ucmucsispec.h header

This header declares registers defined in the Intel UCSI Specification 1.1.

For information, see UCSI spec version 1.2.

Do not include this header. Instead, include Ucmucsicx.h.

For more information, see:

• Write a UcmUcsi client driver
• Universal Serial Bus (USB)

ucmucsispec.h contains the following programming interfaces:

Functions

UCSI_CMD_SUCCEEDED On successful completion of a UCSI command the PPM firmware fills the CCI Data Structure provided by the client driver.

Structures

UCSI_ACK_CC_CI_COMMAND Used in the ACK_CC_CI command. See Table 4-7.
UCSI_ALTERNATE_MODE Used in GET_ALTERNATE_MODES command. See Table 4-26.
UCSI_BM_POWER_SOURCE Used in GET_CAPABILITY command. See Bit 15:8 in Table 4-14.
UCSI_CCI Used in GET_CONNECTOR_CAPABILITY command. See Table 4-16.
UCSI_CONNECTOR_RESET_COMMAND Used in the CONNECTOR_RESET command. See Table 4-5.
UCSI_CONTROL Used in the SET_NOTIFICATION_ENABLE command. See Table 4-9.
UCSI_DATA_BLOCK The data structures for memory locations. See Section 3.
UCSI_GET_ALTERNATE_MODES_COMMAND Used in the GET_ALTERNATE_MODES command. See Table 4-24.
UCSI_GET_ALTERNATE_MODES_IN Learn how UCSI_GET_ALTERNATE_MODES_IN is used in the GET_ALTERNATE_MODES command. See Table 4-24.
UCSI_GET_CABLE_PROPERTY_COMMAND Used in the GET_CABLE_PROPERTY command. See Table 4-37.
UCSI_GET_CABLE_PROPERTY_IN Used in the GET_CABLE_PROPERTY command. See Table 4-39.
UCSI_GET_CAM_SUPPORTED_COMMAND Used in the GET_CAM_SUPPORTED command. See Table 4-27.
UCSI_GET_CAM_SUPPORTED_IN Learn how UCSI_GET_CAM_SUPPORTED_IN is used in the GET_CAM_SUPPORTED command. See Table 4-27.
UCSI_GET_CAPABILITY_IN Used in the GET_CAPABILITY command. See Table 4-13.
UCSI_GET_CONNECTOR_CAPABILITY_COMMAND Used in the GET_CONNECTOR_CAPABILITY command. See Table 4-15.
UCSI_GET_CONNECTOR_CAPABILITY_IN Used in the GET_CONNECTOR_CAPABILITY command.
UCSI_GET_CONNECTOR_STATUS_COMMAND Used in the GET_CONNECTOR_STATUS command. See Table 4-40.
UCSI_GET_CONNECTOR_STATUS_IN Used in the GET_CONNECTOR_STATUS command. See Table 4-42.
UCSI_GET_CURRENT_CAM_COMMAND Used in the GET_CURRENT_CAM command. See Table 4-29.
UCSI_GET_CURRENT_CAM_IN Used in the GET_CURRENT_CAM command. See Table 4-31.
UCSI_GET_ERROR_STATUS_COMMAND Used in the GET_ERROR_STATUS command. See Table 4-45
UCSI_GET_ERROR_STATUS_IN Used in the GET_ERROR_STATUS command. See Table 4-47.
UCSI_GET_PDOS_COMMAND Used in the GET_PDOS command. See Table 4-34.
UCSI_GET_PDOS_IN Used in the GET_PDOS command. See Table 4-36.
UCSI_MESSAGE_IN The MESSAGE IN data structure. See Section 3.4.
UCSI_MESSAGE_OUT The MESSAGE OUT data structure. See Section 3.5.
UCSI_SET_NEW_CAM_COMMAND Used in the SET_NEW_CAM command. See Table 4-32.
UCSI_SET_NOTIFICATION_ENABLE_COMMAND Learn how UCSI_SET_NOTIFICATION_ENABLE_COMMAND is used in the SET_NOTIFICATION_ENABLE command. See Table 4-9.
UCSI_SET_PDM_COMMAND _UCSI_SET_PDM_COMMAND is obsolete.
UCSI_SET_PDR_COMMAND Used in the SET_PDR command. See Table 4-22.
UCSI_SET_POWER_LEVEL_COMMAND Used in the SET_POWER_LEVEL command. See Table 4-48.
UCSI_SET_UOM_COMMAND Used in the SET_UOM command. See Table 4-18.
UCSI_SET_UOR_COMMAND Used in the SET_UOR command. See Table 4-20.
UCSI_VERSION The VERSION data structure. See Section 3.1.

Enumerations

UCSI_BATTERY_CHARGING_STATUS See Table 4-42, Offset 64.
UCSI_COMMAND See Table 4-51, Command Code.
UCSI_CONNECTOR_PARTNER_FLAGS Used in the GET_CONNECTOR_STATUS command. See Table 4-42, Offset 21.
UCSI_CONNECTOR_PARTNER_TYPE Used in the GET_CONNECTOR_STATUS command. See Table 4-42, Offset 29.
UCSI_GET_ALTERNATE_MODES_RECIPIENT Used in the GET_ALTERNATE_MODES command. See Table 4-24, Offset 16.
UCSI_GET_PDOS_SOURCE_CAPABILITIES_TYPE Used in the GET_PDOS command. See Table 4-34, Offset 35.
UCSI_GET_PDOS_TYPE Used in the GET_PDOS command. See Table 4-34, Offset 34.
UCSI_POWER_DIRECTION Used in the GET_CONNECTOR_STATUS command. See Table 4-42, Offset 20.
UCSI_POWER_DIRECTION_MODE Used in the GET_CONNECTOR_STATUS command. See Table 4-42, Offset 20.
UCSI_POWER_DIRECTION_ROLE Used in the SET_PDR command. See Table 4-22, Offset 23.
UCSI_POWER_OPERATION_MODE Used in the GET_CONNECTOR_STATUS command. See Table 4-42, Offset 16.
UCSI_USB_OPERATION_MODE Used in the SET_UOR command. See Table 4-18, Offset 23.
UCSI_USB_OPERATION_ROLE Used in the SET_UOR command. See Table 4-20, Offset 23