Share via

Debug Capability Test (Logo)

  • Article

This test measures the ability of a test computer to support debug operations using an xHCI controller, EHCI controller, serial port, 1394 controller, or a network adapter. The test validates that at least one debug port is available.

Test details

   
Specifications
  • System.Fundamentals.DebugPort.SystemExposesDebugInterface
Platforms
  • Windows 10, client editions (x86)
  • Windows 10, client editions (x64)
  • Windows Server 2016 (x64)
  • Windows 10, client editions (Arm64)
Supported Releases
  • Windows 10
  • Windows 10, version 1511
  • Windows 10, version 1607
  • Windows 10, version 1703
  • Windows 10, version 1709
  • Windows 10, version 1803
  • Windows 10, version 1809
  • Windows 10, version 1903
  • Next update to Windows 10
Expected run time (in minutes) 20
Category Development
Timeout (in minutes) 1200
Requires reboot false
Requires special configuration true
Type automatic

Additional documentation

Tests in this feature area might have additional documentation, including prerequisites, setup, and troubleshooting information, that can be found in the following topic(s):

Running the test

To complete this debug test, you must configure two computers. The computer that you are trying to certify is the System under Test (SUT). The second computer is the Host on which the Windows debugger will run. These computers must meet the Windows HLK prerequisites and must be included in the same computer pool. For more information, see Windows HLK Prerequisites. If the device being tested is an XHCI controller, an XHCI controller must be included in both computers. If the XHCI controller in the SUT has any user-accessible ports, the controller must have debug capability.

Important

You must have a cable that is appropriate for the debug transport that is being verified.

Troubleshooting

For generic troubleshooting of HLK test failures, see Troubleshooting Windows HLK Test Failures.

For troubleshooting information, see Troubleshooting the Windows HLK Environment.

This test returns Pass or Fail. To review test details, review the test log from HLK Studio.

More information

Command syntax

In the Parameters window Transport field, enter one transport type (NET, 1394, USB, or Serial). Based on the transport you entered, you must provide the following additional parameters.

Transport type Required parameters Comments

NET

NetHostIP

You must specify a Host IP. If there's more than one controller on the SUT computer, you must specify a BusParams value. Enter Busparams as b.d.f where b, d, and f are the bus number, device number, and function displayed in the device's properties window in Device Manager.

1394

1394Channel

Default is 1. If there's more than one controller on the SUT computer, you must specify a BusParams value. Enter Busparam as b.d.f where b, d, and f are the bus number, device number, and function displayed in the device's properties window in Device Manager.

USB

UsbTargetName

Default is default. If there's more than one USB host controller on the SUT computer, you must specify a BusParams value. Enter Busparams as b.d.f where b, d, and f are the bus number, device number, and function number of the USB host controller that you are using for debugging. These numbers are displayed in the USB host controller's Properties window in Device Manager.

Important

If you are using an EHCI host controller on the SUT computer, the cable must be connected to Port 1 of the controller. You can use the UsbView tool to identify Port 1. USBView is included in the WDK.

Serial

Not required

Default values are sufficient. If necessary, adjust any serial parameter as needed (prefix Serial_).

Parameters

Parameter name Parameter description
Transport Valid values are: net, usb, 1394, or serial
NetHostIP The IP address of the host machine
NetPort Port number for kernel debugging. Port 50000 is recommended.
NetKey The encryption key for kernel debugging. The default key is recommended.
BusParams Ethernet,1394, USB: Used only when more than one controller is present in the system under test. Enter bus params as b.d.f where b, d, and f are the bus number, device number, and function displayed in the relevant device manager properties page.
SerialTargetPort COM port number on the system under test
SerialHostPort COM port number on the host machine
SerialBaudRate BAUD rate for serial communications
UsbTargetName Any string is acceptable. The default is recommended.
1394Channel The common 1394 channel that will be used on both the host and system under test.