/* SPDX-License-Identifier: GPL-2.0 */ #ifndef __DRIVER_USB_TYPEC_UCSI_H #define __DRIVER_USB_TYPEC_UCSI_H #include #include #include #include #include #include #include #include #include #include /* -------------------------------------------------------------------------- */ struct ucsi; struct ucsi_altmode; struct ucsi_connector; struct dentry; /* UCSI offsets (Bytes) */ #define UCSI_VERSION 0 #define UCSI_CCI 4 #define UCSI_CONTROL 8 #define UCSI_MESSAGE_IN 16 #define UCSI_MESSAGE_OUT 32 #define UCSIv2_MESSAGE_OUT 272 /* UCSI versions */ #define UCSI_VERSION_1_0 0x0100 #define UCSI_VERSION_1_1 0x0110 #define UCSI_VERSION_1_2 0x0120 #define UCSI_VERSION_2_0 0x0200 #define UCSI_VERSION_2_1 0x0210 #define UCSI_VERSION_3_0 0x0300 #define UCSI_BCD_GET_MAJOR(_v_) (((_v_) >> 8) & 0xFF) #define UCSI_BCD_GET_MINOR(_v_) (((_v_) >> 4) & 0x0F) #define UCSI_BCD_GET_SUBMINOR(_v_) ((_v_) & 0x0F) /* * Per USB PD 3.2, Section 6.2.1.1.5, the spec revision is represented by 2 bits * 0b00 = 1.0, 0b01 = 2.0, 0b10 = 3.0, 0b11 = Reserved, Shall NOT be used. */ #define UCSI_SPEC_REVISION_TO_BCD(_v_) (((_v_) + 1) << 8) /* Command Status and Connector Change Indication (CCI) bits */ #define UCSI_CCI_CONNECTOR(_c_) (((_c_) & GENMASK(7, 1)) >> 1) #define UCSI_CCI_LENGTH(_c_) (((_c_) & GENMASK(15, 8)) >> 8) #define UCSI_CCI_NOT_SUPPORTED BIT(25) #define UCSI_CCI_CANCEL_COMPLETE BIT(26) #define UCSI_CCI_RESET_COMPLETE BIT(27) #define UCSI_CCI_BUSY BIT(28) #define UCSI_CCI_ACK_COMPLETE BIT(29) #define UCSI_CCI_ERROR BIT(30) #define UCSI_CCI_COMMAND_COMPLETE BIT(31) /** * struct ucsi_operations - UCSI I/O operations * @read_version: Read implemented UCSI version * @read_cci: Read CCI register * @poll_cci: Read CCI register while polling with notifications disabled * @read_message_in: Read message data from UCSI * @sync_control: Blocking control operation * @async_control: Non-blocking control operation * @update_altmodes: Squashes duplicate DP altmodes * @update_connector: Update connector capabilities before registering * @connector_status: Updates connector status, called holding connector lock * * Read and write routines for UCSI interface. @sync_write must wait for the * Command Completion Event from the PPM before returning, and @async_write must * return immediately after sending the data to the PPM. */ struct ucsi_operations { int (*read_version)(struct ucsi *ucsi, u16 *version); int (*read_cci)(struct ucsi *ucsi, u32 *cci); int (*poll_cci)(struct ucsi *ucsi, u32 *cci); int (*read_message_in)(struct ucsi *ucsi, void *val, size_t val_len); int (*sync_control)(struct ucsi *ucsi, u64 command, u32 *cci, void *data, size_t size); int (*async_control)(struct ucsi *ucsi, u64 command); bool (*update_altmodes)(struct ucsi *ucsi, struct ucsi_altmode *orig, struct ucsi_altmode *updated); void (*update_connector)(struct ucsi_connector *con); void (*connector_status)(struct ucsi_connector *con); }; struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops); void ucsi_destroy(struct ucsi *ucsi); int ucsi_register(struct ucsi *ucsi); void ucsi_unregister(struct ucsi *ucsi); void *ucsi_get_drvdata(struct ucsi *ucsi); void ucsi_set_drvdata(struct ucsi *ucsi, void *data); void ucsi_connector_change(struct ucsi *ucsi, u8 num); /* -------------------------------------------------------------------------- */ /* Commands */ #define UCSI_PPM_RESET 0x01 #define UCSI_CANCEL 0x02 #define UCSI_CONNECTOR_RESET 0x03 #define UCSI_ACK_CC_CI 0x04 #define UCSI_SET_NOTIFICATION_ENABLE 0x05 #define UCSI_GET_CAPABILITY 0x06 #define UCSI_GET_CAPABILITY_SIZE 128 #define UCSI_GET_CONNECTOR_CAPABILITY 0x07 #define UCSI_GET_CONNECTOR_CAPABILITY_SIZE 32 #define UCSI_SET_CCOM 0x08 #define UCSI_SET_UOR 0x09 #define UCSI_SET_PDM 0x0a #define UCSI_SET_PDR 0x0b #define UCSI_GET_ALTERNATE_MODES 0x0c #define UCSI_GET_CAM_SUPPORTED 0x0d #define UCSI_GET_CURRENT_CAM 0x0e #define UCSI_SET_NEW_CAM 0x0f #define UCSI_GET_PDOS 0x10 #define UCSI_GET_CABLE_PROPERTY 0x11 #define UCSI_GET_CABLE_PROPERTY_SIZE 64 #define UCSI_GET_CONNECTOR_STATUS 0x12 #define UCSI_GET_CONNECTOR_STATUS_SIZE 152 #define UCSI_GET_ERROR_STATUS 0x13 #define UCSI_GET_PD_MESSAGE 0x15 #define UCSI_GET_CAM_CS 0x18 #define UCSI_SET_SINK_PATH 0x1c #define UCSI_GET_LPM_PPM_INFO 0x22 #define UCSI_CONNECTOR_NUMBER(_num_) ((u64)(_num_) << 16) #define UCSI_COMMAND(_cmd_) ((_cmd_) & 0xff) #define UCSI_GET_ALTMODE_GET_CONNECTOR_NUMBER(_cmd_) (((_cmd_) >> 24) & GENMASK(6, 0)) #define UCSI_DEFAULT_GET_CONNECTOR_NUMBER(_cmd_) (((_cmd_) >> 16) & GENMASK(6, 0)) /* CONNECTOR_RESET command bits */ #define UCSI_CONNECTOR_RESET_HARD_VER_1_0 BIT(23) /* Deprecated in v1.1 */ #define UCSI_CONNECTOR_RESET_DATA_VER_2_0 BIT(23) /* Redefined in v2.0 */ /* ACK_CC_CI bits */ #define UCSI_ACK_CONNECTOR_CHANGE BIT(16) #define UCSI_ACK_COMMAND_COMPLETE BIT(17) /* SET_NOTIFICATION_ENABLE command bits */ #define UCSI_ENABLE_NTFY_CMD_COMPLETE BIT_ULL(16) #define UCSI_ENABLE_NTFY_EXT_PWR_SRC_CHANGE BIT_ULL(17) #define UCSI_ENABLE_NTFY_PWR_OPMODE_CHANGE BIT_ULL(18) #define UCSI_ENABLE_NTFY_ATTENTION BIT_ULL(19) #define UCSI_ENABLE_NTFY_LPM_FW_UPDATE_REQ BIT_ULL(20) #define UCSI_ENABLE_NTFY_CAP_CHANGE BIT_ULL(21) #define UCSI_ENABLE_NTFY_PWR_LEVEL_CHANGE BIT_ULL(22) #define UCSI_ENABLE_NTFY_PD_RESET_COMPLETE BIT_ULL(23) #define UCSI_ENABLE_NTFY_CAM_CHANGE BIT_ULL(24) #define UCSI_ENABLE_NTFY_BAT_STATUS_CHANGE BIT_ULL(25) #define UCSI_ENABLE_NTFY_SECURITY_REQ_PARTNER BIT_ULL(26) #define UCSI_ENABLE_NTFY_PARTNER_CHANGE BIT_ULL(27) #define UCSI_ENABLE_NTFY_PWR_DIR_CHANGE BIT_ULL(28) #define UCSI_ENABLE_NTFY_SET_RETIMER_MODE BIT_ULL(29) #define UCSI_ENABLE_NTFY_CONNECTOR_CHANGE BIT_ULL(30) #define UCSI_ENABLE_NTFY_ERROR BIT_ULL(31) #define UCSI_ENABLE_NTFY_SINK_PATH_STS_CHANGE BIT_ULL(32) #define UCSI_ENABLE_NTFY_ALL 0xdbe70000 /* SET_UOR command bits */ #define UCSI_SET_UOR_ROLE(_r_) (((_r_) == TYPEC_HOST ? 1 : 2) << 23) #define UCSI_SET_UOR_ACCEPT_ROLE_SWAPS BIT(25) /* SET_PDF command bits */ #define UCSI_SET_PDR_ROLE(_r_) (((_r_) == TYPEC_SOURCE ? 1 : 2) << 23) #define UCSI_SET_PDR_ACCEPT_ROLE_SWAPS BIT(25) /* GET_ALTERNATE_MODES command bits */ #define UCSI_ALTMODE_RECIPIENT(_r_) (((_r_) >> 16) & 0x7) #define UCSI_GET_ALTMODE_RECIPIENT(_r_) ((u64)(_r_) << 16) #define UCSI_RECIPIENT_CON 0 #define UCSI_RECIPIENT_SOP 1 #define UCSI_RECIPIENT_SOP_P 2 #define UCSI_RECIPIENT_SOP_PP 3 #define UCSI_GET_ALTMODE_CONNECTOR_NUMBER(_r_) ((u64)(_r_) << 24) #define UCSI_ALTMODE_OFFSET(_r_) (((_r_) >> 32) & 0xff) #define UCSI_GET_ALTMODE_OFFSET(_r_) ((u64)(_r_) << 32) #define UCSI_GET_ALTMODE_NUM_ALTMODES(_r_) ((u64)(_r_) << 40) /* GET_PDOS command bits */ #define UCSI_GET_PDOS_PARTNER_PDO(_r_) ((u64)(_r_) << 23) #define UCSI_GET_PDOS_PDO_OFFSET(_r_) ((u64)(_r_) << 24) #define UCSI_GET_PDOS_NUM_PDOS(_r_) ((u64)(_r_) << 32) #define UCSI_MAX_PDOS (4) #define UCSI_GET_PDOS_SRC_PDOS ((u64)1 << 34) /* GET_PD_MESSAGE command bits */ #define UCSI_GET_PD_MESSAGE_RECIPIENT(_r_) ((u64)(_r_) << 23) #define UCSI_GET_PD_MESSAGE_OFFSET(_r_) ((u64)(_r_) << 26) #define UCSI_GET_PD_MESSAGE_BYTES(_r_) ((u64)(_r_) << 34) #define UCSI_GET_PD_MESSAGE_TYPE(_r_) ((u64)(_r_) << 42) #define UCSI_GET_PD_MESSAGE_TYPE_SNK_CAP_EXT 0 #define UCSI_GET_PD_MESSAGE_TYPE_SRC_CAP_EXT 1 #define UCSI_GET_PD_MESSAGE_TYPE_BAT_CAP 2 #define UCSI_GET_PD_MESSAGE_TYPE_BAT_STAT 3 #define UCSI_GET_PD_MESSAGE_TYPE_IDENTITY 4 #define UCSI_GET_PD_MESSAGE_TYPE_REVISION 5 /* -------------------------------------------------------------------------- */ /* Error information returned by PPM in response to GET_ERROR_STATUS command. */ #define UCSI_ERROR_UNREGONIZED_CMD BIT(0) #define UCSI_ERROR_INVALID_CON_NUM BIT(1) #define UCSI_ERROR_INVALID_CMD_ARGUMENT BIT(2) #define UCSI_ERROR_INCOMPATIBLE_PARTNER BIT(3) #define UCSI_ERROR_CC_COMMUNICATION_ERR BIT(4) #define UCSI_ERROR_DEAD_BATTERY BIT(5) #define UCSI_ERROR_CONTRACT_NEGOTIATION_FAIL BIT(6) #define UCSI_ERROR_OVERCURRENT BIT(7) #define UCSI_ERROR_UNDEFINED BIT(8) #define UCSI_ERROR_PARTNER_REJECTED_SWAP BIT(9) #define UCSI_ERROR_HARD_RESET BIT(10) #define UCSI_ERROR_PPM_POLICY_CONFLICT BIT(11) #define UCSI_ERROR_SWAP_REJECTED BIT(12) #define UCSI_ERROR_REVERSE_CURRENT_PROTECTION BIT(13) #define UCSI_ERROR_SET_SINK_PATH_REJECTED BIT(14) #define UCSI_SET_NEW_CAM_ENTER(x) (((x) >> 23) & 0x1) #define UCSI_SET_NEW_CAM_GET_AM(x) (((x) >> 24) & 0xff) #define UCSI_SET_NEW_CAM_AM_MASK (0xff << 24) #define UCSI_SET_NEW_CAM_SET_AM(x) (((x) & 0xff) << 24) #define UCSI_CMD_CONNECTOR_MASK (0x7) /* Data structure filled by PPM in response to GET_CAPABILITY command. */ struct ucsi_capability { u32 attributes; #define UCSI_CAP_ATTR_DISABLE_STATE BIT(0) #define UCSI_CAP_ATTR_BATTERY_CHARGING BIT(1) #define UCSI_CAP_ATTR_USB_PD BIT(2) #define UCSI_CAP_ATTR_TYPEC_CURRENT BIT(6) #define UCSI_CAP_ATTR_POWER_AC_SUPPLY BIT(8) #define UCSI_CAP_ATTR_POWER_OTHER BIT(10) #define UCSI_CAP_ATTR_POWER_VBUS BIT(14) u8 num_connectors; u16 features; #define UCSI_CAP_SET_UOM BIT(0) #define UCSI_CAP_SET_PDM BIT(1) #define UCSI_CAP_ALT_MODE_DETAILS BIT(2) #define UCSI_CAP_ALT_MODE_OVERRIDE BIT(3) #define UCSI_CAP_PDO_DETAILS BIT(4) #define UCSI_CAP_CABLE_DETAILS BIT(5) #define UCSI_CAP_EXT_SUPPLY_NOTIFICATIONS BIT(6) #define UCSI_CAP_PD_RESET BIT(7) #define UCSI_CAP_GET_PD_MESSAGE BIT(8) #define UCSI_CAP_GET_ATTENTION_VDO BIT(9) #define UCSI_CAP_FW_UPDATE_REQUEST BIT(10) #define UCSI_CAP_NEGOTIATED_PWR_LEVEL_CHANGE BIT(11) #define UCSI_CAP_SECURITY_REQUEST BIT(12) #define UCSI_CAP_SET_RETIMER_MODE BIT(13) #define UCSI_CAP_CHUNKING_SUPPORT BIT(14) u8 reserved_1; u8 num_alt_modes; u8 reserved_2; u16 bc_version; u16 pd_version; u16 typec_version; } __packed; struct ucsi_altmode { u16 svid; u32 mid; } __packed; /* Data structure filled by PPM in response to GET_CABLE_PROPERTY command. */ struct ucsi_cable_property { u16 speed_supported; u8 current_capability; u8 flags; #define UCSI_CABLE_PROP_FLAG_VBUS_IN_CABLE BIT(0) #define UCSI_CABLE_PROP_FLAG_ACTIVE_CABLE BIT(1) #define UCSI_CABLE_PROP_FLAG_DIRECTIONALITY BIT(2) #define UCSI_CABLE_PROP_FLAG_PLUG_TYPE(_f_) (((_f_) & GENMASK(4, 3)) >> 3) #define UCSI_CABLE_PROPERTY_PLUG_TYPE_A 0 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_B 1 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_C 2 #define UCSI_CABLE_PROPERTY_PLUG_OTHER 3 #define UCSI_CABLE_PROP_FLAG_MODE_SUPPORT BIT(5) #define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_) (((_f_) & GENMASK(7, 6)) >> 6) #define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV_AS_BCD(_f_) \ UCSI_SPEC_REVISION_TO_BCD(UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_)) u8 latency; } __packed; /* Get Connector Capability Fields. */ #define UCSI_CONCAP_OPMODE UCSI_DECLARE_BITFIELD(0, 0, 8) #define UCSI_CONCAP_OPMODE_DFP UCSI_DECLARE_BITFIELD(0, 0, 1) #define UCSI_CONCAP_OPMODE_UFP UCSI_DECLARE_BITFIELD(0, 1, 1) #define UCSI_CONCAP_OPMODE_DRP UCSI_DECLARE_BITFIELD(0, 2, 1) #define UCSI_CONCAP_OPMODE_AUDIO_ACCESSORY UCSI_DECLARE_BITFIELD(0, 3, 1) #define UCSI_CONCAP_OPMODE_DEBUG_ACCESSORY UCSI_DECLARE_BITFIELD(0, 4, 1) #define UCSI_CONCAP_OPMODE_USB2 UCSI_DECLARE_BITFIELD(0, 5, 1) #define UCSI_CONCAP_OPMODE_USB3 UCSI_DECLARE_BITFIELD(0, 6, 1) #define UCSI_CONCAP_OPMODE_ALT_MODE UCSI_DECLARE_BITFIELD(0, 7, 1) #define UCSI_CONCAP_PROVIDER UCSI_DECLARE_BITFIELD(0, 8, 1) #define UCSI_CONCAP_CONSUMER UCSI_DECLARE_BITFIELD(0, 9, 1) #define UCSI_CONCAP_SWAP_TO_DFP_V1_1 UCSI_DECLARE_BITFIELD_V1_1(10, 1) #define UCSI_CONCAP_SWAP_TO_UFP_V1_1 UCSI_DECLARE_BITFIELD_V1_1(11, 1) #define UCSI_CONCAP_SWAP_TO_SRC_V1_1 UCSI_DECLARE_BITFIELD_V1_1(12, 1) #define UCSI_CONCAP_SWAP_TO_SNK_V1_1 UCSI_DECLARE_BITFIELD_V1_1(13, 1) #define UCSI_CONCAP_EXT_OPMODE_V2_0 UCSI_DECLARE_BITFIELD_V2_0(14, 8) #define UCSI_CONCAP_EXT_OPMODE_USB4_GEN2_V2_0 UCSI_DECLARE_BITFIELD_V2_0(14, 1) #define UCSI_CONCAP_EXT_OPMODE_EPR_SRC_V2_0 UCSI_DECLARE_BITFIELD_V2_0(15, 1) #define UCSI_CONCAP_EXT_OPMODE_EPR_SINK_V2_0 UCSI_DECLARE_BITFIELD_V2_0(16, 1) #define UCSI_CONCAP_EXT_OPMODE_USB4_GEN3_V2_0 UCSI_DECLARE_BITFIELD_V2_0(17, 1) #define UCSI_CONCAP_EXT_OPMODE_USB4_GEN4_V2_0 UCSI_DECLARE_BITFIELD_V2_0(18, 1) #define UCSI_CONCAP_MISC_V2_0 UCSI_DECLARE_BITFIELD_V2_0(22, 4) #define UCSI_CONCAP_MISC_FW_UPDATE_V2_0 UCSI_DECLARE_BITFIELD_V2_0(22, 1) #define UCSI_CONCAP_MISC_SECURITY_V2_0 UCSI_DECLARE_BITFIELD_V2_0(23, 1) #define UCSI_CONCAP_REV_CURR_PROT_SUPPORT_V2_0 UCSI_DECLARE_BITFIELD_V2_0(26, 1) #define UCSI_CONCAP_PARTNER_PD_REVISION_V2_1 UCSI_DECLARE_BITFIELD_V2_1(27, 2) /* Helpers for USB capability checks. */ #define UCSI_CONCAP_USB2_SUPPORT(_con_) UCSI_CONCAP((_con_), OPMODE_USB2) #define UCSI_CONCAP_USB3_SUPPORT(_con_) UCSI_CONCAP((_con_), OPMODE_USB3) #define UCSI_CONCAP_USB4_SUPPORT(_con_) \ ((_con_)->ucsi->version >= UCSI_VERSION_2_0 && \ (UCSI_CONCAP((_con_), EXT_OPMODE_USB4_GEN2_V2_0) | \ UCSI_CONCAP((_con_), EXT_OPMODE_USB4_GEN3_V2_0) | \ UCSI_CONCAP((_con_), EXT_OPMODE_USB4_GEN4_V2_0))) /* Get Connector Status Fields. */ #define UCSI_CONSTAT_CHANGE UCSI_DECLARE_BITFIELD(0, 0, 16) #define UCSI_CONSTAT_PWR_OPMODE UCSI_DECLARE_BITFIELD(0, 16, 3) #define UCSI_CONSTAT_PWR_OPMODE_NONE 0 #define UCSI_CONSTAT_PWR_OPMODE_DEFAULT 1 #define UCSI_CONSTAT_PWR_OPMODE_BC 2 #define UCSI_CONSTAT_PWR_OPMODE_PD 3 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC1_5 4 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC3_0 5 #define UCSI_CONSTAT_CONNECTED UCSI_DECLARE_BITFIELD(0, 19, 1) #define UCSI_CONSTAT_PWR_DIR UCSI_DECLARE_BITFIELD(0, 20, 1) #define UCSI_CONSTAT_PARTNER_FLAGS UCSI_DECLARE_BITFIELD(0, 21, 8) #define UCSI_CONSTAT_PARTNER_FLAG_USB UCSI_DECLARE_BITFIELD(0, 21, 1) #define UCSI_CONSTAT_PARTNER_FLAG_ALT_MODE UCSI_DECLARE_BITFIELD(0, 22, 1) #define UCSI_CONSTAT_PARTNER_FLAG_USB4_GEN3 UCSI_DECLARE_BITFIELD(0, 23, 1) #define UCSI_CONSTAT_PARTNER_FLAG_USB4_GEN4 UCSI_DECLARE_BITFIELD(0, 24, 1) #define UCSI_CONSTAT_PARTNER_TYPE UCSI_DECLARE_BITFIELD(0, 29, 3) #define UCSI_CONSTAT_PARTNER_TYPE_DFP 1 #define UCSI_CONSTAT_PARTNER_TYPE_UFP 2 #define UCSI_CONSTAT_PARTNER_TYPE_CABLE 3 /* Powered Cable */ #define UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP 4 /* Powered Cable */ #define UCSI_CONSTAT_PARTNER_TYPE_DEBUG 5 #define UCSI_CONSTAT_PARTNER_TYPE_AUDIO 6 #define UCSI_CONSTAT_RDO UCSI_DECLARE_BITFIELD(0, 32, 32) #define UCSI_CONSTAT_BC_STATUS UCSI_DECLARE_BITFIELD(0, 64, 2) #define UCSI_CONSTAT_BC_NOT_CHARGING 0 #define UCSI_CONSTAT_BC_NOMINAL_CHARGING 1 #define UCSI_CONSTAT_BC_SLOW_CHARGING 2 #define UCSI_CONSTAT_BC_TRICKLE_CHARGING 3 #define UCSI_CONSTAT_PD_VERSION_V1_2 UCSI_DECLARE_BITFIELD_V1_2(70, 16) /* Connector Status Change Bits. */ #define UCSI_CONSTAT_EXT_SUPPLY_CHANGE BIT(1) #define UCSI_CONSTAT_POWER_OPMODE_CHANGE BIT(2) #define UCSI_CONSTAT_PDOS_CHANGE BIT(5) #define UCSI_CONSTAT_POWER_LEVEL_CHANGE BIT(6) #define UCSI_CONSTAT_PD_RESET_COMPLETE BIT(7) #define UCSI_CONSTAT_CAM_CHANGE BIT(8) #define UCSI_CONSTAT_BC_CHANGE BIT(9) #define UCSI_CONSTAT_PARTNER_CHANGE BIT(11) #define UCSI_CONSTAT_POWER_DIR_CHANGE BIT(12) #define UCSI_CONSTAT_CONNECT_CHANGE BIT(14) #define UCSI_CONSTAT_ERROR BIT(15) #define UCSI_DECLARE_BITFIELD_V1_1(_offset_, _size_) \ UCSI_DECLARE_BITFIELD(UCSI_VERSION_1_1, (_offset_), (_size_)) #define UCSI_DECLARE_BITFIELD_V1_2(_offset_, _size_) \ UCSI_DECLARE_BITFIELD(UCSI_VERSION_1_2, (_offset_), (_size_)) #define UCSI_DECLARE_BITFIELD_V2_0(_offset_, _size_) \ UCSI_DECLARE_BITFIELD(UCSI_VERSION_2_0, (_offset_), (_size_)) #define UCSI_DECLARE_BITFIELD_V2_1(_offset_, _size_) \ UCSI_DECLARE_BITFIELD(UCSI_VERSION_2_1, (_offset_), (_size_)) #define UCSI_DECLARE_BITFIELD_V3_0(_offset_, _size_) \ UCSI_DECLARE_BITFIELD(UCSI_VERSION_3_0, (_offset_), (_size_)) #define UCSI_DECLARE_BITFIELD(_ver_, _offset_, _size_) \ (struct ucsi_bitfield) { \ .version = _ver_, \ .offset = _offset_, \ .size = _size_, \ } struct ucsi_bitfield { const u16 version; const u8 offset; const u8 size; }; /** * ucsi_bitfield_read - Read a field from UCSI command response * @_map_: UCSI command response * @_field_: The field offset in the response data structure * @_ver_: UCSI version where the field was introduced * * Reads the fields in the command responses by first checking that the field is * valid with the UCSI interface version that is used in the system. * @_ver_ is the minimum UCSI version for the @_field_. If the UCSI interface is * older than @_ver_, a warning is generated. * * Caveats: * - Removed fields are not checked - @_ver_ is just the minimum UCSI version. * * Returns the value of @_field_, or 0 when the UCSI interface is older than * @_ver_. */ #define ucsi_bitfield_read(_map_, _field_, _ver_) \ ({ \ struct ucsi_bitfield f = (_field_); \ WARN((_ver_) < f.version, \ "Access to unsupported field at offset 0x%x (need version %04x)", \ f.offset, f.version) ? 0 : \ bitmap_read((_map_), f.offset, f.size); \ }) /* Helpers to access cached command responses. */ #define UCSI_CONCAP(_con_, _field_) \ ucsi_bitfield_read((_con_)->cap, UCSI_CONCAP_##_field_, (_con_)->ucsi->version) #define UCSI_CONSTAT(_con_, _field_) \ ucsi_bitfield_read((_con_)->status, UCSI_CONSTAT_##_field_, (_con_)->ucsi->version) /* -------------------------------------------------------------------------- */ struct ucsi_debugfs_entry { u64 command; struct ucsi_data { u64 low; u64 high; } response; u32 status; struct dentry *dentry; }; struct ucsi { u16 version; struct device *dev; void *driver_data; const struct ucsi_operations *ops; struct ucsi_capability cap; struct ucsi_connector *connector; struct ucsi_debugfs_entry *debugfs; struct work_struct resume_work; struct delayed_work work; int work_count; #define UCSI_ROLE_SWITCH_RETRY_PER_HZ 10 #define UCSI_ROLE_SWITCH_INTERVAL (HZ / UCSI_ROLE_SWITCH_RETRY_PER_HZ) #define UCSI_ROLE_SWITCH_WAIT_COUNT (10 * UCSI_ROLE_SWITCH_RETRY_PER_HZ) /* PPM Communication lock */ struct mutex ppm_lock; /* The latest "Notification Enable" bits (SET_NOTIFICATION_ENABLE) */ u64 ntfy; /* PPM communication flags */ unsigned long flags; #define EVENT_PENDING 0 #define COMMAND_PENDING 1 #define ACK_PENDING 2 struct completion complete; unsigned long quirks; #define UCSI_NO_PARTNER_PDOS BIT(0) /* Don't read partner's PDOs */ #define UCSI_DELAY_DEVICE_PDOS BIT(1) /* Reading PDOs fails until the parter is in PD mode */ }; #define UCSI_MAX_DATA_LENGTH(u) (((u)->version < UCSI_VERSION_2_0) ? 0x10 : 0xff) #define UCSI_MAX_SVID 5 #define UCSI_MAX_ALTMODES (UCSI_MAX_SVID * 6) #define UCSI_TYPEC_VSAFE5V 5000 #define UCSI_TYPEC_1_5_CURRENT 1500 #define UCSI_TYPEC_3_0_CURRENT 3000 struct ucsi_connector { int num; struct ucsi *ucsi; struct mutex lock; /* port lock */ struct work_struct work; struct completion complete; struct workqueue_struct *wq; struct list_head partner_tasks; struct typec_port *port; struct typec_partner *partner; struct typec_cable *cable; struct typec_plug *plug; struct typec_altmode *port_altmode[UCSI_MAX_ALTMODES]; struct typec_altmode *partner_altmode[UCSI_MAX_ALTMODES]; struct typec_altmode *plug_altmode[UCSI_MAX_ALTMODES]; struct typec_capability typec_cap; /* Cached command responses. */ DECLARE_BITMAP(cap, UCSI_GET_CONNECTOR_CAPABILITY_SIZE); DECLARE_BITMAP(status, UCSI_GET_CONNECTOR_STATUS_SIZE); struct power_supply *psy; struct power_supply_desc psy_desc; u32 rdo; u32 src_pdos[PDO_MAX_OBJECTS]; int num_pdos; /* USB PD objects */ struct usb_power_delivery *pd; struct usb_power_delivery_capabilities *port_source_caps; struct usb_power_delivery_capabilities *port_sink_caps; struct usb_power_delivery *partner_pd; struct usb_power_delivery_capabilities *partner_source_caps; struct usb_power_delivery_capabilities *partner_sink_caps; struct usb_role_switch *usb_role_sw; /* USB PD identity */ struct usb_pd_identity partner_identity; struct usb_pd_identity cable_identity; }; int ucsi_send_command(struct ucsi *ucsi, u64 command, void *retval, size_t size); void ucsi_altmode_update_active(struct ucsi_connector *con); int ucsi_resume(struct ucsi *ucsi); void ucsi_notify_common(struct ucsi *ucsi, u32 cci); int ucsi_sync_control_common(struct ucsi *ucsi, u64 command, u32 *cci, void *data, size_t size); #if IS_ENABLED(CONFIG_POWER_SUPPLY) int ucsi_register_port_psy(struct ucsi_connector *con); void ucsi_unregister_port_psy(struct ucsi_connector *con); void ucsi_port_psy_changed(struct ucsi_connector *con); #else static inline int ucsi_register_port_psy(struct ucsi_connector *con) { return 0; } static inline void ucsi_unregister_port_psy(struct ucsi_connector *con) { } static inline void ucsi_port_psy_changed(struct ucsi_connector *con) { } #endif /* CONFIG_POWER_SUPPLY */ #if IS_ENABLED(CONFIG_TYPEC_DP_ALTMODE) struct typec_altmode * ucsi_register_displayport(struct ucsi_connector *con, bool override, int offset, struct typec_altmode_desc *desc); void ucsi_displayport_remove_partner(struct typec_altmode *adev); #else static inline struct typec_altmode * ucsi_register_displayport(struct ucsi_connector *con, bool override, int offset, struct typec_altmode_desc *desc) { return typec_port_register_altmode(con->port, desc); } static inline void ucsi_displayport_remove_partner(struct typec_altmode *adev) { } #endif /* CONFIG_TYPEC_DP_ALTMODE */ #ifdef CONFIG_DEBUG_FS void ucsi_debugfs_init(void); void ucsi_debugfs_exit(void); void ucsi_debugfs_register(struct ucsi *ucsi); void ucsi_debugfs_unregister(struct ucsi *ucsi); #else static inline void ucsi_debugfs_init(void) { } static inline void ucsi_debugfs_exit(void) { } static inline void ucsi_debugfs_register(struct ucsi *ucsi) { } static inline void ucsi_debugfs_unregister(struct ucsi *ucsi) { } #endif /* CONFIG_DEBUG_FS */ /* * NVIDIA VirtualLink (svid 0x955) has two altmode. VirtualLink * DP mode with vdo=0x1 and NVIDIA test mode with vdo=0x3 */ #define USB_TYPEC_NVIDIA_VLINK_DP_VDO 0x1 #define USB_TYPEC_NVIDIA_VLINK_DBG_VDO 0x3 #endif /* __DRIVER_USB_TYPEC_UCSI_H */