]>
Commit | Line | Data |
---|---|---|
e237e7ae | 1 | /** @file\r |
2 | \r | |
8616fc4c | 3 | Wrapper function for usb host controller interface.\r |
4 | \r | |
e237e7ae | 5 | Copyright (c) 2007, Intel Corporation\r |
6 | All rights reserved. This program and the accompanying materials\r | |
7 | are licensed and made available under the terms and conditions of the BSD License\r | |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php\r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
e237e7ae | 14 | **/\r |
15 | \r | |
16 | \r | |
17 | #include "UsbBus.h"\r | |
18 | \r | |
ecb575d9 | 19 | //\r |
20 | // if RemainingDevicePath== NULL, then all Usb child devices in this bus are wanted.\r | |
21 | // Use a shor form Usb class Device Path, which could match any usb device, in WantedUsbIoDPList to indicate all Usb devices\r | |
22 | // are wanted Usb devices\r | |
23 | //\r | |
fe1e36e5 | 24 | USB_CLASS_FORMAT_DEVICE_PATH mAllUsbClassDevicePath = {\r |
ecb575d9 | 25 | {\r |
26 | {\r | |
27 | MESSAGING_DEVICE_PATH,\r | |
28 | MSG_USB_CLASS_DP,\r | |
faff3b47 | 29 | {\r |
30 | (UINT8) (sizeof (USB_CLASS_DEVICE_PATH)),\r | |
31 | (UINT8) ((sizeof (USB_CLASS_DEVICE_PATH)) >> 8)\r | |
32 | }\r | |
ecb575d9 | 33 | },\r |
34 | 0xffff, // VendorId\r | |
35 | 0xffff, // ProductId\r | |
36 | 0xff, // DeviceClass\r | |
37 | 0xff, // DeviceSubClass\r | |
38 | 0xff // DeviceProtocol\r | |
39 | },\r | |
40 | \r | |
41 | {\r | |
42 | END_DEVICE_PATH_TYPE,\r | |
43 | END_ENTIRE_DEVICE_PATH_SUBTYPE,\r | |
faff3b47 | 44 | {\r |
45 | END_DEVICE_PATH_LENGTH,\r | |
46 | 0\r | |
47 | }\r | |
ecb575d9 | 48 | }\r |
49 | };\r | |
50 | \r | |
e237e7ae | 51 | \r |
52 | /**\r | |
8616fc4c | 53 | Get the capability of the host controller.\r |
e237e7ae | 54 | \r |
8616fc4c | 55 | @param UsbBus The usb driver.\r |
56 | @param MaxSpeed The maximum speed this host controller supports.\r | |
57 | @param NumOfPort The number of the root hub port.\r | |
58 | @param Is64BitCapable Whether this controller support 64 bit addressing.\r | |
e237e7ae | 59 | \r |
8616fc4c | 60 | @retval EFI_SUCCESS The host controller capability is returned.\r |
e237e7ae | 61 | @retval Others Failed to retrieve the host controller capability.\r |
62 | \r | |
63 | **/\r | |
64 | EFI_STATUS\r | |
65 | UsbHcGetCapability (\r | |
66 | IN USB_BUS *UsbBus,\r | |
67 | OUT UINT8 *MaxSpeed,\r | |
68 | OUT UINT8 *NumOfPort,\r | |
69 | OUT UINT8 *Is64BitCapable\r | |
70 | )\r | |
71 | {\r | |
72 | EFI_STATUS Status;\r | |
73 | \r | |
74 | if (UsbBus->Usb2Hc != NULL) {\r | |
75 | Status = UsbBus->Usb2Hc->GetCapability (\r | |
76 | UsbBus->Usb2Hc,\r | |
77 | MaxSpeed,\r | |
78 | NumOfPort,\r | |
79 | Is64BitCapable\r | |
80 | );\r | |
81 | \r | |
82 | } else {\r | |
83 | Status = UsbBus->UsbHc->GetRootHubPortNumber (UsbBus->UsbHc, NumOfPort);\r | |
84 | \r | |
85 | *MaxSpeed = EFI_USB_SPEED_FULL;\r | |
86 | *Is64BitCapable = (UINT8) FALSE;\r | |
87 | }\r | |
88 | \r | |
89 | return Status;\r | |
90 | }\r | |
91 | \r | |
92 | \r | |
93 | /**\r | |
8616fc4c | 94 | Reset the host controller.\r |
e237e7ae | 95 | \r |
8616fc4c | 96 | @param UsbBus The usb bus driver.\r |
97 | @param Attributes The reset type, only global reset is used by this driver.\r | |
e237e7ae | 98 | \r |
8616fc4c | 99 | @retval EFI_SUCCESS The reset operation succeeded.\r |
100 | @retval EFI_INVALID_PARAMETER Attributes is not valid.\r | |
101 | @retval EFI_UNSUPPOURTED The type of reset specified by Attributes is\r | |
102 | not currently supported by the host controller.\r | |
103 | @retval EFI_DEVICE_ERROR Host controller isn't halted to reset.\r | |
e237e7ae | 104 | **/\r |
105 | EFI_STATUS\r | |
106 | UsbHcReset (\r | |
107 | IN USB_BUS *UsbBus,\r | |
108 | IN UINT16 Attributes\r | |
109 | )\r | |
110 | {\r | |
111 | EFI_STATUS Status;\r | |
112 | \r | |
113 | if (UsbBus->Usb2Hc != NULL) {\r | |
114 | Status = UsbBus->Usb2Hc->Reset (UsbBus->Usb2Hc, Attributes);\r | |
115 | } else {\r | |
116 | Status = UsbBus->UsbHc->Reset (UsbBus->UsbHc, Attributes);\r | |
117 | }\r | |
118 | \r | |
119 | return Status;\r | |
120 | }\r | |
121 | \r | |
122 | \r | |
123 | /**\r | |
8616fc4c | 124 | Get the current operation state of the host controller.\r |
e237e7ae | 125 | \r |
8616fc4c | 126 | @param UsbBus The USB bus driver.\r |
127 | @param State The host controller operation state.\r | |
e237e7ae | 128 | \r |
8616fc4c | 129 | @retval EFI_SUCCESS The operation state is returned in State.\r |
130 | @retval Others Failed to get the host controller state.\r | |
e237e7ae | 131 | \r |
132 | **/\r | |
133 | EFI_STATUS\r | |
134 | UsbHcGetState (\r | |
135 | IN USB_BUS *UsbBus,\r | |
136 | OUT EFI_USB_HC_STATE *State\r | |
137 | )\r | |
138 | {\r | |
139 | EFI_STATUS Status;\r | |
140 | \r | |
141 | if (UsbBus->Usb2Hc != NULL) {\r | |
142 | Status = UsbBus->Usb2Hc->GetState (UsbBus->Usb2Hc, State);\r | |
143 | } else {\r | |
144 | Status = UsbBus->UsbHc->GetState (UsbBus->UsbHc, State);\r | |
145 | }\r | |
146 | \r | |
147 | return Status;\r | |
148 | }\r | |
149 | \r | |
150 | \r | |
151 | /**\r | |
8616fc4c | 152 | Set the host controller operation state.\r |
e237e7ae | 153 | \r |
8616fc4c | 154 | @param UsbBus The USB bus driver.\r |
155 | @param State The state to set.\r | |
e237e7ae | 156 | \r |
8616fc4c | 157 | @retval EFI_SUCCESS The host controller is now working at State.\r |
158 | @retval Others Failed to set operation state.\r | |
e237e7ae | 159 | \r |
160 | **/\r | |
161 | EFI_STATUS\r | |
162 | UsbHcSetState (\r | |
163 | IN USB_BUS *UsbBus,\r | |
164 | IN EFI_USB_HC_STATE State\r | |
165 | )\r | |
166 | {\r | |
167 | EFI_STATUS Status;\r | |
168 | \r | |
169 | if (UsbBus->Usb2Hc != NULL) {\r | |
170 | Status = UsbBus->Usb2Hc->SetState (UsbBus->Usb2Hc, State);\r | |
171 | } else {\r | |
172 | Status = UsbBus->UsbHc->SetState (UsbBus->UsbHc, State);\r | |
173 | }\r | |
174 | \r | |
175 | return Status;\r | |
176 | }\r | |
177 | \r | |
178 | \r | |
179 | /**\r | |
8616fc4c | 180 | Get the root hub port state.\r |
e237e7ae | 181 | \r |
8616fc4c | 182 | @param UsbBus The USB bus driver.\r |
183 | @param PortIndex The index of port.\r | |
184 | @param PortStatus The variable to save port state.\r | |
e237e7ae | 185 | \r |
8616fc4c | 186 | @retval EFI_SUCCESS The root port state is returned in.\r |
187 | @retval Others Failed to get the root hub port state.\r | |
e237e7ae | 188 | \r |
189 | **/\r | |
190 | EFI_STATUS\r | |
191 | UsbHcGetRootHubPortStatus (\r | |
192 | IN USB_BUS *UsbBus,\r | |
193 | IN UINT8 PortIndex,\r | |
194 | OUT EFI_USB_PORT_STATUS *PortStatus\r | |
195 | )\r | |
196 | {\r | |
197 | EFI_STATUS Status;\r | |
198 | \r | |
199 | if (UsbBus->Usb2Hc != NULL) {\r | |
200 | Status = UsbBus->Usb2Hc->GetRootHubPortStatus (UsbBus->Usb2Hc, PortIndex, PortStatus);\r | |
201 | } else {\r | |
202 | Status = UsbBus->UsbHc->GetRootHubPortStatus (UsbBus->UsbHc, PortIndex, PortStatus);\r | |
203 | }\r | |
204 | \r | |
205 | return Status;\r | |
206 | }\r | |
207 | \r | |
208 | \r | |
209 | /**\r | |
8616fc4c | 210 | Set the root hub port feature.\r |
e237e7ae | 211 | \r |
8616fc4c | 212 | @param UsbBus The USB bus driver.\r |
213 | @param PortIndex The port index.\r | |
214 | @param Feature The port feature to set.\r | |
e237e7ae | 215 | \r |
8616fc4c | 216 | @retval EFI_SUCCESS The port feature is set.\r |
217 | @retval Others Failed to set port feature.\r | |
e237e7ae | 218 | \r |
219 | **/\r | |
220 | EFI_STATUS\r | |
221 | UsbHcSetRootHubPortFeature (\r | |
222 | IN USB_BUS *UsbBus,\r | |
223 | IN UINT8 PortIndex,\r | |
224 | IN EFI_USB_PORT_FEATURE Feature\r | |
225 | )\r | |
226 | {\r | |
227 | EFI_STATUS Status;\r | |
228 | \r | |
229 | \r | |
230 | if (UsbBus->Usb2Hc != NULL) {\r | |
231 | Status = UsbBus->Usb2Hc->SetRootHubPortFeature (UsbBus->Usb2Hc, PortIndex, Feature);\r | |
232 | } else {\r | |
233 | Status = UsbBus->UsbHc->SetRootHubPortFeature (UsbBus->UsbHc, PortIndex, Feature);\r | |
234 | }\r | |
235 | \r | |
236 | return Status;\r | |
237 | }\r | |
238 | \r | |
239 | \r | |
240 | /**\r | |
8616fc4c | 241 | Clear the root hub port feature.\r |
e237e7ae | 242 | \r |
8616fc4c | 243 | @param UsbBus The USB bus driver.\r |
244 | @param PortIndex The port index.\r | |
245 | @param Feature The port feature to clear.\r | |
e237e7ae | 246 | \r |
8616fc4c | 247 | @retval EFI_SUCCESS The port feature is clear.\r |
248 | @retval Others Failed to clear port feature.\r | |
e237e7ae | 249 | \r |
250 | **/\r | |
251 | EFI_STATUS\r | |
252 | UsbHcClearRootHubPortFeature (\r | |
253 | IN USB_BUS *UsbBus,\r | |
254 | IN UINT8 PortIndex,\r | |
255 | IN EFI_USB_PORT_FEATURE Feature\r | |
256 | )\r | |
257 | {\r | |
258 | EFI_STATUS Status;\r | |
259 | \r | |
260 | if (UsbBus->Usb2Hc != NULL) {\r | |
261 | Status = UsbBus->Usb2Hc->ClearRootHubPortFeature (UsbBus->Usb2Hc, PortIndex, Feature);\r | |
262 | } else {\r | |
263 | Status = UsbBus->UsbHc->ClearRootHubPortFeature (UsbBus->UsbHc, PortIndex, Feature);\r | |
264 | }\r | |
265 | \r | |
266 | return Status;\r | |
267 | }\r | |
268 | \r | |
269 | \r | |
270 | /**\r | |
8616fc4c | 271 | Execute a control transfer to the device.\r |
272 | \r | |
273 | @param UsbBus The USB bus driver.\r | |
274 | @param DevAddr The device address.\r | |
275 | @param DevSpeed The device speed.\r | |
276 | @param MaxPacket Maximum packet size of endpoint 0.\r | |
277 | @param Request The control transfer request.\r | |
278 | @param Direction The direction of data stage.\r | |
279 | @param Data The buffer holding data.\r | |
280 | @param DataLength The length of the data.\r | |
281 | @param TimeOut Timeout (in ms) to wait until timeout.\r | |
282 | @param Translator The transaction translator for low/full speed device.\r | |
283 | @param UsbResult The result of transfer.\r | |
284 | \r | |
285 | @retval EFI_SUCCESS The control transfer finished without error.\r | |
286 | @retval Others The control transfer failed, reason returned in UsbReslt.\r | |
e237e7ae | 287 | \r |
288 | **/\r | |
289 | EFI_STATUS\r | |
290 | UsbHcControlTransfer (\r | |
291 | IN USB_BUS *UsbBus,\r | |
292 | IN UINT8 DevAddr,\r | |
293 | IN UINT8 DevSpeed,\r | |
294 | IN UINTN MaxPacket,\r | |
295 | IN EFI_USB_DEVICE_REQUEST *Request,\r | |
296 | IN EFI_USB_DATA_DIRECTION Direction,\r | |
297 | IN OUT VOID *Data,\r | |
298 | IN OUT UINTN *DataLength,\r | |
299 | IN UINTN TimeOut,\r | |
300 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
301 | OUT UINT32 *UsbResult\r | |
302 | )\r | |
303 | {\r | |
304 | EFI_STATUS Status;\r | |
305 | BOOLEAN IsSlowDevice;\r | |
306 | \r | |
307 | if (UsbBus->Usb2Hc != NULL) {\r | |
308 | Status = UsbBus->Usb2Hc->ControlTransfer (\r | |
309 | UsbBus->Usb2Hc,\r | |
310 | DevAddr,\r | |
311 | DevSpeed,\r | |
312 | MaxPacket,\r | |
313 | Request,\r | |
314 | Direction,\r | |
315 | Data,\r | |
316 | DataLength,\r | |
317 | TimeOut,\r | |
318 | Translator,\r | |
319 | UsbResult\r | |
320 | );\r | |
321 | \r | |
322 | } else {\r | |
323 | IsSlowDevice = (BOOLEAN)(EFI_USB_SPEED_LOW == DevSpeed);\r | |
324 | Status = UsbBus->UsbHc->ControlTransfer (\r | |
325 | UsbBus->UsbHc,\r | |
326 | DevAddr,\r | |
327 | IsSlowDevice,\r | |
328 | (UINT8) MaxPacket,\r | |
329 | Request,\r | |
330 | Direction,\r | |
331 | Data,\r | |
332 | DataLength,\r | |
333 | TimeOut,\r | |
334 | UsbResult\r | |
335 | );\r | |
336 | }\r | |
337 | \r | |
338 | return Status;\r | |
339 | }\r | |
340 | \r | |
341 | \r | |
342 | /**\r | |
8616fc4c | 343 | Execute a bulk transfer to the device's endpoint.\r |
e237e7ae | 344 | \r |
8616fc4c | 345 | @param UsbBus The USB bus driver.\r |
346 | @param DevAddr The target device address.\r | |
e237e7ae | 347 | @param EpAddr The target endpoint address, with direction encoded in\r |
8616fc4c | 348 | bit 7.\r |
349 | @param DevSpeed The device's speed.\r | |
350 | @param MaxPacket The endpoint's max packet size.\r | |
351 | @param BufferNum The number of data buffer.\r | |
352 | @param Data Array of pointers to data buffer.\r | |
353 | @param DataLength The length of data buffer.\r | |
e237e7ae | 354 | @param DataToggle On input, the initial data toggle to use, also return\r |
355 | the next toggle on output.\r | |
8616fc4c | 356 | @param TimeOut The time to wait until timeout.\r |
357 | @param Translator The transaction translator for low/full speed device.\r | |
358 | @param UsbResult The result of USB execution.\r | |
e237e7ae | 359 | \r |
8616fc4c | 360 | @retval EFI_SUCCESS The bulk transfer is finished without error.\r |
361 | @retval Others Failed to execute bulk transfer, result in UsbResult.\r | |
e237e7ae | 362 | \r |
363 | **/\r | |
364 | EFI_STATUS\r | |
365 | UsbHcBulkTransfer (\r | |
366 | IN USB_BUS *UsbBus,\r | |
367 | IN UINT8 DevAddr,\r | |
368 | IN UINT8 EpAddr,\r | |
369 | IN UINT8 DevSpeed,\r | |
370 | IN UINTN MaxPacket,\r | |
371 | IN UINT8 BufferNum,\r | |
372 | IN OUT VOID *Data[EFI_USB_MAX_BULK_BUFFER_NUM],\r | |
373 | IN OUT UINTN *DataLength,\r | |
374 | IN OUT UINT8 *DataToggle,\r | |
375 | IN UINTN TimeOut,\r | |
376 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
377 | OUT UINT32 *UsbResult\r | |
378 | )\r | |
379 | {\r | |
380 | EFI_STATUS Status;\r | |
381 | \r | |
382 | if (UsbBus->Usb2Hc != NULL) {\r | |
383 | Status = UsbBus->Usb2Hc->BulkTransfer (\r | |
384 | UsbBus->Usb2Hc,\r | |
385 | DevAddr,\r | |
386 | EpAddr,\r | |
387 | DevSpeed,\r | |
388 | MaxPacket,\r | |
389 | BufferNum,\r | |
390 | Data,\r | |
391 | DataLength,\r | |
392 | DataToggle,\r | |
393 | TimeOut,\r | |
394 | Translator,\r | |
395 | UsbResult\r | |
396 | );\r | |
397 | } else {\r | |
398 | Status = UsbBus->UsbHc->BulkTransfer (\r | |
399 | UsbBus->UsbHc,\r | |
400 | DevAddr,\r | |
401 | EpAddr,\r | |
402 | (UINT8) MaxPacket,\r | |
403 | *Data,\r | |
404 | DataLength,\r | |
405 | DataToggle,\r | |
406 | TimeOut,\r | |
407 | UsbResult\r | |
408 | );\r | |
409 | }\r | |
410 | \r | |
411 | return Status;\r | |
412 | }\r | |
413 | \r | |
414 | \r | |
415 | /**\r | |
8616fc4c | 416 | Queue or cancel an asynchronous interrupt transfer.\r |
e237e7ae | 417 | \r |
8616fc4c | 418 | @param UsbBus The USB bus driver.\r |
419 | @param DevAddr The target device address.\r | |
e237e7ae | 420 | @param EpAddr The target endpoint address, with direction encoded in\r |
8616fc4c | 421 | bit 7.\r |
422 | @param DevSpeed The device's speed.\r | |
423 | @param MaxPacket The endpoint's max packet size.\r | |
e237e7ae | 424 | @param IsNewTransfer Whether this is a new request. If not, cancel the old\r |
8616fc4c | 425 | request.\r |
426 | @param DataToggle Data toggle to use on input, next toggle on output.\r | |
427 | @param PollingInterval The interval to poll the interrupt transfer (in ms).\r | |
428 | @param DataLength The length of periodical data receive.\r | |
429 | @param Translator The transaction translator for low/full speed device.\r | |
430 | @param Callback Function to call when data is received.\r | |
431 | @param Context The context to the callback.\r | |
e237e7ae | 432 | \r |
8616fc4c | 433 | @retval EFI_SUCCESS The asynchronous transfer is queued.\r |
434 | @retval Others Failed to queue the transfer.\r | |
e237e7ae | 435 | \r |
436 | **/\r | |
437 | EFI_STATUS\r | |
438 | UsbHcAsyncInterruptTransfer (\r | |
439 | IN USB_BUS *UsbBus,\r | |
440 | IN UINT8 DevAddr,\r | |
441 | IN UINT8 EpAddr,\r | |
442 | IN UINT8 DevSpeed,\r | |
443 | IN UINTN MaxPacket,\r | |
444 | IN BOOLEAN IsNewTransfer,\r | |
445 | IN OUT UINT8 *DataToggle,\r | |
446 | IN UINTN PollingInterval,\r | |
447 | IN UINTN DataLength,\r | |
448 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
449 | IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback,\r | |
450 | IN VOID *Context OPTIONAL\r | |
451 | )\r | |
452 | {\r | |
453 | EFI_STATUS Status;\r | |
454 | BOOLEAN IsSlowDevice;\r | |
455 | \r | |
456 | if (UsbBus->Usb2Hc != NULL) {\r | |
457 | Status = UsbBus->Usb2Hc->AsyncInterruptTransfer (\r | |
458 | UsbBus->Usb2Hc,\r | |
459 | DevAddr,\r | |
460 | EpAddr,\r | |
461 | DevSpeed,\r | |
462 | MaxPacket,\r | |
463 | IsNewTransfer,\r | |
464 | DataToggle,\r | |
465 | PollingInterval,\r | |
466 | DataLength,\r | |
467 | Translator,\r | |
468 | Callback,\r | |
469 | Context\r | |
470 | );\r | |
471 | } else {\r | |
472 | IsSlowDevice = (BOOLEAN)(EFI_USB_SPEED_LOW == DevSpeed);\r | |
473 | \r | |
474 | Status = UsbBus->UsbHc->AsyncInterruptTransfer (\r | |
475 | UsbBus->UsbHc,\r | |
476 | DevAddr,\r | |
477 | EpAddr,\r | |
478 | IsSlowDevice,\r | |
479 | (UINT8) MaxPacket,\r | |
480 | IsNewTransfer,\r | |
481 | DataToggle,\r | |
482 | PollingInterval,\r | |
483 | DataLength,\r | |
484 | Callback,\r | |
485 | Context\r | |
486 | );\r | |
487 | }\r | |
488 | \r | |
489 | return Status;\r | |
490 | }\r | |
491 | \r | |
492 | \r | |
493 | /**\r | |
8616fc4c | 494 | Execute a synchronous interrupt transfer to the target endpoint.\r |
e237e7ae | 495 | \r |
8616fc4c | 496 | @param UsbBus The USB bus driver.\r |
497 | @param DevAddr The target device address.\r | |
e237e7ae | 498 | @param EpAddr The target endpoint address, with direction encoded in\r |
8616fc4c | 499 | bit 7.\r |
500 | @param DevSpeed The device's speed.\r | |
501 | @param MaxPacket The endpoint's max packet size.\r | |
502 | @param Data Pointer to data buffer.\r | |
503 | @param DataLength The length of data buffer.\r | |
e237e7ae | 504 | @param DataToggle On input, the initial data toggle to use, also return\r |
505 | the next toggle on output.\r | |
8616fc4c | 506 | @param TimeOut The time to wait until timeout.\r |
507 | @param Translator The transaction translator for low/full speed device.\r | |
508 | @param UsbResult The result of USB execution.\r | |
e237e7ae | 509 | \r |
8616fc4c | 510 | @retval EFI_SUCCESS The synchronous interrupt transfer is OK.\r |
511 | @retval Others Failed to execute the synchronous interrupt transfer.\r | |
e237e7ae | 512 | \r |
513 | **/\r | |
514 | EFI_STATUS\r | |
515 | UsbHcSyncInterruptTransfer (\r | |
516 | IN USB_BUS *UsbBus,\r | |
517 | IN UINT8 DevAddr,\r | |
518 | IN UINT8 EpAddr,\r | |
519 | IN UINT8 DevSpeed,\r | |
520 | IN UINTN MaxPacket,\r | |
521 | IN OUT VOID *Data,\r | |
522 | IN OUT UINTN *DataLength,\r | |
523 | IN OUT UINT8 *DataToggle,\r | |
524 | IN UINTN TimeOut,\r | |
525 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
526 | OUT UINT32 *UsbResult\r | |
527 | )\r | |
528 | {\r | |
529 | EFI_STATUS Status;\r | |
530 | BOOLEAN IsSlowDevice;\r | |
531 | \r | |
532 | if (UsbBus->Usb2Hc != NULL) {\r | |
533 | Status = UsbBus->Usb2Hc->SyncInterruptTransfer (\r | |
534 | UsbBus->Usb2Hc,\r | |
535 | DevAddr,\r | |
536 | EpAddr,\r | |
537 | DevSpeed,\r | |
538 | MaxPacket,\r | |
539 | Data,\r | |
540 | DataLength,\r | |
541 | DataToggle,\r | |
542 | TimeOut,\r | |
543 | Translator,\r | |
544 | UsbResult\r | |
545 | );\r | |
546 | } else {\r | |
c52fa98c | 547 | IsSlowDevice = (BOOLEAN) ((EFI_USB_SPEED_LOW == DevSpeed) ? TRUE : FALSE);\r |
e237e7ae | 548 | Status = UsbBus->UsbHc->SyncInterruptTransfer (\r |
549 | UsbBus->UsbHc,\r | |
550 | DevAddr,\r | |
551 | EpAddr,\r | |
552 | IsSlowDevice,\r | |
553 | (UINT8) MaxPacket,\r | |
554 | Data,\r | |
555 | DataLength,\r | |
556 | DataToggle,\r | |
557 | TimeOut,\r | |
558 | UsbResult\r | |
559 | );\r | |
560 | }\r | |
561 | \r | |
562 | return Status;\r | |
563 | }\r | |
564 | \r | |
565 | \r | |
566 | /**\r | |
8616fc4c | 567 | Execute a synchronous Isochronous USB transfer.\r |
e237e7ae | 568 | \r |
8616fc4c | 569 | @param UsbBus The USB bus driver.\r |
570 | @param DevAddr The target device address.\r | |
e237e7ae | 571 | @param EpAddr The target endpoint address, with direction encoded in\r |
8616fc4c | 572 | bit 7.\r |
573 | @param DevSpeed The device's speed.\r | |
574 | @param MaxPacket The endpoint's max packet size.\r | |
575 | @param BufferNum The number of data buffer.\r | |
576 | @param Data Array of pointers to data buffer.\r | |
577 | @param DataLength The length of data buffer.\r | |
578 | @param Translator The transaction translator for low/full speed device.\r | |
579 | @param UsbResult The result of USB execution.\r | |
e237e7ae | 580 | \r |
8616fc4c | 581 | @retval EFI_UNSUPPORTED The isochronous transfer isn't supported now.\r |
e237e7ae | 582 | \r |
583 | **/\r | |
584 | EFI_STATUS\r | |
585 | UsbHcIsochronousTransfer (\r | |
586 | IN USB_BUS *UsbBus,\r | |
587 | IN UINT8 DevAddr,\r | |
588 | IN UINT8 EpAddr,\r | |
589 | IN UINT8 DevSpeed,\r | |
590 | IN UINTN MaxPacket,\r | |
591 | IN UINT8 BufferNum,\r | |
592 | IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM],\r | |
593 | IN UINTN DataLength,\r | |
594 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
595 | OUT UINT32 *UsbResult\r | |
596 | )\r | |
597 | {\r | |
598 | return EFI_UNSUPPORTED;\r | |
599 | }\r | |
600 | \r | |
601 | \r | |
602 | /**\r | |
8616fc4c | 603 | Queue an asynchronous isochronous transfer.\r |
e237e7ae | 604 | \r |
8616fc4c | 605 | @param UsbBus The USB bus driver.\r |
606 | @param DevAddr The target device address.\r | |
e237e7ae | 607 | @param EpAddr The target endpoint address, with direction encoded in\r |
8616fc4c | 608 | bit 7.\r |
609 | @param DevSpeed The device's speed.\r | |
610 | @param MaxPacket The endpoint's max packet size.\r | |
611 | @param BufferNum The number of data buffer.\r | |
612 | @param Data Array of pointers to data buffer.\r | |
613 | @param DataLength The length of data buffer.\r | |
614 | @param Translator The transaction translator for low/full speed device.\r | |
615 | @param Callback The function to call when data is transferred.\r | |
616 | @param Context The context to the callback function.\r | |
617 | \r | |
618 | @retval EFI_UNSUPPORTED The asynchronous isochronous transfer isn't supported.\r | |
e237e7ae | 619 | \r |
620 | **/\r | |
621 | EFI_STATUS\r | |
622 | UsbHcAsyncIsochronousTransfer (\r | |
623 | IN USB_BUS *UsbBus,\r | |
624 | IN UINT8 DevAddr,\r | |
625 | IN UINT8 EpAddr,\r | |
626 | IN UINT8 DevSpeed,\r | |
627 | IN UINTN MaxPacket,\r | |
628 | IN UINT8 BufferNum,\r | |
629 | IN OUT VOID *Data[EFI_USB_MAX_ISO_BUFFER_NUM],\r | |
630 | IN UINTN DataLength,\r | |
631 | IN EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,\r | |
632 | IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback,\r | |
633 | IN VOID *Context\r | |
634 | )\r | |
635 | {\r | |
636 | return EFI_UNSUPPORTED;\r | |
637 | }\r | |
638 | \r | |
639 | \r | |
640 | /**\r | |
8616fc4c | 641 | Open the USB host controller protocol BY_CHILD.\r |
e237e7ae | 642 | \r |
8616fc4c | 643 | @param Bus The USB bus driver.\r |
644 | @param Child The child handle.\r | |
e237e7ae | 645 | \r |
8616fc4c | 646 | @return The open protocol return.\r |
e237e7ae | 647 | \r |
648 | **/\r | |
649 | EFI_STATUS\r | |
650 | UsbOpenHostProtoByChild (\r | |
651 | IN USB_BUS *Bus,\r | |
652 | IN EFI_HANDLE Child\r | |
653 | )\r | |
654 | {\r | |
655 | EFI_USB_HC_PROTOCOL *UsbHc;\r | |
656 | EFI_USB2_HC_PROTOCOL *Usb2Hc;\r | |
657 | EFI_STATUS Status;\r | |
658 | \r | |
659 | if (Bus->Usb2Hc != NULL) {\r | |
660 | Status = gBS->OpenProtocol (\r | |
661 | Bus->HostHandle,\r | |
662 | &gEfiUsb2HcProtocolGuid,\r | |
c52fa98c | 663 | (VOID **) &Usb2Hc,\r |
e237e7ae | 664 | mUsbBusDriverBinding.DriverBindingHandle,\r |
665 | Child,\r | |
666 | EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r | |
667 | );\r | |
668 | \r | |
669 | } else {\r | |
670 | Status = gBS->OpenProtocol (\r | |
671 | Bus->HostHandle,\r | |
672 | &gEfiUsbHcProtocolGuid,\r | |
c52fa98c | 673 | (VOID **) &UsbHc,\r |
e237e7ae | 674 | mUsbBusDriverBinding.DriverBindingHandle,\r |
675 | Child,\r | |
676 | EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r | |
677 | );\r | |
678 | }\r | |
679 | \r | |
680 | return Status;\r | |
681 | }\r | |
682 | \r | |
683 | \r | |
684 | /**\r | |
8616fc4c | 685 | Close the USB host controller protocol BY_CHILD.\r |
e237e7ae | 686 | \r |
8616fc4c | 687 | @param Bus The USB bus driver.\r |
688 | @param Child The child handle.\r | |
e237e7ae | 689 | \r |
8616fc4c | 690 | @return None.\r |
e237e7ae | 691 | \r |
692 | **/\r | |
693 | VOID\r | |
694 | UsbCloseHostProtoByChild (\r | |
695 | IN USB_BUS *Bus,\r | |
696 | IN EFI_HANDLE Child\r | |
697 | )\r | |
698 | {\r | |
699 | if (Bus->Usb2Hc != NULL) {\r | |
700 | gBS->CloseProtocol (\r | |
701 | Bus->HostHandle,\r | |
702 | &gEfiUsb2HcProtocolGuid,\r | |
703 | mUsbBusDriverBinding.DriverBindingHandle,\r | |
704 | Child\r | |
705 | );\r | |
706 | \r | |
707 | } else {\r | |
708 | gBS->CloseProtocol (\r | |
709 | Bus->HostHandle,\r | |
710 | &gEfiUsbHcProtocolGuid,\r | |
711 | mUsbBusDriverBinding.DriverBindingHandle,\r | |
712 | Child\r | |
713 | );\r | |
714 | }\r | |
715 | }\r | |
716 | \r | |
717 | \r | |
e237e7ae | 718 | /**\r |
719 | return the current TPL, copied from the EDKII glue lib.\r | |
720 | \r | |
8616fc4c | 721 | @param VOID.\r |
e237e7ae | 722 | \r |
8616fc4c | 723 | @return Current TPL.\r |
e237e7ae | 724 | \r |
725 | **/\r | |
726 | EFI_TPL\r | |
727 | UsbGetCurrentTpl (\r | |
728 | VOID\r | |
729 | )\r | |
730 | {\r | |
731 | EFI_TPL Tpl;\r | |
732 | \r | |
733 | Tpl = gBS->RaiseTPL (TPL_HIGH_LEVEL);\r | |
734 | gBS->RestoreTPL (Tpl);\r | |
735 | \r | |
736 | return Tpl;\r | |
737 | }\r | |
738 | \r | |
ecb575d9 | 739 | /**\r |
8616fc4c | 740 | Create a new device path which only contain the first Usb part of the DevicePath.\r |
ecb575d9 | 741 | \r |
8616fc4c | 742 | @param DevicePath A full device path which contain the usb nodes.\r |
ecb575d9 | 743 | \r |
8616fc4c | 744 | @return A new device path which only contain the Usb part of the DevicePath.\r |
ecb575d9 | 745 | \r |
746 | **/\r | |
747 | EFI_DEVICE_PATH_PROTOCOL *\r | |
748 | EFIAPI\r | |
749 | GetUsbDPFromFullDP (\r | |
750 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r | |
751 | )\r | |
752 | {\r | |
753 | EFI_DEVICE_PATH_PROTOCOL *UsbDevicePathPtr;\r | |
754 | EFI_DEVICE_PATH_PROTOCOL *UsbDevicePathBeginPtr;\r | |
755 | EFI_DEVICE_PATH_PROTOCOL *UsbDevicePathEndPtr;\r | |
756 | UINTN Size;\r | |
757 | \r | |
758 | //\r | |
759 | // Get the Usb part first Begin node in full device path\r | |
760 | //\r | |
761 | UsbDevicePathBeginPtr = DevicePath;\r | |
762 | while ( (!EfiIsDevicePathEnd (UsbDevicePathBeginPtr))&&\r | |
763 | ((UsbDevicePathBeginPtr->Type != MESSAGING_DEVICE_PATH) ||\r | |
764 | (UsbDevicePathBeginPtr->SubType != MSG_USB_DP &&\r | |
765 | UsbDevicePathBeginPtr->SubType != MSG_USB_CLASS_DP\r | |
766 | && UsbDevicePathBeginPtr->SubType != MSG_USB_WWID_DP\r | |
767 | ))) {\r | |
768 | \r | |
769 | UsbDevicePathBeginPtr = NextDevicePathNode(UsbDevicePathBeginPtr);\r | |
770 | }\r | |
771 | \r | |
772 | //\r | |
773 | // Get the Usb part first End node in full device path\r | |
774 | //\r | |
775 | UsbDevicePathEndPtr = UsbDevicePathBeginPtr;\r | |
776 | while ((!EfiIsDevicePathEnd (UsbDevicePathEndPtr))&&\r | |
777 | (UsbDevicePathEndPtr->Type == MESSAGING_DEVICE_PATH) &&\r | |
778 | (UsbDevicePathEndPtr->SubType == MSG_USB_DP ||\r | |
779 | UsbDevicePathEndPtr->SubType == MSG_USB_CLASS_DP\r | |
780 | || UsbDevicePathEndPtr->SubType == MSG_USB_WWID_DP\r | |
781 | )) {\r | |
782 | \r | |
783 | UsbDevicePathEndPtr = NextDevicePathNode(UsbDevicePathEndPtr);\r | |
784 | }\r | |
785 | \r | |
786 | Size = GetDevicePathSize (UsbDevicePathBeginPtr);\r | |
787 | Size -= GetDevicePathSize (UsbDevicePathEndPtr);\r | |
788 | if (Size ==0){\r | |
789 | //\r | |
790 | // The passed in DevicePath does not contain the usb nodes\r | |
791 | //\r | |
792 | return NULL;\r | |
793 | }\r | |
794 | \r | |
795 | //\r | |
796 | // Create a new device path which only contain the above Usb part\r | |
797 | //\r | |
798 | UsbDevicePathPtr = AllocateZeroPool (Size + sizeof (EFI_DEVICE_PATH_PROTOCOL));\r | |
799 | ASSERT (UsbDevicePathPtr != NULL);\r | |
800 | CopyMem (UsbDevicePathPtr, UsbDevicePathBeginPtr, Size);\r | |
801 | //\r | |
802 | // Append end device path node\r | |
803 | //\r | |
804 | UsbDevicePathEndPtr = (EFI_DEVICE_PATH_PROTOCOL *) ((UINTN) UsbDevicePathPtr + Size);\r | |
805 | SetDevicePathEndNode (UsbDevicePathEndPtr);\r | |
806 | return UsbDevicePathPtr;\r | |
807 | }\r | |
808 | \r | |
809 | /**\r | |
810 | Check whether a usb device path is in a DEVICE_PATH_LIST_ITEM list.\r | |
811 | \r | |
8616fc4c | 812 | @param UsbDP a usb device path of DEVICE_PATH_LIST_ITEM.\r |
813 | @param UsbIoDPList a DEVICE_PATH_LIST_ITEM list.\r | |
ecb575d9 | 814 | \r |
8616fc4c | 815 | @retval TRUE there is a DEVICE_PATH_LIST_ITEM in UsbIoDPList which contains the passed in UsbDP.\r |
816 | @retval FALSE there is no DEVICE_PATH_LIST_ITEM in UsbIoDPList which contains the passed in UsbDP.\r | |
ecb575d9 | 817 | \r |
818 | **/\r | |
819 | BOOLEAN\r | |
820 | EFIAPI\r | |
821 | SearchUsbDPInList (\r | |
822 | IN EFI_DEVICE_PATH_PROTOCOL *UsbDP,\r | |
823 | IN LIST_ENTRY *UsbIoDPList\r | |
824 | )\r | |
825 | {\r | |
826 | LIST_ENTRY *ListIndex;\r | |
827 | DEVICE_PATH_LIST_ITEM *ListItem;\r | |
828 | BOOLEAN Found;\r | |
829 | UINTN UsbDpDevicePathSize;\r | |
830 | \r | |
831 | //\r | |
832 | // Check that UsbDP and UsbIoDPList are valid\r | |
833 | //\r | |
834 | if ((UsbIoDPList == NULL) || (UsbDP == NULL)) {\r | |
835 | return FALSE;\r | |
836 | }\r | |
837 | \r | |
838 | Found = FALSE;\r | |
839 | ListIndex = UsbIoDPList->ForwardLink;\r | |
840 | while (ListIndex != UsbIoDPList){\r | |
841 | ListItem = CR(ListIndex, DEVICE_PATH_LIST_ITEM, Link, DEVICE_PATH_LIST_ITEM_SIGNATURE);\r | |
842 | //\r | |
843 | // Compare DEVICE_PATH_LIST_ITEM.DevicePath[]\r | |
844 | //\r | |
845 | ASSERT (ListItem->DevicePath != NULL);\r | |
846 | \r | |
847 | UsbDpDevicePathSize = GetDevicePathSize (UsbDP);\r | |
848 | if (UsbDpDevicePathSize == GetDevicePathSize (ListItem->DevicePath)) {\r | |
849 | if ((CompareMem (UsbDP, ListItem->DevicePath, UsbDpDevicePathSize)) == 0) {\r | |
850 | Found = TRUE;\r | |
851 | break;\r | |
852 | }\r | |
853 | }\r | |
854 | ListIndex = ListIndex->ForwardLink;\r | |
855 | }\r | |
856 | \r | |
857 | return Found;\r | |
858 | }\r | |
859 | \r | |
860 | /**\r | |
861 | Add a usb device path into the DEVICE_PATH_LIST_ITEM list.\r | |
862 | \r | |
8616fc4c | 863 | @param UsbDP a usb device path of DEVICE_PATH_LIST_ITEM.\r |
864 | @param UsbIoDPList a DEVICE_PATH_LIST_ITEM list.\r | |
ecb575d9 | 865 | \r |
8616fc4c | 866 | @retval EFI_INVALID_PARAMETER If parameters are invalid, return this value.\r |
867 | @retval EFI_SUCCESS If Add operation is successful, return this value.\r | |
ecb575d9 | 868 | \r |
869 | **/\r | |
870 | EFI_STATUS\r | |
871 | EFIAPI\r | |
872 | AddUsbDPToList (\r | |
873 | IN EFI_DEVICE_PATH_PROTOCOL *UsbDP,\r | |
874 | IN LIST_ENTRY *UsbIoDPList\r | |
875 | )\r | |
876 | {\r | |
877 | DEVICE_PATH_LIST_ITEM *ListItem;\r | |
878 | \r | |
879 | //\r | |
880 | // Check that UsbDP and UsbIoDPList are valid\r | |
881 | //\r | |
882 | if ((UsbIoDPList == NULL) || (UsbDP == NULL)) {\r | |
883 | return EFI_INVALID_PARAMETER;\r | |
884 | }\r | |
885 | \r | |
886 | if (SearchUsbDPInList (UsbDP, UsbIoDPList)){\r | |
887 | return EFI_SUCCESS;\r | |
888 | }\r | |
889 | \r | |
890 | //\r | |
891 | // Prepare the usbio device path DEVICE_PATH_LIST_ITEM structure.\r | |
892 | //\r | |
893 | ListItem = AllocateZeroPool (sizeof (DEVICE_PATH_LIST_ITEM));\r | |
894 | ASSERT (ListItem != NULL);\r | |
895 | ListItem->Signature = DEVICE_PATH_LIST_ITEM_SIGNATURE;\r | |
896 | ListItem->DevicePath = DuplicateDevicePath (UsbDP);\r | |
897 | \r | |
898 | InsertTailList (UsbIoDPList, &ListItem->Link);\r | |
899 | \r | |
900 | return EFI_SUCCESS;\r | |
901 | }\r | |
902 | \r | |
903 | /**\r | |
904 | Check whether usb device, whose interface is UsbIf, matches the usb class which indicated by\r | |
8616fc4c | 905 | UsbClassDevicePathPtr whose is a short form usb class device path.\r |
ecb575d9 | 906 | \r |
8616fc4c | 907 | @param UsbClassDevicePathPtr a short form usb class device path.\r |
908 | @param UsbIf a usb device interface.\r | |
ecb575d9 | 909 | \r |
8616fc4c | 910 | @retval TRUE the usb device match the usb class.\r |
911 | @retval FALSE the usb device does not match the usb class.\r | |
ecb575d9 | 912 | \r |
913 | **/\r | |
914 | BOOLEAN\r | |
915 | EFIAPI\r | |
916 | MatchUsbClass (\r | |
917 | IN USB_CLASS_DEVICE_PATH *UsbClassDevicePathPtr,\r | |
918 | IN USB_INTERFACE *UsbIf\r | |
919 | )\r | |
920 | {\r | |
921 | USB_INTERFACE_DESC *IfDesc;\r | |
922 | EFI_USB_INTERFACE_DESCRIPTOR *ActIfDesc;\r | |
923 | EFI_USB_DEVICE_DESCRIPTOR *DevDesc;\r | |
924 | \r | |
925 | \r | |
926 | if ((UsbClassDevicePathPtr->Header.Type != MESSAGING_DEVICE_PATH) ||\r | |
927 | (UsbClassDevicePathPtr->Header.SubType != MSG_USB_CLASS_DP)){\r | |
928 | ASSERT (0);\r | |
929 | return FALSE;\r | |
930 | }\r | |
931 | \r | |
932 | IfDesc = UsbIf->IfDesc;\r | |
933 | ActIfDesc = &(IfDesc->Settings[IfDesc->ActiveIndex]->Desc);\r | |
934 | DevDesc = &(UsbIf->Device->DevDesc->Desc);\r | |
935 | \r | |
936 | //\r | |
937 | // If connect class policy, determine whether to create device handle by the five fields\r | |
938 | // in class device path node.\r | |
939 | //\r | |
940 | // In addtion, hub interface is always matched for this policy.\r | |
941 | //\r | |
942 | if ((ActIfDesc->InterfaceClass == USB_HUB_CLASS_CODE) &&\r | |
943 | (ActIfDesc->InterfaceSubClass == USB_HUB_SUBCLASS_CODE)) {\r | |
944 | return TRUE;\r | |
945 | }\r | |
946 | \r | |
947 | //\r | |
948 | // If vendor id or product id is 0xffff, they will be ignored.\r | |
949 | //\r | |
950 | if ((UsbClassDevicePathPtr->VendorId == 0xffff || UsbClassDevicePathPtr->VendorId == DevDesc->IdVendor) &&\r | |
951 | (UsbClassDevicePathPtr->ProductId == 0xffff || UsbClassDevicePathPtr->ProductId == DevDesc->IdProduct)) {\r | |
952 | \r | |
953 | //\r | |
954 | // If class or subclass or protocol is 0, the counterparts in interface should be checked.\r | |
955 | //\r | |
9935f927 | 956 | if (DevDesc->DeviceClass == 0 ||\r |
957 | DevDesc->DeviceSubClass == 0 ||\r | |
ecb575d9 | 958 | DevDesc->DeviceProtocol == 0) {\r |
959 | \r | |
960 | if ((UsbClassDevicePathPtr->DeviceClass == ActIfDesc->InterfaceClass ||\r | |
961 | UsbClassDevicePathPtr->DeviceClass == 0xff) &&\r | |
962 | (UsbClassDevicePathPtr->DeviceSubClass == ActIfDesc->InterfaceSubClass ||\r | |
963 | UsbClassDevicePathPtr->DeviceSubClass == 0xff) &&\r | |
9e58aa1d | 964 | (UsbClassDevicePathPtr->DeviceProtocol == ActIfDesc->InterfaceProtocol ||\r |
965 | UsbClassDevicePathPtr->DeviceProtocol == 0xff)) {\r | |
ecb575d9 | 966 | return TRUE;\r |
967 | }\r | |
968 | \r | |
9935f927 | 969 | } else if ((UsbClassDevicePathPtr->DeviceClass == DevDesc->DeviceClass ||\r |
ecb575d9 | 970 | UsbClassDevicePathPtr->DeviceClass == 0xff) &&\r |
971 | (UsbClassDevicePathPtr->DeviceSubClass == DevDesc->DeviceSubClass ||\r | |
972 | UsbClassDevicePathPtr->DeviceSubClass == 0xff) &&\r | |
9e58aa1d | 973 | (UsbClassDevicePathPtr->DeviceProtocol == DevDesc->DeviceProtocol ||\r |
974 | UsbClassDevicePathPtr->DeviceProtocol == 0xff)) {\r | |
ecb575d9 | 975 | \r |
976 | return TRUE;\r | |
977 | }\r | |
978 | }\r | |
979 | \r | |
980 | return FALSE;\r | |
981 | }\r | |
982 | \r | |
983 | /**\r | |
984 | Check whether usb device, whose interface is UsbIf, matches the usb WWID requirement which indicated by\r | |
8616fc4c | 985 | UsbWWIDDevicePathPtr whose is a short form usb WWID device path.\r |
ecb575d9 | 986 | \r |
8616fc4c | 987 | @param UsbWWIDDevicePathPtr a short form usb WWID device path.\r |
988 | @param UsbIf a usb device interface.\r | |
ecb575d9 | 989 | \r |
8616fc4c | 990 | @retval TRUE the usb device match the usb WWID requirement.\r |
991 | @retval FALSE the usb device does not match the usb WWID requirement.\r | |
ecb575d9 | 992 | \r |
993 | **/\r | |
ecb575d9 | 994 | BOOLEAN\r |
995 | MatchUsbWwid (\r | |
996 | IN USB_WWID_DEVICE_PATH *UsbWWIDDevicePathPtr,\r | |
997 | IN USB_INTERFACE *UsbIf\r | |
998 | )\r | |
999 | {\r | |
1000 | USB_INTERFACE_DESC *IfDesc;\r | |
1001 | EFI_USB_INTERFACE_DESCRIPTOR *ActIfDesc;\r | |
1002 | EFI_USB_DEVICE_DESCRIPTOR *DevDesc;\r | |
1003 | EFI_USB_STRING_DESCRIPTOR *StrDesc;\r | |
1004 | UINT16 *SnString;\r | |
1005 | \r | |
1006 | if ((UsbWWIDDevicePathPtr->Header.Type != MESSAGING_DEVICE_PATH) ||\r | |
1007 | (UsbWWIDDevicePathPtr->Header.SubType != MSG_USB_WWID_DP )){\r | |
1008 | ASSERT (0);\r | |
1009 | return FALSE;\r | |
1010 | }\r | |
1011 | \r | |
1012 | IfDesc = UsbIf->IfDesc;\r | |
1013 | ActIfDesc = &(IfDesc->Settings[IfDesc->ActiveIndex]->Desc);\r | |
1014 | DevDesc = &(UsbIf->Device->DevDesc->Desc);\r | |
1015 | StrDesc = UsbGetOneString (UsbIf->Device, DevDesc->StrSerialNumber, USB_US_LAND_ID);\r | |
1016 | SnString = (UINT16 *) ((UINT8 *)UsbWWIDDevicePathPtr + 10);\r | |
1017 | \r | |
1018 | //\r | |
1019 | //In addtion, hub interface is always matched for this policy.\r | |
1020 | //\r | |
1021 | if ((ActIfDesc->InterfaceClass == USB_HUB_CLASS_CODE) &&\r | |
1022 | (ActIfDesc->InterfaceSubClass == USB_HUB_SUBCLASS_CODE)) {\r | |
1023 | return TRUE;\r | |
1024 | }\r | |
1025 | //\r | |
1026 | // If connect wwid policy, determine the objective device by the serial number of\r | |
1027 | // device descriptor.\r | |
1028 | // Get serial number index from device descriptor, then get serial number by index\r | |
1029 | // and land id, compare the serial number with wwid device path node at last\r | |
1030 | //\r | |
1031 | // BugBug: only check serial number here, should check Interface Number, Device Vendor Id, Device Product Id in later version\r | |
1032 | //\r | |
1033 | if (StrDesc != NULL && !StrnCmp (StrDesc->String, SnString, StrDesc->Length)) {\r | |
1034 | \r | |
1035 | return TRUE;\r | |
1036 | }\r | |
1037 | \r | |
1038 | return FALSE;\r | |
1039 | }\r | |
1040 | \r | |
1041 | /**\r | |
8616fc4c | 1042 | Free a DEVICE_PATH_LIST_ITEM list.\r |
ecb575d9 | 1043 | \r |
8616fc4c | 1044 | @param UsbIoDPList a DEVICE_PATH_LIST_ITEM list pointer.\r |
ecb575d9 | 1045 | \r |
8616fc4c | 1046 | @retval EFI_INVALID_PARAMETER If parameters are invalid, return this value.\r |
1047 | @retval EFI_SUCCESS If free operation is successful, return this value.\r | |
ecb575d9 | 1048 | \r |
1049 | **/\r | |
1050 | EFI_STATUS\r | |
1051 | EFIAPI\r | |
1052 | UsbBusFreeUsbDPList (\r | |
1053 | IN LIST_ENTRY *UsbIoDPList\r | |
1054 | )\r | |
1055 | {\r | |
1056 | LIST_ENTRY *ListIndex;\r | |
1057 | DEVICE_PATH_LIST_ITEM *ListItem;\r | |
1058 | \r | |
1059 | //\r | |
1060 | // Check that ControllerHandle is a valid handle\r | |
1061 | //\r | |
1062 | if (UsbIoDPList == NULL) {\r | |
1063 | return EFI_INVALID_PARAMETER;\r | |
1064 | }\r | |
1065 | \r | |
1066 | ListIndex = UsbIoDPList->ForwardLink;\r | |
1067 | while (ListIndex != UsbIoDPList){\r | |
1068 | ListItem = CR(ListIndex, DEVICE_PATH_LIST_ITEM, Link, DEVICE_PATH_LIST_ITEM_SIGNATURE);\r | |
1069 | //\r | |
1070 | // Free DEVICE_PATH_LIST_ITEM.DevicePath[]\r | |
1071 | //\r | |
1072 | if (ListItem->DevicePath != NULL){\r | |
1073 | FreePool(ListItem->DevicePath);\r | |
1074 | }\r | |
1075 | //\r | |
1076 | // Free DEVICE_PATH_LIST_ITEM itself\r | |
1077 | //\r | |
1078 | ListIndex = ListIndex->ForwardLink;\r | |
1079 | RemoveEntryList (&ListItem->Link);\r | |
1080 | FreePool (ListItem);\r | |
1081 | }\r | |
1082 | \r | |
1083 | InitializeListHead (UsbIoDPList);\r | |
1084 | return EFI_SUCCESS;\r | |
1085 | }\r | |
1086 | \r | |
1087 | /**\r | |
1088 | Store a wanted usb child device info (its Usb part of device path) which is indicated by\r | |
8616fc4c | 1089 | RemainingDevicePath in a Usb bus which is indicated by UsbBusId.\r |
ecb575d9 | 1090 | \r |
8616fc4c | 1091 | @param UsbBusId Point to EFI_USB_BUS_PROTOCOL interface.\r |
1092 | @param RemainingDevicePath The remaining device patch.\r | |
ecb575d9 | 1093 | \r |
8616fc4c | 1094 | @retval EFI_SUCCESS Add operation is successful.\r |
1095 | @retval EFI_INVALID_PARAMETER The parameters are invalid.\r | |
ecb575d9 | 1096 | \r |
1097 | **/\r | |
1098 | EFI_STATUS\r | |
1099 | EFIAPI\r | |
1100 | UsbBusAddWantedUsbIoDP (\r | |
1101 | IN EFI_USB_BUS_PROTOCOL *UsbBusId,\r | |
1102 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
1103 | )\r | |
1104 | {\r | |
1105 | USB_BUS *Bus;\r | |
1106 | EFI_STATUS Status;\r | |
1107 | EFI_DEVICE_PATH_PROTOCOL *DevicePathPtr;\r | |
1108 | \r | |
1109 | //\r | |
1110 | // Check whether remaining device path is valid\r | |
1111 | //\r | |
1112 | if (RemainingDevicePath != NULL) {\r | |
1113 | if ((RemainingDevicePath->Type != MESSAGING_DEVICE_PATH) ||\r | |
1114 | (RemainingDevicePath->SubType != MSG_USB_DP &&\r | |
1115 | RemainingDevicePath->SubType != MSG_USB_CLASS_DP\r | |
1116 | && RemainingDevicePath->SubType != MSG_USB_WWID_DP\r | |
1117 | )) {\r | |
1118 | return EFI_INVALID_PARAMETER;\r | |
1119 | }\r | |
1120 | }\r | |
1121 | \r | |
1122 | if (UsbBusId == NULL){\r | |
1123 | return EFI_INVALID_PARAMETER;\r | |
1124 | }\r | |
1125 | \r | |
1126 | Bus = USB_BUS_FROM_THIS (UsbBusId);\r | |
1127 | \r | |
1128 | if (RemainingDevicePath == NULL) {\r | |
1129 | //\r | |
1130 | // RemainingDevicePath== NULL means all Usb devices in this bus are wanted.\r | |
1131 | // Here use a Usb class Device Path in WantedUsbIoDPList to indicate all Usb devices\r | |
1132 | // are wanted Usb devices\r | |
1133 | //\r | |
1134 | Status = UsbBusFreeUsbDPList (&Bus->WantedUsbIoDPList);\r | |
1135 | ASSERT (!EFI_ERROR (Status));\r | |
1136 | DevicePathPtr = DuplicateDevicePath ((EFI_DEVICE_PATH_PROTOCOL *) &mAllUsbClassDevicePath);\r | |
1137 | } else {\r | |
1138 | //\r | |
1139 | // Create new Usb device path according to the usb part in remaining device path\r | |
1140 | //\r | |
1141 | DevicePathPtr = GetUsbDPFromFullDP (RemainingDevicePath);\r | |
1142 | }\r | |
1143 | \r | |
1144 | ASSERT (DevicePathPtr != NULL);\r | |
1145 | Status = AddUsbDPToList (DevicePathPtr, &Bus->WantedUsbIoDPList);\r | |
1146 | ASSERT (!EFI_ERROR (Status));\r | |
1147 | gBS->FreePool (DevicePathPtr);\r | |
1148 | return EFI_SUCCESS;\r | |
1149 | }\r | |
1150 | \r | |
1151 | /**\r | |
8616fc4c | 1152 | Check whether a usb child device is the wanted device in a bus.\r |
ecb575d9 | 1153 | \r |
8616fc4c | 1154 | @param Bus The Usb bus's private data pointer.\r |
1155 | @param UsbIf The usb child device inferface.\r | |
ecb575d9 | 1156 | \r |
8616fc4c | 1157 | @retval True If a usb child device is the wanted device in a bus.\r |
1158 | @retval False If a usb child device is *NOT* the wanted device in a bus.\r | |
ecb575d9 | 1159 | \r |
1160 | **/\r | |
1161 | BOOLEAN\r | |
1162 | EFIAPI\r | |
1163 | UsbBusIsWantedUsbIO (\r | |
1164 | IN USB_BUS *Bus,\r | |
1165 | IN USB_INTERFACE *UsbIf\r | |
1166 | )\r | |
1167 | {\r | |
1168 | EFI_DEVICE_PATH_PROTOCOL *DevicePathPtr;\r | |
1169 | LIST_ENTRY *WantedUsbIoDPListPtr;\r | |
1170 | LIST_ENTRY *WantedListIndex;\r | |
1171 | DEVICE_PATH_LIST_ITEM *WantedListItem;\r | |
1172 | BOOLEAN DoConvert;\r | |
1173 | UINTN FirstDevicePathSize;\r | |
1174 | \r | |
1175 | //\r | |
1176 | // Check whether passed in parameters are valid\r | |
1177 | //\r | |
1178 | if ((UsbIf == NULL) || (Bus == NULL)) {\r | |
1179 | return FALSE;\r | |
1180 | }\r | |
1181 | //\r | |
1182 | // Check whether UsbIf is Hub\r | |
1183 | //\r | |
1184 | if (UsbIf->IsHub) {\r | |
1185 | return TRUE;\r | |
1186 | }\r | |
1187 | \r | |
1188 | //\r | |
1189 | // Check whether all Usb devices in this bus are wanted\r | |
1190 | //\r | |
1191 | if (SearchUsbDPInList ((EFI_DEVICE_PATH_PROTOCOL *)&mAllUsbClassDevicePath, &Bus->WantedUsbIoDPList)){\r | |
1192 | return TRUE;\r | |
1193 | }\r | |
1194 | \r | |
1195 | //\r | |
1196 | // Check whether the Usb device match any item in WantedUsbIoDPList\r | |
1197 | //\r | |
1198 | WantedUsbIoDPListPtr = &Bus->WantedUsbIoDPList;\r | |
1199 | //\r | |
1200 | // Create new Usb device path according to the usb part in UsbIo full device path\r | |
1201 | //\r | |
1202 | DevicePathPtr = GetUsbDPFromFullDP (UsbIf->DevicePath);\r | |
1203 | ASSERT (DevicePathPtr != NULL);\r | |
1204 | \r | |
1205 | DoConvert = FALSE;\r | |
1206 | WantedListIndex = WantedUsbIoDPListPtr->ForwardLink;\r | |
1207 | while (WantedListIndex != WantedUsbIoDPListPtr){\r | |
1208 | WantedListItem = CR(WantedListIndex, DEVICE_PATH_LIST_ITEM, Link, DEVICE_PATH_LIST_ITEM_SIGNATURE);\r | |
1209 | ASSERT (WantedListItem->DevicePath->Type == MESSAGING_DEVICE_PATH);\r | |
1210 | switch (WantedListItem->DevicePath->SubType) {\r | |
1211 | case MSG_USB_DP:\r | |
1212 | FirstDevicePathSize = GetDevicePathSize (WantedListItem->DevicePath);\r | |
1213 | if (FirstDevicePathSize == GetDevicePathSize (DevicePathPtr)) {\r | |
1214 | if (CompareMem (\r | |
1215 | WantedListItem->DevicePath,\r | |
1216 | DevicePathPtr,\r | |
1217 | GetDevicePathSize (DevicePathPtr)) == 0\r | |
1218 | ) {\r | |
1219 | DoConvert = TRUE;\r | |
1220 | }\r | |
1221 | }\r | |
1222 | break;\r | |
1223 | case MSG_USB_CLASS_DP:\r | |
1224 | if (MatchUsbClass((USB_CLASS_DEVICE_PATH *)WantedListItem->DevicePath, UsbIf)) {\r | |
1225 | DoConvert = TRUE;\r | |
1226 | }\r | |
1227 | break;\r | |
1228 | case MSG_USB_WWID_DP:\r | |
1229 | if (MatchUsbWwid((USB_WWID_DEVICE_PATH *)WantedListItem->DevicePath, UsbIf)) {\r | |
1230 | DoConvert = TRUE;\r | |
1231 | }\r | |
1232 | break;\r | |
1233 | default:\r | |
1234 | ASSERT (0);\r | |
1235 | break;\r | |
1236 | }\r | |
1237 | \r | |
1238 | if (DoConvert) {\r | |
1239 | break;\r | |
1240 | }\r | |
1241 | \r | |
1242 | WantedListIndex = WantedListIndex->ForwardLink;\r | |
1243 | }\r | |
1244 | gBS->FreePool (DevicePathPtr);\r | |
1245 | \r | |
1246 | //\r | |
1247 | // Check whether the new Usb device path is wanted\r | |
1248 | //\r | |
1249 | if (DoConvert){\r | |
1250 | return TRUE;\r | |
1251 | } else {\r | |
1252 | return FALSE;\r | |
1253 | }\r | |
1254 | }\r | |
1255 | \r | |
1256 | /**\r | |
1257 | Recursively connnect every wanted usb child device to ensure they all fully connected.\r | |
8616fc4c | 1258 | Check all the child Usb IO handles in this bus, recursively connecte if it is wanted usb child device.\r |
ecb575d9 | 1259 | \r |
8616fc4c | 1260 | @param UsbBusId Point to EFI_USB_BUS_PROTOCOL interface.\r |
ecb575d9 | 1261 | \r |
8616fc4c | 1262 | @retval EFI_SUCCESS Connect is done successfully.\r |
1263 | @retval EFI_INVALID_PARAMETER The parameter is invalid.\r | |
ecb575d9 | 1264 | \r |
1265 | **/\r | |
1266 | EFI_STATUS\r | |
1267 | EFIAPI\r | |
1268 | UsbBusRecursivelyConnectWantedUsbIo (\r | |
1269 | IN EFI_USB_BUS_PROTOCOL *UsbBusId\r | |
1270 | )\r | |
1271 | {\r | |
1272 | USB_BUS *Bus;\r | |
1273 | EFI_STATUS Status;\r | |
1274 | UINTN Index;\r | |
1275 | EFI_USB_IO_PROTOCOL *UsbIo;\r | |
1276 | USB_INTERFACE *UsbIf;\r | |
1277 | UINTN UsbIoHandleCount;\r | |
1278 | EFI_HANDLE *UsbIoBuffer;\r | |
1279 | EFI_DEVICE_PATH_PROTOCOL *UsbIoDevicePath;\r | |
1280 | \r | |
1281 | if (UsbBusId == NULL){\r | |
1282 | return EFI_INVALID_PARAMETER;\r | |
1283 | }\r | |
1284 | \r | |
1285 | Bus = USB_BUS_FROM_THIS (UsbBusId);\r | |
1286 | \r | |
1287 | //\r | |
1288 | // Get all Usb IO handles in system\r | |
1289 | //\r | |
1290 | UsbIoHandleCount = 0;\r | |
1291 | Status = gBS->LocateHandleBuffer (ByProtocol, &gEfiUsbIoProtocolGuid, NULL, &UsbIoHandleCount, &UsbIoBuffer);\r | |
1292 | if (Status == EFI_NOT_FOUND || UsbIoHandleCount == 0) {\r | |
1293 | return EFI_SUCCESS;\r | |
1294 | }\r | |
1295 | ASSERT (!EFI_ERROR (Status));\r | |
1296 | \r | |
1297 | for (Index = 0; Index < UsbIoHandleCount; Index++) {\r | |
1298 | //\r | |
1299 | // Check whether the USB IO handle is a child of this bus\r | |
1300 | // Note: The usb child handle maybe invalid because of hot plugged out during the loop\r | |
1301 | //\r | |
1302 | UsbIoDevicePath = NULL;\r | |
1303 | Status = gBS->HandleProtocol (UsbIoBuffer[Index], &gEfiDevicePathProtocolGuid, (VOID *) &UsbIoDevicePath);\r | |
1304 | if (EFI_ERROR (Status) || UsbIoDevicePath == NULL) {\r | |
1305 | continue;\r | |
1306 | }\r | |
1307 | if (CompareMem (\r | |
1308 | UsbIoDevicePath,\r | |
1309 | Bus->DevicePath,\r | |
1310 | (GetDevicePathSize (Bus->DevicePath) - sizeof (EFI_DEVICE_PATH_PROTOCOL))\r | |
1311 | ) != 0) {\r | |
1312 | continue;\r | |
1313 | }\r | |
1314 | \r | |
1315 | //\r | |
1316 | // Get the child Usb IO interface\r | |
1317 | //\r | |
1318 | Status = gBS->HandleProtocol(\r | |
1319 | UsbIoBuffer[Index],\r | |
1320 | &gEfiUsbIoProtocolGuid,\r | |
1321 | (VOID **) &UsbIo\r | |
1322 | );\r | |
1323 | if (EFI_ERROR (Status)) {\r | |
1324 | continue;\r | |
1325 | }\r | |
1326 | UsbIf = USB_INTERFACE_FROM_USBIO (UsbIo);\r | |
1327 | \r | |
1328 | if (UsbBusIsWantedUsbIO (Bus, UsbIf)) {\r | |
1329 | if (!UsbIf->IsManaged) {\r | |
1330 | //\r | |
1331 | // Recursively connect the wanted Usb Io handle\r | |
1332 | //\r | |
1333 | DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL before connect is %d\n", UsbGetCurrentTpl ()));\r | |
1334 | Status = gBS->ConnectController (UsbIf->Handle, NULL, NULL, TRUE);\r | |
1335 | UsbIf->IsManaged = (BOOLEAN)!EFI_ERROR (Status);\r | |
1336 | DEBUG ((EFI_D_INFO, "UsbConnectDriver: TPL after connect is %d\n", UsbGetCurrentTpl()));\r | |
1337 | }\r | |
1338 | }\r | |
1339 | }\r | |
1340 | \r | |
1341 | return EFI_SUCCESS;\r | |
1342 | }\r | |
1343 | \r |