Re: [PATCH v2] usbip: fix protocol documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



I think I should have send it to Jonathan instead of Valentina, and to
linux-doc instead of linux-usb.

Alexandre Demers


On 2018-01-28 02:15, Alexandre Demers wrote:
> While reading the document, I found what seems to be 4 mistakes:
>  - 1 clarification: it seems more logical to say that the device driver on
>    the client machine is for the "imported" USB device management, not for
>    the "exported" devices;
>  - 2 typos: "the the" and "completition -> completion";
>  - 1 error in the protocol description (I think):  each device has a
>    specific path, thus every exported USB device description starts at that
>    field, not at the busid.
>
> Signed-off-by: Alexandre Demers <alexandre.f.demers@xxxxxxxxx>
> ---
>  Documentation/usb/usbip_protocol.txt | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/usb/usbip_protocol.txt b/Documentation/usb/usbip_protocol.txt
> index 16b6fe27284c..23527101e2ea 100644
> --- a/Documentation/usb/usbip_protocol.txt
> +++ b/Documentation/usb/usbip_protocol.txt
> @@ -2,7 +2,7 @@ PRELIMINARY DRAFT, MAY CONTAIN MISTAKES!
>  28 Jun 2011
>
>  The USB/IP protocol follows a server/client architecture. The server exports the
> -USB devices and the clients imports them. The device driver for the exported
> +USB devices and the clients imports them. The device driver for the imported
>  USB device runs on the client machine.
>
>  The client may ask for the list of the exported USB devices. To get the list the
> @@ -153,7 +153,7 @@ OP_REP_DEVLIST: Reply with the list of exported USB devices.
>  -----------+--------+------------+---------------------------------------------------
>   0x144     |        | m_0        | From now on each interface is described, all
>             |        |            |   together bNumInterfaces times, with the
> -           |        |            |   the following 4 fields:
> +           |        |            |   following 4 fields:
>  -----------+--------+------------+---------------------------------------------------
>             | 1      |            | bInterfaceClass
>  -----------+--------+------------+---------------------------------------------------
> @@ -164,7 +164,7 @@ OP_REP_DEVLIST: Reply with the list of exported USB devices.
>   0x147     | 1      |            | padding byte for alignment, shall be set to zero
>  -----------+--------+------------+---------------------------------------------------
>   0xC +     |        |            | The second exported USB device starts at i=1
> - i*0x138 + |        |            | with the busid field.
> + i*0x138 + |        |            | with the path field.
>   m_(i-1)*4 |        |            |
>
>  OP_REQ_IMPORT: Request to import (attach) a remote USB device.
> @@ -351,7 +351,7 @@ USBIP_RET_UNLINK: Reply for URB unlink
>   0x10      | 4      |            | ep: endpoint number
>  -----------+--------+------------+---------------------------------------------------
>   0x14      | 4      |            | status: This is the value contained in the
> -           |        |            |   urb->status in the URB completition handler.
> +           |        |            |   urb->status in the URB completion handler.
>             |        |            |   FIXME: a better explanation needed.
>  -----------+--------+------------+---------------------------------------------------
>   0x30      | n      |            | URB data bytes. For ISO transfers the padding
> --
> 2.16.1.windows.1

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux