EVT_UFX_DEVICE_TEST_MODE_SET callback function (ufxclient.h)

Article
02/22/2024

The client driver's implementation to set the test mode of the function controller.

Syntax

EVT_UFX_DEVICE_TEST_MODE_SET EvtUfxDeviceTestModeSet;

void EvtUfxDeviceTestModeSet(
  [in] UFXDEVICE unnamedParam1,
  [in] ULONG unnamedParam2
)
{...}

Parameters

[in] unnamedParam1

The handle to a USB device object that the client driver received in a previous call to the UfxDeviceCreate.

[in] unnamedParam2

Test mode selector value as defined by the USB 2.0 Specification. These values are defined in usbfnbase.h

USB_TEST_MODE_TEST_J 0x01
USB_TEST_MODE_TEST_K 0x02
USB_TEST_MODE_TEST_SE0_NAK 0x03
USB_TEST_MODE_TEST_PACKET 0x04
USB_TEST_MODE_TEST_FORCE_ENABLE 0x05

Return value

None

Remarks

The client driver for the function host controller registers its EVT_UFX_DEVICE_TEST_MODE_SET implementation with the USB function class extension (UFX) by calling the UfxDeviceCreate method.

The client driver indicates completion of this event by calling the UfxDeviceEventComplete method.

Examples

EVT_UFX_DEVICE_TEST_MODE_SET UfxDevice_EvtDeviceTestModeSet;

VOID
UfxDevice_EvtDeviceTestModeSet (
    _In_ UFXDEVICE UfxDevice,
    _In_ ULONG TestMode
    )
/*++

Routine Description:

    EvtDeviceTestModeSet handler for the UFXDEVICE object.
    
    Handles a set test mode request from the host.  Places the controller into 
    the specified test mode.

Arguments:

    UfxDevice - UFXDEVICE object representing the device.

    TestMode - Test mode value.  See Section 7.1.20 of the USB 2.0 specification for definitions of 
               each test mode.

--*/
{
    NTSTATUS Status;

    UNREFERENCED_PARAMETER(TestMode);

    TraceEntry();

    //
    // #### TODO: Insert code to put the controller into the specified test mode ####
    //

    Status = STATUS_SUCCESS;

    UfxDeviceEventComplete(UfxDevice, Status);
    TraceExit();
}

Requirements

Requirement	Value
Target Platform	Windows
Minimum KMDF version	1.0
Minimum UMDF version	2.0
Header	ufxclient.h
IRQL	<=DISPATCH_LEVEL

Share via