Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: usb: rename files to .rst and add them to drivers-api

While there are a mix of things here, most of the stuff
were written from Kernel developer's PoV. So, add them to
the driver-api book.

A follow up for this patch would be to move documents from
there that are specific to sysadmins, adding them to the
admin-guide.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Johan Hovold <johan@kernel.org>
Acked-by: Felipe Balbi <felipe.balbi@linux.intel.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Mauro Carvalho Chehab and committed by
Greg Kroah-Hartman
ecefae6d 743344a9

+119 -40
+1
Documentation/index.rst
··· 101 101 filesystems/index 102 102 vm/index 103 103 bpf/index 104 + usb/index 104 105 misc-devices/index 105 106 106 107 Architecture-specific documentation
+10
Documentation/index.rst.rej
··· 1 + --- Documentation/index.rst 2 + +++ Documentation/index.rst 3 + @@ -103,6 +103,7 @@ needed). 4 + vm/index 5 + bpf/index 6 + PCI/index 7 + + usb/index 8 + misc-devices/index 9 + 10 + Architecture-specific documentation
Documentation/usb/WUSB-Design-overview.txt Documentation/usb/wusb-design-overview.rst
Documentation/usb/acm.txt Documentation/usb/acm.rst
Documentation/usb/authorization.txt Documentation/usb/authorization.rst
Documentation/usb/chipidea.txt Documentation/usb/chipidea.rst
Documentation/usb/dwc3.txt Documentation/usb/dwc3.rst
Documentation/usb/ehci.txt Documentation/usb/ehci.rst
Documentation/usb/functionfs.txt Documentation/usb/functionfs.rst
+2 -2
Documentation/usb/gadget-testing.txt Documentation/usb/gadget-testing.rst
··· 254 254 - connect the gadget to a host, preferably not the one used 255 255 to control the gadget 256 256 - run a program which writes to /dev/hidg<N>, e.g. 257 - a userspace program found in Documentation/usb/gadget_hid.txt:: 257 + a userspace program found in Documentation/usb/gadget_hid.rst:: 258 258 259 259 $ ./hid_gadget_test /dev/hidg0 keyboard 260 260 ··· 886 886 # cat /dev/usb/lp0 887 887 888 888 More advanced testing can be done with the prn_example 889 - described in Documentation/usb/gadget_printer.txt. 889 + described in Documentation/usb/gadget_printer.rst. 890 890 891 891 892 892 20. UAC1 function (virtual ALSA card, using u_audio API)
Documentation/usb/gadget_configfs.txt Documentation/usb/gadget_configfs.rst
Documentation/usb/gadget_hid.txt Documentation/usb/gadget_hid.rst
Documentation/usb/gadget_multi.txt Documentation/usb/gadget_multi.rst
Documentation/usb/gadget_printer.txt Documentation/usb/gadget_printer.rst
Documentation/usb/gadget_serial.txt Documentation/usb/gadget_serial.rst
+39
Documentation/usb/index.rst
··· 1 + =========== 2 + USB support 3 + =========== 4 + 5 + .. toctree:: 6 + :maxdepth: 1 7 + 8 + acm 9 + authorization 10 + chipidea 11 + dwc3 12 + ehci 13 + functionfs 14 + gadget_configfs 15 + gadget_hid 16 + gadget_multi 17 + gadget_printer 18 + gadget_serial 19 + gadget-testing 20 + iuu_phoenix 21 + mass-storage 22 + misc_usbsevseg 23 + mtouchusb 24 + ohci 25 + rio 26 + usbip_protocol 27 + usbmon 28 + usb-serial 29 + wusb-design-overview 30 + 31 + usb-help 32 + text_files 33 + 34 + .. only:: subproject and html 35 + 36 + Indices 37 + ======= 38 + 39 + * :ref:`genindex`
Documentation/usb/iuu_phoenix.txt Documentation/usb/iuu_phoenix.rst
Documentation/usb/mass-storage.txt Documentation/usb/mass-storage.rst
Documentation/usb/misc_usbsevseg.txt Documentation/usb/misc_usbsevseg.rst
Documentation/usb/mtouchusb.txt Documentation/usb/mtouchusb.rst
Documentation/usb/ohci.txt Documentation/usb/ohci.rst
Documentation/usb/rio.txt Documentation/usb/rio.rst
+29
Documentation/usb/text_files.rst
··· 1 + Linux CDC ACM inf 2 + ----------------- 3 + 4 + .. include:: linux-cdc-acm.inf 5 + :literal: 6 + 7 + Linux inf 8 + --------- 9 + 10 + .. include:: linux.inf 11 + :literal: 12 + 13 + USB devfs drop permissions source 14 + --------------------------------- 15 + 16 + .. literalinclude:: usbdevfs-drop-permissions.c 17 + :language: c 18 + 19 + WUSB command line script to manipulate auth credentials 20 + ------------------------------------------------------- 21 + 22 + .. literalinclude:: wusb-cbaf 23 + :language: shell 24 + 25 + Credits 26 + ------- 27 + 28 + .. include:: CREDITS 29 + :literal:
Documentation/usb/usb-help.txt Documentation/usb/usb-help.rst
Documentation/usb/usb-serial.txt Documentation/usb/usb-serial.rst
Documentation/usb/usbip_protocol.txt Documentation/usb/usbip_protocol.rst
Documentation/usb/usbmon.txt Documentation/usb/usbmon.rst
+6 -6
MAINTAINERS
··· 3751 3751 CERTIFIED WIRELESS USB (WUSB) SUBSYSTEM: 3752 3752 L: linux-usb@vger.kernel.org 3753 3753 S: Orphan 3754 - F: Documentation/usb/WUSB-Design-overview.txt 3754 + F: Documentation/usb/wusb-design-overview.rst 3755 3755 F: Documentation/usb/wusb-cbaf 3756 3756 F: drivers/usb/host/hwa-hc.c 3757 3757 F: drivers/usb/host/whci/ ··· 16238 16238 M: Oliver Neukum <oneukum@suse.com> 16239 16239 L: linux-usb@vger.kernel.org 16240 16240 S: Maintained 16241 - F: Documentation/usb/acm.txt 16241 + F: Documentation/usb/acm.rst 16242 16242 F: drivers/usb/class/cdc-acm.* 16243 16243 16244 16244 USB AR5523 WIRELESS DRIVER ··· 16291 16291 M: Alan Stern <stern@rowland.harvard.edu> 16292 16292 L: linux-usb@vger.kernel.org 16293 16293 S: Maintained 16294 - F: Documentation/usb/ehci.txt 16294 + F: Documentation/usb/ehci.rst 16295 16295 F: drivers/usb/host/ehci* 16296 16296 16297 16297 USB GADGET/PERIPHERAL SUBSYSTEM ··· 16365 16365 M: Alan Stern <stern@rowland.harvard.edu> 16366 16366 L: linux-usb@vger.kernel.org 16367 16367 S: Maintained 16368 - F: Documentation/usb/ohci.txt 16368 + F: Documentation/usb/ohci.rst 16369 16369 F: drivers/usb/host/ohci* 16370 16370 16371 16371 USB OTG FSM (Finite State Machine) ··· 16381 16381 M: Shuah Khan <skhan@linuxfoundation.org> 16382 16382 L: linux-usb@vger.kernel.org 16383 16383 S: Maintained 16384 - F: Documentation/usb/usbip_protocol.txt 16384 + F: Documentation/usb/usbip_protocol.rst 16385 16385 F: drivers/usb/usbip/ 16386 16386 F: tools/usb/usbip/ 16387 16387 F: tools/testing/selftests/drivers/usb/usbip/ ··· 16429 16429 L: linux-usb@vger.kernel.org 16430 16430 T: git git://git.kernel.org/pub/scm/linux/kernel/git/johan/usb-serial.git 16431 16431 S: Maintained 16432 - F: Documentation/usb/usb-serial.txt 16432 + F: Documentation/usb/usb-serial.rst 16433 16433 F: drivers/usb/serial/ 16434 16434 F: include/linux/usb/serial.h 16435 16435
+1 -1
drivers/usb/Kconfig
··· 74 74 After choosing your HCD, then select drivers for the USB peripherals 75 75 you'll be using. You may want to check out the information provided 76 76 in <file:Documentation/usb/> and especially the links given in 77 - <file:Documentation/usb/usb-help.txt>. 77 + <file:Documentation/usb/usb-help.rst>. 78 78 79 79 To compile this driver as a module, choose M here: the 80 80 module will be called usbcore.
+1 -1
drivers/usb/class/Kconfig
··· 10 10 ---help--- 11 11 This driver supports USB modems and ISDN adapters which support the 12 12 Communication Device Class Abstract Control Model interface. 13 - Please read <file:Documentation/usb/acm.txt> for details. 13 + Please read <file:Documentation/usb/acm.rst> for details. 14 14 15 15 If your modem only reports "Cls=ff(vend.)" in the descriptors in 16 16 /sys/kernel/debug/usb/devices, then your modem will not work with this
+3 -3
drivers/usb/gadget/Kconfig
··· 228 228 specified simply by creating appropriate directories in configfs. 229 229 Associating functions with configurations is done by creating 230 230 appropriate symbolic links. 231 - For more information see Documentation/usb/gadget_configfs.txt. 231 + For more information see Documentation/usb/gadget_configfs.rst. 232 232 233 233 config USB_CONFIGFS_SERIAL 234 234 bool "Generic serial bulk in/out" ··· 441 441 The HID function driver provides generic emulation of USB 442 442 Human Interface Devices (HID). 443 443 444 - For more information, see Documentation/usb/gadget_hid.txt. 444 + For more information, see Documentation/usb/gadget_hid.rst. 445 445 446 446 config USB_CONFIGFS_F_UVC 447 447 bool "USB Webcam function" ··· 466 466 receive or send printer data. It can use ioctl calls to 467 467 the device file to get or set printer status. 468 468 469 - For more information, see Documentation/usb/gadget_printer.txt 469 + For more information, see Documentation/usb/gadget_printer.rst 470 470 which includes sample code for accessing the device file. 471 471 472 472 config USB_CONFIGFS_F_TCM
+1 -1
drivers/usb/gadget/function/f_mass_storage.c
··· 47 47 * 48 48 * For more information about MSF and in particular its module 49 49 * parameters and sysfs interface read the 50 - * <Documentation/usb/mass-storage.txt> file. 50 + * <Documentation/usb/mass-storage.rst> file. 51 51 */ 52 52 53 53 /*
+3 -3
drivers/usb/gadget/legacy/Kconfig
··· 287 287 Say "y" to link the driver statically, or "m" to build a 288 288 dynamically linked module called "g_serial". 289 289 290 - For more information, see Documentation/usb/gadget_serial.txt 290 + For more information, see Documentation/usb/gadget_serial.rst 291 291 which includes instructions and a "driver info file" needed to 292 292 make MS-Windows work with CDC ACM. 293 293 ··· 321 321 Say "y" to link the driver statically, or "m" to build a 322 322 dynamically linked module called "g_printer". 323 323 324 - For more information, see Documentation/usb/gadget_printer.txt 324 + For more information, see Documentation/usb/gadget_printer.rst 325 325 which includes sample code for accessing the device file. 326 326 327 327 if TTY ··· 436 436 The HID gadget driver provides generic emulation of USB 437 437 Human Interface Devices (HID). 438 438 439 - For more information, see Documentation/usb/gadget_hid.txt which 439 + For more information, see Documentation/usb/gadget_hid.rst which 440 440 includes sample code for accessing the device files. 441 441 442 442 Say "y" to link the driver statically, or "m" to build a
+1 -1
drivers/usb/host/Kconfig
··· 114 114 Controller Driver or UHCI (for Via motherboards) Host Controller 115 115 Driver too. 116 116 117 - You may want to read <file:Documentation/usb/ehci.txt>. 117 + You may want to read <file:Documentation/usb/ehci.rst>. 118 118 119 119 To compile this driver as a module, choose M here: the 120 120 module will be called ehci-hcd.
+1 -1
drivers/usb/misc/Kconfig
··· 51 51 tristate "USB Diamond Rio500 support" 52 52 help 53 53 Say Y here if you want to connect a USB Rio500 mp3 player to your 54 - computer's USB port. Please read <file:Documentation/usb/rio.txt> 54 + computer's USB port. Please read <file:Documentation/usb/rio.rst> 55 55 for more information. 56 56 57 57 To compile this driver as a module, choose M here: the
+1 -1
drivers/usb/mon/Kconfig
··· 8 8 help 9 9 If you select this option, a component which captures the USB traffic 10 10 between peripheral-specific drivers and HC drivers will be built. 11 - For more information, see <file:Documentation/usb/usbmon.txt>. 11 + For more information, see <file:Documentation/usb/usbmon.rst>. 12 12 13 13 If unsure, say Y, if allowed, otherwise M.
+5 -5
drivers/usb/serial/Kconfig
··· 11 11 ports, or acts like a serial device, and you want to connect it to 12 12 your USB bus. 13 13 14 - Please read <file:Documentation/usb/usb-serial.txt> for more 14 + Please read <file:Documentation/usb/usb-serial.rst> for more 15 15 information on the specifics of the different devices that are 16 16 supported, and on how to use them. 17 17 ··· 47 47 bool "USB Generic Serial Driver" 48 48 help 49 49 Say Y here if you want to use the generic USB serial driver. Please 50 - read <file:Documentation/usb/usb-serial.txt> for more information on 50 + read <file:Documentation/usb/usb-serial.rst> for more information on 51 51 using this driver. It is recommended that the "USB Serial converter 52 52 support" be compiled as a module for this driver to be used 53 53 properly. ··· 163 163 help 164 164 Say Y here if you want to connect to your Empeg empeg-car Mark I/II 165 165 mp3 player via USB. The driver uses a single ttyUSB{0,1,2,...} 166 - device node. See <file:Documentation/usb/usb-serial.txt> for more 166 + device node. See <file:Documentation/usb/usb-serial.rst> for more 167 167 tidbits of information. 168 168 169 169 To compile this driver as a module, choose M here: the ··· 199 199 Say Y here if you want to connect to your Compaq iPAQ, HP Jornada 200 200 or any other PDA running Windows CE 3.0 or PocketPC 2002 201 201 using a USB cradle/cable. For information on using the driver, 202 - read <file:Documentation/usb/usb-serial.txt>. 202 + read <file:Documentation/usb/usb-serial.rst>. 203 203 204 204 To compile this driver as a module, choose M here: the 205 205 module will be called ipaq. ··· 334 334 adapter sold by Palm Inc. for use with their Palm III and Palm V 335 335 series PDAs. 336 336 337 - Please read <file:Documentation/usb/usb-serial.txt> for more 337 + Please read <file:Documentation/usb/usb-serial.rst> for more 338 338 information. 339 339 340 340 To compile this driver as a module, choose M here: the
+1 -1
drivers/usb/serial/belkin_sa.c
··· 10 10 * and associated source files. Please see the usb/serial files for 11 11 * individual credits and copyrights. 12 12 * 13 - * See Documentation/usb/usb-serial.txt for more information on using this 13 + * See Documentation/usb/usb-serial.rst for more information on using this 14 14 * driver 15 15 * 16 16 * TODO:
+1 -1
drivers/usb/serial/belkin_sa.h
··· 9 9 * and associated source files. Please see the usb/serial files for 10 10 * individual credits and copyrights. 11 11 * 12 - * See Documentation/usb/usb-serial.txt for more information on using this 12 + * See Documentation/usb/usb-serial.rst for more information on using this 13 13 * driver 14 14 * 15 15 * 12-Mar-2001 gkh
+1 -1
drivers/usb/serial/cypress_m8.c
··· 7 7 * Copyright (C) 2003,2004 8 8 * Neil Whelchel (koyama@firstlight.net) 9 9 * 10 - * See Documentation/usb/usb-serial.txt for more information on using this 10 + * See Documentation/usb/usb-serial.rst for more information on using this 11 11 * driver 12 12 * 13 13 * See http://geocities.com/i0xox0i for information on this driver and the
+1 -1
drivers/usb/serial/empeg.c
··· 8 8 * Copyright (C) 1999 - 2001 9 9 * Greg Kroah-Hartman (greg@kroah.com) 10 10 * 11 - * See Documentation/usb/usb-serial.txt for more information on using this 11 + * See Documentation/usb/usb-serial.rst for more information on using this 12 12 * driver 13 13 */ 14 14
+1 -1
drivers/usb/serial/ftdi_sio.c
··· 10 10 * Copyright (C) 2002 11 11 * Kuba Ober (kuba@mareimbrium.org) 12 12 * 13 - * See Documentation/usb/usb-serial.txt for more information on using this 13 + * See Documentation/usb/usb-serial.rst for more information on using this 14 14 * driver 15 15 * 16 16 * See http://ftdi-usb-sio.sourceforge.net for up to date testing info
+1 -1
drivers/usb/serial/ir-usb.c
··· 16 16 * was written by Roman Weissgaerber <weissg@vienna.at>, Dag Brattli 17 17 * <dag@brattli.net>, and Jean Tourrilhes <jt@hpl.hp.com> 18 18 * 19 - * See Documentation/usb/usb-serial.txt for more information on using this 19 + * See Documentation/usb/usb-serial.rst for more information on using this 20 20 * driver 21 21 */ 22 22
+1 -1
drivers/usb/serial/keyspan_pda.c
··· 6 6 * Copyright (C) 1999, 2000 Brian Warner <warner@lothar.com> 7 7 * Copyright (C) 2000 Al Borchers <borchers@steinerpoint.com> 8 8 * 9 - * See Documentation/usb/usb-serial.txt for more information on using this 9 + * See Documentation/usb/usb-serial.rst for more information on using this 10 10 * driver 11 11 */ 12 12
+1 -1
drivers/usb/serial/omninet.c
··· 4 4 * 5 5 * Copyright (C) 2013,2017 Johan Hovold <johan@kernel.org> 6 6 * 7 - * See Documentation/usb/usb-serial.txt for more information on using this 7 + * See Documentation/usb/usb-serial.rst for more information on using this 8 8 * driver 9 9 * 10 10 * Please report both successes and troubles to the author at omninet@kroah.com
+1 -1
drivers/usb/serial/oti6858.c
··· 22 22 * So, THIS CODE CAN DESTROY OTi-6858 AND ANY OTHER DEVICES, THAT ARE 23 23 * CONNECTED TO IT! 24 24 * 25 - * See Documentation/usb/usb-serial.txt for more information on using this 25 + * See Documentation/usb/usb-serial.rst for more information on using this 26 26 * driver 27 27 * 28 28 * TODO:
+1 -1
drivers/usb/serial/pl2303.c
··· 7 7 * 8 8 * Original driver for 2.2.x by anonymous 9 9 * 10 - * See Documentation/usb/usb-serial.txt for more information on using this 10 + * See Documentation/usb/usb-serial.rst for more information on using this 11 11 * driver 12 12 */ 13 13
+1 -1
drivers/usb/serial/usb-serial.c
··· 10 10 * This driver was originally based on the ACM driver by Armin Fuerst (which was 11 11 * based on a driver by Brad Keryan) 12 12 * 13 - * See Documentation/usb/usb-serial.txt for more information on using this 13 + * See Documentation/usb/usb-serial.rst for more information on using this 14 14 * driver 15 15 */ 16 16
+1 -1
drivers/usb/serial/visor.c
··· 6 6 * Copyright (C) 1999 - 2004 7 7 * Greg Kroah-Hartman (greg@kroah.com) 8 8 * 9 - * See Documentation/usb/usb-serial.txt for more information on using this 9 + * See Documentation/usb/usb-serial.rst for more information on using this 10 10 * driver 11 11 * 12 12 */
+1 -1
drivers/usb/serial/visor.h
··· 5 5 * Copyright (C) 1999 - 2003 6 6 * Greg Kroah-Hartman (greg@kroah.com) 7 7 * 8 - * See Documentation/usb/usb-serial.txt for more information on using this 8 + * See Documentation/usb/usb-serial.rst for more information on using this 9 9 * driver. 10 10 * 11 11 */
+1 -1
drivers/usb/serial/whiteheat.c
··· 8 8 * Copyright (C) 1999 - 2001 9 9 * Greg Kroah-Hartman (greg@kroah.com) 10 10 * 11 - * See Documentation/usb/usb-serial.txt for more information on using this 11 + * See Documentation/usb/usb-serial.rst for more information on using this 12 12 * driver 13 13 */ 14 14
+1 -1
drivers/usb/serial/whiteheat.h
··· 8 8 * Copyright (C) 1999, 2000 9 9 * Greg Kroah-Hartman (greg@kroah.com) 10 10 * 11 - * See Documentation/usb/usb-serial.txt for more information on using this 11 + * See Documentation/usb/usb-serial.rst for more information on using this 12 12 * driver 13 13 * 14 14 */