#include "DebugCommunicationLibUsb3Internal.h"

Functions
VOID	XhcSetR32Bit (IN OUT UINTN Register, IN UINT32 BitMask)

VOID	XhcClearR32Bit (IN OUT UINTN Register, IN UINT32 BitMask)

VOID	XhcWriteDebugReg (IN USB3_DEBUG_PORT_HANDLE *Handle, IN UINT32 Offset, IN UINT32 Data)

UINT32	XhcReadDebugReg (IN USB3_DEBUG_PORT_HANDLE *Handle, IN UINT32 Offset)

VOID	XhcSetDebugRegBit (IN USB3_DEBUG_PORT_HANDLE *Handle, IN UINT32 Offset, IN UINT32 Bit)

VOID	XhcClearDebugRegBit (IN USB3_DEBUG_PORT_HANDLE *Handle, IN UINT32 Offset, IN UINT32 Bit)

EFI_PHYSICAL_ADDRESS	ProgramXhciBaseAddress (VOID)

VOID	UpdateXhcResource (IN OUT USB3_DEBUG_PORT_HANDLE *Handle, IN EFI_PHYSICAL_ADDRESS XhciMmioBase)

RETURN_STATUS EFIAPI	CalculateUsbDebugPortMmioBase (USB3_DEBUG_PORT_HANDLE *Handle)

BOOLEAN EFIAPI	NeedReinitializeHardware (IN USB3_DEBUG_PORT_HANDLE *Handle)

EFI_STATUS	CreateEventRing (IN USB3_DEBUG_PORT_HANDLE Handle, OUT EVENT_RING EventRing)

VOID	CreateTransferRing (IN USB3_DEBUG_PORT_HANDLE Handle, IN UINT32 TrbNum, OUT TRANSFER_RING TransferRing)

EFI_STATUS	CreateDebugCapabilityContext (IN USB3_DEBUG_PORT_HANDLE *Handle)

VOID	XhcDetectDebugCapabilityReady (IN USB3_DEBUG_PORT_HANDLE *Handle)

RETURN_STATUS EFIAPI	InitializeUsbDebugHardware (IN USB3_DEBUG_PORT_HANDLE *Handle)

VOID	DiscoverInitializeUsbDebugPort (IN USB3_DEBUG_PORT_HANDLE *Handle)

VOID	SetUsb3DebugPortInstance (IN USB3_DEBUG_PORT_HANDLE *Instance)

USB3_DEBUG_PORT_HANDLE *	GetUsb3DebugPortInstance (VOID)

UINTN EFIAPI	DebugPortReadBuffer (IN DEBUG_PORT_HANDLE Handle, IN UINT8 *Buffer, IN UINTN NumberOfBytes, IN UINTN Timeout)

UINTN EFIAPI	DebugPortWriteBuffer (IN DEBUG_PORT_HANDLE Handle, IN UINT8 *Buffer, IN UINTN NumberOfBytes)

BOOLEAN EFIAPI	DebugPortPollBuffer (IN DEBUG_PORT_HANDLE Handle)

DEBUG_PORT_HANDLE EFIAPI	DebugPortInitialize (IN VOID *Context, IN DEBUG_PORT_CONTINUE Function)

Variables
UINT16	mString0Desc []

UINT16	mManufacturerStrDesc []

UINT16	mProductStrDesc []

UINT16	mSerialNumberStrDesc []

Detailed Description

Debug Port Library implementation based on usb3 debug port.

Copyright (c) 2014 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DebugCommunicationLibUsb3Common.c.

Function Documentation

◆ CalculateUsbDebugPortMmioBase()

RETURN_STATUS EFIAPI CalculateUsbDebugPortMmioBase ( USB3_DEBUG_PORT_HANDLE * Handle )

Calculate the usb debug port bar address.

Parameters

Handle Debug port handle.

Return values

RETURN_UNSUPPORTED	The usb host controller does not support usb debug port capability.
RETURN_SUCCESS	Get bar and offset successfully.

Definition at line 236 of file DebugCommunicationLibUsb3Common.c.

◆ CreateDebugCapabilityContext()

EFI_STATUS CreateDebugCapabilityContext ( IN USB3_DEBUG_PORT_HANDLE * Handle )

Create debug capability context for XHC debug device.

Parameters

Handle Debug port handle.

Return values

EFI_SUCCESS	The bit successfully changed by host controller.
EFI_TIMEOUT	The time out occurred.

Definition at line 512 of file DebugCommunicationLibUsb3Common.c.

◆ CreateEventRing()

EFI_STATUS CreateEventRing	(	IN USB3_DEBUG_PORT_HANDLE *	Handle,
		OUT EVENT_RING *	EventRing
	)

Create XHCI event ring.

Parameters

Handle	Debug port handle.
EventRing	The created event ring.

Definition at line 367 of file DebugCommunicationLibUsb3Common.c.

◆ CreateTransferRing()

VOID CreateTransferRing	(	IN USB3_DEBUG_PORT_HANDLE *	Handle,
		IN UINT32	TrbNum,
		OUT TRANSFER_RING *	TransferRing
	)

Create XHCI transfer ring.

Parameters

Handle	Debug port handle.
TrbNum	The number of TRB in the ring.
TransferRing	The created transfer ring.

Definition at line 464 of file DebugCommunicationLibUsb3Common.c.

◆ DebugPortInitialize()

DEBUG_PORT_HANDLE EFIAPI DebugPortInitialize	(	IN VOID *	Context,
		IN DEBUG_PORT_CONTINUE	Function
	)

Initialize the debug port.

If Function is not NULL, Debug Communication Library 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 handle 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.

Parameters

[in]	Context	Context needed by callback function; it was optional.
[in]	Function	Continue function called by Debug Communication library; it was optional.

Returns: The debug port handle created by Debug Communication Library if Function is not NULL.

Definition at line 1122 of file DebugCommunicationLibUsb3Common.c.

◆ DebugPortPollBuffer()

BOOLEAN EFIAPI DebugPortPollBuffer ( IN DEBUG_PORT_HANDLE Handle )

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.

Parameters

Handle Debug port handle.

Return values

TRUE	Data is waiting to be read from the debug device.
FALSE	There is no data waiting to be read from the debug device.

Definition at line 1035 of file DebugCommunicationLibUsb3Common.c.

◆ DebugPortReadBuffer()

UINTN EFIAPI DebugPortReadBuffer	(	IN DEBUG_PORT_HANDLE	Handle,
		IN UINT8 *	Buffer,
		IN UINTN	NumberOfBytes,
		IN UINTN	Timeout
	)

Read data from debug device and save the data 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.

Parameters

Handle	Debug port handle.
Buffer	Pointer to the data buffer to store the data read from the debug device.
NumberOfBytes	Number of bytes which will be read.
Timeout	Timeout value for reading from debug device. Its unit is Microsecond.

Return values

0	Read data failed, no data is to be read.
>0	Actual number of bytes read from debug device.

Definition at line 876 of file DebugCommunicationLibUsb3Common.c.

◆ DebugPortWriteBuffer()

UINTN EFIAPI DebugPortWriteBuffer	(	IN DEBUG_PORT_HANDLE	Handle,
		IN UINT8 *	Buffer,
		IN UINTN	NumberOfBytes
	)

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.

Parameters

Handle	Debug port handle.
Buffer	Pointer to the data buffer to be written.
NumberOfBytes	Number of bytes to written to the debug device.

Return values

0	NumberOfBytes is 0.
>0	The number of bytes written to the debug device. If this value is less than NumberOfBytes, then the write operation failed.

Definition at line 958 of file DebugCommunicationLibUsb3Common.c.

◆ DiscoverInitializeUsbDebugPort()

VOID DiscoverInitializeUsbDebugPort ( IN USB3_DEBUG_PORT_HANDLE * Handle )

Discover and initialize usb debug port.

Parameters

Handle Debug port handle.

Definition at line 797 of file DebugCommunicationLibUsb3Common.c.

◆ GetUsb3DebugPortInstance()

USB3_DEBUG_PORT_HANDLE * GetUsb3DebugPortInstance ( VOID )

Return USB3 debug instance address.

Definition at line 842 of file DebugCommunicationLibUsb3Common.c.

◆ InitializeUsbDebugHardware()

RETURN_STATUS EFIAPI InitializeUsbDebugHardware ( IN USB3_DEBUG_PORT_HANDLE * Handle )

Initialize usb debug port hardware.

Parameters

Handle Debug port handle.

Return values

TRUE	The usb debug port hardware configuration is changed.
FALSE	The usb debug port hardware configuration is not changed.

Definition at line 664 of file DebugCommunicationLibUsb3Common.c.

◆ NeedReinitializeHardware()

BOOLEAN EFIAPI NeedReinitializeHardware ( IN USB3_DEBUG_PORT_HANDLE * Handle )

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 triggered by Pci bus resource allocation and so on.

Parameters

Handle Debug port handle.

Return values

TRUE	The usb debug port hardware configuration is changed.
FALSE	The usb debug port hardware configuration is not changed.

Definition at line 336 of file DebugCommunicationLibUsb3Common.c.

◆ ProgramXhciBaseAddress()

EFI_PHYSICAL_ADDRESS ProgramXhciBaseAddress ( VOID )

Program and enable XHCI MMIO base address.

Returns: XHCI MMIO base address.

Definition at line 171 of file DebugCommunicationLibUsb3Common.c.

◆ SetUsb3DebugPortInstance()

VOID SetUsb3DebugPortInstance ( IN USB3_DEBUG_PORT_HANDLE * Instance )

Set USB3 debug instance address.

Parameters

[in] Instance Debug port instance.

Definition at line 826 of file DebugCommunicationLibUsb3Common.c.

◆ UpdateXhcResource()

VOID UpdateXhcResource	(	IN OUT USB3_DEBUG_PORT_HANDLE *	Handle,
		IN EFI_PHYSICAL_ADDRESS	XhciMmioBase
	)

Update XHC MMIO base address when MMIO base address is changed.

Parameters

Handle	Debug port handle.
XhciMmioBase	XHCI MMIO base address.

Definition at line 208 of file DebugCommunicationLibUsb3Common.c.

◆ XhcClearDebugRegBit()

VOID XhcClearDebugRegBit	(	IN USB3_DEBUG_PORT_HANDLE *	Handle,
		IN UINT32	Offset,
		IN UINT32	Bit
	)

Clear one bit of the debug register while keeping other bits.

Parameters

Handle	Debug port handle.
Offset	The offset of the debug register.
Bit	The bit mask of the register to clear.

Definition at line 151 of file DebugCommunicationLibUsb3Common.c.

◆ XhcClearR32Bit()

VOID XhcClearR32Bit	(	IN OUT UINTN	Register,
		IN UINT32	BitMask
	)

Clears bits as per the enabled bit positions in the mask.

Parameters

[in,out]	Register	UINTN register
[in]	BitMask	32-bit mask

Definition at line 61 of file DebugCommunicationLibUsb3Common.c.

◆ XhcDetectDebugCapabilityReady()

VOID XhcDetectDebugCapabilityReady ( IN USB3_DEBUG_PORT_HANDLE * Handle )

Check if debug device is running.

Parameters

Handle Debug port handle.

Definition at line 618 of file DebugCommunicationLibUsb3Common.c.

◆ XhcReadDebugReg()

UINT32 XhcReadDebugReg	(	IN USB3_DEBUG_PORT_HANDLE *	Handle,
		IN UINT32	Offset
	)

Read XHCI debug register.

Parameters

Handle	Debug port handle.
Offset	The offset of the runtime register.

Returns: The register content read

Definition at line 106 of file DebugCommunicationLibUsb3Common.c.

◆ XhcSetDebugRegBit()

VOID XhcSetDebugRegBit	(	IN USB3_DEBUG_PORT_HANDLE *	Handle,
		IN UINT32	Offset,
		IN UINT32	Bit
	)

Set one bit of the debug register while keeping other bits.

Parameters

Handle	Debug port handle.
Offset	The offset of the debug register.
Bit	The bit mask of the register to set.

Definition at line 129 of file DebugCommunicationLibUsb3Common.c.

◆ XhcSetR32Bit()

VOID XhcSetR32Bit	(	IN OUT UINTN	Register,
		IN UINT32	BitMask
	)

Sets bits as per the enabled bit positions in the mask.

Parameters

[in,out]	Register	UINTN register
[in]	BitMask	32-bit mask

Definition at line 42 of file DebugCommunicationLibUsb3Common.c.

◆ XhcWriteDebugReg()

VOID XhcWriteDebugReg	(	IN USB3_DEBUG_PORT_HANDLE *	Handle,
		IN UINT32	Offset,
		IN UINT32	Data
	)

Write the data to the XHCI debug register.

Parameters

Handle	Debug port handle.
Offset	The offset of the debug register.
Data	The data to write.

Definition at line 82 of file DebugCommunicationLibUsb3Common.c.

Variable Documentation

◆ mManufacturerStrDesc

UINT16 mManufacturerStrDesc[]

Initial value:

= {
  
  (USB_DESC_TYPE_STRING << 8) + MANU_DESC_LEN,
  'I',                                        'n','t', 'e', 'l'
}

Definition at line 17 of file DebugCommunicationLibUsb3Common.c.

◆ mProductStrDesc

UINT16 mProductStrDesc[]

Initial value:

= {
  
  (USB_DESC_TYPE_STRING << 8) +  PRODUCT_DESC_LEN,
  'U',                                            'S','B', ' ', '3', '.', '0', ' ', 'D', 'e', 'b', 'u', 'g', ' ', 'C', 'a', 'b', 'l', 'e'
}

Definition at line 23 of file DebugCommunicationLibUsb3Common.c.

◆ mSerialNumberStrDesc

UINT16 mSerialNumberStrDesc[]

Initial value:

= {
  
  (USB_DESC_TYPE_STRING << 8) +  SERIAL_DESC_LEN,
  '1'
}

Definition at line 29 of file DebugCommunicationLibUsb3Common.c.

◆ mString0Desc

UINT16 mString0Desc[]

Initial value:

= {
  
  (USB_DESC_TYPE_STRING << 8) + STRING0_DESC_LEN,
  0x0409
}

Definition at line 11 of file DebugCommunicationLibUsb3Common.c.

Functions

Variables

Detailed Description

Function Documentation

◆ CalculateUsbDebugPortMmioBase()

◆ CreateDebugCapabilityContext()

◆ CreateEventRing()

◆ CreateTransferRing()

◆ DebugPortInitialize()

◆ DebugPortPollBuffer()

◆ DebugPortReadBuffer()

◆ DebugPortWriteBuffer()

◆ DiscoverInitializeUsbDebugPort()

◆ GetUsb3DebugPortInstance()

◆ InitializeUsbDebugHardware()

◆ NeedReinitializeHardware()

◆ ProgramXhciBaseAddress()

◆ SetUsb3DebugPortInstance()

◆ UpdateXhcResource()

◆ XhcClearDebugRegBit()

◆ XhcClearR32Bit()

◆ XhcDetectDebugCapabilityReady()

◆ XhcReadDebugReg()

◆ XhcSetDebugRegBit()

◆ XhcSetR32Bit()

◆ XhcWriteDebugReg()

Variable Documentation

◆ mManufacturerStrDesc

◆ mProductStrDesc

◆ mSerialNumberStrDesc

◆ mString0Desc