linux/Documentation/usb
Hongren Zheng (Zenithal) 17af793217 docs: usbip: Fix major fields and descriptions in protocol
The old document for usbip protocol is misleading and hard to read:
  * Some fields in header are incorrect
  * Explanation of some fields are unclear or even wrong
  * Padding of header (namely all headers have the same length) is
    not explicitly pointed out, which is crucial for stream protocol
    like TCP

Major changes:
  * Document the correct field as described in the codebase.
  * Document the padding in usbip headers. This is crucial for TCP
    stream hence these padding should be explicitly point out.
    In code these padding are implemented by a union of all headers.
  * Fix two FIXME related to usbip unlink and Document the behavior
    of unlink in different situation.
  * Clarify some field with more accurate explanation, like those
    fields associated with URB. Some constraints are extracted from
    code.
  * Delete specific transfer_flag doc in usbip as it should be
    documented by the URB doc in Documentation/driver-api/usb/URB.rst
  * Add data captured from wire as example

Version change:
    From "PRELIMINARY DRAFT, MAY CONTAIN MISTAKES, 28 Jun 2011"
    To "Version 1, 31 Mar 2021"

Co-developed-by: Alexandre Demers <alexandre.f.demers@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Hongren Zheng <i@zenithal.me>
Link: https://lore.kernel.org/r/YGNZHfmAbHO6fyAr@Sun
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2021-04-09 16:04:45 +02:00
..
acm.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
authorization.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
chipidea.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
CREDITS
dwc3.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
ehci.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
functionfs.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
gadget_configfs.rst docs: filesystems: convert configfs.txt to ReST 2020-05-05 09:23:25 -06:00
gadget_hid.rst USB: Replace HTTP links with HTTPS ones 2020-07-21 13:41:57 +02:00
gadget_multi.rst USB: Replace HTTP links with HTTPS ones 2020-07-21 13:41:57 +02:00
gadget_printer.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
gadget_serial.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
gadget-testing.rst usb: gadget: u_ether: support configuring interface names. 2021-01-15 16:08:53 +01:00
index.rst usb: gadget: add raw-gadget interface 2020-03-15 11:34:48 +02:00
iuu_phoenix.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
linux-cdc-acm.inf USB: linux-cdc-acm.inf: add support for the acm_ms gadget 2011-11-29 09:59:29 +09:00
linux.inf USB: Replace HTTP links with HTTPS ones 2020-07-21 13:41:57 +02:00
mass-storage.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
misc_usbsevseg.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
mtouchusb.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
ohci.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
raw-gadget.rst usb: raw-gadget: update documentation and Kconfig 2021-01-26 18:38:45 +01:00
text_files.rst docs: usb: remove some broken references 2020-01-28 13:41:22 -07:00
usb-help.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
usb-serial.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00
usbdevfs-drop-permissions.c usb: devio: Add ioctl to disallow detaching kernel USB drivers. 2016-03-05 12:05:01 -08:00
usbip_protocol.rst docs: usbip: Fix major fields and descriptions in protocol 2021-04-09 16:04:45 +02:00
usbmon.rst docs: usb: rename files to .rst and add them to drivers-api 2019-06-20 14:28:36 +02:00