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
|
/** @file
Wrapper function for usb host controller interface.
Copyright (c) 2007, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "UsbBus.h"
//
// if RemainingDevicePath== NULL, then all Usb child devices in this bus are wanted.
// Use a shor form Usb class Device Path, which could match any usb device, in WantedUsbIoDPList to indicate all Usb devices
// are wanted Usb devices
//
USB_CLASS_FORMAT_DEVICE_PATH mAllUsbClassDevicePath = {
{
{
MESSAGING_DEVICE_PATH,
MSG_USB_CLASS_DP,
{
(UINT8) (sizeof (USB_CLASS_DEVICE_PATH)),
(UINT8) ((sizeof (USB_CLASS_DEVICE_PATH)) >> 8)
}
},
0xffff, // VendorId
0xffff, // ProductId
0xff, // DeviceClass
0xff, // DeviceSubClass
0xff // DeviceProtocol
},
{
END_DEVICE_PATH_TYPE,
END_ENTIRE_DEVICE_PATH_SUBTYPE,
{
END_DEVICE_PATH_LENGTH,
0
}
}
};
/**
Get the capability of the host controller.
@param UsbBus The usb driver.
@param MaxSpeed The maximum speed this host controller supports.
@param NumOfPort The number of the root hub port.
@param Is64BitCapable Whether this controller support 64 bit addressing.
@retval EFI_SUCCESS The host controller capability is returned.
@retval Others Failed to retrieve the host controller capability.
**/
EFI_STATUS
UsbHcGetCapability (
IN USB_BUS *UsbBus,
OUT UINT8 *MaxSpeed,
OUT UINT8 *NumOfPort,
OUT UINT8 *Is64BitCapable
)
{
EFI_STATUS Status;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->GetCapability (
UsbBus->Usb2Hc,
MaxSpeed,
NumOfPort,
Is64BitCapable
);
} else {
Status = UsbBus->UsbHc->GetRootHubPortNumber (UsbBus->UsbHc, NumOfPort);
*MaxSpeed = EFI_USB_SPEED_FULL;
*Is64BitCapable = (UINT8) FALSE;
}
return Status;
}
/**
Reset the host controller.
@param UsbBus The usb bus driver.
@param Attributes The reset type, only global reset is used by this driver.
@retval EFI_SUCCESS The reset operation succeeded.
@retval EFI_INVALID_PARAMETER Attributes is not valid.
@retval EFI_UNSUPPOURTED The type of reset specified by Attributes is
not currently supported by the host controller.
@retval EFI_DEVICE_ERROR Host controller isn't halted to reset.
**/
EFI_STATUS
UsbHcReset (
IN USB_BUS *UsbBus,
IN UINT16 Attributes
)
{
EFI_STATUS Status;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->Reset (UsbBus->Usb2Hc, Attributes);
} else {
Status = UsbBus->UsbHc->Reset (UsbBus->UsbHc, Attributes);
}
return Status;
}
/**
Get the current operation state of the host controller.
@param UsbBus The USB bus driver.
@param State The host controller operation state.
@retval EFI_SUCCESS The operation state is returned in State.
@retval Others Failed to get the host controller state.
**/
EFI_STATUS
UsbHcGetState (
IN USB_BUS *UsbBus,
OUT EFI_USB_HC_STATE *State
)
{
EFI_STATUS Status;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->GetState (UsbBus->Usb2Hc, State);
} else {
Status = UsbBus->UsbHc->GetState (UsbBus->UsbHc, State);
}
return Status;
}
/**
Set the host controller operation state.
@param UsbBus The USB bus driver.
@param State The state to set.
@retval EFI_SUCCESS The host controller is now working at State.
@retval Others Failed to set operation state.
**/
EFI_STATUS
UsbHcSetState (
IN USB_BUS *UsbBus,
IN EFI_USB_HC_STATE State
)
{
EFI_STATUS Status;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->SetState (UsbBus->Usb2Hc, State);
} else {
Status = UsbBus->UsbHc->SetState (UsbBus->UsbHc, State);
}
return Status;
}
/**
Get the root hub port state.
@param UsbBus The USB bus driver.
@param PortIndex The index of port.
@param PortStatus The variable to save port state.
@retval EFI_SUCCESS The root port state is returned in.
@retval Others Failed to get the root hub port state.
**/
EFI_STATUS
UsbHcGetRootHubPortStatus (
IN USB_BUS *UsbBus,
IN UINT8 PortIndex,
OUT EFI_USB_PORT_STATUS *PortStatus
)
{
EFI_STATUS Status;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->GetRootHubPortStatus (UsbBus->Usb2Hc, PortIndex, PortStatus);
} else {
Status = UsbBus->UsbHc->GetRootHubPortStatus (UsbBus->UsbHc, PortIndex, PortStatus);
}
return Status;
}
/**
Set the root hub port feature.
@param UsbBus The USB bus driver.
@param PortIndex The port index.
@param Feature The port feature to set.
@retval EFI_SUCCESS The port feature is set.
@retval Others Failed to set port feature.
**/
EFI_STATUS
UsbHcSetRootHubPortFeature (
IN USB_BUS *UsbBus,
IN UINT8 PortIndex,
IN EFI_USB_PORT_FEATURE Feature
)
{
EFI_STATUS Status;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->SetRootHubPortFeature (UsbBus->Usb2Hc, PortIndex, Feature);
} else {
Status = UsbBus->UsbHc->SetRootHubPortFeature (UsbBus->UsbHc, PortIndex, Feature);
}
return Status;
}
/**
Clear the root hub port feature.
@param UsbBus The USB bus driver.
@param PortIndex The port index.
@param Feature The port feature to clear.
@retval EFI_SUCCESS The port feature is clear.
@retval Others Failed to clear port feature.
**/
EFI_STATUS
UsbHcClearRootHubPortFeature (
IN USB_BUS *UsbBus,
IN UINT8 PortIndex,
IN EFI_USB_PORT_FEATURE Feature
)
{
EFI_STATUS Status;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->ClearRootHubPortFeature (UsbBus->Usb2Hc, PortIndex, Feature);
} else {
Status = UsbBus->UsbHc->ClearRootHubPortFeature (UsbBus->UsbHc, PortIndex, Feature);
}
return Status;
}
/**
Execute a control transfer to the device.
@param UsbBus The USB bus driver.
@param DevAddr The device address.
@param DevSpeed The device speed.
@param MaxPacket Maximum packet size of endpoint 0.
@param Request The control transfer request.
@param Direction The direction of data stage.
@param Data The buffer holding data.
@param DataLength The length of the data.
@param TimeOut Timeout (in ms) to wait until timeout.
@param Translator The transaction translator for low/full speed device.
@param UsbResult The result of transfer.
@retval EFI_SUCCESS The control transfer finished without error.
@retval Others The control transfer failed, reason returned in UsbReslt.
**/
EFI_STATUS
UsbHcControlTransfer (
IN USB_BUS *UsbBus,
IN UINT8 DevAddr,
IN UINT8 DevSpeed,
IN UINTN MaxPacket,
IN EFI_USB_DEVICE_REQUEST *Request,
IN EFI_USB_DATA_DIRECTION Direction,
IN OUT VOID *Data,
IN OUT UINTN *DataLength,
IN UINTN TimeOut,
IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
OUT UINT32 *UsbResult
)
{
EFI_STATUS Status;
BOOLEAN IsSlowDevice;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->ControlTransfer (
UsbBus->Usb2Hc,
DevAddr,
DevSpeed,
MaxPacket,
Request,
Direction,
Data,
DataLength,
TimeOut,
Translator,
UsbResult
);
} else {
IsSlowDevice = (BOOLEAN)(EFI_USB_SPEED_LOW == DevSpeed);
Status = UsbBus->UsbHc->ControlTransfer (
UsbBus->UsbHc,
DevAddr,
IsSlowDevice,
(UINT8) MaxPacket,
Request,
Direction,
Data,
DataLength,
TimeOut,
UsbResult
);
}
return Status;
}
/**
Execute a bulk transfer to the device's endpoint.
@param UsbBus The USB bus driver.
@param DevAddr The target device address.
@param EpAddr The target endpoint address, with direction encoded in
bit 7.
@param DevSpeed The device's speed.
@param MaxPacket The endpoint's max packet size.
@param BufferNum The number of data buffer.
@param Data Array of pointers to data buffer.
@param DataLength The length of data buffer.
@param DataToggle On input, the initial data toggle to use, also return
the next toggle on output.
@param TimeOut The time to wait until timeout.
@param Translator The transaction translator for low/full speed device.
@param UsbResult The result of USB execution.
@retval EFI_SUCCESS The bulk transfer is finished without error.
@retval Others Failed to execute bulk transfer, result in UsbResult.
**/
EFI_STATUS
UsbHcBulkTransfer (
IN USB_BUS *UsbBus,
IN UINT8 DevAddr,
IN UINT8 EpAddr,
IN UINT8 DevSpeed,
IN UINTN MaxPacket,
IN UINT8 BufferNum,
IN OUT VOID *Data[EFI_USB_MAX_BULK_BUFFER_NUM],
IN OUT UINTN *DataLength,
IN OUT UINT8 *DataToggle,
IN UINTN TimeOut,
IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
OUT UINT32 *UsbResult
)
{
EFI_STATUS Status;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->BulkTransfer (
UsbBus->Usb2Hc,
DevAddr,
EpAddr,
DevSpeed,
MaxPacket,
BufferNum,
Data,
DataLength,
DataToggle,
TimeOut,
Translator,
UsbResult
);
} else {
Status = UsbBus->UsbHc->BulkTransfer (
UsbBus->UsbHc,
DevAddr,
EpAddr,
(UINT8) MaxPacket,
*Data,
DataLength,
DataToggle,
TimeOut,
UsbResult
);
}
return Status;
}
/**
Queue or cancel an asynchronous interrupt transfer.
@param UsbBus The USB bus driver.
@param DevAddr The target device address.
@param EpAddr The target endpoint address, with direction encoded in
bit 7.
@param DevSpeed The device's speed.
@param MaxPacket The endpoint's max packet size.
@param IsNewTransfer Whether this is a new request. If not, cancel the old
request.
@param DataToggle Data toggle to use on input, next toggle on output.
@param PollingInterval The interval to poll the interrupt transfer (in ms).
@param DataLength The length of periodical data receive.
@param Translator The transaction translator for low/full speed device.
@param Callback Function to call when data is received.
@param Context The context to the callback.
@retval EFI_SUCCESS The asynchronous transfer is queued.
@retval Others Failed to queue the transfer.
**/
EFI_STATUS
UsbHcAsyncInterruptTransfer (
IN USB_BUS *UsbBus,
IN UINT8 DevAddr,
IN UINT8 EpAddr,
IN UINT8 DevSpeed,
IN UINTN MaxPacket,
IN BOOLEAN IsNewTransfer,
IN OUT UINT8 *DataToggle,
IN UINTN PollingInterval,
IN UINTN DataLength,
IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback,
IN VOID *Context OPTIONAL
)
{
EFI_STATUS Status;
BOOLEAN IsSlowDevice;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->AsyncInterruptTransfer (
UsbBus->Usb2Hc,
DevAddr,
EpAddr,
DevSpeed,
MaxPacket,
IsNewTransfer,
DataToggle,
PollingInterval,
DataLength,
Translator,
Callback,
Context
);
} else {
IsSlowDevice = (BOOLEAN)(EFI_USB_SPEED_LOW == DevSpeed);
Status = UsbBus->UsbHc->AsyncInterruptTransfer (
UsbBus->UsbHc,
DevAddr,
EpAddr,
IsSlowDevice,
(UINT8) MaxPacket,
IsNewTransfer,
DataToggle,
PollingInterval,
DataLength,
Callback,
Context
);
}
return Status;
}
/**
Execute a synchronous interrupt transfer to the target endpoint.
@param UsbBus The USB bus driver.
@param DevAddr The target device address.
@param EpAddr The target endpoint address, with direction encoded in
bit 7.
@param DevSpeed The device's speed.
@param MaxPacket The endpoint's max packet size.
@param Data Pointer to data buffer.
@param DataLength The length of data buffer.
@param DataToggle On input, the initial data toggle to use, also return
the next toggle on output.
@param TimeOut The time to wait until timeout.
@param Translator The transaction translator for low/full speed device.
@param UsbResult The result of USB execution.
@retval EFI_SUCCESS The synchronous interrupt transfer is OK.
@retval Others Failed to execute the synchronous interrupt transfer.
**/
EFI_STATUS
UsbHcSyncInterruptTransfer (
IN USB_BUS *UsbBus,
IN UINT8 DevAddr,
IN UINT8 EpAddr,
IN UINT8 DevSpeed,
IN UINTN MaxPacket,
IN OUT VOID *Data,
IN OUT UINTN *DataLength,
IN OUT UINT8 *DataToggle,
IN UINTN TimeOut,
IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
OUT UINT32 *UsbResult
)
{
EFI_STATUS Status;
BOOLEAN IsSlowDevice;
if (UsbBus->Usb2Hc != NULL) {
Status = UsbBus->Usb2Hc->SyncInterruptTransfer (
UsbBus->Usb2Hc,
DevAddr,
EpAddr,
DevSpeed,
MaxPacket,
Data,
DataLength,
DataToggle,
TimeOut,
Translator,
UsbResult
);
} else {
IsSlowDevice = (BOOLEAN) ((EFI_USB_SPEED_LOW == DevSpeed) ? TRUE : FALSE);
Status = UsbBus->UsbHc->SyncInterruptTransfer (
UsbBus->UsbHc,
DevAddr,
EpAddr,
IsSlowDevice,
(UINT8) MaxPacket,
Data,
DataLength,
DataToggle,
TimeOut,
UsbResult
);
}
return Status;
}
/**
Execute a synchronous Isochronous USB transfer.
@param UsbBus The USB bus driver.
@param DevAddr The target device address.
@param EpAddr The target endpoint address, with direction encoded in
bit 7.
@param DevSpeed The device's speed.
@param MaxPacket The endpoint's max packet size.
@param BufferNum The number of data buffer.
@param Data Array of pointers to data buffer.
@param DataLength The length of data buffer.
@param Translator The transaction translator for low/full speed device.
@param UsbResult The result of USB execution.
@retval EFI_UNSUPPORTED The isochronous transfer isn't supported now.
**/
EFI_STATUS
UsbHcIsochronousTransfer (
IN USB_BUS *UsbBus,
IN UINT8 DevAddr,
IN UINT8 EpAddr,
IN UINT8 DevSpeed,
IN UINTN MaxPacket,
IN UINT8 BufferNum,
IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM],
IN UINTN DataLength,
IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
OUT UINT32 *UsbResult
)
{
return EFI_UNSUPPORTED;
}
/**
Queue an asynchronous isochronous transfer.
@param UsbBus The USB bus driver.
@param DevAddr The target device address.
@param EpAddr The target endpoint address, with direction encoded in
bit 7.
@param DevSpeed The device's speed.
@param MaxPacket The endpoint's max packet size.
@param BufferNum The number of data buffer.
@param Data Array of pointers to data buffer.
@param DataLength The length of data buffer.
@param Translator The transaction translator for low/full speed device.
@param Callback The function to call when data is transferred.
@param Context The context to the callback function.
@retval EFI_UNSUPPORTED The asynchronous isochronous transfer isn't supported.
**/
EFI_STATUS
UsbHcAsyncIsochronousTransfer (
IN USB_BUS *UsbBus,
IN UINT8 DevAddr,
IN UINT8 EpAddr,
IN UINT8 DevSpeed,
IN UINTN MaxPacket,
IN UINT8 BufferNum,
IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM],
IN UINTN DataLength,
IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback,
IN VOID *Context
)
{
return EFI_UNSUPPORTED;
}
/**
Open the USB host controller protocol BY_CHILD.
@param Bus The USB bus driver.
@param Child The child handle.
@return The open protocol return.
**/
EFI_STATUS
UsbOpenHostProtoByChild (
IN USB_BUS *Bus,
IN EFI_HANDLE Child
)
{
EFI_USB_HC_PROTOCOL *UsbHc;
EFI_USB2_HC_PROTOCOL *Usb2Hc;
EFI_STATUS Status;
if (Bus->Usb2Hc != NULL) {
Status = gBS->OpenProtocol (
Bus->HostHandle,
&gEfiUsb2HcProtocolGuid,
(VOID **) &Usb2Hc,
mUsbBusDriverBinding.DriverBindingHandle,
Child,
EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
);
} else {
Status = gBS->OpenProtocol (
Bus->HostHandle,
&gEfiUsbHcProtocolGuid,
(VOID **) &UsbHc,
mUsbBusDriverBinding.DriverBindingHandle,
Child,
EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
);
}
return Status;
}
/**
Close the USB host controller protocol BY_CHILD.
@param Bus The USB bus driver.
@param Child The child handle.
**/
VOID
UsbCloseHostProtoByChild (
IN USB_BUS *Bus,
IN EFI_HANDLE Child
)
{
if (Bus->Usb2Hc != NULL) {
gBS->CloseProtocol (
Bus->HostHandle,
&gEfiUsb2HcProtocolGuid,
mUsbBusDriverBinding.DriverBindingHandle,
Child
);
} else {
gBS->CloseProtocol (
Bus->HostHandle,
&gEfiUsbHcProtocolGuid,
mUsbBusDriverBinding.DriverBindingHandle,
Child
);
}
}
/**
return the current TPL, copied from the EDKII glue lib.
@param VOID.
@return Current TPL.
**/
EFI_TPL
UsbGetCurrentTpl (
VOID
)
{
EFI_TPL Tpl;
Tpl = gBS->RaiseTPL (TPL_HIGH_LEVEL);
gBS->RestoreTPL (Tpl);
return Tpl;
}
/**
Create a new device path which only contain the first Usb part of the DevicePath.
@param DevicePath A full device path which contain the usb nodes.
@return A new device path which only contain the Usb part of the DevicePath.
**/
EFI_DEVICE_PATH_PROTOCOL *
EFIAPI
GetUsbDPFromFullDP (
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath
)
{
EFI_DEVICE_PATH_PROTOCOL *UsbDevicePathPtr;
EFI_DEVICE_PATH_PROTOCOL *UsbDevicePathBeginPtr;
EFI_DEVICE_PATH_PROTOCOL *UsbDevicePathEndPtr;
UINTN Size;
//
// Get the Usb part first Begin node in full device path
//
UsbDevicePathBeginPtr = DevicePath;
while ( (!IsDevicePathEnd (UsbDevicePathBeginPtr))&&
((UsbDevicePathBeginPtr->Type != MESSAGING_DEVICE_PATH) ||
(UsbDevicePathBeginPtr->SubType != MSG_USB_DP &&
UsbDevicePathBeginPtr->SubType != MSG_USB_CLASS_DP
&& UsbDevicePathBeginPtr->SubType != MSG_USB_WWID_DP
))) {
UsbDevicePathBeginPtr = NextDevicePathNode(UsbDevicePathBeginPtr);
}
//
// Get the Usb part first End node in full device path
//
UsbDevicePathEndPtr = UsbDevicePathBeginPtr;
while ((!IsDevicePathEnd (UsbDevicePathEndPtr))&&
(UsbDevicePathEndPtr->Type == MESSAGING_DEVICE_PATH) &&
(UsbDevicePathEndPtr->SubType == MSG_USB_DP ||
UsbDevicePathEndPtr->SubType == MSG_USB_CLASS_DP
|| UsbDevicePathEndPtr->SubType == MSG_USB_WWID_DP
)) {
UsbDevicePathEndPtr = NextDevicePathNode(UsbDevicePathEndPtr);
}
Size = GetDevicePathSize (UsbDevicePathBeginPtr);
Size -= GetDevicePathSize (UsbDevicePathEndPtr);
if (Size ==0){
//
// The passed in DevicePath does not contain the usb nodes
//
return NULL;
}
//
// Create a new device path which only contain the above Usb part
//
UsbDevicePathPtr = AllocateZeroPool (Size + sizeof (EFI_DEVICE_PATH_PROTOCOL));
ASSERT (UsbDevicePathPtr != NULL);
CopyMem (UsbDevicePathPtr, UsbDevicePathBeginPtr, Size);
//
// Append end device path node
//
UsbDevicePathEndPtr = (EFI_DEVICE_PATH_PROTOCOL *) ((UINTN) UsbDevicePathPtr + Size);
SetDevicePathEndNode (UsbDevicePathEndPtr);
return UsbDevicePathPtr;
}
/**
Check whether a usb device path is in a DEVICE_PATH_LIST_ITEM list.
@param UsbDP a usb device path of DEVICE_PATH_LIST_ITEM.
@param UsbIoDPList a DEVICE_PATH_LIST_ITEM list.
@retval TRUE there is a DEVICE_PATH_LIST_ITEM in UsbIoDPList which contains the passed in UsbDP.
@retval FALSE there is no DEVICE_PATH_LIST_ITEM in UsbIoDPList which contains the passed in UsbDP.
**/
BOOLEAN
EFIAPI
SearchUsbDPInList (
IN EFI_DEVICE_PATH_PROTOCOL *UsbDP,
IN LIST_ENTRY *UsbIoDPList
)
{
LIST_ENTRY *ListIndex;
DEVICE_PATH_LIST_ITEM *ListItem;
BOOLEAN Found;
UINTN UsbDpDevicePathSize;
//
// Check that UsbDP and UsbIoDPList are valid
//
if ((UsbIoDPList == NULL) || (UsbDP == NULL)) {
return FALSE;
}
Found = FALSE;
ListIndex = UsbIoDPList->ForwardLink;
while (ListIndex != UsbIoDPList){
ListItem = CR(ListIndex, DEVICE_PATH_LIST_ITEM, Link, DEVICE_PATH_LIST_ITEM_SIGNATURE);
//
// Compare DEVICE_PATH_LIST_ITEM.DevicePath[]
//
ASSERT (ListItem->DevicePath != NULL);
UsbDpDevicePathSize = GetDevicePathSize (UsbDP);
if (UsbDpDevicePathSize == GetDevicePathSize (ListItem->DevicePath)) {
if ((CompareMem (UsbDP, ListItem->DevicePath, UsbDpDevicePathSize)) == 0) {
Found = TRUE;
break;
}
}
ListIndex = ListIndex->ForwardLink;
}
return Found;
}
/**
Add a usb device path into the DEVICE_PATH_LIST_ITEM list.
@param UsbDP a usb device path of DEVICE_PATH_LIST_ITEM.
@param UsbIoDPList a DEVICE_PATH_LIST_ITEM list.
@retval EFI_INVALID_PARAMETER If parameters are invalid, return this value.
@retval EFI_SUCCESS If Add operation is successful, return this value.
**/
EFI_STATUS
EFIAPI
AddUsbDPToList (
IN EFI_DEVICE_PATH_PROTOCOL *UsbDP,
IN LIST_ENTRY *UsbIoDPList
)
{
DEVICE_PATH_LIST_ITEM *ListItem;
//
// Check that UsbDP and UsbIoDPList are valid
//
if ((UsbIoDPList == NULL) || (UsbDP == NULL)) {
return EFI_INVALID_PARAMETER;
}
if (SearchUsbDPInList (UsbDP, UsbIoDPList)){
return EFI_SUCCESS;
}
//
// Prepare the usbio device path DEVICE_PATH_LIST_ITEM structure.
//
ListItem = AllocateZeroPool (sizeof (DEVICE_PATH_LIST_ITEM));
ASSERT (ListItem != NULL);
ListItem->Signature = DEVICE_PATH_LIST_ITEM_SIGNATURE;
ListItem->DevicePath = DuplicateDevicePath (UsbDP);
InsertTailList (UsbIoDPList, &ListItem->Link);
return EFI_SUCCESS;
}
/**
Check whether usb device, whose interface is UsbIf, matches the usb class which indicated by
UsbClassDevicePathPtr whose is a short form usb class device path.
@param UsbClassDevicePathPtr a short form usb class device path.
@param UsbIf a usb device interface.
@retval TRUE the usb device match the usb class.
@retval FALSE the usb device does not match the usb class.
**/
BOOLEAN
EFIAPI
MatchUsbClass (
IN USB_CLASS_DEVICE_PATH *UsbClassDevicePathPtr,
IN USB_INTERFACE *UsbIf
)
{
USB_INTERFACE_DESC *IfDesc;
EFI_USB_INTERFACE_DESCRIPTOR *ActIfDesc;
EFI_USB_DEVICE_DESCRIPTOR *DevDesc;
if ((UsbClassDevicePathPtr->Header.Type != MESSAGING_DEVICE_PATH) ||
(UsbClassDevicePathPtr->Header.SubType != MSG_USB_CLASS_DP)){
ASSERT (0);
return FALSE;
}
IfDesc = UsbIf->IfDesc;
ActIfDesc = &(IfDesc->Settings[IfDesc->ActiveIndex]->Desc);
DevDesc = &(UsbIf->Device->DevDesc->Desc);
//
// If connect class policy, determine whether to create device handle by the five fields
// in class device path node.
//
// In addtion, hub interface is always matched for this policy.
//
if ((ActIfDesc->InterfaceClass == USB_HUB_CLASS_CODE) &&
(ActIfDesc->InterfaceSubClass == USB_HUB_SUBCLASS_CODE)) {
return TRUE;
}
//
// If vendor id or product id is 0xffff, they will be ignored.
//
if ((UsbClassDevicePathPtr->VendorId == 0xffff || UsbClassDevicePathPtr->VendorId == DevDesc->IdVendor) &&
(UsbClassDevicePathPtr->ProductId == 0xffff || UsbClassDevicePathPtr->ProductId == DevDesc->IdProduct)) {
//
// If class or subclass or protocol is 0, the counterparts in interface should be checked.
//
if (DevDesc->DeviceClass == 0 ||
DevDesc->DeviceSubClass == 0 ||
DevDesc->DeviceProtocol == 0) {
if ((UsbClassDevicePathPtr->DeviceClass == ActIfDesc->InterfaceClass ||
UsbClassDevicePathPtr->DeviceClass == 0xff) &&
(UsbClassDevicePathPtr->DeviceSubClass == ActIfDesc->InterfaceSubClass ||
UsbClassDevicePathPtr->DeviceSubClass == 0xff) &&
(UsbClassDevicePathPtr->DeviceProtocol == ActIfDesc->InterfaceProtocol ||
UsbClassDevicePathPtr->DeviceProtocol == 0xff)) {
return TRUE;
}
} else if ((UsbClassDevicePathPtr->DeviceClass == DevDesc->DeviceClass ||
UsbClassDevicePathPtr->DeviceClass == 0xff) &&
(UsbClassDevicePathPtr->DeviceSubClass == DevDesc->DeviceSubClass ||
UsbClassDevicePathPtr->DeviceSubClass == 0xff) &&
(UsbClassDevicePathPtr->DeviceProtocol == DevDesc->DeviceProtocol ||
UsbClassDevicePathPtr->DeviceProtocol == 0xff)) {
return TRUE;
}
}
return FALSE;
}
/**
Check whether usb device, whose interface is UsbIf, matches the usb WWID requirement which indicated by
UsbWWIDDevicePathPtr whose is a short form usb WWID device path.
@param UsbWWIDDevicePathPtr a short form usb WWID device path.
@param UsbIf a usb device interface.
@retval TRUE the usb device match the usb WWID requirement.
@retval FALSE the usb device does not match the usb WWID requirement.
**/
BOOLEAN
MatchUsbWwid (
IN USB_WWID_DEVICE_PATH *UsbWWIDDevicePathPtr,
IN USB_INTERFACE *UsbIf
)
{
USB_INTERFACE_DESC *IfDesc;
EFI_USB_INTERFACE_DESCRIPTOR *ActIfDesc;
EFI_USB_DEVICE_DESCRIPTOR *DevDesc;
EFI_USB_STRING_DESCRIPTOR *StrDesc;
UINT16 *SnString;
if ((UsbWWIDDevicePathPtr->Header.Type != MESSAGING_DEVICE_PATH) ||
(UsbWWIDDevicePathPtr->Header.SubType != MSG_USB_WWID_DP )){
ASSERT (0);
return FALSE;
}
IfDesc = UsbIf->IfDesc;
ActIfDesc = &(IfDesc->Settings[IfDesc->ActiveIndex]->Desc);
DevDesc = &(UsbIf->Device->DevDesc->Desc);
StrDesc = UsbGetOneString (UsbIf->Device, DevDesc->StrSerialNumber, USB_US_LAND_ID);
SnString = (UINT16 *) ((UINT8 *)UsbWWIDDevicePathPtr + 10);
//
//In addtion, hub interface is always matched for this policy.
//
if ((ActIfDesc->InterfaceClass == USB_HUB_CLASS_CODE) &&
(ActIfDesc->InterfaceSubClass == USB_HUB_SUBCLASS_CODE)) {
return TRUE;
}
//
// If connect wwid policy, determine the objective device by the serial number of
// device descriptor.
// Get serial number index from device descriptor, then get serial number by index
// and land id, compare the serial number with wwid device path node at last
//
// BugBug: only check serial number here, should check Interface Number, Device Vendor Id, Device Product Id in later version
//
if (StrDesc != NULL && !StrnCmp (StrDesc->String, SnString, StrDesc->Length)) {
return TRUE;
}
return FALSE;
}
/**
Free a DEVICE_PATH_LIST_ITEM list.
@param UsbIoDPList a DEVICE_PATH_LIST_ITEM list pointer.
@retval EFI_INVALID_PARAMETER If parameters are invalid, return this value.
@retval EFI_SUCCESS If free operation is successful, return this value.
**/
EFI_STATUS
EFIAPI
UsbBusFreeUsbDPList (
IN LIST_ENTRY *UsbIoDPList
)
{
LIST_ENTRY *ListIndex;
DEVICE_PATH_LIST_ITEM *ListItem;
//
// Check that ControllerHandle is a valid handle
//
if (UsbIoDPList == NULL) {
return EFI_INVALID_PARAMETER;
}
ListIndex = UsbIoDPList->ForwardLink;
while (ListIndex != UsbIoDPList){
ListItem = CR(ListIndex, DEVICE_PATH_LIST_ITEM, Link, DEVICE_PATH_LIST_ITEM_SIGNATURE);
//
// Free DEVICE_PATH_LIST_ITEM.DevicePath[]
//
if (ListItem->DevicePath != NULL){
FreePool(ListItem->DevicePath);
}
//
// Free DEVICE_PATH_LIST_ITEM itself
//
ListIndex = ListIndex->ForwardLink;
RemoveEntryList (&ListItem->Link);
FreePool (ListItem);
}
InitializeListHead (UsbIoDPList);
return EFI_SUCCESS;
}
/**
Store a wanted usb child device info (its Usb part of device path) which is indicated by
RemainingDevicePath in a Usb bus which is indicated by UsbBusId.
@param UsbBusId Point to EFI_USB_BUS_PROTOCOL interface.
@param RemainingDevicePath The remaining device patch.
@retval EFI_SUCCESS Add operation is successful.
@retval EFI_INVALID_PARAMETER The parameters are invalid.
**/
EFI_STATUS
EFIAPI
UsbBusAddWantedUsbIoDP (
IN EFI_USB_BUS_PROTOCOL *UsbBusId,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
{
USB_BUS *Bus;
EFI_STATUS Status;
EFI_DEVICE_PATH_PROTOCOL *DevicePathPtr;
//
// Check whether remaining device path is valid
//
if (RemainingDevicePath != NULL) {
if ((RemainingDevicePath->Type != MESSAGING_DEVICE_PATH) ||
(RemainingDevicePath->SubType != MSG_USB_DP &&
RemainingDevicePath->SubType != MSG_USB_CLASS_DP
&& RemainingDevicePath->SubType != MSG_USB_WWID_DP
)) {
return EFI_INVALID_PARAMETER;
}
}
if (UsbBusId == NULL){
return EFI_INVALID_PARAMETER;
}
Bus = USB_BUS_FROM_THIS (UsbBusId);
if (RemainingDevicePath == NULL) {
//
// RemainingDevicePath== NULL means all Usb devices in this bus are wanted.
// Here use a Usb class Device Path in WantedUsbIoDPList to indicate all Usb devices
// are wanted Usb devices
//
Status = UsbBusFreeUsbDPList (&Bus->WantedUsbIoDPList);
ASSERT (!EFI_ERROR (Status));
DevicePathPtr = DuplicateDevicePath ((EFI_DEVICE_PATH_PROTOCOL *) &mAllUsbClassDevicePath);
} else {
//
// Create new Usb device path according to the usb part in remaining device path
//
DevicePathPtr = GetUsbDPFromFullDP (RemainingDevicePath);
}
ASSERT (DevicePathPtr != NULL);
Status = AddUsbDPToList (DevicePathPtr, &Bus->WantedUsbIoDPList);
ASSERT (!EFI_ERROR (Status));
gBS->FreePool (DevicePathPtr);
return EFI_SUCCESS;
}
/**
Check whether a usb child device is the wanted device in a bus.
@param Bus The Usb bus's private data pointer.
@param UsbIf The usb child device inferface.
@retval True If a usb child device is the wanted device in a bus.
@retval False If a usb child device is *NOT* the wanted device in a bus.
**/
BOOLEAN
EFIAPI
UsbBusIsWantedUsbIO (
IN USB_BUS *Bus,
IN USB_INTERFACE *UsbIf
)
{
EFI_DEVICE_PATH_PROTOCOL *DevicePathPtr;
LIST_ENTRY *WantedUsbIoDPListPtr;
LIST_ENTRY *WantedListIndex;
DEVICE_PATH_LIST_ITEM *WantedListItem;
BOOLEAN DoConvert;
UINTN FirstDevicePathSize;
//
// Check whether passed in parameters are valid
//
if ((UsbIf == NULL) || (Bus == NULL)) {
return FALSE;
}
//
// Check whether UsbIf is Hub
//
if (UsbIf->IsHub) {
return TRUE;
}
//
// Check whether all Usb devices in this bus are wanted
//
if (SearchUsbDPInList ((EFI_DEVICE_PATH_PROTOCOL *)&mAllUsbClassDevicePath, &Bus->WantedUsbIoDPList)){
return TRUE;
}
//
// Check whether the Usb device match any item in WantedUsbIoDPList
//
WantedUsbIoDPListPtr = &Bus->WantedUsbIoDPList;
//
// Create new Usb device path according to the usb part in UsbIo full device path
//
DevicePathPtr = GetUsbDPFromFullDP (UsbIf->DevicePath);
ASSERT (DevicePathPtr != NULL);
DoConvert = FALSE;
WantedListIndex = WantedUsbIoDPListPtr->ForwardLink;
while (WantedListIndex != WantedUsbIoDPListPtr){
WantedListItem = CR(WantedListIndex, DEVICE_PATH_LIST_ITEM, Link, DEVICE_PATH_LIST_ITEM_SIGNATURE);
ASSERT (WantedListItem->DevicePath->Type == MESSAGING_DEVICE_PATH);
switch (WantedListItem->DevicePath->SubType) {
case MSG_USB_DP:
FirstDevicePathSize = GetDevicePathSize (WantedListItem->DevicePath);
if (FirstDevicePathSize == GetDevicePathSize (DevicePathPtr)) {
if (CompareMem (
WantedListItem->DevicePath,
DevicePathPtr,
GetDevicePathSize (DevicePathPtr)) == 0
) {
DoConvert = TRUE;
}
}
break;
case MSG_USB_CLASS_DP:
if (MatchUsbClass((USB_CLASS_DEVICE_PATH *)WantedListItem->DevicePath, UsbIf)) {
DoConvert = TRUE;
}
break;
case MSG_USB_WWID_DP:
if (MatchUsbWwid((USB_WWID_DEVICE_PATH *)WantedListItem->DevicePath, UsbIf)) {
DoConvert = TRUE;
}
break;
default:
ASSERT (0);
break;
}
if (DoConvert) {
break;
}
WantedListIndex = WantedListIndex->ForwardLink;
}
gBS->FreePool (DevicePathPtr);
//
// Check whether the new Usb device path is wanted
//
if (DoConvert){
return TRUE;
} else {
return FALSE;
}
}
/**
Recursively connnect every wanted usb child device to ensure they all fully connected.
Check all the child Usb IO handles in this bus, recursively connecte if it is wanted usb child device.
@param UsbBusId Point to EFI_USB_BUS_PROTOCOL interface.
@retval EFI_SUCCESS Connect is done successfully.
@retval EFI_INVALID_PARAMETER The parameter is invalid.
**/
EFI_STATUS
EFIAPI
UsbBusRecursivelyConnectWantedUsbIo (
IN EFI_USB_BUS_PROTOCOL *UsbBusId
)
{
USB_BUS *Bus;
EFI_STATUS Status;
UINTN Index;
EFI_USB_IO_PROTOCOL *UsbIo;
USB_INTERFACE *UsbIf;
UINTN UsbIoHandleCount;
EFI_HANDLE *UsbIoBuffer;
EFI_DEVICE_PATH_PROTOCOL *UsbIoDevicePath;
if (UsbBusId == NULL){
return EFI_INVALID_PARAMETER;
}
Bus = USB_BUS_FROM_THIS (UsbBusId);
//
// Get all Usb IO handles in system
//
UsbIoHandleCount = 0;
Status = gBS->LocateHandleBuffer (ByProtocol, &gEfiUsbIoProtocolGuid, NULL, &UsbIoHandleCount, &UsbIoBuffer);
if (Status == EFI_NOT_FOUND || UsbIoHandleCount == 0) {
return EFI_SUCCESS;
}
ASSERT (!EFI_ERROR (Status));
for (Index = 0; Index < UsbIoHandleCount; Index++) {
//
// Check whether the USB IO handle is a child of this bus
// Note: The usb child handle maybe invalid because of hot plugged out during the loop
//
UsbIoDevicePath = NULL;
Status = gBS->HandleProtocol (UsbIoBuffer[Index], &gEfiDevicePathProtocolGuid, (VOID *) &UsbIoDevicePath);
if (EFI_ERROR (Status) || UsbIoDevicePath == NULL) {
continue;
}
if (CompareMem (
UsbIoDevicePath,
Bus->DevicePath,
(GetDevicePathSize (Bus->DevicePath) - sizeof (EFI_DEVICE_PATH_PROTOCOL))
) != 0) {
continue;
}
//
// Get the child Usb IO interface
//
Status = gBS->HandleProtocol(
UsbIoBuffer[Index],
&gEfiUsbIoProtocolGuid,
(VOID **) &UsbIo
);
if (EFI_ERROR (Status)) {
continue;
}
UsbIf = USB_INTERFACE_FROM_USBIO (UsbIo);
if (UsbBusIsWantedUsbIO (Bus, UsbIf)) {
if (!UsbIf->IsManaged) {
//
// Recursively connect the wanted Usb Io handle
//
DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL before connect is %d\n", (UINT32)UsbGetCurrentTpl ()));
Status = gBS->ConnectController (UsbIf->Handle, NULL, NULL, TRUE);
UsbIf->IsManaged = (BOOLEAN)!EFI_ERROR (Status);
DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL after connect is %d\n", (UINT32)UsbGetCurrentTpl()));
}
}
}
return EFI_SUCCESS;
}
|