index.rst 2.4 KB

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