1/* SPDX-License-Identifier: GPL-2.0 */ 2 3#ifndef __DRIVER_USB_TYPEC_UCSI_H 4#define __DRIVER_USB_TYPEC_UCSI_H 5 6#include <linux/bitops.h> 7#include <linux/device.h> 8#include <linux/power_supply.h> 9#include <linux/types.h> 10#include <linux/usb/typec.h> 11#include <linux/usb/pd.h> 12#include <linux/usb/role.h> 13#include <asm/unaligned.h> 14 15/* -------------------------------------------------------------------------- */ 16 17struct ucsi; 18struct ucsi_altmode; 19struct dentry; 20 21/* UCSI offsets (Bytes) */ 22#define UCSI_VERSION 0 23#define UCSI_CCI 4 24#define UCSI_CONTROL 8 25#define UCSI_MESSAGE_IN 16 26#define UCSI_MESSAGE_OUT 32 27#define UCSIv2_MESSAGE_OUT 272 28 29/* UCSI versions */ 30#define UCSI_VERSION_1_2 0x0120 31#define UCSI_VERSION_2_0 0x0200 32#define UCSI_VERSION_2_1 0x0210 33#define UCSI_VERSION_3_0 0x0300 34 35#define UCSI_BCD_GET_MAJOR(_v_) (((_v_) >> 8) & 0xFF) 36#define UCSI_BCD_GET_MINOR(_v_) (((_v_) >> 4) & 0x0F) 37#define UCSI_BCD_GET_SUBMINOR(_v_) ((_v_) & 0x0F) 38 39/* 40 * Per USB PD 3.2, Section 6.2.1.1.5, the spec revision is represented by 2 bits 41 * 0b00 = 1.0, 0b01 = 2.0, 0b10 = 3.0, 0b11 = Reserved, Shall NOT be used. 42 */ 43#define UCSI_SPEC_REVISION_TO_BCD(_v_) (((_v_) + 1) << 8) 44 45/* Command Status and Connector Change Indication (CCI) bits */ 46#define UCSI_CCI_CONNECTOR(_c_) (((_c_) & GENMASK(7, 1)) >> 1) 47#define UCSI_CCI_LENGTH(_c_) (((_c_) & GENMASK(15, 8)) >> 8) 48#define UCSI_CCI_NOT_SUPPORTED BIT(25) 49#define UCSI_CCI_CANCEL_COMPLETE BIT(26) 50#define UCSI_CCI_RESET_COMPLETE BIT(27) 51#define UCSI_CCI_BUSY BIT(28) 52#define UCSI_CCI_ACK_COMPLETE BIT(29) 53#define UCSI_CCI_ERROR BIT(30) 54#define UCSI_CCI_COMMAND_COMPLETE BIT(31) 55 56/** 57 * struct ucsi_operations - UCSI I/O operations 58 * @read: Read operation 59 * @sync_write: Blocking write operation 60 * @async_write: Non-blocking write operation 61 * @update_altmodes: Squashes duplicate DP altmodes 62 * 63 * Read and write routines for UCSI interface. @sync_write must wait for the 64 * Command Completion Event from the PPM before returning, and @async_write must 65 * return immediately after sending the data to the PPM. 66 */ 67struct ucsi_operations { 68 int (*read)(struct ucsi *ucsi, unsigned int offset, 69 void *val, size_t val_len); 70 int (*sync_write)(struct ucsi *ucsi, unsigned int offset, 71 const void *val, size_t val_len); 72 int (*async_write)(struct ucsi *ucsi, unsigned int offset, 73 const void *val, size_t val_len); 74 bool (*update_altmodes)(struct ucsi *ucsi, struct ucsi_altmode *orig, 75 struct ucsi_altmode *updated); 76}; 77 78struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops); 79void ucsi_destroy(struct ucsi *ucsi); 80int ucsi_register(struct ucsi *ucsi); 81void ucsi_unregister(struct ucsi *ucsi); 82void *ucsi_get_drvdata(struct ucsi *ucsi); 83void ucsi_set_drvdata(struct ucsi *ucsi, void *data); 84 85void ucsi_connector_change(struct ucsi *ucsi, u8 num); 86 87/* -------------------------------------------------------------------------- */ 88 89/* Commands */ 90#define UCSI_PPM_RESET 0x01 91#define UCSI_CANCEL 0x02 92#define UCSI_CONNECTOR_RESET 0x03 93#define UCSI_ACK_CC_CI 0x04 94#define UCSI_SET_NOTIFICATION_ENABLE 0x05 95#define UCSI_GET_CAPABILITY 0x06 96#define UCSI_GET_CONNECTOR_CAPABILITY 0x07 97#define UCSI_SET_UOM 0x08 98#define UCSI_SET_UOR 0x09 99#define UCSI_SET_PDM 0x0a 100#define UCSI_SET_PDR 0x0b 101#define UCSI_GET_ALTERNATE_MODES 0x0c 102#define UCSI_GET_CAM_SUPPORTED 0x0d 103#define UCSI_GET_CURRENT_CAM 0x0e 104#define UCSI_SET_NEW_CAM 0x0f 105#define UCSI_GET_PDOS 0x10 106#define UCSI_GET_CABLE_PROPERTY 0x11 107#define UCSI_GET_CONNECTOR_STATUS 0x12 108#define UCSI_GET_ERROR_STATUS 0x13 109#define UCSI_GET_PD_MESSAGE 0x15 110 111#define UCSI_CONNECTOR_NUMBER(_num_) ((u64)(_num_) << 16) 112#define UCSI_COMMAND(_cmd_) ((_cmd_) & 0xff) 113 114/* CONNECTOR_RESET command bits */ 115#define UCSI_CONNECTOR_RESET_HARD BIT(23) /* Deprecated in v1.1 */ 116 117/* ACK_CC_CI bits */ 118#define UCSI_ACK_CONNECTOR_CHANGE BIT(16) 119#define UCSI_ACK_COMMAND_COMPLETE BIT(17) 120 121/* SET_NOTIFICATION_ENABLE command bits */ 122#define UCSI_ENABLE_NTFY_CMD_COMPLETE BIT(16) 123#define UCSI_ENABLE_NTFY_EXT_PWR_SRC_CHANGE BIT(17) 124#define UCSI_ENABLE_NTFY_PWR_OPMODE_CHANGE BIT(18) 125#define UCSI_ENABLE_NTFY_CAP_CHANGE BIT(21) 126#define UCSI_ENABLE_NTFY_PWR_LEVEL_CHANGE BIT(22) 127#define UCSI_ENABLE_NTFY_PD_RESET_COMPLETE BIT(23) 128#define UCSI_ENABLE_NTFY_CAM_CHANGE BIT(24) 129#define UCSI_ENABLE_NTFY_BAT_STATUS_CHANGE BIT(25) 130#define UCSI_ENABLE_NTFY_PARTNER_CHANGE BIT(27) 131#define UCSI_ENABLE_NTFY_PWR_DIR_CHANGE BIT(28) 132#define UCSI_ENABLE_NTFY_CONNECTOR_CHANGE BIT(30) 133#define UCSI_ENABLE_NTFY_ERROR BIT(31) 134#define UCSI_ENABLE_NTFY_ALL 0xdbe70000 135 136/* SET_UOR command bits */ 137#define UCSI_SET_UOR_ROLE(_r_) (((_r_) == TYPEC_HOST ? 1 : 2) << 23) 138#define UCSI_SET_UOR_ACCEPT_ROLE_SWAPS BIT(25) 139 140/* SET_PDF command bits */ 141#define UCSI_SET_PDR_ROLE(_r_) (((_r_) == TYPEC_SOURCE ? 1 : 2) << 23) 142#define UCSI_SET_PDR_ACCEPT_ROLE_SWAPS BIT(25) 143 144/* GET_ALTERNATE_MODES command bits */ 145#define UCSI_ALTMODE_RECIPIENT(_r_) (((_r_) >> 16) & 0x7) 146#define UCSI_GET_ALTMODE_RECIPIENT(_r_) ((u64)(_r_) << 16) 147#define UCSI_RECIPIENT_CON 0 148#define UCSI_RECIPIENT_SOP 1 149#define UCSI_RECIPIENT_SOP_P 2 150#define UCSI_RECIPIENT_SOP_PP 3 151#define UCSI_GET_ALTMODE_CONNECTOR_NUMBER(_r_) ((u64)(_r_) << 24) 152#define UCSI_ALTMODE_OFFSET(_r_) (((_r_) >> 32) & 0xff) 153#define UCSI_GET_ALTMODE_OFFSET(_r_) ((u64)(_r_) << 32) 154#define UCSI_GET_ALTMODE_NUM_ALTMODES(_r_) ((u64)(_r_) << 40) 155 156/* GET_PDOS command bits */ 157#define UCSI_GET_PDOS_PARTNER_PDO(_r_) ((u64)(_r_) << 23) 158#define UCSI_GET_PDOS_PDO_OFFSET(_r_) ((u64)(_r_) << 24) 159#define UCSI_GET_PDOS_NUM_PDOS(_r_) ((u64)(_r_) << 32) 160#define UCSI_MAX_PDOS (4) 161#define UCSI_GET_PDOS_SRC_PDOS ((u64)1 << 34) 162 163/* GET_PD_MESSAGE command bits */ 164#define UCSI_GET_PD_MESSAGE_RECIPIENT(_r_) ((u64)(_r_) << 23) 165#define UCSI_GET_PD_MESSAGE_OFFSET(_r_) ((u64)(_r_) << 26) 166#define UCSI_GET_PD_MESSAGE_BYTES(_r_) ((u64)(_r_) << 34) 167#define UCSI_GET_PD_MESSAGE_TYPE(_r_) ((u64)(_r_) << 42) 168#define UCSI_GET_PD_MESSAGE_TYPE_SNK_CAP_EXT 0 169#define UCSI_GET_PD_MESSAGE_TYPE_SRC_CAP_EXT 1 170#define UCSI_GET_PD_MESSAGE_TYPE_BAT_CAP 2 171#define UCSI_GET_PD_MESSAGE_TYPE_BAT_STAT 3 172#define UCSI_GET_PD_MESSAGE_TYPE_IDENTITY 4 173#define UCSI_GET_PD_MESSAGE_TYPE_REVISION 5 174 175/* -------------------------------------------------------------------------- */ 176 177/* Error information returned by PPM in response to GET_ERROR_STATUS command. */ 178#define UCSI_ERROR_UNREGONIZED_CMD BIT(0) 179#define UCSI_ERROR_INVALID_CON_NUM BIT(1) 180#define UCSI_ERROR_INVALID_CMD_ARGUMENT BIT(2) 181#define UCSI_ERROR_INCOMPATIBLE_PARTNER BIT(3) 182#define UCSI_ERROR_CC_COMMUNICATION_ERR BIT(4) 183#define UCSI_ERROR_DEAD_BATTERY BIT(5) 184#define UCSI_ERROR_CONTRACT_NEGOTIATION_FAIL BIT(6) 185#define UCSI_ERROR_OVERCURRENT BIT(7) 186#define UCSI_ERROR_UNDEFINED BIT(8) 187#define UCSI_ERROR_PARTNER_REJECTED_SWAP BIT(9) 188#define UCSI_ERROR_HARD_RESET BIT(10) 189#define UCSI_ERROR_PPM_POLICY_CONFLICT BIT(11) 190#define UCSI_ERROR_SWAP_REJECTED BIT(12) 191 192#define UCSI_SET_NEW_CAM_ENTER(x) (((x) >> 23) & 0x1) 193#define UCSI_SET_NEW_CAM_GET_AM(x) (((x) >> 24) & 0xff) 194#define UCSI_SET_NEW_CAM_AM_MASK (0xff << 24) 195#define UCSI_SET_NEW_CAM_SET_AM(x) (((x) & 0xff) << 24) 196#define UCSI_CMD_CONNECTOR_MASK (0x7) 197 198/* Data structure filled by PPM in response to GET_CAPABILITY command. */ 199struct ucsi_capability { 200 u32 attributes; 201#define UCSI_CAP_ATTR_DISABLE_STATE BIT(0) 202#define UCSI_CAP_ATTR_BATTERY_CHARGING BIT(1) 203#define UCSI_CAP_ATTR_USB_PD BIT(2) 204#define UCSI_CAP_ATTR_TYPEC_CURRENT BIT(6) 205#define UCSI_CAP_ATTR_POWER_AC_SUPPLY BIT(8) 206#define UCSI_CAP_ATTR_POWER_OTHER BIT(10) 207#define UCSI_CAP_ATTR_POWER_VBUS BIT(14) 208 u8 num_connectors; 209 u16 features; 210#define UCSI_CAP_SET_UOM BIT(0) 211#define UCSI_CAP_SET_PDM BIT(1) 212#define UCSI_CAP_ALT_MODE_DETAILS BIT(2) 213#define UCSI_CAP_ALT_MODE_OVERRIDE BIT(3) 214#define UCSI_CAP_PDO_DETAILS BIT(4) 215#define UCSI_CAP_CABLE_DETAILS BIT(5) 216#define UCSI_CAP_EXT_SUPPLY_NOTIFICATIONS BIT(6) 217#define UCSI_CAP_PD_RESET BIT(7) 218#define UCSI_CAP_GET_PD_MESSAGE BIT(8) 219 u8 reserved_1; 220 u8 num_alt_modes; 221 u8 reserved_2; 222 u16 bc_version; 223 u16 pd_version; 224 u16 typec_version; 225} __packed; 226 227/* Data structure filled by PPM in response to GET_CONNECTOR_CAPABILITY cmd. */ 228struct ucsi_connector_capability { 229 u8 op_mode; 230#define UCSI_CONCAP_OPMODE_DFP BIT(0) 231#define UCSI_CONCAP_OPMODE_UFP BIT(1) 232#define UCSI_CONCAP_OPMODE_DRP BIT(2) 233#define UCSI_CONCAP_OPMODE_AUDIO_ACCESSORY BIT(3) 234#define UCSI_CONCAP_OPMODE_DEBUG_ACCESSORY BIT(4) 235#define UCSI_CONCAP_OPMODE_USB2 BIT(5) 236#define UCSI_CONCAP_OPMODE_USB3 BIT(6) 237#define UCSI_CONCAP_OPMODE_ALT_MODE BIT(7) 238 u32 flags; 239#define UCSI_CONCAP_FLAG_PROVIDER BIT(0) 240#define UCSI_CONCAP_FLAG_CONSUMER BIT(1) 241#define UCSI_CONCAP_FLAG_SWAP_TO_DFP BIT(2) 242#define UCSI_CONCAP_FLAG_SWAP_TO_UFP BIT(3) 243#define UCSI_CONCAP_FLAG_SWAP_TO_SRC BIT(4) 244#define UCSI_CONCAP_FLAG_SWAP_TO_SINK BIT(5) 245#define UCSI_CONCAP_FLAG_EX_OP_MODE(_f_) \ 246 (((_f_) & GENMASK(13, 6)) >> 6) 247#define UCSI_CONCAP_EX_OP_MODE_USB4_GEN2 BIT(0) 248#define UCSI_CONCAP_EX_OP_MODE_EPR_SRC BIT(1) 249#define UCSI_CONCAP_EX_OP_MODE_EPR_SINK BIT(2) 250#define UCSI_CONCAP_EX_OP_MODE_USB4_GEN3 BIT(3) 251#define UCSI_CONCAP_EX_OP_MODE_USB4_GEN4 BIT(4) 252#define UCSI_CONCAP_FLAG_MISC_CAPS(_f_) \ 253 (((_f_) & GENMASK(17, 14)) >> 14) 254#define UCSI_CONCAP_MISC_CAP_FW_UPDATE BIT(0) 255#define UCSI_CONCAP_MISC_CAP_SECURITY BIT(1) 256#define UCSI_CONCAP_FLAG_REV_CURR_PROT_SUPPORT BIT(18) 257#define UCSI_CONCAP_FLAG_PARTNER_PD_MAJOR_REV(_f_) \ 258 (((_f_) & GENMASK(20, 19)) >> 19) 259#define UCSI_CONCAP_FLAG_PARTNER_PD_MAJOR_REV_AS_BCD(_f_) \ 260 UCSI_SPEC_REVISION_TO_BCD(UCSI_CONCAP_FLAG_PARTNER_PD_MAJOR_REV(_f_)) 261} __packed; 262 263struct ucsi_altmode { 264 u16 svid; 265 u32 mid; 266} __packed; 267 268/* Data structure filled by PPM in response to GET_CABLE_PROPERTY command. */ 269struct ucsi_cable_property { 270 u16 speed_supported; 271 u8 current_capability; 272 u8 flags; 273#define UCSI_CABLE_PROP_FLAG_VBUS_IN_CABLE BIT(0) 274#define UCSI_CABLE_PROP_FLAG_ACTIVE_CABLE BIT(1) 275#define UCSI_CABLE_PROP_FLAG_DIRECTIONALITY BIT(2) 276#define UCSI_CABLE_PROP_FLAG_PLUG_TYPE(_f_) (((_f_) & GENMASK(4, 3)) >> 3) 277#define UCSI_CABLE_PROPERTY_PLUG_TYPE_A 0 278#define UCSI_CABLE_PROPERTY_PLUG_TYPE_B 1 279#define UCSI_CABLE_PROPERTY_PLUG_TYPE_C 2 280#define UCSI_CABLE_PROPERTY_PLUG_OTHER 3 281#define UCSI_CABLE_PROP_FLAG_MODE_SUPPORT BIT(5) 282#define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_) (((_f_) & GENMASK(7, 6)) >> 6) 283#define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV_AS_BCD(_f_) \ 284 UCSI_SPEC_REVISION_TO_BCD(UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_)) 285 u8 latency; 286} __packed; 287 288/* Data structure filled by PPM in response to GET_CONNECTOR_STATUS command. */ 289struct ucsi_connector_status { 290 u16 change; 291#define UCSI_CONSTAT_EXT_SUPPLY_CHANGE BIT(1) 292#define UCSI_CONSTAT_POWER_OPMODE_CHANGE BIT(2) 293#define UCSI_CONSTAT_PDOS_CHANGE BIT(5) 294#define UCSI_CONSTAT_POWER_LEVEL_CHANGE BIT(6) 295#define UCSI_CONSTAT_PD_RESET_COMPLETE BIT(7) 296#define UCSI_CONSTAT_CAM_CHANGE BIT(8) 297#define UCSI_CONSTAT_BC_CHANGE BIT(9) 298#define UCSI_CONSTAT_PARTNER_CHANGE BIT(11) 299#define UCSI_CONSTAT_POWER_DIR_CHANGE BIT(12) 300#define UCSI_CONSTAT_CONNECT_CHANGE BIT(14) 301#define UCSI_CONSTAT_ERROR BIT(15) 302 u16 flags; 303#define UCSI_CONSTAT_PWR_OPMODE(_f_) ((_f_) & GENMASK(2, 0)) 304#define UCSI_CONSTAT_PWR_OPMODE_NONE 0 305#define UCSI_CONSTAT_PWR_OPMODE_DEFAULT 1 306#define UCSI_CONSTAT_PWR_OPMODE_BC 2 307#define UCSI_CONSTAT_PWR_OPMODE_PD 3 308#define UCSI_CONSTAT_PWR_OPMODE_TYPEC1_5 4 309#define UCSI_CONSTAT_PWR_OPMODE_TYPEC3_0 5 310#define UCSI_CONSTAT_CONNECTED BIT(3) 311#define UCSI_CONSTAT_PWR_DIR BIT(4) 312#define UCSI_CONSTAT_PARTNER_FLAGS(_f_) (((_f_) & GENMASK(12, 5)) >> 5) 313#define UCSI_CONSTAT_PARTNER_FLAG_USB 1 314#define UCSI_CONSTAT_PARTNER_FLAG_ALT_MODE 2 315#define UCSI_CONSTAT_PARTNER_TYPE(_f_) (((_f_) & GENMASK(15, 13)) >> 13) 316#define UCSI_CONSTAT_PARTNER_TYPE_DFP 1 317#define UCSI_CONSTAT_PARTNER_TYPE_UFP 2 318#define UCSI_CONSTAT_PARTNER_TYPE_CABLE 3 /* Powered Cable */ 319#define UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP 4 /* Powered Cable */ 320#define UCSI_CONSTAT_PARTNER_TYPE_DEBUG 5 321#define UCSI_CONSTAT_PARTNER_TYPE_AUDIO 6 322 u32 request_data_obj; 323 324 u8 pwr_status[3]; 325#define UCSI_CONSTAT_BC_STATUS(_p_) ((_p_[0]) & GENMASK(1, 0)) 326#define UCSI_CONSTAT_BC_NOT_CHARGING 0 327#define UCSI_CONSTAT_BC_NOMINAL_CHARGING 1 328#define UCSI_CONSTAT_BC_SLOW_CHARGING 2 329#define UCSI_CONSTAT_BC_TRICKLE_CHARGING 3 330#define UCSI_CONSTAT_PROVIDER_CAP_LIMIT(_p_) (((_p_[0]) & GENMASK(5, 2)) >> 2) 331#define UCSI_CONSTAT_CAP_PWR_LOWERED 0 332#define UCSI_CONSTAT_CAP_PWR_BUDGET_LIMIT 1 333#define UCSI_CONSTAT_PROVIDER_PD_VERSION_OPER_MODE(_p_) \ 334 ((get_unaligned_le32(_p_) & GENMASK(21, 6)) >> 6) 335#define UCSI_CONSTAT_ORIENTATION(_p_) (((_p_[2]) & GENMASK(6, 6)) >> 6) 336#define UCSI_CONSTAT_ORIENTATION_DIRECT 0 337#define UCSI_CONSTAT_ORIENTATION_FLIPPED 1 338#define UCSI_CONSTAT_SINK_PATH_STATUS(_p_) (((_p_[2]) & GENMASK(7, 7)) >> 7) 339#define UCSI_CONSTAT_SINK_PATH_DISABLED 0 340#define UCSI_CONSTAT_SINK_PATH_ENABLED 1 341 u8 pwr_readings[9]; 342#define UCSI_CONSTAT_REV_CURR_PROT_STATUS(_p_) ((_p_[0]) & 0x1) 343#define UCSI_CONSTAT_PWR_READING_VALID(_p_) (((_p_[0]) & GENMASK(1, 1)) >> 1) 344#define UCSI_CONSTAT_CURRENT_SCALE(_p_) (((_p_[0]) & GENMASK(4, 2)) >> 2) 345#define UCSI_CONSTAT_PEAK_CURRENT(_p_) \ 346 ((get_unaligned_le32(_p_) & GENMASK(20, 5)) >> 5) 347#define UCSI_CONSTAT_AVG_CURRENT(_p_) \ 348 ((get_unaligned_le32(&(_p_)[2]) & GENMASK(20, 5)) >> 5) 349#define UCSI_CONSTAT_VOLTAGE_SCALE(_p_) \ 350 ((get_unaligned_le16(&(_p_)[4]) & GENMASK(8, 5)) >> 5) 351#define UCSI_CONSTAT_VOLTAGE_READING(_p_) \ 352 ((get_unaligned_le32(&(_p_)[5]) & GENMASK(16, 1)) >> 1) 353} __packed; 354 355/* 356 * Data structure filled by PPM in response to GET_PD_MESSAGE command with the 357 * Response Message Type set to Discover Identity Response. 358 */ 359struct ucsi_pd_message_disc_id { 360 u32 vdm_header; 361 u32 id_header; 362 u32 cert_stat; 363 u32 product; 364 u32 vdo[3]; 365} __packed; 366 367/* -------------------------------------------------------------------------- */ 368 369struct ucsi_debugfs_entry { 370 u64 command; 371 struct ucsi_data { 372 u64 low; 373 u64 high; 374 } response; 375 u32 status; 376 struct dentry *dentry; 377}; 378 379struct ucsi { 380 u16 version; 381 struct device *dev; 382 struct driver_data *driver_data; 383 384 const struct ucsi_operations *ops; 385 386 struct ucsi_capability cap; 387 struct ucsi_connector *connector; 388 struct ucsi_debugfs_entry *debugfs; 389 390 struct work_struct resume_work; 391 struct delayed_work work; 392 int work_count; 393#define UCSI_ROLE_SWITCH_RETRY_PER_HZ 10 394#define UCSI_ROLE_SWITCH_INTERVAL (HZ / UCSI_ROLE_SWITCH_RETRY_PER_HZ) 395#define UCSI_ROLE_SWITCH_WAIT_COUNT (10 * UCSI_ROLE_SWITCH_RETRY_PER_HZ) 396 397 /* PPM Communication lock */ 398 struct mutex ppm_lock; 399 400 /* The latest "Notification Enable" bits (SET_NOTIFICATION_ENABLE) */ 401 u64 ntfy; 402 403 /* PPM communication flags */ 404 unsigned long flags; 405#define EVENT_PENDING 0 406#define COMMAND_PENDING 1 407#define ACK_PENDING 2 408 409 unsigned long quirks; 410#define UCSI_NO_PARTNER_PDOS BIT(0) /* Don't read partner's PDOs */ 411}; 412 413#define UCSI_MAX_SVID 5 414#define UCSI_MAX_ALTMODES (UCSI_MAX_SVID * 6) 415 416#define UCSI_TYPEC_VSAFE5V 5000 417#define UCSI_TYPEC_1_5_CURRENT 1500 418#define UCSI_TYPEC_3_0_CURRENT 3000 419 420struct ucsi_connector { 421 int num; 422 423 struct ucsi *ucsi; 424 struct mutex lock; /* port lock */ 425 struct work_struct work; 426 struct completion complete; 427 struct workqueue_struct *wq; 428 struct list_head partner_tasks; 429 430 struct typec_port *port; 431 struct typec_partner *partner; 432 struct typec_cable *cable; 433 struct typec_plug *plug; 434 435 struct typec_altmode *port_altmode[UCSI_MAX_ALTMODES]; 436 struct typec_altmode *partner_altmode[UCSI_MAX_ALTMODES]; 437 struct typec_altmode *plug_altmode[UCSI_MAX_ALTMODES]; 438 439 struct typec_capability typec_cap; 440 441 struct ucsi_connector_status status; 442 struct ucsi_connector_capability cap; 443 struct ucsi_cable_property cable_prop; 444 struct power_supply *psy; 445 struct power_supply_desc psy_desc; 446 u32 rdo; 447 u32 src_pdos[PDO_MAX_OBJECTS]; 448 int num_pdos; 449 450 /* USB PD objects */ 451 struct usb_power_delivery *pd; 452 struct usb_power_delivery_capabilities *port_source_caps; 453 struct usb_power_delivery_capabilities *port_sink_caps; 454 struct usb_power_delivery *partner_pd; 455 struct usb_power_delivery_capabilities *partner_source_caps; 456 struct usb_power_delivery_capabilities *partner_sink_caps; 457 458 struct usb_role_switch *usb_role_sw; 459 460 /* USB PD identity */ 461 struct usb_pd_identity partner_identity; 462 struct usb_pd_identity cable_identity; 463}; 464 465int ucsi_send_command(struct ucsi *ucsi, u64 command, 466 void *retval, size_t size); 467 468void ucsi_altmode_update_active(struct ucsi_connector *con); 469int ucsi_resume(struct ucsi *ucsi); 470 471#if IS_ENABLED(CONFIG_POWER_SUPPLY) 472int ucsi_register_port_psy(struct ucsi_connector *con); 473void ucsi_unregister_port_psy(struct ucsi_connector *con); 474void ucsi_port_psy_changed(struct ucsi_connector *con); 475#else 476static inline int ucsi_register_port_psy(struct ucsi_connector *con) { return 0; } 477static inline void ucsi_unregister_port_psy(struct ucsi_connector *con) { } 478static inline void ucsi_port_psy_changed(struct ucsi_connector *con) { } 479#endif /* CONFIG_POWER_SUPPLY */ 480 481#if IS_ENABLED(CONFIG_TYPEC_DP_ALTMODE) 482struct typec_altmode * 483ucsi_register_displayport(struct ucsi_connector *con, 484 bool override, int offset, 485 struct typec_altmode_desc *desc); 486 487void ucsi_displayport_remove_partner(struct typec_altmode *adev); 488 489#else 490static inline struct typec_altmode * 491ucsi_register_displayport(struct ucsi_connector *con, 492 bool override, int offset, 493 struct typec_altmode_desc *desc) 494{ 495 return NULL; 496} 497 498static inline void 499ucsi_displayport_remove_partner(struct typec_altmode *adev) { } 500#endif /* CONFIG_TYPEC_DP_ALTMODE */ 501 502#ifdef CONFIG_DEBUG_FS 503void ucsi_debugfs_init(void); 504void ucsi_debugfs_exit(void); 505void ucsi_debugfs_register(struct ucsi *ucsi); 506void ucsi_debugfs_unregister(struct ucsi *ucsi); 507#else 508static inline void ucsi_debugfs_init(void) { } 509static inline void ucsi_debugfs_exit(void) { } 510static inline void ucsi_debugfs_register(struct ucsi *ucsi) { } 511static inline void ucsi_debugfs_unregister(struct ucsi *ucsi) { } 512#endif /* CONFIG_DEBUG_FS */ 513 514/* 515 * NVIDIA VirtualLink (svid 0x955) has two altmode. VirtualLink 516 * DP mode with vdo=0x1 and NVIDIA test mode with vdo=0x3 517 */ 518#define USB_TYPEC_NVIDIA_VLINK_DP_VDO 0x1 519#define USB_TYPEC_NVIDIA_VLINK_DBG_VDO 0x3 520 521#endif /* __DRIVER_USB_TYPEC_UCSI_H */ 522