summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api/auxiliary_bus.rst
blob: cec84908fbc0d63b4d1edc46fa50f931be728867 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
.. 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