summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api/index.rst
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@linux-foundation.org>2026-09-05 11:59:05 -0700
committerLinus Torvalds <torvalds@linux-foundation.org>2026-09-05 11:59:05 -0700
commit9f0346dcbea363787186c94ef94dd01aaa215afa (patch)
treeb81c168f4d0dbe4c7f4750f4598d48a6deb72094 /Documentation/driver-api/index.rst
downloadlinux-stable-9f0346dcbea363787186c94ef94dd01aaa215afa.tar.gz
linux-stable-9f0346dcbea363787186c94ef94dd01aaa215afa.zip
Merge tag 'driver-core-7.3-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/driver-core/driver-coregrafted
Pull driver core fixes from Danilo Krummrich: - Fix kernfs listxattr() not returning security xattr names (e.g. SELinux labels) when the kernfs node has no allocated kernfs_iattrs - Fix silent truncation of IRQ vector indices in the Rust PCI abstractions - Don't select OF from DRIVER_PE_KUNIT_TEST; skip the test when OF is disabled instead of silently enabling extra kernel functionality - Russ Weight is retiring from kernel development; update the Firmware Loader sysfs contact to the driver-core mailing list, add a CREDITS entry for Firmware Upload, and update MAINTAINERS accordingly * tag 'driver-core-7.3-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/driver-core/driver-core: MAINTAINERS: Remove Russ Weight from Firmware Loader CREDITS: Add CREDITS entry for Firmware Upload firmware_loader: Change contact for sysfs nodes rust: pci: reject IRQ vector indices that do not fit in u32 kernfs: preserve security xattrs without allocating iattrs drivers: base: test: DRIVER_PE_KUNIT_TEST should not select OF
Diffstat (limited to 'Documentation/driver-api/index.rst')
-rw-r--r--Documentation/driver-api/index.rst152
1 files changed, 152 insertions, 0 deletions
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
new file mode 100644
index 000000000..6601a2586
--- /dev/null
+++ b/Documentation/driver-api/index.rst
@@ -0,0 +1,152 @@
+.. 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.
+
+
+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: 1
+
+ basics
+ driver-model/index
+ device_link
+ infrastructure
+ ioctl
+ pm/index
+
+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
+ devfreq
+ dma-buf
+ 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
+ i3c/index
+ isa
+ men-chameleon-bus
+ pci/index
+ rapidio/index
+ slimbus
+ usb/index
+ virtio/index
+ vme
+ w1
+ xillybus
+
+
+Subsystem-specific APIs
+=======================
+
+.. toctree::
+ :maxdepth: 1
+
+ 80211/index
+ acpi/index
+ backlight/lp855x-driver.rst
+ clk
+ coco/index
+ console
+ crypto/index
+ dmaengine/index
+ dpll
+ edac
+ extcon
+ firmware/index
+ 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
+ issei/index
+ libata
+ mailbox
+ md/index
+ media/index
+ mei/index
+ memory-devices/index
+ 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
+ pwm
+ pwrseq
+ regulator
+ reset
+ rfkill
+ s390-drivers
+ scsi
+ serial/index
+ sm501
+ soundwire/index
+ spi
+ surface_aggregator/index
+ switchtec
+ sync_file
+ target
+ tee
+ thermal/index
+ tty/index
+ wbrf
+ wmi
+ xilinx/index
+ zorro