Heikki Krogerus
28ce553985
usb: typec: Improve Alt Mode documentation
...
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 <heikki.krogerus@linux.intel.com >
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
2018-12-19 08:13:25 +01:00
Felipe Balbi
b0b3ddf8fb
usb: move ReST documentation to Documentation/driver-api/usb/
...
This is where all other USB ReST documentation has moved to.
Signed-off-by: Felipe Balbi <felipe.balbi@linux.intel.com >
2017-06-02 11:22:30 +03:00
Felipe Balbi
8b4cfe0bb7
usb: dwc3: add ReST documentation
...
Document a few details about DWC3 in order to help people report bugs
and debug DWC3.
Signed-off-by: Felipe Balbi <felipe.balbi@linux.intel.com >
2017-06-02 11:22:30 +03:00
Mauro Carvalho Chehab
e463c06335
usb/URB.txt: convert to ReST and update it
...
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 <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:40:25 -06:00
Mauro Carvalho Chehab
32a3bebce9
usb/persist.txt: convert to ReST and add to driver-api book
...
This document describe some USB core features. Add it to the
driver-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:40:12 -06:00
Mauro Carvalho Chehab
76f650f077
usb/hotplug.txt: convert to ReST and add to driver-api book
...
This document describe some USB core features. Add it to the
driver-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:40:01 -06:00
Mauro Carvalho Chehab
360a7b5f57
error-codes.rst: convert to ReST and add to driver-api book
...
This document describe some USB core features. Add it to the
driver-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:39:49 -06:00
Mauro Carvalho Chehab
2a373331dd
usb/dma.txt: convert to ReST and add to driver-api book
...
This document describe some USB core features. Add it to the
driver-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:39:36 -06:00
Mauro Carvalho Chehab
3db5f406e4
usb/power-management.txt: convert to ReST and add to driver-api book
...
This document describe some USB core functions. Add it to the
driver-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:39:20 -06:00
Mauro Carvalho Chehab
3b38e4f218
usb/callbacks.txt: convert to ReST and add to driver-api book
...
This document describe some USB core functions. Add it to the
driver-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:39:08 -06:00
Mauro Carvalho Chehab
401c7be2ba
usb/bulk-streams.txt: convert to ReST and add to driver-api book
...
This document describe some USB core functions. Add it to the
driver-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:38:56 -06:00
Mauro Carvalho Chehab
79e0c2e6d4
usb/anchors.txt: convert to ReST and add to driver-api book
...
This document describe some USB core functions. Add it to the
driver-api book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:38:44 -06:00
Mauro Carvalho Chehab
4ad4b21b1b
docs-rst: convert usb docbooks to ReST
...
As we're moving out of DocBook, let's convert the remaining
USB docbooks to ReST.
The transformation itself on this patch is a no-brainer
conversion using pandoc via this script:
Documentation/sphinx/tmplcvt
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com >
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2017-04-11 14:37:04 -06:00