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/role.h> 12 13 /* -------------------------------------------------------------------------- */ 14 15 struct ucsi; 16 struct ucsi_altmode; 17 18 /* UCSI offsets (Bytes) */ 19 #define UCSI_VERSION 0 20 #define UCSI_CCI 4 21 #define UCSI_CONTROL 8 22 #define UCSI_MESSAGE_IN 16 23 #define UCSI_MESSAGE_OUT 32 24 25 /* Command Status and Connector Change Indication (CCI) bits */ 26 #define UCSI_CCI_CONNECTOR(_c_) (((_c_) & GENMASK(7, 1)) >> 1) 27 #define UCSI_CCI_LENGTH(_c_) (((_c_) & GENMASK(15, 8)) >> 8) 28 #define UCSI_CCI_NOT_SUPPORTED BIT(25) 29 #define UCSI_CCI_CANCEL_COMPLETE BIT(26) 30 #define UCSI_CCI_RESET_COMPLETE BIT(27) 31 #define UCSI_CCI_BUSY BIT(28) 32 #define UCSI_CCI_ACK_COMPLETE BIT(29) 33 #define UCSI_CCI_ERROR BIT(30) 34 #define UCSI_CCI_COMMAND_COMPLETE BIT(31) 35 36 /** 37 * struct ucsi_operations - UCSI I/O operations 38 * @read: Read operation 39 * @sync_write: Blocking write operation 40 * @async_write: Non-blocking write operation 41 * @update_altmodes: Squashes duplicate DP altmodes 42 * 43 * Read and write routines for UCSI interface. @sync_write must wait for the 44 * Command Completion Event from the PPM before returning, and @async_write must 45 * return immediately after sending the data to the PPM. 46 */ 47 struct ucsi_operations { 48 int (*read)(struct ucsi *ucsi, unsigned int offset, 49 void *val, size_t val_len); 50 int (*sync_write)(struct ucsi *ucsi, unsigned int offset, 51 const void *val, size_t val_len); 52 int (*async_write)(struct ucsi *ucsi, unsigned int offset, 53 const void *val, size_t val_len); 54 bool (*update_altmodes)(struct ucsi *ucsi, struct ucsi_altmode *orig, 55 struct ucsi_altmode *updated); 56 }; 57 58 struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops); 59 void ucsi_destroy(struct ucsi *ucsi); 60 int ucsi_register(struct ucsi *ucsi); 61 void ucsi_unregister(struct ucsi *ucsi); 62 void *ucsi_get_drvdata(struct ucsi *ucsi); 63 void ucsi_set_drvdata(struct ucsi *ucsi, void *data); 64 65 void ucsi_connector_change(struct ucsi *ucsi, u8 num); 66 67 /* -------------------------------------------------------------------------- */ 68 69 /* Commands */ 70 #define UCSI_PPM_RESET 0x01 71 #define UCSI_CANCEL 0x02 72 #define UCSI_CONNECTOR_RESET 0x03 73 #define UCSI_ACK_CC_CI 0x04 74 #define UCSI_SET_NOTIFICATION_ENABLE 0x05 75 #define UCSI_GET_CAPABILITY 0x06 76 #define UCSI_GET_CONNECTOR_CAPABILITY 0x07 77 #define UCSI_SET_UOM 0x08 78 #define UCSI_SET_UOR 0x09 79 #define UCSI_SET_PDM 0x0a 80 #define UCSI_SET_PDR 0x0b 81 #define UCSI_GET_ALTERNATE_MODES 0x0c 82 #define UCSI_GET_CAM_SUPPORTED 0x0d 83 #define UCSI_GET_CURRENT_CAM 0x0e 84 #define UCSI_SET_NEW_CAM 0x0f 85 #define UCSI_GET_PDOS 0x10 86 #define UCSI_GET_CABLE_PROPERTY 0x11 87 #define UCSI_GET_CONNECTOR_STATUS 0x12 88 #define UCSI_GET_ERROR_STATUS 0x13 89 90 #define UCSI_CONNECTOR_NUMBER(_num_) ((u64)(_num_) << 16) 91 #define UCSI_COMMAND(_cmd_) ((_cmd_) & 0xff) 92 93 /* CONNECTOR_RESET command bits */ 94 #define UCSI_CONNECTOR_RESET_HARD BIT(23) /* Deprecated in v1.1 */ 95 96 /* ACK_CC_CI bits */ 97 #define UCSI_ACK_CONNECTOR_CHANGE BIT(16) 98 #define UCSI_ACK_COMMAND_COMPLETE BIT(17) 99 100 /* SET_NOTIFICATION_ENABLE command bits */ 101 #define UCSI_ENABLE_NTFY_CMD_COMPLETE BIT(16) 102 #define UCSI_ENABLE_NTFY_EXT_PWR_SRC_CHANGE BIT(17) 103 #define UCSI_ENABLE_NTFY_PWR_OPMODE_CHANGE BIT(18) 104 #define UCSI_ENABLE_NTFY_CAP_CHANGE BIT(21) 105 #define UCSI_ENABLE_NTFY_PWR_LEVEL_CHANGE BIT(22) 106 #define UCSI_ENABLE_NTFY_PD_RESET_COMPLETE BIT(23) 107 #define UCSI_ENABLE_NTFY_CAM_CHANGE BIT(24) 108 #define UCSI_ENABLE_NTFY_BAT_STATUS_CHANGE BIT(25) 109 #define UCSI_ENABLE_NTFY_PARTNER_CHANGE BIT(27) 110 #define UCSI_ENABLE_NTFY_PWR_DIR_CHANGE BIT(28) 111 #define UCSI_ENABLE_NTFY_CONNECTOR_CHANGE BIT(30) 112 #define UCSI_ENABLE_NTFY_ERROR BIT(31) 113 #define UCSI_ENABLE_NTFY_ALL 0xdbe70000 114 115 /* SET_UOR command bits */ 116 #define UCSI_SET_UOR_ROLE(_r_) (((_r_) == TYPEC_HOST ? 1 : 2) << 23) 117 #define UCSI_SET_UOR_ACCEPT_ROLE_SWAPS BIT(25) 118 119 /* SET_PDF command bits */ 120 #define UCSI_SET_PDR_ROLE(_r_) (((_r_) == TYPEC_SOURCE ? 1 : 2) << 23) 121 #define UCSI_SET_PDR_ACCEPT_ROLE_SWAPS BIT(25) 122 123 /* GET_ALTERNATE_MODES command bits */ 124 #define UCSI_ALTMODE_RECIPIENT(_r_) (((_r_) >> 16) & 0x7) 125 #define UCSI_GET_ALTMODE_RECIPIENT(_r_) ((u64)(_r_) << 16) 126 #define UCSI_RECIPIENT_CON 0 127 #define UCSI_RECIPIENT_SOP 1 128 #define UCSI_RECIPIENT_SOP_P 2 129 #define UCSI_RECIPIENT_SOP_PP 3 130 #define UCSI_GET_ALTMODE_CONNECTOR_NUMBER(_r_) ((u64)(_r_) << 24) 131 #define UCSI_ALTMODE_OFFSET(_r_) (((_r_) >> 32) & 0xff) 132 #define UCSI_GET_ALTMODE_OFFSET(_r_) ((u64)(_r_) << 32) 133 #define UCSI_GET_ALTMODE_NUM_ALTMODES(_r_) ((u64)(_r_) << 40) 134 135 /* GET_PDOS command bits */ 136 #define UCSI_GET_PDOS_PARTNER_PDO(_r_) ((u64)(_r_) << 23) 137 #define UCSI_GET_PDOS_NUM_PDOS(_r_) ((u64)(_r_) << 32) 138 #define UCSI_GET_PDOS_SRC_PDOS ((u64)1 << 34) 139 140 /* -------------------------------------------------------------------------- */ 141 142 /* Error information returned by PPM in response to GET_ERROR_STATUS command. */ 143 #define UCSI_ERROR_UNREGONIZED_CMD BIT(0) 144 #define UCSI_ERROR_INVALID_CON_NUM BIT(1) 145 #define UCSI_ERROR_INVALID_CMD_ARGUMENT BIT(2) 146 #define UCSI_ERROR_INCOMPATIBLE_PARTNER BIT(3) 147 #define UCSI_ERROR_CC_COMMUNICATION_ERR BIT(4) 148 #define UCSI_ERROR_DEAD_BATTERY BIT(5) 149 #define UCSI_ERROR_CONTRACT_NEGOTIATION_FAIL BIT(6) 150 #define UCSI_ERROR_OVERCURRENT BIT(7) 151 #define UCSI_ERROR_UNDEFINED BIT(8) 152 #define UCSI_ERROR_PARTNER_REJECTED_SWAP BIT(9) 153 #define UCSI_ERROR_HARD_RESET BIT(10) 154 #define UCSI_ERROR_PPM_POLICY_CONFLICT BIT(11) 155 #define UCSI_ERROR_SWAP_REJECTED BIT(12) 156 157 #define UCSI_SET_NEW_CAM_ENTER(x) (((x) >> 23) & 0x1) 158 #define UCSI_SET_NEW_CAM_GET_AM(x) (((x) >> 24) & 0xff) 159 #define UCSI_SET_NEW_CAM_AM_MASK (0xff << 24) 160 #define UCSI_SET_NEW_CAM_SET_AM(x) (((x) & 0xff) << 24) 161 #define UCSI_CMD_CONNECTOR_MASK (0x7) 162 163 /* Data structure filled by PPM in response to GET_CAPABILITY command. */ 164 struct ucsi_capability { 165 u32 attributes; 166 #define UCSI_CAP_ATTR_DISABLE_STATE BIT(0) 167 #define UCSI_CAP_ATTR_BATTERY_CHARGING BIT(1) 168 #define UCSI_CAP_ATTR_USB_PD BIT(2) 169 #define UCSI_CAP_ATTR_TYPEC_CURRENT BIT(6) 170 #define UCSI_CAP_ATTR_POWER_AC_SUPPLY BIT(8) 171 #define UCSI_CAP_ATTR_POWER_OTHER BIT(10) 172 #define UCSI_CAP_ATTR_POWER_VBUS BIT(14) 173 u8 num_connectors; 174 u8 features; 175 #define UCSI_CAP_SET_UOM BIT(0) 176 #define UCSI_CAP_SET_PDM BIT(1) 177 #define UCSI_CAP_ALT_MODE_DETAILS BIT(2) 178 #define UCSI_CAP_ALT_MODE_OVERRIDE BIT(3) 179 #define UCSI_CAP_PDO_DETAILS BIT(4) 180 #define UCSI_CAP_CABLE_DETAILS BIT(5) 181 #define UCSI_CAP_EXT_SUPPLY_NOTIFICATIONS BIT(6) 182 #define UCSI_CAP_PD_RESET BIT(7) 183 u16 reserved_1; 184 u8 num_alt_modes; 185 u8 reserved_2; 186 u16 bc_version; 187 u16 pd_version; 188 u16 typec_version; 189 } __packed; 190 191 /* Data structure filled by PPM in response to GET_CONNECTOR_CAPABILITY cmd. */ 192 struct ucsi_connector_capability { 193 u8 op_mode; 194 #define UCSI_CONCAP_OPMODE_DFP BIT(0) 195 #define UCSI_CONCAP_OPMODE_UFP BIT(1) 196 #define UCSI_CONCAP_OPMODE_DRP BIT(2) 197 #define UCSI_CONCAP_OPMODE_AUDIO_ACCESSORY BIT(3) 198 #define UCSI_CONCAP_OPMODE_DEBUG_ACCESSORY BIT(4) 199 #define UCSI_CONCAP_OPMODE_USB2 BIT(5) 200 #define UCSI_CONCAP_OPMODE_USB3 BIT(6) 201 #define UCSI_CONCAP_OPMODE_ALT_MODE BIT(7) 202 u8 flags; 203 #define UCSI_CONCAP_FLAG_PROVIDER BIT(0) 204 #define UCSI_CONCAP_FLAG_CONSUMER BIT(1) 205 } __packed; 206 207 struct ucsi_altmode { 208 u16 svid; 209 u32 mid; 210 } __packed; 211 212 /* Data structure filled by PPM in response to GET_CABLE_PROPERTY command. */ 213 struct ucsi_cable_property { 214 u16 speed_supported; 215 u8 current_capability; 216 u8 flags; 217 #define UCSI_CABLE_PROP_FLAG_VBUS_IN_CABLE BIT(0) 218 #define UCSI_CABLE_PROP_FLAG_ACTIVE_CABLE BIT(1) 219 #define UCSI_CABLE_PROP_FLAG_DIRECTIONALITY BIT(2) 220 #define UCSI_CABLE_PROP_FLAG_PLUG_TYPE(_f_) ((_f_) & GENMASK(3, 0)) 221 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_A 0 222 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_B 1 223 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_C 2 224 #define UCSI_CABLE_PROPERTY_PLUG_OTHER 3 225 #define UCSI_CABLE_PROP_MODE_SUPPORT BIT(5) 226 u8 latency; 227 } __packed; 228 229 /* Data structure filled by PPM in response to GET_CONNECTOR_STATUS command. */ 230 struct ucsi_connector_status { 231 u16 change; 232 #define UCSI_CONSTAT_EXT_SUPPLY_CHANGE BIT(1) 233 #define UCSI_CONSTAT_POWER_OPMODE_CHANGE BIT(2) 234 #define UCSI_CONSTAT_PDOS_CHANGE BIT(5) 235 #define UCSI_CONSTAT_POWER_LEVEL_CHANGE BIT(6) 236 #define UCSI_CONSTAT_PD_RESET_COMPLETE BIT(7) 237 #define UCSI_CONSTAT_CAM_CHANGE BIT(8) 238 #define UCSI_CONSTAT_BC_CHANGE BIT(9) 239 #define UCSI_CONSTAT_PARTNER_CHANGE BIT(11) 240 #define UCSI_CONSTAT_POWER_DIR_CHANGE BIT(12) 241 #define UCSI_CONSTAT_CONNECT_CHANGE BIT(14) 242 #define UCSI_CONSTAT_ERROR BIT(15) 243 u16 flags; 244 #define UCSI_CONSTAT_PWR_OPMODE(_f_) ((_f_) & GENMASK(2, 0)) 245 #define UCSI_CONSTAT_PWR_OPMODE_NONE 0 246 #define UCSI_CONSTAT_PWR_OPMODE_DEFAULT 1 247 #define UCSI_CONSTAT_PWR_OPMODE_BC 2 248 #define UCSI_CONSTAT_PWR_OPMODE_PD 3 249 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC1_5 4 250 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC3_0 5 251 #define UCSI_CONSTAT_CONNECTED BIT(3) 252 #define UCSI_CONSTAT_PWR_DIR BIT(4) 253 #define UCSI_CONSTAT_PARTNER_FLAGS(_f_) (((_f_) & GENMASK(12, 5)) >> 5) 254 #define UCSI_CONSTAT_PARTNER_FLAG_USB 1 255 #define UCSI_CONSTAT_PARTNER_FLAG_ALT_MODE 2 256 #define UCSI_CONSTAT_PARTNER_TYPE(_f_) (((_f_) & GENMASK(15, 13)) >> 13) 257 #define UCSI_CONSTAT_PARTNER_TYPE_DFP 1 258 #define UCSI_CONSTAT_PARTNER_TYPE_UFP 2 259 #define UCSI_CONSTAT_PARTNER_TYPE_CABLE 3 /* Powered Cable */ 260 #define UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP 4 /* Powered Cable */ 261 #define UCSI_CONSTAT_PARTNER_TYPE_DEBUG 5 262 #define UCSI_CONSTAT_PARTNER_TYPE_AUDIO 6 263 u32 request_data_obj; 264 u8 pwr_status; 265 #define UCSI_CONSTAT_BC_STATUS(_p_) ((_p_) & GENMASK(2, 0)) 266 #define UCSI_CONSTAT_BC_NOT_CHARGING 0 267 #define UCSI_CONSTAT_BC_NOMINAL_CHARGING 1 268 #define UCSI_CONSTAT_BC_SLOW_CHARGING 2 269 #define UCSI_CONSTAT_BC_TRICKLE_CHARGING 3 270 #define UCSI_CONSTAT_PROVIDER_CAP_LIMIT(_p_) (((_p_) & GENMASK(6, 3)) >> 3) 271 #define UCSI_CONSTAT_CAP_PWR_LOWERED 0 272 #define UCSI_CONSTAT_CAP_PWR_BUDGET_LIMIT 1 273 } __packed; 274 275 /* -------------------------------------------------------------------------- */ 276 277 struct ucsi { 278 u16 version; 279 struct device *dev; 280 struct driver_data *driver_data; 281 282 const struct ucsi_operations *ops; 283 284 struct ucsi_capability cap; 285 struct ucsi_connector *connector; 286 287 struct work_struct work; 288 289 /* PPM Communication lock */ 290 struct mutex ppm_lock; 291 292 /* The latest "Notification Enable" bits (SET_NOTIFICATION_ENABLE) */ 293 u64 ntfy; 294 295 /* PPM communication flags */ 296 unsigned long flags; 297 #define EVENT_PENDING 0 298 #define COMMAND_PENDING 1 299 #define ACK_PENDING 2 300 #define EVENT_PROCESSING 3 301 }; 302 303 #define UCSI_MAX_SVID 5 304 #define UCSI_MAX_ALTMODES (UCSI_MAX_SVID * 6) 305 #define UCSI_MAX_PDOS (4) 306 307 #define UCSI_TYPEC_VSAFE5V 5000 308 #define UCSI_TYPEC_1_5_CURRENT 1500 309 #define UCSI_TYPEC_3_0_CURRENT 3000 310 311 struct ucsi_connector { 312 int num; 313 314 struct ucsi *ucsi; 315 struct mutex lock; /* port lock */ 316 struct work_struct work; 317 struct completion complete; 318 319 struct typec_port *port; 320 struct typec_partner *partner; 321 322 struct typec_altmode *port_altmode[UCSI_MAX_ALTMODES]; 323 struct typec_altmode *partner_altmode[UCSI_MAX_ALTMODES]; 324 325 struct typec_capability typec_cap; 326 327 u16 unprocessed_changes; 328 struct ucsi_connector_status status; 329 struct ucsi_connector_capability cap; 330 struct power_supply *psy; 331 struct power_supply_desc psy_desc; 332 u32 rdo; 333 u32 src_pdos[UCSI_MAX_PDOS]; 334 int num_pdos; 335 336 struct usb_role_switch *usb_role_sw; 337 }; 338 339 int ucsi_send_command(struct ucsi *ucsi, u64 command, 340 void *retval, size_t size); 341 342 void ucsi_altmode_update_active(struct ucsi_connector *con); 343 int ucsi_resume(struct ucsi *ucsi); 344 345 #if IS_ENABLED(CONFIG_POWER_SUPPLY) 346 int ucsi_register_port_psy(struct ucsi_connector *con); 347 void ucsi_unregister_port_psy(struct ucsi_connector *con); 348 void ucsi_port_psy_changed(struct ucsi_connector *con); 349 #else 350 static inline int ucsi_register_port_psy(struct ucsi_connector *con) { return 0; } 351 static inline void ucsi_unregister_port_psy(struct ucsi_connector *con) { } 352 static inline void ucsi_port_psy_changed(struct ucsi_connector *con) { } 353 #endif /* CONFIG_POWER_SUPPLY */ 354 355 #if IS_ENABLED(CONFIG_TYPEC_DP_ALTMODE) 356 struct typec_altmode * 357 ucsi_register_displayport(struct ucsi_connector *con, 358 bool override, int offset, 359 struct typec_altmode_desc *desc); 360 361 void ucsi_displayport_remove_partner(struct typec_altmode *adev); 362 363 #else 364 static inline struct typec_altmode * 365 ucsi_register_displayport(struct ucsi_connector *con, 366 bool override, int offset, 367 struct typec_altmode_desc *desc) 368 { 369 return NULL; 370 } 371 372 static inline void 373 ucsi_displayport_remove_partner(struct typec_altmode *adev) { } 374 #endif /* CONFIG_TYPEC_DP_ALTMODE */ 375 376 /* 377 * NVIDIA VirtualLink (svid 0x955) has two altmode. VirtualLink 378 * DP mode with vdo=0x1 and NVIDIA test mode with vdo=0x3 379 */ 380 #define USB_TYPEC_NVIDIA_VLINK_DP_VDO 0x1 381 #define USB_TYPEC_NVIDIA_VLINK_DBG_VDO 0x3 382 383 #endif /* __DRIVER_USB_TYPEC_UCSI_H */ 384