usbc_pd.h

Go to the documentation of this file.

/*
 * Copyright 2022 The Chromium OS Authors
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_PD_H_
#define ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_PD_H_
 
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define PD_MAX_EXTENDED_MSG_LEGACY_LEN   26
 
#define PD_MAX_EXTENDED_MSG_LEN    260
 
#define PD_MAX_EXTENDED_MSG_CHUNK_LEN    26
 
#define PD_N_CAPS_COUNT 50
 
#define PD_N_HARD_RESET_COUNT 2
 
#define PD_T_NO_RESPONSE_MIN_MS 4500
 
#define PD_T_NO_RESPONSE_MAX_MS 5500
 
#define PD_T_PS_HARD_RESET_MIN_MS 25
 
#define PD_T_PS_HARD_RESET_MAX_MS 35
 
#define PD_T_SINK_TX_MIN_MS 16
 
#define PD_T_SINK_TX_MAX_MS 20
 
#define PD_T_TYPEC_SEND_SOURCE_CAP_MIN_MS 100
 
#define PD_T_TYPEC_SEND_SOURCE_CAP_MAX_MS 200
 
#define PD_T_TYPEC_SINK_WAIT_CAP_MIN_MS 310
 
#define PD_T_TYPEC_SINK_WAIT_CAP_MAX_MS 620
 
#define PD_V_SAFE_0V_MAX_MV 800
 
#define PD_V_SAFE_5V_MIN_MV 4750
 
#define PD_T_SAFE_0V_MAX_MS  650
 
#define PD_T_SAFE_5V_MAX_MS  275
 
#define PD_T_TX_TIMEOUT_MS 100
 
#define PD_T_HARD_RESET_COMPLETE_MIN_MS 4
 
#define PD_T_HARD_RESET_COMPLETE_MAX_MS 5
 
#define PD_T_SENDER_RESPONSE_MIN_MS 24
 
#define PD_T_SENDER_RESPONSE_NOM_MS 27
 
#define PD_T_SENDER_RESPONSE_MAX_MS 30
 
#define PD_T_SPR_PS_TRANSITION_MIN_MS 450
 
#define PD_T_SPR_PS_TRANSITION_NOM_MS 500
 
#define PD_T_SPR_PS_TRANSITION_MAX_MS 550
 
#define PD_T_EPR_PS_TRANSITION_MIN_MS 830
 
#define PD_T_EPR_PS_TRANSITION_NOM_MS 925
 
#define PD_T_EPR_PS_TRANSITION_MAX_MS 1020
 
#define PD_T_SINK_REQUEST_MIN_MS 100
 
#define PD_T_CHUNKING_NOT_SUPPORTED_MIN_MS 40
 
#define PD_T_CHUNKING_NOT_SUPPORTED_NOM_MS 45
 
#define PD_T_CHUNKING_NOT_SUPPORTED_MAX_MS 50
 
#define PD_CONVERT_BYTES_TO_PD_HEADER_COUNT(c) ((c) >> 2)
 
#define PD_CONVERT_PD_HEADER_COUNT_TO_BYTES(c) ((c) << 2)
 
#define SINK_TX_OK TC_RP_3A0
 
#define SINK_TX_NG TC_RP_1A5
 
union pd_header {
        struct {
                uint16_t message_type : 5;
                uint16_t port_data_role : 1;
                uint16_t specification_revision : 2;
                uint16_t port_power_role : 1;
                uint16_t message_id : 3;
                uint16_t number_of_data_objects : 3;
                uint16_t extended : 1;
        };
        uint16_t raw_value;
};
 
#define PD_GET_EXT_HEADER(c) ((c) & 0xffff)
 
union pd_ext_header {
        struct {
                uint16_t data_size : 9;
                uint16_t reserved0 : 1;
                uint16_t request_chunk : 1;
                uint16_t chunk_number : 4;
                uint16_t chunked : 1;
        };
        uint16_t raw_value;
};
 
#define PDO_MAX_DATA_OBJECTS 7
 
enum pdo_type {
        PDO_FIXED       = 0,
        PDO_BATTERY     = 1,
        PDO_VARIABLE    = 2,
        PDO_AUGMENTED   = 3
};
 
#define PD_CONVERT_MA_TO_FIXED_PDO_CURRENT(c) ((c) / 10)
 
#define PD_CONVERT_MV_TO_FIXED_PDO_VOLTAGE(v) ((v) / 50)
 
#define PD_CONVERT_FIXED_PDO_CURRENT_TO_MA(c) ((c) * 10)
 
#define PD_CONVERT_FIXED_PDO_VOLTAGE_TO_MV(v) ((v) * 50)
 
union pd_fixed_supply_pdo_source {
        struct {
                uint32_t max_current : 10;
                uint32_t voltage : 10;
                uint32_t peak_current : 2;
                uint32_t reserved0 : 2;
                uint32_t unchunked_ext_msg_supported : 1;
                uint32_t dual_role_data : 1;
                uint32_t usb_comms_capable : 1;
                uint32_t unconstrained_power : 1;
                uint32_t usb_suspend_supported : 1;
                uint32_t dual_role_power : 1;
                enum pdo_type type : 2;
        };
        uint32_t raw_value;
};
 
enum pd_frs_type {
        FRS_NOT_SUPPORTED,
        FRS_DEFAULT_USB_POWER,
        FRS_1P5A_5V,
        FRS_3P0A_5V
};
 
union pd_fixed_supply_pdo_sink {
        struct {
                uint32_t operational_current : 10;
                uint32_t voltage : 10;
                uint32_t reserved0 : 3;
                enum pd_frs_type frs_required : 2;
                uint32_t dual_role_data : 1;
                uint32_t usb_comms_capable : 1;
                uint32_t unconstrained_power : 1;
                uint32_t higher_capability : 1;
                uint32_t dual_role_power : 1;
                enum pdo_type type : 2;
        };
        uint32_t raw_value;
};
 
#define PD_CONVERT_MA_TO_VARIABLE_PDO_CURRENT(c) ((c) / 10)
 
#define PD_CONVERT_MV_TO_VARIABLE_PDO_VOLTAGE(v) ((v) / 50)
 
#define PD_CONVERT_VARIABLE_PDO_CURRENT_TO_MA(c) ((c) * 10)
 
#define PD_CONVERT_VARIABLE_PDO_VOLTAGE_TO_MV(v) ((v) * 50)
 
union pd_variable_supply_pdo_source {
        struct {
                uint32_t max_current : 10;
                uint32_t min_voltage : 10;
                uint32_t max_voltage : 10;
                enum pdo_type type : 2;
        };
        uint32_t raw_value;
};
 
union pd_variable_supply_pdo_sink {
        struct {
                uint32_t operational_current : 10;
                uint32_t min_voltage : 10;
                uint32_t max_voltage : 10;
                enum pdo_type type : 2;
        };
        uint32_t raw_value;
};
 
#define PD_CONVERT_MW_TO_BATTERY_PDO_POWER(c) ((c) / 250)
 
#define PD_CONVERT_MV_TO_BATTERY_PDO_VOLTAGE(v) ((v) / 50)
 
#define PD_CONVERT_BATTERY_PDO_POWER_TO_MW(c) ((c) * 250)
 
#define PD_CONVERT_BATTERY_PDO_VOLTAGE_TO_MV(v) ((v) * 50)
 
union pd_battery_supply_pdo_source {
        struct {
                uint32_t max_power : 10;
                uint32_t min_voltage : 10;
                uint32_t max_voltage : 10;
                enum pdo_type type : 2;
        };
        uint32_t raw_value;
};
 
union pd_battery_supply_pdo_sink {
        struct {
                uint32_t operational_power : 10;
                uint32_t min_voltage : 10;
                uint32_t max_voltage : 10;
                enum pdo_type type : 2;
        };
        uint32_t raw_value;
};
 
#define PD_CONVERT_MA_TO_AUGMENTED_PDO_CURRENT(c) ((c) / 50)
 
#define PD_CONVERT_MV_TO_AUGMENTED_PDO_VOLTAGE(v) ((v) / 100)
 
#define PD_CONVERT_AUGMENTED_PDO_CURRENT_TO_MA(c) ((c) * 50)
 
#define PD_CONVERT_AUGMENTED_PDO_VOLTAGE_TO_MV(v) ((v) * 100)
 
union pd_augmented_supply_pdo_source {
        struct {
                uint32_t max_current : 7;
                uint32_t reserved0 : 1;
                uint32_t min_voltage : 8;
                uint32_t reserved1 : 1;
                uint32_t max_voltage : 8;
                uint32_t reserved2 : 2;
                uint32_t pps_power_limited : 1;
                uint32_t reserved3 : 2;
                enum pdo_type type : 2;
        };
        uint32_t raw_value;
};
 
union pd_augmented_supply_pdo_sink {
        struct {
                uint32_t max_current : 7;
                uint32_t reserved0 : 1;
                uint32_t min_voltage : 8;
                uint32_t reserved1 : 1;
                uint32_t max_voltage : 8;
                uint32_t reserved2 : 3;
                uint32_t reserved3 : 2;
                enum pdo_type type : 2;
        };
        uint32_t raw_value;
};
 
union pd_rdo {
        struct {
                uint32_t min_or_max_operating_current : 10;
                uint32_t operating_current : 10;
                uint32_t reserved0 : 3;
                uint32_t unchunked_ext_msg_supported : 1;
                uint32_t no_usb_suspend : 1;
                uint32_t usb_comm_capable : 1;
                uint32_t cap_mismatch : 1;
                uint32_t giveback : 1;
                uint32_t object_pos : 3;
                uint32_t reserved1 : 1;
        } fixed;
 
        struct {
                uint32_t min_or_max_operating_current : 10;
                uint32_t operating_current : 10;
                uint32_t reserved0 : 3;
                uint32_t unchunked_ext_msg_supported : 1;
                uint32_t no_usb_suspend : 1;
                uint32_t usb_comm_capable : 1;
                uint32_t cap_mismatch : 1;
                uint32_t giveback : 1;
                uint32_t object_pos : 3;
                uint32_t reserved1 : 1;
        } variable;
 
        struct {
                uint32_t min_operating_power : 10;
                uint32_t operating_power : 10;
                uint32_t reserved0 : 3;
                uint32_t unchunked_ext_msg_supported : 1;
                uint32_t no_usb_suspend : 1;
                uint32_t usb_comm_capable : 1;
                uint32_t cap_mismatch : 1;
                uint32_t giveback : 1;
                uint32_t object_pos : 3;
                uint32_t reserved1 : 1;
        } battery;
 
        struct {
                uint32_t operating_current : 7;
                uint32_t reserved0 : 2;
                uint32_t output_voltage : 11;
                uint32_t reserved1 : 3;
                uint32_t unchunked_ext_msg_supported : 1;
                uint32_t no_usb_suspend : 1;
                uint32_t usb_comm_capable : 1;
                uint32_t cap_mismatch : 1;
                uint32_t reserved2 : 1;
                uint32_t object_pos : 3;
                uint32_t reserved3 : 1;
        } augmented;
        uint32_t raw_value;
};
 
enum pd_rev_type {
        PD_REV10        = 0,
        PD_REV20        = 1,
        PD_REV30        = 2,
};
 
enum pd_packet_type {
        PD_PACKET_SOP                   = 0,
        PD_PACKET_SOP_PRIME             = 1,
        PD_PACKET_PRIME_PRIME           = 2,
        PD_PACKET_DEBUG_PRIME           = 3,
        PD_PACKET_DEBUG_PRIME_PRIME     = 4,
        PD_PACKET_TX_HARD_RESET         = 5,
        PD_PACKET_CABLE_RESET           = 6,
        PD_PACKET_TX_BIST_MODE_2        = 7,
 
        PD_PACKET_MSG_INVALID           = 0xf
};
 
#define NUM_SOP_STAR_TYPES (PD_PACKET_DEBUG_PRIME_PRIME + 1)
 
enum pd_ctrl_msg_type {
        PD_CTRL_GOOD_CRC        = 1,
        PD_CTRL_GOTO_MIN        = 2,
        PD_CTRL_ACCEPT          = 3,
        PD_CTRL_REJECT          = 4,
        PD_CTRL_PING            = 5,
        PD_CTRL_PS_RDY          = 6,
        PD_CTRL_GET_SOURCE_CAP  = 7,
        PD_CTRL_GET_SINK_CAP    = 8,
        PD_CTRL_DR_SWAP         = 9,
        PD_CTRL_PR_SWAP         = 10,
        PD_CTRL_VCONN_SWAP      = 11,
        PD_CTRL_WAIT            = 12,
        PD_CTRL_SOFT_RESET      = 13,
 
        PD_CTRL_DATA_RESET              = 14,
        PD_CTRL_DATA_RESET_COMPLETE     = 15,
        PD_CTRL_NOT_SUPPORTED           = 16,
        PD_CTRL_GET_SOURCE_CAP_EXT      = 17,
        PD_CTRL_GET_STATUS              = 18,
        PD_CTRL_FR_SWAP                 = 19,
        PD_CTRL_GET_PPS_STATUS          = 20,
        PD_CTRL_GET_COUNTRY_CODES       = 21,
        PD_CTRL_GET_SINK_CAP_EXT        = 22
 
};
 
enum pd_data_msg_type {
        PD_DATA_SOURCE_CAP              = 1,
        PD_DATA_REQUEST                 = 2,
        PD_DATA_BIST                    = 3,
        PD_DATA_SINK_CAP                = 4,
        PD_DATA_BATTERY_STATUS          = 5,
        PD_DATA_ALERT                   = 6,
        PD_DATA_GET_COUNTRY_INFO        = 7,
 
        PD_DATA_ENTER_USB       = 8,
        PD_DATA_VENDOR_DEF      = 15,
};
 
enum pd_ext_msg_type {
        PD_EXT_SOURCE_CAP               = 1,
        PD_EXT_STATUS                   = 2,
        PD_EXT_GET_BATTERY_CAP          = 3,
        PD_EXT_GET_BATTERY_STATUS       = 4,
        PD_EXT_BATTERY_CAP              = 5,
        PD_EXT_GET_MANUFACTURER_INFO    = 6,
        PD_EXT_MANUFACTURER_INFO        = 7,
        PD_EXT_SECURITY_REQUEST         = 8,
        PD_EXT_SECURITY_RESPONSE        = 9,
        PD_EXT_FIRMWARE_UPDATE_REQUEST  = 10,
        PD_EXT_FIRMWARE_UPDATE_RESPONSE = 11,
        PD_EXT_PPS_STATUS               = 12,
        PD_EXT_COUNTRY_INFO             = 13,
        PD_EXT_COUNTRY_CODES            = 14,
 
        /*8 15-31 Reserved */
};
 
enum usbpd_cc_pin {
        USBPD_CC_PIN_1  = 0,
        USBPD_CC_PIN_2  = 1,
};
 
struct pd_msg {
        enum pd_packet_type type;
        union pd_header header;
        uint32_t len;
        uint8_t data[PD_MAX_EXTENDED_MSG_LEN];
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_USBC_USBC_PD_H_ */