Documentation: usb: ACM function testing
authorAndrzej Pietrasiewicz <andrzej.p@samsung.com>
Tue, 16 Dec 2014 13:56:25 +0000 (14:56 +0100)
committerFelipe Balbi <balbi@ti.com>
Mon, 12 Jan 2015 18:13:24 +0000 (12:13 -0600)
The newly added file will be used to provide descriptions of how to test
the functions of USB gadgets.

Signed-off-by: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
Signed-off-by: Felipe Balbi <balbi@ti.com>
Documentation/usb/gadget-testing.txt [new file with mode: 0644]

diff --git a/Documentation/usb/gadget-testing.txt b/Documentation/usb/gadget-testing.txt
new file mode 100644 (file)
index 0000000..2a448f8
--- /dev/null
@@ -0,0 +1,34 @@
+This file summarizes information on basic testing of USB functions
+provided by gadgets.
+
+1. ACM function
+
+
+1. ACM function
+===============
+
+The function is provided by usb_f_acm.ko module.
+
+Function-specific configfs interface
+------------------------------------
+
+The function name to use when creating the function directory is "acm".
+The ACM function provides just one attribute in its function directory:
+
+       port_num
+
+The attribute is read-only.
+
+There can be at most 4 ACM/generic serial/OBEX ports in the system.
+
+
+Testing the ACM function
+------------------------
+
+On the host: cat > /dev/ttyACM<X>
+On the device : cat /dev/ttyGS<Y>
+
+then the other way round
+
+On the device: cat > /dev/ttyGS<Y>
+On the host: cat /dev/ttyACM<X>