UcmUcsiPpmCreate function

Description

Creates a Platform Policy Manager (PPM) object.

Parameters

WdfDevice [in]

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

Config [in]

A pointer to a caller-supplied UCMUCSI_PPM_CONFIG structure that is initialized by calling UCMUCSI_PPM_CONFIG_INIT. The ConnectorCollectionHandle member must be set to the handle retrieved in a previous call to UcmUcsiConnectorCollectionCreate.

Attributes [in]

A pointer to a caller-supplied WDF_OBJECT_ATTRIBUTES structure that contains attributes for the new connector collection object. This parameter is optional and can be WDF_NO_OBJECT_ATTRIBUTES.

PPMObject [out]

A pointer to a location that receives a handle to the new PPM object.

Return value

Returns STATUS_SUCCESS if the operation succeeds. Otherwise, this method can return an appropriate NTSTATUS value.

Remarks

The client driver is expected to call UcmUcsiPpmCreate from the EVT_WDF_DEVICE_PREPARE_HARDWARE callback function.

The structure passed in _Config_ contains Type-C connector information that is necessary for creating connectors with USB Type-C connector class extension (UcmCx) by using UcmConnectorCreate and are not obtainable from PPM through UCSI commands such as GetCapability or GetConnectorCapability.

The _Config_ structure also contains connector IDs, which are required for one-to-one mapping between USB Type-C connectors and USB ports.

The PPM object is also a WDFOBJECT and creates a one-to-one association with the WDFDEVICE handle provided by the client driver.

The PPM object is parented to the WDFOBJECT even when UcmUcsiPpmCreate is called by passing WDF_NO_ATTRIBUTES. The lifetime of the object is manager by the framework.

See also