summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api/usb
Commit message (Collapse)AuthorAgeFilesLines
* usb: doc: Update document for USB3 debug port usageLu Baolu2017-12-211-0/+52
| | | | | | | | | | | Update Documentation/driver-api/usb/usb3-debug-port.rst. This update includes the guide for using xHCI debug capability based TTY serial link. Cc: Mathias Nyman <mathias.nyman@linux.intel.com> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Lu Baolu <baolu.lu@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/driver-api/usb: Replace dead linkStefan Tatschner2017-12-111-1/+1
| | | | | | | | | | | | | | This link is dead: $ curl -vI http://usb.cs.tum.edu/usbdoc * Could not resolve host: usb.cs.tum.edu * Closing connection 0 curl: (6) Could not resolve host: usb.cs.tum.edu I found the document somewhere else. Let's replace it. Signed-off-by: Stefan Tatschner <stefan.tatschner@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: fix usb related doc refsTom Saeger2017-10-121-3/+1
| | | | | | | Update ref to usb proc_usb_info.txt. Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge tag 'usb-for-v4.13' of ↵Greg Kroah-Hartman2017-06-204-0/+997
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | git://git.kernel.org/pub/scm/linux/kernel/git/balbi/usb into usb-testing Felipe writes: usb: changes for v4.13 merge window This time around we have a total of 57 non-merge commits. A list of most important changes follows: - Improvements to dwc3 tracing interface - Initial dual-role support for dwc3 - Improvements to how we handle DMA resources in dwc3 - A new f_uac1 implementation which much more flexible - Removal of AVR32 bits - Improvements to f_mass_storage driver
| * usb: move ReST documentation to Documentation/driver-api/usb/Felipe Balbi2017-06-023-0/+286
| | | | | | | | | | | | This is where all other USB ReST documentation has moved to. Signed-off-by: Felipe Balbi <felipe.balbi@linux.intel.com>
| * usb: dwc3: add ReST documentationFelipe Balbi2017-06-022-0/+713
|/ | | | | | | 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>
* usb.rst: move documentation from proc_usb_info.txt to USB ReST bookMauro Carvalho Chehab2017-04-201-34/+405
| | | | | | | | | | | | | The contents of proc_usb_info.txt complements what's there at driver-api usb book. Yet, it is outdated, as it still refers to the USB character devices as usbfs. So, move the contents to usb.rst, adjusting it to point to the right places. 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>
* docs-rst: usb: update old usbfs-related documentationMauro Carvalho Chehab2017-04-201-120/+60
| | | | | | | | | | | | There's no usbfs anymore. The old features are now either exported to /dev/bus/usb or via debugfs. Update documentation accordingly, pointing to the new places where the character devices and usb/devices are now placed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs-rst: fix usb cross-referencesMauro Carvalho Chehab2017-04-116-5/+11
| | | | | | | | | As some USB documentation files got moved, adjust their cross-references to their new place. 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>
* usb.rst: get rid of some Sphinx errorsMauro Carvalho Chehab2017-04-111-3/+3
| | | | | | | | | | | | | Get rid of those warnings: Documentation/driver-api/usb/usb.rst:615: ERROR: Unknown target name: "usb_type". Documentation/driver-api/usb/usb.rst:615: ERROR: Unknown target name: "usb_dir". Documentation/driver-api/usb/usb.rst:615: ERROR: Unknown target name: "usb_recip". Documentation/driver-api/usb/usb.rst:679: ERROR: Unknown target name: "usbdevfs_urb_type". 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>
* usb/URB.txt: convert to ReST and update itMauro Carvalho Chehab2017-04-113-0/+291
| | | | | | | | | | | | | | | | | 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>
* usb/persist.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-0/+170
| | | | | | | | | 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>
* usb/hotplug.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-0/+155
| | | | | | | | | 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>
* error-codes.rst: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-0/+206
| | | | | | | | | 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>
* usb/dma.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-0/+137
| | | | | | | | | 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>
* usb/power-management.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-0/+795
| | | | | | | | | 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>
* usb/callbacks.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-0/+158
| | | | | | | | | 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>
* usb/bulk-streams.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-0/+84
| | | | | | | | | 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>
* usb/anchors.txt: convert to ReST and add to driver-api bookMauro Carvalho Chehab2017-04-112-0/+84
| | | | | | | | | 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>
* writing_musb_glue_layer.rst: Enrich its ReST representationMauro Carvalho Chehab2017-04-111-315/+301
| | | | | | | | | | | | | | | | | | | | | | | This file is actually quite complex, and required several manual handwork: - add a title for the document; - use the right tags for monospaced fonts; - use c references where needed; - adjust cross-reference to writing_usb_driver.rst - hightlight cross-referenced lines. With regards to C code snippet line highlights, the better would be to use :linenos: for the C code snippets that are referenced by the line number. However, at least with Sphinx 1.4.9, enabling it cause the line number to be misaligned with the code, making it even more confusing. So, instead, let's use :emphasize-lines: tag to mark the lines that are referenced at the text. 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>
* writing_usb_driver.rst: Enrich its ReST representationMauro Carvalho Chehab2017-04-111-100/+82
| | | | | | | | | | | | | | The pandoc conversion is not perfect. Do handwork in order to: - add a title to this chapter; - adjust function and struct references; - use monospaced fonts for C code names; - some other minor adjustments to make it better to read in text mode and in html. 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>
* gadget.rst: Enrich its ReST representation and add kernel-doc tagMauro Carvalho Chehab2017-04-111-75/+52
| | | | | | | | | | | | | | | The pandoc conversion is not perfect. Do handwork in order to: - add a title to this chapter; - use the proper warning and note markups; - use kernel-doc to include Kernel header and c files; - remove legacy notes with regards to DocBook; - some other minor adjustments to make it better to read in text mode and in html. 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>
* usb.rst: Enrich its ReST representationMauro Carvalho Chehab2017-04-111-31/+17
| | | | | | | | | | | | - use the proper warning and note markups; - add references for parts of the document that will be cross-referenced on other USB docs; - some minor adjustments to make it better to read in text mode and in html. 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>
* docs-rst: convert usb docbooks to ReSTMauro Carvalho Chehab2017-04-115-0/+2379
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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-08 10:20:13 +0000