17af793217
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>
|
||
|---|---|---|
| .. | ||
| CREDITS | ||
| acm.rst | ||
| authorization.rst | ||
| chipidea.rst | ||
| dwc3.rst | ||
| ehci.rst | ||
| functionfs.rst | ||
| gadget-testing.rst | ||
| gadget_configfs.rst | ||
| gadget_hid.rst | ||
| gadget_multi.rst | ||
| gadget_printer.rst | ||
| gadget_serial.rst | ||
| index.rst | ||
| iuu_phoenix.rst | ||
| linux-cdc-acm.inf | ||
| linux.inf | ||
| mass-storage.rst | ||
| misc_usbsevseg.rst | ||
| mtouchusb.rst | ||
| ohci.rst | ||
| raw-gadget.rst | ||
| text_files.rst | ||
| usb-help.rst | ||
| usb-serial.rst | ||
| usbdevfs-drop-permissions.c | ||
| usbip_protocol.rst | ||
| usbmon.rst | ||