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