f7f3409686b8c9d13484b0f2cbb571475b63809b
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / XhciDxe / XhciSched.c
1 /** @file
2
3 XHCI transfer scheduling routines.
4
5 Copyright (c) 2011 - 2017, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
10
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13
14 **/
15
16 #include "Xhci.h"
17
18 /**
19 Create a command transfer TRB to support XHCI command interfaces.
20
21 @param Xhc The XHCI Instance.
22 @param CmdTrb The cmd TRB to be executed.
23
24 @return Created URB or NULL.
25
26 **/
27 URB*
28 XhcCreateCmdTrb (
29 IN USB_XHCI_INSTANCE *Xhc,
30 IN TRB_TEMPLATE *CmdTrb
31 )
32 {
33 URB *Urb;
34
35 Urb = AllocateZeroPool (sizeof (URB));
36 if (Urb == NULL) {
37 return NULL;
38 }
39
40 Urb->Signature = XHC_URB_SIG;
41
42 Urb->Ring = &Xhc->CmdRing;
43 XhcSyncTrsRing (Xhc, Urb->Ring);
44 Urb->TrbNum = 1;
45 Urb->TrbStart = Urb->Ring->RingEnqueue;
46 CopyMem (Urb->TrbStart, CmdTrb, sizeof (TRB_TEMPLATE));
47 Urb->TrbStart->CycleBit = Urb->Ring->RingPCS & BIT0;
48 Urb->TrbEnd = Urb->TrbStart;
49
50 return Urb;
51 }
52
53 /**
54 Execute a XHCI cmd TRB pointed by CmdTrb.
55
56 @param Xhc The XHCI Instance.
57 @param CmdTrb The cmd TRB to be executed.
58 @param Timeout Indicates the maximum time, in millisecond, which the
59 transfer is allowed to complete.
60 @param EvtTrb The event TRB corresponding to the cmd TRB.
61
62 @retval EFI_SUCCESS The transfer was completed successfully.
63 @retval EFI_INVALID_PARAMETER Some parameters are invalid.
64 @retval EFI_TIMEOUT The transfer failed due to timeout.
65 @retval EFI_DEVICE_ERROR The transfer failed due to host controller error.
66
67 **/
68 EFI_STATUS
69 EFIAPI
70 XhcCmdTransfer (
71 IN USB_XHCI_INSTANCE *Xhc,
72 IN TRB_TEMPLATE *CmdTrb,
73 IN UINTN Timeout,
74 OUT TRB_TEMPLATE **EvtTrb
75 )
76 {
77 EFI_STATUS Status;
78 URB *Urb;
79
80 //
81 // Validate the parameters
82 //
83 if ((Xhc == NULL) || (CmdTrb == NULL)) {
84 return EFI_INVALID_PARAMETER;
85 }
86
87 Status = EFI_DEVICE_ERROR;
88
89 if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) {
90 DEBUG ((EFI_D_ERROR, "XhcCmdTransfer: HC is halted\n"));
91 goto ON_EXIT;
92 }
93
94 //
95 // Create a new URB, then poll the execution status.
96 //
97 Urb = XhcCreateCmdTrb (Xhc, CmdTrb);
98
99 if (Urb == NULL) {
100 DEBUG ((EFI_D_ERROR, "XhcCmdTransfer: failed to create URB\n"));
101 Status = EFI_OUT_OF_RESOURCES;
102 goto ON_EXIT;
103 }
104
105 Status = XhcExecTransfer (Xhc, TRUE, Urb, Timeout);
106 *EvtTrb = Urb->EvtTrb;
107
108 if (Urb->Result == EFI_USB_NOERROR) {
109 Status = EFI_SUCCESS;
110 }
111
112 XhcFreeUrb (Xhc, Urb);
113
114 ON_EXIT:
115 return Status;
116 }
117
118 /**
119 Create a new URB for a new transaction.
120
121 @param Xhc The XHCI Instance
122 @param BusAddr The logical device address assigned by UsbBus driver
123 @param EpAddr Endpoint addrress
124 @param DevSpeed The device speed
125 @param MaxPacket The max packet length of the endpoint
126 @param Type The transaction type
127 @param Request The standard USB request for control transfer
128 @param Data The user data to transfer
129 @param DataLen The length of data buffer
130 @param Callback The function to call when data is transferred
131 @param Context The context to the callback
132
133 @return Created URB or NULL
134
135 **/
136 URB*
137 XhcCreateUrb (
138 IN USB_XHCI_INSTANCE *Xhc,
139 IN UINT8 BusAddr,
140 IN UINT8 EpAddr,
141 IN UINT8 DevSpeed,
142 IN UINTN MaxPacket,
143 IN UINTN Type,
144 IN EFI_USB_DEVICE_REQUEST *Request,
145 IN VOID *Data,
146 IN UINTN DataLen,
147 IN EFI_ASYNC_USB_TRANSFER_CALLBACK Callback,
148 IN VOID *Context
149 )
150 {
151 USB_ENDPOINT *Ep;
152 EFI_STATUS Status;
153 URB *Urb;
154
155 Urb = AllocateZeroPool (sizeof (URB));
156 if (Urb == NULL) {
157 return NULL;
158 }
159
160 Urb->Signature = XHC_URB_SIG;
161 InitializeListHead (&Urb->UrbList);
162
163 Ep = &Urb->Ep;
164 Ep->BusAddr = BusAddr;
165 Ep->EpAddr = (UINT8)(EpAddr & 0x0F);
166 Ep->Direction = ((EpAddr & 0x80) != 0) ? EfiUsbDataIn : EfiUsbDataOut;
167 Ep->DevSpeed = DevSpeed;
168 Ep->MaxPacket = MaxPacket;
169 Ep->Type = Type;
170
171 Urb->Request = Request;
172 Urb->Data = Data;
173 Urb->DataLen = DataLen;
174 Urb->Callback = Callback;
175 Urb->Context = Context;
176
177 Status = XhcCreateTransferTrb (Xhc, Urb);
178 ASSERT_EFI_ERROR (Status);
179 if (EFI_ERROR (Status)) {
180 DEBUG ((EFI_D_ERROR, "XhcCreateUrb: XhcCreateTransferTrb Failed, Status = %r\n", Status));
181 FreePool (Urb);
182 Urb = NULL;
183 }
184
185 return Urb;
186 }
187
188 /**
189 Free an allocated URB.
190
191 @param Xhc The XHCI device.
192 @param Urb The URB to free.
193
194 **/
195 VOID
196 XhcFreeUrb (
197 IN USB_XHCI_INSTANCE *Xhc,
198 IN URB *Urb
199 )
200 {
201 if ((Xhc == NULL) || (Urb == NULL)) {
202 return;
203 }
204
205 if (Urb->DataMap != NULL) {
206 Xhc->PciIo->Unmap (Xhc->PciIo, Urb->DataMap);
207 }
208
209 FreePool (Urb);
210 }
211
212 /**
213 Create a transfer TRB.
214
215 @param Xhc The XHCI Instance
216 @param Urb The urb used to construct the transfer TRB.
217
218 @return Created TRB or NULL
219
220 **/
221 EFI_STATUS
222 XhcCreateTransferTrb (
223 IN USB_XHCI_INSTANCE *Xhc,
224 IN URB *Urb
225 )
226 {
227 VOID *OutputContext;
228 TRANSFER_RING *EPRing;
229 UINT8 EPType;
230 UINT8 SlotId;
231 UINT8 Dci;
232 TRB *TrbStart;
233 UINTN TotalLen;
234 UINTN Len;
235 UINTN TrbNum;
236 EFI_PCI_IO_PROTOCOL_OPERATION MapOp;
237 EFI_PHYSICAL_ADDRESS PhyAddr;
238 VOID *Map;
239 EFI_STATUS Status;
240
241 SlotId = XhcBusDevAddrToSlotId (Xhc, Urb->Ep.BusAddr);
242 if (SlotId == 0) {
243 return EFI_DEVICE_ERROR;
244 }
245
246 Urb->Finished = FALSE;
247 Urb->StartDone = FALSE;
248 Urb->EndDone = FALSE;
249 Urb->Completed = 0;
250 Urb->Result = EFI_USB_NOERROR;
251
252 Dci = XhcEndpointToDci (Urb->Ep.EpAddr, (UINT8)(Urb->Ep.Direction));
253 ASSERT (Dci < 32);
254 EPRing = (TRANSFER_RING *)(UINTN) Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1];
255 Urb->Ring = EPRing;
256 OutputContext = Xhc->UsbDevContext[SlotId].OutputContext;
257 if (Xhc->HcCParams.Data.Csz == 0) {
258 EPType = (UINT8) ((DEVICE_CONTEXT *)OutputContext)->EP[Dci-1].EPType;
259 } else {
260 EPType = (UINT8) ((DEVICE_CONTEXT_64 *)OutputContext)->EP[Dci-1].EPType;
261 }
262
263 if (Urb->Data != NULL) {
264 if (((UINT8) (Urb->Ep.Direction)) == EfiUsbDataIn) {
265 MapOp = EfiPciIoOperationBusMasterWrite;
266 } else {
267 MapOp = EfiPciIoOperationBusMasterRead;
268 }
269
270 Len = Urb->DataLen;
271 Status = Xhc->PciIo->Map (Xhc->PciIo, MapOp, Urb->Data, &Len, &PhyAddr, &Map);
272
273 if (EFI_ERROR (Status) || (Len != Urb->DataLen)) {
274 DEBUG ((EFI_D_ERROR, "XhcCreateTransferTrb: Fail to map Urb->Data.\n"));
275 return EFI_OUT_OF_RESOURCES;
276 }
277
278 Urb->DataPhy = (VOID *) ((UINTN) PhyAddr);
279 Urb->DataMap = Map;
280 }
281
282 //
283 // Construct the TRB
284 //
285 XhcSyncTrsRing (Xhc, EPRing);
286 Urb->TrbStart = EPRing->RingEnqueue;
287 switch (EPType) {
288 case ED_CONTROL_BIDIR:
289 //
290 // For control transfer, create SETUP_STAGE_TRB first.
291 //
292 TrbStart = (TRB *)(UINTN)EPRing->RingEnqueue;
293 TrbStart->TrbCtrSetup.bmRequestType = Urb->Request->RequestType;
294 TrbStart->TrbCtrSetup.bRequest = Urb->Request->Request;
295 TrbStart->TrbCtrSetup.wValue = Urb->Request->Value;
296 TrbStart->TrbCtrSetup.wIndex = Urb->Request->Index;
297 TrbStart->TrbCtrSetup.wLength = Urb->Request->Length;
298 TrbStart->TrbCtrSetup.Length = 8;
299 TrbStart->TrbCtrSetup.IntTarget = 0;
300 TrbStart->TrbCtrSetup.IOC = 1;
301 TrbStart->TrbCtrSetup.IDT = 1;
302 TrbStart->TrbCtrSetup.Type = TRB_TYPE_SETUP_STAGE;
303 if (Urb->Ep.Direction == EfiUsbDataIn) {
304 TrbStart->TrbCtrSetup.TRT = 3;
305 } else if (Urb->Ep.Direction == EfiUsbDataOut) {
306 TrbStart->TrbCtrSetup.TRT = 2;
307 } else {
308 TrbStart->TrbCtrSetup.TRT = 0;
309 }
310 //
311 // Update the cycle bit
312 //
313 TrbStart->TrbCtrSetup.CycleBit = EPRing->RingPCS & BIT0;
314 Urb->TrbNum++;
315
316 //
317 // For control transfer, create DATA_STAGE_TRB.
318 //
319 if (Urb->DataLen > 0) {
320 XhcSyncTrsRing (Xhc, EPRing);
321 TrbStart = (TRB *)(UINTN)EPRing->RingEnqueue;
322 TrbStart->TrbCtrData.TRBPtrLo = XHC_LOW_32BIT(Urb->DataPhy);
323 TrbStart->TrbCtrData.TRBPtrHi = XHC_HIGH_32BIT(Urb->DataPhy);
324 TrbStart->TrbCtrData.Length = (UINT32) Urb->DataLen;
325 TrbStart->TrbCtrData.TDSize = 0;
326 TrbStart->TrbCtrData.IntTarget = 0;
327 TrbStart->TrbCtrData.ISP = 1;
328 TrbStart->TrbCtrData.IOC = 1;
329 TrbStart->TrbCtrData.IDT = 0;
330 TrbStart->TrbCtrData.CH = 0;
331 TrbStart->TrbCtrData.Type = TRB_TYPE_DATA_STAGE;
332 if (Urb->Ep.Direction == EfiUsbDataIn) {
333 TrbStart->TrbCtrData.DIR = 1;
334 } else if (Urb->Ep.Direction == EfiUsbDataOut) {
335 TrbStart->TrbCtrData.DIR = 0;
336 } else {
337 TrbStart->TrbCtrData.DIR = 0;
338 }
339 //
340 // Update the cycle bit
341 //
342 TrbStart->TrbCtrData.CycleBit = EPRing->RingPCS & BIT0;
343 Urb->TrbNum++;
344 }
345 //
346 // For control transfer, create STATUS_STAGE_TRB.
347 // Get the pointer to next TRB for status stage use
348 //
349 XhcSyncTrsRing (Xhc, EPRing);
350 TrbStart = (TRB *)(UINTN)EPRing->RingEnqueue;
351 TrbStart->TrbCtrStatus.IntTarget = 0;
352 TrbStart->TrbCtrStatus.IOC = 1;
353 TrbStart->TrbCtrStatus.CH = 0;
354 TrbStart->TrbCtrStatus.Type = TRB_TYPE_STATUS_STAGE;
355 if (Urb->Ep.Direction == EfiUsbDataIn) {
356 TrbStart->TrbCtrStatus.DIR = 0;
357 } else if (Urb->Ep.Direction == EfiUsbDataOut) {
358 TrbStart->TrbCtrStatus.DIR = 1;
359 } else {
360 TrbStart->TrbCtrStatus.DIR = 0;
361 }
362 //
363 // Update the cycle bit
364 //
365 TrbStart->TrbCtrStatus.CycleBit = EPRing->RingPCS & BIT0;
366 //
367 // Update the enqueue pointer
368 //
369 XhcSyncTrsRing (Xhc, EPRing);
370 Urb->TrbNum++;
371 Urb->TrbEnd = (TRB_TEMPLATE *)(UINTN)TrbStart;
372
373 break;
374
375 case ED_BULK_OUT:
376 case ED_BULK_IN:
377 TotalLen = 0;
378 Len = 0;
379 TrbNum = 0;
380 TrbStart = (TRB *)(UINTN)EPRing->RingEnqueue;
381 while (TotalLen < Urb->DataLen) {
382 if ((TotalLen + 0x10000) >= Urb->DataLen) {
383 Len = Urb->DataLen - TotalLen;
384 } else {
385 Len = 0x10000;
386 }
387 TrbStart = (TRB *)(UINTN)EPRing->RingEnqueue;
388 TrbStart->TrbNormal.TRBPtrLo = XHC_LOW_32BIT((UINT8 *) Urb->DataPhy + TotalLen);
389 TrbStart->TrbNormal.TRBPtrHi = XHC_HIGH_32BIT((UINT8 *) Urb->DataPhy + TotalLen);
390 TrbStart->TrbNormal.Length = (UINT32) Len;
391 TrbStart->TrbNormal.TDSize = 0;
392 TrbStart->TrbNormal.IntTarget = 0;
393 TrbStart->TrbNormal.ISP = 1;
394 TrbStart->TrbNormal.IOC = 1;
395 TrbStart->TrbNormal.Type = TRB_TYPE_NORMAL;
396 //
397 // Update the cycle bit
398 //
399 TrbStart->TrbNormal.CycleBit = EPRing->RingPCS & BIT0;
400
401 XhcSyncTrsRing (Xhc, EPRing);
402 TrbNum++;
403 TotalLen += Len;
404 }
405
406 Urb->TrbNum = TrbNum;
407 Urb->TrbEnd = (TRB_TEMPLATE *)(UINTN)TrbStart;
408 break;
409
410 case ED_INTERRUPT_OUT:
411 case ED_INTERRUPT_IN:
412 TotalLen = 0;
413 Len = 0;
414 TrbNum = 0;
415 TrbStart = (TRB *)(UINTN)EPRing->RingEnqueue;
416 while (TotalLen < Urb->DataLen) {
417 if ((TotalLen + 0x10000) >= Urb->DataLen) {
418 Len = Urb->DataLen - TotalLen;
419 } else {
420 Len = 0x10000;
421 }
422 TrbStart = (TRB *)(UINTN)EPRing->RingEnqueue;
423 TrbStart->TrbNormal.TRBPtrLo = XHC_LOW_32BIT((UINT8 *) Urb->DataPhy + TotalLen);
424 TrbStart->TrbNormal.TRBPtrHi = XHC_HIGH_32BIT((UINT8 *) Urb->DataPhy + TotalLen);
425 TrbStart->TrbNormal.Length = (UINT32) Len;
426 TrbStart->TrbNormal.TDSize = 0;
427 TrbStart->TrbNormal.IntTarget = 0;
428 TrbStart->TrbNormal.ISP = 1;
429 TrbStart->TrbNormal.IOC = 1;
430 TrbStart->TrbNormal.Type = TRB_TYPE_NORMAL;
431 //
432 // Update the cycle bit
433 //
434 TrbStart->TrbNormal.CycleBit = EPRing->RingPCS & BIT0;
435
436 XhcSyncTrsRing (Xhc, EPRing);
437 TrbNum++;
438 TotalLen += Len;
439 }
440
441 Urb->TrbNum = TrbNum;
442 Urb->TrbEnd = (TRB_TEMPLATE *)(UINTN)TrbStart;
443 break;
444
445 default:
446 DEBUG ((EFI_D_INFO, "Not supported EPType 0x%x!\n",EPType));
447 ASSERT (FALSE);
448 break;
449 }
450
451 return EFI_SUCCESS;
452 }
453
454
455 /**
456 Initialize the XHCI host controller for schedule.
457
458 @param Xhc The XHCI Instance to be initialized.
459
460 **/
461 VOID
462 XhcInitSched (
463 IN USB_XHCI_INSTANCE *Xhc
464 )
465 {
466 VOID *Dcbaa;
467 EFI_PHYSICAL_ADDRESS DcbaaPhy;
468 UINT64 CmdRing;
469 EFI_PHYSICAL_ADDRESS CmdRingPhy;
470 UINTN Entries;
471 UINT32 MaxScratchpadBufs;
472 UINT64 *ScratchBuf;
473 EFI_PHYSICAL_ADDRESS ScratchPhy;
474 UINT64 *ScratchEntry;
475 EFI_PHYSICAL_ADDRESS ScratchEntryPhy;
476 UINT32 Index;
477 UINTN *ScratchEntryMap;
478 EFI_STATUS Status;
479
480 //
481 // Initialize memory management.
482 //
483 Xhc->MemPool = UsbHcInitMemPool (Xhc->PciIo);
484 ASSERT (Xhc->MemPool != NULL);
485
486 //
487 // Program the Max Device Slots Enabled (MaxSlotsEn) field in the CONFIG register (5.4.7)
488 // to enable the device slots that system software is going to use.
489 //
490 Xhc->MaxSlotsEn = Xhc->HcSParams1.Data.MaxSlots;
491 ASSERT (Xhc->MaxSlotsEn >= 1 && Xhc->MaxSlotsEn <= 255);
492 XhcWriteOpReg (Xhc, XHC_CONFIG_OFFSET, Xhc->MaxSlotsEn);
493
494 //
495 // The Device Context Base Address Array entry associated with each allocated Device Slot
496 // shall contain a 64-bit pointer to the base of the associated Device Context.
497 // The Device Context Base Address Array shall contain MaxSlotsEn + 1 entries.
498 // Software shall set Device Context Base Address Array entries for unallocated Device Slots to '0'.
499 //
500 Entries = (Xhc->MaxSlotsEn + 1) * sizeof(UINT64);
501 Dcbaa = UsbHcAllocateMem (Xhc->MemPool, Entries);
502 ASSERT (Dcbaa != NULL);
503 ZeroMem (Dcbaa, Entries);
504
505 //
506 // A Scratchpad Buffer is a PAGESIZE block of system memory located on a PAGESIZE boundary.
507 // System software shall allocate the Scratchpad Buffer(s) before placing the xHC in to Run
508 // mode (Run/Stop(R/S) ='1').
509 //
510 MaxScratchpadBufs = ((Xhc->HcSParams2.Data.ScratchBufHi) << 5) | (Xhc->HcSParams2.Data.ScratchBufLo);
511 Xhc->MaxScratchpadBufs = MaxScratchpadBufs;
512 ASSERT (MaxScratchpadBufs <= 1023);
513 if (MaxScratchpadBufs != 0) {
514 //
515 // Allocate the buffer to record the Mapping for each scratch buffer in order to Unmap them
516 //
517 ScratchEntryMap = AllocateZeroPool (sizeof (UINTN) * MaxScratchpadBufs);
518 ASSERT (ScratchEntryMap != NULL);
519 Xhc->ScratchEntryMap = ScratchEntryMap;
520
521 //
522 // Allocate the buffer to record the host address for each entry
523 //
524 ScratchEntry = AllocateZeroPool (sizeof (UINT64) * MaxScratchpadBufs);
525 ASSERT (ScratchEntry != NULL);
526 Xhc->ScratchEntry = ScratchEntry;
527
528 ScratchPhy = 0;
529 Status = UsbHcAllocateAlignedPages (
530 Xhc->PciIo,
531 EFI_SIZE_TO_PAGES (MaxScratchpadBufs * sizeof (UINT64)),
532 Xhc->PageSize,
533 (VOID **) &ScratchBuf,
534 &ScratchPhy,
535 &Xhc->ScratchMap
536 );
537 ASSERT_EFI_ERROR (Status);
538
539 ZeroMem (ScratchBuf, MaxScratchpadBufs * sizeof (UINT64));
540 Xhc->ScratchBuf = ScratchBuf;
541
542 //
543 // Allocate each scratch buffer
544 //
545 for (Index = 0; Index < MaxScratchpadBufs; Index++) {
546 ScratchEntryPhy = 0;
547 Status = UsbHcAllocateAlignedPages (
548 Xhc->PciIo,
549 EFI_SIZE_TO_PAGES (Xhc->PageSize),
550 Xhc->PageSize,
551 (VOID **) &ScratchEntry[Index],
552 &ScratchEntryPhy,
553 (VOID **) &ScratchEntryMap[Index]
554 );
555 ASSERT_EFI_ERROR (Status);
556 ZeroMem ((VOID *)(UINTN)ScratchEntry[Index], Xhc->PageSize);
557 //
558 // Fill with the PCI device address
559 //
560 *ScratchBuf++ = ScratchEntryPhy;
561 }
562 //
563 // The Scratchpad Buffer Array contains pointers to the Scratchpad Buffers. Entry 0 of the
564 // Device Context Base Address Array points to the Scratchpad Buffer Array.
565 //
566 *(UINT64 *)Dcbaa = (UINT64)(UINTN) ScratchPhy;
567 }
568
569 //
570 // Program the Device Context Base Address Array Pointer (DCBAAP) register (5.4.6) with
571 // a 64-bit address pointing to where the Device Context Base Address Array is located.
572 //
573 Xhc->DCBAA = (UINT64 *)(UINTN)Dcbaa;
574 //
575 // Some 3rd party XHCI external cards don't support single 64-bytes width register access,
576 // So divide it to two 32-bytes width register access.
577 //
578 DcbaaPhy = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, Dcbaa, Entries);
579 XhcWriteOpReg (Xhc, XHC_DCBAAP_OFFSET, XHC_LOW_32BIT(DcbaaPhy));
580 XhcWriteOpReg (Xhc, XHC_DCBAAP_OFFSET + 4, XHC_HIGH_32BIT (DcbaaPhy));
581
582 DEBUG ((EFI_D_INFO, "XhcInitSched:DCBAA=0x%x\n", (UINT64)(UINTN)Xhc->DCBAA));
583
584 //
585 // Define the Command Ring Dequeue Pointer by programming the Command Ring Control Register
586 // (5.4.5) with a 64-bit address pointing to the starting address of the first TRB of the Command Ring.
587 // Note: The Command Ring is 64 byte aligned, so the low order 6 bits of the Command Ring Pointer shall
588 // always be '0'.
589 //
590 CreateTransferRing (Xhc, CMD_RING_TRB_NUMBER, &Xhc->CmdRing);
591 //
592 // The xHC uses the Enqueue Pointer to determine when a Transfer Ring is empty. As it fetches TRBs from a
593 // Transfer Ring it checks for a Cycle bit transition. If a transition detected, the ring is empty.
594 // So we set RCS as inverted PCS init value to let Command Ring empty
595 //
596 CmdRing = (UINT64)(UINTN)Xhc->CmdRing.RingSeg0;
597 CmdRingPhy = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, (VOID *)(UINTN) CmdRing, sizeof (TRB_TEMPLATE) * CMD_RING_TRB_NUMBER);
598 ASSERT ((CmdRingPhy & 0x3F) == 0);
599 CmdRingPhy |= XHC_CRCR_RCS;
600 //
601 // Some 3rd party XHCI external cards don't support single 64-bytes width register access,
602 // So divide it to two 32-bytes width register access.
603 //
604 XhcWriteOpReg (Xhc, XHC_CRCR_OFFSET, XHC_LOW_32BIT(CmdRingPhy));
605 XhcWriteOpReg (Xhc, XHC_CRCR_OFFSET + 4, XHC_HIGH_32BIT (CmdRingPhy));
606
607 //
608 // Disable the 'interrupter enable' bit in USB_CMD
609 // and clear IE & IP bit in all Interrupter X Management Registers.
610 //
611 XhcClearOpRegBit (Xhc, XHC_USBCMD_OFFSET, XHC_USBCMD_INTE);
612 for (Index = 0; Index < (UINT16)(Xhc->HcSParams1.Data.MaxIntrs); Index++) {
613 XhcClearRuntimeRegBit (Xhc, XHC_IMAN_OFFSET + (Index * 32), XHC_IMAN_IE);
614 XhcSetRuntimeRegBit (Xhc, XHC_IMAN_OFFSET + (Index * 32), XHC_IMAN_IP);
615 }
616
617 //
618 // Allocate EventRing for Cmd, Ctrl, Bulk, Interrupt, AsynInterrupt transfer
619 //
620 CreateEventRing (Xhc, &Xhc->EventRing);
621 DEBUG ((DEBUG_INFO, "XhcInitSched: Created CMD ring [%p~%p) EVENT ring [%p~%p)\n",
622 Xhc->CmdRing.RingSeg0, (UINTN)Xhc->CmdRing.RingSeg0 + sizeof (TRB_TEMPLATE) * CMD_RING_TRB_NUMBER,
623 Xhc->EventRing.EventRingSeg0, (UINTN)Xhc->EventRing.EventRingSeg0 + sizeof (TRB_TEMPLATE) * EVENT_RING_TRB_NUMBER
624 ));
625 }
626
627 /**
628 System software shall use a Reset Endpoint Command (section 4.11.4.7) to remove the Halted
629 condition in the xHC. After the successful completion of the Reset Endpoint Command, the Endpoint
630 Context is transitioned from the Halted to the Stopped state and the Transfer Ring of the endpoint is
631 reenabled. The next write to the Doorbell of the Endpoint will transition the Endpoint Context from the
632 Stopped to the Running state.
633
634 @param Xhc The XHCI Instance.
635 @param Urb The urb which makes the endpoint halted.
636
637 @retval EFI_SUCCESS The recovery is successful.
638 @retval Others Failed to recovery halted endpoint.
639
640 **/
641 EFI_STATUS
642 EFIAPI
643 XhcRecoverHaltedEndpoint (
644 IN USB_XHCI_INSTANCE *Xhc,
645 IN URB *Urb
646 )
647 {
648 EFI_STATUS Status;
649 UINT8 Dci;
650 UINT8 SlotId;
651
652 Status = EFI_SUCCESS;
653 SlotId = XhcBusDevAddrToSlotId (Xhc, Urb->Ep.BusAddr);
654 if (SlotId == 0) {
655 return EFI_DEVICE_ERROR;
656 }
657 Dci = XhcEndpointToDci (Urb->Ep.EpAddr, (UINT8)(Urb->Ep.Direction));
658 ASSERT (Dci < 32);
659
660 DEBUG ((EFI_D_INFO, "Recovery Halted Slot = %x,Dci = %x\n", SlotId, Dci));
661
662 //
663 // 1) Send Reset endpoint command to transit from halt to stop state
664 //
665 Status = XhcResetEndpoint(Xhc, SlotId, Dci);
666 if (EFI_ERROR(Status)) {
667 DEBUG ((EFI_D_ERROR, "XhcRecoverHaltedEndpoint: Reset Endpoint Failed, Status = %r\n", Status));
668 goto Done;
669 }
670
671 //
672 // 2)Set dequeue pointer
673 //
674 Status = XhcSetTrDequeuePointer(Xhc, SlotId, Dci, Urb);
675 if (EFI_ERROR(Status)) {
676 DEBUG ((EFI_D_ERROR, "XhcRecoverHaltedEndpoint: Set Transfer Ring Dequeue Pointer Failed, Status = %r\n", Status));
677 goto Done;
678 }
679
680 //
681 // 3)Ring the doorbell to transit from stop to active
682 //
683 XhcRingDoorBell (Xhc, SlotId, Dci);
684
685 Done:
686 return Status;
687 }
688
689 /**
690 System software shall use a Stop Endpoint Command (section 4.6.9) and the Set TR Dequeue Pointer
691 Command (section 4.6.10) to remove the timed-out TDs from the xHC transfer ring. The next write to
692 the Doorbell of the Endpoint will transition the Endpoint Context from the Stopped to the Running
693 state.
694
695 @param Xhc The XHCI Instance.
696 @param Urb The urb which doesn't get completed in a specified timeout range.
697
698 @retval EFI_SUCCESS The dequeuing of the TDs is successful.
699 @retval Others Failed to stop the endpoint and dequeue the TDs.
700
701 **/
702 EFI_STATUS
703 EFIAPI
704 XhcDequeueTrbFromEndpoint (
705 IN USB_XHCI_INSTANCE *Xhc,
706 IN URB *Urb
707 )
708 {
709 EFI_STATUS Status;
710 UINT8 Dci;
711 UINT8 SlotId;
712
713 Status = EFI_SUCCESS;
714 SlotId = XhcBusDevAddrToSlotId (Xhc, Urb->Ep.BusAddr);
715 if (SlotId == 0) {
716 return EFI_DEVICE_ERROR;
717 }
718 Dci = XhcEndpointToDci (Urb->Ep.EpAddr, (UINT8)(Urb->Ep.Direction));
719 ASSERT (Dci < 32);
720
721 DEBUG ((EFI_D_INFO, "Stop Slot = %x,Dci = %x\n", SlotId, Dci));
722
723 //
724 // 1) Send Stop endpoint command to stop xHC from executing of the TDs on the endpoint
725 //
726 Status = XhcStopEndpoint(Xhc, SlotId, Dci);
727 if (EFI_ERROR(Status)) {
728 DEBUG ((EFI_D_ERROR, "XhcDequeueTrbFromEndpoint: Stop Endpoint Failed, Status = %r\n", Status));
729 goto Done;
730 }
731
732 //
733 // 2)Set dequeue pointer
734 //
735 Status = XhcSetTrDequeuePointer(Xhc, SlotId, Dci, Urb);
736 if (EFI_ERROR(Status)) {
737 DEBUG ((EFI_D_ERROR, "XhcDequeueTrbFromEndpoint: Set Transfer Ring Dequeue Pointer Failed, Status = %r\n", Status));
738 goto Done;
739 }
740
741 //
742 // 3)Ring the doorbell to transit from stop to active
743 //
744 XhcRingDoorBell (Xhc, SlotId, Dci);
745
746 Done:
747 return Status;
748 }
749
750 /**
751 Create XHCI event ring.
752
753 @param Xhc The XHCI Instance.
754 @param EventRing The created event ring.
755
756 **/
757 VOID
758 CreateEventRing (
759 IN USB_XHCI_INSTANCE *Xhc,
760 OUT EVENT_RING *EventRing
761 )
762 {
763 VOID *Buf;
764 EVENT_RING_SEG_TABLE_ENTRY *ERSTBase;
765 UINTN Size;
766 EFI_PHYSICAL_ADDRESS ERSTPhy;
767 EFI_PHYSICAL_ADDRESS DequeuePhy;
768
769 ASSERT (EventRing != NULL);
770
771 Size = sizeof (TRB_TEMPLATE) * EVENT_RING_TRB_NUMBER;
772 Buf = UsbHcAllocateMem (Xhc->MemPool, Size);
773 ASSERT (Buf != NULL);
774 ASSERT (((UINTN) Buf & 0x3F) == 0);
775 ZeroMem (Buf, Size);
776
777 EventRing->EventRingSeg0 = Buf;
778 EventRing->TrbNumber = EVENT_RING_TRB_NUMBER;
779 EventRing->EventRingDequeue = (TRB_TEMPLATE *) EventRing->EventRingSeg0;
780 EventRing->EventRingEnqueue = (TRB_TEMPLATE *) EventRing->EventRingSeg0;
781
782 DequeuePhy = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, Buf, Size);
783
784 //
785 // Software maintains an Event Ring Consumer Cycle State (CCS) bit, initializing it to '1'
786 // and toggling it every time the Event Ring Dequeue Pointer wraps back to the beginning of the Event Ring.
787 //
788 EventRing->EventRingCCS = 1;
789
790 Size = sizeof (EVENT_RING_SEG_TABLE_ENTRY) * ERST_NUMBER;
791 Buf = UsbHcAllocateMem (Xhc->MemPool, Size);
792 ASSERT (Buf != NULL);
793 ASSERT (((UINTN) Buf & 0x3F) == 0);
794 ZeroMem (Buf, Size);
795
796 ERSTBase = (EVENT_RING_SEG_TABLE_ENTRY *) Buf;
797 EventRing->ERSTBase = ERSTBase;
798 ERSTBase->PtrLo = XHC_LOW_32BIT (DequeuePhy);
799 ERSTBase->PtrHi = XHC_HIGH_32BIT (DequeuePhy);
800 ERSTBase->RingTrbSize = EVENT_RING_TRB_NUMBER;
801
802 ERSTPhy = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, ERSTBase, Size);
803
804 //
805 // Program the Interrupter Event Ring Segment Table Size (ERSTSZ) register (5.5.2.3.1)
806 //
807 XhcWriteRuntimeReg (
808 Xhc,
809 XHC_ERSTSZ_OFFSET,
810 ERST_NUMBER
811 );
812 //
813 // Program the Interrupter Event Ring Dequeue Pointer (ERDP) register (5.5.2.3.3)
814 //
815 // Some 3rd party XHCI external cards don't support single 64-bytes width register access,
816 // So divide it to two 32-bytes width register access.
817 //
818 XhcWriteRuntimeReg (
819 Xhc,
820 XHC_ERDP_OFFSET,
821 XHC_LOW_32BIT((UINT64)(UINTN)DequeuePhy)
822 );
823 XhcWriteRuntimeReg (
824 Xhc,
825 XHC_ERDP_OFFSET + 4,
826 XHC_HIGH_32BIT((UINT64)(UINTN)DequeuePhy)
827 );
828 //
829 // Program the Interrupter Event Ring Segment Table Base Address (ERSTBA) register(5.5.2.3.2)
830 //
831 // Some 3rd party XHCI external cards don't support single 64-bytes width register access,
832 // So divide it to two 32-bytes width register access.
833 //
834 XhcWriteRuntimeReg (
835 Xhc,
836 XHC_ERSTBA_OFFSET,
837 XHC_LOW_32BIT((UINT64)(UINTN)ERSTPhy)
838 );
839 XhcWriteRuntimeReg (
840 Xhc,
841 XHC_ERSTBA_OFFSET + 4,
842 XHC_HIGH_32BIT((UINT64)(UINTN)ERSTPhy)
843 );
844 //
845 // Need set IMAN IE bit to enble the ring interrupt
846 //
847 XhcSetRuntimeRegBit (Xhc, XHC_IMAN_OFFSET, XHC_IMAN_IE);
848 }
849
850 /**
851 Create XHCI transfer ring.
852
853 @param Xhc The XHCI Instance.
854 @param TrbNum The number of TRB in the ring.
855 @param TransferRing The created transfer ring.
856
857 **/
858 VOID
859 CreateTransferRing (
860 IN USB_XHCI_INSTANCE *Xhc,
861 IN UINTN TrbNum,
862 OUT TRANSFER_RING *TransferRing
863 )
864 {
865 VOID *Buf;
866 LINK_TRB *EndTrb;
867 EFI_PHYSICAL_ADDRESS PhyAddr;
868
869 Buf = UsbHcAllocateMem (Xhc->MemPool, sizeof (TRB_TEMPLATE) * TrbNum);
870 ASSERT (Buf != NULL);
871 ASSERT (((UINTN) Buf & 0x3F) == 0);
872 ZeroMem (Buf, sizeof (TRB_TEMPLATE) * TrbNum);
873
874 TransferRing->RingSeg0 = Buf;
875 TransferRing->TrbNumber = TrbNum;
876 TransferRing->RingEnqueue = (TRB_TEMPLATE *) TransferRing->RingSeg0;
877 TransferRing->RingDequeue = (TRB_TEMPLATE *) TransferRing->RingSeg0;
878 TransferRing->RingPCS = 1;
879 //
880 // 4.9.2 Transfer Ring Management
881 // To form a ring (or circular queue) a Link TRB may be inserted at the end of a ring to
882 // point to the first TRB in the ring.
883 //
884 EndTrb = (LINK_TRB *) ((UINTN)Buf + sizeof (TRB_TEMPLATE) * (TrbNum - 1));
885 EndTrb->Type = TRB_TYPE_LINK;
886 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, Buf, sizeof (TRB_TEMPLATE) * TrbNum);
887 EndTrb->PtrLo = XHC_LOW_32BIT (PhyAddr);
888 EndTrb->PtrHi = XHC_HIGH_32BIT (PhyAddr);
889 //
890 // Toggle Cycle (TC). When set to '1', the xHC shall toggle its interpretation of the Cycle bit.
891 //
892 EndTrb->TC = 1;
893 //
894 // Set Cycle bit as other TRB PCS init value
895 //
896 EndTrb->CycleBit = 0;
897 }
898
899 /**
900 Free XHCI event ring.
901
902 @param Xhc The XHCI Instance.
903 @param EventRing The event ring to be freed.
904
905 **/
906 EFI_STATUS
907 EFIAPI
908 XhcFreeEventRing (
909 IN USB_XHCI_INSTANCE *Xhc,
910 IN EVENT_RING *EventRing
911 )
912 {
913 if(EventRing->EventRingSeg0 == NULL) {
914 return EFI_SUCCESS;
915 }
916
917 //
918 // Free EventRing Segment 0
919 //
920 UsbHcFreeMem (Xhc->MemPool, EventRing->EventRingSeg0, sizeof (TRB_TEMPLATE) * EVENT_RING_TRB_NUMBER);
921
922 //
923 // Free ESRT table
924 //
925 UsbHcFreeMem (Xhc->MemPool, EventRing->ERSTBase, sizeof (EVENT_RING_SEG_TABLE_ENTRY) * ERST_NUMBER);
926 return EFI_SUCCESS;
927 }
928
929 /**
930 Free the resouce allocated at initializing schedule.
931
932 @param Xhc The XHCI Instance.
933
934 **/
935 VOID
936 XhcFreeSched (
937 IN USB_XHCI_INSTANCE *Xhc
938 )
939 {
940 UINT32 Index;
941 UINT64 *ScratchEntry;
942
943 if (Xhc->ScratchBuf != NULL) {
944 ScratchEntry = Xhc->ScratchEntry;
945 for (Index = 0; Index < Xhc->MaxScratchpadBufs; Index++) {
946 //
947 // Free Scratchpad Buffers
948 //
949 UsbHcFreeAlignedPages (Xhc->PciIo, (VOID*)(UINTN)ScratchEntry[Index], EFI_SIZE_TO_PAGES (Xhc->PageSize), (VOID *) Xhc->ScratchEntryMap[Index]);
950 }
951 //
952 // Free Scratchpad Buffer Array
953 //
954 UsbHcFreeAlignedPages (Xhc->PciIo, Xhc->ScratchBuf, EFI_SIZE_TO_PAGES (Xhc->MaxScratchpadBufs * sizeof (UINT64)), Xhc->ScratchMap);
955 FreePool (Xhc->ScratchEntryMap);
956 FreePool (Xhc->ScratchEntry);
957 }
958
959 if (Xhc->CmdRing.RingSeg0 != NULL) {
960 UsbHcFreeMem (Xhc->MemPool, Xhc->CmdRing.RingSeg0, sizeof (TRB_TEMPLATE) * CMD_RING_TRB_NUMBER);
961 Xhc->CmdRing.RingSeg0 = NULL;
962 }
963
964 XhcFreeEventRing (Xhc,&Xhc->EventRing);
965
966 if (Xhc->DCBAA != NULL) {
967 UsbHcFreeMem (Xhc->MemPool, Xhc->DCBAA, (Xhc->MaxSlotsEn + 1) * sizeof(UINT64));
968 Xhc->DCBAA = NULL;
969 }
970
971 //
972 // Free memory pool at last
973 //
974 if (Xhc->MemPool != NULL) {
975 UsbHcFreeMemPool (Xhc->MemPool);
976 Xhc->MemPool = NULL;
977 }
978 }
979
980 /**
981 Check if the Trb is a transaction of the URB.
982
983 @param Trb The TRB to be checked
984 @param Urb The URB to be checked.
985
986 @retval TRUE It is a transaction of the URB.
987 @retval FALSE It is not any transaction of the URB.
988
989 **/
990 BOOLEAN
991 IsTransferRingTrb (
992 IN USB_XHCI_INSTANCE *Xhc,
993 IN TRB_TEMPLATE *Trb,
994 IN URB *Urb
995 )
996 {
997 LINK_TRB *LinkTrb;
998 TRB_TEMPLATE *CheckedTrb;
999 UINTN Index;
1000 EFI_PHYSICAL_ADDRESS PhyAddr;
1001
1002 CheckedTrb = Urb->TrbStart;
1003 for (Index = 0; Index < Urb->TrbNum; Index++) {
1004 if (Trb == CheckedTrb) {
1005 return TRUE;
1006 }
1007 CheckedTrb++;
1008 //
1009 // If the checked TRB is the link TRB at the end of the transfer ring,
1010 // recircle it to the head of the ring.
1011 //
1012 if (CheckedTrb->Type == TRB_TYPE_LINK) {
1013 LinkTrb = (LINK_TRB *) CheckedTrb;
1014 PhyAddr = (EFI_PHYSICAL_ADDRESS)(LinkTrb->PtrLo | LShiftU64 ((UINT64) LinkTrb->PtrHi, 32));
1015 CheckedTrb = (TRB_TEMPLATE *)(UINTN) UsbHcGetHostAddrForPciAddr (Xhc->MemPool, (VOID *)(UINTN) PhyAddr, sizeof (TRB_TEMPLATE));
1016 ASSERT (CheckedTrb == Urb->Ring->RingSeg0);
1017 }
1018 }
1019
1020 return FALSE;
1021 }
1022
1023 /**
1024 Check if the Trb is a transaction of the URBs in XHCI's asynchronous transfer list.
1025
1026 @param Xhc The XHCI Instance.
1027 @param Trb The TRB to be checked.
1028 @param Urb The pointer to the matched Urb.
1029
1030 @retval TRUE The Trb is matched with a transaction of the URBs in the async list.
1031 @retval FALSE The Trb is not matched with any URBs in the async list.
1032
1033 **/
1034 BOOLEAN
1035 IsAsyncIntTrb (
1036 IN USB_XHCI_INSTANCE *Xhc,
1037 IN TRB_TEMPLATE *Trb,
1038 OUT URB **Urb
1039 )
1040 {
1041 LIST_ENTRY *Entry;
1042 LIST_ENTRY *Next;
1043 URB *CheckedUrb;
1044
1045 EFI_LIST_FOR_EACH_SAFE (Entry, Next, &Xhc->AsyncIntTransfers) {
1046 CheckedUrb = EFI_LIST_CONTAINER (Entry, URB, UrbList);
1047 if (IsTransferRingTrb (Xhc, Trb, CheckedUrb)) {
1048 *Urb = CheckedUrb;
1049 return TRUE;
1050 }
1051 }
1052
1053 return FALSE;
1054 }
1055
1056
1057 /**
1058 Check the URB's execution result and update the URB's
1059 result accordingly.
1060
1061 @param Xhc The XHCI Instance.
1062 @param Urb The URB to check result.
1063
1064 @return Whether the result of URB transfer is finialized.
1065
1066 **/
1067 BOOLEAN
1068 XhcCheckUrbResult (
1069 IN USB_XHCI_INSTANCE *Xhc,
1070 IN URB *Urb
1071 )
1072 {
1073 EVT_TRB_TRANSFER *EvtTrb;
1074 TRB_TEMPLATE *TRBPtr;
1075 UINTN Index;
1076 UINT8 TRBType;
1077 EFI_STATUS Status;
1078 URB *AsyncUrb;
1079 URB *CheckedUrb;
1080 UINT64 XhcDequeue;
1081 UINT32 High;
1082 UINT32 Low;
1083 EFI_PHYSICAL_ADDRESS PhyAddr;
1084
1085 ASSERT ((Xhc != NULL) && (Urb != NULL));
1086
1087 Status = EFI_SUCCESS;
1088 AsyncUrb = NULL;
1089
1090 if (Urb->Finished) {
1091 goto EXIT;
1092 }
1093
1094 EvtTrb = NULL;
1095
1096 if (XhcIsHalt (Xhc) || XhcIsSysError (Xhc)) {
1097 Urb->Result |= EFI_USB_ERR_SYSTEM;
1098 goto EXIT;
1099 }
1100
1101 //
1102 // Traverse the event ring to find out all new events from the previous check.
1103 //
1104 XhcSyncEventRing (Xhc, &Xhc->EventRing);
1105 for (Index = 0; Index < Xhc->EventRing.TrbNumber; Index++) {
1106 Status = XhcCheckNewEvent (Xhc, &Xhc->EventRing, ((TRB_TEMPLATE **)&EvtTrb));
1107 if (Status == EFI_NOT_READY) {
1108 //
1109 // All new events are handled, return directly.
1110 //
1111 goto EXIT;
1112 }
1113
1114 //
1115 // Only handle COMMAND_COMPLETETION_EVENT and TRANSFER_EVENT.
1116 //
1117 if ((EvtTrb->Type != TRB_TYPE_COMMAND_COMPLT_EVENT) && (EvtTrb->Type != TRB_TYPE_TRANS_EVENT)) {
1118 continue;
1119 }
1120
1121 //
1122 // Need convert pci device address to host address
1123 //
1124 PhyAddr = (EFI_PHYSICAL_ADDRESS)(EvtTrb->TRBPtrLo | LShiftU64 ((UINT64) EvtTrb->TRBPtrHi, 32));
1125 TRBPtr = (TRB_TEMPLATE *)(UINTN) UsbHcGetHostAddrForPciAddr (Xhc->MemPool, (VOID *)(UINTN) PhyAddr, sizeof (TRB_TEMPLATE));
1126
1127 //
1128 // Update the status of Urb according to the finished event regardless of whether
1129 // the urb is current checked one or in the XHCI's async transfer list.
1130 // This way is used to avoid that those completed async transfer events don't get
1131 // handled in time and are flushed by newer coming events.
1132 //
1133 if (IsTransferRingTrb (Xhc, TRBPtr, Urb)) {
1134 CheckedUrb = Urb;
1135 } else if (IsAsyncIntTrb (Xhc, TRBPtr, &AsyncUrb)) {
1136 CheckedUrb = AsyncUrb;
1137 } else {
1138 continue;
1139 }
1140
1141 switch (EvtTrb->Completecode) {
1142 case TRB_COMPLETION_STALL_ERROR:
1143 CheckedUrb->Result |= EFI_USB_ERR_STALL;
1144 CheckedUrb->Finished = TRUE;
1145 DEBUG ((EFI_D_ERROR, "XhcCheckUrbResult: STALL_ERROR! Completecode = %x\n",EvtTrb->Completecode));
1146 goto EXIT;
1147
1148 case TRB_COMPLETION_BABBLE_ERROR:
1149 CheckedUrb->Result |= EFI_USB_ERR_BABBLE;
1150 CheckedUrb->Finished = TRUE;
1151 DEBUG ((EFI_D_ERROR, "XhcCheckUrbResult: BABBLE_ERROR! Completecode = %x\n",EvtTrb->Completecode));
1152 goto EXIT;
1153
1154 case TRB_COMPLETION_DATA_BUFFER_ERROR:
1155 CheckedUrb->Result |= EFI_USB_ERR_BUFFER;
1156 CheckedUrb->Finished = TRUE;
1157 DEBUG ((EFI_D_ERROR, "XhcCheckUrbResult: ERR_BUFFER! Completecode = %x\n",EvtTrb->Completecode));
1158 goto EXIT;
1159
1160 case TRB_COMPLETION_USB_TRANSACTION_ERROR:
1161 CheckedUrb->Result |= EFI_USB_ERR_TIMEOUT;
1162 CheckedUrb->Finished = TRUE;
1163 DEBUG ((EFI_D_ERROR, "XhcCheckUrbResult: TRANSACTION_ERROR! Completecode = %x\n",EvtTrb->Completecode));
1164 goto EXIT;
1165
1166 case TRB_COMPLETION_SHORT_PACKET:
1167 case TRB_COMPLETION_SUCCESS:
1168 if (EvtTrb->Completecode == TRB_COMPLETION_SHORT_PACKET) {
1169 DEBUG ((EFI_D_VERBOSE, "XhcCheckUrbResult: short packet happens!\n"));
1170 }
1171
1172 TRBType = (UINT8) (TRBPtr->Type);
1173 if ((TRBType == TRB_TYPE_DATA_STAGE) ||
1174 (TRBType == TRB_TYPE_NORMAL) ||
1175 (TRBType == TRB_TYPE_ISOCH)) {
1176 CheckedUrb->Completed += (((TRANSFER_TRB_NORMAL*)TRBPtr)->Length - EvtTrb->Length);
1177 }
1178
1179 break;
1180
1181 default:
1182 DEBUG ((EFI_D_ERROR, "Transfer Default Error Occur! Completecode = 0x%x!\n",EvtTrb->Completecode));
1183 CheckedUrb->Result |= EFI_USB_ERR_TIMEOUT;
1184 CheckedUrb->Finished = TRUE;
1185 goto EXIT;
1186 }
1187
1188 //
1189 // Only check first and end Trb event address
1190 //
1191 if (TRBPtr == CheckedUrb->TrbStart) {
1192 CheckedUrb->StartDone = TRUE;
1193 }
1194
1195 if (TRBPtr == CheckedUrb->TrbEnd) {
1196 CheckedUrb->EndDone = TRUE;
1197 }
1198
1199 if (CheckedUrb->StartDone && CheckedUrb->EndDone) {
1200 CheckedUrb->Finished = TRUE;
1201 CheckedUrb->EvtTrb = (TRB_TEMPLATE *)EvtTrb;
1202 }
1203 }
1204
1205 EXIT:
1206
1207 //
1208 // Advance event ring to last available entry
1209 //
1210 // Some 3rd party XHCI external cards don't support single 64-bytes width register access,
1211 // So divide it to two 32-bytes width register access.
1212 //
1213 Low = XhcReadRuntimeReg (Xhc, XHC_ERDP_OFFSET);
1214 High = XhcReadRuntimeReg (Xhc, XHC_ERDP_OFFSET + 4);
1215 XhcDequeue = (UINT64)(LShiftU64((UINT64)High, 32) | Low);
1216
1217 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, Xhc->EventRing.EventRingDequeue, sizeof (TRB_TEMPLATE));
1218
1219 if ((XhcDequeue & (~0x0F)) != (PhyAddr & (~0x0F))) {
1220 //
1221 // Some 3rd party XHCI external cards don't support single 64-bytes width register access,
1222 // So divide it to two 32-bytes width register access.
1223 //
1224 XhcWriteRuntimeReg (Xhc, XHC_ERDP_OFFSET, XHC_LOW_32BIT (PhyAddr) | BIT3);
1225 XhcWriteRuntimeReg (Xhc, XHC_ERDP_OFFSET + 4, XHC_HIGH_32BIT (PhyAddr));
1226 }
1227
1228 return Urb->Finished;
1229 }
1230
1231
1232 /**
1233 Execute the transfer by polling the URB. This is a synchronous operation.
1234
1235 @param Xhc The XHCI Instance.
1236 @param CmdTransfer The executed URB is for cmd transfer or not.
1237 @param Urb The URB to execute.
1238 @param Timeout The time to wait before abort, in millisecond.
1239
1240 @return EFI_DEVICE_ERROR The transfer failed due to transfer error.
1241 @return EFI_TIMEOUT The transfer failed due to time out.
1242 @return EFI_SUCCESS The transfer finished OK.
1243
1244 **/
1245 EFI_STATUS
1246 XhcExecTransfer (
1247 IN USB_XHCI_INSTANCE *Xhc,
1248 IN BOOLEAN CmdTransfer,
1249 IN URB *Urb,
1250 IN UINTN Timeout
1251 )
1252 {
1253 EFI_STATUS Status;
1254 UINTN Index;
1255 UINT64 Loop;
1256 UINT8 SlotId;
1257 UINT8 Dci;
1258 BOOLEAN Finished;
1259
1260 if (CmdTransfer) {
1261 SlotId = 0;
1262 Dci = 0;
1263 } else {
1264 SlotId = XhcBusDevAddrToSlotId (Xhc, Urb->Ep.BusAddr);
1265 if (SlotId == 0) {
1266 return EFI_DEVICE_ERROR;
1267 }
1268 Dci = XhcEndpointToDci (Urb->Ep.EpAddr, (UINT8)(Urb->Ep.Direction));
1269 ASSERT (Dci < 32);
1270 }
1271
1272 Status = EFI_SUCCESS;
1273 Loop = Timeout * XHC_1_MILLISECOND;
1274 if (Timeout == 0) {
1275 Loop = 0xFFFFFFFF;
1276 }
1277
1278 XhcRingDoorBell (Xhc, SlotId, Dci);
1279
1280 for (Index = 0; Index < Loop; Index++) {
1281 Finished = XhcCheckUrbResult (Xhc, Urb);
1282 if (Finished) {
1283 break;
1284 }
1285 gBS->Stall (XHC_1_MICROSECOND);
1286 }
1287
1288 if (Index == Loop) {
1289 Urb->Result = EFI_USB_ERR_TIMEOUT;
1290 Status = EFI_TIMEOUT;
1291 } else if (Urb->Result != EFI_USB_NOERROR) {
1292 Status = EFI_DEVICE_ERROR;
1293 }
1294
1295 return Status;
1296 }
1297
1298 /**
1299 Delete a single asynchronous interrupt transfer for
1300 the device and endpoint.
1301
1302 @param Xhc The XHCI Instance.
1303 @param BusAddr The logical device address assigned by UsbBus driver.
1304 @param EpNum The endpoint of the target.
1305
1306 @retval EFI_SUCCESS An asynchronous transfer is removed.
1307 @retval EFI_NOT_FOUND No transfer for the device is found.
1308
1309 **/
1310 EFI_STATUS
1311 XhciDelAsyncIntTransfer (
1312 IN USB_XHCI_INSTANCE *Xhc,
1313 IN UINT8 BusAddr,
1314 IN UINT8 EpNum
1315 )
1316 {
1317 LIST_ENTRY *Entry;
1318 LIST_ENTRY *Next;
1319 URB *Urb;
1320 EFI_USB_DATA_DIRECTION Direction;
1321 EFI_STATUS Status;
1322
1323 Direction = ((EpNum & 0x80) != 0) ? EfiUsbDataIn : EfiUsbDataOut;
1324 EpNum &= 0x0F;
1325
1326 Urb = NULL;
1327
1328 EFI_LIST_FOR_EACH_SAFE (Entry, Next, &Xhc->AsyncIntTransfers) {
1329 Urb = EFI_LIST_CONTAINER (Entry, URB, UrbList);
1330 if ((Urb->Ep.BusAddr == BusAddr) &&
1331 (Urb->Ep.EpAddr == EpNum) &&
1332 (Urb->Ep.Direction == Direction)) {
1333 //
1334 // Device doesn't finish the IntTransfer until real data comes
1335 // So the TRB should be removed as well.
1336 //
1337 Status = XhcDequeueTrbFromEndpoint (Xhc, Urb);
1338 if (EFI_ERROR (Status)) {
1339 DEBUG ((EFI_D_ERROR, "XhciDelAsyncIntTransfer: XhcDequeueTrbFromEndpoint failed\n"));
1340 }
1341
1342 RemoveEntryList (&Urb->UrbList);
1343 FreePool (Urb->Data);
1344 XhcFreeUrb (Xhc, Urb);
1345 return EFI_SUCCESS;
1346 }
1347 }
1348
1349 return EFI_NOT_FOUND;
1350 }
1351
1352 /**
1353 Remove all the asynchronous interrutp transfers.
1354
1355 @param Xhc The XHCI Instance.
1356
1357 **/
1358 VOID
1359 XhciDelAllAsyncIntTransfers (
1360 IN USB_XHCI_INSTANCE *Xhc
1361 )
1362 {
1363 LIST_ENTRY *Entry;
1364 LIST_ENTRY *Next;
1365 URB *Urb;
1366 EFI_STATUS Status;
1367
1368 EFI_LIST_FOR_EACH_SAFE (Entry, Next, &Xhc->AsyncIntTransfers) {
1369 Urb = EFI_LIST_CONTAINER (Entry, URB, UrbList);
1370
1371 //
1372 // Device doesn't finish the IntTransfer until real data comes
1373 // So the TRB should be removed as well.
1374 //
1375 Status = XhcDequeueTrbFromEndpoint (Xhc, Urb);
1376 if (EFI_ERROR (Status)) {
1377 DEBUG ((EFI_D_ERROR, "XhciDelAllAsyncIntTransfers: XhcDequeueTrbFromEndpoint failed\n"));
1378 }
1379
1380 RemoveEntryList (&Urb->UrbList);
1381 FreePool (Urb->Data);
1382 XhcFreeUrb (Xhc, Urb);
1383 }
1384 }
1385
1386 /**
1387 Update the queue head for next round of asynchronous transfer
1388
1389 @param Xhc The XHCI Instance.
1390 @param Urb The URB to update
1391
1392 **/
1393 VOID
1394 XhcUpdateAsyncRequest (
1395 IN USB_XHCI_INSTANCE *Xhc,
1396 IN URB *Urb
1397 )
1398 {
1399 EFI_STATUS Status;
1400
1401 if (Urb->Result == EFI_USB_NOERROR) {
1402 Status = XhcCreateTransferTrb (Xhc, Urb);
1403 if (EFI_ERROR (Status)) {
1404 return;
1405 }
1406 Status = RingIntTransferDoorBell (Xhc, Urb);
1407 if (EFI_ERROR (Status)) {
1408 return;
1409 }
1410 }
1411 }
1412
1413 /**
1414 Flush data from PCI controller specific address to mapped system
1415 memory address.
1416
1417 @param Xhc The XHCI device.
1418 @param Urb The URB to unmap.
1419
1420 @retval EFI_SUCCESS Success to flush data to mapped system memory.
1421 @retval EFI_DEVICE_ERROR Fail to flush data to mapped system memory.
1422
1423 **/
1424 EFI_STATUS
1425 XhcFlushAsyncIntMap (
1426 IN USB_XHCI_INSTANCE *Xhc,
1427 IN URB *Urb
1428 )
1429 {
1430 EFI_STATUS Status;
1431 EFI_PHYSICAL_ADDRESS PhyAddr;
1432 EFI_PCI_IO_PROTOCOL_OPERATION MapOp;
1433 EFI_PCI_IO_PROTOCOL *PciIo;
1434 UINTN Len;
1435 VOID *Map;
1436
1437 PciIo = Xhc->PciIo;
1438 Len = Urb->DataLen;
1439
1440 if (Urb->Ep.Direction == EfiUsbDataIn) {
1441 MapOp = EfiPciIoOperationBusMasterWrite;
1442 } else {
1443 MapOp = EfiPciIoOperationBusMasterRead;
1444 }
1445
1446 if (Urb->DataMap != NULL) {
1447 Status = PciIo->Unmap (PciIo, Urb->DataMap);
1448 if (EFI_ERROR (Status)) {
1449 goto ON_ERROR;
1450 }
1451 }
1452
1453 Urb->DataMap = NULL;
1454
1455 Status = PciIo->Map (PciIo, MapOp, Urb->Data, &Len, &PhyAddr, &Map);
1456 if (EFI_ERROR (Status) || (Len != Urb->DataLen)) {
1457 goto ON_ERROR;
1458 }
1459
1460 Urb->DataPhy = (VOID *) ((UINTN) PhyAddr);
1461 Urb->DataMap = Map;
1462 return EFI_SUCCESS;
1463
1464 ON_ERROR:
1465 return EFI_DEVICE_ERROR;
1466 }
1467
1468 /**
1469 Interrupt transfer periodic check handler.
1470
1471 @param Event Interrupt event.
1472 @param Context Pointer to USB_XHCI_INSTANCE.
1473
1474 **/
1475 VOID
1476 EFIAPI
1477 XhcMonitorAsyncRequests (
1478 IN EFI_EVENT Event,
1479 IN VOID *Context
1480 )
1481 {
1482 USB_XHCI_INSTANCE *Xhc;
1483 LIST_ENTRY *Entry;
1484 LIST_ENTRY *Next;
1485 UINT8 *ProcBuf;
1486 URB *Urb;
1487 UINT8 SlotId;
1488 EFI_STATUS Status;
1489 EFI_TPL OldTpl;
1490
1491 OldTpl = gBS->RaiseTPL (XHC_TPL);
1492
1493 Xhc = (USB_XHCI_INSTANCE*) Context;
1494
1495 EFI_LIST_FOR_EACH_SAFE (Entry, Next, &Xhc->AsyncIntTransfers) {
1496 Urb = EFI_LIST_CONTAINER (Entry, URB, UrbList);
1497
1498 //
1499 // Make sure that the device is available before every check.
1500 //
1501 SlotId = XhcBusDevAddrToSlotId (Xhc, Urb->Ep.BusAddr);
1502 if (SlotId == 0) {
1503 continue;
1504 }
1505
1506 //
1507 // Check the result of URB execution. If it is still
1508 // active, check the next one.
1509 //
1510 XhcCheckUrbResult (Xhc, Urb);
1511
1512 if (!Urb->Finished) {
1513 continue;
1514 }
1515
1516 //
1517 // Flush any PCI posted write transactions from a PCI host
1518 // bridge to system memory.
1519 //
1520 Status = XhcFlushAsyncIntMap (Xhc, Urb);
1521 if (EFI_ERROR (Status)) {
1522 DEBUG ((EFI_D_ERROR, "XhcMonitorAsyncRequests: Fail to Flush AsyncInt Mapped Memeory\n"));
1523 }
1524
1525 //
1526 // Allocate a buffer then copy the transferred data for user.
1527 // If failed to allocate the buffer, update the URB for next
1528 // round of transfer. Ignore the data of this round.
1529 //
1530 ProcBuf = NULL;
1531 if (Urb->Result == EFI_USB_NOERROR) {
1532 ASSERT (Urb->Completed <= Urb->DataLen);
1533
1534 ProcBuf = AllocateZeroPool (Urb->Completed);
1535
1536 if (ProcBuf == NULL) {
1537 XhcUpdateAsyncRequest (Xhc, Urb);
1538 continue;
1539 }
1540
1541 CopyMem (ProcBuf, Urb->Data, Urb->Completed);
1542 }
1543
1544 //
1545 // Leave error recovery to its related device driver. A
1546 // common case of the error recovery is to re-submit the
1547 // interrupt transfer which is linked to the head of the
1548 // list. This function scans from head to tail. So the
1549 // re-submitted interrupt transfer's callback function
1550 // will not be called again in this round. Don't touch this
1551 // URB after the callback, it may have been removed by the
1552 // callback.
1553 //
1554 if (Urb->Callback != NULL) {
1555 //
1556 // Restore the old TPL, USB bus maybe connect device in
1557 // his callback. Some drivers may has a lower TPL restriction.
1558 //
1559 gBS->RestoreTPL (OldTpl);
1560 (Urb->Callback) (ProcBuf, Urb->Completed, Urb->Context, Urb->Result);
1561 OldTpl = gBS->RaiseTPL (XHC_TPL);
1562 }
1563
1564 if (ProcBuf != NULL) {
1565 gBS->FreePool (ProcBuf);
1566 }
1567
1568 XhcUpdateAsyncRequest (Xhc, Urb);
1569 }
1570 gBS->RestoreTPL (OldTpl);
1571 }
1572
1573 /**
1574 Monitor the port status change. Enable/Disable device slot if there is a device attached/detached.
1575
1576 @param Xhc The XHCI Instance.
1577 @param ParentRouteChart The route string pointed to the parent device if it exists.
1578 @param Port The port to be polled.
1579 @param PortState The port state.
1580
1581 @retval EFI_SUCCESS Successfully enable/disable device slot according to port state.
1582 @retval Others Should not appear.
1583
1584 **/
1585 EFI_STATUS
1586 EFIAPI
1587 XhcPollPortStatusChange (
1588 IN USB_XHCI_INSTANCE *Xhc,
1589 IN USB_DEV_ROUTE ParentRouteChart,
1590 IN UINT8 Port,
1591 IN EFI_USB_PORT_STATUS *PortState
1592 )
1593 {
1594 EFI_STATUS Status;
1595 UINT8 Speed;
1596 UINT8 SlotId;
1597 USB_DEV_ROUTE RouteChart;
1598
1599 Status = EFI_SUCCESS;
1600
1601 if ((PortState->PortChangeStatus & (USB_PORT_STAT_C_CONNECTION | USB_PORT_STAT_C_ENABLE | USB_PORT_STAT_C_OVERCURRENT | USB_PORT_STAT_C_RESET)) == 0) {
1602 return EFI_SUCCESS;
1603 }
1604
1605 if (ParentRouteChart.Dword == 0) {
1606 RouteChart.Route.RouteString = 0;
1607 RouteChart.Route.RootPortNum = Port + 1;
1608 RouteChart.Route.TierNum = 1;
1609 } else {
1610 if(Port < 14) {
1611 RouteChart.Route.RouteString = ParentRouteChart.Route.RouteString | (Port << (4 * (ParentRouteChart.Route.TierNum - 1)));
1612 } else {
1613 RouteChart.Route.RouteString = ParentRouteChart.Route.RouteString | (15 << (4 * (ParentRouteChart.Route.TierNum - 1)));
1614 }
1615 RouteChart.Route.RootPortNum = ParentRouteChart.Route.RootPortNum;
1616 RouteChart.Route.TierNum = ParentRouteChart.Route.TierNum + 1;
1617 }
1618
1619 SlotId = XhcRouteStringToSlotId (Xhc, RouteChart);
1620 if (SlotId != 0) {
1621 if (Xhc->HcCParams.Data.Csz == 0) {
1622 Status = XhcDisableSlotCmd (Xhc, SlotId);
1623 } else {
1624 Status = XhcDisableSlotCmd64 (Xhc, SlotId);
1625 }
1626 }
1627
1628 if (((PortState->PortStatus & USB_PORT_STAT_ENABLE) != 0) &&
1629 ((PortState->PortStatus & USB_PORT_STAT_CONNECTION) != 0)) {
1630 //
1631 // Has a device attached, Identify device speed after port is enabled.
1632 //
1633 Speed = EFI_USB_SPEED_FULL;
1634 if ((PortState->PortStatus & USB_PORT_STAT_LOW_SPEED) != 0) {
1635 Speed = EFI_USB_SPEED_LOW;
1636 } else if ((PortState->PortStatus & USB_PORT_STAT_HIGH_SPEED) != 0) {
1637 Speed = EFI_USB_SPEED_HIGH;
1638 } else if ((PortState->PortStatus & USB_PORT_STAT_SUPER_SPEED) != 0) {
1639 Speed = EFI_USB_SPEED_SUPER;
1640 }
1641 //
1642 // Execute Enable_Slot cmd for attached device, initialize device context and assign device address.
1643 //
1644 SlotId = XhcRouteStringToSlotId (Xhc, RouteChart);
1645 if ((SlotId == 0) && ((PortState->PortChangeStatus & USB_PORT_STAT_C_RESET) != 0)) {
1646 if (Xhc->HcCParams.Data.Csz == 0) {
1647 Status = XhcInitializeDeviceSlot (Xhc, ParentRouteChart, Port, RouteChart, Speed);
1648 } else {
1649 Status = XhcInitializeDeviceSlot64 (Xhc, ParentRouteChart, Port, RouteChart, Speed);
1650 }
1651 }
1652 }
1653
1654 return Status;
1655 }
1656
1657
1658 /**
1659 Calculate the device context index by endpoint address and direction.
1660
1661 @param EpAddr The target endpoint number.
1662 @param Direction The direction of the target endpoint.
1663
1664 @return The device context index of endpoint.
1665
1666 **/
1667 UINT8
1668 XhcEndpointToDci (
1669 IN UINT8 EpAddr,
1670 IN UINT8 Direction
1671 )
1672 {
1673 UINT8 Index;
1674
1675 if (EpAddr == 0) {
1676 return 1;
1677 } else {
1678 Index = (UINT8) (2 * EpAddr);
1679 if (Direction == EfiUsbDataIn) {
1680 Index += 1;
1681 }
1682 return Index;
1683 }
1684 }
1685
1686 /**
1687 Find out the actual device address according to the requested device address from UsbBus.
1688
1689 @param Xhc The XHCI Instance.
1690 @param BusDevAddr The requested device address by UsbBus upper driver.
1691
1692 @return The actual device address assigned to the device.
1693
1694 **/
1695 UINT8
1696 EFIAPI
1697 XhcBusDevAddrToSlotId (
1698 IN USB_XHCI_INSTANCE *Xhc,
1699 IN UINT8 BusDevAddr
1700 )
1701 {
1702 UINT8 Index;
1703
1704 for (Index = 0; Index < 255; Index++) {
1705 if (Xhc->UsbDevContext[Index + 1].Enabled &&
1706 (Xhc->UsbDevContext[Index + 1].SlotId != 0) &&
1707 (Xhc->UsbDevContext[Index + 1].BusDevAddr == BusDevAddr)) {
1708 break;
1709 }
1710 }
1711
1712 if (Index == 255) {
1713 return 0;
1714 }
1715
1716 return Xhc->UsbDevContext[Index + 1].SlotId;
1717 }
1718
1719 /**
1720 Find out the slot id according to the device's route string.
1721
1722 @param Xhc The XHCI Instance.
1723 @param RouteString The route string described the device location.
1724
1725 @return The slot id used by the device.
1726
1727 **/
1728 UINT8
1729 EFIAPI
1730 XhcRouteStringToSlotId (
1731 IN USB_XHCI_INSTANCE *Xhc,
1732 IN USB_DEV_ROUTE RouteString
1733 )
1734 {
1735 UINT8 Index;
1736
1737 for (Index = 0; Index < 255; Index++) {
1738 if (Xhc->UsbDevContext[Index + 1].Enabled &&
1739 (Xhc->UsbDevContext[Index + 1].SlotId != 0) &&
1740 (Xhc->UsbDevContext[Index + 1].RouteString.Dword == RouteString.Dword)) {
1741 break;
1742 }
1743 }
1744
1745 if (Index == 255) {
1746 return 0;
1747 }
1748
1749 return Xhc->UsbDevContext[Index + 1].SlotId;
1750 }
1751
1752 /**
1753 Synchronize the specified event ring to update the enqueue and dequeue pointer.
1754
1755 @param Xhc The XHCI Instance.
1756 @param EvtRing The event ring to sync.
1757
1758 @retval EFI_SUCCESS The event ring is synchronized successfully.
1759
1760 **/
1761 EFI_STATUS
1762 EFIAPI
1763 XhcSyncEventRing (
1764 IN USB_XHCI_INSTANCE *Xhc,
1765 IN EVENT_RING *EvtRing
1766 )
1767 {
1768 UINTN Index;
1769 TRB_TEMPLATE *EvtTrb1;
1770
1771 ASSERT (EvtRing != NULL);
1772
1773 //
1774 // Calculate the EventRingEnqueue and EventRingCCS.
1775 // Note: only support single Segment
1776 //
1777 EvtTrb1 = EvtRing->EventRingDequeue;
1778
1779 for (Index = 0; Index < EvtRing->TrbNumber; Index++) {
1780 if (EvtTrb1->CycleBit != EvtRing->EventRingCCS) {
1781 break;
1782 }
1783
1784 EvtTrb1++;
1785
1786 if ((UINTN)EvtTrb1 >= ((UINTN) EvtRing->EventRingSeg0 + sizeof (TRB_TEMPLATE) * EvtRing->TrbNumber)) {
1787 EvtTrb1 = EvtRing->EventRingSeg0;
1788 EvtRing->EventRingCCS = (EvtRing->EventRingCCS) ? 0 : 1;
1789 }
1790 }
1791
1792 if (Index < EvtRing->TrbNumber) {
1793 EvtRing->EventRingEnqueue = EvtTrb1;
1794 } else {
1795 ASSERT (FALSE);
1796 }
1797
1798 return EFI_SUCCESS;
1799 }
1800
1801 /**
1802 Synchronize the specified transfer ring to update the enqueue and dequeue pointer.
1803
1804 @param Xhc The XHCI Instance.
1805 @param TrsRing The transfer ring to sync.
1806
1807 @retval EFI_SUCCESS The transfer ring is synchronized successfully.
1808
1809 **/
1810 EFI_STATUS
1811 EFIAPI
1812 XhcSyncTrsRing (
1813 IN USB_XHCI_INSTANCE *Xhc,
1814 IN TRANSFER_RING *TrsRing
1815 )
1816 {
1817 UINTN Index;
1818 TRB_TEMPLATE *TrsTrb;
1819
1820 ASSERT (TrsRing != NULL);
1821 //
1822 // Calculate the latest RingEnqueue and RingPCS
1823 //
1824 TrsTrb = TrsRing->RingEnqueue;
1825 ASSERT (TrsTrb != NULL);
1826
1827 for (Index = 0; Index < TrsRing->TrbNumber; Index++) {
1828 if (TrsTrb->CycleBit != (TrsRing->RingPCS & BIT0)) {
1829 break;
1830 }
1831 TrsTrb++;
1832 if ((UINT8) TrsTrb->Type == TRB_TYPE_LINK) {
1833 ASSERT (((LINK_TRB*)TrsTrb)->TC != 0);
1834 //
1835 // set cycle bit in Link TRB as normal
1836 //
1837 ((LINK_TRB*)TrsTrb)->CycleBit = TrsRing->RingPCS & BIT0;
1838 //
1839 // Toggle PCS maintained by software
1840 //
1841 TrsRing->RingPCS = (TrsRing->RingPCS & BIT0) ? 0 : 1;
1842 TrsTrb = (TRB_TEMPLATE *) TrsRing->RingSeg0; // Use host address
1843 }
1844 }
1845
1846 ASSERT (Index != TrsRing->TrbNumber);
1847
1848 if (TrsTrb != TrsRing->RingEnqueue) {
1849 TrsRing->RingEnqueue = TrsTrb;
1850 }
1851
1852 //
1853 // Clear the Trb context for enqueue, but reserve the PCS bit
1854 //
1855 TrsTrb->Parameter1 = 0;
1856 TrsTrb->Parameter2 = 0;
1857 TrsTrb->Status = 0;
1858 TrsTrb->RsvdZ1 = 0;
1859 TrsTrb->Type = 0;
1860 TrsTrb->Control = 0;
1861
1862 return EFI_SUCCESS;
1863 }
1864
1865 /**
1866 Check if there is a new generated event.
1867
1868 @param Xhc The XHCI Instance.
1869 @param EvtRing The event ring to check.
1870 @param NewEvtTrb The new event TRB found.
1871
1872 @retval EFI_SUCCESS Found a new event TRB at the event ring.
1873 @retval EFI_NOT_READY The event ring has no new event.
1874
1875 **/
1876 EFI_STATUS
1877 EFIAPI
1878 XhcCheckNewEvent (
1879 IN USB_XHCI_INSTANCE *Xhc,
1880 IN EVENT_RING *EvtRing,
1881 OUT TRB_TEMPLATE **NewEvtTrb
1882 )
1883 {
1884 ASSERT (EvtRing != NULL);
1885
1886 *NewEvtTrb = EvtRing->EventRingDequeue;
1887
1888 if (EvtRing->EventRingDequeue == EvtRing->EventRingEnqueue) {
1889 return EFI_NOT_READY;
1890 }
1891
1892 EvtRing->EventRingDequeue++;
1893 //
1894 // If the dequeue pointer is beyond the ring, then roll-back it to the begining of the ring.
1895 //
1896 if ((UINTN)EvtRing->EventRingDequeue >= ((UINTN) EvtRing->EventRingSeg0 + sizeof (TRB_TEMPLATE) * EvtRing->TrbNumber)) {
1897 EvtRing->EventRingDequeue = EvtRing->EventRingSeg0;
1898 }
1899
1900 return EFI_SUCCESS;
1901 }
1902
1903 /**
1904 Ring the door bell to notify XHCI there is a transaction to be executed.
1905
1906 @param Xhc The XHCI Instance.
1907 @param SlotId The slot id of the target device.
1908 @param Dci The device context index of the target slot or endpoint.
1909
1910 @retval EFI_SUCCESS Successfully ring the door bell.
1911
1912 **/
1913 EFI_STATUS
1914 EFIAPI
1915 XhcRingDoorBell (
1916 IN USB_XHCI_INSTANCE *Xhc,
1917 IN UINT8 SlotId,
1918 IN UINT8 Dci
1919 )
1920 {
1921 if (SlotId == 0) {
1922 XhcWriteDoorBellReg (Xhc, 0, 0);
1923 } else {
1924 XhcWriteDoorBellReg (Xhc, SlotId * sizeof (UINT32), Dci);
1925 }
1926
1927 return EFI_SUCCESS;
1928 }
1929
1930 /**
1931 Ring the door bell to notify XHCI there is a transaction to be executed through URB.
1932
1933 @param Xhc The XHCI Instance.
1934 @param Urb The URB to be rung.
1935
1936 @retval EFI_SUCCESS Successfully ring the door bell.
1937
1938 **/
1939 EFI_STATUS
1940 RingIntTransferDoorBell (
1941 IN USB_XHCI_INSTANCE *Xhc,
1942 IN URB *Urb
1943 )
1944 {
1945 UINT8 SlotId;
1946 UINT8 Dci;
1947
1948 SlotId = XhcBusDevAddrToSlotId (Xhc, Urb->Ep.BusAddr);
1949 Dci = XhcEndpointToDci (Urb->Ep.EpAddr, (UINT8)(Urb->Ep.Direction));
1950 XhcRingDoorBell (Xhc, SlotId, Dci);
1951 return EFI_SUCCESS;
1952 }
1953
1954 /**
1955 Assign and initialize the device slot for a new device.
1956
1957 @param Xhc The XHCI Instance.
1958 @param ParentRouteChart The route string pointed to the parent device.
1959 @param ParentPort The port at which the device is located.
1960 @param RouteChart The route string pointed to the device.
1961 @param DeviceSpeed The device speed.
1962
1963 @retval EFI_SUCCESS Successfully assign a slot to the device and assign an address to it.
1964
1965 **/
1966 EFI_STATUS
1967 EFIAPI
1968 XhcInitializeDeviceSlot (
1969 IN USB_XHCI_INSTANCE *Xhc,
1970 IN USB_DEV_ROUTE ParentRouteChart,
1971 IN UINT16 ParentPort,
1972 IN USB_DEV_ROUTE RouteChart,
1973 IN UINT8 DeviceSpeed
1974 )
1975 {
1976 EFI_STATUS Status;
1977 EVT_TRB_COMMAND_COMPLETION *EvtTrb;
1978 INPUT_CONTEXT *InputContext;
1979 DEVICE_CONTEXT *OutputContext;
1980 TRANSFER_RING *EndpointTransferRing;
1981 CMD_TRB_ADDRESS_DEVICE CmdTrbAddr;
1982 UINT8 DeviceAddress;
1983 CMD_TRB_ENABLE_SLOT CmdTrb;
1984 UINT8 SlotId;
1985 UINT8 ParentSlotId;
1986 DEVICE_CONTEXT *ParentDeviceContext;
1987 EFI_PHYSICAL_ADDRESS PhyAddr;
1988
1989 ZeroMem (&CmdTrb, sizeof (CMD_TRB_ENABLE_SLOT));
1990 CmdTrb.CycleBit = 1;
1991 CmdTrb.Type = TRB_TYPE_EN_SLOT;
1992
1993 Status = XhcCmdTransfer (
1994 Xhc,
1995 (TRB_TEMPLATE *) (UINTN) &CmdTrb,
1996 XHC_GENERIC_TIMEOUT,
1997 (TRB_TEMPLATE **) (UINTN) &EvtTrb
1998 );
1999 if (EFI_ERROR (Status)) {
2000 DEBUG ((EFI_D_ERROR, "XhcInitializeDeviceSlot: Enable Slot Failed, Status = %r\n", Status));
2001 return Status;
2002 }
2003 ASSERT (EvtTrb->SlotId <= Xhc->MaxSlotsEn);
2004 DEBUG ((EFI_D_INFO, "Enable Slot Successfully, The Slot ID = 0x%x\n", EvtTrb->SlotId));
2005 SlotId = (UINT8)EvtTrb->SlotId;
2006 ASSERT (SlotId != 0);
2007
2008 ZeroMem (&Xhc->UsbDevContext[SlotId], sizeof (USB_DEV_CONTEXT));
2009 Xhc->UsbDevContext[SlotId].Enabled = TRUE;
2010 Xhc->UsbDevContext[SlotId].SlotId = SlotId;
2011 Xhc->UsbDevContext[SlotId].RouteString.Dword = RouteChart.Dword;
2012 Xhc->UsbDevContext[SlotId].ParentRouteString.Dword = ParentRouteChart.Dword;
2013
2014 //
2015 // 4.3.3 Device Slot Initialization
2016 // 1) Allocate an Input Context data structure (6.2.5) and initialize all fields to '0'.
2017 //
2018 InputContext = UsbHcAllocateMem (Xhc->MemPool, sizeof (INPUT_CONTEXT));
2019 ASSERT (InputContext != NULL);
2020 ASSERT (((UINTN) InputContext & 0x3F) == 0);
2021 ZeroMem (InputContext, sizeof (INPUT_CONTEXT));
2022
2023 Xhc->UsbDevContext[SlotId].InputContext = (VOID *) InputContext;
2024
2025 //
2026 // 2) Initialize the Input Control Context (6.2.5.1) of the Input Context by setting the A0 and A1
2027 // flags to '1'. These flags indicate that the Slot Context and the Endpoint 0 Context of the Input
2028 // Context are affected by the command.
2029 //
2030 InputContext->InputControlContext.Dword2 |= (BIT0 | BIT1);
2031
2032 //
2033 // 3) Initialize the Input Slot Context data structure
2034 //
2035 InputContext->Slot.RouteString = RouteChart.Route.RouteString;
2036 InputContext->Slot.Speed = DeviceSpeed + 1;
2037 InputContext->Slot.ContextEntries = 1;
2038 InputContext->Slot.RootHubPortNum = RouteChart.Route.RootPortNum;
2039
2040 if (RouteChart.Route.RouteString) {
2041 //
2042 // The device is behind of hub device.
2043 //
2044 ParentSlotId = XhcRouteStringToSlotId(Xhc, ParentRouteChart);
2045 ASSERT (ParentSlotId != 0);
2046 //
2047 //if the Full/Low device attached to a High Speed Hub, Init the TTPortNum and TTHubSlotId field of slot context
2048 //
2049 ParentDeviceContext = (DEVICE_CONTEXT *)Xhc->UsbDevContext[ParentSlotId].OutputContext;
2050 if ((ParentDeviceContext->Slot.TTPortNum == 0) &&
2051 (ParentDeviceContext->Slot.TTHubSlotId == 0)) {
2052 if ((ParentDeviceContext->Slot.Speed == (EFI_USB_SPEED_HIGH + 1)) && (DeviceSpeed < EFI_USB_SPEED_HIGH)) {
2053 //
2054 // Full/Low device attached to High speed hub port that isolates the high speed signaling
2055 // environment from Full/Low speed signaling environment for a device
2056 //
2057 InputContext->Slot.TTPortNum = ParentPort;
2058 InputContext->Slot.TTHubSlotId = ParentSlotId;
2059 }
2060 } else {
2061 //
2062 // Inherit the TT parameters from parent device.
2063 //
2064 InputContext->Slot.TTPortNum = ParentDeviceContext->Slot.TTPortNum;
2065 InputContext->Slot.TTHubSlotId = ParentDeviceContext->Slot.TTHubSlotId;
2066 //
2067 // If the device is a High speed device then down the speed to be the same as its parent Hub
2068 //
2069 if (DeviceSpeed == EFI_USB_SPEED_HIGH) {
2070 InputContext->Slot.Speed = ParentDeviceContext->Slot.Speed;
2071 }
2072 }
2073 }
2074
2075 //
2076 // 4) Allocate and initialize the Transfer Ring for the Default Control Endpoint.
2077 //
2078 EndpointTransferRing = AllocateZeroPool (sizeof (TRANSFER_RING));
2079 Xhc->UsbDevContext[SlotId].EndpointTransferRing[0] = EndpointTransferRing;
2080 CreateTransferRing(Xhc, TR_RING_TRB_NUMBER, (TRANSFER_RING *)Xhc->UsbDevContext[SlotId].EndpointTransferRing[0]);
2081 //
2082 // 5) Initialize the Input default control Endpoint 0 Context (6.2.3).
2083 //
2084 InputContext->EP[0].EPType = ED_CONTROL_BIDIR;
2085
2086 if (DeviceSpeed == EFI_USB_SPEED_SUPER) {
2087 InputContext->EP[0].MaxPacketSize = 512;
2088 } else if (DeviceSpeed == EFI_USB_SPEED_HIGH) {
2089 InputContext->EP[0].MaxPacketSize = 64;
2090 } else {
2091 InputContext->EP[0].MaxPacketSize = 8;
2092 }
2093 //
2094 // Initial value of Average TRB Length for Control endpoints would be 8B, Interrupt endpoints
2095 // 1KB, and Bulk and Isoch endpoints 3KB.
2096 //
2097 InputContext->EP[0].AverageTRBLength = 8;
2098 InputContext->EP[0].MaxBurstSize = 0;
2099 InputContext->EP[0].Interval = 0;
2100 InputContext->EP[0].MaxPStreams = 0;
2101 InputContext->EP[0].Mult = 0;
2102 InputContext->EP[0].CErr = 3;
2103
2104 //
2105 // Init the DCS(dequeue cycle state) as the transfer ring's CCS
2106 //
2107 PhyAddr = UsbHcGetPciAddrForHostAddr (
2108 Xhc->MemPool,
2109 ((TRANSFER_RING *)(UINTN)Xhc->UsbDevContext[SlotId].EndpointTransferRing[0])->RingSeg0,
2110 sizeof (TRB_TEMPLATE) * TR_RING_TRB_NUMBER
2111 );
2112 InputContext->EP[0].PtrLo = XHC_LOW_32BIT (PhyAddr) | BIT0;
2113 InputContext->EP[0].PtrHi = XHC_HIGH_32BIT (PhyAddr);
2114
2115 //
2116 // 6) Allocate the Output Device Context data structure (6.2.1) and initialize it to '0'.
2117 //
2118 OutputContext = UsbHcAllocateMem (Xhc->MemPool, sizeof (DEVICE_CONTEXT));
2119 ASSERT (OutputContext != NULL);
2120 ASSERT (((UINTN) OutputContext & 0x3F) == 0);
2121 ZeroMem (OutputContext, sizeof (DEVICE_CONTEXT));
2122
2123 Xhc->UsbDevContext[SlotId].OutputContext = OutputContext;
2124 //
2125 // 7) Load the appropriate (Device Slot ID) entry in the Device Context Base Address Array (5.4.6) with
2126 // a pointer to the Output Device Context data structure (6.2.1).
2127 //
2128 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, OutputContext, sizeof (DEVICE_CONTEXT));
2129 //
2130 // Fill DCBAA with PCI device address
2131 //
2132 Xhc->DCBAA[SlotId] = (UINT64) (UINTN) PhyAddr;
2133
2134 //
2135 // 8) Issue an Address Device Command for the Device Slot, where the command points to the Input
2136 // Context data structure described above.
2137 //
2138 // Delay 10ms to meet TRSTRCY delay requirement in usb 2.0 spec chapter 7.1.7.5 before sending SetAddress() request
2139 // to device.
2140 //
2141 gBS->Stall (XHC_RESET_RECOVERY_DELAY);
2142 ZeroMem (&CmdTrbAddr, sizeof (CmdTrbAddr));
2143 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, Xhc->UsbDevContext[SlotId].InputContext, sizeof (INPUT_CONTEXT));
2144 CmdTrbAddr.PtrLo = XHC_LOW_32BIT (PhyAddr);
2145 CmdTrbAddr.PtrHi = XHC_HIGH_32BIT (PhyAddr);
2146 CmdTrbAddr.CycleBit = 1;
2147 CmdTrbAddr.Type = TRB_TYPE_ADDRESS_DEV;
2148 CmdTrbAddr.SlotId = Xhc->UsbDevContext[SlotId].SlotId;
2149 Status = XhcCmdTransfer (
2150 Xhc,
2151 (TRB_TEMPLATE *) (UINTN) &CmdTrbAddr,
2152 XHC_GENERIC_TIMEOUT,
2153 (TRB_TEMPLATE **) (UINTN) &EvtTrb
2154 );
2155 if (!EFI_ERROR (Status)) {
2156 DeviceAddress = (UINT8) ((DEVICE_CONTEXT *) OutputContext)->Slot.DeviceAddress;
2157 DEBUG ((EFI_D_INFO, " Address %d assigned successfully\n", DeviceAddress));
2158 Xhc->UsbDevContext[SlotId].XhciDevAddr = DeviceAddress;
2159 }
2160
2161 return Status;
2162 }
2163
2164 /**
2165 Assign and initialize the device slot for a new device.
2166
2167 @param Xhc The XHCI Instance.
2168 @param ParentRouteChart The route string pointed to the parent device.
2169 @param ParentPort The port at which the device is located.
2170 @param RouteChart The route string pointed to the device.
2171 @param DeviceSpeed The device speed.
2172
2173 @retval EFI_SUCCESS Successfully assign a slot to the device and assign an address to it.
2174
2175 **/
2176 EFI_STATUS
2177 EFIAPI
2178 XhcInitializeDeviceSlot64 (
2179 IN USB_XHCI_INSTANCE *Xhc,
2180 IN USB_DEV_ROUTE ParentRouteChart,
2181 IN UINT16 ParentPort,
2182 IN USB_DEV_ROUTE RouteChart,
2183 IN UINT8 DeviceSpeed
2184 )
2185 {
2186 EFI_STATUS Status;
2187 EVT_TRB_COMMAND_COMPLETION *EvtTrb;
2188 INPUT_CONTEXT_64 *InputContext;
2189 DEVICE_CONTEXT_64 *OutputContext;
2190 TRANSFER_RING *EndpointTransferRing;
2191 CMD_TRB_ADDRESS_DEVICE CmdTrbAddr;
2192 UINT8 DeviceAddress;
2193 CMD_TRB_ENABLE_SLOT CmdTrb;
2194 UINT8 SlotId;
2195 UINT8 ParentSlotId;
2196 DEVICE_CONTEXT_64 *ParentDeviceContext;
2197 EFI_PHYSICAL_ADDRESS PhyAddr;
2198
2199 ZeroMem (&CmdTrb, sizeof (CMD_TRB_ENABLE_SLOT));
2200 CmdTrb.CycleBit = 1;
2201 CmdTrb.Type = TRB_TYPE_EN_SLOT;
2202
2203 Status = XhcCmdTransfer (
2204 Xhc,
2205 (TRB_TEMPLATE *) (UINTN) &CmdTrb,
2206 XHC_GENERIC_TIMEOUT,
2207 (TRB_TEMPLATE **) (UINTN) &EvtTrb
2208 );
2209 if (EFI_ERROR (Status)) {
2210 DEBUG ((EFI_D_ERROR, "XhcInitializeDeviceSlot64: Enable Slot Failed, Status = %r\n", Status));
2211 return Status;
2212 }
2213 ASSERT (EvtTrb->SlotId <= Xhc->MaxSlotsEn);
2214 DEBUG ((EFI_D_INFO, "Enable Slot Successfully, The Slot ID = 0x%x\n", EvtTrb->SlotId));
2215 SlotId = (UINT8)EvtTrb->SlotId;
2216 ASSERT (SlotId != 0);
2217
2218 ZeroMem (&Xhc->UsbDevContext[SlotId], sizeof (USB_DEV_CONTEXT));
2219 Xhc->UsbDevContext[SlotId].Enabled = TRUE;
2220 Xhc->UsbDevContext[SlotId].SlotId = SlotId;
2221 Xhc->UsbDevContext[SlotId].RouteString.Dword = RouteChart.Dword;
2222 Xhc->UsbDevContext[SlotId].ParentRouteString.Dword = ParentRouteChart.Dword;
2223
2224 //
2225 // 4.3.3 Device Slot Initialization
2226 // 1) Allocate an Input Context data structure (6.2.5) and initialize all fields to '0'.
2227 //
2228 InputContext = UsbHcAllocateMem (Xhc->MemPool, sizeof (INPUT_CONTEXT_64));
2229 ASSERT (InputContext != NULL);
2230 ASSERT (((UINTN) InputContext & 0x3F) == 0);
2231 ZeroMem (InputContext, sizeof (INPUT_CONTEXT_64));
2232
2233 Xhc->UsbDevContext[SlotId].InputContext = (VOID *) InputContext;
2234
2235 //
2236 // 2) Initialize the Input Control Context (6.2.5.1) of the Input Context by setting the A0 and A1
2237 // flags to '1'. These flags indicate that the Slot Context and the Endpoint 0 Context of the Input
2238 // Context are affected by the command.
2239 //
2240 InputContext->InputControlContext.Dword2 |= (BIT0 | BIT1);
2241
2242 //
2243 // 3) Initialize the Input Slot Context data structure
2244 //
2245 InputContext->Slot.RouteString = RouteChart.Route.RouteString;
2246 InputContext->Slot.Speed = DeviceSpeed + 1;
2247 InputContext->Slot.ContextEntries = 1;
2248 InputContext->Slot.RootHubPortNum = RouteChart.Route.RootPortNum;
2249
2250 if (RouteChart.Route.RouteString) {
2251 //
2252 // The device is behind of hub device.
2253 //
2254 ParentSlotId = XhcRouteStringToSlotId(Xhc, ParentRouteChart);
2255 ASSERT (ParentSlotId != 0);
2256 //
2257 //if the Full/Low device attached to a High Speed Hub, Init the TTPortNum and TTHubSlotId field of slot context
2258 //
2259 ParentDeviceContext = (DEVICE_CONTEXT_64 *)Xhc->UsbDevContext[ParentSlotId].OutputContext;
2260 if ((ParentDeviceContext->Slot.TTPortNum == 0) &&
2261 (ParentDeviceContext->Slot.TTHubSlotId == 0)) {
2262 if ((ParentDeviceContext->Slot.Speed == (EFI_USB_SPEED_HIGH + 1)) && (DeviceSpeed < EFI_USB_SPEED_HIGH)) {
2263 //
2264 // Full/Low device attached to High speed hub port that isolates the high speed signaling
2265 // environment from Full/Low speed signaling environment for a device
2266 //
2267 InputContext->Slot.TTPortNum = ParentPort;
2268 InputContext->Slot.TTHubSlotId = ParentSlotId;
2269 }
2270 } else {
2271 //
2272 // Inherit the TT parameters from parent device.
2273 //
2274 InputContext->Slot.TTPortNum = ParentDeviceContext->Slot.TTPortNum;
2275 InputContext->Slot.TTHubSlotId = ParentDeviceContext->Slot.TTHubSlotId;
2276 //
2277 // If the device is a High speed device then down the speed to be the same as its parent Hub
2278 //
2279 if (DeviceSpeed == EFI_USB_SPEED_HIGH) {
2280 InputContext->Slot.Speed = ParentDeviceContext->Slot.Speed;
2281 }
2282 }
2283 }
2284
2285 //
2286 // 4) Allocate and initialize the Transfer Ring for the Default Control Endpoint.
2287 //
2288 EndpointTransferRing = AllocateZeroPool (sizeof (TRANSFER_RING));
2289 Xhc->UsbDevContext[SlotId].EndpointTransferRing[0] = EndpointTransferRing;
2290 CreateTransferRing(Xhc, TR_RING_TRB_NUMBER, (TRANSFER_RING *)Xhc->UsbDevContext[SlotId].EndpointTransferRing[0]);
2291 //
2292 // 5) Initialize the Input default control Endpoint 0 Context (6.2.3).
2293 //
2294 InputContext->EP[0].EPType = ED_CONTROL_BIDIR;
2295
2296 if (DeviceSpeed == EFI_USB_SPEED_SUPER) {
2297 InputContext->EP[0].MaxPacketSize = 512;
2298 } else if (DeviceSpeed == EFI_USB_SPEED_HIGH) {
2299 InputContext->EP[0].MaxPacketSize = 64;
2300 } else {
2301 InputContext->EP[0].MaxPacketSize = 8;
2302 }
2303 //
2304 // Initial value of Average TRB Length for Control endpoints would be 8B, Interrupt endpoints
2305 // 1KB, and Bulk and Isoch endpoints 3KB.
2306 //
2307 InputContext->EP[0].AverageTRBLength = 8;
2308 InputContext->EP[0].MaxBurstSize = 0;
2309 InputContext->EP[0].Interval = 0;
2310 InputContext->EP[0].MaxPStreams = 0;
2311 InputContext->EP[0].Mult = 0;
2312 InputContext->EP[0].CErr = 3;
2313
2314 //
2315 // Init the DCS(dequeue cycle state) as the transfer ring's CCS
2316 //
2317 PhyAddr = UsbHcGetPciAddrForHostAddr (
2318 Xhc->MemPool,
2319 ((TRANSFER_RING *)(UINTN)Xhc->UsbDevContext[SlotId].EndpointTransferRing[0])->RingSeg0,
2320 sizeof (TRB_TEMPLATE) * TR_RING_TRB_NUMBER
2321 );
2322 InputContext->EP[0].PtrLo = XHC_LOW_32BIT (PhyAddr) | BIT0;
2323 InputContext->EP[0].PtrHi = XHC_HIGH_32BIT (PhyAddr);
2324
2325 //
2326 // 6) Allocate the Output Device Context data structure (6.2.1) and initialize it to '0'.
2327 //
2328 OutputContext = UsbHcAllocateMem (Xhc->MemPool, sizeof (DEVICE_CONTEXT_64));
2329 ASSERT (OutputContext != NULL);
2330 ASSERT (((UINTN) OutputContext & 0x3F) == 0);
2331 ZeroMem (OutputContext, sizeof (DEVICE_CONTEXT_64));
2332
2333 Xhc->UsbDevContext[SlotId].OutputContext = OutputContext;
2334 //
2335 // 7) Load the appropriate (Device Slot ID) entry in the Device Context Base Address Array (5.4.6) with
2336 // a pointer to the Output Device Context data structure (6.2.1).
2337 //
2338 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, OutputContext, sizeof (DEVICE_CONTEXT_64));
2339 //
2340 // Fill DCBAA with PCI device address
2341 //
2342 Xhc->DCBAA[SlotId] = (UINT64) (UINTN) PhyAddr;
2343
2344 //
2345 // 8) Issue an Address Device Command for the Device Slot, where the command points to the Input
2346 // Context data structure described above.
2347 //
2348 // Delay 10ms to meet TRSTRCY delay requirement in usb 2.0 spec chapter 7.1.7.5 before sending SetAddress() request
2349 // to device.
2350 //
2351 gBS->Stall (XHC_RESET_RECOVERY_DELAY);
2352 ZeroMem (&CmdTrbAddr, sizeof (CmdTrbAddr));
2353 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, Xhc->UsbDevContext[SlotId].InputContext, sizeof (INPUT_CONTEXT_64));
2354 CmdTrbAddr.PtrLo = XHC_LOW_32BIT (PhyAddr);
2355 CmdTrbAddr.PtrHi = XHC_HIGH_32BIT (PhyAddr);
2356 CmdTrbAddr.CycleBit = 1;
2357 CmdTrbAddr.Type = TRB_TYPE_ADDRESS_DEV;
2358 CmdTrbAddr.SlotId = Xhc->UsbDevContext[SlotId].SlotId;
2359 Status = XhcCmdTransfer (
2360 Xhc,
2361 (TRB_TEMPLATE *) (UINTN) &CmdTrbAddr,
2362 XHC_GENERIC_TIMEOUT,
2363 (TRB_TEMPLATE **) (UINTN) &EvtTrb
2364 );
2365 if (!EFI_ERROR (Status)) {
2366 DeviceAddress = (UINT8) ((DEVICE_CONTEXT_64 *) OutputContext)->Slot.DeviceAddress;
2367 DEBUG ((EFI_D_INFO, " Address %d assigned successfully\n", DeviceAddress));
2368 Xhc->UsbDevContext[SlotId].XhciDevAddr = DeviceAddress;
2369 }
2370 return Status;
2371 }
2372
2373
2374 /**
2375 Disable the specified device slot.
2376
2377 @param Xhc The XHCI Instance.
2378 @param SlotId The slot id to be disabled.
2379
2380 @retval EFI_SUCCESS Successfully disable the device slot.
2381
2382 **/
2383 EFI_STATUS
2384 EFIAPI
2385 XhcDisableSlotCmd (
2386 IN USB_XHCI_INSTANCE *Xhc,
2387 IN UINT8 SlotId
2388 )
2389 {
2390 EFI_STATUS Status;
2391 TRB_TEMPLATE *EvtTrb;
2392 CMD_TRB_DISABLE_SLOT CmdTrbDisSlot;
2393 UINT8 Index;
2394 VOID *RingSeg;
2395
2396 //
2397 // Disable the device slots occupied by these devices on its downstream ports.
2398 // Entry 0 is reserved.
2399 //
2400 for (Index = 0; Index < 255; Index++) {
2401 if (!Xhc->UsbDevContext[Index + 1].Enabled ||
2402 (Xhc->UsbDevContext[Index + 1].SlotId == 0) ||
2403 (Xhc->UsbDevContext[Index + 1].ParentRouteString.Dword != Xhc->UsbDevContext[SlotId].RouteString.Dword)) {
2404 continue;
2405 }
2406
2407 Status = XhcDisableSlotCmd (Xhc, Xhc->UsbDevContext[Index + 1].SlotId);
2408
2409 if (EFI_ERROR (Status)) {
2410 DEBUG ((EFI_D_ERROR, "XhcDisableSlotCmd: failed to disable child, ignore error\n"));
2411 Xhc->UsbDevContext[Index + 1].SlotId = 0;
2412 }
2413 }
2414
2415 //
2416 // Construct the disable slot command
2417 //
2418 DEBUG ((EFI_D_INFO, "Disable device slot %d!\n", SlotId));
2419
2420 ZeroMem (&CmdTrbDisSlot, sizeof (CmdTrbDisSlot));
2421 CmdTrbDisSlot.CycleBit = 1;
2422 CmdTrbDisSlot.Type = TRB_TYPE_DIS_SLOT;
2423 CmdTrbDisSlot.SlotId = SlotId;
2424 Status = XhcCmdTransfer (
2425 Xhc,
2426 (TRB_TEMPLATE *) (UINTN) &CmdTrbDisSlot,
2427 XHC_GENERIC_TIMEOUT,
2428 (TRB_TEMPLATE **) (UINTN) &EvtTrb
2429 );
2430 if (EFI_ERROR (Status)) {
2431 DEBUG ((EFI_D_ERROR, "XhcDisableSlotCmd: Disable Slot Command Failed, Status = %r\n", Status));
2432 return Status;
2433 }
2434 //
2435 // Free the slot's device context entry
2436 //
2437 Xhc->DCBAA[SlotId] = 0;
2438
2439 //
2440 // Free the slot related data structure
2441 //
2442 for (Index = 0; Index < 31; Index++) {
2443 if (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Index] != NULL) {
2444 RingSeg = ((TRANSFER_RING *)(UINTN)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Index])->RingSeg0;
2445 if (RingSeg != NULL) {
2446 UsbHcFreeMem (Xhc->MemPool, RingSeg, sizeof (TRB_TEMPLATE) * TR_RING_TRB_NUMBER);
2447 }
2448 FreePool (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Index]);
2449 Xhc->UsbDevContext[SlotId].EndpointTransferRing[Index] = NULL;
2450 }
2451 }
2452
2453 for (Index = 0; Index < Xhc->UsbDevContext[SlotId].DevDesc.NumConfigurations; Index++) {
2454 if (Xhc->UsbDevContext[SlotId].ConfDesc[Index] != NULL) {
2455 FreePool (Xhc->UsbDevContext[SlotId].ConfDesc[Index]);
2456 }
2457 }
2458
2459 if (Xhc->UsbDevContext[SlotId].ActiveAlternateSetting != NULL) {
2460 FreePool (Xhc->UsbDevContext[SlotId].ActiveAlternateSetting);
2461 }
2462
2463 if (Xhc->UsbDevContext[SlotId].InputContext != NULL) {
2464 UsbHcFreeMem (Xhc->MemPool, Xhc->UsbDevContext[SlotId].InputContext, sizeof (INPUT_CONTEXT));
2465 }
2466
2467 if (Xhc->UsbDevContext[SlotId].OutputContext != NULL) {
2468 UsbHcFreeMem (Xhc->MemPool, Xhc->UsbDevContext[SlotId].OutputContext, sizeof (DEVICE_CONTEXT));
2469 }
2470 //
2471 // Doesn't zero the entry because XhcAsyncInterruptTransfer() may be invoked to remove the established
2472 // asynchronous interrupt pipe after the device is disabled. It needs the device address mapping info to
2473 // remove urb from XHCI's asynchronous transfer list.
2474 //
2475 Xhc->UsbDevContext[SlotId].Enabled = FALSE;
2476 Xhc->UsbDevContext[SlotId].SlotId = 0;
2477
2478 return Status;
2479 }
2480
2481 /**
2482 Disable the specified device slot.
2483
2484 @param Xhc The XHCI Instance.
2485 @param SlotId The slot id to be disabled.
2486
2487 @retval EFI_SUCCESS Successfully disable the device slot.
2488
2489 **/
2490 EFI_STATUS
2491 EFIAPI
2492 XhcDisableSlotCmd64 (
2493 IN USB_XHCI_INSTANCE *Xhc,
2494 IN UINT8 SlotId
2495 )
2496 {
2497 EFI_STATUS Status;
2498 TRB_TEMPLATE *EvtTrb;
2499 CMD_TRB_DISABLE_SLOT CmdTrbDisSlot;
2500 UINT8 Index;
2501 VOID *RingSeg;
2502
2503 //
2504 // Disable the device slots occupied by these devices on its downstream ports.
2505 // Entry 0 is reserved.
2506 //
2507 for (Index = 0; Index < 255; Index++) {
2508 if (!Xhc->UsbDevContext[Index + 1].Enabled ||
2509 (Xhc->UsbDevContext[Index + 1].SlotId == 0) ||
2510 (Xhc->UsbDevContext[Index + 1].ParentRouteString.Dword != Xhc->UsbDevContext[SlotId].RouteString.Dword)) {
2511 continue;
2512 }
2513
2514 Status = XhcDisableSlotCmd64 (Xhc, Xhc->UsbDevContext[Index + 1].SlotId);
2515
2516 if (EFI_ERROR (Status)) {
2517 DEBUG ((EFI_D_ERROR, "XhcDisableSlotCmd: failed to disable child, ignore error\n"));
2518 Xhc->UsbDevContext[Index + 1].SlotId = 0;
2519 }
2520 }
2521
2522 //
2523 // Construct the disable slot command
2524 //
2525 DEBUG ((EFI_D_INFO, "Disable device slot %d!\n", SlotId));
2526
2527 ZeroMem (&CmdTrbDisSlot, sizeof (CmdTrbDisSlot));
2528 CmdTrbDisSlot.CycleBit = 1;
2529 CmdTrbDisSlot.Type = TRB_TYPE_DIS_SLOT;
2530 CmdTrbDisSlot.SlotId = SlotId;
2531 Status = XhcCmdTransfer (
2532 Xhc,
2533 (TRB_TEMPLATE *) (UINTN) &CmdTrbDisSlot,
2534 XHC_GENERIC_TIMEOUT,
2535 (TRB_TEMPLATE **) (UINTN) &EvtTrb
2536 );
2537 if (EFI_ERROR (Status)) {
2538 DEBUG ((EFI_D_ERROR, "XhcDisableSlotCmd: Disable Slot Command Failed, Status = %r\n", Status));
2539 return Status;
2540 }
2541 //
2542 // Free the slot's device context entry
2543 //
2544 Xhc->DCBAA[SlotId] = 0;
2545
2546 //
2547 // Free the slot related data structure
2548 //
2549 for (Index = 0; Index < 31; Index++) {
2550 if (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Index] != NULL) {
2551 RingSeg = ((TRANSFER_RING *)(UINTN)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Index])->RingSeg0;
2552 if (RingSeg != NULL) {
2553 UsbHcFreeMem (Xhc->MemPool, RingSeg, sizeof (TRB_TEMPLATE) * TR_RING_TRB_NUMBER);
2554 }
2555 FreePool (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Index]);
2556 Xhc->UsbDevContext[SlotId].EndpointTransferRing[Index] = NULL;
2557 }
2558 }
2559
2560 for (Index = 0; Index < Xhc->UsbDevContext[SlotId].DevDesc.NumConfigurations; Index++) {
2561 if (Xhc->UsbDevContext[SlotId].ConfDesc[Index] != NULL) {
2562 FreePool (Xhc->UsbDevContext[SlotId].ConfDesc[Index]);
2563 }
2564 }
2565
2566 if (Xhc->UsbDevContext[SlotId].ActiveAlternateSetting != NULL) {
2567 FreePool (Xhc->UsbDevContext[SlotId].ActiveAlternateSetting);
2568 }
2569
2570 if (Xhc->UsbDevContext[SlotId].InputContext != NULL) {
2571 UsbHcFreeMem (Xhc->MemPool, Xhc->UsbDevContext[SlotId].InputContext, sizeof (INPUT_CONTEXT_64));
2572 }
2573
2574 if (Xhc->UsbDevContext[SlotId].OutputContext != NULL) {
2575 UsbHcFreeMem (Xhc->MemPool, Xhc->UsbDevContext[SlotId].OutputContext, sizeof (DEVICE_CONTEXT_64));
2576 }
2577 //
2578 // Doesn't zero the entry because XhcAsyncInterruptTransfer() may be invoked to remove the established
2579 // asynchronous interrupt pipe after the device is disabled. It needs the device address mapping info to
2580 // remove urb from XHCI's asynchronous transfer list.
2581 //
2582 Xhc->UsbDevContext[SlotId].Enabled = FALSE;
2583 Xhc->UsbDevContext[SlotId].SlotId = 0;
2584
2585 return Status;
2586 }
2587
2588 /**
2589 Initialize endpoint context in input context.
2590
2591 @param Xhc The XHCI Instance.
2592 @param SlotId The slot id to be configured.
2593 @param DeviceSpeed The device's speed.
2594 @param InputContext The pointer to the input context.
2595 @param IfDesc The pointer to the usb device interface descriptor.
2596
2597 @return The maximum device context index of endpoint.
2598
2599 **/
2600 UINT8
2601 EFIAPI
2602 XhcInitializeEndpointContext (
2603 IN USB_XHCI_INSTANCE *Xhc,
2604 IN UINT8 SlotId,
2605 IN UINT8 DeviceSpeed,
2606 IN INPUT_CONTEXT *InputContext,
2607 IN USB_INTERFACE_DESCRIPTOR *IfDesc
2608 )
2609 {
2610 USB_ENDPOINT_DESCRIPTOR *EpDesc;
2611 UINTN NumEp;
2612 UINTN EpIndex;
2613 UINT8 EpAddr;
2614 UINT8 Direction;
2615 UINT8 Dci;
2616 UINT8 MaxDci;
2617 EFI_PHYSICAL_ADDRESS PhyAddr;
2618 UINT8 Interval;
2619 TRANSFER_RING *EndpointTransferRing;
2620
2621 MaxDci = 0;
2622
2623 NumEp = IfDesc->NumEndpoints;
2624
2625 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)(IfDesc + 1);
2626 for (EpIndex = 0; EpIndex < NumEp; EpIndex++) {
2627 while (EpDesc->DescriptorType != USB_DESC_TYPE_ENDPOINT) {
2628 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2629 }
2630
2631 if (EpDesc->Length < sizeof (USB_ENDPOINT_DESCRIPTOR)) {
2632 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2633 continue;
2634 }
2635
2636 EpAddr = (UINT8)(EpDesc->EndpointAddress & 0x0F);
2637 Direction = (UINT8)((EpDesc->EndpointAddress & 0x80) ? EfiUsbDataIn : EfiUsbDataOut);
2638
2639 Dci = XhcEndpointToDci (EpAddr, Direction);
2640 ASSERT (Dci < 32);
2641 if (Dci > MaxDci) {
2642 MaxDci = Dci;
2643 }
2644
2645 InputContext->InputControlContext.Dword2 |= (BIT0 << Dci);
2646 InputContext->EP[Dci-1].MaxPacketSize = EpDesc->MaxPacketSize;
2647
2648 if (DeviceSpeed == EFI_USB_SPEED_SUPER) {
2649 //
2650 // 6.2.3.4, shall be set to the value defined in the bMaxBurst field of the SuperSpeed Endpoint Companion Descriptor.
2651 //
2652 InputContext->EP[Dci-1].MaxBurstSize = 0x0;
2653 } else {
2654 InputContext->EP[Dci-1].MaxBurstSize = 0x0;
2655 }
2656
2657 switch (EpDesc->Attributes & USB_ENDPOINT_TYPE_MASK) {
2658 case USB_ENDPOINT_BULK:
2659 if (Direction == EfiUsbDataIn) {
2660 InputContext->EP[Dci-1].CErr = 3;
2661 InputContext->EP[Dci-1].EPType = ED_BULK_IN;
2662 } else {
2663 InputContext->EP[Dci-1].CErr = 3;
2664 InputContext->EP[Dci-1].EPType = ED_BULK_OUT;
2665 }
2666
2667 InputContext->EP[Dci-1].AverageTRBLength = 0x1000;
2668 if (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1] == NULL) {
2669 EndpointTransferRing = AllocateZeroPool(sizeof (TRANSFER_RING));
2670 Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1] = (VOID *) EndpointTransferRing;
2671 CreateTransferRing(Xhc, TR_RING_TRB_NUMBER, (TRANSFER_RING *)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1]);
2672 DEBUG ((DEBUG_INFO, "Endpoint[%x]: Created BULK ring [%p~%p)\n",
2673 EpDesc->EndpointAddress,
2674 EndpointTransferRing->RingSeg0,
2675 (UINTN) EndpointTransferRing->RingSeg0 + TR_RING_TRB_NUMBER * sizeof (TRB_TEMPLATE)
2676 ));
2677 }
2678
2679 break;
2680 case USB_ENDPOINT_ISO:
2681 if (Direction == EfiUsbDataIn) {
2682 InputContext->EP[Dci-1].CErr = 0;
2683 InputContext->EP[Dci-1].EPType = ED_ISOCH_IN;
2684 } else {
2685 InputContext->EP[Dci-1].CErr = 0;
2686 InputContext->EP[Dci-1].EPType = ED_ISOCH_OUT;
2687 }
2688 //
2689 // Get the bInterval from descriptor and init the the interval field of endpoint context.
2690 // Refer to XHCI 1.1 spec section 6.2.3.6.
2691 //
2692 if (DeviceSpeed == EFI_USB_SPEED_FULL) {
2693 Interval = EpDesc->Interval;
2694 ASSERT (Interval >= 1 && Interval <= 16);
2695 InputContext->EP[Dci-1].Interval = Interval + 2;
2696 } else if ((DeviceSpeed == EFI_USB_SPEED_HIGH) || (DeviceSpeed == EFI_USB_SPEED_SUPER)) {
2697 Interval = EpDesc->Interval;
2698 ASSERT (Interval >= 1 && Interval <= 16);
2699 InputContext->EP[Dci-1].Interval = Interval - 1;
2700 }
2701
2702 //
2703 // Do not support isochronous transfer now.
2704 //
2705 DEBUG ((EFI_D_INFO, "XhcInitializeEndpointContext: Unsupport ISO EP found, Transfer ring is not allocated.\n"));
2706 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2707 continue;
2708 case USB_ENDPOINT_INTERRUPT:
2709 if (Direction == EfiUsbDataIn) {
2710 InputContext->EP[Dci-1].CErr = 3;
2711 InputContext->EP[Dci-1].EPType = ED_INTERRUPT_IN;
2712 } else {
2713 InputContext->EP[Dci-1].CErr = 3;
2714 InputContext->EP[Dci-1].EPType = ED_INTERRUPT_OUT;
2715 }
2716 InputContext->EP[Dci-1].AverageTRBLength = 0x1000;
2717 InputContext->EP[Dci-1].MaxESITPayload = EpDesc->MaxPacketSize;
2718 //
2719 // Get the bInterval from descriptor and init the the interval field of endpoint context
2720 //
2721 if ((DeviceSpeed == EFI_USB_SPEED_FULL) || (DeviceSpeed == EFI_USB_SPEED_LOW)) {
2722 Interval = EpDesc->Interval;
2723 //
2724 // Calculate through the bInterval field of Endpoint descriptor.
2725 //
2726 ASSERT (Interval != 0);
2727 InputContext->EP[Dci-1].Interval = (UINT32)HighBitSet32((UINT32)Interval) + 3;
2728 } else if ((DeviceSpeed == EFI_USB_SPEED_HIGH) || (DeviceSpeed == EFI_USB_SPEED_SUPER)) {
2729 Interval = EpDesc->Interval;
2730 ASSERT (Interval >= 1 && Interval <= 16);
2731 //
2732 // Refer to XHCI 1.0 spec section 6.2.3.6, table 61
2733 //
2734 InputContext->EP[Dci-1].Interval = Interval - 1;
2735 InputContext->EP[Dci-1].AverageTRBLength = 0x1000;
2736 InputContext->EP[Dci-1].MaxESITPayload = 0x0002;
2737 InputContext->EP[Dci-1].MaxBurstSize = 0x0;
2738 InputContext->EP[Dci-1].CErr = 3;
2739 }
2740
2741 if (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1] == NULL) {
2742 EndpointTransferRing = AllocateZeroPool(sizeof (TRANSFER_RING));
2743 Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1] = (VOID *) EndpointTransferRing;
2744 CreateTransferRing(Xhc, TR_RING_TRB_NUMBER, (TRANSFER_RING *)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1]);
2745 DEBUG ((DEBUG_INFO, "Endpoint[%x]: Created INT ring [%p~%p)\n",
2746 EpDesc->EndpointAddress,
2747 EndpointTransferRing->RingSeg0,
2748 (UINTN) EndpointTransferRing->RingSeg0 + TR_RING_TRB_NUMBER * sizeof (TRB_TEMPLATE)
2749 ));
2750 }
2751 break;
2752
2753 case USB_ENDPOINT_CONTROL:
2754 //
2755 // Do not support control transfer now.
2756 //
2757 DEBUG ((EFI_D_INFO, "XhcInitializeEndpointContext: Unsupport Control EP found, Transfer ring is not allocated.\n"));
2758 default:
2759 DEBUG ((EFI_D_INFO, "XhcInitializeEndpointContext: Unknown EP found, Transfer ring is not allocated.\n"));
2760 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2761 continue;
2762 }
2763
2764 PhyAddr = UsbHcGetPciAddrForHostAddr (
2765 Xhc->MemPool,
2766 ((TRANSFER_RING *)(UINTN)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1])->RingSeg0,
2767 sizeof (TRB_TEMPLATE) * TR_RING_TRB_NUMBER
2768 );
2769 PhyAddr &= ~((EFI_PHYSICAL_ADDRESS)0x0F);
2770 PhyAddr |= (EFI_PHYSICAL_ADDRESS)((TRANSFER_RING *)(UINTN)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1])->RingPCS;
2771 InputContext->EP[Dci-1].PtrLo = XHC_LOW_32BIT (PhyAddr);
2772 InputContext->EP[Dci-1].PtrHi = XHC_HIGH_32BIT (PhyAddr);
2773
2774 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2775 }
2776
2777 return MaxDci;
2778 }
2779
2780 /**
2781 Initialize endpoint context in input context.
2782
2783 @param Xhc The XHCI Instance.
2784 @param SlotId The slot id to be configured.
2785 @param DeviceSpeed The device's speed.
2786 @param InputContext The pointer to the input context.
2787 @param IfDesc The pointer to the usb device interface descriptor.
2788
2789 @return The maximum device context index of endpoint.
2790
2791 **/
2792 UINT8
2793 EFIAPI
2794 XhcInitializeEndpointContext64 (
2795 IN USB_XHCI_INSTANCE *Xhc,
2796 IN UINT8 SlotId,
2797 IN UINT8 DeviceSpeed,
2798 IN INPUT_CONTEXT_64 *InputContext,
2799 IN USB_INTERFACE_DESCRIPTOR *IfDesc
2800 )
2801 {
2802 USB_ENDPOINT_DESCRIPTOR *EpDesc;
2803 UINTN NumEp;
2804 UINTN EpIndex;
2805 UINT8 EpAddr;
2806 UINT8 Direction;
2807 UINT8 Dci;
2808 UINT8 MaxDci;
2809 EFI_PHYSICAL_ADDRESS PhyAddr;
2810 UINT8 Interval;
2811 TRANSFER_RING *EndpointTransferRing;
2812
2813 MaxDci = 0;
2814
2815 NumEp = IfDesc->NumEndpoints;
2816
2817 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)(IfDesc + 1);
2818 for (EpIndex = 0; EpIndex < NumEp; EpIndex++) {
2819 while (EpDesc->DescriptorType != USB_DESC_TYPE_ENDPOINT) {
2820 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2821 }
2822
2823 if (EpDesc->Length < sizeof (USB_ENDPOINT_DESCRIPTOR)) {
2824 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2825 continue;
2826 }
2827
2828 EpAddr = (UINT8)(EpDesc->EndpointAddress & 0x0F);
2829 Direction = (UINT8)((EpDesc->EndpointAddress & 0x80) ? EfiUsbDataIn : EfiUsbDataOut);
2830
2831 Dci = XhcEndpointToDci (EpAddr, Direction);
2832 ASSERT (Dci < 32);
2833 if (Dci > MaxDci) {
2834 MaxDci = Dci;
2835 }
2836
2837 InputContext->InputControlContext.Dword2 |= (BIT0 << Dci);
2838 InputContext->EP[Dci-1].MaxPacketSize = EpDesc->MaxPacketSize;
2839
2840 if (DeviceSpeed == EFI_USB_SPEED_SUPER) {
2841 //
2842 // 6.2.3.4, shall be set to the value defined in the bMaxBurst field of the SuperSpeed Endpoint Companion Descriptor.
2843 //
2844 InputContext->EP[Dci-1].MaxBurstSize = 0x0;
2845 } else {
2846 InputContext->EP[Dci-1].MaxBurstSize = 0x0;
2847 }
2848
2849 switch (EpDesc->Attributes & USB_ENDPOINT_TYPE_MASK) {
2850 case USB_ENDPOINT_BULK:
2851 if (Direction == EfiUsbDataIn) {
2852 InputContext->EP[Dci-1].CErr = 3;
2853 InputContext->EP[Dci-1].EPType = ED_BULK_IN;
2854 } else {
2855 InputContext->EP[Dci-1].CErr = 3;
2856 InputContext->EP[Dci-1].EPType = ED_BULK_OUT;
2857 }
2858
2859 InputContext->EP[Dci-1].AverageTRBLength = 0x1000;
2860 if (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1] == NULL) {
2861 EndpointTransferRing = AllocateZeroPool(sizeof (TRANSFER_RING));
2862 Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1] = (VOID *) EndpointTransferRing;
2863 CreateTransferRing(Xhc, TR_RING_TRB_NUMBER, (TRANSFER_RING *)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1]);
2864 DEBUG ((DEBUG_INFO, "Endpoint64[%x]: Created BULK ring [%p~%p)\n",
2865 EpDesc->EndpointAddress,
2866 EndpointTransferRing->RingSeg0,
2867 (UINTN) EndpointTransferRing->RingSeg0 + TR_RING_TRB_NUMBER * sizeof (TRB_TEMPLATE)
2868 ));
2869 }
2870
2871 break;
2872 case USB_ENDPOINT_ISO:
2873 if (Direction == EfiUsbDataIn) {
2874 InputContext->EP[Dci-1].CErr = 0;
2875 InputContext->EP[Dci-1].EPType = ED_ISOCH_IN;
2876 } else {
2877 InputContext->EP[Dci-1].CErr = 0;
2878 InputContext->EP[Dci-1].EPType = ED_ISOCH_OUT;
2879 }
2880 //
2881 // Get the bInterval from descriptor and init the the interval field of endpoint context.
2882 // Refer to XHCI 1.1 spec section 6.2.3.6.
2883 //
2884 if (DeviceSpeed == EFI_USB_SPEED_FULL) {
2885 Interval = EpDesc->Interval;
2886 ASSERT (Interval >= 1 && Interval <= 16);
2887 InputContext->EP[Dci-1].Interval = Interval + 2;
2888 } else if ((DeviceSpeed == EFI_USB_SPEED_HIGH) || (DeviceSpeed == EFI_USB_SPEED_SUPER)) {
2889 Interval = EpDesc->Interval;
2890 ASSERT (Interval >= 1 && Interval <= 16);
2891 InputContext->EP[Dci-1].Interval = Interval - 1;
2892 }
2893
2894 //
2895 // Do not support isochronous transfer now.
2896 //
2897 DEBUG ((EFI_D_INFO, "XhcInitializeEndpointContext64: Unsupport ISO EP found, Transfer ring is not allocated.\n"));
2898 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2899 continue;
2900 case USB_ENDPOINT_INTERRUPT:
2901 if (Direction == EfiUsbDataIn) {
2902 InputContext->EP[Dci-1].CErr = 3;
2903 InputContext->EP[Dci-1].EPType = ED_INTERRUPT_IN;
2904 } else {
2905 InputContext->EP[Dci-1].CErr = 3;
2906 InputContext->EP[Dci-1].EPType = ED_INTERRUPT_OUT;
2907 }
2908 InputContext->EP[Dci-1].AverageTRBLength = 0x1000;
2909 InputContext->EP[Dci-1].MaxESITPayload = EpDesc->MaxPacketSize;
2910 //
2911 // Get the bInterval from descriptor and init the the interval field of endpoint context
2912 //
2913 if ((DeviceSpeed == EFI_USB_SPEED_FULL) || (DeviceSpeed == EFI_USB_SPEED_LOW)) {
2914 Interval = EpDesc->Interval;
2915 //
2916 // Calculate through the bInterval field of Endpoint descriptor.
2917 //
2918 ASSERT (Interval != 0);
2919 InputContext->EP[Dci-1].Interval = (UINT32)HighBitSet32((UINT32)Interval) + 3;
2920 } else if ((DeviceSpeed == EFI_USB_SPEED_HIGH) || (DeviceSpeed == EFI_USB_SPEED_SUPER)) {
2921 Interval = EpDesc->Interval;
2922 ASSERT (Interval >= 1 && Interval <= 16);
2923 //
2924 // Refer to XHCI 1.0 spec section 6.2.3.6, table 61
2925 //
2926 InputContext->EP[Dci-1].Interval = Interval - 1;
2927 InputContext->EP[Dci-1].AverageTRBLength = 0x1000;
2928 InputContext->EP[Dci-1].MaxESITPayload = 0x0002;
2929 InputContext->EP[Dci-1].MaxBurstSize = 0x0;
2930 InputContext->EP[Dci-1].CErr = 3;
2931 }
2932
2933 if (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1] == NULL) {
2934 EndpointTransferRing = AllocateZeroPool(sizeof (TRANSFER_RING));
2935 Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1] = (VOID *) EndpointTransferRing;
2936 CreateTransferRing(Xhc, TR_RING_TRB_NUMBER, (TRANSFER_RING *)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1]);
2937 DEBUG ((DEBUG_INFO, "Endpoint64[%x]: Created INT ring [%p~%p)\n",
2938 EpDesc->EndpointAddress,
2939 EndpointTransferRing->RingSeg0,
2940 (UINTN) EndpointTransferRing->RingSeg0 + TR_RING_TRB_NUMBER * sizeof (TRB_TEMPLATE)
2941 ));
2942 }
2943 break;
2944
2945 case USB_ENDPOINT_CONTROL:
2946 //
2947 // Do not support control transfer now.
2948 //
2949 DEBUG ((EFI_D_INFO, "XhcInitializeEndpointContext64: Unsupport Control EP found, Transfer ring is not allocated.\n"));
2950 default:
2951 DEBUG ((EFI_D_INFO, "XhcInitializeEndpointContext64: Unknown EP found, Transfer ring is not allocated.\n"));
2952 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2953 continue;
2954 }
2955
2956 PhyAddr = UsbHcGetPciAddrForHostAddr (
2957 Xhc->MemPool,
2958 ((TRANSFER_RING *)(UINTN)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1])->RingSeg0,
2959 sizeof (TRB_TEMPLATE) * TR_RING_TRB_NUMBER
2960 );
2961 PhyAddr &= ~((EFI_PHYSICAL_ADDRESS)0x0F);
2962 PhyAddr |= (EFI_PHYSICAL_ADDRESS)((TRANSFER_RING *)(UINTN)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci-1])->RingPCS;
2963 InputContext->EP[Dci-1].PtrLo = XHC_LOW_32BIT (PhyAddr);
2964 InputContext->EP[Dci-1].PtrHi = XHC_HIGH_32BIT (PhyAddr);
2965
2966 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
2967 }
2968
2969 return MaxDci;
2970 }
2971
2972 /**
2973 Configure all the device endpoints through XHCI's Configure_Endpoint cmd.
2974
2975 @param Xhc The XHCI Instance.
2976 @param SlotId The slot id to be configured.
2977 @param DeviceSpeed The device's speed.
2978 @param ConfigDesc The pointer to the usb device configuration descriptor.
2979
2980 @retval EFI_SUCCESS Successfully configure all the device endpoints.
2981
2982 **/
2983 EFI_STATUS
2984 EFIAPI
2985 XhcSetConfigCmd (
2986 IN USB_XHCI_INSTANCE *Xhc,
2987 IN UINT8 SlotId,
2988 IN UINT8 DeviceSpeed,
2989 IN USB_CONFIG_DESCRIPTOR *ConfigDesc
2990 )
2991 {
2992 EFI_STATUS Status;
2993 USB_INTERFACE_DESCRIPTOR *IfDesc;
2994 UINT8 Index;
2995 UINT8 Dci;
2996 UINT8 MaxDci;
2997 EFI_PHYSICAL_ADDRESS PhyAddr;
2998
2999 CMD_TRB_CONFIG_ENDPOINT CmdTrbCfgEP;
3000 INPUT_CONTEXT *InputContext;
3001 DEVICE_CONTEXT *OutputContext;
3002 EVT_TRB_COMMAND_COMPLETION *EvtTrb;
3003 //
3004 // 4.6.6 Configure Endpoint
3005 //
3006 InputContext = Xhc->UsbDevContext[SlotId].InputContext;
3007 OutputContext = Xhc->UsbDevContext[SlotId].OutputContext;
3008 ZeroMem (InputContext, sizeof (INPUT_CONTEXT));
3009 CopyMem (&InputContext->Slot, &OutputContext->Slot, sizeof (SLOT_CONTEXT));
3010
3011 ASSERT (ConfigDesc != NULL);
3012
3013 MaxDci = 0;
3014
3015 IfDesc = (USB_INTERFACE_DESCRIPTOR *)(ConfigDesc + 1);
3016 for (Index = 0; Index < ConfigDesc->NumInterfaces; Index++) {
3017 while ((IfDesc->DescriptorType != USB_DESC_TYPE_INTERFACE) || (IfDesc->AlternateSetting != 0)) {
3018 IfDesc = (USB_INTERFACE_DESCRIPTOR *)((UINTN)IfDesc + IfDesc->Length);
3019 }
3020
3021 if (IfDesc->Length < sizeof (USB_INTERFACE_DESCRIPTOR)) {
3022 IfDesc = (USB_INTERFACE_DESCRIPTOR *)((UINTN)IfDesc + IfDesc->Length);
3023 continue;
3024 }
3025
3026 Dci = XhcInitializeEndpointContext (Xhc, SlotId, DeviceSpeed, InputContext, IfDesc);
3027 if (Dci > MaxDci) {
3028 MaxDci = Dci;
3029 }
3030
3031 IfDesc = (USB_INTERFACE_DESCRIPTOR *)((UINTN)IfDesc + IfDesc->Length);
3032 }
3033
3034 InputContext->InputControlContext.Dword2 |= BIT0;
3035 InputContext->Slot.ContextEntries = MaxDci;
3036 //
3037 // configure endpoint
3038 //
3039 ZeroMem (&CmdTrbCfgEP, sizeof (CmdTrbCfgEP));
3040 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, InputContext, sizeof (INPUT_CONTEXT));
3041 CmdTrbCfgEP.PtrLo = XHC_LOW_32BIT (PhyAddr);
3042 CmdTrbCfgEP.PtrHi = XHC_HIGH_32BIT (PhyAddr);
3043 CmdTrbCfgEP.CycleBit = 1;
3044 CmdTrbCfgEP.Type = TRB_TYPE_CON_ENDPOINT;
3045 CmdTrbCfgEP.SlotId = Xhc->UsbDevContext[SlotId].SlotId;
3046 DEBUG ((EFI_D_INFO, "Configure Endpoint\n"));
3047 Status = XhcCmdTransfer (
3048 Xhc,
3049 (TRB_TEMPLATE *) (UINTN) &CmdTrbCfgEP,
3050 XHC_GENERIC_TIMEOUT,
3051 (TRB_TEMPLATE **) (UINTN) &EvtTrb
3052 );
3053 if (EFI_ERROR (Status)) {
3054 DEBUG ((EFI_D_ERROR, "XhcSetConfigCmd: Config Endpoint Failed, Status = %r\n", Status));
3055 } else {
3056 Xhc->UsbDevContext[SlotId].ActiveConfiguration = ConfigDesc->ConfigurationValue;
3057 }
3058
3059 return Status;
3060 }
3061
3062 /**
3063 Configure all the device endpoints through XHCI's Configure_Endpoint cmd.
3064
3065 @param Xhc The XHCI Instance.
3066 @param SlotId The slot id to be configured.
3067 @param DeviceSpeed The device's speed.
3068 @param ConfigDesc The pointer to the usb device configuration descriptor.
3069
3070 @retval EFI_SUCCESS Successfully configure all the device endpoints.
3071
3072 **/
3073 EFI_STATUS
3074 EFIAPI
3075 XhcSetConfigCmd64 (
3076 IN USB_XHCI_INSTANCE *Xhc,
3077 IN UINT8 SlotId,
3078 IN UINT8 DeviceSpeed,
3079 IN USB_CONFIG_DESCRIPTOR *ConfigDesc
3080 )
3081 {
3082 EFI_STATUS Status;
3083 USB_INTERFACE_DESCRIPTOR *IfDesc;
3084 UINT8 Index;
3085 UINT8 Dci;
3086 UINT8 MaxDci;
3087 EFI_PHYSICAL_ADDRESS PhyAddr;
3088
3089 CMD_TRB_CONFIG_ENDPOINT CmdTrbCfgEP;
3090 INPUT_CONTEXT_64 *InputContext;
3091 DEVICE_CONTEXT_64 *OutputContext;
3092 EVT_TRB_COMMAND_COMPLETION *EvtTrb;
3093 //
3094 // 4.6.6 Configure Endpoint
3095 //
3096 InputContext = Xhc->UsbDevContext[SlotId].InputContext;
3097 OutputContext = Xhc->UsbDevContext[SlotId].OutputContext;
3098 ZeroMem (InputContext, sizeof (INPUT_CONTEXT_64));
3099 CopyMem (&InputContext->Slot, &OutputContext->Slot, sizeof (SLOT_CONTEXT_64));
3100
3101 ASSERT (ConfigDesc != NULL);
3102
3103 MaxDci = 0;
3104
3105 IfDesc = (USB_INTERFACE_DESCRIPTOR *)(ConfigDesc + 1);
3106 for (Index = 0; Index < ConfigDesc->NumInterfaces; Index++) {
3107 while ((IfDesc->DescriptorType != USB_DESC_TYPE_INTERFACE) || (IfDesc->AlternateSetting != 0)) {
3108 IfDesc = (USB_INTERFACE_DESCRIPTOR *)((UINTN)IfDesc + IfDesc->Length);
3109 }
3110
3111 if (IfDesc->Length < sizeof (USB_INTERFACE_DESCRIPTOR)) {
3112 IfDesc = (USB_INTERFACE_DESCRIPTOR *)((UINTN)IfDesc + IfDesc->Length);
3113 continue;
3114 }
3115
3116 Dci = XhcInitializeEndpointContext64 (Xhc, SlotId, DeviceSpeed, InputContext, IfDesc);
3117 if (Dci > MaxDci) {
3118 MaxDci = Dci;
3119 }
3120
3121 IfDesc = (USB_INTERFACE_DESCRIPTOR *)((UINTN)IfDesc + IfDesc->Length);
3122 }
3123
3124 InputContext->InputControlContext.Dword2 |= BIT0;
3125 InputContext->Slot.ContextEntries = MaxDci;
3126 //
3127 // configure endpoint
3128 //
3129 ZeroMem (&CmdTrbCfgEP, sizeof (CmdTrbCfgEP));
3130 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, InputContext, sizeof (INPUT_CONTEXT_64));
3131 CmdTrbCfgEP.PtrLo = XHC_LOW_32BIT (PhyAddr);
3132 CmdTrbCfgEP.PtrHi = XHC_HIGH_32BIT (PhyAddr);
3133 CmdTrbCfgEP.CycleBit = 1;
3134 CmdTrbCfgEP.Type = TRB_TYPE_CON_ENDPOINT;
3135 CmdTrbCfgEP.SlotId = Xhc->UsbDevContext[SlotId].SlotId;
3136 DEBUG ((EFI_D_INFO, "Configure Endpoint\n"));
3137 Status = XhcCmdTransfer (
3138 Xhc,
3139 (TRB_TEMPLATE *) (UINTN) &CmdTrbCfgEP,
3140 XHC_GENERIC_TIMEOUT,
3141 (TRB_TEMPLATE **) (UINTN) &EvtTrb
3142 );
3143 if (EFI_ERROR (Status)) {
3144 DEBUG ((EFI_D_ERROR, "XhcSetConfigCmd64: Config Endpoint Failed, Status = %r\n", Status));
3145 } else {
3146 Xhc->UsbDevContext[SlotId].ActiveConfiguration = ConfigDesc->ConfigurationValue;
3147 }
3148
3149 return Status;
3150 }
3151
3152 /**
3153 Stop endpoint through XHCI's Stop_Endpoint cmd.
3154
3155 @param Xhc The XHCI Instance.
3156 @param SlotId The slot id to be configured.
3157 @param Dci The device context index of endpoint.
3158
3159 @retval EFI_SUCCESS Stop endpoint successfully.
3160 @retval Others Failed to stop endpoint.
3161
3162 **/
3163 EFI_STATUS
3164 EFIAPI
3165 XhcStopEndpoint (
3166 IN USB_XHCI_INSTANCE *Xhc,
3167 IN UINT8 SlotId,
3168 IN UINT8 Dci
3169 )
3170 {
3171 EFI_STATUS Status;
3172 EVT_TRB_COMMAND_COMPLETION *EvtTrb;
3173 CMD_TRB_STOP_ENDPOINT CmdTrbStopED;
3174
3175 DEBUG ((EFI_D_INFO, "XhcStopEndpoint: Slot = 0x%x, Dci = 0x%x\n", SlotId, Dci));
3176
3177 //
3178 // Send stop endpoint command to transit Endpoint from running to stop state
3179 //
3180 ZeroMem (&CmdTrbStopED, sizeof (CmdTrbStopED));
3181 CmdTrbStopED.CycleBit = 1;
3182 CmdTrbStopED.Type = TRB_TYPE_STOP_ENDPOINT;
3183 CmdTrbStopED.EDID = Dci;
3184 CmdTrbStopED.SlotId = SlotId;
3185 Status = XhcCmdTransfer (
3186 Xhc,
3187 (TRB_TEMPLATE *) (UINTN) &CmdTrbStopED,
3188 XHC_GENERIC_TIMEOUT,
3189 (TRB_TEMPLATE **) (UINTN) &EvtTrb
3190 );
3191 if (EFI_ERROR(Status)) {
3192 DEBUG ((EFI_D_ERROR, "XhcStopEndpoint: Stop Endpoint Failed, Status = %r\n", Status));
3193 }
3194
3195 return Status;
3196 }
3197
3198 /**
3199 Reset endpoint through XHCI's Reset_Endpoint cmd.
3200
3201 @param Xhc The XHCI Instance.
3202 @param SlotId The slot id to be configured.
3203 @param Dci The device context index of endpoint.
3204
3205 @retval EFI_SUCCESS Reset endpoint successfully.
3206 @retval Others Failed to reset endpoint.
3207
3208 **/
3209 EFI_STATUS
3210 EFIAPI
3211 XhcResetEndpoint (
3212 IN USB_XHCI_INSTANCE *Xhc,
3213 IN UINT8 SlotId,
3214 IN UINT8 Dci
3215 )
3216 {
3217 EFI_STATUS Status;
3218 EVT_TRB_COMMAND_COMPLETION *EvtTrb;
3219 CMD_TRB_RESET_ENDPOINT CmdTrbResetED;
3220
3221 DEBUG ((EFI_D_INFO, "XhcResetEndpoint: Slot = 0x%x, Dci = 0x%x\n", SlotId, Dci));
3222
3223 //
3224 // Send stop endpoint command to transit Endpoint from running to stop state
3225 //
3226 ZeroMem (&CmdTrbResetED, sizeof (CmdTrbResetED));
3227 CmdTrbResetED.CycleBit = 1;
3228 CmdTrbResetED.Type = TRB_TYPE_RESET_ENDPOINT;
3229 CmdTrbResetED.EDID = Dci;
3230 CmdTrbResetED.SlotId = SlotId;
3231 Status = XhcCmdTransfer (
3232 Xhc,
3233 (TRB_TEMPLATE *) (UINTN) &CmdTrbResetED,
3234 XHC_GENERIC_TIMEOUT,
3235 (TRB_TEMPLATE **) (UINTN) &EvtTrb
3236 );
3237 if (EFI_ERROR(Status)) {
3238 DEBUG ((EFI_D_ERROR, "XhcResetEndpoint: Reset Endpoint Failed, Status = %r\n", Status));
3239 }
3240
3241 return Status;
3242 }
3243
3244 /**
3245 Set transfer ring dequeue pointer through XHCI's Set_Tr_Dequeue_Pointer cmd.
3246
3247 @param Xhc The XHCI Instance.
3248 @param SlotId The slot id to be configured.
3249 @param Dci The device context index of endpoint.
3250 @param Urb The dequeue pointer of the transfer ring specified
3251 by the urb to be updated.
3252
3253 @retval EFI_SUCCESS Set transfer ring dequeue pointer succeeds.
3254 @retval Others Failed to set transfer ring dequeue pointer.
3255
3256 **/
3257 EFI_STATUS
3258 EFIAPI
3259 XhcSetTrDequeuePointer (
3260 IN USB_XHCI_INSTANCE *Xhc,
3261 IN UINT8 SlotId,
3262 IN UINT8 Dci,
3263 IN URB *Urb
3264 )
3265 {
3266 EFI_STATUS Status;
3267 EVT_TRB_COMMAND_COMPLETION *EvtTrb;
3268 CMD_SET_TR_DEQ_POINTER CmdSetTRDeq;
3269 EFI_PHYSICAL_ADDRESS PhyAddr;
3270
3271 DEBUG ((EFI_D_INFO, "XhcSetTrDequeuePointer: Slot = 0x%x, Dci = 0x%x, Urb = 0x%x\n", SlotId, Dci, Urb));
3272
3273 //
3274 // Send stop endpoint command to transit Endpoint from running to stop state
3275 //
3276 ZeroMem (&CmdSetTRDeq, sizeof (CmdSetTRDeq));
3277 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, Urb->Ring->RingEnqueue, sizeof (CMD_SET_TR_DEQ_POINTER));
3278 CmdSetTRDeq.PtrLo = XHC_LOW_32BIT (PhyAddr) | Urb->Ring->RingPCS;
3279 CmdSetTRDeq.PtrHi = XHC_HIGH_32BIT (PhyAddr);
3280 CmdSetTRDeq.CycleBit = 1;
3281 CmdSetTRDeq.Type = TRB_TYPE_SET_TR_DEQUE;
3282 CmdSetTRDeq.Endpoint = Dci;
3283 CmdSetTRDeq.SlotId = SlotId;
3284 Status = XhcCmdTransfer (
3285 Xhc,
3286 (TRB_TEMPLATE *) (UINTN) &CmdSetTRDeq,
3287 XHC_GENERIC_TIMEOUT,
3288 (TRB_TEMPLATE **) (UINTN) &EvtTrb
3289 );
3290 if (EFI_ERROR(Status)) {
3291 DEBUG ((EFI_D_ERROR, "XhcSetTrDequeuePointer: Set TR Dequeue Pointer Failed, Status = %r\n", Status));
3292 }
3293
3294 return Status;
3295 }
3296
3297 /**
3298 Set interface through XHCI's Configure_Endpoint cmd.
3299
3300 @param Xhc The XHCI Instance.
3301 @param SlotId The slot id to be configured.
3302 @param DeviceSpeed The device's speed.
3303 @param ConfigDesc The pointer to the usb device configuration descriptor.
3304 @param Request USB device request to send.
3305
3306 @retval EFI_SUCCESS Successfully set interface.
3307
3308 **/
3309 EFI_STATUS
3310 EFIAPI
3311 XhcSetInterface (
3312 IN USB_XHCI_INSTANCE *Xhc,
3313 IN UINT8 SlotId,
3314 IN UINT8 DeviceSpeed,
3315 IN USB_CONFIG_DESCRIPTOR *ConfigDesc,
3316 IN EFI_USB_DEVICE_REQUEST *Request
3317 )
3318 {
3319 EFI_STATUS Status;
3320 USB_INTERFACE_DESCRIPTOR *IfDescActive;
3321 USB_INTERFACE_DESCRIPTOR *IfDescSet;
3322 USB_INTERFACE_DESCRIPTOR *IfDesc;
3323 USB_ENDPOINT_DESCRIPTOR *EpDesc;
3324 UINTN NumEp;
3325 UINTN EpIndex;
3326 UINT8 EpAddr;
3327 UINT8 Direction;
3328 UINT8 Dci;
3329 UINT8 MaxDci;
3330 EFI_PHYSICAL_ADDRESS PhyAddr;
3331 VOID *RingSeg;
3332
3333 CMD_TRB_CONFIG_ENDPOINT CmdTrbCfgEP;
3334 INPUT_CONTEXT *InputContext;
3335 DEVICE_CONTEXT *OutputContext;
3336 EVT_TRB_COMMAND_COMPLETION *EvtTrb;
3337
3338 Status = EFI_SUCCESS;
3339
3340 InputContext = Xhc->UsbDevContext[SlotId].InputContext;
3341 OutputContext = Xhc->UsbDevContext[SlotId].OutputContext;
3342 //
3343 // XHCI 4.6.6 Configure Endpoint
3344 // When this command is used to "Set an Alternate Interface on a device", software shall set the Drop
3345 // Context and Add Context flags as follows:
3346 // 1) If an endpoint is not modified by the Alternate Interface setting, then software shall set the Drop
3347 // Context and Add Context flags to '0'.
3348 //
3349 // Except the interface indicated by Reqeust->Index, no impact to other interfaces.
3350 // So the default Drop Context and Add Context flags can be '0' to cover 1).
3351 //
3352 ZeroMem (InputContext, sizeof (INPUT_CONTEXT));
3353 CopyMem (&InputContext->Slot, &OutputContext->Slot, sizeof (SLOT_CONTEXT));
3354
3355 ASSERT (ConfigDesc != NULL);
3356
3357 MaxDci = 0;
3358
3359 IfDescActive = NULL;
3360 IfDescSet = NULL;
3361
3362 IfDesc = (USB_INTERFACE_DESCRIPTOR *)(ConfigDesc + 1);
3363 while ((UINTN) IfDesc < ((UINTN) ConfigDesc + ConfigDesc->TotalLength)) {
3364 if ((IfDesc->DescriptorType == USB_DESC_TYPE_INTERFACE) && (IfDesc->Length >= sizeof (USB_INTERFACE_DESCRIPTOR))) {
3365 if (IfDesc->InterfaceNumber == (UINT8) Request->Index) {
3366 if (IfDesc->AlternateSetting == Xhc->UsbDevContext[SlotId].ActiveAlternateSetting[IfDesc->InterfaceNumber]) {
3367 //
3368 // Find out the active interface descriptor.
3369 //
3370 IfDescActive = IfDesc;
3371 } else if (IfDesc->AlternateSetting == (UINT8) Request->Value) {
3372 //
3373 // Find out the interface descriptor to set.
3374 //
3375 IfDescSet = IfDesc;
3376 }
3377 }
3378 }
3379 IfDesc = (USB_INTERFACE_DESCRIPTOR *)((UINTN)IfDesc + IfDesc->Length);
3380 }
3381
3382 //
3383 // XHCI 4.6.6 Configure Endpoint
3384 // When this command is used to "Set an Alternate Interface on a device", software shall set the Drop
3385 // Context and Add Context flags as follows:
3386 // 2) If an endpoint previously disabled, is enabled by the Alternate Interface setting, then software shall set
3387 // the Drop Context flag to '0' and Add Context flag to '1', and initialize the Input Endpoint Context.
3388 // 3) If an endpoint previously enabled, is disabled by the Alternate Interface setting, then software shall set
3389 // the Drop Context flag to '1' and Add Context flag to '0'.
3390 // 4) If a parameter of an enabled endpoint is modified by an Alternate Interface setting, the Drop Context
3391 // and Add Context flags shall be set to '1'.
3392 //
3393 // Below codes are to cover 2), 3) and 4).
3394 //
3395
3396 if ((IfDescActive != NULL) && (IfDescSet != NULL)) {
3397 NumEp = IfDescActive->NumEndpoints;
3398 EpDesc = (USB_ENDPOINT_DESCRIPTOR *) (IfDescActive + 1);
3399 for (EpIndex = 0; EpIndex < NumEp; EpIndex++) {
3400 while (EpDesc->DescriptorType != USB_DESC_TYPE_ENDPOINT) {
3401 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
3402 }
3403
3404 if (EpDesc->Length < sizeof (USB_ENDPOINT_DESCRIPTOR)) {
3405 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
3406 continue;
3407 }
3408
3409 EpAddr = (UINT8) (EpDesc->EndpointAddress & 0x0F);
3410 Direction = (UINT8) ((EpDesc->EndpointAddress & 0x80) ? EfiUsbDataIn : EfiUsbDataOut);
3411
3412 Dci = XhcEndpointToDci (EpAddr, Direction);
3413 ASSERT (Dci < 32);
3414 if (Dci > MaxDci) {
3415 MaxDci = Dci;
3416 }
3417 //
3418 // XHCI 4.3.6 - Setting Alternate Interfaces
3419 // 1) Stop any Running Transfer Rings affected by the Alternate Interface setting.
3420 //
3421 Status = XhcStopEndpoint (Xhc, SlotId, Dci);
3422 if (EFI_ERROR (Status)) {
3423 return Status;
3424 }
3425 //
3426 // XHCI 4.3.6 - Setting Alternate Interfaces
3427 // 2) Free Transfer Rings of all endpoints that will be affected by the Alternate Interface setting.
3428 //
3429 if (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci - 1] != NULL) {
3430 RingSeg = ((TRANSFER_RING *)(UINTN)Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci - 1])->RingSeg0;
3431 if (RingSeg != NULL) {
3432 UsbHcFreeMem (Xhc->MemPool, RingSeg, sizeof (TRB_TEMPLATE) * TR_RING_TRB_NUMBER);
3433 }
3434 FreePool (Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci - 1]);
3435 Xhc->UsbDevContext[SlotId].EndpointTransferRing[Dci - 1] = NULL;
3436 }
3437
3438 //
3439 // Set the Drop Context flag to '1'.
3440 //
3441 InputContext->InputControlContext.Dword1 |= (BIT0 << Dci);
3442
3443 EpDesc = (USB_ENDPOINT_DESCRIPTOR *)((UINTN)EpDesc + EpDesc->Length);
3444 }
3445
3446 //
3447 // XHCI 4.3.6 - Setting Alternate Interfaces
3448 // 3) Clear all the Endpoint Context fields of each endpoint that will be disabled by the Alternate
3449 // Interface setting, to '0'.
3450 //
3451 // The step 3) has been covered by the ZeroMem () to InputContext at the start of the function.
3452 //
3453
3454 //
3455 // XHCI 4.3.6 - Setting Alternate Interfaces
3456 // 4) For each endpoint enabled by the Configure Endpoint Command:
3457 // a. Allocate a Transfer Ring.
3458 // b. Initialize the Transfer Ring Segment(s) by clearing all fields of all TRBs to '0'.
3459 // c. Initialize the Endpoint Context data structure.
3460 //
3461 Dci = XhcInitializeEndpointContext (Xhc, SlotId, DeviceSpeed, InputContext, IfDescSet);
3462 if (Dci > MaxDci) {
3463 MaxDci = Dci;
3464 }
3465
3466 InputContext->InputControlContext.Dword2 |= BIT0;
3467 InputContext->Slot.ContextEntries = MaxDci;
3468 //
3469 // XHCI 4.3.6 - Setting Alternate Interfaces
3470 // 5) Issue and successfully complete a Configure Endpoint Command.
3471 //
3472 ZeroMem (&CmdTrbCfgEP, sizeof (CmdTrbCfgEP));
3473 PhyAddr = UsbHcGetPciAddrForHostAddr (Xhc->MemPool, InputContext, sizeof (INPUT_CONTEXT));
3474 CmdTrbCfgEP.PtrLo = XHC_LOW_32BIT (PhyAddr);
3475 CmdTrbCfgEP.PtrHi = XHC_HIGH_32BIT (PhyAddr);
3476 CmdTrbCfgEP.CycleBit = 1;
3477 CmdTrbCfgEP.Type = TRB_TYPE_CON_ENDPOINT;
3478 CmdTrbCfgEP.SlotId = Xhc->UsbDevContext[SlotId].SlotId;
3479 DEBUG ((EFI_D_INFO, "SetInterface: Configure Endpoint\n"));
3480 Status = XhcCmdTransfer (
3481 Xhc,
3482 (TRB_TEMPLATE *) (UINTN) &CmdTrbCfgEP,
3483 XHC_GENERIC_TIMEOUT,
3484 (TRB_TEMPLATE **) (UINTN) &EvtTrb
3485 );
3486 if (EFI_ERROR (Status)) {
3487 DEBUG ((EFI_D_ERROR, "SetInterface: Config Endpoint Failed, Status = %r\n", Status));
3488 } else {
3489 //
3490 // Update the active AlternateSetting.
3491 //
3492 Xhc->UsbDevContext[SlotId].ActiveAlternateSetting[(UINT8) Request->Index] = (UINT8) Request->Value;
3493 }
3494 }
3495
3496 return Status;
3497 }
3498
3499 /**
3500 Set interface through XHCI's Configure_Endpoint cmd.
3501
3502 @param Xhc The XHCI Instance.
3503 @param SlotId The slot id to be configured.
3504 @param DeviceSpeed The device's speed.
3505 @param ConfigDesc The pointer to the usb device configuration descriptor.
3506 @param Request USB device request to send.
3507
3508 @retval EFI_SUCCESS Successfully set interface.
3509
3510 **/
3511 EFI_STATUS
3512 EFIAPI
3513 XhcSetInterface64 (
3514 IN USB_XHCI_INSTANCE *Xhc,
3515 IN UINT8 SlotId,
3516 IN UINT8 DeviceSpeed,
3517 IN USB_CONFIG_DESCRIPTOR *ConfigDesc,
3518 IN EFI_USB_DEVICE_REQUEST *Request
3519 )
3520 {
3521 EFI_STATUS Status;
3522 USB_INTERFACE_DESCRIPTOR *IfDescActive;
3523 USB_INTERFACE_DESCRIPTOR *IfDescSet;
3524 USB_INTERFACE_DESCRIPTOR *IfDesc;
3525 USB_ENDPOINT_DESCRIPTOR *EpDesc;
3526 UINTN NumEp;
3527 UINTN EpIndex;
3528 UINT8 EpAddr;
3529 UINT8 Direction;
3530 UINT8 Dci;
3531 UINT8 MaxDci;
3532 EFI_PHYSICAL_ADDRESS PhyAddr;
3533 VOID *RingSeg;
3534
3535 CMD_TRB_CONFIG_ENDPOINT CmdTrbCfgEP;
3536 INPUT_CONTEXT_64 *InputContext;
3537 DEVICE_CONTEXT_64 *OutputContext;
3538 EVT_TRB_COMMAND_COMPLETION *EvtTrb;
3539
3540 Status = EFI_SUCCESS;
3541
3542 InputContext = Xhc->UsbDevContext[SlotId].InputContext;
3543 OutputContext = Xhc->UsbDevContext[SlotId].OutputContext;
3544 //
3545 // XHCI 4.6.6 Configure Endpoint
3546 // When this command is used to "Set an Alternate Interface on a device", software shall set the Drop
3547 // Context and Add Context flags as follows:
3548 // 1) If an endpoint is not modified by the Alternate Interface setting, then software shall set the Drop
3549 // Context and Add Context flags to '0'.
3550 //
3551 // Except the interface indicated by Reqeust->Index, no impact to other interfaces.
3552 // So the default Drop Context and Add Context flags can be '0' to cover 1).
3553 //
3554 ZeroMem (InputContext, sizeof (INPUT_CONTEXT_64));
3555 CopyMem (&InputContext->Slot, &OutputContext->Slot, sizeof (SLOT_CONTEXT_64));
3556
3557 ASSERT (ConfigDesc != NULL);
3558
3559 MaxDci = 0;
3560
3561 IfDescActive = NULL;
3562 IfDescSet = NULL;
3563
3564 IfDesc = (USB_INTERFACE_DESCRIPTOR *)(ConfigDesc + 1);
3565 while ((UINTN) IfDesc < ((UINTN) ConfigDesc + ConfigDesc->TotalLength)) {
3566 if ((IfDesc->DescriptorType == USB_DESC_TYPE_INTERFACE) && (IfDesc->Length >= sizeof (USB_INTERFACE_DESCRIPTOR))) {
3567 if (IfDesc->InterfaceNumber == (UINT8) Request->Index) {
3568 if (IfDesc->AlternateSetting == Xhc->UsbDevContext[SlotId].ActiveAlternateSetting[IfDesc->InterfaceNumber]) {
3569 //
3570 // Find out the active interface descriptor.
3571 //
3572 IfDescActive = IfDesc;
3573 } else if (IfDesc->AlternateSetting == (UINT8) Request->Value) {
3574 //
3575 // Find out the interface descriptor to set.
3576 //
3577 IfDescSet = IfDesc;
3578 }
3579 }
3580 }
3581 IfDesc = (USB_INTERFACE_DESCRIPTOR *)((UINTN)IfDesc + IfDesc->Length);
3582 }
3583
3584 //
3585 // XHCI 4.6.6 Configure Endpoint
3586 // When this command is used to "Set an Alternate Interface on a device"