include/linux/usb/pd.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Copyright 2015-2017 Google, Inc
   4  */
   5
   6 #ifndef __LINUX_USB_PD_H
   7 #define __LINUX_USB_PD_H
   8
   9 #include <linux/kernel.h>
  10 #include <linux/types.h>
  11 #include <linux/usb/typec.h>
  12
  13 /* USB PD Messages */
  14 enum pd_ctrl_msg_type {
  15         /* 0 Reserved */
  16         PD_CTRL_GOOD_CRC = 1,
  17         PD_CTRL_GOTO_MIN = 2,
  18         PD_CTRL_ACCEPT = 3,
  19         PD_CTRL_REJECT = 4,
  20         PD_CTRL_PING = 5,
  21         PD_CTRL_PS_RDY = 6,
  22         PD_CTRL_GET_SOURCE_CAP = 7,
  23         PD_CTRL_GET_SINK_CAP = 8,
  24         PD_CTRL_DR_SWAP = 9,
  25         PD_CTRL_PR_SWAP = 10,
  26         PD_CTRL_VCONN_SWAP = 11,
  27         PD_CTRL_WAIT = 12,
  28         PD_CTRL_SOFT_RESET = 13,
  29         /* 14-15 Reserved */
  30         PD_CTRL_NOT_SUPP = 16,
  31         PD_CTRL_GET_SOURCE_CAP_EXT = 17,
  32         PD_CTRL_GET_STATUS = 18,
  33         PD_CTRL_FR_SWAP = 19,
  34         PD_CTRL_GET_PPS_STATUS = 20,
  35         PD_CTRL_GET_COUNTRY_CODES = 21,
  36         /* 22-23 Reserved */
  37         PD_CTRL_GET_REVISION = 24,
  38         /* 25-31 Reserved */
  39 };
  40
  41 enum pd_data_msg_type {
  42         /* 0 Reserved */
  43         PD_DATA_SOURCE_CAP = 1,
  44         PD_DATA_REQUEST = 2,
  45         PD_DATA_BIST = 3,
  46         PD_DATA_SINK_CAP = 4,
  47         PD_DATA_BATT_STATUS = 5,
  48         PD_DATA_ALERT = 6,
  49         PD_DATA_GET_COUNTRY_INFO = 7,
  50         PD_DATA_ENTER_USB = 8,
  51         /* 9-11 Reserved */
  52         PD_DATA_REVISION = 12,
  53         /* 13-14 Reserved */
  54         PD_DATA_VENDOR_DEF = 15,
  55         /* 16-31 Reserved */
  56 };
  57
  58 enum pd_ext_msg_type {
  59         /* 0 Reserved */
  60         PD_EXT_SOURCE_CAP_EXT = 1,
  61         PD_EXT_STATUS = 2,
  62         PD_EXT_GET_BATT_CAP = 3,
  63         PD_EXT_GET_BATT_STATUS = 4,
  64         PD_EXT_BATT_CAP = 5,
  65         PD_EXT_GET_MANUFACTURER_INFO = 6,
  66         PD_EXT_MANUFACTURER_INFO = 7,
  67         PD_EXT_SECURITY_REQUEST = 8,
  68         PD_EXT_SECURITY_RESPONSE = 9,
  69         PD_EXT_FW_UPDATE_REQUEST = 10,
  70         PD_EXT_FW_UPDATE_RESPONSE = 11,
  71         PD_EXT_PPS_STATUS = 12,
  72         PD_EXT_COUNTRY_INFO = 13,
  73         PD_EXT_COUNTRY_CODES = 14,
  74         /* 15-31 Reserved */
  75 };
  76
  77 #define PD_REV10        0x0
  78 #define PD_REV20        0x1
  79 #define PD_REV30        0x2
  80 #define PD_MAX_REV      PD_REV30
  81
  82 #define PD_HEADER_EXT_HDR       BIT(15)
  83 #define PD_HEADER_CNT_SHIFT     12
  84 #define PD_HEADER_CNT_MASK      0x7
  85 #define PD_HEADER_ID_SHIFT      9
  86 #define PD_HEADER_ID_MASK       0x7
  87 #define PD_HEADER_PWR_ROLE      BIT(8)
  88 #define PD_HEADER_REV_SHIFT     6
  89 #define PD_HEADER_REV_MASK      0x3
  90 #define PD_HEADER_DATA_ROLE     BIT(5)
  91 #define PD_HEADER_TYPE_SHIFT    0
  92 #define PD_HEADER_TYPE_MASK     0x1f
  93
  94 #define PD_HEADER(type, pwr, data, rev, id, cnt, ext_hdr)               \
  95         ((((type) & PD_HEADER_TYPE_MASK) << PD_HEADER_TYPE_SHIFT) |     \
  96          ((pwr) == TYPEC_SOURCE ? PD_HEADER_PWR_ROLE : 0) |             \
  97          ((data) == TYPEC_HOST ? PD_HEADER_DATA_ROLE : 0) |             \
  98          (rev << PD_HEADER_REV_SHIFT) |                                 \
  99          (((id) & PD_HEADER_ID_MASK) << PD_HEADER_ID_SHIFT) |           \
 100          (((cnt) & PD_HEADER_CNT_MASK) << PD_HEADER_CNT_SHIFT) |        \
 101          ((ext_hdr) ? PD_HEADER_EXT_HDR : 0))
 102
 103 #define PD_HEADER_LE(type, pwr, data, rev, id, cnt) \
 104         cpu_to_le16(PD_HEADER((type), (pwr), (data), (rev), (id), (cnt), (0)))
 105
 106 static inline unsigned int pd_header_cnt(u16 header)
 107 {
 108         return (header >> PD_HEADER_CNT_SHIFT) & PD_HEADER_CNT_MASK;
 109 }
 110
 111 static inline unsigned int pd_header_cnt_le(__le16 header)
 112 {
 113         return pd_header_cnt(le16_to_cpu(header));
 114 }
 115
 116 static inline unsigned int pd_header_type(u16 header)
 117 {
 118         return (header >> PD_HEADER_TYPE_SHIFT) & PD_HEADER_TYPE_MASK;
 119 }
 120
 121 static inline unsigned int pd_header_type_le(__le16 header)
 122 {
 123         return pd_header_type(le16_to_cpu(header));
 124 }
 125
 126 static inline unsigned int pd_header_msgid(u16 header)
 127 {
 128         return (header >> PD_HEADER_ID_SHIFT) & PD_HEADER_ID_MASK;
 129 }
 130
 131 static inline unsigned int pd_header_msgid_le(__le16 header)
 132 {
 133         return pd_header_msgid(le16_to_cpu(header));
 134 }
 135
 136 static inline unsigned int pd_header_rev(u16 header)
 137 {
 138         return (header >> PD_HEADER_REV_SHIFT) & PD_HEADER_REV_MASK;
 139 }
 140
 141 static inline unsigned int pd_header_rev_le(__le16 header)
 142 {
 143         return pd_header_rev(le16_to_cpu(header));
 144 }
 145
 146 #define PD_EXT_HDR_CHUNKED              BIT(15)
 147 #define PD_EXT_HDR_CHUNK_NUM_SHIFT      11
 148 #define PD_EXT_HDR_CHUNK_NUM_MASK       0xf
 149 #define PD_EXT_HDR_REQ_CHUNK            BIT(10)
 150 #define PD_EXT_HDR_DATA_SIZE_SHIFT      0
 151 #define PD_EXT_HDR_DATA_SIZE_MASK       0x1ff
 152
 153 #define PD_EXT_HDR(data_size, req_chunk, chunk_num, chunked)                            \
 154         ((((data_size) & PD_EXT_HDR_DATA_SIZE_MASK) << PD_EXT_HDR_DATA_SIZE_SHIFT) |    \
 155          ((req_chunk) ? PD_EXT_HDR_REQ_CHUNK : 0) |                                     \
 156          (((chunk_num) & PD_EXT_HDR_CHUNK_NUM_MASK) << PD_EXT_HDR_CHUNK_NUM_SHIFT) |    \
 157          ((chunked) ? PD_EXT_HDR_CHUNKED : 0))
 158
 159 #define PD_EXT_HDR_LE(data_size, req_chunk, chunk_num, chunked) \
 160         cpu_to_le16(PD_EXT_HDR((data_size), (req_chunk), (chunk_num), (chunked)))
 161
 162 static inline unsigned int pd_ext_header_chunk_num(u16 ext_header)
 163 {
 164         return (ext_header >> PD_EXT_HDR_CHUNK_NUM_SHIFT) &
 165                 PD_EXT_HDR_CHUNK_NUM_MASK;
 166 }
 167
 168 static inline unsigned int pd_ext_header_data_size(u16 ext_header)
 169 {
 170         return (ext_header >> PD_EXT_HDR_DATA_SIZE_SHIFT) &
 171                 PD_EXT_HDR_DATA_SIZE_MASK;
 172 }
 173
 174 static inline unsigned int pd_ext_header_data_size_le(__le16 ext_header)
 175 {
 176         return pd_ext_header_data_size(le16_to_cpu(ext_header));
 177 }
 178
 179 #define PD_MAX_PAYLOAD          7
 180 #define PD_EXT_MAX_CHUNK_DATA   26
 181
 182 /**
 183   * struct pd_chunked_ext_message_data - PD chunked extended message data as
 184   *                                      seen on wire
 185   * @header:    PD extended message header
 186   * @data:      PD extended message data
 187   */
 188 struct pd_chunked_ext_message_data {
 189         __le16 header;
 190         u8 data[PD_EXT_MAX_CHUNK_DATA];
 191 } __packed;
 192
 193 /**
 194   * struct pd_message - PD message as seen on wire
 195   * @header:    PD message header
 196   * @payload:   PD message payload
 197   * @ext_msg:   PD message chunked extended message data
 198   */
 199 struct pd_message {
 200         __le16 header;
 201         union {
 202                 __le32 payload[PD_MAX_PAYLOAD];
 203                 struct pd_chunked_ext_message_data ext_msg;
 204         };
 205 } __packed;
 206
 207 /* PDO: Power Data Object */
 208 #define PDO_MAX_OBJECTS         7
 209
 210 enum pd_pdo_type {
 211         PDO_TYPE_FIXED = 0,
 212         PDO_TYPE_BATT = 1,
 213         PDO_TYPE_VAR = 2,
 214         PDO_TYPE_APDO = 3,
 215 };
 216
 217 #define PDO_TYPE_SHIFT          30
 218 #define PDO_TYPE_MASK           0x3
 219
 220 #define PDO_TYPE(t)     ((t) << PDO_TYPE_SHIFT)
 221
 222 #define PDO_VOLT_MASK           0x3ff
 223 #define PDO_CURR_MASK           0x3ff
 224 #define PDO_PWR_MASK            0x3ff
 225
 226 #define PDO_FIXED_DUAL_ROLE             BIT(29) /* Power role swap supported */
 227 #define PDO_FIXED_SUSPEND               BIT(28) /* USB Suspend supported (Source) */
 228 #define PDO_FIXED_HIGHER_CAP            BIT(28) /* Requires more than vSafe5V (Sink) */
 229 #define PDO_FIXED_EXTPOWER              BIT(27) /* Externally powered */
 230 #define PDO_FIXED_USB_COMM              BIT(26) /* USB communications capable */
 231 #define PDO_FIXED_DATA_SWAP             BIT(25) /* Data role swap supported */
 232 #define PDO_FIXED_UNCHUNK_EXT           BIT(24) /* Unchunked Extended Message supported (Source) */
 233 #define PDO_FIXED_FRS_CURR_MASK         (BIT(24) | BIT(23)) /* FR_Swap Current (Sink) */
 234 #define PDO_FIXED_FRS_CURR_SHIFT        23
 235 #define PDO_FIXED_PEAK_CURR_SHIFT       20
 236 #define PDO_FIXED_VOLT_SHIFT            10      /* 50mV units */
 237 #define PDO_FIXED_CURR_SHIFT            0       /* 10mA units */
 238
 239 #define PDO_FIXED_VOLT(mv)      ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
 240 #define PDO_FIXED_CURR(ma)      ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
 241
 242 #define PDO_FIXED(mv, ma, flags)                        \
 243         (PDO_TYPE(PDO_TYPE_FIXED) | (flags) |           \
 244          PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
 245
 246 #define VSAFE5V 5000 /* mv units */
 247
 248 #define PDO_BATT_MAX_VOLT_SHIFT 20      /* 50mV units */
 249 #define PDO_BATT_MIN_VOLT_SHIFT 10      /* 50mV units */
 250 #define PDO_BATT_MAX_PWR_SHIFT  0       /* 250mW units */
 251
 252 #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
 253 #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
 254 #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
 255
 256 #define PDO_BATT(min_mv, max_mv, max_mw)                        \
 257         (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) |  \
 258          PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
 259
 260 #define PDO_VAR_MAX_VOLT_SHIFT  20      /* 50mV units */
 261 #define PDO_VAR_MIN_VOLT_SHIFT  10      /* 50mV units */
 262 #define PDO_VAR_MAX_CURR_SHIFT  0       /* 10mA units */
 263
 264 #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
 265 #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
 266 #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
 267
 268 #define PDO_VAR(min_mv, max_mv, max_ma)                         \
 269         (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) |    \
 270          PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
 271
 272 enum pd_apdo_type {
 273         APDO_TYPE_PPS = 0,
 274 };
 275
 276 #define PDO_APDO_TYPE_SHIFT     28      /* Only valid value currently is 0x0 - PPS */
 277 #define PDO_APDO_TYPE_MASK      0x3
 278
 279 #define PDO_APDO_TYPE(t)        ((t) << PDO_APDO_TYPE_SHIFT)
 280
 281 #define PDO_PPS_APDO_MAX_VOLT_SHIFT     17      /* 100mV units */
 282 #define PDO_PPS_APDO_MIN_VOLT_SHIFT     8       /* 100mV units */
 283 #define PDO_PPS_APDO_MAX_CURR_SHIFT     0       /* 50mA units */
 284
 285 #define PDO_PPS_APDO_VOLT_MASK  0xff
 286 #define PDO_PPS_APDO_CURR_MASK  0x7f
 287
 288 #define PDO_PPS_APDO_MIN_VOLT(mv)       \
 289         ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT)
 290 #define PDO_PPS_APDO_MAX_VOLT(mv)       \
 291         ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT)
 292 #define PDO_PPS_APDO_MAX_CURR(ma)       \
 293         ((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT)
 294
 295 #define PDO_PPS_APDO(min_mv, max_mv, max_ma)                            \
 296         (PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) |       \
 297         PDO_PPS_APDO_MIN_VOLT(min_mv) | PDO_PPS_APDO_MAX_VOLT(max_mv) | \
 298         PDO_PPS_APDO_MAX_CURR(max_ma))
 299
 300 static inline enum pd_pdo_type pdo_type(u32 pdo)
 301 {
 302         return (pdo >> PDO_TYPE_SHIFT) & PDO_TYPE_MASK;
 303 }
 304
 305 static inline unsigned int pdo_fixed_voltage(u32 pdo)
 306 {
 307         return ((pdo >> PDO_FIXED_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
 308 }
 309
 310 static inline unsigned int pdo_min_voltage(u32 pdo)
 311 {
 312         return ((pdo >> PDO_VAR_MIN_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
 313 }
 314
 315 static inline unsigned int pdo_max_voltage(u32 pdo)
 316 {
 317         return ((pdo >> PDO_VAR_MAX_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
 318 }
 319
 320 static inline unsigned int pdo_max_current(u32 pdo)
 321 {
 322         return ((pdo >> PDO_VAR_MAX_CURR_SHIFT) & PDO_CURR_MASK) * 10;
 323 }
 324
 325 static inline unsigned int pdo_max_power(u32 pdo)
 326 {
 327         return ((pdo >> PDO_BATT_MAX_PWR_SHIFT) & PDO_PWR_MASK) * 250;
 328 }
 329
 330 static inline enum pd_apdo_type pdo_apdo_type(u32 pdo)
 331 {
 332         return (pdo >> PDO_APDO_TYPE_SHIFT) & PDO_APDO_TYPE_MASK;
 333 }
 334
 335 static inline unsigned int pdo_pps_apdo_min_voltage(u32 pdo)
 336 {
 337         return ((pdo >> PDO_PPS_APDO_MIN_VOLT_SHIFT) &
 338                 PDO_PPS_APDO_VOLT_MASK) * 100;
 339 }
 340
 341 static inline unsigned int pdo_pps_apdo_max_voltage(u32 pdo)
 342 {
 343         return ((pdo >> PDO_PPS_APDO_MAX_VOLT_SHIFT) &
 344                 PDO_PPS_APDO_VOLT_MASK) * 100;
 345 }
 346
 347 static inline unsigned int pdo_pps_apdo_max_current(u32 pdo)
 348 {
 349         return ((pdo >> PDO_PPS_APDO_MAX_CURR_SHIFT) &
 350                 PDO_PPS_APDO_CURR_MASK) * 50;
 351 }
 352
 353 /* RDO: Request Data Object */
 354 #define RDO_OBJ_POS_SHIFT       28
 355 #define RDO_OBJ_POS_MASK        0x7
 356 #define RDO_GIVE_BACK           BIT(27) /* Supports reduced operating current */
 357 #define RDO_CAP_MISMATCH        BIT(26) /* Not satisfied by source caps */
 358 #define RDO_USB_COMM            BIT(25) /* USB communications capable */
 359 #define RDO_NO_SUSPEND          BIT(24) /* USB Suspend not supported */
 360
 361 #define RDO_PWR_MASK                    0x3ff
 362 #define RDO_CURR_MASK                   0x3ff
 363
 364 #define RDO_FIXED_OP_CURR_SHIFT         10
 365 #define RDO_FIXED_MAX_CURR_SHIFT        0
 366
 367 #define RDO_OBJ(idx) (((idx) & RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT)
 368
 369 #define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT)
 370 #define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT)
 371
 372 #define RDO_FIXED(idx, op_ma, max_ma, flags)                    \
 373         (RDO_OBJ(idx) | (flags) |                               \
 374          PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma))
 375
 376 #define RDO_BATT_OP_PWR_SHIFT           10      /* 250mW units */
 377 #define RDO_BATT_MAX_PWR_SHIFT          0       /* 250mW units */
 378
 379 #define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT)
 380 #define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT)
 381
 382 #define RDO_BATT(idx, op_mw, max_mw, flags)                     \
 383         (RDO_OBJ(idx) | (flags) |                               \
 384          RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw))
 385
 386 #define RDO_PROG_VOLT_MASK      0x7ff
 387 #define RDO_PROG_CURR_MASK      0x7f
 388
 389 #define RDO_PROG_VOLT_SHIFT     9
 390 #define RDO_PROG_CURR_SHIFT     0
 391
 392 #define RDO_PROG_VOLT_MV_STEP   20
 393 #define RDO_PROG_CURR_MA_STEP   50
 394
 395 #define PDO_PROG_OUT_VOLT(mv)   \
 396         ((((mv) / RDO_PROG_VOLT_MV_STEP) & RDO_PROG_VOLT_MASK) << RDO_PROG_VOLT_SHIFT)
 397 #define PDO_PROG_OP_CURR(ma)    \
 398         ((((ma) / RDO_PROG_CURR_MA_STEP) & RDO_PROG_CURR_MASK) << RDO_PROG_CURR_SHIFT)
 399
 400 #define RDO_PROG(idx, out_mv, op_ma, flags)                     \
 401         (RDO_OBJ(idx) | (flags) |                               \
 402          PDO_PROG_OUT_VOLT(out_mv) | PDO_PROG_OP_CURR(op_ma))
 403
 404 static inline unsigned int rdo_index(u32 rdo)
 405 {
 406         return (rdo >> RDO_OBJ_POS_SHIFT) & RDO_OBJ_POS_MASK;
 407 }
 408
 409 static inline unsigned int rdo_op_current(u32 rdo)
 410 {
 411         return ((rdo >> RDO_FIXED_OP_CURR_SHIFT) & RDO_CURR_MASK) * 10;
 412 }
 413
 414 static inline unsigned int rdo_max_current(u32 rdo)
 415 {
 416         return ((rdo >> RDO_FIXED_MAX_CURR_SHIFT) &
 417                 RDO_CURR_MASK) * 10;
 418 }
 419
 420 static inline unsigned int rdo_op_power(u32 rdo)
 421 {
 422         return ((rdo >> RDO_BATT_OP_PWR_SHIFT) & RDO_PWR_MASK) * 250;
 423 }
 424
 425 static inline unsigned int rdo_max_power(u32 rdo)
 426 {
 427         return ((rdo >> RDO_BATT_MAX_PWR_SHIFT) & RDO_PWR_MASK) * 250;
 428 }
 429
 430 /* Enter_USB Data Object */
 431 #define EUDO_USB_MODE_MASK              GENMASK(30, 28)
 432 #define EUDO_USB_MODE_SHIFT             28
 433 #define   EUDO_USB_MODE_USB2            0
 434 #define   EUDO_USB_MODE_USB3            1
 435 #define   EUDO_USB_MODE_USB4            2
 436 #define EUDO_USB4_DRD                   BIT(26)
 437 #define EUDO_USB3_DRD                   BIT(25)
 438 #define EUDO_CABLE_SPEED_MASK           GENMASK(23, 21)
 439 #define EUDO_CABLE_SPEED_SHIFT          21
 440 #define   EUDO_CABLE_SPEED_USB2         0
 441 #define   EUDO_CABLE_SPEED_USB3_GEN1    1
 442 #define   EUDO_CABLE_SPEED_USB4_GEN2    2
 443 #define   EUDO_CABLE_SPEED_USB4_GEN3    3
 444 #define EUDO_CABLE_TYPE_MASK            GENMASK(20, 19)
 445 #define EUDO_CABLE_TYPE_SHIFT           19
 446 #define   EUDO_CABLE_TYPE_PASSIVE       0
 447 #define   EUDO_CABLE_TYPE_RE_TIMER      1
 448 #define   EUDO_CABLE_TYPE_RE_DRIVER     2
 449 #define   EUDO_CABLE_TYPE_OPTICAL       3
 450 #define EUDO_CABLE_CURRENT_MASK         GENMASK(18, 17)
 451 #define EUDO_CABLE_CURRENT_SHIFT        17
 452 #define   EUDO_CABLE_CURRENT_NOTSUPP    0
 453 #define   EUDO_CABLE_CURRENT_3A         2
 454 #define   EUDO_CABLE_CURRENT_5A         3
 455 #define EUDO_PCIE_SUPPORT               BIT(16)
 456 #define EUDO_DP_SUPPORT                 BIT(15)
 457 #define EUDO_TBT_SUPPORT                BIT(14)
 458 #define EUDO_HOST_PRESENT               BIT(13)
 459
 460 /*
 461  * Request Message Data Object (PD Revision 3.1+ only)
 462  * --------
 463  * <31:28> :: Revision Major
 464  * <27:24> :: Revision Minor
 465  * <23:20> :: Version Major
 466  * <19:16> :: Version Minor
 467  * <15:0>  :: Reserved, Shall be set to zero
 468  */
 469
 470 #define RMDO(rev_maj, rev_min, ver_maj, ver_min)                        \
 471         (((rev_maj) & 0xf) << 28 | ((rev_min) & 0xf) << 24 |            \
 472          ((ver_maj) & 0xf) << 20 | ((ver_min) & 0xf) << 16)
 473
 474 /* USB PD timers and counters */
 475 #define PD_T_NO_RESPONSE        5000    /* 4.5 - 5.5 seconds */
 476 #define PD_T_DB_DETECT          10000   /* 10 - 15 seconds */
 477 #define PD_T_SEND_SOURCE_CAP    150     /* 100 - 200 ms */
 478 #define PD_T_SENDER_RESPONSE    60      /* 24 - 30 ms, relaxed */
 479 #define PD_T_RECEIVER_RESPONSE  15      /* 15ms max */
 480 #define PD_T_SOURCE_ACTIVITY    45
 481 #define PD_T_SINK_ACTIVITY      135
 482 #define PD_T_SINK_WAIT_CAP      310     /* 310 - 620 ms */
 483 #define PD_T_PS_TRANSITION      500
 484 #define PD_T_SRC_TRANSITION     35
 485 #define PD_T_DRP_SNK            40
 486 #define PD_T_DRP_SRC            30
 487 #define PD_T_PS_SOURCE_OFF      920
 488 #define PD_T_PS_SOURCE_ON       480
 489 #define PD_T_PS_SOURCE_ON_PRS   450     /* 390 - 480ms */
 490 #define PD_T_PS_HARD_RESET      30
 491 #define PD_T_SRC_RECOVER        760
 492 #define PD_T_SRC_RECOVER_MAX    1000
 493 #define PD_T_SRC_TURN_ON        275
 494 #define PD_T_SAFE_0V            650
 495 #define PD_T_VCONN_SOURCE_ON    100
 496 #define PD_T_SINK_REQUEST       100     /* 100 ms minimum */
 497 #define PD_T_ERROR_RECOVERY     100     /* minimum 25 is insufficient */
 498 #define PD_T_SRCSWAPSTDBY       625     /* Maximum of 650ms */
 499 #define PD_T_NEWSRC             250     /* Maximum of 275ms */
 500 #define PD_T_SWAP_SRC_START     20      /* Minimum of 20ms */
 501 #define PD_T_BIST_CONT_MODE     50      /* 30 - 60 ms */
 502 #define PD_T_SINK_TX            16      /* 16 - 20 ms */
 503 #define PD_T_CHUNK_NOT_SUPP     42      /* 40 - 50 ms */
 504 #define PD_T_VCONN_STABLE       50
 505
 506 #define PD_T_DRP_TRY            100     /* 75 - 150 ms */
 507 #define PD_T_DRP_TRYWAIT        600     /* 400 - 800 ms */
 508
 509 #define PD_T_CC_DEBOUNCE        200     /* 100 - 200 ms */
 510 #define PD_T_PD_DEBOUNCE        20      /* 10 - 20 ms */
 511 #define PD_T_TRY_CC_DEBOUNCE    15      /* 10 - 20 ms */
 512
 513 #define PD_N_CAPS_COUNT         (PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP)
 514 #define PD_N_HARD_RESET_COUNT   2
 515
 516 #define PD_P_SNK_STDBY_MW       2500    /* 2500 mW */
 517
 518 #if IS_ENABLED(CONFIG_TYPEC)
 519
 520 struct usb_power_delivery;
 521
 522 /**
 523  * usb_power_delivery_desc - USB Power Delivery Descriptor
 524  * @revision: USB Power Delivery Specification Revision
 525  * @version: USB Power Delivery Specicication Version - optional
 526  */
 527 struct usb_power_delivery_desc {
 528         u16 revision;
 529         u16 version;
 530 };
 531
 532 /**
 533  * usb_power_delivery_capabilities_desc - Description of USB Power Delivery Capabilities Message
 534  * @pdo: The Power Data Objects in the Capability Message
 535  * @role: Power role of the capabilities
 536  */
 537 struct usb_power_delivery_capabilities_desc {
 538         u32 pdo[PDO_MAX_OBJECTS];
 539         enum typec_role role;
 540 };
 541
 542 struct usb_power_delivery_capabilities *
 543 usb_power_delivery_register_capabilities(struct usb_power_delivery *pd,
 544                                          struct usb_power_delivery_capabilities_desc *desc);
 545 void usb_power_delivery_unregister_capabilities(struct usb_power_delivery_capabilities *cap);
 546
 547 struct usb_power_delivery *usb_power_delivery_register(struct device *parent,
 548                                                        struct usb_power_delivery_desc *desc);
 549 void usb_power_delivery_unregister(struct usb_power_delivery *pd);
 550
 551 int usb_power_delivery_link_device(struct usb_power_delivery *pd, struct device *dev);
 552 void usb_power_delivery_unlink_device(struct usb_power_delivery *pd, struct device *dev);
 553
 554 #endif /* CONFIG_TYPEC */
 555
 556 #endif /* __LINUX_USB_PD_H */