Documentation/ABI/testing: configfs-based usb gadgets

Signed-off-by: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com>
Acked-by: Felipe Balbi <balbi@ti.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/Documentation/ABI/testing/configfs-usb-gadget b/Documentation/ABI/testing/configfs-usb-gadget
new file mode 100644 (file)
index 0000000..01e769d
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-usb-gadget
@@ -0,0 +1,81 @@
+What:          /config/usb-gadget
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+               This group contains sub-groups corresponding to created
+               USB gadgets.
+
+What:          /config/usb-gadget/gadget
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+
+               The attributes of a gadget:
+
+               UDC             - bind a gadget to UDC/unbind a gadget;
+                               write UDC's name found in /sys/class/udc/*
+                               to bind a gadget, empty string "" to unbind.
+
+               bDeviceClass    - USB device class code
+               bDeviceSubClass - USB device subclass code
+               bDeviceProtocol - USB device protocol code
+               bMaxPacketSize0 - maximum endpoint 0 packet size
+               bcdDevice       - bcd device release number
+               bcdUSB          - bcd USB specification version number
+               idProduct       - product ID
+               idVendor        - vendor ID
+
+What:          /config/usb-gadget/gadget/configs
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+               This group contains a USB gadget's configurations
+
+What:          /config/usb-gadget/gadget/configs/config
+Date:          Jun 2013
+KernelVersion: 3.11
+Description:
+               The attributes of a configuration:
+
+               bmAttributes    - configuration characteristics
+               MaxPower        - maximum power consumption from the bus
+
+What:          /config/usb-gadget/gadget/configs/config/strings
+Date:          Jun 2013
+KernelVersion: 3.11
+Description:
+               This group contains subdirectories for language-specific
+               strings for this configuration.
+
+What:          /config/usb-gadget/gadget/configs/config/strings/language
+Date:          Jun 2013
+KernelVersion: 3.11
+Description:
+               The attributes:
+
+               configuration   - configuration description
+
+
+What:          /config/usb-gadget/gadget/functions
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+               This group contains functions available to this USB gadget.
+
+What:          /config/usb-gadget/gadget/strings
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+               This group contains subdirectories for language-specific
+               strings for this gadget.
+
+What:          /config/usb-gadget/gadget/strings/language
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+               The attributes:
+
+               serialnumber    - gadget's serial number (string)
+               product         - gadget's product description
+               manufacturer    - gadget's manufacturer description
+

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-acm b/Documentation/ABI/testing/configfs-usb-gadget-acm
new file mode 100644 (file)
index 0000000..5708a56
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-usb-gadget-acm
@@ -0,0 +1,8 @@
+What:          /config/usb-gadget/gadget/functions/acm.name
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+
+               This item contains just one readonly attribute: port_num.
+               It contains the port number of the /dev/ttyGS<n> device
+               associated with acm function's instance "name".

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-ecm b/Documentation/ABI/testing/configfs-usb-gadget-ecm
new file mode 100644 (file)
index 0000000..6b9a582
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-usb-gadget-ecm
@@ -0,0 +1,16 @@
+What:          /config/usb-gadget/gadget/functions/ecm.name
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+               The attributes:
+
+               ifname          - network device interface name associated with
+                               this function instance
+               qmult           - queue length multiplier for high and
+                               super speed
+               host_addr       - MAC address of host's end of this
+                               Ethernet over USB link
+               dev_addr        - MAC address of device's end of this
+                               Ethernet over USB link
+
+

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-eem b/Documentation/ABI/testing/configfs-usb-gadget-eem
index 10e87d6..dbddf36 100644 (file)
--- a/Documentation/ABI/testing/configfs-usb-gadget-eem
+++ b/Documentation/ABI/testing/configfs-usb-gadget-eem
@@ -1,5 +1,5 @@
 What:          /config/usb-gadget/gadget/functions/eem.name
-Date:          May 2013
+Date:          Jun 2013
 KenelVersion:  3.11
 Description:
                The attributes:

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-ncm b/Documentation/ABI/testing/configfs-usb-gadget-ncm
new file mode 100644 (file)
index 0000000..bc309f4
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-usb-gadget-ncm
@@ -0,0 +1,15 @@
+What:          /config/usb-gadget/gadget/functions/ncm.name
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+               The attributes:
+
+               ifname          - network device interface name associated with
+                               this function instance
+               qmult           - queue length multiplier for high and
+                               super speed
+               host_addr       - MAC address of host's end of this
+                               Ethernet over USB link
+               dev_addr        - MAC address of device's end of this
+                               Ethernet over USB link
+

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-obex b/Documentation/ABI/testing/configfs-usb-gadget-obex
new file mode 100644 (file)
index 0000000..aaa5c96
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-usb-gadget-obex
@@ -0,0 +1,9 @@
+What:          /config/usb-gadget/gadget/functions/obex.name
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+
+               This item contains just one readonly attribute: port_num.
+               It contains the port number of the /dev/ttyGS<n> device
+               associated with obex function's instance "name".
+

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-phonet b/Documentation/ABI/testing/configfs-usb-gadget-phonet
index 19b67d3..3e3b742 100644 (file)
--- a/Documentation/ABI/testing/configfs-usb-gadget-phonet
+++ b/Documentation/ABI/testing/configfs-usb-gadget-phonet
@@ -1,5 +1,5 @@
 What:          /config/usb-gadget/gadget/functions/phonet.name
-Date:          May 2013
+Date:          Jun 2013
 KenelVersion:  3.11
 Description:
 

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-rndis b/Documentation/ABI/testing/configfs-usb-gadget-rndis
index ff127dd..822e6da 100644 (file)
--- a/Documentation/ABI/testing/configfs-usb-gadget-rndis
+++ b/Documentation/ABI/testing/configfs-usb-gadget-rndis
@@ -1,5 +1,5 @@
 What:          /config/usb-gadget/gadget/functions/rndis.name
-Date:          May 2013
+Date:          Jun 2013
 KenelVersion:  3.11
 Description:
                The attributes:

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-serial b/Documentation/ABI/testing/configfs-usb-gadget-serial
new file mode 100644 (file)
index 0000000..16f130c
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-usb-gadget-serial
@@ -0,0 +1,9 @@
+What:          /config/usb-gadget/gadget/functions/gser.name
+Date:          Jun 2013
+KenelVersion:  3.11
+Description:
+
+               This item contains just one readonly attribute: port_num.
+               It contains the port number of the /dev/ttyGS<n> device
+               associated with gser function's instance "name".
+

diff --git a/Documentation/ABI/testing/configfs-usb-gadget-subset b/Documentation/ABI/testing/configfs-usb-gadget-subset
index f47170a..154ae59 100644 (file)
--- a/Documentation/ABI/testing/configfs-usb-gadget-subset
+++ b/Documentation/ABI/testing/configfs-usb-gadget-subset
@@ -1,5 +1,5 @@
 What:          /config/usb-gadget/gadget/functions/geth.name
-Date:          May 2013
+Date:          Jun 2013
 KenelVersion:  3.11
 Description:
                The attributes: