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
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
|
/*
* Copyright (C) 2014 Michael Brown <mbrown@fensystems.co.uk>.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*
* You can also choose to distribute this program under the terms of
* the Unmodified Binary Distribution Licence (as given in the file
* COPYING.UBDL), provided that you have satisfied its requirements.
*/
FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <assert.h>
#include <byteswap.h>
#include <ipxe/usb.h>
#include <ipxe/cdc.h>
/** @file
*
* Universal Serial Bus (USB)
*
*/
/******************************************************************************
*
* Utility functions
*
******************************************************************************
*/
/**
* Get USB endpoint name (for debugging)
*
* @v address Endpoint address
* @ret name Endpoint name
*/
static inline const char * usb_endpoint_name ( unsigned int address ) {
static char buf[ 9 /* "EPxx OUT" + NUL */ ];
snprintf ( buf, sizeof ( buf ), "EP%d%s",
( address & USB_ENDPOINT_MAX ),
( address ?
( ( address & USB_ENDPOINT_IN ) ? " IN" : " OUT" ) : "" ));
return buf;
}
/**
* Get USB speed name (for debugging)
*
* @v speed Speed
* @ret name Speed name
*/
static inline const char * usb_speed_name ( unsigned int speed ) {
static const char *exponents[4] = { "", "k", "M", "G" };
static char buf[ 10 /* "xxxxxXbps" + NUL */ ];
unsigned int mantissa;
unsigned int exponent;
/* Extract mantissa and exponent */
mantissa = USB_SPEED_MANTISSA ( speed );
exponent = USB_SPEED_EXPONENT ( speed );
/* Name speed */
switch ( speed ) {
case USB_SPEED_NONE: return "DETACHED";
case USB_SPEED_LOW: return "low";
case USB_SPEED_FULL: return "full";
case USB_SPEED_HIGH: return "high";
case USB_SPEED_SUPER: return "super";
default:
snprintf ( buf, sizeof ( buf ), "%d%sbps",
mantissa, exponents[exponent] );
return buf;
}
}
/**
* Transcribe USB BCD-coded value (for debugging)
*
* @v bcd BCD-coded value
* @ret string Transcribed value
*/
static inline const char * usb_bcd ( uint16_t bcd ) {
static char buf[ 6 /* "xx.xx" + NUL */ ];
uint8_t high = ( bcd >> 8 );
uint8_t low = ( bcd >> 0 );
snprintf ( buf, sizeof ( buf ), "%x.%02x", high, low );
return buf;
}
/******************************************************************************
*
* USB descriptors
*
******************************************************************************
*/
/**
* Locate USB interface association descriptor
*
* @v config Configuraton descriptor
* @v first First interface number
* @ret desc Interface association descriptor, or NULL if not found
*/
static struct usb_interface_association_descriptor *
usb_interface_association_descriptor ( struct usb_configuration_descriptor
*config,
unsigned int first ) {
struct usb_interface_association_descriptor *desc;
/* Find a matching interface association descriptor */
for_each_config_descriptor ( desc, config ) {
if ( ( desc->header.type ==
USB_INTERFACE_ASSOCIATION_DESCRIPTOR ) &&
( desc->first == first ) )
return desc;
}
return NULL;
}
/**
* Locate USB interface descriptor
*
* @v config Configuraton descriptor
* @v interface Interface number
* @v alternate Alternate setting
* @ret desc Interface descriptor, or NULL if not found
*/
struct usb_interface_descriptor *
usb_interface_descriptor ( struct usb_configuration_descriptor *config,
unsigned int interface, unsigned int alternate ) {
struct usb_interface_descriptor *desc;
/* Find a matching interface descriptor */
for_each_config_descriptor ( desc, config ) {
if ( ( desc->header.type == USB_INTERFACE_DESCRIPTOR ) &&
( desc->interface == interface ) &&
( desc->alternate == alternate ) )
return desc;
}
return NULL;
}
/**
* Locate USB endpoint descriptor
*
* @v config Configuration descriptor
* @v interface Interface descriptor
* @v type Endpoint (internal) type
* @v index Endpoint index
* @ret desc Descriptor, or NULL if not found
*/
struct usb_endpoint_descriptor *
usb_endpoint_descriptor ( struct usb_configuration_descriptor *config,
struct usb_interface_descriptor *interface,
unsigned int type, unsigned int index ) {
struct usb_endpoint_descriptor *desc;
unsigned int attributes = ( type & USB_ENDPOINT_ATTR_TYPE_MASK );
unsigned int direction = ( type & USB_DIR_IN );
/* Find a matching endpoint descriptor */
for_each_interface_descriptor ( desc, config, interface ) {
if ( ( desc->header.type == USB_ENDPOINT_DESCRIPTOR ) &&
( ( desc->attributes &
USB_ENDPOINT_ATTR_TYPE_MASK ) == attributes ) &&
( ( desc->endpoint & USB_DIR_IN ) == direction ) &&
( index-- == 0 ) )
return desc;
}
return NULL;
}
/**
* Locate USB endpoint companion descriptor
*
* @v config Configuration descriptor
* @v desc Endpoint descriptor
* @ret descx Companion descriptor, or NULL if not found
*/
struct usb_endpoint_companion_descriptor *
usb_endpoint_companion_descriptor ( struct usb_configuration_descriptor *config,
struct usb_endpoint_descriptor *desc ) {
struct usb_endpoint_companion_descriptor *descx;
/* Get companion descriptor, if present */
descx = container_of ( usb_next_descriptor ( &desc->header ),
struct usb_endpoint_companion_descriptor,
header );
return ( ( usb_is_within_config ( config, &descx->header ) &&
descx->header.type == USB_ENDPOINT_COMPANION_DESCRIPTOR )
? descx : NULL );
}
/******************************************************************************
*
* USB endpoint
*
******************************************************************************
*/
/**
* Describe USB endpoint from device configuration
*
* @v ep USB endpoint
* @v config Configuration descriptor
* @v interface Interface descriptor
* @v type Endpoint (internal) type
* @v index Endpoint index
* @ret rc Return status code
*/
int usb_endpoint_described ( struct usb_endpoint *ep,
struct usb_configuration_descriptor *config,
struct usb_interface_descriptor *interface,
unsigned int type, unsigned int index ) {
struct usb_device *usb = ep->usb;
struct usb_port *port = usb->port;
struct usb_endpoint_descriptor *desc;
struct usb_endpoint_companion_descriptor *descx;
unsigned int sizes;
unsigned int burst;
unsigned int interval;
size_t mtu;
/* Locate endpoint descriptor */
desc = usb_endpoint_descriptor ( config, interface, type, index );
if ( ! desc )
return -ENOENT;
/* Locate companion descriptor, if any */
descx = usb_endpoint_companion_descriptor ( config, desc );
/* Calculate MTU and burst size */
sizes = le16_to_cpu ( desc->sizes );
mtu = USB_ENDPOINT_MTU ( sizes );
burst = ( descx ? descx->burst : USB_ENDPOINT_BURST ( sizes ) );
/* Calculate interval */
if ( type == USB_INTERRUPT ) {
if ( port->speed >= USB_SPEED_HIGH ) {
/* 2^(desc->interval-1) is a microframe count */
interval = ( 1 << ( desc->interval - 1 ) );
} else {
/* desc->interval is a (whole) frame count */
interval = ( desc->interval << 3 );
}
} else {
/* desc->interval is a microframe count */
interval = desc->interval;
}
/* Describe endpoint */
usb_endpoint_describe ( ep, desc->endpoint, desc->attributes,
mtu, burst, interval );
return 0;
}
/**
* Open USB endpoint
*
* @v ep USB endpoint
* @ret rc Return status code
*/
int usb_endpoint_open ( struct usb_endpoint *ep ) {
struct usb_device *usb = ep->usb;
unsigned int idx = USB_ENDPOINT_IDX ( ep->address );
int rc;
/* Populate host controller operations */
ep->host = &usb->port->hub->bus->op->endpoint;
/* Add to endpoint list */
if ( usb->ep[idx] != NULL ) {
DBGC ( usb, "USB %s %s is already open\n",
usb->name, usb_endpoint_name ( ep->address ) );
rc = -EALREADY;
goto err_already;
}
usb->ep[idx] = ep;
/* Clear any stale error status */
ep->rc = 0;
/* Open endpoint */
if ( ( rc = ep->host->open ( ep ) ) != 0 ) {
DBGC ( usb, "USB %s %s could not open: %s\n", usb->name,
usb_endpoint_name ( ep->address ), strerror ( rc ) );
goto err_open;
}
ep->open = 1;
DBGC2 ( usb, "USB %s %s opened with MTU %zd, burst %d, interval %d\n",
usb->name, usb_endpoint_name ( ep->address ), ep->mtu,
ep->burst, ep->interval );
return 0;
ep->open = 0;
ep->host->close ( ep );
err_open:
usb->ep[idx] = NULL;
err_already:
if ( ep->max )
usb_flush ( ep );
return rc;
}
/**
* Close USB endpoint
*
* @v ep USB endpoint
*/
void usb_endpoint_close ( struct usb_endpoint *ep ) {
struct usb_device *usb = ep->usb;
unsigned int idx = USB_ENDPOINT_IDX ( ep->address );
/* Sanity checks */
assert ( usb->ep[idx] == ep );
/* Close endpoint */
ep->open = 0;
ep->host->close ( ep );
assert ( ep->fill == 0 );
/* Remove from endpoint list */
usb->ep[idx] = NULL;
/* Discard any recycled buffers, if applicable */
if ( ep->max )
usb_flush ( ep );
}
/**
* Reset USB endpoint
*
* @v ep USB endpoint
* @ret rc Return status code
*/
static int usb_endpoint_reset ( struct usb_endpoint *ep ) {
struct usb_device *usb = ep->usb;
unsigned int type;
int rc;
/* Reset endpoint */
if ( ( rc = ep->host->reset ( ep ) ) != 0 ) {
DBGC ( usb, "USB %s %s could not reset: %s\n",
usb->name, usb_endpoint_name ( ep->address ),
strerror ( rc ) );
return rc;
}
/* Clear endpoint halt, if applicable */
type = ( ep->attributes & USB_ENDPOINT_ATTR_TYPE_MASK );
if ( ( type != USB_ENDPOINT_ATTR_CONTROL ) &&
( ( rc = usb_clear_feature ( usb, USB_RECIP_ENDPOINT,
USB_ENDPOINT_HALT,
ep->address ) ) != 0 ) ) {
DBGC ( usb, "USB %s %s could not clear endpoint halt: %s\n",
usb->name, usb_endpoint_name ( ep->address ),
strerror ( rc ) );
return rc;
}
/* Clear recorded error */
ep->rc = 0;
DBGC ( usb, "USB %s %s reset\n",
usb->name, usb_endpoint_name ( ep->address ) );
return 0;
}
/**
* Update endpoint MTU
*
* @v ep USB endpoint
* @v mtu New MTU
* @ret rc Return status code
*/
static int usb_endpoint_mtu ( struct usb_endpoint *ep, size_t mtu ) {
struct usb_device *usb = ep->usb;
int rc;
/* Update MTU */
ep->mtu = mtu;
if ( ( rc = ep->host->mtu ( ep ) ) != 0 ) {
DBGC ( usb, "USB %s %s could not update MTU: %s\n",
usb->name, usb_endpoint_name ( ep->address ),
strerror ( rc ) );
return rc;
}
return 0;
}
/**
* Enqueue USB message transfer
*
* @v ep USB endpoint
* @v request Request
* @v value Value parameter
* @v index Index parameter
* @v iobuf I/O buffer
* @ret rc Return status code
*/
int usb_message ( struct usb_endpoint *ep, unsigned int request,
unsigned int value, unsigned int index,
struct io_buffer *iobuf ) {
struct usb_device *usb = ep->usb;
struct usb_port *port = usb->port;
struct usb_setup_packet packet;
size_t len = iob_len ( iobuf );
int rc;
/* Fail immediately if device has been unplugged */
if ( port->speed == USB_SPEED_NONE )
return -ENODEV;
/* Reset endpoint if required */
if ( ( ep->rc != 0 ) && ( ( rc = usb_endpoint_reset ( ep ) ) != 0 ) )
return rc;
/* Zero input data buffer (if applicable) */
if ( request & USB_DIR_IN )
memset ( iobuf->data, 0, len );
/* Construct setup packet */
packet.request = cpu_to_le16 ( request );
packet.value = cpu_to_le16 ( value );
packet.index = cpu_to_le16 ( index );
packet.len = cpu_to_le16 ( len );
/* Enqueue message transfer */
if ( ( rc = ep->host->message ( ep, &packet, iobuf ) ) != 0 ) {
DBGC ( usb, "USB %s %s could not enqueue message transfer: "
"%s\n", usb->name, usb_endpoint_name ( ep->address ),
strerror ( rc ) );
return rc;
}
/* Increment fill level */
ep->fill++;
return 0;
}
/**
* Enqueue USB stream transfer
*
* @v ep USB endpoint
* @v iobuf I/O buffer
* @v terminate Terminate using a short packet
* @ret rc Return status code
*/
int usb_stream ( struct usb_endpoint *ep, struct io_buffer *iobuf,
int terminate ) {
struct usb_device *usb = ep->usb;
struct usb_port *port = usb->port;
int rc;
/* Fail immediately if device has been unplugged */
if ( port->speed == USB_SPEED_NONE )
return -ENODEV;
/* Reset endpoint if required */
if ( ( ep->rc != 0 ) && ( ( rc = usb_endpoint_reset ( ep ) ) != 0 ) )
return rc;
/* Enqueue stream transfer */
if ( ( rc = ep->host->stream ( ep, iobuf, terminate ) ) != 0 ) {
DBGC ( usb, "USB %s %s could not enqueue stream transfer: %s\n",
usb->name, usb_endpoint_name ( ep->address ),
strerror ( rc ) );
return rc;
}
/* Increment fill level */
ep->fill++;
return 0;
}
/**
* Complete transfer (possibly with error)
*
* @v ep USB endpoint
* @v iobuf I/O buffer
* @v rc Completion status code
*/
void usb_complete_err ( struct usb_endpoint *ep, struct io_buffer *iobuf,
int rc ) {
struct usb_device *usb = ep->usb;
/* Decrement fill level */
assert ( ep->fill > 0 );
ep->fill--;
/* Record error (if any) */
ep->rc = rc;
if ( ( rc != 0 ) && ep->open ) {
DBGC ( usb, "USB %s %s completion failed: %s\n",
usb->name, usb_endpoint_name ( ep->address ),
strerror ( rc ) );
}
/* Report completion */
ep->driver->complete ( ep, iobuf, rc );
}
/******************************************************************************
*
* Endpoint refilling
*
******************************************************************************
*/
/**
* Prefill endpoint recycled buffer list
*
* @v ep USB endpoint
* @ret rc Return status code
*/
int usb_prefill ( struct usb_endpoint *ep ) {
struct io_buffer *iobuf;
size_t len = ( ep->len ? ep->len : ep->mtu );
unsigned int fill;
int rc;
/* Sanity checks */
assert ( ep->fill == 0 );
assert ( ep->max > 0 );
assert ( list_empty ( &ep->recycled ) );
/* Fill recycled buffer list */
for ( fill = 0 ; fill < ep->max ; fill++ ) {
/* Allocate I/O buffer */
iobuf = alloc_iob ( len );
if ( ! iobuf ) {
rc = -ENOMEM;
goto err_alloc;
}
/* Add to recycled buffer list */
list_add_tail ( &iobuf->list, &ep->recycled );
}
return 0;
err_alloc:
usb_flush ( ep );
return rc;
}
/**
* Refill endpoint
*
* @v ep USB endpoint
* @ret rc Return status code
*/
int usb_refill ( struct usb_endpoint *ep ) {
struct io_buffer *iobuf;
size_t len = ( ep->len ? ep->len : ep->mtu );
int rc;
/* Sanity checks */
assert ( ep->open );
assert ( ep->max > 0 );
/* Refill endpoint */
while ( ep->fill < ep->max ) {
/* Get or allocate buffer */
if ( list_empty ( &ep->recycled ) ) {
/* Recycled buffer list is empty; allocate new buffer */
iobuf = alloc_iob ( len );
if ( ! iobuf )
return -ENOMEM;
} else {
/* Get buffer from recycled buffer list */
iobuf = list_first_entry ( &ep->recycled,
struct io_buffer, list );
assert ( iobuf != NULL );
list_del ( &iobuf->list );
}
/* Reset buffer to maximum size */
assert ( iob_len ( iobuf ) <= len );
iob_put ( iobuf, ( len - iob_len ( iobuf ) ) );
/* Enqueue buffer */
if ( ( rc = usb_stream ( ep, iobuf, 0 ) ) != 0 ) {
list_add ( &iobuf->list, &ep->recycled );
return rc;
}
}
return 0;
}
/**
* Discard endpoint recycled buffer list
*
* @v ep USB endpoint
*/
void usb_flush ( struct usb_endpoint *ep ) {
struct io_buffer *iobuf;
struct io_buffer *tmp;
/* Sanity checks */
assert ( ! ep->open );
assert ( ep->max > 0 );
/* Free all I/O buffers */
list_for_each_entry_safe ( iobuf, tmp, &ep->recycled, list ) {
list_del ( &iobuf->list );
free_iob ( iobuf );
}
}
/******************************************************************************
*
* Control endpoint
*
******************************************************************************
*/
/**
* Complete USB control transfer
*
* @v ep USB endpoint
* @v iobuf I/O buffer
* @v rc Completion status code
*/
static void usb_control_complete ( struct usb_endpoint *ep,
struct io_buffer *iobuf, int rc ) {
struct usb_device *usb = ep->usb;
/* Check for failures */
if ( rc != 0 ) {
DBGC ( usb, "USB %s control transaction failed: %s\n",
usb->name, strerror ( rc ) );
free_iob ( iobuf );
return;
}
/* Add to list of completed I/O buffers */
list_add_tail ( &iobuf->list, &usb->complete );
}
/** USB control endpoint driver operations */
static struct usb_endpoint_driver_operations usb_control_operations = {
.complete = usb_control_complete,
};
/**
* Issue USB control transaction
*
* @v usb USB device
* @v request Request
* @v value Value parameter
* @v index Index parameter
* @v data Data buffer (if any)
* @v len Length of data
* @ret rc Return status code
*/
int usb_control ( struct usb_device *usb, unsigned int request,
unsigned int value, unsigned int index, void *data,
size_t len ) {
struct usb_bus *bus = usb->port->hub->bus;
struct usb_endpoint *ep = &usb->control;
struct io_buffer *iobuf;
struct io_buffer *cmplt;
unsigned int i;
int rc;
/* Allocate I/O buffer */
iobuf = alloc_iob ( len );
if ( ! iobuf ) {
rc = -ENOMEM;
goto err_alloc;
}
iob_put ( iobuf, len );
if ( request & USB_DIR_IN ) {
memset ( data, 0, len );
} else {
memcpy ( iobuf->data, data, len );
}
/* Enqueue message */
if ( ( rc = usb_message ( ep, request, value, index, iobuf ) ) != 0 )
goto err_message;
/* Wait for completion */
for ( i = 0 ; i < USB_CONTROL_MAX_WAIT_MS ; i++ ) {
/* Poll bus */
usb_poll ( bus );
/* Check for completion */
while ( ( cmplt = list_first_entry ( &usb->complete,
struct io_buffer,
list ) ) ) {
/* Remove from completion list */
list_del ( &cmplt->list );
/* Discard stale completions */
if ( cmplt != iobuf ) {
DBGC ( usb, "USB %s stale control "
"completion:\n", usb->name );
DBGC_HDA ( usb, 0, cmplt->data,
iob_len ( cmplt ) );
free_iob ( cmplt );
continue;
}
/* Copy completion to data buffer, if applicable */
assert ( iob_len ( cmplt ) <= len );
if ( request & USB_DIR_IN )
memcpy ( data, cmplt->data, iob_len ( cmplt ) );
free_iob ( cmplt );
return 0;
}
/* Fail immediately if endpoint is in an error state */
if ( ep->rc )
return ep->rc;
/* Delay */
mdelay ( 1 );
}
DBGC ( usb, "USB %s timed out waiting for control transaction\n",
usb->name );
return -ETIMEDOUT;
err_message:
free_iob ( iobuf );
err_alloc:
return rc;
}
/**
* Get USB string descriptor
*
* @v usb USB device
* @v index String index
* @v language Language ID
* @v buf Data buffer
* @v len Length of buffer
* @ret len String length (excluding NUL), or negative error
*/
int usb_get_string_descriptor ( struct usb_device *usb, unsigned int index,
unsigned int language, char *buf, size_t len ) {
size_t max = ( len ? ( len - 1 /* NUL */ ) : 0 );
struct {
struct usb_descriptor_header header;
uint16_t character[max];
} __attribute__ (( packed )) *desc;
unsigned int actual;
unsigned int i;
int rc;
/* Allocate buffer for string */
desc = malloc ( sizeof ( *desc ) );
if ( ! desc ) {
rc = -ENOMEM;
goto err_alloc;
}
/* Get descriptor */
if ( ( rc = usb_get_descriptor ( usb, 0, USB_STRING_DESCRIPTOR, index,
language, &desc->header,
sizeof ( *desc ) ) ) != 0 )
goto err_get_descriptor;
/* Copy to buffer */
actual = ( ( desc->header.len - sizeof ( desc->header ) ) /
sizeof ( desc->character[0] ) );
for ( i = 0 ; ( ( i < actual ) && ( i < max ) ) ; i++ )
buf[i] = le16_to_cpu ( desc->character[i] );
if ( len )
buf[i] = '\0';
/* Free buffer */
free ( desc );
return actual;
err_get_descriptor:
free ( desc );
err_alloc:
return rc;
}
/******************************************************************************
*
* USB device driver
*
******************************************************************************
*/
/**
* Describe USB function
*
* @v func USB function
* @v config Configuration descriptor
* @v first First interface number
* @ret rc Return status code
*/
static int usb_function ( struct usb_function *func,
struct usb_configuration_descriptor *config,
unsigned int first ) {
struct usb_device *usb = func->usb;
struct usb_interface_association_descriptor *association;
struct usb_interface_descriptor *interface;
struct cdc_union_descriptor *cdc_union;
unsigned int i;
/* First, look for an interface association descriptor */
association = usb_interface_association_descriptor ( config, first );
if ( association ) {
/* Sanity check */
if ( association->count > config->interfaces ) {
DBGC ( usb, "USB %s has invalid association [%d-%d)\n",
func->name, association->first,
( association->first + association->count ) );
return -ERANGE;
}
/* Describe function */
memcpy ( &func->class, &association->class,
sizeof ( func->class ) );
func->count = association->count;
for ( i = 0 ; i < association->count ; i++ )
func->interface[i] = ( association->first + i );
return 0;
}
/* Next, look for an interface descriptor */
interface = usb_interface_descriptor ( config, first, 0 );
if ( ! interface ) {
DBGC ( usb, "USB %s has no interface descriptor\n",
func->name );
return -ENOENT;
}
/* Describe function */
memcpy ( &func->class, &interface->class, sizeof ( func->class ) );
func->count = 1;
func->interface[0] = first;
/* Look for a CDC union descriptor, if applicable */
if ( ( func->class.class == USB_CLASS_CDC ) &&
( cdc_union = cdc_union_descriptor ( config, interface ) ) ) {
/* Determine interface count */
func->count = ( ( cdc_union->header.len -
offsetof ( typeof ( *cdc_union ),
interface[0] ) ) /
sizeof ( cdc_union->interface[0] ) );
if ( func->count > config->interfaces ) {
DBGC ( usb, "USB %s has invalid union functional "
"descriptor with %d interfaces\n",
func->name, func->count );
return -ERANGE;
}
/* Describe function */
for ( i = 0 ; i < func->count ; i++ )
func->interface[i] = cdc_union->interface[i];
return 0;
}
return 0;
}
/**
* Check for a USB device ID match
*
* @v func USB function
* @v id Device ID
* @ret matches Device ID matches
*/
static int
usb_device_id_matches ( struct usb_function *func, struct usb_device_id *id ) {
return ( ( ( id->vendor == func->dev.desc.vendor ) ||
( id->vendor == USB_ANY_ID ) ) &&
( ( id->product == func->dev.desc.device ) ||
( id->product == USB_ANY_ID ) ) &&
( id->class.class == func->class.class ) &&
( id->class.subclass == func->class.subclass ) &&
( id->class.protocol == func->class.protocol ) );
}
/**
* Probe USB device driver
*
* @v func USB function
* @v config Configuration descriptor
* @ret rc Return status code
*/
static int usb_probe ( struct usb_function *func,
struct usb_configuration_descriptor *config ) {
struct usb_device *usb = func->usb;
struct usb_driver *driver;
struct usb_device_id *id;
unsigned int i;
int rc;
/* Look for a matching driver */
for_each_table_entry ( driver, USB_DRIVERS ) {
for ( i = 0 ; i < driver->id_count ; i++ ) {
/* Check for a matching ID */
id = &driver->ids[i];
if ( ! usb_device_id_matches ( func, id ) )
continue;
/* Probe driver */
if ( ( rc = driver->probe ( func, config ) ) != 0 ) {
DBGC ( usb, "USB %s failed to probe driver %s: "
"%s\n", func->name, id->name,
strerror ( rc ) );
/* Continue trying other drivers */
continue;
}
/* Record driver */
func->driver = driver;
func->dev.driver_name = id->name;
return 0;
}
}
/* No driver found */
DBGC ( usb, "USB %s %04x:%04x class %d:%d:%d has no driver\n",
func->name, func->dev.desc.vendor, func->dev.desc.device,
func->class.class, func->class.subclass, func->class.protocol );
return -ENOENT;
}
/**
* Remove USB device driver
*
* @v func USB function
*/
static void usb_remove ( struct usb_function *func ) {
/* Remove driver */
func->driver->remove ( func );
}
/**
* Probe all USB device drivers
*
* @v usb USB device
* @v config Configuration descriptor
*/
static void
usb_probe_all ( struct usb_device *usb,
struct usb_configuration_descriptor *config ) {
struct usb_bus *bus = usb->port->hub->bus;
struct usb_function *func;
uint8_t used[config->interfaces];
unsigned int first;
unsigned int i;
int rc;
/* Identify each function in turn */
memset ( used, 0, sizeof ( used ) );
for ( first = 0 ; first < config->interfaces ; first++ ) {
/* Skip interfaces already used */
if ( used[first] )
continue;
/* Allocate and initialise structure */
func = zalloc ( sizeof ( *func ) +
( config->interfaces *
sizeof ( func->interface[0] ) ) );
if ( ! func )
goto err_alloc;
func->name = func->dev.name;
func->usb = usb;
func->dev.desc.bus_type = BUS_TYPE_USB;
func->dev.desc.location = usb->address;
func->dev.desc.vendor = le16_to_cpu ( usb->device.vendor );
func->dev.desc.device = le16_to_cpu ( usb->device.product );
snprintf ( func->dev.name, sizeof ( func->dev.name ),
"%s-%d.%d", usb->name, config->config, first );
INIT_LIST_HEAD ( &func->dev.children );
func->dev.parent = bus->dev;
/* Identify function */
if ( ( rc = usb_function ( func, config, first ) ) != 0 )
goto err_function;
assert ( func->count <= config->interfaces );
/* Mark interfaces as used */
for ( i = 0 ; i < func->count ; i++ ) {
if ( func->interface[i] >= config->interfaces ) {
DBGC ( usb, "USB %s has invalid interface %d\n",
func->name, func->interface[i] );
goto err_interface;
}
used[ func->interface[i] ] = 1;
}
/* Probe device driver */
if ( ( rc = usb_probe ( func, config ) ) != 0 )
goto err_probe;
DBGC ( usb, "USB %s %04x:%04x class %d:%d:%d interfaces ",
func->name, func->dev.desc.vendor, func->dev.desc.device,
func->class.class, func->class.subclass,
func->class.protocol );
for ( i = 0 ; i < func->count ; i++ )
DBGC ( usb, "%s%d", ( i ? "," : "" ),
func->interface[i] );
DBGC ( usb, " using driver %s\n", func->dev.driver_name );
/* Add to list of functions */
list_add ( &func->list, &usb->functions );
/* Add to device hierarchy */
list_add_tail ( &func->dev.siblings, &bus->dev->children );
continue;
list_del ( &func->dev.siblings );
list_del ( &func->list );
usb_remove ( func );
err_probe:
free ( func );
err_alloc:
err_interface:
err_function:
/* Continue registering other functions */
continue;
}
}
/**
* Remove all device drivers
*
* @v usb USB device
*/
static void usb_remove_all ( struct usb_device *usb ) {
struct usb_function *func;
struct usb_function *tmp;
/* Remove all functions */
list_for_each_entry_safe ( func, tmp, &usb->functions, list ) {
/* Remove device driver */
usb_remove ( func );
/* Remove from device hierarchy */
assert ( list_empty ( &func->dev.children ) );
list_del ( &func->dev.siblings );
/* Remove from list of functions */
list_del ( &func->list );
/* Free function */
free ( func );
}
}
/**
* Select USB device configuration
*
* @v usb USB device
* @v index Configuration index
* @ret rc Return status code
*/
static int usb_configure ( struct usb_device *usb, unsigned int index ) {
struct usb_configuration_descriptor partial;
struct usb_configuration_descriptor *config;
size_t len;
int rc;
/* Read first part of configuration descriptor to get size */
if ( ( rc = usb_get_config_descriptor ( usb, index, &partial,
sizeof ( partial ) ) ) != 0 ) {
DBGC ( usb, "USB %s could not get configuration descriptor %d: "
"%s\n", usb->name, index, strerror ( rc ) );
goto err_get_partial;
}
len = le16_to_cpu ( partial.len );
if ( len < sizeof ( partial ) ) {
DBGC ( usb, "USB %s underlength configuraton descriptor %d\n",
usb->name, index );
rc = -EINVAL;
goto err_partial_len;
}
/* Allocate buffer for whole configuration descriptor */
config = malloc ( len );
if ( ! config ) {
rc = -ENOMEM;
goto err_alloc_config;
}
/* Read whole configuration descriptor */
if ( ( rc = usb_get_config_descriptor ( usb, index, config,
len ) ) != 0 ) {
DBGC ( usb, "USB %s could not get configuration descriptor %d: "
"%s\n", usb->name, index, strerror ( rc ) );
goto err_get_config_descriptor;
}
if ( config->len != partial.len ) {
DBGC ( usb, "USB %s bad configuration descriptor %d length\n",
usb->name, index );
rc = -EINVAL;
goto err_config_len;
}
/* Set configuration */
if ( ( rc = usb_set_configuration ( usb, config->config ) ) != 0){
DBGC ( usb, "USB %s could not set configuration %d: %s\n",
usb->name, config->config, strerror ( rc ) );
goto err_set_configuration;
}
/* Probe USB device drivers */
usb_probe_all ( usb, config );
/* Free configuration descriptor */
free ( config );
return 0;
usb_remove_all ( usb );
usb_set_configuration ( usb, 0 );
err_set_configuration:
err_config_len:
err_get_config_descriptor:
free ( config );
err_alloc_config:
err_partial_len:
err_get_partial:
return rc;
}
/**
* Clear USB device configuration
*
* @v usb USB device
*/
static void usb_deconfigure ( struct usb_device *usb ) {
unsigned int i;
/* Remove device drivers */
usb_remove_all ( usb );
/* Sanity checks */
for ( i = 0 ; i < ( sizeof ( usb->ep ) / sizeof ( usb->ep[0] ) ) ; i++){
if ( i != USB_ENDPOINT_IDX ( USB_EP0_ADDRESS ) )
assert ( usb->ep[i] == NULL );
}
/* Clear device configuration */
usb_set_configuration ( usb, 0 );
}
/**
* Find and select a supported USB device configuration
*
* @v usb USB device
* @ret rc Return status code
*/
static int usb_configure_any ( struct usb_device *usb ) {
unsigned int index;
int rc = -ENOENT;
/* Attempt all configuration indexes */
for ( index = 0 ; index < usb->device.configurations ; index++ ) {
/* Attempt this configuration index */
if ( ( rc = usb_configure ( usb, index ) ) != 0 )
continue;
/* If we have no drivers, then try the next configuration */
if ( list_empty ( &usb->functions ) ) {
rc = -ENOTSUP;
usb_deconfigure ( usb );
continue;
}
return 0;
}
return rc;
}
/******************************************************************************
*
* USB device
*
******************************************************************************
*/
/**
* Allocate USB device
*
* @v port USB port
* @ret usb USB device, or NULL on allocation failure
*/
static struct usb_device * alloc_usb ( struct usb_port *port ) {
struct usb_hub *hub = port->hub;
struct usb_bus *bus = hub->bus;
struct usb_device *usb;
/* Allocate and initialise structure */
usb = zalloc ( sizeof ( *usb ) );
if ( ! usb )
return NULL;
snprintf ( usb->name, sizeof ( usb->name ), "%s%c%d", hub->name,
( hub->usb ? '.' : '-' ), port->address );
usb->port = port;
INIT_LIST_HEAD ( &usb->functions );
usb->host = &bus->op->device;
usb_endpoint_init ( &usb->control, usb, &usb_control_operations );
INIT_LIST_HEAD ( &usb->complete );
return usb;
}
/**
* Register USB device
*
* @v usb USB device
* @ret rc Return status code
*/
static int register_usb ( struct usb_device *usb ) {
struct usb_port *port = usb->port;
struct usb_hub *hub = port->hub;
struct usb_bus *bus = hub->bus;
unsigned int protocol;
size_t mtu;
int rc;
/* Add to port */
if ( port->usb != NULL ) {
DBGC ( hub, "USB hub %s port %d is already registered to %s\n",
hub->name, port->address, port->usb->name );
rc = -EALREADY;
goto err_already;
}
port->usb = usb;
/* Add to bus device list */
list_add_tail ( &usb->list, &bus->devices );
/* Enable device */
if ( ( rc = hub->driver->enable ( hub, port ) ) != 0 ) {
DBGC ( hub, "USB hub %s port %d could not enable: %s\n",
hub->name, port->address, strerror ( rc ) );
goto err_enable;
}
/* Get device speed */
if ( ( rc = hub->driver->speed ( hub, port ) ) != 0 ) {
DBGC ( hub, "USB hub %s port %d could not get speed: %s\n",
hub->name, port->address, strerror ( rc ) );
goto err_speed;
}
DBGC2 ( usb, "USB %s attached as %s-speed device\n",
usb->name, usb_speed_name ( port->speed ) );
/* Open device */
if ( ( rc = usb->host->open ( usb ) ) != 0 ) {
DBGC ( usb, "USB %s could not open: %s\n",
usb->name, strerror ( rc ) );
goto err_open;
}
/* Describe control endpoint */
mtu = USB_EP0_DEFAULT_MTU ( port->speed );
usb_endpoint_describe ( &usb->control, USB_EP0_ADDRESS,
USB_EP0_ATTRIBUTES, mtu, USB_EP0_BURST,
USB_EP0_INTERVAL );
/* Open control endpoint */
if ( ( rc = usb_endpoint_open ( &usb->control ) ) != 0 )
goto err_open_control;
assert ( usb_endpoint ( usb, USB_EP0_ADDRESS ) == &usb->control );
/* Assign device address */
if ( ( rc = usb->host->address ( usb ) ) != 0 ) {
DBGC ( usb, "USB %s could not set address: %s\n",
usb->name, strerror ( rc ) );
goto err_address;
}
DBGC2 ( usb, "USB %s assigned address %d\n", usb->name, usb->address );
/* Read first part of device descriptor to get EP0 MTU */
if ( ( rc = usb_get_mtu ( usb, &usb->device ) ) != 0 ) {
DBGC ( usb, "USB %s could not get MTU: %s\n",
usb->name, strerror ( rc ) );
goto err_get_mtu;
}
/* Calculate EP0 MTU */
protocol = le16_to_cpu ( usb->device.protocol );
mtu = ( ( protocol < USB_PROTO_3_0 ) ?
usb->device.mtu : ( 1 << usb->device.mtu ) );
DBGC2 ( usb, "USB %s has control MTU %zd (guessed %zd)\n",
usb->name, mtu, usb->control.mtu );
/* Update MTU */
if ( ( rc = usb_endpoint_mtu ( &usb->control, mtu ) ) != 0 )
goto err_mtu;
/* Read whole device descriptor */
if ( ( rc = usb_get_device_descriptor ( usb, &usb->device ) ) != 0 ) {
DBGC ( usb, "USB %s could not get device descriptor: %s\n",
usb->name, strerror ( rc ) );
goto err_get_device_descriptor;
}
DBGC ( usb, "USB %s addr %d %04x:%04x class %d:%d:%d (v%s, %s-speed, "
"MTU %zd)\n", usb->name, usb->address,
le16_to_cpu ( usb->device.vendor ),
le16_to_cpu ( usb->device.product ), usb->device.class.class,
usb->device.class.subclass, usb->device.class.protocol,
usb_bcd ( le16_to_cpu ( usb->device.protocol ) ),
usb_speed_name ( port->speed ), usb->control.mtu );
/* Configure device */
if ( ( rc = usb_configure_any ( usb ) ) != 0 )
goto err_configure_any;
return 0;
usb_deconfigure ( usb );
err_configure_any:
err_get_device_descriptor:
err_mtu:
err_get_mtu:
err_address:
usb_endpoint_close ( &usb->control );
err_open_control:
usb->host->close ( usb );
err_open:
err_speed:
hub->driver->disable ( hub, port );
err_enable:
list_del ( &usb->list );
port->usb = NULL;
err_already:
return rc;
}
/**
* Unregister USB device
*
* @v usb USB device
*/
static void unregister_usb ( struct usb_device *usb ) {
struct usb_port *port = usb->port;
struct usb_hub *hub = port->hub;
struct io_buffer *iobuf;
struct io_buffer *tmp;
/* Sanity checks */
assert ( port->usb == usb );
/* Clear device configuration */
usb_deconfigure ( usb );
/* Close control endpoint */
usb_endpoint_close ( &usb->control );
/* Discard any stale control completions */
list_for_each_entry_safe ( iobuf, tmp, &usb->complete, list ) {
list_del ( &iobuf->list );
free_iob ( iobuf );
}
/* Close device */
usb->host->close ( usb );
/* Disable port */
hub->driver->disable ( hub, port );
/* Remove from bus device list */
list_del ( &usb->list );
/* Remove from port */
port->usb = NULL;
}
/**
* Free USB device
*
* @v usb USB device
*/
static void free_usb ( struct usb_device *usb ) {
unsigned int i;
/* Sanity checks */
for ( i = 0 ; i < ( sizeof ( usb->ep ) / sizeof ( usb->ep[0] ) ) ; i++ )
assert ( usb->ep[i] == NULL );
assert ( list_empty ( &usb->functions ) );
assert ( list_empty ( &usb->complete ) );
/* Free device */
free ( usb );
}
/******************************************************************************
*
* USB device hotplug event handling
*
******************************************************************************
*/
/**
* Handle newly attached USB device
*
* @v port USB port
* @ret rc Return status code
*/
static int usb_attached ( struct usb_port *port ) {
struct usb_device *usb;
int rc;
/* Mark port as attached */
port->attached = 1;
/* Sanity checks */
assert ( port->usb == NULL );
/* Allocate USB device */
usb = alloc_usb ( port );
if ( ! usb ) {
rc = -ENOMEM;
goto err_alloc;
}
/* Register USB device */
if ( ( rc = register_usb ( usb ) ) != 0 )
goto err_register;
return 0;
unregister_usb ( usb );
err_register:
free_usb ( usb );
err_alloc:
return rc;
}
/**
* Handle newly detached USB device
*
* @v port USB port
*/
static void usb_detached ( struct usb_port *port ) {
struct usb_device *usb = port->usb;
/* Mark port as detached */
port->attached = 0;
/* Do nothing if we have no USB device */
if ( ! usb )
return;
/* Unregister USB device */
unregister_usb ( usb );
/* Free USB device */
free_usb ( usb );
}
/**
* Handle newly attached or detached USB devices
*
* @v port USB port
* @ret rc Return status code
*/
static int usb_hotplug ( struct usb_port *port ) {
struct usb_hub *hub = port->hub;
int rc;
/* Get current port speed */
if ( ( rc = hub->driver->speed ( hub, port ) ) != 0 ) {
DBGC ( hub, "USB hub %s port %d could not get speed: %s\n",
hub->name, port->address, strerror ( rc ) );
return rc;
}
/* Handle attached/detached device as applicable */
if ( port->speed && ! port->attached ) {
/* Newly attached device */
return usb_attached ( port );
} else if ( port->attached && ! port->speed ) {
/* Newly detached device */
usb_detached ( port );
return 0;
} else {
/* Ignore */
return 0;
}
}
/******************************************************************************
*
* USB process
*
******************************************************************************
*/
/**
* Report port status change
*
* @v port USB port
*/
void usb_port_changed ( struct usb_port *port ) {
struct usb_hub *hub = port->hub;
struct usb_bus *bus = hub->bus;
/* Record hub port status change */
list_del ( &port->list );
list_add_tail ( &port->list, &bus->changed );
}
/**
* USB process
*
* @v bus USB bus
*/
static void usb_step ( struct usb_bus *bus ) {
struct usb_port *port;
/* Poll bus */
usb_poll ( bus );
/* Handle any changed ports, allowing for the fact that the
* port list may change as we perform hotplug actions.
*/
while ( ! list_empty ( &bus->changed ) ) {
/* Get first changed port */
port = list_first_entry ( &bus->changed, struct usb_port, list);
assert ( port != NULL );
/* Remove from list of changed ports */
list_del ( &port->list );
INIT_LIST_HEAD ( &port->list );
/* Perform appropriate hotplug action */
usb_hotplug ( port );
}
}
/** USB process */
static struct process_descriptor usb_process_desc =
PROC_DESC ( struct usb_bus, process, usb_step );
/******************************************************************************
*
* USB hub
*
******************************************************************************
*/
/**
* Allocate USB hub
*
* @v bus USB bus
* @v usb Underlying USB device, if any
* @v ports Number of ports
* @v driver Hub driver operations
* @ret hub USB hub, or NULL on allocation failure
*/
struct usb_hub * alloc_usb_hub ( struct usb_bus *bus, struct usb_device *usb,
unsigned int ports,
struct usb_hub_driver_operations *driver ) {
struct usb_hub *hub;
struct usb_port *port;
unsigned int i;
/* Allocate and initialise structure */
hub = zalloc ( sizeof ( *hub ) + ( ports * sizeof ( hub->port[0] ) ) );
if ( ! hub )
return NULL;
hub->name = ( usb ? usb->name : bus->name );
hub->bus = bus;
hub->usb = usb;
if ( usb )
hub->protocol = usb->port->protocol;
hub->ports = ports;
hub->driver = driver;
/* Initialise port list */
for ( i = 1 ; i <= hub->ports ; i++ ) {
port = usb_port ( hub, i );
port->hub = hub;
port->address = i;
if ( usb )
port->protocol = usb->port->protocol;
INIT_LIST_HEAD ( &port->list );
}
return hub;
}
/**
* Register USB hub
*
* @v hub USB hub
* @ret rc Return status code
*/
int register_usb_hub ( struct usb_hub *hub ) {
struct usb_bus *bus = hub->bus;
struct usb_port *port;
unsigned int i;
int rc;
/* Add to hub list */
list_add_tail ( &hub->list, &bus->hubs );
/* Open hub */
if ( ( rc = hub->driver->open ( hub ) ) != 0 ) {
DBGC ( hub, "USB hub %s could not open: %s\n",
hub->name, strerror ( rc ) );
goto err_open;
}
/* Delay to allow ports to stabilise */
mdelay ( USB_PORT_DELAY_MS );
/* Attach any devices already present */
for ( i = 1 ; i <= hub->ports ; i++ ) {
port = usb_port ( hub, i );
usb_hotplug ( port );
}
/* Some hubs seem to defer reporting device connections until
* their interrupt endpoint is polled for the first time.
* Poll the bus once now in order to pick up any such
* connections.
*/
usb_step ( bus );
return 0;
hub->driver->close ( hub );
err_open:
list_del ( &hub->list );
return rc;
}
/**
* Unregister USB hub
*
* @v hub USB hub
*/
void unregister_usb_hub ( struct usb_hub *hub ) {
struct usb_port *port;
unsigned int i;
/* Detach all devices */
for ( i = 1 ; i <= hub->ports ; i++ ) {
port = usb_port ( hub, i );
if ( port->attached )
usb_detached ( port );
}
/* Close hub */
hub->driver->close ( hub );
/* Cancel any pending port status changes */
for ( i = 1 ; i <= hub->ports ; i++ ) {
port = usb_port ( hub, i );
list_del ( &port->list );
INIT_LIST_HEAD ( &port->list );
}
/* Remove from hub list */
list_del ( &hub->list );
}
/**
* Free USB hub
*
* @v hub USB hub
*/
void free_usb_hub ( struct usb_hub *hub ) {
struct usb_port *port;
unsigned int i;
/* Sanity checks */
for ( i = 1 ; i <= hub->ports ; i++ ) {
port = usb_port ( hub, i );
assert ( ! port->attached );
assert ( port->usb == NULL );
assert ( list_empty ( &port->list ) );
}
/* Free hub */
free ( hub );
}
/******************************************************************************
*
* USB bus
*
******************************************************************************
*/
/**
* Allocate USB bus
*
* @v dev Underlying hardware device
* @v ports Number of root hub ports
* @v op Host controller operations
* @ret bus USB bus, or NULL on allocation failure
*/
struct usb_bus * alloc_usb_bus ( struct device *dev, unsigned int ports,
struct usb_host_operations *op ) {
struct usb_bus *bus;
/* Allocate and initialise structure */
bus = zalloc ( sizeof ( *bus ) );
if ( ! bus )
goto err_alloc_bus;
bus->name = dev->name;
bus->dev = dev;
bus->op = op;
INIT_LIST_HEAD ( &bus->devices );
INIT_LIST_HEAD ( &bus->hubs );
INIT_LIST_HEAD ( &bus->changed );
process_init_stopped ( &bus->process, &usb_process_desc, NULL );
bus->host = &bus->op->bus;
/* Allocate root hub */
bus->hub = alloc_usb_hub ( bus, NULL, ports, &op->hub );
if ( ! bus->hub )
goto err_alloc_hub;
return bus;
free_usb_hub ( bus->hub );
err_alloc_hub:
free ( bus );
err_alloc_bus:
return NULL;
}
/**
* Register USB bus
*
* @v bus USB bus
* @ret rc Return status code
*/
int register_usb_bus ( struct usb_bus *bus ) {
int rc;
/* Sanity checks */
assert ( bus->hub != NULL );
/* Open bus */
if ( ( rc = bus->host->open ( bus ) ) != 0 )
goto err_open;
/* Register root hub */
if ( ( rc = register_usb_hub ( bus->hub ) ) != 0 )
goto err_register_hub;
/* Start bus process */
process_add ( &bus->process );
return 0;
unregister_usb_hub ( bus->hub );
err_register_hub:
bus->host->close ( bus );
err_open:
return rc;
}
/**
* Unregister USB bus
*
* @v bus USB bus
*/
void unregister_usb_bus ( struct usb_bus *bus ) {
/* Sanity checks */
assert ( bus->hub != NULL );
assert ( process_running ( &bus->process ) );
/* Stop bus process */
process_del ( &bus->process );
/* Unregister root hub */
unregister_usb_hub ( bus->hub );
/* Close bus */
bus->host->close ( bus );
/* Sanity checks */
assert ( list_empty ( &bus->devices ) );
assert ( list_empty ( &bus->hubs ) );
assert ( ! process_running ( &bus->process ) );
}
/**
* Free USB bus
*
* @v bus USB bus
*/
void free_usb_bus ( struct usb_bus *bus ) {
/* Sanity checks */
assert ( list_empty ( &bus->devices ) );
assert ( list_empty ( &bus->hubs ) );
assert ( ! process_running ( &bus->process ) );
/* Free root hub */
free_usb_hub ( bus->hub );
/* Free bus */
free ( bus );
}
/******************************************************************************
*
* USB bus topology
*
******************************************************************************
*/
/**
* Get USB route string
*
* @v usb USB device
* @ret route USB route string
*/
unsigned int usb_route_string ( struct usb_device *usb ) {
unsigned int route;
/* Navigate up to root hub, constructing route string as we go */
for ( route = 0 ; usb->port->hub->usb ; usb = usb->port->hub->usb ) {
route <<= 4;
route |= ( ( usb->port->address > 0xf ) ?
0xf : usb->port->address );
}
return route;
}
/**
* Get USB depth
*
* @v usb USB device
* @ret depth Hub depth
*/
unsigned int usb_depth ( struct usb_device *usb ) {
unsigned int depth;
/* Navigate up to root hub, constructing depth as we go */
for ( depth = 0 ; usb->port->hub->usb ; usb = usb->port->hub->usb )
depth++;
return depth;
}
/**
* Get USB root hub port
*
* @v usb USB device
* @ret port Root hub port
*/
struct usb_port * usb_root_hub_port ( struct usb_device *usb ) {
/* Navigate up to root hub */
while ( usb->port->hub->usb )
usb = usb->port->hub->usb;
return usb->port;
}
/* Drag in hub driver */
REQUIRE_OBJECT ( usbhub );
|