xref: /linux/Documentation/ABI/testing/configfs-usb-gadget (revision 37744feebc086908fd89760650f458ab19071750)
1What:		/config/usb-gadget
2Date:		Jun 2013
3KernelVersion:	3.11
4Description:
5		This group contains sub-groups corresponding to created
6		USB gadgets.
7
8What:		/config/usb-gadget/gadget
9Date:		Jun 2013
10KernelVersion:	3.11
11Description:
12
13		The attributes of a gadget:
14
15		UDC		- bind a gadget to UDC/unbind a gadget;
16				write UDC's name found in /sys/class/udc/*
17				to bind a gadget, empty string "" to unbind.
18
19		max_speed	- maximum speed the driver supports. Valid
20				names are super-speed-plus, super-speed,
21				high-speed, full-speed, and low-speed.
22
23		bDeviceClass	- USB device class code
24		bDeviceSubClass	- USB device subclass code
25		bDeviceProtocol	- USB device protocol code
26		bMaxPacketSize0	- maximum endpoint 0 packet size
27		bcdDevice	- bcd device release number
28		bcdUSB		- bcd USB specification version number
29		idProduct	- product ID
30		idVendor	- vendor ID
31
32What:		/config/usb-gadget/gadget/configs
33Date:		Jun 2013
34KernelVersion:	3.11
35Description:
36		This group contains a USB gadget's configurations
37
38What:		/config/usb-gadget/gadget/configs/config
39Date:		Jun 2013
40KernelVersion:	3.11
41Description:
42		The attributes of a configuration:
43
44		bmAttributes	- configuration characteristics
45		MaxPower	- maximum power consumption from the bus
46
47What:		/config/usb-gadget/gadget/configs/config/strings
48Date:		Jun 2013
49KernelVersion:	3.11
50Description:
51		This group contains subdirectories for language-specific
52		strings for this configuration.
53
54What:		/config/usb-gadget/gadget/configs/config/strings/language
55Date:		Jun 2013
56KernelVersion:	3.11
57Description:
58		The attributes:
59
60		configuration	- configuration description
61
62
63What:		/config/usb-gadget/gadget/functions
64Date:		Jun 2013
65KernelVersion:	3.11
66Description:
67		This group contains functions available to this USB gadget.
68
69What:		/config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>
70Date:		May 2014
71KernelVersion:	3.16
72Description:
73		This group contains "Feature Descriptors" specific for one
74		gadget's USB interface or one interface group described
75		by an IAD.
76
77		The attributes:
78
79		compatible_id		- 8-byte string for "Compatible ID"
80		sub_compatible_id	- 8-byte string for "Sub Compatible ID"
81
82What:		/config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property>
83Date:		May 2014
84KernelVersion:	3.16
85Description:
86		This group contains "Extended Property Descriptors" specific for one
87		gadget's USB interface or one interface group described
88		by an IAD.
89
90		The attributes:
91
92		type		- value 1..7 for interpreting the data
93				1: unicode string
94				2: unicode string with environment variable
95				3: binary
96				4: little-endian 32-bit
97				5: big-endian 32-bit
98				6: unicode string with a symbolic link
99				7: multiple unicode strings
100		data		- blob of data to be interpreted depending on
101				type
102
103What:		/config/usb-gadget/gadget/strings
104Date:		Jun 2013
105KernelVersion:	3.11
106Description:
107		This group contains subdirectories for language-specific
108		strings for this gadget.
109
110What:		/config/usb-gadget/gadget/strings/language
111Date:		Jun 2013
112KernelVersion:	3.11
113Description:
114		The attributes:
115
116		serialnumber	- gadget's serial number (string)
117		product		- gadget's product description
118		manufacturer	- gadget's manufacturer description
119
120What:		/config/usb-gadget/gadget/os_desc
121Date:		May 2014
122KernelVersion:	3.16
123Description:
124		This group contains "OS String" extension handling attributes.
125
126		use		- flag turning "OS Desctiptors" support on/off
127		b_vendor_code	- one-byte value used for custom per-device and
128				per-interface requests
129		qw_sign		- an identifier to be reported as "OS String"
130				proper
131