/
usb.c
424 lines (365 loc) · 14.6 KB
/
usb.c
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
/**
* @section License
*
* The MIT License (MIT)
*
* Copyright (c) 2014-2016, Erik Moqvist
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* This file is part of the Simba project.
*/
#include "simba.h"
#if CONFIG_USB == 1
struct id_str_t {
int id;
char *str_p;
};
/**
* USB class map.
*/
static const struct id_str_t class_map[] = {
{ .id = 0x00, .str_p = "USE_INTERFACE" },
{ .id = 0x01, .str_p = "AUDIO" },
{ .id = 0x02, .str_p = "CDC_CONTROL" },
{ .id = 0x03, .str_p = "HID" },
{ .id = 0x05, .str_p = "PHYSICAL" },
{ .id = 0x06, .str_p = "IMAGE" },
{ .id = 0x07, .str_p = "PRINTER" },
{ .id = 0x08, .str_p = "MASS_STORAGE" },
{ .id = 0x09, .str_p = "HUB" },
{ .id = 0x0a, .str_p = "CDC_DATA" },
{ .id = 0x0b, .str_p = "SMART_CARD" },
{ .id = 0x0d, .str_p = "CONTENT_SECURITY" },
{ .id = 0x0e, .str_p = "VIDEO" },
{ .id = 0x0f, .str_p = "PERSONAL_HEALTHCARE" },
{ .id = 0x10, .str_p = "AUDIO_VIDEO_DEVICES" },
{ .id = 0x11, .str_p = "BILLBOARD_DEVICE_CLASS" },
{ .id = 0xdc, .str_p = "DIAGNOSTIC_DEVICE" },
{ .id = 0xe0, .str_p = "WIRELESS_CONTROLLER" },
{ .id = 0xef, .str_p = "MISCELLANEOUS" },
{ .id = 0xfe, .str_p = "APPLICATION_SPECIFIC" },
{ .id = 0xff, .str_p = "VENDOR_SPECIFIC" },
{ .id = 0x00, .str_p = NULL }
};
/**
* USB endpoint direction map.
*/
static const struct id_str_t endpoint_direction_map[] = {
{ .id = 0x00, .str_p = "OUT" },
{ .id = 0x01, .str_p = "IN" },
{ .id = 0x00, .str_p = NULL }
};
/**
* USB endpoint transfer type map.
*/
static const struct id_str_t endpoint_transfer_type_map[] = {
{ .id = 0x00, .str_p = "CONTROL" },
{ .id = 0x01, .str_p = "ISOCHRONOUS" },
{ .id = 0x02, .str_p = "BULK" },
{ .id = 0x03, .str_p = "INTERRUPT" },
{ .id = 0x00, .str_p = NULL }
};
/**
* USB endpoint synchronisation type map.
*/
static const struct id_str_t endpoint_synchronisation_type_map[] = {
{ .id = 0x00, .str_p = "NO_SYNCHRONISATION" },
{ .id = 0x01, .str_p = "ASYNCHRONOUS" },
{ .id = 0x02, .str_p = "ADAPTIVE" },
{ .id = 0x03, .str_p = "SYNCHRONOUS" },
{ .id = 0x00, .str_p = NULL }
};
/**
* USB endpoint usage type map.
*/
static const struct id_str_t endpoint_usage_type_map[] = {
{ .id = 0x00, .str_p = "DATA" },
{ .id = 0x01, .str_p = "FEEDBACK" },
{ .id = 0x02, .str_p = "EXPLICIT_FEEDBACK" },
{ .id = 0x00, .str_p = NULL }
};
static const char *get_str_by_id(const struct id_str_t *id_str_map_p,
int id)
{
while (id_str_map_p->str_p != NULL) {
if (id_str_map_p->id == id) {
return (id_str_map_p->str_p);
}
id_str_map_p++;
}
return (NULL);
}
int usb_format_descriptors(void *out_p,
uint8_t *buf_p,
size_t size)
{
ASSERTN(out_p != NULL, EINVAL);
ASSERTN(buf_p != NULL, EINVAL);
ASSERTN(size > 0, EINVAL);
union usb_descriptor_t *desc_p;
size_t pos = 0;
while (pos < size) {
desc_p = (union usb_descriptor_t *)buf_p;
switch (desc_p->header.descriptor_type) {
case DESCRIPTOR_TYPE_DEVICE:
std_printf(FSTR("Device descriptor:\r\n"
" length = %d\r\n"
" descriptor_type = %d\r\n"
" bcd_usb = %02x.%02x\r\n"
" device_class = %d (%s)\r\n"
" device_subclass = %d\r\n"
" device_protocol = %d\r\n"
" max_packet_size_0 = %d\r\n"
" id_vendor = 0x%04x\r\n"
" id_product = 0x%04x\r\n"
" bcd_device = %02x.%02x\r\n"
" manufacturer = %d\r\n"
" product = %d\r\n"
" serial_number = %d\r\n"
" num_configurations = %d\r\n"),
desc_p->device.length,
desc_p->device.descriptor_type,
((desc_p->device.bcd_usb >> 8) & 0xff),
(desc_p->device.bcd_usb & 0xff),
desc_p->device.device_class,
get_str_by_id(class_map,
desc_p->device.device_class),
desc_p->device.device_subclass,
desc_p->device.device_protocol,
desc_p->device.max_packet_size_0,
desc_p->device.id_vendor,
desc_p->device.id_product,
((desc_p->device.bcd_device >> 8) & 0xff),
(desc_p->device.bcd_device & 0xff),
desc_p->device.manufacturer,
desc_p->device.product,
desc_p->device.serial_number,
desc_p->device.num_configurations);
break;
case DESCRIPTOR_TYPE_CONFIGURATION:
std_printf(FSTR(" Configuration descriptor:\r\n"
" length = %d\r\n"
" descriptor_type = %d\r\n"
" total_length = %d\r\n"
" num_interfaces = %d\r\n"
" configuration_value = %d\r\n"
" configuration = %d\r\n"
" configuration_attributes = %d\r\n"
" max_power = %d mA\r\n"),
desc_p->configuration.length,
desc_p->configuration.descriptor_type,
desc_p->configuration.total_length,
desc_p->configuration.num_interfaces,
desc_p->configuration.configuration_value,
desc_p->configuration.configuration,
desc_p->configuration.configuration_attributes,
2 * desc_p->configuration.max_power);
break;
case DESCRIPTOR_TYPE_INTERFACE:
std_printf(FSTR(" Interface descriptor:\r\n"
" length = %d\r\n"
" descriptor_type = %d\r\n"
" interface_number = %d\r\n"
" alternate_setting = %d\r\n"
" num_endpoints = %d\r\n"
" interface_class = %d (%s)\r\n"
" interface_subclass = %d\r\n"
" interface_protocol = %d\r\n"
" interface = %d\r\n"),
desc_p->interface.length,
desc_p->interface.descriptor_type,
desc_p->interface.interface_number,
desc_p->interface.alternate_setting,
desc_p->interface.num_endpoints,
desc_p->interface.interface_class,
get_str_by_id(class_map,
desc_p->interface.interface_class),
desc_p->interface.interface_subclass,
desc_p->interface.interface_protocol,
desc_p->interface.interface);
break;
case DESCRIPTOR_TYPE_ENDPOINT:
{
std_printf(FSTR(" Endpoint descriptor:\r\n"
" length = %d\r\n"
" descriptor_type = %d\r\n"),
desc_p->endpoint.length,
desc_p->endpoint.descriptor_type);
int type = ENDPOINT_ATTRIBUTES_TRANSFER_TYPE(desc_p->endpoint.attributes);
if (type == ENDPOINT_ATTRIBUTES_TRANSFER_TYPE_CONTROL) {
std_printf(FSTR(" endpoint_address = 0x%02x (EP %d)\r\n"),
desc_p->endpoint.endpoint_address,
ENDPOINT_ENDPOINT_ADDRESS_NUMBER(desc_p->endpoint.endpoint_address));
} else {
std_printf(FSTR(" endpoint_address = 0x%02x (%s, EP %d)\r\n"),
desc_p->endpoint.endpoint_address,
get_str_by_id(endpoint_direction_map,
ENDPOINT_ENDPOINT_ADDRESS_DIRECTION(desc_p->endpoint.endpoint_address)),
ENDPOINT_ENDPOINT_ADDRESS_NUMBER(desc_p->endpoint.endpoint_address));
}
if (type == ENDPOINT_ATTRIBUTES_TRANSFER_TYPE_ISOCHRONOUS) {
std_printf(FSTR(" attributes = 0x%02x (%s, %s, %s)\r\n"),
desc_p->endpoint.attributes,
get_str_by_id(endpoint_usage_type_map,
ENDPOINT_ATTRIBUTES_USAGE_TYPE(desc_p->endpoint.attributes)),
get_str_by_id(endpoint_synchronisation_type_map,
ENDPOINT_ATTRIBUTES_SYNCHRONISATION_TYPE(desc_p->endpoint.attributes)),
get_str_by_id(endpoint_transfer_type_map, type));
} else {
std_printf(FSTR(" attributes = 0x%02x (%s)\r\n"),
desc_p->endpoint.attributes,
get_str_by_id(endpoint_transfer_type_map, type));
}
std_printf(FSTR(" max_packet_size = %d\r\n"
" interval = %d\r\n"),
desc_p->endpoint.max_packet_size,
desc_p->endpoint.interval);
break;
}
default:
break;
}
pos += desc_p->header.length;
buf_p += desc_p->header.length;
}
return (0);
}
struct usb_descriptor_configuration_t *
usb_desc_get_configuration(uint8_t *buf_p,
size_t size,
int configuration)
{
ASSERTN(buf_p != NULL, EINVAL);
ASSERTN(size > 0, EINVAL);
union usb_descriptor_t *desc_p;
size_t pos = 0;
while (pos < size) {
desc_p = (union usb_descriptor_t *)buf_p;
switch (desc_p->header.descriptor_type) {
case DESCRIPTOR_TYPE_CONFIGURATION:
if (desc_p->configuration.configuration_value == configuration) {
return (&desc_p->configuration);
}
break;
default:
break;
}
pos += desc_p->header.length;
buf_p += desc_p->header.length;
}
return (NULL);
}
struct usb_descriptor_interface_t *
usb_desc_get_interface(uint8_t *buf_p,
size_t size,
int configuration,
int interface)
{
ASSERTN(buf_p != NULL, EINVAL);
ASSERTN(size > 0, EINVAL);
union usb_descriptor_t *desc_p;
struct usb_descriptor_configuration_t *conf_desc_p = NULL;
size_t pos = 0;
while (pos < size) {
desc_p = (union usb_descriptor_t *)buf_p;
switch (desc_p->header.descriptor_type) {
case DESCRIPTOR_TYPE_CONFIGURATION:
if (desc_p->configuration.configuration_value == configuration) {
conf_desc_p = &desc_p->configuration;
}
break;
case DESCRIPTOR_TYPE_INTERFACE:
if (conf_desc_p != NULL) {
if (desc_p->interface.interface_number == interface) {
return (&desc_p->interface);
}
}
break;
default:
break;
}
pos += desc_p->header.length;
buf_p += desc_p->header.length;
}
return (NULL);
}
struct usb_descriptor_endpoint_t *
usb_desc_get_endpoint(uint8_t *buf_p,
size_t size,
int configuration,
int interface,
int endpoint)
{
ASSERTN(buf_p != NULL, EINVAL);
ASSERTN(size > 0, EINVAL);
union usb_descriptor_t *desc_p;
struct usb_descriptor_configuration_t *conf_desc_p = NULL;
struct usb_descriptor_interface_t *int_desc_p = NULL;
size_t pos = 0;
while (pos < size) {
desc_p = (union usb_descriptor_t *)buf_p;
switch (desc_p->header.descriptor_type) {
case DESCRIPTOR_TYPE_CONFIGURATION:
if (desc_p->configuration.configuration_value == configuration) {
conf_desc_p = &desc_p->configuration;
}
break;
case DESCRIPTOR_TYPE_INTERFACE:
if (conf_desc_p != NULL) {
if (desc_p->interface.interface_number == interface) {
int_desc_p = &desc_p->interface;
}
}
break;
case DESCRIPTOR_TYPE_ENDPOINT:
if (int_desc_p != NULL) {
if ((desc_p->endpoint.endpoint_address & 0x7f) == endpoint) {
return (&desc_p->endpoint);
}
}
break;
default:
break;
}
pos += desc_p->header.length;
buf_p += desc_p->header.length;
}
return (NULL);
}
int usb_desc_get_class(uint8_t *buf_p,
size_t size,
int configuration,
int interface)
{
ASSERTN(buf_p != NULL, EINVAL);
ASSERTN(size > 0, EINVAL);
struct usb_descriptor_interface_t *int_desc_p;
int_desc_p = usb_desc_get_interface(buf_p,
size,
configuration,
interface);
if (int_desc_p == NULL) {
return (-1);
}
return (int_desc_p->interface_class);
}
#endif