usbpmapi.h header
This header is the main include header for client drivers of the USB Policy Manager to monitor the activities of USB Type-C connectors and/or get involved into policy decisions of USB Type-C connectors.
Usbpmapi.h includes:
Do not include the preceding header directly. Instead, only include Usbpmapi.h.
For more information, see:
usbpmapi.h contains the following programming interfaces:
Functions
| USBPM_ASSIGN_CONNECTOR_POWER_LEVEL_PARAMS_INIT Initializes a USBPM_ASSIGN_CONNECTOR_POWER_LEVEL_PARAMS structure. |
| UsbPm_AssignConnectorPowerLevel Attempts a PD contract renegotiation with the specified voltage/current/power value. |
| USBPM_CLIENT_CONFIG_EXTRA_INFO_INIT Initializes a USBPM_CLIENT_CONFIG_EXTRA_INFO structure. |
| USBPM_CLIENT_CONFIG_INIT Initializes a USBPM_CLIENT_CONFIG structure. |
| USBPM_CONNECTOR_PROPERTIES_INIT Initializes a USBPM_CONNECTOR_PROPERTIES structure. |
| USBPM_CONNECTOR_STATE_INIT Initializes a USBPM_CONNECTOR_STATE_INIT structure. |
| UsbPm_Deregister Unregisters the client driver with the Policy Manager. |
| USBPM_HUB_CONNECTOR_HANDLES_INIT Initializes a USBPM_HUB_CONNECTOR_HANDLES structure. |
| USBPM_HUB_PROPERTIES_INIT Initializes a [USBPM_HUB_PROPERTIES] structure. |
| UsbPm_Register Registers the client driver with the Policy Manager to report hub arrival/removal and connector state changes. |
| UsbPm_RetrieveConnectorProperties Retrieves the properties of a connector. The properties are static information that do not change during the lifecycle of a connector. |
| UsbPm_RetrieveConnectorState Retrieves the current state of a connector. Unlike connector properties, state information is dynamic, which can change at runtime. |
| UsbPm_RetrieveHubConnectorHandles Retrieves connector handles for all connectors of a hub. |
| UsbPm_RetrieveHubProperties Retrieves the properties of a hub. Properties are static information that do not change during the lifecycle of a hub. |
Callback functions
| EVT_USBPM_EVENT_CALLBACK Sends notifications about hub arrival/removal and connector state changes. |
Structures
| USBPM_ASSIGN_CONNECTOR_POWER_LEVEL_PARAMS Describes the parameters for the UsbPm_AssignConnectorPowerLevel. |
| USBPM_CLIENT_CONFIG The configuration structure used in the registering the client driver with the Policy Manager |
| USBPM_CLIENT_CONFIG_EXTRA_INFO Contains optional information used to configure the client driver's registration. |
| USBPM_CONNECTOR_PROPERTIES Describes the properties of a connector. |
| USBPM_CONNECTOR_STATE Describes the state of a connector. |
| USBPM_EVENT_CALLBACK_PARAMS Contains the details of the events related to changes in policy manager arrival/removal, hub arrival/removal or connector state change. |
| USBPM_HUB_CONNECTOR_HANDLES Stores the connector handles for all connectors on a hub. |
| USBPM_HUB_PROPERTIES Properties of a connector hub. |
Enumerations
| USBPM_ACCESS_TYPE Defines the access types for calling Policy Manager functions. |
| USBPM_ASSIGN_POWER_LEVEL_PARAMS_FORMAT Defines format values used in USBPM_ASSIGN_CONNECTOR_POWER_LEVEL_PARAMS. |
| USBPM_EVENT_TYPE Defines values for types of events. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for