summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api/index.rst
diff options
context:
space:
mode:
authorSalah Triki <salah.triki@gmail.com>2026-09-17 14:00:52 +0100
committerJonathan Cameron <jonathan.cameron@oss.qualcomm.com>2026-09-30 18:59:55 +0100
commite8dd273d199f5bbe295a8e3d8b777c5505b6b2e1 (patch)
tree767c7e109d3e6b9ec6549e99dfec9085d01318ad /Documentation/driver-api/index.rst
downloadlinux-stable-e8dd273d199f5bbe295a8e3d8b777c5505b6b2e1.tar.gz
linux-stable-e8dd273d199f5bbe295a8e3d8b777c5505b6b2e1.zip
iio: proximity: isl29501: Fix return type of isl29501_register_writegrafted
isl29501_register_write() was returning a u32 instead of an int. Since the function returns negative error codes (such as -ERANGE or return values from i2c_smbus_write_byte_data()), returning an unsigned integer type prevents callers from correctly checking for negative error conditions. Fix this by changing the function return type from u32 to int. This was found through manual code review. Fixes: 1c28799257bc ("iio: light: isl29501: Add support for the ISL29501 ToF sensor.") Signed-off-by: Salah Triki <salah.triki@gmail.com> Reviewed-by: Joshua Crofts <joshua.crofts1@gmail.com> Cc: stable@vger.kernel.org Signed-off-by: Jonathan Cameron <jonathan.cameron@oss.qualcomm.com>
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