kernel/Documentation/driver-api/usb/index.rst, branch linux-rolling-stable

Documentation: driver-api: usb: Limit toctree depth

2025-08-21T17:49:44Z

toctree index in USB driver api docs currently spoils the entire docs headings due to lack of :maxdepth: option. Add the option to limit toctree depth to 1, mirroring usb subsystem docs in Documentation/usb/index.rst. Signed-off-by: Bagas Sanjaya Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/20250820050416.25219-1-bagasdotme@gmail.com

usb: typec: Improve Alt Mode documentation

2018-12-19T07:13:25Z

Adding the document to the usb index file and fixing a few references. Also, exposing the code examples as "literal blocks" so they are more easy to read. Signed-off-by: Heikki Krogerus Signed-off-by: Greg Kroah-Hartman

usb: move ReST documentation to Documentation/driver-api/usb/

2017-06-02T08:22:30Z

This is where all other USB ReST documentation has moved to. Signed-off-by: Felipe Balbi

usb: dwc3: add ReST documentation

2017-06-02T08:22:30Z

Document a few details about DWC3 in order to help people report bugs and debug DWC3. Signed-off-by: Felipe Balbi

usb/URB.txt: convert to ReST and update it

2017-04-11T20:40:25Z

The URB doc describes the Kernel mechanism that do USB transfers. While the functions are already described at urb.h, there are a number of concepts and theory that are important for USB driver developers. Convert it to ReST and use C ref links to point to the places at usb.h where each function and struct is located. A few of those descriptions were incomplete. While here, update to reflect the current API status. Signed-off-by: Mauro Carvalho Chehab Acked-by: Greg Kroah-Hartman Signed-off-by: Jonathan Corbet

usb/persist.txt: convert to ReST and add to driver-api book

2017-04-11T20:40:12Z

This document describe some USB core features. Add it to the driver-api book. Signed-off-by: Mauro Carvalho Chehab Acked-by: Greg Kroah-Hartman Signed-off-by: Jonathan Corbet

usb/hotplug.txt: convert to ReST and add to driver-api book

2017-04-11T20:40:01Z

This document describe some USB core features. Add it to the driver-api book. Signed-off-by: Mauro Carvalho Chehab Acked-by: Greg Kroah-Hartman Signed-off-by: Jonathan Corbet

error-codes.rst: convert to ReST and add to driver-api book

2017-04-11T20:39:49Z

This document describe some USB core features. Add it to the driver-api book. Signed-off-by: Mauro Carvalho Chehab Acked-by: Greg Kroah-Hartman Signed-off-by: Jonathan Corbet

usb/dma.txt: convert to ReST and add to driver-api book

2017-04-11T20:39:36Z

This document describe some USB core features. Add it to the driver-api book. Signed-off-by: Mauro Carvalho Chehab Acked-by: Greg Kroah-Hartman Signed-off-by: Jonathan Corbet

usb/power-management.txt: convert to ReST and add to driver-api book

2017-04-11T20:39:20Z

This document describe some USB core functions. Add it to the driver-api book. Signed-off-by: Mauro Carvalho Chehab Acked-by: Greg Kroah-Hartman Signed-off-by: Jonathan Corbet