Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: driver-model: move it to the driver-api book
The audience for the Kernel driver-model is clearly Kernel hackers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com> # ice driver changes
+16
-17
+1
-1
Documentation/driver-api/gpio/driver.rst
+1
-1
Documentation/driver-api/gpio/driver.rst
···
399
399
will pass the struct gpio_chip* for the chip to all IRQ callbacks, so the
400
400
callbacks need to embed the gpio_chip in its state container and obtain a
401
401
pointer to the container using container_of().
402
-
(See Documentation/driver-model/design-patterns.rst)
402
+
(See Documentation/driver-api/driver-model/design-patterns.rst)
403
403
404
404
- gpiochip_irqchip_add_nested(): adds a nested cascaded irqchip to a gpiochip,
405
405
as discussed above regarding different types of cascaded irqchips. The
+1
Documentation/driver-api/index.rst
+1
Documentation/driver-api/index.rst
Documentation/driver-model/binding.rst
Documentation/driver-api/driver-model/binding.rst
Documentation/driver-model/binding.rst
Documentation/driver-api/driver-model/binding.rst
Documentation/driver-model/bus.rst
Documentation/driver-api/driver-model/bus.rst
Documentation/driver-model/bus.rst
Documentation/driver-api/driver-model/bus.rst
Documentation/driver-model/class.rst
Documentation/driver-api/driver-model/class.rst
Documentation/driver-model/class.rst
Documentation/driver-api/driver-model/class.rst
Documentation/driver-model/design-patterns.rst
Documentation/driver-api/driver-model/design-patterns.rst
Documentation/driver-model/design-patterns.rst
Documentation/driver-api/driver-model/design-patterns.rst
Documentation/driver-model/device.rst
Documentation/driver-api/driver-model/device.rst
Documentation/driver-model/device.rst
Documentation/driver-api/driver-model/device.rst
Documentation/driver-model/devres.rst
Documentation/driver-api/driver-model/devres.rst
Documentation/driver-model/devres.rst
Documentation/driver-api/driver-model/devres.rst
Documentation/driver-model/driver.rst
Documentation/driver-api/driver-model/driver.rst
Documentation/driver-model/driver.rst
Documentation/driver-api/driver-model/driver.rst
-2
Documentation/driver-model/index.rst
Documentation/driver-api/driver-model/index.rst
-2
Documentation/driver-model/index.rst
Documentation/driver-api/driver-model/index.rst
Documentation/driver-model/overview.rst
Documentation/driver-api/driver-model/overview.rst
Documentation/driver-model/overview.rst
Documentation/driver-api/driver-model/overview.rst
Documentation/driver-model/platform.rst
Documentation/driver-api/driver-model/platform.rst
Documentation/driver-model/platform.rst
Documentation/driver-api/driver-model/platform.rst
+1
-1
Documentation/driver-model/porting.rst
Documentation/driver-api/driver-model/porting.rst
+1
-1
Documentation/driver-model/porting.rst
Documentation/driver-api/driver-model/porting.rst
···
9
9
10
10
Overview
11
11
12
-
Please refer to `Documentation/driver-model/*.rst` for definitions of
12
+
Please refer to `Documentation/driver-api/driver-model/*.rst` for definitions of
13
13
various driver types and concepts.
14
14
15
15
Most of the work of porting devices drivers to the new model happens
+2
-2
Documentation/eisa.txt
+2
-2
Documentation/eisa.txt
···
103
103
(driver_data).
104
104
105
105
driver a generic driver, such as described in
106
-
Documentation/driver-model/driver.rst. Only .name,
106
+
Documentation/driver-api/driver-model/driver.rst. Only .name,
107
107
.probe and .remove members are mandatory.
108
108
=============== ====================================================
109
109
···
152
152
flags are EISA_CONFIG_ENABLED and EISA_CONFIG_FORCED.
153
153
res set of four 256 bytes I/O regions allocated to this device
154
154
dma_mask DMA mask set from the parent device.
155
-
dev generic device (see Documentation/driver-model/device.rst)
155
+
dev generic device (see Documentation/driver-api/driver-model/device.rst)
156
156
======== ============================================================
157
157
158
158
You can get the 'struct eisa_device' from 'struct device' using the
+1
-1
Documentation/filesystems/sysfs.txt
+1
-1
Documentation/filesystems/sysfs.txt
+1
-1
Documentation/hwmon/submitting-patches.rst
+1
-1
Documentation/hwmon/submitting-patches.rst
···
89
89
console. Excessive logging can seriously affect system performance.
90
90
91
91
* Use devres functions whenever possible to allocate resources. For rationale
92
-
and supported functions, please see Documentation/driver-model/devres.rst.
92
+
and supported functions, please see Documentation/driver-api/driver-model/devres.rst.
93
93
If a function is not supported by devres, consider using devm_add_action().
94
94
95
95
* If the driver has a detect function, make sure it is silent. Debug messages
+1
-1
Documentation/translations/zh_CN/filesystems/sysfs.txt
+1
-1
Documentation/translations/zh_CN/filesystems/sysfs.txt
+1
-1
drivers/base/platform.c
+1
-1
drivers/base/platform.c
+1
-1
drivers/gpio/gpio-cs5535.c
+1
-1
drivers/gpio/gpio-cs5535.c
···
41
41
42
42
/*
43
43
* FIXME: convert this singleton driver to use the state container
44
-
* design pattern, see Documentation/driver-model/design-patterns.rst
44
+
* design pattern, see Documentation/driver-api/driver-model/design-patterns.rst
45
45
*/
46
46
static struct cs5535_gpio_chip {
47
47
struct gpio_chip chip;
+1
-1
drivers/net/ethernet/intel/ice/ice_main.c
+1
-1
drivers/net/ethernet/intel/ice/ice_main.c
···
2286
2286
struct ice_hw *hw;
2287
2287
int err;
2288
2288
2289
-
/* this driver uses devres, see Documentation/driver-model/devres.rst */
2289
+
/* this driver uses devres, see Documentation/driver-api/driver-model/devres.rst */
2290
2290
err = pcim_enable_device(pdev);
2291
2291
if (err)
2292
2292
return err;
+2
-2
drivers/staging/unisys/Documentation/overview.txt
+2
-2
drivers/staging/unisys/Documentation/overview.txt
···
15
15
* visorinput - keyboard and mouse
16
16
17
17
These drivers conform to the standard Linux bus/device model described
18
-
within Documentation/driver-model/, and utilize a driver named visorbus to
18
+
within Documentation/driver-api/driver-model/, and utilize a driver named visorbus to
19
19
present the virtual busses involved. Drivers in the 'visor*' driver set are
20
20
commonly referred to as "guest drivers" or "client drivers". All drivers
21
21
except visorbus expose a device of a specific usable class to the Linux guest
···
141
141
-----------------------------------
142
142
143
143
Because visorbus is a standard Linux bus driver in the model described in
144
-
Documentation/driver-model/, the hierarchy of s-Par virtual devices is
144
+
Documentation/driver-api/driver-model/, the hierarchy of s-Par virtual devices is
145
145
published in the sysfs tree beneath /bus/visorbus/, e.g.,
146
146
/sys/bus/visorbus/devices/ might look like:
147
147
+1
-1
include/linux/device.h
+1
-1
include/linux/device.h
+1
-1
include/linux/platform_device.h
+1
-1
include/linux/platform_device.h
+1
-1
scripts/coccinelle/free/devm_free.cocci
+1
-1
scripts/coccinelle/free/devm_free.cocci
···
3
3
/// functions. Values allocated using the devm_functions are freed when
4
4
/// the device is detached, and thus the use of the standard freeing
5
5
/// function would cause a double free.
6
-
/// See Documentation/driver-model/devres.rst for more information.
6
+
/// See Documentation/driver-api/driver-model/devres.rst for more information.
7
7
///
8
8
/// A difficulty of detecting this problem is that the standard freeing
9
9
/// function might be called from a different function than the one