xref: /linux/Documentation/driver-api/auxiliary_bus.rst (revision 24bce201d79807b668bf9d9e0aca801c5c0d5f78)
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                 auxiliary_find_device
28
29Auxiliary Device Memory Model and Lifespan
30------------------------------------------
31
32.. kernel-doc:: include/linux/auxiliary_bus.h
33   :doc: DEVICE_LIFESPAN
34
35
36Auxiliary Drivers
37=================
38
39.. kernel-doc:: include/linux/auxiliary_bus.h
40   :identifiers: auxiliary_driver module_auxiliary_driver
41
42.. kernel-doc:: drivers/base/auxiliary.c
43   :identifiers: __auxiliary_driver_register auxiliary_driver_unregister
44
45Example Usage
46=============
47
48.. kernel-doc:: drivers/base/auxiliary.c
49   :doc: EXAMPLE
50
51