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
|
/* $FreeBSD$ */
/*-
* Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved.
* Copyright (c) 1998 Lennart Augustsson. All rights reserved.
* Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* USB spec: http://www.usb.org/developers/docs/usbspec.zip
*/
#include <dev/usb/usb_defs.h>
#include <dev/usb/usb_mfunc.h>
#include <dev/usb/usb_error.h>
#include <dev/usb/usb.h>
#include <dev/usb/usb_ioctl.h>
#define USB_DEBUG_VAR uhub_debug
#include <dev/usb/usb_core.h>
#include <dev/usb/usb_process.h>
#include <dev/usb/usb_device.h>
#include <dev/usb/usb_request.h>
#include <dev/usb/usb_debug.h>
#include <dev/usb/usb_hub.h>
#include <dev/usb/usb_util.h>
#include <dev/usb/usb_busdma.h>
#include <dev/usb/usb_transfer.h>
#include <dev/usb/usb_dynamic.h>
#include <dev/usb/usb_controller.h>
#include <dev/usb/usb_bus.h>
#define UHUB_INTR_INTERVAL 250 /* ms */
#define UHUB_N_TRANSFER 1
#if USB_DEBUG
static int uhub_debug = 0;
SYSCTL_NODE(_hw_usb2, OID_AUTO, uhub, CTLFLAG_RW, 0, "USB HUB");
SYSCTL_INT(_hw_usb2_uhub, OID_AUTO, debug, CTLFLAG_RW, &uhub_debug, 0,
"Debug level");
#endif
static int usb2_power_timeout = 30; /* seconds */
SYSCTL_INT(_hw_usb2, OID_AUTO, power_timeout, CTLFLAG_RW,
&usb2_power_timeout, 0, "USB power timeout");
struct uhub_current_state {
uint16_t port_change;
uint16_t port_status;
};
struct uhub_softc {
struct uhub_current_state sc_st;/* current state */
device_t sc_dev; /* base device */
struct usb2_device *sc_udev; /* USB device */
struct usb2_xfer *sc_xfer[UHUB_N_TRANSFER]; /* interrupt xfer */
uint8_t sc_flags;
#define UHUB_FLAG_DID_EXPLORE 0x01
char sc_name[32];
};
#define UHUB_PROTO(sc) ((sc)->sc_udev->ddesc.bDeviceProtocol)
#define UHUB_IS_HIGH_SPEED(sc) (UHUB_PROTO(sc) != UDPROTO_FSHUB)
#define UHUB_IS_SINGLE_TT(sc) (UHUB_PROTO(sc) == UDPROTO_HSHUBSTT)
/* prototypes for type checking: */
static device_probe_t uhub_probe;
static device_attach_t uhub_attach;
static device_detach_t uhub_detach;
static device_suspend_t uhub_suspend;
static device_resume_t uhub_resume;
static bus_driver_added_t uhub_driver_added;
static bus_child_location_str_t uhub_child_location_string;
static bus_child_pnpinfo_str_t uhub_child_pnpinfo_string;
static usb2_callback_t uhub_intr_callback;
static void usb2_dev_resume_peer(struct usb2_device *udev);
static void usb2_dev_suspend_peer(struct usb2_device *udev);
static const struct usb2_config uhub_config[UHUB_N_TRANSFER] = {
[0] = {
.type = UE_INTERRUPT,
.endpoint = UE_ADDR_ANY,
.direction = UE_DIR_ANY,
.mh.timeout = 0,
.mh.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
.mh.bufsize = 0, /* use wMaxPacketSize */
.mh.callback = &uhub_intr_callback,
.mh.interval = UHUB_INTR_INTERVAL,
},
};
/*
* driver instance for "hub" connected to "usb"
* and "hub" connected to "hub"
*/
static devclass_t uhub_devclass;
static driver_t uhub_driver =
{
.name = "uhub",
.methods = (device_method_t[]){
DEVMETHOD(device_probe, uhub_probe),
DEVMETHOD(device_attach, uhub_attach),
DEVMETHOD(device_detach, uhub_detach),
DEVMETHOD(device_suspend, uhub_suspend),
DEVMETHOD(device_resume, uhub_resume),
DEVMETHOD(device_shutdown, bus_generic_shutdown),
DEVMETHOD(bus_child_location_str, uhub_child_location_string),
DEVMETHOD(bus_child_pnpinfo_str, uhub_child_pnpinfo_string),
DEVMETHOD(bus_driver_added, uhub_driver_added),
{0, 0}
},
.size = sizeof(struct uhub_softc)
};
DRIVER_MODULE(uhub, usbus, uhub_driver, uhub_devclass, 0, 0);
DRIVER_MODULE(uhub, uhub, uhub_driver, uhub_devclass, NULL, 0);
static void
uhub_intr_callback(struct usb2_xfer *xfer)
{
struct uhub_softc *sc = xfer->priv_sc;
switch (USB_GET_STATE(xfer)) {
case USB_ST_TRANSFERRED:
DPRINTFN(2, "\n");
/*
* This is an indication that some port
* has changed status. Notify the bus
* event handler thread that we need
* to be explored again:
*/
usb2_needs_explore(sc->sc_udev->bus, 0);
case USB_ST_SETUP:
xfer->frlengths[0] = xfer->max_data_length;
usb2_start_hardware(xfer);
break;
default: /* Error */
if (xfer->error != USB_ERR_CANCELLED) {
/*
* Do a clear-stall. The "stall_pipe" flag
* will get cleared before next callback by
* the USB stack.
*/
xfer->flags.stall_pipe = 1;
xfer->frlengths[0] = xfer->max_data_length;
usb2_start_hardware(xfer);
}
break;
}
}
/*------------------------------------------------------------------------*
* uhub_explore_sub - subroutine
*
* Return values:
* 0: Success
* Else: A control transaction failed
*------------------------------------------------------------------------*/
static usb2_error_t
uhub_explore_sub(struct uhub_softc *sc, struct usb2_port *up)
{
struct usb2_bus *bus;
struct usb2_device *child;
uint8_t refcount;
usb2_error_t err;
bus = sc->sc_udev->bus;
err = 0;
/* get driver added refcount from USB bus */
refcount = bus->driver_added_refcount;
/* get device assosiated with the given port */
child = usb2_bus_port_get_device(bus, up);
if (child == NULL) {
/* nothing to do */
goto done;
}
/* check if probe and attach should be done */
if (child->driver_added_refcount != refcount) {
child->driver_added_refcount = refcount;
err = usb2_probe_and_attach(child,
USB_IFACE_INDEX_ANY);
if (err) {
goto done;
}
}
/* start control transfer, if device mode */
if (child->flags.usb2_mode == USB_MODE_DEVICE) {
usb2_default_transfer_setup(child);
}
/* if a HUB becomes present, do a recursive HUB explore */
if (child->hub) {
err = (child->hub->explore) (child);
}
done:
return (err);
}
/*------------------------------------------------------------------------*
* uhub_read_port_status - factored out code
*------------------------------------------------------------------------*/
static usb2_error_t
uhub_read_port_status(struct uhub_softc *sc, uint8_t portno)
{
struct usb2_port_status ps;
usb2_error_t err;
err = usb2_req_get_port_status(
sc->sc_udev, NULL, &ps, portno);
/* update status regardless of error */
sc->sc_st.port_status = UGETW(ps.wPortStatus);
sc->sc_st.port_change = UGETW(ps.wPortChange);
/* debugging print */
DPRINTFN(4, "port %d, wPortStatus=0x%04x, "
"wPortChange=0x%04x, err=%s\n",
portno, sc->sc_st.port_status,
sc->sc_st.port_change, usb2_errstr(err));
return (err);
}
/*------------------------------------------------------------------------*
* uhub_reattach_port
*
* Returns:
* 0: Success
* Else: A control transaction failed
*------------------------------------------------------------------------*/
static usb2_error_t
uhub_reattach_port(struct uhub_softc *sc, uint8_t portno)
{
struct usb2_device *child;
struct usb2_device *udev;
usb2_error_t err;
uint8_t timeout;
uint8_t speed;
uint8_t usb2_mode;
DPRINTF("reattaching port %d\n", portno);
err = 0;
timeout = 0;
udev = sc->sc_udev;
child = usb2_bus_port_get_device(udev->bus,
udev->hub->ports + portno - 1);
repeat:
/* first clear the port connection change bit */
err = usb2_req_clear_port_feature(udev, NULL,
portno, UHF_C_PORT_CONNECTION);
if (err) {
goto error;
}
/* detach any existing devices */
if (child) {
usb2_detach_device(child, USB_IFACE_INDEX_ANY, 1);
usb2_free_device(child);
child = NULL;
}
/* get fresh status */
err = uhub_read_port_status(sc, portno);
if (err) {
goto error;
}
/* check if nothing is connected to the port */
if (!(sc->sc_st.port_status & UPS_CURRENT_CONNECT_STATUS)) {
goto error;
}
/* check if there is no power on the port and print a warning */
if (!(sc->sc_st.port_status & UPS_PORT_POWER)) {
DPRINTF("WARNING: strange, connected port %d "
"has no power\n", portno);
}
/* check if the device is in Host Mode */
if (!(sc->sc_st.port_status & UPS_PORT_MODE_DEVICE)) {
DPRINTF("Port %d is in Host Mode\n", portno);
if (sc->sc_st.port_status & UPS_SUSPEND) {
DPRINTF("Port %d was still "
"suspended, clearing.\n", portno);
err = usb2_req_clear_port_feature(sc->sc_udev,
NULL, portno, UHF_PORT_SUSPEND);
}
/* USB Host Mode */
/* wait for maximum device power up time */
usb2_pause_mtx(NULL,
USB_MS_TO_TICKS(USB_PORT_POWERUP_DELAY));
/* reset port, which implies enabling it */
err = usb2_req_reset_port(udev, NULL, portno);
if (err) {
DPRINTFN(0, "port %d reset "
"failed, error=%s\n",
portno, usb2_errstr(err));
goto error;
}
/* get port status again, it might have changed during reset */
err = uhub_read_port_status(sc, portno);
if (err) {
goto error;
}
/* check if something changed during port reset */
if ((sc->sc_st.port_change & UPS_C_CONNECT_STATUS) ||
(!(sc->sc_st.port_status & UPS_CURRENT_CONNECT_STATUS))) {
if (timeout) {
DPRINTFN(0, "giving up port reset "
"- device vanished!\n");
goto error;
}
timeout = 1;
goto repeat;
}
} else {
DPRINTF("Port %d is in Device Mode\n", portno);
}
/*
* Figure out the device speed
*/
switch (udev->speed) {
case USB_SPEED_HIGH:
if (sc->sc_st.port_status & UPS_HIGH_SPEED)
speed = USB_SPEED_HIGH;
else if (sc->sc_st.port_status & UPS_LOW_SPEED)
speed = USB_SPEED_LOW;
else
speed = USB_SPEED_FULL;
break;
case USB_SPEED_FULL:
if (sc->sc_st.port_status & UPS_LOW_SPEED)
speed = USB_SPEED_LOW;
else
speed = USB_SPEED_FULL;
break;
case USB_SPEED_LOW:
speed = USB_SPEED_LOW;
break;
default:
/* same speed like parent */
speed = udev->speed;
break;
}
/*
* Figure out the device mode
*
* NOTE: This part is currently FreeBSD specific.
*/
if (sc->sc_st.port_status & UPS_PORT_MODE_DEVICE)
usb2_mode = USB_MODE_DEVICE;
else
usb2_mode = USB_MODE_HOST;
/* need to create a new child */
child = usb2_alloc_device(sc->sc_dev, udev->bus, udev,
udev->depth + 1, portno - 1, portno, speed, usb2_mode);
if (child == NULL) {
DPRINTFN(0, "could not allocate new device!\n");
goto error;
}
return (0); /* success */
error:
if (child) {
usb2_detach_device(child, USB_IFACE_INDEX_ANY, 1);
usb2_free_device(child);
child = NULL;
}
if (err == 0) {
if (sc->sc_st.port_status & UPS_PORT_ENABLED) {
err = usb2_req_clear_port_feature(
sc->sc_udev, NULL,
portno, UHF_PORT_ENABLE);
}
}
if (err) {
DPRINTFN(0, "device problem (%s), "
"disabling port %d\n", usb2_errstr(err), portno);
}
return (err);
}
/*------------------------------------------------------------------------*
* uhub_suspend_resume_port
*
* Returns:
* 0: Success
* Else: A control transaction failed
*------------------------------------------------------------------------*/
static usb2_error_t
uhub_suspend_resume_port(struct uhub_softc *sc, uint8_t portno)
{
struct usb2_device *child;
struct usb2_device *udev;
uint8_t is_suspend;
usb2_error_t err;
DPRINTF("port %d\n", portno);
udev = sc->sc_udev;
child = usb2_bus_port_get_device(udev->bus,
udev->hub->ports + portno - 1);
/* first clear the port suspend change bit */
err = usb2_req_clear_port_feature(udev, NULL,
portno, UHF_C_PORT_SUSPEND);
if (err) {
DPRINTF("clearing suspend failed.\n");
goto done;
}
/* get fresh status */
err = uhub_read_port_status(sc, portno);
if (err) {
DPRINTF("reading port status failed.\n");
goto done;
}
/* get current state */
if (sc->sc_st.port_status & UPS_SUSPEND) {
is_suspend = 1;
} else {
is_suspend = 0;
}
DPRINTF("suspended=%u\n", is_suspend);
/* do the suspend or resume */
if (child) {
/*
* This code handle two cases: 1) Host Mode - we can only
* receive resume here 2) Device Mode - we can receive
* suspend and resume here
*/
if (is_suspend == 0)
usb2_dev_resume_peer(child);
else if (child->flags.usb2_mode == USB_MODE_DEVICE)
usb2_dev_suspend_peer(child);
}
done:
return (err);
}
/*------------------------------------------------------------------------*
* uhub_explore
*
* Returns:
* 0: Success
* Else: Failure
*------------------------------------------------------------------------*/
static usb2_error_t
uhub_explore(struct usb2_device *udev)
{
struct usb2_hub *hub;
struct uhub_softc *sc;
struct usb2_port *up;
usb2_error_t err;
uint8_t portno;
uint8_t x;
hub = udev->hub;
sc = hub->hubsoftc;
DPRINTFN(11, "udev=%p addr=%d\n", udev, udev->address);
/* ignore hubs that are too deep */
if (udev->depth > USB_HUB_MAX_DEPTH) {
return (USB_ERR_TOO_DEEP);
}
if (udev->pwr_save.suspended) {
/* need to wait until the child signals resume */
DPRINTF("Device is suspended!\n");
return (0);
}
for (x = 0; x != hub->nports; x++) {
up = hub->ports + x;
portno = x + 1;
err = uhub_read_port_status(sc, portno);
if (err) {
/* most likely the HUB is gone */
break;
}
if (sc->sc_st.port_change & UPS_C_OVERCURRENT_INDICATOR) {
DPRINTF("Overcurrent on port %u.\n", portno);
err = usb2_req_clear_port_feature(
udev, NULL, portno, UHF_C_PORT_OVER_CURRENT);
if (err) {
/* most likely the HUB is gone */
break;
}
}
if (!(sc->sc_flags & UHUB_FLAG_DID_EXPLORE)) {
/*
* Fake a connect status change so that the
* status gets checked initially!
*/
sc->sc_st.port_change |=
UPS_C_CONNECT_STATUS;
}
if (sc->sc_st.port_change & UPS_C_PORT_ENABLED) {
err = usb2_req_clear_port_feature(
udev, NULL, portno, UHF_C_PORT_ENABLE);
if (err) {
/* most likely the HUB is gone */
break;
}
if (sc->sc_st.port_change & UPS_C_CONNECT_STATUS) {
/*
* Ignore the port error if the device
* has vanished !
*/
} else if (sc->sc_st.port_status & UPS_PORT_ENABLED) {
DPRINTFN(0, "illegal enable change, "
"port %d\n", portno);
} else {
if (up->restartcnt == USB_RESTART_MAX) {
/* XXX could try another speed ? */
DPRINTFN(0, "port error, giving up "
"port %d\n", portno);
} else {
sc->sc_st.port_change |=
UPS_C_CONNECT_STATUS;
up->restartcnt++;
}
}
}
if (sc->sc_st.port_change & UPS_C_CONNECT_STATUS) {
err = uhub_reattach_port(sc, portno);
if (err) {
/* most likely the HUB is gone */
break;
}
}
if (sc->sc_st.port_change & UPS_C_SUSPEND) {
err = uhub_suspend_resume_port(sc, portno);
if (err) {
/* most likely the HUB is gone */
break;
}
}
err = uhub_explore_sub(sc, up);
if (err) {
/* no device(s) present */
continue;
}
/* explore succeeded - reset restart counter */
up->restartcnt = 0;
}
/* initial status checked */
sc->sc_flags |= UHUB_FLAG_DID_EXPLORE;
/* return success */
return (USB_ERR_NORMAL_COMPLETION);
}
static int
uhub_probe(device_t dev)
{
struct usb2_attach_arg *uaa = device_get_ivars(dev);
if (uaa->usb2_mode != USB_MODE_HOST) {
return (ENXIO);
}
/*
* The subclass for USB HUBs is ignored because it is 0 for
* some and 1 for others.
*/
if ((uaa->info.bConfigIndex == 0) &&
(uaa->info.bDeviceClass == UDCLASS_HUB)) {
return (0);
}
return (ENXIO);
}
static int
uhub_attach(device_t dev)
{
struct uhub_softc *sc = device_get_softc(dev);
struct usb2_attach_arg *uaa = device_get_ivars(dev);
struct usb2_device *udev = uaa->device;
struct usb2_device *parent_hub = udev->parent_hub;
struct usb2_hub *hub;
struct usb2_hub_descriptor hubdesc;
uint16_t pwrdly;
uint8_t x;
uint8_t nports;
uint8_t portno;
uint8_t removable;
uint8_t iface_index;
usb2_error_t err;
sc->sc_udev = udev;
sc->sc_dev = dev;
snprintf(sc->sc_name, sizeof(sc->sc_name), "%s",
device_get_nameunit(dev));
device_set_usb2_desc(dev);
DPRINTFN(2, "depth=%d selfpowered=%d, parent=%p, "
"parent->selfpowered=%d\n",
udev->depth,
udev->flags.self_powered,
parent_hub,
parent_hub ?
parent_hub->flags.self_powered : 0);
if (udev->depth > USB_HUB_MAX_DEPTH) {
DPRINTFN(0, "hub depth, %d, exceeded. HUB ignored!\n",
USB_HUB_MAX_DEPTH);
goto error;
}
if (!udev->flags.self_powered && parent_hub &&
(!parent_hub->flags.self_powered)) {
DPRINTFN(0, "bus powered HUB connected to "
"bus powered HUB. HUB ignored!\n");
goto error;
}
/* get HUB descriptor */
DPRINTFN(2, "getting HUB descriptor\n");
/* assuming that there is one port */
err = usb2_req_get_hub_descriptor(udev, NULL, &hubdesc, 1);
nports = hubdesc.bNbrPorts;
if (!err && (nports >= 8)) {
/* get complete HUB descriptor */
err = usb2_req_get_hub_descriptor(udev, NULL, &hubdesc, nports);
}
if (err) {
DPRINTFN(0, "getting hub descriptor failed,"
"error=%s\n", usb2_errstr(err));
goto error;
}
if (hubdesc.bNbrPorts != nports) {
DPRINTFN(0, "number of ports changed!\n");
goto error;
}
if (nports == 0) {
DPRINTFN(0, "portless HUB!\n");
goto error;
}
hub = malloc(sizeof(hub[0]) + (sizeof(hub->ports[0]) * nports),
M_USBDEV, M_WAITOK | M_ZERO);
if (hub == NULL) {
goto error;
}
udev->hub = hub;
/* init FULL-speed ISOCHRONOUS schedule */
usb2_fs_isoc_schedule_init_all(hub->fs_isoc_schedule);
/* initialize HUB structure */
hub->hubsoftc = sc;
hub->explore = &uhub_explore;
hub->nports = hubdesc.bNbrPorts;
hub->hubudev = udev;
/* if self powered hub, give ports maximum current */
if (udev->flags.self_powered) {
hub->portpower = USB_MAX_POWER;
} else {
hub->portpower = USB_MIN_POWER;
}
/* set up interrupt pipe */
iface_index = 0;
err = usb2_transfer_setup(udev, &iface_index, sc->sc_xfer,
uhub_config, UHUB_N_TRANSFER, sc, &Giant);
if (err) {
DPRINTFN(0, "cannot setup interrupt transfer, "
"errstr=%s!\n", usb2_errstr(err));
goto error;
}
/* wait with power off for a while */
usb2_pause_mtx(NULL, USB_MS_TO_TICKS(USB_POWER_DOWN_TIME));
/*
* To have the best chance of success we do things in the exact same
* order as Windoze98. This should not be necessary, but some
* devices do not follow the USB specs to the letter.
*
* These are the events on the bus when a hub is attached:
* Get device and config descriptors (see attach code)
* Get hub descriptor (see above)
* For all ports
* turn on power
* wait for power to become stable
* (all below happens in explore code)
* For all ports
* clear C_PORT_CONNECTION
* For all ports
* get port status
* if device connected
* wait 100 ms
* turn on reset
* wait
* clear C_PORT_RESET
* get port status
* proceed with device attachment
*/
/* XXX should check for none, individual, or ganged power? */
removable = 0;
pwrdly = ((hubdesc.bPwrOn2PwrGood * UHD_PWRON_FACTOR) +
USB_EXTRA_POWER_UP_TIME);
for (x = 0; x != nports; x++) {
/* set up data structures */
struct usb2_port *up = hub->ports + x;
up->device_index = 0;
up->restartcnt = 0;
portno = x + 1;
/* check if port is removable */
if (!UHD_NOT_REMOV(&hubdesc, portno)) {
removable++;
}
if (!err) {
/* turn the power on */
err = usb2_req_set_port_feature(udev, NULL,
portno, UHF_PORT_POWER);
}
if (err) {
DPRINTFN(0, "port %d power on failed, %s\n",
portno, usb2_errstr(err));
}
DPRINTF("turn on port %d power\n",
portno);
/* wait for stable power */
usb2_pause_mtx(NULL, USB_MS_TO_TICKS(pwrdly));
}
device_printf(dev, "%d port%s with %d "
"removable, %s powered\n", nports, (nports != 1) ? "s" : "",
removable, udev->flags.self_powered ? "self" : "bus");
/* start the interrupt endpoint */
USB_XFER_LOCK(sc->sc_xfer[0]);
usb2_transfer_start(sc->sc_xfer[0]);
USB_XFER_UNLOCK(sc->sc_xfer[0]);
/* Enable automatic power save on all USB HUBs */
usb2_set_power_mode(udev, USB_POWER_MODE_SAVE);
return (0);
error:
usb2_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
if (udev->hub) {
free(udev->hub, M_USBDEV);
udev->hub = NULL;
}
return (ENXIO);
}
/*
* Called from process context when the hub is gone.
* Detach all devices on active ports.
*/
static int
uhub_detach(device_t dev)
{
struct uhub_softc *sc = device_get_softc(dev);
struct usb2_hub *hub = sc->sc_udev->hub;
struct usb2_device *child;
uint8_t x;
/* detach all children first */
bus_generic_detach(dev);
if (hub == NULL) { /* must be partially working */
return (0);
}
for (x = 0; x != hub->nports; x++) {
child = usb2_bus_port_get_device(sc->sc_udev->bus, hub->ports + x);
if (child == NULL) {
continue;
}
/*
* Subdevices are not freed, because the caller of
* uhub_detach() will do that.
*/
usb2_detach_device(child, USB_IFACE_INDEX_ANY, 0);
usb2_free_device(child);
child = NULL;
}
usb2_transfer_unsetup(sc->sc_xfer, UHUB_N_TRANSFER);
free(hub, M_USBDEV);
sc->sc_udev->hub = NULL;
return (0);
}
static int
uhub_suspend(device_t dev)
{
DPRINTF("\n");
/* Sub-devices are not suspended here! */
return (0);
}
static int
uhub_resume(device_t dev)
{
DPRINTF("\n");
/* Sub-devices are not resumed here! */
return (0);
}
static void
uhub_driver_added(device_t dev, driver_t *driver)
{
usb2_needs_explore_all();
}
struct hub_result {
struct usb2_device *udev;
uint8_t portno;
uint8_t iface_index;
};
static void
uhub_find_iface_index(struct usb2_hub *hub, device_t child,
struct hub_result *res)
{
struct usb2_interface *iface;
struct usb2_device *udev;
uint8_t nports;
uint8_t x;
uint8_t i;
nports = hub->nports;
for (x = 0; x != nports; x++) {
udev = usb2_bus_port_get_device(hub->hubudev->bus,
hub->ports + x);
if (!udev) {
continue;
}
for (i = 0; i != USB_IFACE_MAX; i++) {
iface = usb2_get_iface(udev, i);
if (iface &&
(iface->subdev == child)) {
res->iface_index = i;
res->udev = udev;
res->portno = x + 1;
return;
}
}
}
res->iface_index = 0;
res->udev = NULL;
res->portno = 0;
}
static int
uhub_child_location_string(device_t parent, device_t child,
char *buf, size_t buflen)
{
struct uhub_softc *sc = device_get_softc(parent);
struct usb2_hub *hub = sc->sc_udev->hub;
struct hub_result res;
mtx_lock(&Giant);
uhub_find_iface_index(hub, child, &res);
if (!res.udev) {
DPRINTF("device not on hub\n");
if (buflen) {
buf[0] = '\0';
}
goto done;
}
snprintf(buf, buflen, "port=%u interface=%u",
res.portno, res.iface_index);
done:
mtx_unlock(&Giant);
return (0);
}
static int
uhub_child_pnpinfo_string(device_t parent, device_t child,
char *buf, size_t buflen)
{
struct uhub_softc *sc = device_get_softc(parent);
struct usb2_hub *hub = sc->sc_udev->hub;
struct usb2_interface *iface;
struct hub_result res;
mtx_lock(&Giant);
uhub_find_iface_index(hub, child, &res);
if (!res.udev) {
DPRINTF("device not on hub\n");
if (buflen) {
buf[0] = '\0';
}
goto done;
}
iface = usb2_get_iface(res.udev, res.iface_index);
if (iface && iface->idesc) {
snprintf(buf, buflen, "vendor=0x%04x product=0x%04x "
"devclass=0x%02x devsubclass=0x%02x "
"sernum=\"%s\" "
"intclass=0x%02x intsubclass=0x%02x",
UGETW(res.udev->ddesc.idVendor),
UGETW(res.udev->ddesc.idProduct),
res.udev->ddesc.bDeviceClass,
res.udev->ddesc.bDeviceSubClass,
res.udev->serial,
iface->idesc->bInterfaceClass,
iface->idesc->bInterfaceSubClass);
} else {
if (buflen) {
buf[0] = '\0';
}
goto done;
}
done:
mtx_unlock(&Giant);
return (0);
}
/*
* The USB Transaction Translator:
* ===============================
*
* When doing LOW- and FULL-speed USB transfers accross a HIGH-speed
* USB HUB, bandwidth must be allocated for ISOCHRONOUS and INTERRUPT
* USB transfers. To utilize bandwidth dynamically the "scatter and
* gather" principle must be applied. This means that bandwidth must
* be divided into equal parts of bandwidth. With regard to USB all
* data is transferred in smaller packets with length
* "wMaxPacketSize". The problem however is that "wMaxPacketSize" is
* not a constant!
*
* The bandwidth scheduler which I have implemented will simply pack
* the USB transfers back to back until there is no more space in the
* schedule. Out of the 8 microframes which the USB 2.0 standard
* provides, only 6 are available for non-HIGH-speed devices. I have
* reserved the first 4 microframes for ISOCHRONOUS transfers. The
* last 2 microframes I have reserved for INTERRUPT transfers. Without
* this division, it is very difficult to allocate and free bandwidth
* dynamically.
*
* NOTE about the Transaction Translator in USB HUBs:
*
* USB HUBs have a very simple Transaction Translator, that will
* simply pipeline all the SPLIT transactions. That means that the
* transactions will be executed in the order they are queued!
*
*/
/*------------------------------------------------------------------------*
* usb2_intr_find_best_slot
*
* Return value:
* The best Transaction Translation slot for an interrupt endpoint.
*------------------------------------------------------------------------*/
static uint8_t
usb2_intr_find_best_slot(uint32_t *ptr, uint8_t start, uint8_t end)
{
uint32_t max = 0xffffffff;
uint8_t x;
uint8_t y;
y = 0;
/* find the last slot with lesser used bandwidth */
for (x = start; x < end; x++) {
if (max >= ptr[x]) {
max = ptr[x];
y = x;
}
}
return (y);
}
/*------------------------------------------------------------------------*
* usb2_intr_schedule_adjust
*
* This function will update the bandwith usage for the microframe
* having index "slot" by "len" bytes. "len" can be negative. If the
* "slot" argument is greater or equal to "USB_HS_MICRO_FRAMES_MAX"
* the "slot" argument will be replaced by the slot having least used
* bandwidth.
*
* Returns:
* The slot on which the bandwidth update was done.
*------------------------------------------------------------------------*/
uint8_t
usb2_intr_schedule_adjust(struct usb2_device *udev, int16_t len, uint8_t slot)
{
struct usb2_bus *bus = udev->bus;
struct usb2_hub *hub;
uint8_t speed;
USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
speed = usb2_get_speed(udev);
switch (speed) {
case USB_SPEED_LOW:
case USB_SPEED_FULL:
if (speed == USB_SPEED_LOW) {
len *= 8;
}
/*
* The Host Controller Driver should have
* performed checks so that the lookup
* below does not result in a NULL pointer
* access.
*/
hub = bus->devices[udev->hs_hub_addr]->hub;
if (slot >= USB_HS_MICRO_FRAMES_MAX) {
slot = usb2_intr_find_best_slot(hub->uframe_usage,
USB_FS_ISOC_UFRAME_MAX, 6);
}
hub->uframe_usage[slot] += len;
bus->uframe_usage[slot] += len;
break;
default:
if (slot >= USB_HS_MICRO_FRAMES_MAX) {
slot = usb2_intr_find_best_slot(bus->uframe_usage, 0,
USB_HS_MICRO_FRAMES_MAX);
}
bus->uframe_usage[slot] += len;
break;
}
return (slot);
}
/*------------------------------------------------------------------------*
* usb2_fs_isoc_schedule_init_sub
*
* This function initialises an USB FULL speed isochronous schedule
* entry.
*------------------------------------------------------------------------*/
static void
usb2_fs_isoc_schedule_init_sub(struct usb2_fs_isoc_schedule *fss)
{
fss->total_bytes = (USB_FS_ISOC_UFRAME_MAX *
USB_FS_BYTES_PER_HS_UFRAME);
fss->frame_bytes = (USB_FS_BYTES_PER_HS_UFRAME);
fss->frame_slot = 0;
}
/*------------------------------------------------------------------------*
* usb2_fs_isoc_schedule_init_all
*
* This function will reset the complete USB FULL speed isochronous
* bandwidth schedule.
*------------------------------------------------------------------------*/
void
usb2_fs_isoc_schedule_init_all(struct usb2_fs_isoc_schedule *fss)
{
struct usb2_fs_isoc_schedule *fss_end = fss + USB_ISOC_TIME_MAX;
while (fss != fss_end) {
usb2_fs_isoc_schedule_init_sub(fss);
fss++;
}
}
/*------------------------------------------------------------------------*
* usb2_isoc_time_expand
*
* This function will expand the time counter from 7-bit to 16-bit.
*
* Returns:
* 16-bit isochronous time counter.
*------------------------------------------------------------------------*/
uint16_t
usb2_isoc_time_expand(struct usb2_bus *bus, uint16_t isoc_time_curr)
{
uint16_t rem;
USB_BUS_LOCK_ASSERT(bus, MA_OWNED);
rem = bus->isoc_time_last & (USB_ISOC_TIME_MAX - 1);
isoc_time_curr &= (USB_ISOC_TIME_MAX - 1);
if (isoc_time_curr < rem) {
/* the time counter wrapped around */
bus->isoc_time_last += USB_ISOC_TIME_MAX;
}
/* update the remainder */
bus->isoc_time_last &= ~(USB_ISOC_TIME_MAX - 1);
bus->isoc_time_last |= isoc_time_curr;
return (bus->isoc_time_last);
}
/*------------------------------------------------------------------------*
* usb2_fs_isoc_schedule_isoc_time_expand
*
* This function does multiple things. First of all it will expand the
* passed isochronous time, which is the return value. Then it will
* store where the current FULL speed isochronous schedule is
* positioned in time and where the end is. See "pp_start" and
* "pp_end" arguments.
*
* Returns:
* Expanded version of "isoc_time".
*
* NOTE: This function depends on being called regularly with
* intervals less than "USB_ISOC_TIME_MAX".
*------------------------------------------------------------------------*/
uint16_t
usb2_fs_isoc_schedule_isoc_time_expand(struct usb2_device *udev,
struct usb2_fs_isoc_schedule **pp_start,
struct usb2_fs_isoc_schedule **pp_end,
uint16_t isoc_time)
{
struct usb2_fs_isoc_schedule *fss_end;
struct usb2_fs_isoc_schedule *fss_a;
struct usb2_fs_isoc_schedule *fss_b;
struct usb2_hub *hs_hub;
isoc_time = usb2_isoc_time_expand(udev->bus, isoc_time);
hs_hub = udev->bus->devices[udev->hs_hub_addr]->hub;
if (hs_hub != NULL) {
fss_a = hs_hub->fs_isoc_schedule +
(hs_hub->isoc_last_time % USB_ISOC_TIME_MAX);
hs_hub->isoc_last_time = isoc_time;
fss_b = hs_hub->fs_isoc_schedule +
(isoc_time % USB_ISOC_TIME_MAX);
fss_end = hs_hub->fs_isoc_schedule + USB_ISOC_TIME_MAX;
*pp_start = hs_hub->fs_isoc_schedule;
*pp_end = fss_end;
while (fss_a != fss_b) {
if (fss_a == fss_end) {
fss_a = hs_hub->fs_isoc_schedule;
continue;
}
usb2_fs_isoc_schedule_init_sub(fss_a);
fss_a++;
}
} else {
*pp_start = NULL;
*pp_end = NULL;
}
return (isoc_time);
}
/*------------------------------------------------------------------------*
* usb2_fs_isoc_schedule_alloc
*
* This function will allocate bandwidth for an isochronous FULL speed
* transaction in the FULL speed schedule. The microframe slot where
* the transaction should be started is stored in the byte pointed to
* by "pstart". The "len" argument specifies the length of the
* transaction in bytes.
*
* Returns:
* 0: Success
* Else: Error
*------------------------------------------------------------------------*/
uint8_t
usb2_fs_isoc_schedule_alloc(struct usb2_fs_isoc_schedule *fss,
uint8_t *pstart, uint16_t len)
{
uint8_t slot = fss->frame_slot;
/* Compute overhead and bit-stuffing */
len += 8;
len *= 7;
len /= 6;
if (len > fss->total_bytes) {
*pstart = 0; /* set some dummy value */
return (1); /* error */
}
if (len > 0) {
fss->total_bytes -= len;
while (len >= fss->frame_bytes) {
len -= fss->frame_bytes;
fss->frame_bytes = USB_FS_BYTES_PER_HS_UFRAME;
fss->frame_slot++;
}
fss->frame_bytes -= len;
}
*pstart = slot;
return (0); /* success */
}
/*------------------------------------------------------------------------*
* usb2_bus_port_get_device
*
* This function is NULL safe.
*------------------------------------------------------------------------*/
struct usb2_device *
usb2_bus_port_get_device(struct usb2_bus *bus, struct usb2_port *up)
{
if ((bus == NULL) || (up == NULL)) {
/* be NULL safe */
return (NULL);
}
if (up->device_index == 0) {
/* nothing to do */
return (NULL);
}
return (bus->devices[up->device_index]);
}
/*------------------------------------------------------------------------*
* usb2_bus_port_set_device
*
* This function is NULL safe.
*------------------------------------------------------------------------*/
void
usb2_bus_port_set_device(struct usb2_bus *bus, struct usb2_port *up,
struct usb2_device *udev, uint8_t device_index)
{
if (bus == NULL) {
/* be NULL safe */
return;
}
/*
* There is only one case where we don't
* have an USB port, and that is the Root Hub!
*/
if (up) {
if (udev) {
up->device_index = device_index;
} else {
device_index = up->device_index;
up->device_index = 0;
}
}
/*
* Make relationships to our new device
*/
if (device_index != 0) {
#if USB_HAVE_UGEN
mtx_lock(&usb2_ref_lock);
#endif
bus->devices[device_index] = udev;
#if USB_HAVE_UGEN
mtx_unlock(&usb2_ref_lock);
#endif
}
/*
* Debug print
*/
DPRINTFN(2, "bus %p devices[%u] = %p\n", bus, device_index, udev);
}
/*------------------------------------------------------------------------*
* usb2_needs_explore
*
* This functions is called when the USB event thread needs to run.
*------------------------------------------------------------------------*/
void
usb2_needs_explore(struct usb2_bus *bus, uint8_t do_probe)
{
DPRINTF("\n");
if (bus == NULL) {
DPRINTF("No bus pointer!\n");
return;
}
USB_BUS_LOCK(bus);
if (do_probe) {
bus->do_probe = 1;
}
if (usb2_proc_msignal(&bus->explore_proc,
&bus->explore_msg[0], &bus->explore_msg[1])) {
/* ignore */
}
USB_BUS_UNLOCK(bus);
}
/*------------------------------------------------------------------------*
* usb2_needs_explore_all
*
* This function is called whenever a new driver is loaded and will
* cause that all USB busses are re-explored.
*------------------------------------------------------------------------*/
void
usb2_needs_explore_all(void)
{
struct usb2_bus *bus;
devclass_t dc;
device_t dev;
int max;
DPRINTFN(3, "\n");
dc = usb2_devclass_ptr;
if (dc == NULL) {
DPRINTFN(0, "no devclass\n");
return;
}
/*
* Explore all USB busses in parallell.
*/
max = devclass_get_maxunit(dc);
while (max >= 0) {
dev = devclass_get_device(dc, max);
if (dev) {
bus = device_get_softc(dev);
if (bus) {
usb2_needs_explore(bus, 1);
}
}
max--;
}
}
/*------------------------------------------------------------------------*
* usb2_bus_power_update
*
* This function will ensure that all USB devices on the given bus are
* properly suspended or resumed according to the device transfer
* state.
*------------------------------------------------------------------------*/
void
usb2_bus_power_update(struct usb2_bus *bus)
{
usb2_needs_explore(bus, 0 /* no probe */ );
}
/*------------------------------------------------------------------------*
* usb2_transfer_power_ref
*
* This function will modify the power save reference counts and
* wakeup the USB device associated with the given USB transfer, if
* needed.
*------------------------------------------------------------------------*/
void
usb2_transfer_power_ref(struct usb2_xfer *xfer, int val)
{
static const uint32_t power_mask[4] = {
[UE_CONTROL] = USB_HW_POWER_CONTROL,
[UE_BULK] = USB_HW_POWER_BULK,
[UE_INTERRUPT] = USB_HW_POWER_INTERRUPT,
[UE_ISOCHRONOUS] = USB_HW_POWER_ISOC,
};
struct usb2_device *udev;
uint8_t needs_explore;
uint8_t needs_hw_power;
uint8_t xfer_type;
udev = xfer->xroot->udev;
if (udev->device_index == USB_ROOT_HUB_ADDR) {
/* no power save for root HUB */
return;
}
USB_BUS_LOCK(udev->bus);
xfer_type = xfer->pipe->edesc->bmAttributes & UE_XFERTYPE;
udev->pwr_save.last_xfer_time = ticks;
udev->pwr_save.type_refs[xfer_type] += val;
if (xfer->flags_int.control_xfr) {
udev->pwr_save.read_refs += val;
if (xfer->flags_int.usb2_mode == USB_MODE_HOST) {
/*
* it is not allowed to suspend during a control
* transfer
*/
udev->pwr_save.write_refs += val;
}
} else if (USB_GET_DATA_ISREAD(xfer)) {
udev->pwr_save.read_refs += val;
} else {
udev->pwr_save.write_refs += val;
}
if (udev->pwr_save.suspended)
needs_explore =
(udev->pwr_save.write_refs != 0) ||
((udev->pwr_save.read_refs != 0) &&
(usb2_peer_can_wakeup(udev) == 0));
else
needs_explore = 0;
if (!(udev->bus->hw_power_state & power_mask[xfer_type])) {
DPRINTF("Adding type %u to power state\n", xfer_type);
udev->bus->hw_power_state |= power_mask[xfer_type];
needs_hw_power = 1;
} else {
needs_hw_power = 0;
}
USB_BUS_UNLOCK(udev->bus);
if (needs_explore) {
DPRINTF("update\n");
usb2_bus_power_update(udev->bus);
} else if (needs_hw_power) {
DPRINTF("needs power\n");
if (udev->bus->methods->set_hw_power != NULL) {
(udev->bus->methods->set_hw_power) (udev->bus);
}
}
return;
}
/*------------------------------------------------------------------------*
* usb2_bus_powerd
*
* This function implements the USB power daemon and is called
* regularly from the USB explore thread.
*------------------------------------------------------------------------*/
void
usb2_bus_powerd(struct usb2_bus *bus)
{
struct usb2_device *udev;
unsigned int temp;
unsigned int limit;
unsigned int mintime;
uint32_t type_refs[5];
uint8_t x;
uint8_t rem_wakeup;
limit = usb2_power_timeout;
if (limit == 0)
limit = hz;
else if (limit > 255)
limit = 255 * hz;
else
limit = limit * hz;
DPRINTF("bus=%p\n", bus);
USB_BUS_LOCK(bus);
/*
* The root HUB device is never suspended
* and we simply skip it.
*/
for (x = USB_ROOT_HUB_ADDR + 1;
x != bus->devices_max; x++) {
udev = bus->devices[x];
if (udev == NULL)
continue;
rem_wakeup = usb2_peer_can_wakeup(udev);
temp = ticks - udev->pwr_save.last_xfer_time;
if ((udev->power_mode == USB_POWER_MODE_ON) ||
(udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0) ||
(udev->pwr_save.write_refs != 0) ||
((udev->pwr_save.read_refs != 0) &&
(rem_wakeup == 0))) {
/* check if we are suspended */
if (udev->pwr_save.suspended != 0) {
USB_BUS_UNLOCK(bus);
usb2_dev_resume_peer(udev);
USB_BUS_LOCK(bus);
}
} else if (temp >= limit) {
/* check if we are not suspended */
if (udev->pwr_save.suspended == 0) {
USB_BUS_UNLOCK(bus);
usb2_dev_suspend_peer(udev);
USB_BUS_LOCK(bus);
}
}
}
/* reset counters */
mintime = 0 - 1;
type_refs[0] = 0;
type_refs[1] = 0;
type_refs[2] = 0;
type_refs[3] = 0;
type_refs[4] = 0;
/* Re-loop all the devices to get the actual state */
for (x = USB_ROOT_HUB_ADDR + 1;
x != bus->devices_max; x++) {
udev = bus->devices[x];
if (udev == NULL)
continue;
/* we found a non-Root-Hub USB device */
type_refs[4] += 1;
/* "last_xfer_time" can be updated by a resume */
temp = ticks - udev->pwr_save.last_xfer_time;
/*
* Compute minimum time since last transfer for the complete
* bus:
*/
if (temp < mintime)
mintime = temp;
if (udev->pwr_save.suspended == 0) {
type_refs[0] += udev->pwr_save.type_refs[0];
type_refs[1] += udev->pwr_save.type_refs[1];
type_refs[2] += udev->pwr_save.type_refs[2];
type_refs[3] += udev->pwr_save.type_refs[3];
}
}
if (mintime >= (1 * hz)) {
/* recompute power masks */
DPRINTF("Recomputing power masks\n");
bus->hw_power_state = 0;
if (type_refs[UE_CONTROL] != 0)
bus->hw_power_state |= USB_HW_POWER_CONTROL;
if (type_refs[UE_BULK] != 0)
bus->hw_power_state |= USB_HW_POWER_BULK;
if (type_refs[UE_INTERRUPT] != 0)
bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
if (type_refs[UE_ISOCHRONOUS] != 0)
bus->hw_power_state |= USB_HW_POWER_ISOC;
if (type_refs[4] != 0)
bus->hw_power_state |= USB_HW_POWER_NON_ROOT_HUB;
}
USB_BUS_UNLOCK(bus);
if (bus->methods->set_hw_power != NULL) {
/* always update hardware power! */
(bus->methods->set_hw_power) (bus);
}
return;
}
/*------------------------------------------------------------------------*
* usb2_dev_resume_peer
*
* This function will resume an USB peer and do the required USB
* signalling to get an USB device out of the suspended state.
*------------------------------------------------------------------------*/
static void
usb2_dev_resume_peer(struct usb2_device *udev)
{
struct usb2_bus *bus;
int err;
/* be NULL safe */
if (udev == NULL)
return;
/* check if already resumed */
if (udev->pwr_save.suspended == 0)
return;
/* we need a parent HUB to do resume */
if (udev->parent_hub == NULL)
return;
DPRINTF("udev=%p\n", udev);
if ((udev->flags.usb2_mode == USB_MODE_DEVICE) &&
(udev->flags.remote_wakeup == 0)) {
/*
* If the host did not set the remote wakeup feature, we can
* not wake it up either!
*/
DPRINTF("remote wakeup is not set!\n");
return;
}
/* get bus pointer */
bus = udev->bus;
/* resume parent hub first */
usb2_dev_resume_peer(udev->parent_hub);
/* resume current port (Valid in Host and Device Mode) */
err = usb2_req_clear_port_feature(udev->parent_hub,
NULL, udev->port_no, UHF_PORT_SUSPEND);
if (err) {
DPRINTFN(0, "Resuming port failed!\n");
return;
}
/* resume settle time */
usb2_pause_mtx(NULL, USB_MS_TO_TICKS(USB_PORT_RESUME_DELAY));
if (bus->methods->device_resume != NULL) {
/* resume USB device on the USB controller */
(bus->methods->device_resume) (udev);
}
USB_BUS_LOCK(bus);
/* set that this device is now resumed */
udev->pwr_save.suspended = 0;
/* make sure that we don't go into suspend right away */
udev->pwr_save.last_xfer_time = ticks;
/* make sure the needed power masks are on */
if (udev->pwr_save.type_refs[UE_CONTROL] != 0)
bus->hw_power_state |= USB_HW_POWER_CONTROL;
if (udev->pwr_save.type_refs[UE_BULK] != 0)
bus->hw_power_state |= USB_HW_POWER_BULK;
if (udev->pwr_save.type_refs[UE_INTERRUPT] != 0)
bus->hw_power_state |= USB_HW_POWER_INTERRUPT;
if (udev->pwr_save.type_refs[UE_ISOCHRONOUS] != 0)
bus->hw_power_state |= USB_HW_POWER_ISOC;
USB_BUS_UNLOCK(bus);
if (bus->methods->set_hw_power != NULL) {
/* always update hardware power! */
(bus->methods->set_hw_power) (bus);
}
sx_xlock(udev->default_sx + 1);
/* notify all sub-devices about resume */
err = usb2_suspend_resume(udev, 0);
sx_unlock(udev->default_sx + 1);
/* check if peer has wakeup capability */
if (usb2_peer_can_wakeup(udev)) {
/* clear remote wakeup */
err = usb2_req_clear_device_feature(udev,
NULL, UF_DEVICE_REMOTE_WAKEUP);
if (err) {
DPRINTFN(0, "Clearing device "
"remote wakeup failed: %s!\n",
usb2_errstr(err));
}
}
return;
}
/*------------------------------------------------------------------------*
* usb2_dev_suspend_peer
*
* This function will suspend an USB peer and do the required USB
* signalling to get an USB device into the suspended state.
*------------------------------------------------------------------------*/
static void
usb2_dev_suspend_peer(struct usb2_device *udev)
{
struct usb2_device *hub;
struct usb2_device *child;
uint32_t temp;
int err;
uint8_t x;
uint8_t nports;
uint8_t suspend_parent;
repeat:
/* be NULL safe */
if (udev == NULL)
return;
/* check if already suspended */
if (udev->pwr_save.suspended)
return;
/* we need a parent HUB to do suspend */
if (udev->parent_hub == NULL)
return;
DPRINTF("udev=%p\n", udev);
/* check if all devices on the parent hub are suspended */
hub = udev->parent_hub;
if (hub != NULL) {
nports = hub->hub->nports;
suspend_parent = 1;
for (x = 0; x != nports; x++) {
child = usb2_bus_port_get_device(hub->bus,
hub->hub->ports + x);
if (child == NULL)
continue;
if (child->pwr_save.suspended)
continue;
if (child == udev)
continue;
/* another device on the HUB is not suspended */
suspend_parent = 0;
break;
}
} else {
suspend_parent = 0;
}
sx_xlock(udev->default_sx + 1);
/* notify all sub-devices about suspend */
err = usb2_suspend_resume(udev, 1);
sx_unlock(udev->default_sx + 1);
if (usb2_peer_can_wakeup(udev)) {
/* allow device to do remote wakeup */
err = usb2_req_set_device_feature(udev,
NULL, UF_DEVICE_REMOTE_WAKEUP);
if (err) {
DPRINTFN(0, "Setting device "
"remote wakeup failed!\n");
}
}
USB_BUS_LOCK(udev->bus);
/*
* Set that this device is suspended. This variable must be set
* before calling USB controller suspend callbacks.
*/
udev->pwr_save.suspended = 1;
USB_BUS_UNLOCK(udev->bus);
if (udev->bus->methods->device_suspend != NULL) {
/* suspend device on the USB controller */
(udev->bus->methods->device_suspend) (udev);
/* do DMA delay */
temp = usb2_get_dma_delay(udev->bus);
usb2_pause_mtx(NULL, USB_MS_TO_TICKS(temp));
}
/* suspend current port */
err = usb2_req_set_port_feature(udev->parent_hub,
NULL, udev->port_no, UHF_PORT_SUSPEND);
if (err) {
DPRINTFN(0, "Suspending port failed\n");
return;
}
if (suspend_parent) {
udev = udev->parent_hub;
goto repeat;
}
return;
}
/*------------------------------------------------------------------------*
* usb2_set_power_mode
*
* This function will set the power mode, see USB_POWER_MODE_XXX for a
* USB device.
*------------------------------------------------------------------------*/
void
usb2_set_power_mode(struct usb2_device *udev, uint8_t power_mode)
{
/* filter input argument */
if ((power_mode != USB_POWER_MODE_ON) &&
(power_mode != USB_POWER_MODE_OFF)) {
power_mode = USB_POWER_MODE_SAVE;
}
udev->power_mode = power_mode; /* update copy of power mode */
usb2_bus_power_update(udev->bus);
return;
}
|