summaryrefslogtreecommitdiff
path: root/Documentation/ABI/testing/configfs-usb-gadget
blob: 4594cc2435e8cab6a8f3040343cf86d6ed2a232b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
What:		/config/usb-gadget
Date:		Jun 2013
KernelVersion:	3.11
Description:
		This group contains sub-groups corresponding to created
		USB gadgets.

What:		/config/usb-gadget/gadget
Date:		Jun 2013
KernelVersion:	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.

		max_speed	- maximum speed the driver supports. Valid
				names are super-speed-plus, super-speed,
				high-speed, full-speed, and low-speed.

		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
KernelVersion:	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
KernelVersion:	3.11
Description:
		This group contains functions available to this USB gadget.

What:		/config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>
Date:		May 2014
KernelVersion:	3.16
Description:
		This group contains "Feature Descriptors" specific for one
		gadget's USB interface or one interface group described
		by an IAD.

		The attributes:

		compatible_id		- 8-byte string for "Compatible ID"
		sub_compatible_id	- 8-byte string for "Sub Compatible ID"

What:		/config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property>
Date:		May 2014
KernelVersion:	3.16
Description:
		This group contains "Extended Property Descriptors" specific for one
		gadget's USB interface or one interface group described
		by an IAD.

		The attributes:

		type		- value 1..7 for interpreting the data
				1: unicode string
				2: unicode string with environment variable
				3: binary
				4: little-endian 32-bit
				5: big-endian 32-bit
				6: unicode string with a symbolic link
				7: multiple unicode strings
		data		- blob of data to be interpreted depending on
				type

What:		/config/usb-gadget/gadget/strings
Date:		Jun 2013
KernelVersion:	3.11
Description:
		This group contains subdirectories for language-specific
		strings for this gadget.

What:		/config/usb-gadget/gadget/strings/language
Date:		Jun 2013
KernelVersion:	3.11
Description:
		The attributes:

		serialnumber	- gadget's serial number (string)
		product		- gadget's product description
		manufacturer	- gadget's manufacturer description

What:		/config/usb-gadget/gadget/os_desc
Date:		May 2014
KernelVersion:	3.16
Description:
		This group contains "OS String" extension handling attributes.

		use		- flag turning "OS Desctiptors" support on/off
		b_vendor_code	- one-byte value used for custom per-device and
				per-interface requests
		qw_sign		- an identifier to be reported as "OS String"
				proper