xref: /linux/Documentation/driver-api/auxiliary_bus.rst (revision 7f71507851fc7764b36a3221839607d3a45c2025)
1.. SPDX-License-Identifier: GPL-2.0-only
2
3.. _auxiliary_bus:
4
5=============
6Auxiliary Bus
7=============
8
9.. kernel-doc:: drivers/base/auxiliary.c
10   :doc: PURPOSE
11
12When Should the Auxiliary Bus Be Used
13=====================================
14
15.. kernel-doc:: drivers/base/auxiliary.c
16   :doc: USAGE
17
18
19Auxiliary Device Creation
20=========================
21
22.. kernel-doc:: include/linux/auxiliary_bus.h
23   :identifiers: auxiliary_device
24
25.. kernel-doc:: drivers/base/auxiliary.c
26   :identifiers: auxiliary_device_init __auxiliary_device_add
27
28Auxiliary Device Memory Model and Lifespan
29------------------------------------------
30
31.. kernel-doc:: include/linux/auxiliary_bus.h
32   :doc: DEVICE_LIFESPAN
33
34
35Auxiliary Drivers
36=================
37
38.. kernel-doc:: include/linux/auxiliary_bus.h
39   :identifiers: auxiliary_driver module_auxiliary_driver
40
41.. kernel-doc:: drivers/base/auxiliary.c
42   :identifiers: __auxiliary_driver_register auxiliary_driver_unregister
43
44Example Usage
45=============
46
47.. kernel-doc:: drivers/base/auxiliary.c
48   :doc: EXAMPLE
49
50