Overview

• Feature Name: USB3 Debug
• PI Phase(s) Supported: PEI, DXE
• SMM Required? No

More Information: * USB 3.1 Device-Class Specification for Debug Devices * Intel® UDK Debugger Tool * eXtensible Host Controller Interface for Universal Serial Bus (xHCI) Requirements Specification Rev. 1.2

Purpose

The USB3 Debug feature enables EDK II compliant firmware to use a USB3 port on the system for firmware debug. This is an important capability in firmware development as debug options are often constrained in the later phases of research and development. In many cases, dedicated debug ports are often removed from an end product, especially in small form factor devices where external ports are at a premium.

This feature provides a firmware implementation that enables EDK II firmware debug compliant with the USB 3.1 Device Class Specification for Debug Devices. The feature is intended to be used with the UEFI Development Kit Debugger Tool (Intel® UDK Debugger Tool). The Intel® UDK Debugger Tool can be used in a Linux or Windows host environment to retrieve debug message output and provide runtime debug control via GNU Project Debugger (GDB) or the Microsoft Windows Debug Tool (WinDbg) respectively.

High-Level Theory of Operation

TODO A description of how the device works at a high-level.

The description should not be constrained to implementation details but provide a simple mental model of how the feature is supposed to work.

Firmware Volumes

TODO A bulleted list of the firmware volumes that feature module(s) are placed in.

Modules

TODO A bulleted list of the modules that make up the feature.

TODO Each module in the feature should have a section that describes the module in a level of detail that is useful to better understand the module source code.

TODO Each library in the feature should have a section that describes the library in a level of detail that is useful to better understand the library source code.

Key Functions

TODO A bulleted list of key functions for interacting with the feature.

Not all features need to be listed. Only functions exposed through external interfaces that are important for feature users to be aware of.

Configuration

TODO Information that is useful for configuring the feature.

Not all configuration options need to be listed. This section is used to provide more background on configuration options than possible elsewhere.

Data Flows

TODO Architecturally defined data structures and flows for the feature.

Control Flows

TODO Key control flows for the feature.

Build Flows

TODO Any special build flows should be described in this section.

This is particularly useful for features that use custom build tools or require non-standard tool configuration. If the standard flow in the feature package template is used, this section may be empty.

Test Point Results

TODO The test(s) that can verify porting is complete for the feature.

Each feature must describe at least one test point to verify the feature is successful. If the test point is not implemented, this should be stated.

Functional Exit Criteria

TODO The testable functionality for the feature.

This section should provide an ordered list of criteria that a board integrator can reference to ensure the feature is functional on their board.

Feature Enabling Checklist

TODO An ordered list of required activities to achieve desired functionality for the feature.

Performance Impact

A general expectation for the impact on overall boot performance due to using this feature.

This section is expected to provide guidance on: * How to estimate performance impact due to the feature * How to measure performance impact of the feature * How to manage performance impact of the feature

Common Optimizations

TODO Common size or performance tuning options for this feature.

This section is recommended but not required. If not used, the contents should be left empty.