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