ucmmanager.h header
This header is used by usbref. For more information, see:
ucmmanager.h contains the following programming interfaces:
Functions
| UCM_CONNECTOR_CONFIG_INIT Initializes a UCM_CONNECTOR_CONFIG structure. |
| UCM_CONNECTOR_PD_CONFIG_INIT Initializes a UCM_CONNECTOR_PD_CONFIG structure. |
| UCM_CONNECTOR_PD_CONN_STATE_CHANGED_PARAMS_INIT Initializes a UCM_CONNECTOR_PD_CONN_STATE_CHANGED_PARAMS structure. |
| UCM_CONNECTOR_TYPEC_ATTACH_PARAMS_INIT Initializes a UCM_CONNECTOR_TYPEC_ATTACH_PARAMS structure. |
| UCM_CONNECTOR_TYPEC_CONFIG_INIT Initializes the UCM_CONNECTOR_TYPEC_CONFIG structure. |
| UCM_MANAGER_CONFIG_INIT Initializes a UCM_MANAGER_CONFIG structure. |
| UcmConnectorChargingStateChanged Notifies the USB connector manager framework extension (UcmCx) with the updated charging state of the partner connector. |
| UcmConnectorCreate Creates a connector object. |
| UcmConnectorDataDirectionChanged Notifies the USB connector manager framework extension (UcmCx) with the new data role of a change in data role. |
| UcmConnectorPdConnectionStateChanged Notifies the USB connector manager framework extension (UcmCx) with the connection capabilities of the currently negotiated PD contract (if any). |
| UcmConnectorPdPartnerSourceCaps Notifies the USB connector manager framework extension (UcmCx) with the power source capabilities of the partner connector. |
| UcmConnectorPdSourceCaps Notifies the USB connector manager framework extension (UcmCx) with the power source capabilities of the connector. |
| UcmConnectorPowerDirectionChanged Notifies the USB connector manager framework extension (UcmCx) with the new power role of the partner connector. |
| UcmConnectorTypeCAttach Notifies the USB connector manager framework extension (UcmCx) when a partner connector is attached. |
| UcmConnectorTypeCCurrentAdChanged Notifies the USB connector manager framework extension (UcmCx) when the specified connector changes the current advertisement. Either the connector changes it (when it is DFP/Source), or the partner changed it (when it is UFP/Sink). |
| UcmConnectorTypeCDetach Notifies the USB connector manager framework extension (UcmCx) when the partner connector detaches from the specified Type-C connector. |
| UcmInitializeDevice Initializes the USB connector manager framework extension (UcmCx). |
Callback functions
| EVT_UCM_CONNECTOR_SET_DATA_ROLE The client driver's implementation of the EVT_UCM_CONNECTOR_SET_DATA_ROLE event callback function that swaps the data role of the connector to the specified role when attached to a partner connector. |
| EVT_UCM_CONNECTOR_SET_POWER_ROLE The client driver's implementation of the EVT_UCM_CONNECTOR_SET_POWER_ROLE event callback function that sets the power role of the connector to the specified role when attached to a partner connector. |
Structures
| UCM_CONNECTOR_CONFIG Describes the configuration options for a Type-C connector object. An initialized UCM_MANAGER_CONFIG structure is an input parameter value to UcmInitializeDevice. |
| UCM_CONNECTOR_PD_CONFIG Describes the Power Delivery 2.0 capabilities of the connector. |
| UCM_CONNECTOR_PD_CONN_STATE_CHANGED_PARAMS Describes the parameters for PD connection changed event. |
| UCM_CONNECTOR_TYPEC_ATTACH_PARAMS Describes the partner that is currently attached to the connector. |
| UCM_CONNECTOR_TYPEC_CONFIG Describes the configuration options for a Type-C connector. |
| UCM_MANAGER_CONFIG Describes the configuration options for the UCM Manager. An initialized UCM_MANAGER_CONFIG structure is an input parameter value to UcmInitializeDevice. |