Skip to content

Commit

Permalink
Documentation/ABI/testing: configfs-based usb gadgets
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Andrzej Pietrasiewicz authored and gregkh committed Jun 17, 2013
1 parent 5e654a4 commit 5b92f46
Show file tree
Hide file tree
Showing 10 changed files with 142 additions and 4 deletions.
81 changes: 81 additions & 0 deletions Documentation/ABI/testing/configfs-usb-gadget
Original file line number Diff line number Diff line change
@@ -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

8 changes: 8 additions & 0 deletions Documentation/ABI/testing/configfs-usb-gadget-acm
Original file line number Diff line number Diff line change
@@ -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".
16 changes: 16 additions & 0 deletions Documentation/ABI/testing/configfs-usb-gadget-ecm
Original file line number Diff line number Diff line change
@@ -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


2 changes: 1 addition & 1 deletion Documentation/ABI/testing/configfs-usb-gadget-eem
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
What: /config/usb-gadget/gadget/functions/eem.name
Date: May 2013
Date: Jun 2013
KenelVersion: 3.11
Description:
The attributes:
Expand Down
15 changes: 15 additions & 0 deletions Documentation/ABI/testing/configfs-usb-gadget-ncm
Original file line number Diff line number Diff line change
@@ -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

9 changes: 9 additions & 0 deletions Documentation/ABI/testing/configfs-usb-gadget-obex
Original file line number Diff line number Diff line change
@@ -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".

2 changes: 1 addition & 1 deletion Documentation/ABI/testing/configfs-usb-gadget-phonet
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
What: /config/usb-gadget/gadget/functions/phonet.name
Date: May 2013
Date: Jun 2013
KenelVersion: 3.11
Description:

Expand Down
2 changes: 1 addition & 1 deletion Documentation/ABI/testing/configfs-usb-gadget-rndis
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
What: /config/usb-gadget/gadget/functions/rndis.name
Date: May 2013
Date: Jun 2013
KenelVersion: 3.11
Description:
The attributes:
Expand Down
9 changes: 9 additions & 0 deletions Documentation/ABI/testing/configfs-usb-gadget-serial
Original file line number Diff line number Diff line change
@@ -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".

2 changes: 1 addition & 1 deletion Documentation/ABI/testing/configfs-usb-gadget-subset
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
What: /config/usb-gadget/gadget/functions/geth.name
Date: May 2013
Date: Jun 2013
KenelVersion: 3.11
Description:
The attributes:
Expand Down

0 comments on commit 5b92f46

Please sign in to comment.