Re: [PATCH v13 09/10] usbip: exporting devices: chage to documenattion

[Shuah Khan]

On 12/02/2016 10:16 AM, Krzysztof Opasiak wrote:
> 
> 
> On 11/22/2016 07:48 AM, Nobuo Iwata wrote:
>> This patch adds function and usage of new connect operation, disconnect 
>> operation and application(vhci)-side daemon to README and manuals.
>>
>> At this point, the wording, 'server' and 'client' are ambiguous in 
>> several place.
>>
>> For existing attach command, the daemon runs device side machine and 
>> attach command is executed in application side machine. Then 'server' 
>> is used for device side and 'client' is for application side.
>>
>> For the new connect command, the daemon runs applications side machine 
>> and connect command is executed in device side machine. Now, 'server' 
>> and 'client' run in different machine than before.
>>
>> To avoid confusion, to represent things to be done in device side node 
>> by both command and daemon, words 'device-side' is used instead of 
>> 'server'. To represent things to be done is application side node by 
>> both command and daemon, 'applicationr-side' are used instead of 
>> 'client'.
>>
> 
> In my humble opinion device side is not a good term.
> 
> Meaning of Device Side means USB gadget so using it here may cause
> misunderstanding. Application side I think is also not a perfect choice.
> 
> Current terminology (server/client) is also imperfect after this series.

Introduce a new word for the intermediate server - In any case I have yet
to see a good argument for why we need this patch series.

> 
> Maybe using a terms from semiconductors world like donor (machine which
> provides the device) and acceptor (machine which accepts the device)
> would be better?
> 
> Best regards,
> 

Please don't introduce new terminology. The current terminology is
correct and makes sense:

Server - system with device physically attached that exports the devices
Client - system that imports the device.

thanks,
-- Shuah

-- 
Shuah Khan
Sr. Linux Kernel Developer
Open Source Innovation Group
Samsung Research America(Silicon Valley)
shuah...@samsung.com
--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v13 09/10] usbip: exporting devices: chage to documenattion

[Krzysztof Opasiak]

On 12/02/2016 06:21 PM, Shuah Khan wrote:
> On 12/02/2016 10:16 AM, Krzysztof Opasiak wrote:
>>
>>
>> On 11/22/2016 07:48 AM, Nobuo Iwata wrote:
>>> This patch adds function and usage of new connect operation, disconnect 
>>> operation and application(vhci)-side daemon to README and manuals.
>>>
>>> At this point, the wording, 'server' and 'client' are ambiguous in 
>>> several place.
>>>
>>> For existing attach command, the daemon runs device side machine and 
>>> attach command is executed in application side machine. Then 'server' 
>>> is used for device side and 'client' is for application side.
>>>
>>> For the new connect command, the daemon runs applications side machine 
>>> and connect command is executed in device side machine. Now, 'server' 
>>> and 'client' run in different machine than before.
>>>
>>> To avoid confusion, to represent things to be done in device side node 
>>> by both command and daemon, words 'device-side' is used instead of 
>>> 'server'. To represent things to be done is application side node by 
>>> both command and daemon, 'applicationr-side' are used instead of 
>>> 'client'.
>>>
>>
>> In my humble opinion device side is not a good term.
>>
>> Meaning of Device Side means USB gadget so using it here may cause
>> misunderstanding. Application side I think is also not a perfect choice.
>>
>> Current terminology (server/client) is also imperfect after this series.
> 
> Introduce a new word for the intermediate server - In any case I have yet
> to see a good argument for why we need this patch series.
> 

I will post my summary after going through all patches in this series as
a reply to cover letter.

>>
>> Maybe using a terms from semiconductors world like donor (machine which
>> provides the device) and acceptor (machine which accepts the device)
>> would be better?
>>
>> Best regards,
>>
> 
> Please don't introduce new terminology. The current terminology is
> correct and makes sense:
> 
> Server - system with device physically attached that exports the devices
> Client - system that imports the device.

Totally agree that it makes sens unless this series is applied.
If we apply this series then server and client is a little bit ambiguous.

Best regards,
-- 
Krzysztof Opasiak
Samsung R Institute Poland
Samsung Electronics
--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v13 09/10] usbip: exporting devices: chage to documenattion

[Krzysztof Opasiak]

On 11/22/2016 07:48 AM, Nobuo Iwata wrote:
> This patch adds function and usage of new connect operation, disconnect 
> operation and application(vhci)-side daemon to README and manuals.
> 
> At this point, the wording, 'server' and 'client' are ambiguous in 
> several place.
> 
> For existing attach command, the daemon runs device side machine and 
> attach command is executed in application side machine. Then 'server' 
> is used for device side and 'client' is for application side.
> 
> For the new connect command, the daemon runs applications side machine 
> and connect command is executed in device side machine. Now, 'server' 
> and 'client' run in different machine than before.
> 
> To avoid confusion, to represent things to be done in device side node 
> by both command and daemon, words 'device-side' is used instead of 
> 'server'. To represent things to be done is application side node by 
> both command and daemon, 'applicationr-side' are used instead of 
> 'client'.
> 

In my humble opinion device side is not a good term.

Meaning of Device Side means USB gadget so using it here may cause
misunderstanding. Application side I think is also not a perfect choice.

Current terminology (server/client) is also imperfect after this series.

Maybe using a terms from semiconductors world like donor (machine which
provides the device) and acceptor (machine which accepts the device)
would be better?

Best regards,
-- 
Krzysztof Opasiak
Samsung R Institute Poland
Samsung Electronics
--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH v13 09/10] usbip: exporting devices: chage to documenattion

[Nobuo Iwata]

This patch adds function and usage of new connect operation, disconnect 
operation and application(vhci)-side daemon to README and manuals.

At this point, the wording, 'server' and 'client' are ambiguous in 
several place.

For existing attach command, the daemon runs device side machine and 
attach command is executed in application side machine. Then 'server' 
is used for device side and 'client' is for application side.

For the new connect command, the daemon runs applications side machine 
and connect command is executed in device side machine. Now, 'server' 
and 'client' run in different machine than before.

To avoid confusion, to represent things to be done in device side node 
by both command and daemon, words 'device-side' is used instead of 
'server'. To represent things to be done is application side node by 
both command and daemon, 'applicationr-side' are used instead of 
'client'.

EXISTING) - invites devices from application(vhci)-side
 +--+ +--+
 device--+ STUB | | application/VHCI |
 +--+ +--+
 1) usbipd ... start daemon
 = = =
 2) usbip list --local
 3) usbip bind
<--- list bound devices ---   4) usbip list --remote
<--- import a device --   5) usbip attach
 = = =
   X disconnected 6) usbip detach
 7) usbip unbind

NEW) - dedicates devices from device(stb)-side
 +--+ +--+
 device--+ STUB | | application/VHCI |
 +--+ +--+
  1) usbipa ... start daemon
 = = =
 2) usbip list --local
 3) usbip connect --- export a device -->
 = = =
 4) usbip disconnect  --- un-export a device --->

Signed-off-by: Nobuo Iwata 
---
 tools/usb/usbip/Makefile.am  |   2 +-
 tools/usb/usbip/README   |  70 --
 tools/usb/usbip/doc/usbip.8  | 136 ---
 tools/usb/usbip/doc/usbipa.8 |  78 
 tools/usb/usbip/doc/usbipd.8 |  38 +-
 5 files changed, 263 insertions(+), 61 deletions(-)

diff --git a/tools/usb/usbip/Makefile.am b/tools/usb/usbip/Makefile.am
index 66f8bf0..f371ed9 100644
--- a/tools/usb/usbip/Makefile.am
+++ b/tools/usb/usbip/Makefile.am
@@ -3,4 +3,4 @@ includedir = @includedir@/usbip
 include_HEADERS := $(addprefix libsrc/, \
 usbip_common.h vhci_driver.h usbip_host_driver.h)
 
-dist_man_MANS := $(addprefix doc/, usbip.8 usbipd.8)
+dist_man_MANS := $(addprefix doc/, usbip.8 usbipd.8 usbipa.8)
diff --git a/tools/usb/usbip/README b/tools/usb/usbip/README
index 831f49f..74f4afb 100644
--- a/tools/usb/usbip/README
+++ b/tools/usb/usbip/README
@@ -1,7 +1,8 @@
 #
 # README for usbip-utils
 #
-# Copyright (C) 2011 matt mooney 
+# Copyright (C) 2015 Nobuo Iwata
+#   2011 matt mooney 
 #   2005-2008 Takahiro Hirofuchi
 
 
@@ -36,41 +37,70 @@
 
 
 [Usage]
-server:# (Physically attach your USB device.)
+Device-side: a machine has USB device(s).
+Application-side: a machine runs an application software uses remote USB 
device.
 
-server:# insmod usbip-core.ko
-server:# insmod usbip-host.ko
+1) Connect from application-side to device-side.
 
-server:# usbipd -D
+dev:# (Physically attach your USB device.)
+
+dev:# insmod usbip-core.ko
+dev:# insmod usbip-host.ko
+
+dev:# usbipd -D
- Start usbip daemon.
 
-server:# usbip list -l
-   - List driver assignments for USB devices.
+dev:# usbip list -l
+   - List driver assignments for USB devices and their busid.
 
-server:# usbip bind --busid 1-2
-   - Bind usbip-host.ko to the device with busid 1-2.
-   - The USB device 1-2 is now exportable to other hosts!
-   - Use `usbip unbind --busid 1-2' to stop exporting the device.
+dev:# usbip bind --busid 
+   - Bind usbip-host.ko to the device with .
+   - The USB device with  is now exportable to other hosts!
+   - Use `usbip unbind --busid ` to stop exporting the device.
 
-client:# insmod usbip-core.ko
-client:# insmod vhci-hcd.ko
+app:# insmod usbip-core.ko
+app:# insmod vhci-hcd.ko
 
-client:# usbip list --remote 
+app:# usbip list --remote 
- List exported USB devices on the .
 
-client:# usbip attach --remote  --busid 1-2
+app:# usbip attach --remote  --busid 
- Connect the remote USB device.
 
-client:# usbip port
+app:# usbip port
- Show virtual port status.
 
-client:# usbip detach --port 
+app:# usbip detach --port 
- Detach the USB device.
 
+2) Connect from device-side to application-side.
+
+app:# insmod usbip-core.ko
+app:# insmod