1 /* 2 * Copyright 2015-2017 Google, Inc 3 * 4 * This program is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License as published by 6 * the Free Software Foundation; either version 2 of the License, or 7 * (at your option) any later version. 8 * 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 */ 14 15 #ifndef __LINUX_USB_PD_H 16 #define __LINUX_USB_PD_H 17 18 #include <linux/types.h> 19 #include <linux/usb/typec.h> 20 21 /* USB PD Messages */ 22 enum pd_ctrl_msg_type { 23 /* 0 Reserved */ 24 PD_CTRL_GOOD_CRC = 1, 25 PD_CTRL_GOTO_MIN = 2, 26 PD_CTRL_ACCEPT = 3, 27 PD_CTRL_REJECT = 4, 28 PD_CTRL_PING = 5, 29 PD_CTRL_PS_RDY = 6, 30 PD_CTRL_GET_SOURCE_CAP = 7, 31 PD_CTRL_GET_SINK_CAP = 8, 32 PD_CTRL_DR_SWAP = 9, 33 PD_CTRL_PR_SWAP = 10, 34 PD_CTRL_VCONN_SWAP = 11, 35 PD_CTRL_WAIT = 12, 36 PD_CTRL_SOFT_RESET = 13, 37 /* 14-15 Reserved */ 38 PD_CTRL_NOT_SUPP = 16, 39 PD_CTRL_GET_SOURCE_CAP_EXT = 17, 40 PD_CTRL_GET_STATUS = 18, 41 PD_CTRL_FR_SWAP = 19, 42 PD_CTRL_GET_PPS_STATUS = 20, 43 PD_CTRL_GET_COUNTRY_CODES = 21, 44 /* 22-31 Reserved */ 45 }; 46 47 enum pd_data_msg_type { 48 /* 0 Reserved */ 49 PD_DATA_SOURCE_CAP = 1, 50 PD_DATA_REQUEST = 2, 51 PD_DATA_BIST = 3, 52 PD_DATA_SINK_CAP = 4, 53 PD_DATA_BATT_STATUS = 5, 54 PD_DATA_ALERT = 6, 55 PD_DATA_GET_COUNTRY_INFO = 7, 56 /* 8-14 Reserved */ 57 PD_DATA_VENDOR_DEF = 15, 58 /* 16-31 Reserved */ 59 }; 60 61 enum pd_ext_msg_type { 62 /* 0 Reserved */ 63 PD_EXT_SOURCE_CAP_EXT = 1, 64 PD_EXT_STATUS = 2, 65 PD_EXT_GET_BATT_CAP = 3, 66 PD_EXT_GET_BATT_STATUS = 4, 67 PD_EXT_BATT_CAP = 5, 68 PD_EXT_GET_MANUFACTURER_INFO = 6, 69 PD_EXT_MANUFACTURER_INFO = 7, 70 PD_EXT_SECURITY_REQUEST = 8, 71 PD_EXT_SECURITY_RESPONSE = 9, 72 PD_EXT_FW_UPDATE_REQUEST = 10, 73 PD_EXT_FW_UPDATE_RESPONSE = 11, 74 PD_EXT_PPS_STATUS = 12, 75 PD_EXT_COUNTRY_INFO = 13, 76 PD_EXT_COUNTRY_CODES = 14, 77 /* 15-31 Reserved */ 78 }; 79 80 #define PD_REV10 0x0 81 #define PD_REV20 0x1 82 #define PD_REV30 0x2 83 #define PD_MAX_REV PD_REV30 84 85 #define PD_HEADER_EXT_HDR BIT(15) 86 #define PD_HEADER_CNT_SHIFT 12 87 #define PD_HEADER_CNT_MASK 0x7 88 #define PD_HEADER_ID_SHIFT 9 89 #define PD_HEADER_ID_MASK 0x7 90 #define PD_HEADER_PWR_ROLE BIT(8) 91 #define PD_HEADER_REV_SHIFT 6 92 #define PD_HEADER_REV_MASK 0x3 93 #define PD_HEADER_DATA_ROLE BIT(5) 94 #define PD_HEADER_TYPE_SHIFT 0 95 #define PD_HEADER_TYPE_MASK 0x1f 96 97 #define PD_HEADER(type, pwr, data, rev, id, cnt, ext_hdr) \ 98 ((((type) & PD_HEADER_TYPE_MASK) << PD_HEADER_TYPE_SHIFT) | \ 99 ((pwr) == TYPEC_SOURCE ? PD_HEADER_PWR_ROLE : 0) | \ 100 ((data) == TYPEC_HOST ? PD_HEADER_DATA_ROLE : 0) | \ 101 (rev << PD_HEADER_REV_SHIFT) | \ 102 (((id) & PD_HEADER_ID_MASK) << PD_HEADER_ID_SHIFT) | \ 103 (((cnt) & PD_HEADER_CNT_MASK) << PD_HEADER_CNT_SHIFT) | \ 104 ((ext_hdr) ? PD_HEADER_EXT_HDR : 0)) 105 106 #define PD_HEADER_LE(type, pwr, data, id, cnt) \ 107 cpu_to_le16(PD_HEADER((type), (pwr), (data), PD_REV20, (id), (cnt), (0))) 108 109 static inline unsigned int pd_header_cnt(u16 header) 110 { 111 return (header >> PD_HEADER_CNT_SHIFT) & PD_HEADER_CNT_MASK; 112 } 113 114 static inline unsigned int pd_header_cnt_le(__le16 header) 115 { 116 return pd_header_cnt(le16_to_cpu(header)); 117 } 118 119 static inline unsigned int pd_header_type(u16 header) 120 { 121 return (header >> PD_HEADER_TYPE_SHIFT) & PD_HEADER_TYPE_MASK; 122 } 123 124 static inline unsigned int pd_header_type_le(__le16 header) 125 { 126 return pd_header_type(le16_to_cpu(header)); 127 } 128 129 static inline unsigned int pd_header_msgid(u16 header) 130 { 131 return (header >> PD_HEADER_ID_SHIFT) & PD_HEADER_ID_MASK; 132 } 133 134 static inline unsigned int pd_header_msgid_le(__le16 header) 135 { 136 return pd_header_msgid(le16_to_cpu(header)); 137 } 138 139 static inline unsigned int pd_header_rev(u16 header) 140 { 141 return (header >> PD_HEADER_REV_SHIFT) & PD_HEADER_REV_MASK; 142 } 143 144 static inline unsigned int pd_header_rev_le(__le16 header) 145 { 146 return pd_header_rev(le16_to_cpu(header)); 147 } 148 149 #define PD_EXT_HDR_CHUNKED BIT(15) 150 #define PD_EXT_HDR_CHUNK_NUM_SHIFT 11 151 #define PD_EXT_HDR_CHUNK_NUM_MASK 0xf 152 #define PD_EXT_HDR_REQ_CHUNK BIT(10) 153 #define PD_EXT_HDR_DATA_SIZE_SHIFT 0 154 #define PD_EXT_HDR_DATA_SIZE_MASK 0x1ff 155 156 #define PD_EXT_HDR(data_size, req_chunk, chunk_num, chunked) \ 157 ((((data_size) & PD_EXT_HDR_DATA_SIZE_MASK) << PD_EXT_HDR_DATA_SIZE_SHIFT) | \ 158 ((req_chunk) ? PD_EXT_HDR_REQ_CHUNK : 0) | \ 159 (((chunk_num) & PD_EXT_HDR_CHUNK_NUM_MASK) << PD_EXT_HDR_CHUNK_NUM_SHIFT) | \ 160 ((chunked) ? PD_EXT_HDR_CHUNKED : 0)) 161 162 #define PD_EXT_HDR_LE(data_size, req_chunk, chunk_num, chunked) \ 163 cpu_to_le16(PD_EXT_HDR((data_size), (req_chunk), (chunk_num), (chunked))) 164 165 static inline unsigned int pd_ext_header_chunk_num(u16 ext_header) 166 { 167 return (ext_header >> PD_EXT_HDR_CHUNK_NUM_SHIFT) & 168 PD_EXT_HDR_CHUNK_NUM_MASK; 169 } 170 171 static inline unsigned int pd_ext_header_data_size(u16 ext_header) 172 { 173 return (ext_header >> PD_EXT_HDR_DATA_SIZE_SHIFT) & 174 PD_EXT_HDR_DATA_SIZE_MASK; 175 } 176 177 static inline unsigned int pd_ext_header_data_size_le(__le16 ext_header) 178 { 179 return pd_ext_header_data_size(le16_to_cpu(ext_header)); 180 } 181 182 #define PD_MAX_PAYLOAD 7 183 #define PD_EXT_MAX_CHUNK_DATA 26 184 185 /** 186 * struct pd_chunked_ext_message_data - PD chunked extended message data as 187 * seen on wire 188 * @header: PD extended message header 189 * @data: PD extended message data 190 */ 191 struct pd_chunked_ext_message_data { 192 __le16 header; 193 u8 data[PD_EXT_MAX_CHUNK_DATA]; 194 } __packed; 195 196 /** 197 * struct pd_message - PD message as seen on wire 198 * @header: PD message header 199 * @payload: PD message payload 200 * @ext_msg: PD message chunked extended message data 201 */ 202 struct pd_message { 203 __le16 header; 204 union { 205 __le32 payload[PD_MAX_PAYLOAD]; 206 struct pd_chunked_ext_message_data ext_msg; 207 }; 208 } __packed; 209 210 /* PDO: Power Data Object */ 211 #define PDO_MAX_OBJECTS 7 212 213 enum pd_pdo_type { 214 PDO_TYPE_FIXED = 0, 215 PDO_TYPE_BATT = 1, 216 PDO_TYPE_VAR = 2, 217 PDO_TYPE_APDO = 3, 218 }; 219 220 #define PDO_TYPE_SHIFT 30 221 #define PDO_TYPE_MASK 0x3 222 223 #define PDO_TYPE(t) ((t) << PDO_TYPE_SHIFT) 224 225 #define PDO_VOLT_MASK 0x3ff 226 #define PDO_CURR_MASK 0x3ff 227 #define PDO_PWR_MASK 0x3ff 228 229 #define PDO_FIXED_DUAL_ROLE BIT(29) /* Power role swap supported */ 230 #define PDO_FIXED_SUSPEND BIT(28) /* USB Suspend supported (Source) */ 231 #define PDO_FIXED_HIGHER_CAP BIT(28) /* Requires more than vSafe5V (Sink) */ 232 #define PDO_FIXED_EXTPOWER BIT(27) /* Externally powered */ 233 #define PDO_FIXED_USB_COMM BIT(26) /* USB communications capable */ 234 #define PDO_FIXED_DATA_SWAP BIT(25) /* Data role swap supported */ 235 #define PDO_FIXED_VOLT_SHIFT 10 /* 50mV units */ 236 #define PDO_FIXED_CURR_SHIFT 0 /* 10mA units */ 237 238 #define PDO_FIXED_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT) 239 #define PDO_FIXED_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT) 240 241 #define PDO_FIXED(mv, ma, flags) \ 242 (PDO_TYPE(PDO_TYPE_FIXED) | (flags) | \ 243 PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma)) 244 245 #define VSAFE5V 5000 /* mv units */ 246 247 #define PDO_BATT_MAX_VOLT_SHIFT 20 /* 50mV units */ 248 #define PDO_BATT_MIN_VOLT_SHIFT 10 /* 50mV units */ 249 #define PDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */ 250 251 #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT) 252 #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT) 253 #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT) 254 255 #define PDO_BATT(min_mv, max_mv, max_mw) \ 256 (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) | \ 257 PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw)) 258 259 #define PDO_VAR_MAX_VOLT_SHIFT 20 /* 50mV units */ 260 #define PDO_VAR_MIN_VOLT_SHIFT 10 /* 50mV units */ 261 #define PDO_VAR_MAX_CURR_SHIFT 0 /* 10mA units */ 262 263 #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT) 264 #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT) 265 #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT) 266 267 #define PDO_VAR(min_mv, max_mv, max_ma) \ 268 (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) | \ 269 PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma)) 270 271 enum pd_apdo_type { 272 APDO_TYPE_PPS = 0, 273 }; 274 275 #define PDO_APDO_TYPE_SHIFT 28 /* Only valid value currently is 0x0 - PPS */ 276 #define PDO_APDO_TYPE_MASK 0x3 277 278 #define PDO_APDO_TYPE(t) ((t) << PDO_APDO_TYPE_SHIFT) 279 280 #define PDO_PPS_APDO_MAX_VOLT_SHIFT 17 /* 100mV units */ 281 #define PDO_PPS_APDO_MIN_VOLT_SHIFT 8 /* 100mV units */ 282 #define PDO_PPS_APDO_MAX_CURR_SHIFT 0 /* 50mA units */ 283 284 #define PDO_PPS_APDO_VOLT_MASK 0xff 285 #define PDO_PPS_APDO_CURR_MASK 0x7f 286 287 #define PDO_PPS_APDO_MIN_VOLT(mv) \ 288 ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT) 289 #define PDO_PPS_APDO_MAX_VOLT(mv) \ 290 ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT) 291 #define PDO_PPS_APDO_MAX_CURR(ma) \ 292 ((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT) 293 294 #define PDO_PPS_APDO(min_mv, max_mv, max_ma) \ 295 (PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) | \ 296 PDO_PPS_APDO_MIN_VOLT(min_mv) | PDO_PPS_APDO_MAX_VOLT(max_mv) | \ 297 PDO_PPS_APDO_MAX_CURR(max_ma)) 298 299 static inline enum pd_pdo_type pdo_type(u32 pdo) 300 { 301 return (pdo >> PDO_TYPE_SHIFT) & PDO_TYPE_MASK; 302 } 303 304 static inline unsigned int pdo_fixed_voltage(u32 pdo) 305 { 306 return ((pdo >> PDO_FIXED_VOLT_SHIFT) & PDO_VOLT_MASK) * 50; 307 } 308 309 static inline unsigned int pdo_min_voltage(u32 pdo) 310 { 311 return ((pdo >> PDO_VAR_MIN_VOLT_SHIFT) & PDO_VOLT_MASK) * 50; 312 } 313 314 static inline unsigned int pdo_max_voltage(u32 pdo) 315 { 316 return ((pdo >> PDO_VAR_MAX_VOLT_SHIFT) & PDO_VOLT_MASK) * 50; 317 } 318 319 static inline unsigned int pdo_max_current(u32 pdo) 320 { 321 return ((pdo >> PDO_VAR_MAX_CURR_SHIFT) & PDO_CURR_MASK) * 10; 322 } 323 324 static inline unsigned int pdo_max_power(u32 pdo) 325 { 326 return ((pdo >> PDO_BATT_MAX_PWR_SHIFT) & PDO_PWR_MASK) * 250; 327 } 328 329 static inline enum pd_apdo_type pdo_apdo_type(u32 pdo) 330 { 331 return (pdo >> PDO_APDO_TYPE_SHIFT) & PDO_APDO_TYPE_MASK; 332 } 333 334 static inline unsigned int pdo_pps_apdo_min_voltage(u32 pdo) 335 { 336 return ((pdo >> PDO_PPS_APDO_MIN_VOLT_SHIFT) & 337 PDO_PPS_APDO_VOLT_MASK) * 100; 338 } 339 340 static inline unsigned int pdo_pps_apdo_max_voltage(u32 pdo) 341 { 342 return ((pdo >> PDO_PPS_APDO_MAX_VOLT_SHIFT) & 343 PDO_PPS_APDO_VOLT_MASK) * 100; 344 } 345 346 static inline unsigned int pdo_pps_apdo_max_current(u32 pdo) 347 { 348 return ((pdo >> PDO_PPS_APDO_MAX_CURR_SHIFT) & 349 PDO_PPS_APDO_CURR_MASK) * 50; 350 } 351 352 /* RDO: Request Data Object */ 353 #define RDO_OBJ_POS_SHIFT 28 354 #define RDO_OBJ_POS_MASK 0x7 355 #define RDO_GIVE_BACK BIT(27) /* Supports reduced operating current */ 356 #define RDO_CAP_MISMATCH BIT(26) /* Not satisfied by source caps */ 357 #define RDO_USB_COMM BIT(25) /* USB communications capable */ 358 #define RDO_NO_SUSPEND BIT(24) /* USB Suspend not supported */ 359 360 #define RDO_PWR_MASK 0x3ff 361 #define RDO_CURR_MASK 0x3ff 362 363 #define RDO_FIXED_OP_CURR_SHIFT 10 364 #define RDO_FIXED_MAX_CURR_SHIFT 0 365 366 #define RDO_OBJ(idx) (((idx) & RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT) 367 368 #define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT) 369 #define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT) 370 371 #define RDO_FIXED(idx, op_ma, max_ma, flags) \ 372 (RDO_OBJ(idx) | (flags) | \ 373 PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma)) 374 375 #define RDO_BATT_OP_PWR_SHIFT 10 /* 250mW units */ 376 #define RDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */ 377 378 #define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT) 379 #define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT) 380 381 #define RDO_BATT(idx, op_mw, max_mw, flags) \ 382 (RDO_OBJ(idx) | (flags) | \ 383 RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw)) 384 385 #define RDO_PROG_VOLT_MASK 0x7ff 386 #define RDO_PROG_CURR_MASK 0x7f 387 388 #define RDO_PROG_VOLT_SHIFT 9 389 #define RDO_PROG_CURR_SHIFT 0 390 391 #define RDO_PROG_VOLT_MV_STEP 20 392 #define RDO_PROG_CURR_MA_STEP 50 393 394 #define PDO_PROG_OUT_VOLT(mv) \ 395 ((((mv) / RDO_PROG_VOLT_MV_STEP) & RDO_PROG_VOLT_MASK) << RDO_PROG_VOLT_SHIFT) 396 #define PDO_PROG_OP_CURR(ma) \ 397 ((((ma) / RDO_PROG_CURR_MA_STEP) & RDO_PROG_CURR_MASK) << RDO_PROG_CURR_SHIFT) 398 399 #define RDO_PROG(idx, out_mv, op_ma, flags) \ 400 (RDO_OBJ(idx) | (flags) | \ 401 PDO_PROG_OUT_VOLT(out_mv) | PDO_PROG_OP_CURR(op_ma)) 402 403 static inline unsigned int rdo_index(u32 rdo) 404 { 405 return (rdo >> RDO_OBJ_POS_SHIFT) & RDO_OBJ_POS_MASK; 406 } 407 408 static inline unsigned int rdo_op_current(u32 rdo) 409 { 410 return ((rdo >> RDO_FIXED_OP_CURR_SHIFT) & RDO_CURR_MASK) * 10; 411 } 412 413 static inline unsigned int rdo_max_current(u32 rdo) 414 { 415 return ((rdo >> RDO_FIXED_MAX_CURR_SHIFT) & 416 RDO_CURR_MASK) * 10; 417 } 418 419 static inline unsigned int rdo_op_power(u32 rdo) 420 { 421 return ((rdo >> RDO_BATT_OP_PWR_SHIFT) & RDO_PWR_MASK) * 250; 422 } 423 424 static inline unsigned int rdo_max_power(u32 rdo) 425 { 426 return ((rdo >> RDO_BATT_MAX_PWR_SHIFT) & RDO_PWR_MASK) * 250; 427 } 428 429 /* USB PD timers and counters */ 430 #define PD_T_NO_RESPONSE 5000 /* 4.5 - 5.5 seconds */ 431 #define PD_T_DB_DETECT 10000 /* 10 - 15 seconds */ 432 #define PD_T_SEND_SOURCE_CAP 150 /* 100 - 200 ms */ 433 #define PD_T_SENDER_RESPONSE 60 /* 24 - 30 ms, relaxed */ 434 #define PD_T_SOURCE_ACTIVITY 45 435 #define PD_T_SINK_ACTIVITY 135 436 #define PD_T_SINK_WAIT_CAP 240 437 #define PD_T_PS_TRANSITION 500 438 #define PD_T_SRC_TRANSITION 35 439 #define PD_T_DRP_SNK 40 440 #define PD_T_DRP_SRC 30 441 #define PD_T_PS_SOURCE_OFF 920 442 #define PD_T_PS_SOURCE_ON 480 443 #define PD_T_PS_HARD_RESET 30 444 #define PD_T_SRC_RECOVER 760 445 #define PD_T_SRC_RECOVER_MAX 1000 446 #define PD_T_SRC_TURN_ON 275 447 #define PD_T_SAFE_0V 650 448 #define PD_T_VCONN_SOURCE_ON 100 449 #define PD_T_SINK_REQUEST 100 /* 100 ms minimum */ 450 #define PD_T_ERROR_RECOVERY 100 /* minimum 25 is insufficient */ 451 #define PD_T_SRCSWAPSTDBY 625 /* Maximum of 650ms */ 452 #define PD_T_NEWSRC 250 /* Maximum of 275ms */ 453 454 #define PD_T_DRP_TRY 100 /* 75 - 150 ms */ 455 #define PD_T_DRP_TRYWAIT 600 /* 400 - 800 ms */ 456 457 #define PD_T_CC_DEBOUNCE 200 /* 100 - 200 ms */ 458 #define PD_T_PD_DEBOUNCE 20 /* 10 - 20 ms */ 459 460 #define PD_N_CAPS_COUNT (PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP) 461 #define PD_N_HARD_RESET_COUNT 2 462 463 #endif /* __LINUX_USB_PD_H */ 464