Commit 0c17bb5e authored by Jonathan Corbet's avatar Jonathan Corbet

docs: rework the driver-api top-level page

Add subsections in an attempt to bring a bit order to this page; also sort
most subsections into alphabetical order.  With luck all this will help to
prevent merge conflicts on this page due to everybody adding entries at the
end.
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/87plxtm2oo.fsf@meer.lwn.net
parent 6151b9c8
...@@ -9,110 +9,141 @@ of device drivers. This document is an only somewhat organized collection ...@@ -9,110 +9,141 @@ of device drivers. This document is an only somewhat organized collection
of some of those interfaces — it will hopefully get better over time! The of some of those interfaces — it will hopefully get better over time! The
available subsections can be seen below. 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:: .. toctree::
:caption: Table of contents :maxdepth: 1
:maxdepth: 2
driver-model/index
basics basics
driver-model/index
device_link
infrastructure infrastructure
ioctl ioctl
early-userspace/index
pm/index 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-io
devfreq
dma-buf dma-buf
device_link
component component
message-based io-mapping
infiniband io_ordering
aperture uio-howto
frame-buffer vfio-mediated-device
regulator vfio
reset vfio-pci-device-specific-driver-acceptance
iio/index
input Bus-level documentation
usb/index =======================
firewire
pci/index .. toctree::
:maxdepth: 1
auxiliary_bus
cxl/index cxl/index
spi eisa
i2c firewire
ipmb
ipmi
i3c/index i3c/index
interconnect isa
devfreq men-chameleon-bus
hsi pci/index
edac
scsi
libata
target
mailbox
mtdnand
miscellaneous
mei/index
mtd/index
mmc/index
nvdimm/index
w1
rapidio/index rapidio/index
s390-drivers slimbus
usb/index
virtio/index
vme vme
w1
xillybus
Subsystem-specific APIs
=======================
.. toctree::
:maxdepth: 1
80211/index 80211/index
uio-howto acpi/index
backlight/lp855x-driver.rst
clk
console
crypto/index
dmaengine/index
dpll
edac
firmware/index firmware/index
pin-control fpga/index
frame-buffer
aperture
generic-counter
gpio/index gpio/index
hsi
hte/index
i2c
iio/index
infiniband
input
interconnect
ipmb
ipmi
libata
mailbox
md/index md/index
media/index media/index
mei/index
memory-devices/index
message-based
misc_devices misc_devices
miscellaneous
mmc/index
mtd/index
mtdnand
nfc/index nfc/index
dmaengine/index
slimbus
soundwire/index
thermal/index
fpga/index
acpi/index
auxiliary_bus
backlight/lp855x-driver.rst
connector
console
eisa
isa
io-mapping
io_ordering
generic-counter
memory-devices/index
men-chameleon-bus
ntb ntb
nvdimm/index
nvmem nvmem
parport-lowlevel parport-lowlevel
phy/index
pin-control
pldmfw/index
pps pps
ptp ptp
phy/index
pwm pwm
pldmfw/index regulator
reset
rfkill rfkill
s390-drivers
scsi
serial/index serial/index
sm501 sm501
soundwire/index
spi
surface_aggregator/index surface_aggregator/index
switchtec switchtec
sync_file sync_file
target
tee
thermal/index
tty/index tty/index
vfio-mediated-device wbrf
vfio wmi
vfio-pci-device-specific-driver-acceptance
virtio/index
xilinx/index xilinx/index
xillybus
zorro zorro
hte/index
wmi
dpll
wbrf
crypto/index
tee
.. only:: subproject and html .. only:: subproject and html
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment