diff options
Diffstat (limited to 'Documentation/driver-api/index.rst')
| -rw-r--r-- | Documentation/driver-api/index.rst | 162 |
1 files changed, 128 insertions, 34 deletions
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index ab38ced66a44..1833e6a0687e 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -1,60 +1,154 @@ -======================================== -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 basics + driver-model/index + device_link infrastructure + 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 - message-based - sound - frame-buffer - regulator - iio/index - input - usb/index + component + 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 i3c/index - hsi - edac - scsi - libata - target - mtdnand - miscellaneous - w1 - rapidio - s390-drivers + isa + men-chameleon-bus + pci/index + rapidio/index + slimbus + usb/index + virtio/index vme + w1 + xillybus + + +Subsystem-specific APIs +======================= + +.. toctree:: + :maxdepth: 1 + 80211/index - uio-howto + acpi/index + backlight/lp855x-driver.rst + clk + coco/index + console + crypto/index + dmaengine/index + dpll + edac + extcon firmware/index - pinctl + fpga/index + frame-buffer + aperture + generic-counter + generic_pt gpio/index + hsi + hte/index + hw-recoverable-errors + i2c + iio/index + infiniband + input + interconnect + ipmb + ipmi + libata + mailbox + md/index + media/index + mei/index + memory-devices/index + message-based misc_devices - dmaengine/index - slimbus + miscellaneous + mmc/index + mtd/index + mtdnand + nfc/index + ntb + nvdimm/index + nvmem + parport-lowlevel + phy/index + pin-control + pldmfw/index + pps + ptp + pwm + pwrseq + regulator + reset + rfkill + s390-drivers + scsi + serial/index + sm501 soundwire/index - fpga/index + spi + surface_aggregator/index + switchtec + sync_file + target + tee + thermal/index + tty/index + wbrf + wmi + xilinx/index + zorro .. only:: subproject and html |
