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
|
/*
* Copyright (C) 2015 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 <strings.h>
#include <unistd.h>
#include <errno.h>
#include <byteswap.h>
#include <ipxe/malloc.h>
#include <ipxe/pci.h>
#include <ipxe/usb.h>
#include "ehci.h"
#include "uhci.h"
/** @file
*
* USB Universal Host Controller Interface (UHCI) driver
*
*/
/******************************************************************************
*
* Register access
*
******************************************************************************
*/
/**
* Check that address is reachable
*
* @v addr Address
* @v len Length
* @ret rc Return status code
*/
static inline __attribute__ (( always_inline)) int
uhci_reachable ( void *addr, size_t len ) {
physaddr_t phys = virt_to_phys ( addr );
/* Always reachable in a 32-bit build */
if ( sizeof ( physaddr_t ) <= sizeof ( uint32_t ) )
return 0;
/* Reachable if below 4GB */
if ( ( ( phys + len - 1 ) & ~0xffffffffULL ) == 0 )
return 0;
return -ENOTSUP;
}
/******************************************************************************
*
* Run / stop / reset
*
******************************************************************************
*/
/**
* Start UHCI device
*
* @v uhci UHCI device
*/
static void uhci_run ( struct uhci_device *uhci ) {
uint16_t usbcmd;
/* Set run/stop bit */
usbcmd = inw ( uhci->regs + UHCI_USBCMD );
usbcmd |= ( UHCI_USBCMD_RUN | UHCI_USBCMD_MAX64 );
outw ( usbcmd, uhci->regs + UHCI_USBCMD );
}
/**
* Stop UHCI device
*
* @v uhci UHCI device
* @ret rc Return status code
*/
static int uhci_stop ( struct uhci_device *uhci ) {
uint16_t usbcmd;
uint16_t usbsts;
unsigned int i;
/* Clear run/stop bit */
usbcmd = inw ( uhci->regs + UHCI_USBCMD );
usbcmd &= ~UHCI_USBCMD_RUN;
outw ( usbcmd, uhci->regs + UHCI_USBCMD );
/* Wait for device to stop */
for ( i = 0 ; i < UHCI_STOP_MAX_WAIT_MS ; i++ ) {
/* Check if device is stopped */
usbsts = inw ( uhci->regs + UHCI_USBSTS );
if ( usbsts & UHCI_USBSTS_HCHALTED )
return 0;
/* Delay */
mdelay ( 1 );
}
DBGC ( uhci, "UHCI %s timed out waiting for stop\n", uhci->name );
return -ETIMEDOUT;
}
/**
* Reset UHCI device
*
* @v uhci UHCI device
* @ret rc Return status code
*/
static int uhci_reset ( struct uhci_device *uhci ) {
uint16_t usbcmd;
unsigned int i;
int rc;
/* The UHCI specification states that resetting a running
* device may result in undefined behaviour, so try stopping
* it first.
*/
if ( ( rc = uhci_stop ( uhci ) ) != 0 ) {
/* Ignore errors and attempt to reset the device anyway */
}
/* Reset device */
outw ( UHCI_USBCMD_HCRESET, uhci->regs + UHCI_USBCMD );
/* Wait for reset to complete */
for ( i = 0 ; i < UHCI_RESET_MAX_WAIT_MS ; i++ ) {
/* Check if reset is complete */
usbcmd = inw ( uhci->regs + UHCI_USBCMD );
if ( ! ( usbcmd & UHCI_USBCMD_HCRESET ) )
return 0;
/* Delay */
mdelay ( 1 );
}
DBGC ( uhci, "UHCI %s timed out waiting for reset\n", uhci->name );
return -ETIMEDOUT;
}
/******************************************************************************
*
* Transfer descriptor rings
*
******************************************************************************
*/
/**
* Allocate transfer ring
*
* @v ring Transfer ring
* @ret rc Return status code
*/
static int uhci_ring_alloc ( struct uhci_ring *ring ) {
int rc;
/* Initialise structure */
memset ( ring, 0, sizeof ( *ring ) );
/* Allocate queue head */
ring->head = malloc_dma ( sizeof ( *ring->head ), UHCI_ALIGN );
if ( ! ring->head ) {
rc = -ENOMEM;
goto err_alloc;
}
if ( ( rc = uhci_reachable ( ring->head,
sizeof ( *ring->head ) ) ) != 0 )
goto err_unreachable;
/* Initialise queue head */
ring->head->current = cpu_to_le32 ( UHCI_LINK_TERMINATE );
return 0;
err_unreachable:
free_dma ( ring->head, sizeof ( *ring->head ) );
err_alloc:
return rc;
}
/**
* Free transfer ring
*
* @v ring Transfer ring
*/
static void uhci_ring_free ( struct uhci_ring *ring ) {
unsigned int i;
/* Sanity checks */
assert ( uhci_ring_fill ( ring ) == 0 );
for ( i = 0 ; i < UHCI_RING_COUNT ; i++ )
assert ( ring->xfer[i] == NULL );
/* Free queue head */
free_dma ( ring->head, sizeof ( *ring->head ) );
}
/**
* Enqueue new transfer
*
* @v ring Transfer ring
* @v iobuf I/O buffer
* @v count Number of descriptors
* @ret rc Return status code
*/
static int uhci_enqueue ( struct uhci_ring *ring, struct io_buffer *iobuf,
unsigned int count ) {
struct uhci_transfer *xfer;
struct uhci_transfer *end;
struct uhci_transfer_descriptor *desc;
unsigned int index = ( ring->prod % UHCI_RING_COUNT );
uint32_t link;
size_t len;
int rc;
/* Sanity check */
assert ( count > 0 );
assert ( iobuf != NULL );
/* Check for space in ring */
if ( ! uhci_ring_remaining ( ring ) ) {
rc = -ENOBUFS;
goto err_ring_full;
}
/* Check for reachability of I/O buffer */
if ( ( rc = uhci_reachable ( iobuf->data, iob_len ( iobuf ) ) ) != 0 )
goto err_unreachable_iobuf;
/* Allocate transfer */
xfer = malloc ( sizeof ( *xfer ) );
if ( ! xfer ) {
rc = -ENOMEM;
goto err_alloc_xfer;
}
/* Initialise transfer */
xfer->prod = 0;
xfer->cons = 0;
xfer->len = 0;
xfer->iobuf = iobuf;
/* Allocate transfer descriptors */
len = ( count * sizeof ( xfer->desc[0] ) );
xfer->desc = malloc_dma ( len, UHCI_ALIGN );
if ( ! xfer->desc ) {
rc = -ENOMEM;
goto err_alloc_desc;
}
if ( ( rc = uhci_reachable ( xfer->desc, len ) ) != 0 )
goto err_unreachable_desc;
/* Initialise transfer descriptors */
memset ( xfer->desc, 0, len );
desc = xfer->desc;
for ( ; --count ; desc++ ) {
link = ( virt_to_phys ( desc + 1 ) | UHCI_LINK_DEPTH_FIRST );
desc->link = cpu_to_le32 ( link );
desc->flags = ring->flags;
}
desc->link = cpu_to_le32 ( UHCI_LINK_TERMINATE );
desc->flags = ( ring->flags | UHCI_FL_IOC );
/* Add to ring */
wmb();
link = virt_to_phys ( xfer->desc );
if ( uhci_ring_fill ( ring ) > 0 ) {
end = ring->end;
end->desc[ end->prod - 1 ].link = cpu_to_le32 ( link );
} else {
ring->head->current = cpu_to_le32 ( link );
}
assert ( ring->xfer[index] == NULL );
ring->xfer[index] = xfer;
ring->end = xfer;
ring->prod++;
return 0;
err_unreachable_desc:
free_dma ( xfer->desc, len );
err_alloc_desc:
free ( xfer );
err_alloc_xfer:
err_unreachable_iobuf:
err_ring_full:
return rc;
}
/**
* Describe transfer
*
* @v ring Transfer ring
* @v data Data
* @v len Length of data
* @v pid Packet ID
*/
static void uhci_describe ( struct uhci_ring *ring, void *data,
size_t len, uint8_t pid ) {
struct uhci_transfer *xfer = ring->end;
struct uhci_transfer_descriptor *desc;
size_t frag_len;
uint32_t control;
do {
/* Calculate fragment length */
frag_len = len;
if ( frag_len > ring->mtu )
frag_len = ring->mtu;
/* Populate descriptor */
desc = &xfer->desc[xfer->prod++];
if ( pid == USB_PID_IN )
desc->flags |= UHCI_FL_SPD;
control = ( ring->control | UHCI_CONTROL_PID ( pid ) |
UHCI_CONTROL_LEN ( frag_len ) );
desc->control = cpu_to_le32 ( control );
if ( data )
desc->data = virt_to_phys ( data );
wmb();
desc->status = UHCI_STATUS_ACTIVE;
/* Update data toggle */
ring->control ^= UHCI_CONTROL_TOGGLE;
/* Move to next descriptor */
data += frag_len;
len -= frag_len;
} while ( len );
}
/**
* Dequeue transfer
*
* @v ring Transfer ring
* @ret iobuf I/O buffer
*/
static struct io_buffer * uhci_dequeue ( struct uhci_ring *ring ) {
unsigned int index = ( ring->cons % UHCI_RING_COUNT );
struct io_buffer *iobuf;
struct uhci_transfer *xfer;
size_t len;
/* Sanity checks */
assert ( uhci_ring_fill ( ring ) > 0 );
/* Consume transfer */
xfer = ring->xfer[index];
assert ( xfer != NULL );
assert ( xfer->desc != NULL );
iobuf = xfer->iobuf;
assert ( iobuf != NULL );
ring->xfer[index] = NULL;
ring->cons++;
/* Free transfer descriptors */
len = ( xfer->prod * sizeof ( xfer->desc[0] ) );
free_dma ( xfer->desc, len );
/* Free transfer */
free ( xfer );
return iobuf;
}
/**
* Restart ring
*
* @v ring Transfer ring
* @v toggle Expected data toggle for next descriptor
*/
static void uhci_restart ( struct uhci_ring *ring, uint32_t toggle ) {
struct uhci_transfer *xfer;
struct uhci_transfer_descriptor *desc;
struct uhci_transfer_descriptor *first;
uint32_t link;
unsigned int i;
unsigned int j;
/* Sanity check */
assert ( ring->head->current == cpu_to_le32 ( UHCI_LINK_TERMINATE ) );
/* If ring is empty, then just update the data toggle for the
* next descriptor.
*/
if ( uhci_ring_fill ( ring ) == 0 ) {
ring->control &= ~UHCI_CONTROL_TOGGLE;
ring->control |= toggle;
return;
}
/* If expected toggle does not match the toggle in the first
* unconsumed descriptor, then invert all toggles.
*/
xfer = ring->xfer[ ring->cons % UHCI_RING_COUNT ];
assert ( xfer != NULL );
assert ( xfer->cons == 0 );
first = &xfer->desc[0];
if ( ( le32_to_cpu ( first->control ) ^ toggle ) & UHCI_CONTROL_TOGGLE){
/* Invert toggle on all unconsumed transfer descriptors */
for ( i = ring->cons ; i != ring->prod ; i++ ) {
xfer = ring->xfer[ i % UHCI_RING_COUNT ];
assert ( xfer != NULL );
assert ( xfer->cons == 0 );
for ( j = 0 ; j < xfer->prod ; j++ ) {
desc = &xfer->desc[j];
desc->control ^=
cpu_to_le32 ( UHCI_CONTROL_TOGGLE );
}
}
/* Invert toggle for next descriptor to be enqueued */
ring->control ^= UHCI_CONTROL_TOGGLE;
}
/* Restart ring at first unconsumed transfer */
link = virt_to_phys ( first );
wmb();
ring->head->current = cpu_to_le32 ( link );
}
/******************************************************************************
*
* Schedule management
*
******************************************************************************
*/
/**
* Get link value for a queue head
*
* @v queue Queue head
* @ret link Link value
*/
static inline uint32_t uhci_link_qh ( struct uhci_queue_head *queue ) {
return ( virt_to_phys ( queue ) | UHCI_LINK_TYPE_QH );
}
/**
* (Re)build asynchronous schedule
*
* @v uhci UHCI device
*/
static void uhci_async_schedule ( struct uhci_device *uhci ) {
struct uhci_endpoint *endpoint;
struct uhci_queue_head *queue;
uint32_t end;
uint32_t link;
/* Build schedule in reverse order of execution. Provided
* that we only ever add or remove single endpoints, this can
* safely run concurrently with hardware execution of the
* schedule.
*/
link = end = uhci_link_qh ( uhci->head );
list_for_each_entry_reverse ( endpoint, &uhci->async, schedule ) {
queue = endpoint->ring.head;
queue->link = cpu_to_le32 ( link );
wmb();
link = uhci_link_qh ( queue );
}
if ( link == end )
link = UHCI_LINK_TERMINATE;
uhci->head->link = cpu_to_le32 ( link );
wmb();
}
/**
* Add endpoint to asynchronous schedule
*
* @v endpoint Endpoint
*/
static void uhci_async_add ( struct uhci_endpoint *endpoint ) {
struct uhci_device *uhci = endpoint->uhci;
/* Add to end of schedule */
list_add_tail ( &endpoint->schedule, &uhci->async );
/* Rebuild schedule */
uhci_async_schedule ( uhci );
}
/**
* Remove endpoint from asynchronous schedule
*
* @v endpoint Endpoint
*/
static void uhci_async_del ( struct uhci_endpoint *endpoint ) {
struct uhci_device *uhci = endpoint->uhci;
/* Remove from schedule */
list_check_contains_entry ( endpoint, &uhci->async, schedule );
list_del ( &endpoint->schedule );
/* Rebuild schedule */
uhci_async_schedule ( uhci );
/* Delay for a whole USB frame (with a 100% safety margin) */
mdelay ( 2 );
}
/**
* (Re)build periodic schedule
*
* @v uhci UHCI device
*/
static void uhci_periodic_schedule ( struct uhci_device *uhci ) {
struct uhci_endpoint *endpoint;
struct uhci_queue_head *queue;
uint32_t link;
uint32_t end;
unsigned int max_interval;
unsigned int i;
/* Build schedule in reverse order of execution. Provided
* that we only ever add or remove single endpoints, this can
* safely run concurrently with hardware execution of the
* schedule.
*/
DBGCP ( uhci, "UHCI %s periodic schedule: ", uhci->name );
link = end = uhci_link_qh ( uhci->head );
list_for_each_entry_reverse ( endpoint, &uhci->periodic, schedule ) {
queue = endpoint->ring.head;
queue->link = cpu_to_le32 ( link );
wmb();
DBGCP ( uhci, "%s%d", ( ( link == end ) ? "" : "<-" ),
endpoint->ep->interval );
link = uhci_link_qh ( queue );
}
DBGCP ( uhci, "\n" );
/* Populate periodic frame list */
DBGCP ( uhci, "UHCI %s periodic frame list:", uhci->name );
for ( i = 0 ; i < UHCI_FRAMES ; i++ ) {
/* Calculate maximum interval (in microframes) which
* may appear as part of this frame list.
*/
if ( i == 0 ) {
/* Start of list: include all endpoints */
max_interval = -1U;
} else {
/* Calculate highest power-of-two frame interval */
max_interval = ( 1 << ( ffs ( i ) - 1 ) );
/* Convert to microframes */
max_interval <<= 3;
/* Round up to nearest 2^n-1 */
max_interval = ( ( max_interval << 1 ) - 1 );
}
/* Find first endpoint in schedule satisfying this
* maximum interval constraint.
*/
link = uhci_link_qh ( uhci->head );
list_for_each_entry ( endpoint, &uhci->periodic, schedule ) {
if ( endpoint->ep->interval <= max_interval ) {
queue = endpoint->ring.head;
link = uhci_link_qh ( queue );
DBGCP ( uhci, " %d:%d",
i, endpoint->ep->interval );
break;
}
}
uhci->frame->link[i] = cpu_to_le32 ( link );
}
wmb();
DBGCP ( uhci, "\n" );
}
/**
* Add endpoint to periodic schedule
*
* @v endpoint Endpoint
*/
static void uhci_periodic_add ( struct uhci_endpoint *endpoint ) {
struct uhci_device *uhci = endpoint->uhci;
struct uhci_endpoint *before;
unsigned int interval = endpoint->ep->interval;
/* Find first endpoint with a smaller interval */
list_for_each_entry ( before, &uhci->periodic, schedule ) {
if ( before->ep->interval < interval )
break;
}
list_add_tail ( &endpoint->schedule, &before->schedule );
/* Rebuild schedule */
uhci_periodic_schedule ( uhci );
}
/**
* Remove endpoint from periodic schedule
*
* @v endpoint Endpoint
*/
static void uhci_periodic_del ( struct uhci_endpoint *endpoint ) {
struct uhci_device *uhci = endpoint->uhci;
/* Remove from schedule */
list_check_contains_entry ( endpoint, &uhci->periodic, schedule );
list_del ( &endpoint->schedule );
/* Rebuild schedule */
uhci_periodic_schedule ( uhci );
/* Delay for a whole USB frame (with a 100% safety margin) */
mdelay ( 2 );
}
/**
* Add endpoint to appropriate schedule
*
* @v endpoint Endpoint
*/
static void uhci_schedule_add ( struct uhci_endpoint *endpoint ) {
struct usb_endpoint *ep = endpoint->ep;
unsigned int attr = ( ep->attributes & USB_ENDPOINT_ATTR_TYPE_MASK );
if ( attr == USB_ENDPOINT_ATTR_INTERRUPT ) {
uhci_periodic_add ( endpoint );
} else {
uhci_async_add ( endpoint );
}
}
/**
* Remove endpoint from appropriate schedule
*
* @v endpoint Endpoint
*/
static void uhci_schedule_del ( struct uhci_endpoint *endpoint ) {
struct usb_endpoint *ep = endpoint->ep;
unsigned int attr = ( ep->attributes & USB_ENDPOINT_ATTR_TYPE_MASK );
if ( attr == USB_ENDPOINT_ATTR_INTERRUPT ) {
uhci_periodic_del ( endpoint );
} else {
uhci_async_del ( endpoint );
}
}
/******************************************************************************
*
* Endpoint operations
*
******************************************************************************
*/
/**
* Open endpoint
*
* @v ep USB endpoint
* @ret rc Return status code
*/
static int uhci_endpoint_open ( struct usb_endpoint *ep ) {
struct usb_device *usb = ep->usb;
struct uhci_device *uhci = usb_get_hostdata ( usb );
struct uhci_endpoint *endpoint;
int rc;
/* Allocate and initialise structure */
endpoint = zalloc ( sizeof ( *endpoint ) );
if ( ! endpoint ) {
rc = -ENOMEM;
goto err_alloc;
}
endpoint->uhci = uhci;
endpoint->ep = ep;
usb_endpoint_set_hostdata ( ep, endpoint );
/* Initialise descriptor ring */
if ( ( rc = uhci_ring_alloc ( &endpoint->ring ) ) != 0 )
goto err_ring_alloc;
endpoint->ring.mtu = ep->mtu;
endpoint->ring.flags = UHCI_FL_CERR_MAX;
if ( usb->speed < USB_SPEED_FULL )
endpoint->ring.flags |= UHCI_FL_LS;
endpoint->ring.control = ( UHCI_CONTROL_DEVICE ( usb->address ) |
UHCI_CONTROL_ENDPOINT ( ep->address ) );
/* Add to list of endpoints */
list_add_tail ( &endpoint->list, &uhci->endpoints );
/* Add to schedule */
uhci_schedule_add ( endpoint );
return 0;
uhci_ring_free ( &endpoint->ring );
err_ring_alloc:
free ( endpoint );
err_alloc:
return rc;
}
/**
* Close endpoint
*
* @v ep USB endpoint
*/
static void uhci_endpoint_close ( struct usb_endpoint *ep ) {
struct uhci_endpoint *endpoint = usb_endpoint_get_hostdata ( ep );
struct io_buffer *iobuf;
/* Remove from schedule */
uhci_schedule_del ( endpoint );
/* Cancel any incomplete transfers */
while ( uhci_ring_fill ( &endpoint->ring ) ) {
iobuf = uhci_dequeue ( &endpoint->ring );
if ( iobuf )
usb_complete_err ( ep, iobuf, -ECANCELED );
}
/* Remove from list of endpoints */
list_del ( &endpoint->list );
/* Free descriptor ring */
uhci_ring_free ( &endpoint->ring );
/* Free endpoint */
free ( endpoint );
}
/**
* Reset endpoint
*
* @v ep USB endpoint
* @ret rc Return status code
*/
static int uhci_endpoint_reset ( struct usb_endpoint *ep ) {
struct uhci_endpoint *endpoint = usb_endpoint_get_hostdata ( ep );
struct uhci_ring *ring = &endpoint->ring;
/* Restart ring */
uhci_restart ( ring, 0 );
return 0;
}
/**
* Update MTU
*
* @v ep USB endpoint
* @ret rc Return status code
*/
static int uhci_endpoint_mtu ( struct usb_endpoint *ep ) {
struct uhci_endpoint *endpoint = usb_endpoint_get_hostdata ( ep );
/* Update endpoint MTU */
endpoint->ring.mtu = ep->mtu;
return 0;
}
/**
* Enqueue message transfer
*
* @v ep USB endpoint
* @v iobuf I/O buffer
* @ret rc Return status code
*/
static int uhci_endpoint_message ( struct usb_endpoint *ep,
struct io_buffer *iobuf ) {
struct uhci_endpoint *endpoint = usb_endpoint_get_hostdata ( ep );
struct uhci_ring *ring = &endpoint->ring;
struct usb_setup_packet *packet;
unsigned int count;
size_t len;
int input;
int rc;
/* Calculate number of descriptors */
assert ( iob_len ( iobuf ) >= sizeof ( *packet ) );
len = ( iob_len ( iobuf ) - sizeof ( *packet ) );
count = ( 1 /* setup stage */ +
( ( len + ring->mtu - 1 ) / ring->mtu ) /* data stage */ +
1 /* status stage */ );
/* Enqueue transfer */
if ( ( rc = uhci_enqueue ( ring, iobuf, count ) ) != 0 )
return rc;
/* Describe setup stage */
packet = iobuf->data;
ring->control &= ~UHCI_CONTROL_TOGGLE;
uhci_describe ( ring, packet, sizeof ( *packet ), USB_PID_SETUP );
iob_pull ( iobuf, sizeof ( *packet ) );
/* Describe data stage, if applicable */
assert ( ring->control & UHCI_CONTROL_TOGGLE );
input = ( packet->request & cpu_to_le16 ( USB_DIR_IN ) );
if ( len ) {
uhci_describe ( ring, iobuf->data, len,
( input ? USB_PID_IN : USB_PID_OUT ) );
}
/* Describe status stage */
ring->control |= UHCI_CONTROL_TOGGLE;
uhci_describe ( ring, NULL, 0,
( ( len && input ) ? USB_PID_OUT : USB_PID_IN ) );
/* Sanity check */
assert ( ring->end->prod == count );
return 0;
}
/**
* Enqueue stream transfer
*
* @v ep USB endpoint
* @v iobuf I/O buffer
* @v zlp Append a zero-length packet
* @ret rc Return status code
*/
static int uhci_endpoint_stream ( struct usb_endpoint *ep,
struct io_buffer *iobuf, int zlp ) {
struct uhci_endpoint *endpoint = usb_endpoint_get_hostdata ( ep );
struct uhci_ring *ring = &endpoint->ring;
unsigned int count;
size_t len;
int input;
int rc;
/* Calculate number of descriptors */
len = iob_len ( iobuf );
count = ( ( ( len + ring->mtu - 1 ) / ring->mtu ) + ( zlp ? 1 : 0 ) );
/* Enqueue transfer */
if ( ( rc = uhci_enqueue ( ring, iobuf, count ) ) != 0 )
return rc;
/* Describe data packet */
input = ( ep->address & USB_DIR_IN );
uhci_describe ( ring, iobuf->data, len,
( input ? USB_PID_IN : USB_PID_OUT ) );
/* Describe zero-length packet, if applicable */
if ( zlp )
uhci_describe ( ring, NULL, 0, USB_PID_OUT );
/* Sanity check */
assert ( ring->end->prod == count );
return 0;
}
/**
* Check if transfer is a message transfer
*
* @v xfer UHCI transfer
* @ret is_message Transfer is a message transfer
*/
static inline int uhci_is_message ( struct uhci_transfer *xfer ) {
struct uhci_transfer_descriptor *desc = &xfer->desc[0];
return ( ( desc->control & cpu_to_le32 ( UHCI_CONTROL_PID_MASK ) ) ==
cpu_to_le32 ( UHCI_CONTROL_PID ( USB_PID_SETUP ) ) );
}
/**
* Poll for completions
*
* @v endpoint Endpoint
*/
static void uhci_endpoint_poll ( struct uhci_endpoint *endpoint ) {
struct uhci_ring *ring = &endpoint->ring;
struct uhci_device *uhci = endpoint->uhci;
struct usb_endpoint *ep = endpoint->ep;
struct usb_device *usb = ep->usb;
struct uhci_transfer *xfer;
struct uhci_transfer_descriptor *desc;
struct io_buffer *iobuf;
unsigned int index;
uint32_t link;
uint32_t toggle;
uint32_t control;
uint16_t actual;
size_t len;
/* Consume all completed descriptors */
while ( uhci_ring_fill ( ring ) ) {
/* Stop if we reach an uncompleted descriptor */
index = ( ring->cons % UHCI_RING_COUNT );
xfer = ring->xfer[index];
assert ( xfer != NULL );
assert ( xfer->cons < xfer->prod );
desc = &xfer->desc[xfer->cons];
rmb();
if ( desc->status & UHCI_STATUS_ACTIVE )
break;
control = le32_to_cpu ( desc->control );
actual = le16_to_cpu ( desc->actual );
/* Update data length, if applicable */
if ( UHCI_DATA_PACKET ( control ) )
xfer->len += UHCI_ACTUAL_LEN ( actual );
/* If we have encountered an error, then deactivate
* the queue head (to prevent further hardware
* accesses to this transfer), consume the transfer,
* and report the error to the USB core.
*/
if ( desc->status & UHCI_STATUS_STALLED ) {
DBGC ( uhci, "UHCI %s %s completion %d.%d failed "
"(status %02x)\n", usb->name,
usb_endpoint_name ( ep ), index,
xfer->cons, desc->status );
link = UHCI_LINK_TERMINATE;
ring->head->current = cpu_to_le32 ( link );
wmb();
iobuf = uhci_dequeue ( ring );
usb_complete_err ( ep, iobuf, -EIO );
break;
}
/* Consume this descriptor */
xfer->cons++;
/* Check for short packets */
if ( UHCI_SHORT_PACKET ( control, actual ) ) {
/* Sanity checks */
assert ( desc->flags & UHCI_FL_SPD );
link = virt_to_phys ( desc );
assert ( ( le32_to_cpu ( ring->head->current ) &
~( UHCI_ALIGN - 1 ) ) == link );
/* If this is a message transfer, then restart
* at the status stage.
*/
if ( uhci_is_message ( xfer ) ) {
xfer->cons = ( xfer->prod - 1 );
link = virt_to_phys ( &xfer->desc[xfer->cons] );
ring->head->current = cpu_to_le32 ( link );
break;
}
/* Otherwise, this is a stream transfer.
* First, prevent further hardware access to
* this transfer.
*/
link = UHCI_LINK_TERMINATE;
ring->head->current = cpu_to_le32 ( link );
wmb();
/* Determine expected data toggle for next descriptor */
toggle = ( ( control ^ UHCI_CONTROL_TOGGLE ) &
UHCI_CONTROL_TOGGLE );
/* Consume this transfer */
len = xfer->len;
iobuf = uhci_dequeue ( ring );
/* Update packet length */
assert ( len <= iob_len ( iobuf ) );
iob_unput ( iobuf, ( iob_len ( iobuf ) - len ) );
/* Restart ring */
uhci_restart ( ring, toggle );
} else if ( xfer->cons == xfer->prod ) {
/* Completed a transfer: consume it */
len = xfer->len;
iobuf = uhci_dequeue ( ring );
assert ( len == iob_len ( iobuf ) );
} else {
/* Not a short packet and not yet complete:
* continue processing.
*/
continue;
}
/* Report completion to USB core */
usb_complete ( ep, iobuf );
}
}
/******************************************************************************
*
* Device operations
*
******************************************************************************
*/
/**
* Open device
*
* @v usb USB device
* @ret rc Return status code
*/
static int uhci_device_open ( struct usb_device *usb ) {
struct uhci_device *uhci = usb_bus_get_hostdata ( usb->port->hub->bus );
usb_set_hostdata ( usb, uhci );
return 0;
}
/**
* Close device
*
* @v usb USB device
*/
static void uhci_device_close ( struct usb_device *usb ) {
struct uhci_device *uhci = usb_get_hostdata ( usb );
struct usb_bus *bus = uhci->bus;
/* Free device address, if assigned */
if ( usb->address )
usb_free_address ( bus, usb->address );
}
/**
* Assign device address
*
* @v usb USB device
* @ret rc Return status code
*/
static int uhci_device_address ( struct usb_device *usb ) {
struct uhci_device *uhci = usb_get_hostdata ( usb );
struct usb_bus *bus = uhci->bus;
struct usb_endpoint *ep0 = usb_endpoint ( usb, USB_EP0_ADDRESS );
struct uhci_endpoint *endpoint0 = usb_endpoint_get_hostdata ( ep0 );
int address;
int rc;
/* Sanity checks */
assert ( usb->address == 0 );
assert ( ep0 != NULL );
/* Allocate device address */
address = usb_alloc_address ( bus );
if ( address < 0 ) {
rc = address;
DBGC ( uhci, "UHCI %s could not allocate address: %s\n",
usb->name, strerror ( rc ) );
goto err_alloc_address;
}
/* Set address */
if ( ( rc = usb_set_address ( usb, address ) ) != 0 )
goto err_set_address;
/* Update device address */
usb->address = address;
endpoint0->ring.control |= UHCI_CONTROL_DEVICE ( address );
return 0;
err_set_address:
usb_free_address ( bus, address );
err_alloc_address:
return rc;
}
/******************************************************************************
*
* Hub operations
*
******************************************************************************
*/
/**
* Open hub
*
* @v hub USB hub
* @ret rc Return status code
*/
static int uhci_hub_open ( struct usb_hub *hub __unused ) {
/* Nothing to do */
return 0;
}
/**
* Close hub
*
* @v hub USB hub
*/
static void uhci_hub_close ( struct usb_hub *hub __unused ) {
/* Nothing to do */
}
/******************************************************************************
*
* Root hub operations
*
******************************************************************************
*/
/**
* Open root hub
*
* @v hub USB hub
* @ret rc Return status code
*/
static int uhci_root_open ( struct usb_hub *hub __unused) {
/* Nothing to do */
return 0;
}
/**
* Close root hub
*
* @v hub USB hub
*/
static void uhci_root_close ( struct usb_hub *hub __unused ) {
/* Nothing to do */
}
/**
* Enable port
*
* @v hub USB hub
* @v port USB port
* @ret rc Return status code
*/
static int uhci_root_enable ( struct usb_hub *hub, struct usb_port *port ) {
struct uhci_device *uhci = usb_hub_get_drvdata ( hub );
uint16_t portsc;
unsigned int i;
/* Reset port */
portsc = inw ( uhci->regs + UHCI_PORTSC ( port->address ) );
portsc |= UHCI_PORTSC_PR;
outw ( portsc, uhci->regs + UHCI_PORTSC ( port->address ) );
mdelay ( USB_RESET_DELAY_MS );
portsc &= ~UHCI_PORTSC_PR;
outw ( portsc, uhci->regs + UHCI_PORTSC ( port->address ) );
mdelay ( USB_RESET_RECOVER_DELAY_MS );
/* Enable port */
portsc |= UHCI_PORTSC_PED;
outw ( portsc, uhci->regs + UHCI_PORTSC ( port->address ) );
mdelay ( USB_RESET_RECOVER_DELAY_MS );
/* Wait for port to become enabled */
for ( i = 0 ; i < UHCI_PORT_ENABLE_MAX_WAIT_MS ; i++ ) {
/* Check port status */
portsc = inw ( uhci->regs + UHCI_PORTSC ( port->address ) );
if ( portsc & UHCI_PORTSC_PED )
return 0;
/* Delay */
mdelay ( 1 );
}
DBGC ( uhci, "UHCI %s-%d timed out waiting for port to enable "
"(status %04x)\n", uhci->name, port->address, portsc );
return -ETIMEDOUT;
}
/**
* Disable port
*
* @v hub USB hub
* @v port USB port
* @ret rc Return status code
*/
static int uhci_root_disable ( struct usb_hub *hub, struct usb_port *port ) {
struct uhci_device *uhci = usb_hub_get_drvdata ( hub );
uint16_t portsc;
/* Disable port */
portsc = inw ( uhci->regs + UHCI_PORTSC ( port->address ) );
portsc &= ~UHCI_PORTSC_PED;
outw ( portsc, uhci->regs + UHCI_PORTSC ( port->address ) );
return 0;
}
/**
* Update root hub port speed
*
* @v hub USB hub
* @v port USB port
* @ret rc Return status code
*/
static int uhci_root_speed ( struct usb_hub *hub, struct usb_port *port ) {
struct uhci_device *uhci = usb_hub_get_drvdata ( hub );
struct pci_device pci;
uint16_t portsc;
unsigned int speed;
/* Read port status */
portsc = inw ( uhci->regs + UHCI_PORTSC ( port->address ) );
if ( ! ( portsc & UHCI_PORTSC_CCS ) ) {
/* Port not connected */
speed = USB_SPEED_NONE;
} else if ( uhci->companion &&
! find_usb_bus_by_location ( BUS_TYPE_PCI,
uhci->companion ) ) {
/* Defer connection detection until companion
* controller has been enumerated.
*/
pci_init ( &pci, uhci->companion );
DBGC ( uhci, "UHCI %s-%d deferring for companion " PCI_FMT "\n",
uhci->name, port->address, PCI_ARGS ( &pci ) );
speed = USB_SPEED_NONE;
} else if ( portsc & UHCI_PORTSC_LS ) {
/* Low-speed device */
speed = USB_SPEED_LOW;
} else {
/* Full-speed device */
speed = USB_SPEED_FULL;
}
port->speed = speed;
/* Record disconnections and clear changes */
port->disconnected |= ( portsc & UHCI_PORTSC_CSC );
outw ( portsc, uhci->regs + UHCI_PORTSC ( port->address ) );
return 0;
}
/**
* Clear transaction translator buffer
*
* @v hub USB hub
* @v port USB port
* @v ep USB endpoint
* @ret rc Return status code
*/
static int uhci_root_clear_tt ( struct usb_hub *hub, struct usb_port *port,
struct usb_endpoint *ep ) {
struct uhci_device *uhci = usb_hub_get_drvdata ( hub );
/* Should never be called; this is a root hub */
DBGC ( uhci, "UHCI %s-%d nonsensical CLEAR_TT for %s %s\n", uhci->name,
port->address, ep->usb->name, usb_endpoint_name ( ep ) );
return -ENOTSUP;
}
/**
* Poll for port status changes
*
* @v hub USB hub
* @v port USB port
*/
static void uhci_root_poll ( struct usb_hub *hub, struct usb_port *port ) {
struct uhci_device *uhci = usb_hub_get_drvdata ( hub );
uint16_t portsc;
uint16_t change;
/* Do nothing unless something has changed */
portsc = inw ( uhci->regs + UHCI_PORTSC ( port->address ) );
change = ( portsc & UHCI_PORTSC_CHANGE );
if ( ! change )
return;
/* Record disconnections and clear changes */
port->disconnected |= ( portsc & UHCI_PORTSC_CSC );
outw ( portsc, uhci->regs + UHCI_PORTSC ( port->address ) );
/* Report port status change */
usb_port_changed ( port );
}
/******************************************************************************
*
* Bus operations
*
******************************************************************************
*/
/**
* Open USB bus
*
* @v bus USB bus
* @ret rc Return status code
*/
static int uhci_bus_open ( struct usb_bus *bus ) {
struct uhci_device *uhci = usb_bus_get_hostdata ( bus );
int rc;
/* Sanity checks */
assert ( list_empty ( &uhci->async ) );
assert ( list_empty ( &uhci->periodic ) );
/* Allocate and initialise asynchronous queue head */
uhci->head = malloc_dma ( sizeof ( *uhci->head ), UHCI_ALIGN );
if ( ! uhci->head ) {
rc = -ENOMEM;
goto err_alloc_head;
}
if ( ( rc = uhci_reachable ( uhci->head, sizeof ( *uhci->head ) ) ) !=0)
goto err_unreachable_head;
memset ( uhci->head, 0, sizeof ( *uhci->head ) );
uhci->head->current = cpu_to_le32 ( UHCI_LINK_TERMINATE );
uhci_async_schedule ( uhci );
/* Allocate periodic frame list */
uhci->frame = malloc_dma ( sizeof ( *uhci->frame ),
sizeof ( *uhci->frame ) );
if ( ! uhci->frame ) {
rc = -ENOMEM;
goto err_alloc_frame;
}
if ( ( rc = uhci_reachable ( uhci->frame,
sizeof ( *uhci->frame ) ) ) != 0 )
goto err_unreachable_frame;
uhci_periodic_schedule ( uhci );
outl ( virt_to_phys ( uhci->frame ), uhci->regs + UHCI_FLBASEADD );
/* Start controller */
uhci_run ( uhci );
return 0;
uhci_stop ( uhci );
err_unreachable_frame:
free_dma ( uhci->frame, sizeof ( *uhci->frame ) );
err_alloc_frame:
err_unreachable_head:
free_dma ( uhci->head, sizeof ( *uhci->head ) );
err_alloc_head:
return rc;
}
/**
* Close USB bus
*
* @v bus USB bus
*/
static void uhci_bus_close ( struct usb_bus *bus ) {
struct uhci_device *uhci = usb_bus_get_hostdata ( bus );
/* Sanity checks */
assert ( list_empty ( &uhci->async ) );
assert ( list_empty ( &uhci->periodic ) );
/* Stop controller */
uhci_stop ( uhci );
/* Free periodic frame list */
free_dma ( uhci->frame, sizeof ( *uhci->frame ) );
/* Free asynchronous schedule */
free_dma ( uhci->head, sizeof ( *uhci->head ) );
}
/**
* Poll USB bus
*
* @v bus USB bus
*/
static void uhci_bus_poll ( struct usb_bus *bus ) {
struct uhci_device *uhci = usb_bus_get_hostdata ( bus );
struct usb_hub *hub = bus->hub;
struct uhci_endpoint *endpoint;
unsigned int i;
/* UHCI defers interrupts (including short packet detection)
* until the end of the frame. This can result in bulk IN
* endpoints remaining halted for much of the time, waiting
* for software action to reset the data toggles. We
* therefore ignore USBSTS and unconditionally poll all
* endpoints for completed transfer descriptors.
*
* As with EHCI, we trust that completion handlers are minimal
* and will not do anything that could plausibly affect the
* endpoint list itself.
*/
list_for_each_entry ( endpoint, &uhci->endpoints, list )
uhci_endpoint_poll ( endpoint );
/* UHCI provides no single bit to indicate that a port status
* change has occurred. We therefore unconditionally iterate
* over all ports looking for status changes.
*/
for ( i = 1 ; i <= UHCI_PORTS ; i++ )
uhci_root_poll ( hub, usb_port ( hub, i ) );
}
/******************************************************************************
*
* PCI interface
*
******************************************************************************
*/
/** USB host controller operations */
static struct usb_host_operations uhci_operations = {
.endpoint = {
.open = uhci_endpoint_open,
.close = uhci_endpoint_close,
.reset = uhci_endpoint_reset,
.mtu = uhci_endpoint_mtu,
.message = uhci_endpoint_message,
.stream = uhci_endpoint_stream,
},
.device = {
.open = uhci_device_open,
.close = uhci_device_close,
.address = uhci_device_address,
},
.bus = {
.open = uhci_bus_open,
.close = uhci_bus_close,
.poll = uhci_bus_poll,
},
.hub = {
.open = uhci_hub_open,
.close = uhci_hub_close,
},
.root = {
.open = uhci_root_open,
.close = uhci_root_close,
.enable = uhci_root_enable,
.disable = uhci_root_disable,
.speed = uhci_root_speed,
.clear_tt = uhci_root_clear_tt,
},
};
/**
* Locate EHCI companion controller (when no EHCI support is present)
*
* @v pci PCI device
* @ret busdevfn EHCI companion controller bus:dev.fn (if any)
*/
__weak unsigned int ehci_companion ( struct pci_device *pci __unused ) {
return 0;
}
/**
* Probe PCI device
*
* @v pci PCI device
* @ret rc Return status code
*/
static int uhci_probe ( struct pci_device *pci ) {
struct uhci_device *uhci;
struct usb_port *port;
unsigned int i;
int rc;
/* Allocate and initialise structure */
uhci = zalloc ( sizeof ( *uhci ) );
if ( ! uhci ) {
rc = -ENOMEM;
goto err_alloc;
}
uhci->name = pci->dev.name;
INIT_LIST_HEAD ( &uhci->endpoints );
INIT_LIST_HEAD ( &uhci->async );
INIT_LIST_HEAD ( &uhci->periodic );
/* Fix up PCI device */
adjust_pci_device ( pci );
/* Identify EHCI companion controller, if any */
uhci->companion = ehci_companion ( pci );
/* Claim ownership from BIOS. (There is no release mechanism
* for UHCI.)
*/
pci_write_config_word ( pci, UHCI_USBLEGSUP, UHCI_USBLEGSUP_DEFAULT );
/* Map registers */
uhci->regs = pci->ioaddr;
if ( ! uhci->regs ) {
rc = -ENODEV;
goto err_ioremap;
}
/* Reset device */
if ( ( rc = uhci_reset ( uhci ) ) != 0 )
goto err_reset;
/* Allocate USB bus */
uhci->bus = alloc_usb_bus ( &pci->dev, UHCI_PORTS, UHCI_MTU,
&uhci_operations );
if ( ! uhci->bus ) {
rc = -ENOMEM;
goto err_alloc_bus;
}
usb_bus_set_hostdata ( uhci->bus, uhci );
usb_hub_set_drvdata ( uhci->bus->hub, uhci );
/* Set port protocols */
for ( i = 1 ; i <= UHCI_PORTS ; i++ ) {
port = usb_port ( uhci->bus->hub, i );
port->protocol = USB_PROTO_2_0;
}
/* Register USB bus */
if ( ( rc = register_usb_bus ( uhci->bus ) ) != 0 )
goto err_register;
pci_set_drvdata ( pci, uhci );
return 0;
unregister_usb_bus ( uhci->bus );
err_register:
free_usb_bus ( uhci->bus );
err_alloc_bus:
uhci_reset ( uhci );
err_reset:
err_ioremap:
free ( uhci );
err_alloc:
return rc;
}
/**
* Remove PCI device
*
* @v pci PCI device
*/
static void uhci_remove ( struct pci_device *pci ) {
struct uhci_device *uhci = pci_get_drvdata ( pci );
struct usb_bus *bus = uhci->bus;
unregister_usb_bus ( bus );
assert ( list_empty ( &uhci->async ) );
assert ( list_empty ( &uhci->periodic ) );
free_usb_bus ( bus );
uhci_reset ( uhci );
free ( uhci );
}
/** UHCI PCI device IDs */
static struct pci_device_id uhci_ids[] = {
PCI_ROM ( 0xffff, 0xffff, "uhci", "UHCI", 0 ),
};
/** UHCI PCI driver */
struct pci_driver uhci_driver __pci_driver = {
.ids = uhci_ids,
.id_count = ( sizeof ( uhci_ids ) / sizeof ( uhci_ids[0] ) ),
.class = PCI_CLASS_ID ( PCI_CLASS_SERIAL, PCI_CLASS_SERIAL_USB,
PCI_CLASS_SERIAL_USB_UHCI ),
.probe = uhci_probe,
.remove = uhci_remove,
};
|