mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-26 06:04:14 +08:00
e1b5186810
The code and documentation are more difficult to maintain when kept separately. This is further compounded when the standard structure documentation infrastructure is not used. Move the documentation into the code, use the standard documentation infrastructure, add current documented functions, and reference the text in the rst file. Suggested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Ira Weiny <ira.weiny@intel.com> Link: https://lore.kernel.org/r/20211202044305.4006853-8-ira.weiny@intel.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
51 lines
1.1 KiB
ReStructuredText
51 lines
1.1 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0-only
|
|
|
|
.. _auxiliary_bus:
|
|
|
|
=============
|
|
Auxiliary Bus
|
|
=============
|
|
|
|
.. kernel-doc:: drivers/base/auxiliary.c
|
|
:doc: PURPOSE
|
|
|
|
When Should the Auxiliary Bus Be Used
|
|
=====================================
|
|
|
|
.. kernel-doc:: drivers/base/auxiliary.c
|
|
:doc: USAGE
|
|
|
|
|
|
Auxiliary Device Creation
|
|
=========================
|
|
|
|
.. kernel-doc:: include/linux/auxiliary_bus.h
|
|
:identifiers: auxiliary_device
|
|
|
|
.. kernel-doc:: drivers/base/auxiliary.c
|
|
:identifiers: auxiliary_device_init __auxiliary_device_add
|
|
auxiliary_find_device
|
|
|
|
Auxiliary Device Memory Model and Lifespan
|
|
------------------------------------------
|
|
|
|
.. kernel-doc:: include/linux/auxiliary_bus.h
|
|
:doc: DEVICE_LIFESPAN
|
|
|
|
|
|
Auxiliary Drivers
|
|
=================
|
|
|
|
.. kernel-doc:: include/linux/auxiliary_bus.h
|
|
:identifiers: auxiliary_driver module_auxiliary_driver
|
|
|
|
.. kernel-doc:: drivers/base/auxiliary.c
|
|
:identifiers: __auxiliary_driver_register auxiliary_driver_unregister
|
|
|
|
Example Usage
|
|
=============
|
|
|
|
.. kernel-doc:: drivers/base/auxiliary.c
|
|
:doc: EXAMPLE
|
|
|