diff options
Diffstat (limited to 'Documentation/driver-api/index.rst')
-rw-r--r-- | Documentation/driver-api/index.rst | 172 |
1 files changed, 107 insertions, 65 deletions
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index 0ebe205efd0c..f10decc2c14b 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -1,106 +1,148 @@ -======================================== -The Linux driver implementer's API guide -======================================== +.. SPDX-License-Identifier: GPL-2.0 + +============================== +Driver implementer's API guide +============================== The kernel offers a wide variety of interfaces to support the development of device drivers. This document is an only somewhat organized collection of some of those interfaces — it will hopefully get better over time! The available subsections can be seen below. -.. class:: toc-title - Table of contents +General information for driver authors +====================================== + +This section contains documentation that should, at some point or other, be +of interest to most developers working on device drivers. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - driver-model/index basics + driver-model/index + device_link infrastructure - early-userspace/index + ioctl pm/index - clk + +Useful support libraries +======================== + +This section contains documentation that should, at some point or other, be +of interest to most developers working on device drivers. + +.. toctree:: + :maxdepth: 1 + + early-userspace/index + connector device-io - device_connection + devfreq dma-buf - device_link component - message-based - infiniband - sound - frame-buffer - regulator - iio/index - input - usb/index + io-mapping + io_ordering + uio-howto + vfio-mediated-device + vfio + vfio-pci-device-specific-driver-acceptance + +Bus-level documentation +======================= + +.. toctree:: + :maxdepth: 1 + + auxiliary_bus + cxl/index + eisa firewire - pci/index - spi - i2c - ipmb i3c/index - interconnect - devfreq - hsi - edac - scsi - libata - target - mtdnand - miscellaneous - mei/index - mtd/index - mmc/index - nvdimm/index - w1 + isa + men-chameleon-bus + pci/index rapidio/index - s390-drivers + slimbus + usb/index + virtio/index vme + w1 + xillybus + + +Subsystem-specific APIs +======================= + +.. toctree:: + :maxdepth: 1 + 80211/index - uio-howto - firmware/index - pinctl - gpio/index - md/index - misc_devices - nfc/index - dmaengine/index - slimbus - soundwire/index - thermal/index - fpga/index acpi/index backlight/lp855x-driver.rst - connector + clk console - dcdbas - edid - eisa - ipmb - isa - isapnp + crypto/index + dmaengine/index + dpll + edac + firmware/index + fpga/index + frame-buffer + aperture generic-counter - lightnvm-pblk + gpio/index + hsi + hte/index + i2c + iio/index + infiniband + input + interconnect + ipmb + ipmi + libata + mailbox + md/index + media/index + mei/index memory-devices/index - men-chameleon-bus + message-based + misc_devices + miscellaneous + mmc/index + mtd/index + mtdnand + nfc/index ntb + nvdimm/index nvmem parport-lowlevel + phy/index + pin-control + pldmfw/index pps ptp - phy/index - pti_intel_mid pwm + regulator + reset rfkill + s390-drivers + scsi serial/index sm501 - smsc_ece1099 + soundwire/index + spi + surface_aggregator/index switchtec sync_file - vfio-mediated-device - vfio + target + tee + thermal/index + tty/index + wbrf + wmi xilinx/index - xillybus zorro .. only:: subproject and html |