4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Debug Port Library implementation based on usb debug port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Usb debug device descriptor, which is defined at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// USB2 Debug Device Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Usb debug port register file, which is defined at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// EHCI Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The internal data structure of DEBUG_PORT_HANDLE, which stores some
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// important datum which are used across various phases.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The usb debug port memory BAR number in EHCI configuration space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The offset of usb debug port registers in EHCI memory range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The usb debug port memory BAR address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The EHCI memory BAR address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The Bulk In endpoint toggle bit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The Bulk Out endpoint toggle bit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The available data length in the following data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The data buffer. Maximum length is 8 bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The global variable which can be used after memory is ready.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Calculate the usb debug port bar address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DebugPortOffset Get usb debug port offset in the usb debug port memory space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DebugPortBarNumbar Get the bar number at which usb debug port is located.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_UNSUPPORTED The usb host controller does not supported usb debug port capability.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS Get bar and offset successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VendorId = PciRead16 (PcdGet32(PcdUsbEhciPciAddress) + PCI_VENDOR_ID_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DeviceId = PciRead16 (PcdGet32(PcdUsbEhciPciAddress) + PCI_DEVICE_ID_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((VendorId == 0xFFFF) || (DeviceId == 0xFFFF)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ProgInterface = PciRead8 (PcdGet32(PcdUsbEhciPciAddress) + PCI_CLASSCODE_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SubClassCode = PciRead8 (PcdGet32(PcdUsbEhciPciAddress) + PCI_CLASSCODE_OFFSET + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BaseCode = PciRead8 (PcdGet32(PcdUsbEhciPciAddress) + PCI_CLASSCODE_OFFSET + 2);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((ProgInterface != PCI_IF_EHCI) || (SubClassCode != PCI_CLASS_SERIAL_USB) || (BaseCode != PCI_CLASS_SERIAL)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Enable Ehci Host Controller MMIO Space.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PciStatus = PciRead16 (PcdGet32(PcdUsbEhciPciAddress) + PCI_PRIMARY_STATUS_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((PciStatus & EFI_PCI_STATUS_CAPABILITY) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The Pci Device Doesn't Support Capability Pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get Pointer To Capability List
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapabilityPtr = PciRead8(PcdGet32(PcdUsbEhciPciAddress) + PCI_CAPBILITY_POINTER_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Find Capability ID 0xA, Which Is For Debug Port
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while (CapabilityPtr != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapabilityId = PciRead8(PcdGet32(PcdUsbEhciPciAddress) + CapabilityPtr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CapabilityId == PCI_CAPABILITY_ID_DEBUG_PORT) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapabilityPtr = PciRead8(PcdGet32(PcdUsbEhciPciAddress) + CapabilityPtr + 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // No Debug Port Capability Found
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get The Base Address Of Debug Port Register In Debug Port Capability Register
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *DebugPortOffset = (UINT16)(PciRead16(PcdGet32(PcdUsbEhciPciAddress) + CapabilityPtr + 2) & 0x1FFF);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *DebugPortBarNumbar = (UINT8)((PciRead16(PcdGet32(PcdUsbEhciPciAddress) + CapabilityPtr + 2) >> 13) - 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Do a usb IN transaction by usb debug port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DebugPortRegister Pointer to the base address of usb debug port register interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Pointer to the buffer receiving data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length Number of bytes of the received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The token PID for each USB transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Addr The usb device address for usb transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ep The endpoint for usb transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataToggle The toggle bit used at usb transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The IN transaction is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER The parameters passed in are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_DEVICE_ERROR The IN transaction comes across error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DebugPortRegister->UsbAddress = (UINT8)(Addr & 0x7F);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DebugPortRegister->UsbEndPoint = (UINT8)(Ep & 0xF);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Clearing W/R bit to indicate it's a READ operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioAnd32((UINTN)&DebugPortRegister->ControlStatus, (UINT32)~BIT4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Setting GO bit as well as clearing DONE bit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioOr32((UINTN)&DebugPortRegister->ControlStatus, (UINT32)BIT5);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Wait for completing the request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while ((MmioRead32((UINTN)&DebugPortRegister->ControlStatus) & (UINT32)BIT16) == 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if the request is executed successfully or not.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((MmioRead32((UINTN)&DebugPortRegister->ControlStatus)) & BIT6) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Make sure the received data are not beyond the allowable maximum length - 8 byte
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((MmioRead32((UINTN)&DebugPortRegister->ControlStatus)) & 0xF) > USB_DEBUG_PORT_MAX_PACKET_SIZE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *Length = (UINT8)(MmioRead32((UINTN)&DebugPortRegister->ControlStatus) & 0xF);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Buffer[Index] = DebugPortRegister->DataBuffer[Index];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Do a usb SETUP/OUT transaction by usb debug port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DebugPortRegister Pointer to the base address of usb debug port register interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Pointer to the buffer receiving data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length Number of bytes of the received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The token PID for each USB transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Addr The usb device address for usb transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ep The endpoint for usb transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataToggle The toggle bit used at usb transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The IN transaction is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER The parameters passed in are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_DEVICE_ERROR The IN transaction comes across error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DebugPortRegister->UsbAddress = (UINT8)(Addr & 0x7F);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DebugPortRegister->UsbEndPoint = (UINT8)(Ep & 0xF);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill in the data length and corresponding data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioAnd32((UINTN)&DebugPortRegister->ControlStatus, (UINT32)~0xF);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioOr32((UINTN)&DebugPortRegister->ControlStatus, Length & 0xF);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DebugPortRegister->DataBuffer[Index] = Buffer[Index];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Setting W/R bit to indicate it's a WRITE operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioOr32((UINTN)&DebugPortRegister->ControlStatus, BIT4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Setting GO bit as well as clearing DONE bit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioOr32((UINTN)&DebugPortRegister->ControlStatus, BIT5);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Wait for completing the request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while ((MmioRead32((UINTN)&DebugPortRegister->ControlStatus) & BIT16) == 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if the request is executed successfully or not.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((MmioRead32((UINTN)&DebugPortRegister->ControlStatus)) & BIT6) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Make sure the sent data are not beyond the allowable maximum length - 8 byte
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((MmioRead32((UINTN)&DebugPortRegister->ControlStatus)) & 0xF) > USB_DEBUG_PORT_MAX_PACKET_SIZE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Do a usb control transfer by usb debug port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DebugPortRegister Pointer to the base address of usb debug port register interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SetupPacket The token PID for each USB transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Addr The usb device address for usb transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ep The endpoint for usb transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Data Pointer to the buffer receiving data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DataLength Number of bytes of the received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_SUCCESS The IN transaction is executed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_INVALID_PARAMETER The parameters passed in are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval RETURN_DEVICE_ERROR The IN transaction comes across error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Setup Phase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortOut(DebugPortRegister, (UINT8 *)SetupPacket, (UINT8)sizeof(USB_DEVICE_REQUEST), SETUP_PID, Addr, Ep, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Data Phase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get Data From Device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortIn(DebugPortRegister, Data, DataLength, INPUT_PID, Addr, Ep, 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Send Data To Device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortOut(DebugPortRegister, Data, *DataLength, OUTPUT_PID, Addr, Ep, 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Status Phase
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // For READ operation, Data Toggle in Status Phase Should be 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortOut(DebugPortRegister, NULL, 0, OUTPUT_PID, Addr, Ep, 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // For WRITE operation, Data Toggle in Status Phase Should be 1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortIn(DebugPortRegister, ReturnStatus, &Temp, INPUT_PID, Addr, Ep, 1);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Check if it needs to re-initialize usb debug port hardware.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync During different phases switch, such as SEC to PEI or PEI to DXE or DXE to SMM, we should check
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync whether the usb debug port hardware configuration is changed. Such case can be triggerred by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Pci bus resource allocation and so on.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle Debug port handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The usb debug port hardware configuration is changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The usb debug port hardware configuration is not changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EhciMemoryBase = 0xFFFFFC00 & PciRead32(PcdGet32(PcdUsbEhciPciAddress) + PCI_BASE_ADDRESSREG_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortMemoryBase = 0xFFFFFC00 & PciRead32(PcdGet32(PcdUsbEhciPciAddress) + PCI_BASE_ADDRESSREG_OFFSET + Handle->DebugPortBarNumber * 4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (UsbDebugPortMemoryBase != Handle->UsbDebugPortMemoryBase) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Handle->UsbDebugPortMemoryBase = UsbDebugPortMemoryBase;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Enable Ehci Memory Space Access
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PciCmd = PciRead16 (PcdGet32(PcdUsbEhciPciAddress) + PCI_COMMAND_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((PciCmd & EFI_PCI_COMMAND_MEMORY_SPACE) == 0) || ((PciCmd & EFI_PCI_COMMAND_BUS_MASTER) == 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if the debug port is enabled and owned by myself.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortRegister = (USB_DEBUG_PORT_REGISTER *)(Handle->UsbDebugPortMemoryBase + Handle->DebugPortOffset);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((MmioRead32((UINTN)&UsbDebugPortRegister->ControlStatus) &
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (USB_DEBUG_PORT_OWNER | USB_DEBUG_PORT_ENABLE | USB_DEBUG_PORT_IN_USE)) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initialize usb debug port hardware.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 1. reset ehci host controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2. set right port to debug port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 3. find a usb debug device is attached by getting debug device descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 4. set address for the usb debug device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 5. configure the usb debug device to debug mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle Debug port handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE The usb debug port hardware configuration is changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE The usb debug port hardware configuration is not changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortRegister = (USB_DEBUG_PORT_REGISTER *)(Handle->UsbDebugPortMemoryBase + Handle->DebugPortOffset);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PciCmd = PciRead16 (PcdGet32(PcdUsbEhciPciAddress) + PCI_COMMAND_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbHCSParam = (UINT32 *)(Handle->EhciMemoryBase + 0x04);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbCmd = (UINT32 *)(Handle->EhciMemoryBase + 0x20);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbStatus = (UINT32 *)(Handle->EhciMemoryBase + 0x24);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // initialize the data toggle used by bulk in/out endpoint.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Enable Ehci Memory Space Access
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((PciCmd & EFI_PCI_COMMAND_MEMORY_SPACE) == 0) || ((PciCmd & EFI_PCI_COMMAND_BUS_MASTER) == 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PciCmd |= EFI_PCI_COMMAND_MEMORY_SPACE | EFI_PCI_COMMAND_BUS_MASTER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PciWrite16(PcdGet32(PcdUsbEhciPciAddress) + PCI_COMMAND_OFFSET, PciCmd);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If the host controller is not halted, then halt it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while ((MmioRead32((UINTN)UsbStatus) & BIT12) == 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // reset the host controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // ensure that the host controller is reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Start the host controller if it's not running
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // ensure that the host controller is started (HALTED bit must be cleared)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // First get the ownership of port 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioOr32((UINTN)&UsbDebugPortRegister->ControlStatus, USB_DEBUG_PORT_OWNER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Find out which port is used as debug port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DebugPortNumber = (UINT8)((MmioRead32((UINTN)UsbHCSParam) & 0x00F00000) >> 20);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Should find a non low-speed device is connected
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PortStatus = (UINT32 *)(Handle->EhciMemoryBase + 0x64 + (DebugPortNumber - 1) * 4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!(MmioRead32((UINTN)PortStatus) & BIT0) || ((MmioRead32((UINTN)PortStatus) & USB_PORT_LINE_STATUS_MASK) == USB_PORT_LINE_STATUS_LS)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Reset the debug port
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The port enabled bit should be set by HW.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Enable Usb Debug Port Capability
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioOr32((UINTN)&UsbDebugPortRegister->ControlStatus, USB_DEBUG_PORT_ENABLE | USB_DEBUG_PORT_IN_USE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Start to communicate with Usb Debug Device to see if the attached device is usb debug device or not.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)sizeof (USB_DEBUG_PORT_DESCRIPTOR);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // It's not a dedicated usb debug device, should use address 0 to get debug descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortControlTransfer (UsbDebugPortRegister, &mGetDebugDescriptor, 0x0, 0x0, (UINT8*)&UsbDebugPortDescriptor, &Length);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The device is not a usb debug device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // set usb debug device address as 0x7F.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortControlTransfer (UsbDebugPortRegister, &mSetDebugAddress, 0x0, 0x0, NULL, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The device can not work well.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // enable the usb debug feature.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortControlTransfer (UsbDebugPortRegister, &mSetDebugFeature, 0x7F, 0x0, NULL, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Read data from debug device and save the datas in buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reads NumberOfBytes data bytes from a debug device into the buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Buffer. The number of bytes actually read is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the return value is less than NumberOfBytes, then the rest operation failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If NumberOfBytes is zero, then return 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle Debug port handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Pointer to the data buffer to store the data read from the debug device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumberOfBytes Number of bytes which will be read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Timeout Timeout value for reading from debug device. It unit is Microsecond.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval 0 Read data failed, no data is to be read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval >0 Actual number of bytes read from debug device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If Handle is NULL, it means memory is ready for use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Use global variable to store handle value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortHandle = (USB_DEBUG_PORT_HANDLE *)Handle;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if debug port is ready
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (NeedReinitializeHardware(UsbDebugPortHandle)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = InitializeUsbDebugHardware (UsbDebugPortHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortRegister = (USB_DEBUG_PORT_REGISTER *)(UsbDebugPortHandle->UsbDebugPortMemoryBase + UsbDebugPortHandle->DebugPortOffset);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // First read data from buffer, then read debug port hw to get received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (NumberOfBytes <= UsbDebugPortHandle->DataCount) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < UsbDebugPortHandle->DataCount - Total; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortHandle->Data[Index] = UsbDebugPortHandle->Data[Total + Index];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortHandle->DataCount = (UINT8)(UsbDebugPortHandle->DataCount - (UINT8)Total);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If Timeout is equal to 0, then it means it should always wait until all datum required are received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Read remaining data by executing one or more usb debug transfer transactions at usb debug port hw.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while ((Total < NumberOfBytes) && (Timeout != 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortIn(UsbDebugPortRegister, Buffer + Total, &Received, INPUT_PID, 0x7f, 0x82, UsbDebugPortHandle->BulkInToggle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortIn(UsbDebugPortRegister, &UsbDebugPortHandle->Data[0], &Received, INPUT_PID, 0x7f, 0x82, UsbDebugPortHandle->BulkInToggle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy required data from the data buffer to user buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (Buffer + Total)[Index] = UsbDebugPortHandle->Data[Index];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // reorder the data buffer to make available data arranged from the beginning of the data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < Received - Length; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortHandle->Data[Index] = UsbDebugPortHandle->Data[Length + Index];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // fixup the real received length in Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Write data from buffer to debug device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Writes NumberOfBytes data bytes from Buffer to the debug device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The number of bytes actually written to the debug device is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the return value is less than NumberOfBytes, then the write operation failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If NumberOfBytes is zero, then return 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle Debug port handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Pointer to the data buffer to be written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumberOfBytes Number of bytes to written to the debug device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval 0 NumberOfBytes is 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval >0 The number of bytes written to the debug device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this value is less than NumberOfBytes, then the read operation failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If Handle is NULL, it means memory is ready for use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Use global variable to store handle value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortHandle = (USB_DEBUG_PORT_HANDLE *)Handle;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if debug port is ready
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (NeedReinitializeHardware(UsbDebugPortHandle)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = InitializeUsbDebugHardware (UsbDebugPortHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortRegister = (USB_DEBUG_PORT_REGISTER *)(UsbDebugPortHandle->UsbDebugPortMemoryBase + UsbDebugPortHandle->DebugPortOffset);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (NumberOfBytes - Total > USB_DEBUG_PORT_MAX_PACKET_SIZE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = UsbDebugPortOut(UsbDebugPortRegister, Buffer + Total, Sent, OUTPUT_PID, 0x7F, 0x01, UsbDebugPortHandle->BulkOutToggle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ReceivedPid = (MmioRead8((UINTN)&UsbDebugPortRegister->ReceivedPid));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If received a NAK_PID on write transaction, it means the usb debug device is busy and can not handle this transaction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // should send the packet again.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Polls a debug device to see if there is any data waiting to be read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Polls a debug device to see if there is any data waiting to be read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If there is data waiting to be read from the debug device, then TRUE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If there is no data waiting to be read from the debug device, then FALSE is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Handle Debug port handle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval TRUE Data is waiting to be read from the debug device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval FALSE There is no data waiting to be read from the serial device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If Handle is NULL, it means memory is ready for use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Use global variable to store handle value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortHandle = (USB_DEBUG_PORT_HANDLE *)Handle;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if debug port is ready
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (NeedReinitializeHardware(UsbDebugPortHandle)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = InitializeUsbDebugHardware(UsbDebugPortHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If the data buffer is not empty, then return TRUE directly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // else initialize a usb read transaction and read data to the data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortRegister = (USB_DEBUG_PORT_REGISTER *)(UsbDebugPortHandle->UsbDebugPortMemoryBase + UsbDebugPortHandle->DebugPortOffset);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Clearing W/R bit to indicate it's a READ operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioAnd32((UINTN)&UsbDebugPortRegister->ControlStatus, (UINT32)~BIT4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Setting GO bit as well as clearing DONE bit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MmioOr32((UINTN)&UsbDebugPortRegister->ControlStatus, (UINT32)BIT5);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Wait for completing the request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while ((MmioRead32((UINTN)&UsbDebugPortRegister->ControlStatus) & (UINT32)BIT16) == 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((MmioRead32((UINTN)&UsbDebugPortRegister->ControlStatus)) & BIT6) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Length = (UINT8)(MmioRead32((UINTN)&UsbDebugPortRegister->ControlStatus) & 0xF);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UsbDebugPortHandle->Data[Index] = UsbDebugPortRegister->DataBuffer[Index];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initialize the debug port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Function is not NULL, Debug Communication Libary will call this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by passing in the Context to be the first parameter. If needed, Debug Communication
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Library will create one debug port handle to be the second argument passing in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync calling the Function, otherwise it will pass NULL to be the second argument of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Function is NULL, and Context is not NULL, the Debug Communication Library could
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a) Return the same handle as passed in (as Context parameter).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync b) Ignore the input Context parameter and create new hanlde to be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If parameter Function is NULL and Context is NULL, Debug Communication Library could
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync created a new handle if needed and return it, otherwise it will return NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Context Context needed by callback function; it was optional.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Function Continue function called by Debug Communication library;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it was optional.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @return The debug port handle created by Debug Communication Library if Function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = CalculateUsbDebugPortBar(&Handle.DebugPortOffset, &Handle.DebugPortBarNumber);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_ERROR, "USB Debug Port: the pci device pointed by PcdUsbEhciPciAddress is not EHCI host controller or does not support debug port capability!\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Handle.EhciMemoryBase = 0xFFFFFC00 & PciRead32(PcdGet32(PcdUsbEhciPciAddress) + PCI_BASE_ADDRESSREG_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Usb Debug Port MMIO Space Is Not Enabled. Assumption here that DebugPortBase is zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PciWrite32(PcdGet32(PcdUsbEhciPciAddress) + PCI_BASE_ADDRESSREG_OFFSET, PcdGet32(PcdUsbEhciMemorySpaceBase));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Handle.EhciMemoryBase = 0xFFFFFC00 & PciRead32(PcdGet32(PcdUsbEhciPciAddress) + PCI_BASE_ADDRESSREG_OFFSET);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Handle.UsbDebugPortMemoryBase = 0xFFFFFC00 & PciRead32(PcdGet32(PcdUsbEhciPciAddress) + PCI_BASE_ADDRESSREG_OFFSET + Handle.DebugPortBarNumber * 4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Usb Debug Port MMIO Space Is Not Enabled. Assumption here that DebugPortBase is zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PciWrite32(PcdGet32(PcdUsbEhciPciAddress) + PCI_BASE_ADDRESSREG_OFFSET + Handle.DebugPortBarNumber * 4, PcdGet32(PcdUsbDebugPortMemorySpaceBase));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Handle.UsbDebugPortMemoryBase = 0xFFFFFC00 & PciRead32(PcdGet32(PcdUsbEhciPciAddress) + PCI_BASE_ADDRESSREG_OFFSET + Handle.DebugPortBarNumber * 4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_ERROR, "USB Debug Port: Initialization failed, please check if USB debug cable is plugged into EHCI debug port correctly!\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set debug port initialized successfully flag
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem(&mUsbDebugPortHandle, &Handle, sizeof (USB_DEBUG_PORT_HANDLE));