index.rst

  1.. SPDX-License-Identifier: GPL-2.0
  2
  3==============================
  4Driver implementer's API guide
  5==============================
  6
  7The kernel offers a wide variety of interfaces to support the development
  8of device drivers.  This document is an only somewhat organized collection
  9of some of those interfaces — it will hopefully get better over time!  The
 10available subsections can be seen below.
 11
 12
 13General information for driver authors
 14======================================
 15
 16This section contains documentation that should, at some point or other, be
 17of interest to most developers working on device drivers.
 18
 19.. toctree::
 20   :maxdepth: 1
 21
 22   basics
 23   driver-model/index
 24   device_link
 25   infrastructure
 26   ioctl
 27   pm/index
 28
 29Useful support libraries
 30========================
 31
 32This section contains documentation that should, at some point or other, be
 33of interest to most developers working on device drivers.
 34
 35.. toctree::
 36   :maxdepth: 1
 37
 38   early-userspace/index
 39   connector
 40   device-io
 41   devfreq
 42   dma-buf
 43   component
 44   io-mapping
 45   io_ordering
 46   uio-howto
 47   vfio-mediated-device
 48   vfio
 49   vfio-pci-device-specific-driver-acceptance
 50
 51Bus-level documentation
 52=======================
 53
 54.. toctree::
 55   :maxdepth: 1
 56
 57   auxiliary_bus
 58   cxl/index
 59   eisa
 60   firewire
 61   i3c/index
 62   isa
 63   men-chameleon-bus
 64   pci/index
 65   rapidio/index
 66   slimbus
 67   usb/index
 68   virtio/index
 69   vme
 70   w1
 71   xillybus
 72
 73
 74Subsystem-specific APIs
 75=======================
 76
 77.. toctree::
 78   :maxdepth: 1
 79
 80   80211/index
 81   acpi/index
 82   backlight/lp855x-driver.rst
 83   clk
 84   coco/index
 85   console
 86   crypto/index
 87   dmaengine/index
 88   dpll
 89   edac
 90   extcon
 91   firmware/index
 92   fpga/index
 93   frame-buffer
 94   aperture
 95   generic-counter
 96   generic_pt
 97   gpio/index
 98   hsi
 99   hte/index
100   hw-recoverable-errors
101   i2c
102   iio/index
103   infiniband
104   input
105   interconnect
106   ipmb
107   ipmi
108   libata
109   mailbox
110   md/index
111   media/index
112   mei/index
113   memory-devices/index
114   message-based
115   misc_devices
116   miscellaneous
117   mmc/index
118   mtd/index
119   mtdnand
120   nfc/index
121   ntb
122   nvdimm/index
123   nvmem
124   parport-lowlevel
125   phy/index
126   pin-control
127   pldmfw/index
128   pps
129   ptp
130   pwm
131   pwrseq
132   regulator
133   reset
134   rfkill
135   s390-drivers
136   scsi
137   serial/index
138   sm501
139   soundwire/index
140   spi
141   surface_aggregator/index
142   switchtec
143   sync_file
144   target
145   tee
146   thermal/index
147   tty/index
148   wbrf
149   wmi
150   xilinx/index
151   zorro
152
153.. only::  subproject and html
154
155   Indices
156   =======
157
158   * :ref:`genindex`