hc
2023-12-11 d2ccde1c8e90d38cee87a1b0309ad2827f3fd30d
kernel/Documentation/ABI/testing/configfs-usb-gadget
....@@ -12,18 +12,24 @@
1212
1313 The attributes of a gadget:
1414
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.
15
+ ================ ============================================
16
+ UDC bind a gadget to UDC/unbind a gadget;
17
+ write UDC's name found in /sys/class/udc/*
18
+ to bind a gadget, empty string "" to unbind.
1819
19
- bDeviceClass - USB device class code
20
- bDeviceSubClass - USB device subclass code
21
- bDeviceProtocol - USB device protocol code
22
- bMaxPacketSize0 - maximum endpoint 0 packet size
23
- bcdDevice - bcd device release number
24
- bcdUSB - bcd USB specification version number
25
- idProduct - product ID
26
- idVendor - vendor ID
20
+ max_speed maximum speed the driver supports. Valid
21
+ names are super-speed-plus, super-speed,
22
+ high-speed, full-speed, and low-speed.
23
+
24
+ bDeviceClass USB device class code
25
+ bDeviceSubClass USB device subclass code
26
+ bDeviceProtocol USB device protocol code
27
+ bMaxPacketSize0 maximum endpoint 0 packet size
28
+ bcdDevice bcd device release number
29
+ bcdUSB bcd USB specification version number
30
+ idProduct product ID
31
+ idVendor vendor ID
32
+ ================ ============================================
2733
2834 What: /config/usb-gadget/gadget/configs
2935 Date: Jun 2013
....@@ -37,8 +43,10 @@
3743 Description:
3844 The attributes of a configuration:
3945
40
- bmAttributes - configuration characteristics
41
- MaxPower - maximum power consumption from the bus
46
+ ================ ======================================
47
+ bmAttributes configuration characteristics
48
+ MaxPower maximum power consumption from the bus
49
+ ================ ======================================
4250
4351 What: /config/usb-gadget/gadget/configs/config/strings
4452 Date: Jun 2013
....@@ -53,7 +61,9 @@
5361 Description:
5462 The attributes:
5563
56
- configuration - configuration description
64
+ ================ =========================
65
+ configuration configuration description
66
+ ================ =========================
5767
5868
5969 What: /config/usb-gadget/gadget/functions
....@@ -72,8 +82,10 @@
7282
7383 The attributes:
7484
75
- compatible_id - 8-byte string for "Compatible ID"
76
- sub_compatible_id - 8-byte string for "Sub Compatible ID"
85
+ ================= =====================================
86
+ compatible_id 8-byte string for "Compatible ID"
87
+ sub_compatible_id 8-byte string for "Sub Compatible ID"
88
+ ================= =====================================
7789
7890 What: /config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property>
7991 Date: May 2014
....@@ -85,16 +97,19 @@
8597
8698 The attributes:
8799
88
- type - value 1..7 for interpreting the data
89
- 1: unicode string
90
- 2: unicode string with environment variable
91
- 3: binary
92
- 4: little-endian 32-bit
93
- 5: big-endian 32-bit
94
- 6: unicode string with a symbolic link
95
- 7: multiple unicode strings
96
- data - blob of data to be interpreted depending on
100
+ ===== ===============================================
101
+ type value 1..7 for interpreting the data
102
+
103
+ - 1: unicode string
104
+ - 2: unicode string with environment variable
105
+ - 3: binary
106
+ - 4: little-endian 32-bit
107
+ - 5: big-endian 32-bit
108
+ - 6: unicode string with a symbolic link
109
+ - 7: multiple unicode strings
110
+ data blob of data to be interpreted depending on
97111 type
112
+ ===== ===============================================
98113
99114 What: /config/usb-gadget/gadget/strings
100115 Date: Jun 2013
....@@ -109,9 +124,11 @@
109124 Description:
110125 The attributes:
111126
112
- serialnumber - gadget's serial number (string)
113
- product - gadget's product description
114
- manufacturer - gadget's manufacturer description
127
+ ============ =================================
128
+ serialnumber gadget's serial number (string)
129
+ product gadget's product description
130
+ manufacturer gadget's manufacturer description
131
+ ============ =================================
115132
116133 What: /config/usb-gadget/gadget/os_desc
117134 Date: May 2014
....@@ -119,8 +136,10 @@
119136 Description:
120137 This group contains "OS String" extension handling attributes.
121138
122
- use - flag turning "OS Desctiptors" support on/off
123
- b_vendor_code - one-byte value used for custom per-device and
139
+ ============= ===============================================
140
+ use flag turning "OS Desctiptors" support on/off
141
+ b_vendor_code one-byte value used for custom per-device and
124142 per-interface requests
125
- qw_sign - an identifier to be reported as "OS String"
143
+ qw_sign an identifier to be reported as "OS String"
126144 proper
145
+ ============= ===============================================