Edit

Share via

UcmTcpciDeviceInitialize function (ucmtcpcidevice.h)

  • Article

Initializes the USB Type-C Port Controller Interface framework extension (UcmTcpciCx).

Syntax

NTSTATUS UcmTcpciDeviceInitialize(
  WDFDEVICE               WdfDevice,
  PUCMTCPCI_DEVICE_CONFIG Config
);

Parameters

WdfDevice

A handle to a framework device object that the client driver received in the previous call to WdfDeviceCreate.

Config

A pointer to a caller-supplied UCMTCPCI_DEVICE_CONFIG structure that is initialized by calling UCMTCPCI_DEVICE_CONFIG_INIT. This value cannot be NULL.

Return value

(NTSTATUS) The method returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method may return an appropriate NTSTATUS error code.

Return code Description
STATUS_INFO_LENGTH_MISMATCH
 Invalid size for the structure pointed to by Config. Must be size of UCMTCPCI_DEVICE_CONFIG.
STATUS_INVALID_DEVICE_STATE
 The Plug and Play state of the framework device object's is uninitialized. Call UcmTcpciDeviceInitialize within the driver's implementation of EVT_WDF_DRIVER_DEVICE_ADD.

Remarks

The client driver must call UcmTcpciDeviceInitialize within the driver's implementation of EVT_WDF_DRIVER_DEVICE_ADD. This method configures the framework device object and allocates resources required, registers for PnP events, and sets up I/O targets.

Requirements

Requirement Value
Minimum supported client Windows 10
Minimum supported server Windows Server 2016
Target Platform Windows
Header ucmtcpcidevice.h
Library Ucmtcpcicxstub.lib
IRQL PASSIVE_LEVEL

See also

WdfDeviceCreate