iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
c807ca95a6
linux/Documentation/driver-api/infrastructure.rst

98 lines
1.9 KiB
ReStructuredText
Raw Normal View History

docs: split up the driver book We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-20 22:17:32 +03:00
Device drivers infrastructure
=============================
The Basic Device Driver-Model Structures
----------------------------------------
.. kernel-doc:: include/linux/device.h
:internal:
docs: infrastructure.rst: exclude device_link_state from device.h This is already documented at device_link.rst, causing this warning, due to a broken cross-reference: .../Documentation/driver-api/device_link.rst: WARNING: Duplicate C declaration, also defined in 'driver-api/infrastructure'. Declaration is 'device_link_state'. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-10-05 12:03:49 +03:00
:no-identifiers: device_link_state
docs: split up the driver book We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-20 22:17:32 +03:00
docs: add more driver-model infrastructure interfaces Add bus, class, and device data structures and enum constants to the Driver-Model Structures section and add function interfaces to the Device Drivers Base section of the Device drivers infrastructure chapter. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: "Rafael J. Wysocki" <rafael@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230627064523.16618-1-rdunlap@infradead.org
2023-06-27 09:45:23 +03:00
.. kernel-doc:: include/linux/device/bus.h
:identifiers: bus_type bus_notifier_event
.. kernel-doc:: include/linux/device/class.h
:identifiers: class
.. kernel-doc:: include/linux/device/driver.h
:identifiers: probe_type device_driver
docs: split up the driver book We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-20 22:17:32 +03:00
Device Drivers Base
-------------------
.. kernel-doc:: drivers/base/init.c
:internal:
docs: add more driver-model infrastructure interfaces Add bus, class, and device data structures and enum constants to the Driver-Model Structures section and add function interfaces to the Device Drivers Base section of the Device drivers infrastructure chapter. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: "Rafael J. Wysocki" <rafael@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230627064523.16618-1-rdunlap@infradead.org
2023-06-27 09:45:23 +03:00
.. kernel-doc:: include/linux/device/driver.h
:no-identifiers: probe_type device_driver
docs: split up the driver book We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-20 22:17:32 +03:00
.. kernel-doc:: drivers/base/driver.c
:export:
.. kernel-doc:: drivers/base/core.c
:export:
.. kernel-doc:: drivers/base/syscore.c
:export:
docs: add more driver-model infrastructure interfaces Add bus, class, and device data structures and enum constants to the Driver-Model Structures section and add function interfaces to the Device Drivers Base section of the Device drivers infrastructure chapter. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: "Rafael J. Wysocki" <rafael@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230627064523.16618-1-rdunlap@infradead.org
2023-06-27 09:45:23 +03:00
.. kernel-doc:: include/linux/device/class.h
:no-identifiers: class
docs: split up the driver book We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-20 22:17:32 +03:00
.. kernel-doc:: drivers/base/class.c
:export:
.. kernel-doc:: drivers/base/node.c
:internal:
.. kernel-doc:: drivers/base/transport_class.c
:export:
.. kernel-doc:: drivers/base/dd.c
:export:
.. kernel-doc:: include/linux/platform_device.h
:internal:
.. kernel-doc:: drivers/base/platform.c
:export:
docs: add more driver-model infrastructure interfaces Add bus, class, and device data structures and enum constants to the Driver-Model Structures section and add function interfaces to the Device Drivers Base section of the Device drivers infrastructure chapter. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: "Rafael J. Wysocki" <rafael@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230627064523.16618-1-rdunlap@infradead.org
2023-06-27 09:45:23 +03:00
.. kernel-doc:: include/linux/device/bus.h
:no-identifiers: bus_type bus_notifier_event
docs: split up the driver book We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-20 22:17:32 +03:00
.. kernel-doc:: drivers/base/bus.c
:export:
Device Drivers DMA Management
-----------------------------
dma-mapping: move all DMA mapping code to kernel/dma Currently the code is split over various files with dma- prefixes in the lib/ and drives/base directories, and the number of files keeps growing. Move them into a single directory to keep the code together and remove the file name prefixes. To match the irq infrastructure this directory is placed under the kernel/ directory. Signed-off-by: Christoph Hellwig <hch@lst.de>
2018-06-12 20:01:45 +03:00
.. kernel-doc:: kernel/dma/mapping.c
docs: split up the driver book We don't need to keep it as a single large file anymore; split it up so that it is easier to manage and the individual sections can be read directly as plain files. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2016-08-20 22:17:32 +03:00
:export:
Device drivers PnP support
--------------------------
.. kernel-doc:: drivers/pnp/core.c
:internal:
.. kernel-doc:: drivers/pnp/card.c
:export:
.. kernel-doc:: drivers/pnp/driver.c
:internal:
.. kernel-doc:: drivers/pnp/manager.c
:export:
.. kernel-doc:: drivers/pnp/support.c
:export:
Userspace IO devices
--------------------
.. kernel-doc:: drivers/uio/uio.c
:export:
.. kernel-doc:: include/linux/uio_driver.h
:internal:
Reference in New Issue Copy Permalink