summaryrefslogtreecommitdiffstats
path: root/Documentation/usb
diff options
context:
space:
mode:
authorAndrzej Pietrasiewicz <andrzej.p@samsung.com>2014-12-16 14:56:29 +0100
committerFelipe Balbi <balbi@ti.com>2015-01-12 12:13:25 -0600
commit2c0f62f9e4f2c450342369dfd5858db51bc90fe3 (patch)
tree2bd41a8ddf285a79bc0bda08fa569be419899566 /Documentation/usb
parent4ca560a6d31d1deae004a9977adf64766e87a021 (diff)
downloadlinux-2c0f62f9e4f2c450342369dfd5858db51bc90fe3.tar.bz2
Documentation: usb: FFS function testing
Summary of how to test FFS (FunctionFS) function of USB gadget. Signed-off-by: Andrzej Pietrasiewicz <andrzej.p@samsung.com> Signed-off-by: Felipe Balbi <balbi@ti.com>
Diffstat (limited to 'Documentation/usb')
-rw-r--r--Documentation/usb/gadget-testing.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/Documentation/usb/gadget-testing.txt b/Documentation/usb/gadget-testing.txt
index 50b0a6cc6674..141a1d01f312 100644
--- a/Documentation/usb/gadget-testing.txt
+++ b/Documentation/usb/gadget-testing.txt
@@ -5,6 +5,7 @@ provided by gadgets.
2. ECM function
3. ECM subset function
4. EEM function
+5. FFS function
1. ACM function
@@ -134,3 +135,26 @@ Configure IP addresses of the device and the host. Then:
On the device: ping <host's IP>
On the host: ping <device's IP>
+
+5. FFS function
+===============
+
+The function is provided by usb_f_fs.ko module.
+
+Function-specific configfs interface
+------------------------------------
+
+The function name to use when creating the function directory is "ffs".
+The function directory is intentionally empty and not modifiable.
+
+After creating the directory there is a new instance (a "device") of FunctionFS
+available in the system. Once a "device" is available, the user should follow
+the standard procedure for using FunctionFS (mount it, run the userspace
+process which implements the function proper). The gadget should be enabled
+by writing a suitable string to usb_gadget/<gadget>/UDC.
+
+Testing the FFS function
+------------------------
+
+On the device: start the function's userspace daemon, enable the gadget
+On the host: use the USB function provided by the device