include/dt-bindings/usb/pd.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __DT_POWER_DELIVERY_H
   3 #define __DT_POWER_DELIVERY_H
   4
   5 /* Power delivery Power Data Object definitions */
   6 #define PDO_TYPE_FIXED          0
   7 #define PDO_TYPE_BATT           1
   8 #define PDO_TYPE_VAR            2
   9 #define PDO_TYPE_APDO           3
  10
  11 #define PDO_TYPE_SHIFT          30
  12 #define PDO_TYPE_MASK           0x3
  13
  14 #define PDO_TYPE(t)     ((t) << PDO_TYPE_SHIFT)
  15
  16 #define PDO_VOLT_MASK           0x3ff
  17 #define PDO_CURR_MASK           0x3ff
  18 #define PDO_PWR_MASK            0x3ff
  19
  20 #define PDO_FIXED_DUAL_ROLE     (1 << 29) /* Power role swap supported */
  21 #define PDO_FIXED_SUSPEND       (1 << 28) /* USB Suspend supported (Source) */
  22 #define PDO_FIXED_HIGHER_CAP    (1 << 28) /* Requires more than vSafe5V (Sink) */
  23 #define PDO_FIXED_EXTPOWER      (1 << 27) /* Externally powered */
  24 #define PDO_FIXED_USB_COMM      (1 << 26) /* USB communications capable */
  25 #define PDO_FIXED_DATA_SWAP     (1 << 25) /* Data role swap supported */
  26 #define PDO_FIXED_VOLT_SHIFT    10      /* 50mV units */
  27 #define PDO_FIXED_CURR_SHIFT    0       /* 10mA units */
  28
  29 #define PDO_FIXED_VOLT(mv)      ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
  30 #define PDO_FIXED_CURR(ma)      ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
  31
  32 #define PDO_FIXED(mv, ma, flags)                        \
  33         (PDO_TYPE(PDO_TYPE_FIXED) | (flags) |           \
  34          PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
  35
  36 #define VSAFE5V 5000 /* mv units */
  37
  38 #define PDO_BATT_MAX_VOLT_SHIFT 20      /* 50mV units */
  39 #define PDO_BATT_MIN_VOLT_SHIFT 10      /* 50mV units */
  40 #define PDO_BATT_MAX_PWR_SHIFT  0       /* 250mW units */
  41
  42 #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
  43 #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
  44 #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
  45
  46 #define PDO_BATT(min_mv, max_mv, max_mw)                        \
  47         (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) |  \
  48          PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
  49
  50 #define PDO_VAR_MAX_VOLT_SHIFT  20      /* 50mV units */
  51 #define PDO_VAR_MIN_VOLT_SHIFT  10      /* 50mV units */
  52 #define PDO_VAR_MAX_CURR_SHIFT  0       /* 10mA units */
  53
  54 #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
  55 #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
  56 #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
  57
  58 #define PDO_VAR(min_mv, max_mv, max_ma)                         \
  59         (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) |    \
  60          PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
  61
  62 #define APDO_TYPE_PPS           0
  63
  64 #define PDO_APDO_TYPE_SHIFT     28      /* Only valid value currently is 0x0 - PPS */
  65 #define PDO_APDO_TYPE_MASK      0x3
  66
  67 #define PDO_APDO_TYPE(t)        ((t) << PDO_APDO_TYPE_SHIFT)
  68
  69 #define PDO_PPS_APDO_MAX_VOLT_SHIFT     17      /* 100mV units */
  70 #define PDO_PPS_APDO_MIN_VOLT_SHIFT     8       /* 100mV units */
  71 #define PDO_PPS_APDO_MAX_CURR_SHIFT     0       /* 50mA units */
  72
  73 #define PDO_PPS_APDO_VOLT_MASK  0xff
  74 #define PDO_PPS_APDO_CURR_MASK  0x7f
  75
  76 #define PDO_PPS_APDO_MIN_VOLT(mv)       \
  77         ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT)
  78 #define PDO_PPS_APDO_MAX_VOLT(mv)       \
  79         ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT)
  80 #define PDO_PPS_APDO_MAX_CURR(ma)       \
  81         ((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT)
  82
  83 #define PDO_PPS_APDO(min_mv, max_mv, max_ma)                                    \
  84         (PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) |               \
  85          PDO_PPS_APDO_MIN_VOLT(min_mv) | PDO_PPS_APDO_MAX_VOLT(max_mv) |        \
  86          PDO_PPS_APDO_MAX_CURR(max_ma))
  87
  88  /*
  89   * Based on "Table 6-14 Fixed Supply PDO - Sink" of "USB Power Delivery Specification Revision 3.0,
  90   * Version 1.2"
  91   * Initial current capability of the new source when vSafe5V is applied.
  92   */
  93 #define FRS_DEFAULT_POWER      1
  94 #define FRS_5V_1P5A            2
  95 #define FRS_5V_3A              3
  96
  97 /*
  98  * SVDM Identity Header
  99  * --------------------
 100  * <31>     :: data capable as a USB host
 101  * <30>     :: data capable as a USB device
 102  * <29:27>  :: product type (UFP / Cable / VPD)
 103  * <26>     :: modal operation supported (1b == yes)
 104  * <25:23>  :: product type (DFP) (SVDM version 2.0+ only; set to zero in version 1.0)
 105  * <22:21>  :: connector type (SVDM version 2.0+ only; set to zero in version 1.0)
 106  * <20:16>  :: Reserved, Shall be set to zero
 107  * <15:0>   :: USB-IF assigned VID for this cable vendor
 108  */
 109 /* SOP Product Type (UFP) */
 110 #define IDH_PTYPE_NOT_UFP       0
 111 #define IDH_PTYPE_HUB           1
 112 #define IDH_PTYPE_PERIPH        2
 113 #define IDH_PTYPE_PSD           3
 114 #define IDH_PTYPE_AMA           5
 115
 116 /* SOP' Product Type (Cable Plug / VPD) */
 117 #define IDH_PTYPE_NOT_CABLE     0
 118 #define IDH_PTYPE_PCABLE        3
 119 #define IDH_PTYPE_ACABLE        4
 120 #define IDH_PTYPE_VPD           6
 121
 122 /* SOP Product Type (DFP) */
 123 #define IDH_PTYPE_NOT_DFP       0
 124 #define IDH_PTYPE_DFP_HUB       1
 125 #define IDH_PTYPE_DFP_HOST      2
 126 #define IDH_PTYPE_DFP_PB        3
 127
 128 #define VDO_IDH(usbh, usbd, ufp_cable, is_modal, dfp, conn, vid)                \
 129         ((usbh) << 31 | (usbd) << 30 | ((ufp_cable) & 0x7) << 27                \
 130          | (is_modal) << 26 | ((dfp) & 0x7) << 23 | ((conn) & 0x3) << 21        \
 131          | ((vid) & 0xffff))
 132
 133 /*
 134  * Cert Stat VDO
 135  * -------------
 136  * <31:0>  : USB-IF assigned XID for this cable
 137  */
 138 #define VDO_CERT(xid)           ((xid) & 0xffffffff)
 139
 140 /*
 141  * Product VDO
 142  * -----------
 143  * <31:16> : USB Product ID
 144  * <15:0>  : USB bcdDevice
 145  */
 146 #define VDO_PRODUCT(pid, bcd)   (((pid) & 0xffff) << 16 | ((bcd) & 0xffff))
 147
 148 /*
 149  * UFP VDO (PD Revision 3.0+ only)
 150  * --------
 151  * <31:29> :: UFP VDO version
 152  * <28>    :: Reserved
 153  * <27:24> :: Device capability
 154  * <23:22> :: Connector type (10b == receptacle, 11b == captive plug)
 155  * <21:11> :: Reserved
 156  * <10:8>  :: Vconn power (AMA only)
 157  * <7>     :: Vconn required (AMA only, 0b == no, 1b == yes)
 158  * <6>     :: Vbus required (AMA only, 0b == yes, 1b == no)
 159  * <5:3>   :: Alternate modes
 160  * <2:0>   :: USB highest speed
 161  */
 162 /* UFP VDO Version */
 163 #define UFP_VDO_VER1_2          2
 164
 165 /* Device Capability */
 166 #define DEV_USB2_CAPABLE        BIT(0)
 167 #define DEV_USB2_BILLBOARD      BIT(1)
 168 #define DEV_USB3_CAPABLE        BIT(2)
 169 #define DEV_USB4_CAPABLE        BIT(3)
 170
 171 /* Connector Type */
 172 #define UFP_RECEPTACLE          2
 173 #define UFP_CAPTIVE             3
 174
 175 /* Vconn Power (AMA only, set to AMA_VCONN_NOT_REQ if Vconn is not required) */
 176 #define AMA_VCONN_PWR_1W        0
 177 #define AMA_VCONN_PWR_1W5       1
 178 #define AMA_VCONN_PWR_2W        2
 179 #define AMA_VCONN_PWR_3W        3
 180 #define AMA_VCONN_PWR_4W        4
 181 #define AMA_VCONN_PWR_5W        5
 182 #define AMA_VCONN_PWR_6W        6
 183
 184 /* Vconn Required (AMA only) */
 185 #define AMA_VCONN_NOT_REQ       0
 186 #define AMA_VCONN_REQ           1
 187
 188 /* Vbus Required (AMA only) */
 189 #define AMA_VBUS_REQ            0
 190 #define AMA_VBUS_NOT_REQ        1
 191
 192 /* Alternate Modes */
 193 #define UFP_ALTMODE_NOT_SUPP    0
 194 #define UFP_ALTMODE_TBT3        BIT(0)
 195 #define UFP_ALTMODE_RECFG       BIT(1)
 196 #define UFP_ALTMODE_NO_RECFG    BIT(2)
 197
 198 /* USB Highest Speed */
 199 #define UFP_USB2_ONLY           0
 200 #define UFP_USB32_GEN1          1
 201 #define UFP_USB32_4_GEN2        2
 202 #define UFP_USB4_GEN3           3
 203
 204 #define VDO_UFP(ver, cap, conn, vcpwr, vcr, vbr, alt, spd)                      \
 205         (((ver) & 0x7) << 29 | ((cap) & 0xf) << 24 | ((conn) & 0x3) << 22       \
 206          | ((vcpwr) & 0x7) << 8 | (vcr) << 7 | (vbr) << 6 | ((alt) & 0x7) << 3  \
 207          | ((spd) & 0x7))
 208
 209 /*
 210  * DFP VDO (PD Revision 3.0+ only)
 211  * --------
 212  * <31:29> :: DFP VDO version
 213  * <28:27> :: Reserved
 214  * <26:24> :: Host capability
 215  * <23:22> :: Connector type (10b == receptacle, 11b == captive plug)
 216  * <21:5>  :: Reserved
 217  * <4:0>   :: Port number
 218  */
 219 #define DFP_VDO_VER1_1          1
 220 #define HOST_USB2_CAPABLE       BIT(0)
 221 #define HOST_USB3_CAPABLE       BIT(1)
 222 #define HOST_USB4_CAPABLE       BIT(2)
 223 #define DFP_RECEPTACLE          2
 224 #define DFP_CAPTIVE             3
 225
 226 #define VDO_DFP(ver, cap, conn, pnum)                                           \
 227         (((ver) & 0x7) << 29 | ((cap) & 0x7) << 24 | ((conn) & 0x3) << 22       \
 228          | ((pnum) & 0x1f))
 229
 230 /*
 231  * Passive Cable VDO
 232  * ---------
 233  * <31:28> :: Cable HW version
 234  * <27:24> :: Cable FW version
 235  * <23:21> :: VDO version
 236  * <20>    :: Reserved, Shall be set to zero
 237  * <19:18> :: Type-C to Type-C/Captive (10b == C, 11b == Captive)
 238  * <17>    :: Reserved, Shall be set to zero
 239  * <16:13> :: cable latency (0001 == <10ns(~1m length))
 240  * <12:11> :: cable termination type (10b == Vconn not req, 01b == Vconn req)
 241  * <10:9>  :: Maximum Vbus voltage (00b == 20V, 01b == 30V, 10b == 40V, 11b == 50V)
 242  * <8:7>   :: Reserved, Shall be set to zero
 243  * <6:5>   :: Vbus current handling capability (01b == 3A, 10b == 5A)
 244  * <4:3>   :: Reserved, Shall be set to zero
 245  * <2:0>   :: USB highest speed
 246  *
 247  * Active Cable VDO 1
 248  * ---------
 249  * <31:28> :: Cable HW version
 250  * <27:24> :: Cable FW version
 251  * <23:21> :: VDO version
 252  * <20>    :: Reserved, Shall be set to zero
 253  * <19:18> :: Connector type (10b == C, 11b == Captive)
 254  * <17>    :: Reserved, Shall be set to zero
 255  * <16:13> :: cable latency (0001 == <10ns(~1m length))
 256  * <12:11> :: cable termination type (10b == one end active, 11b == both ends active VCONN req)
 257  * <10:9>  :: Maximum Vbus voltage (00b == 20V, 01b == 30V, 10b == 40V, 11b == 50V)
 258  * <8>     :: SBU supported (0b == supported, 1b == not supported)
 259  * <7>     :: SBU type (0b == passive, 1b == active)
 260  * <6:5>   :: Vbus current handling capability (01b == 3A, 10b == 5A)
 261  * <4>     :: Vbus through cable (0b == no, 1b == yes)
 262  * <3>     :: SOP" controller present? (0b == no, 1b == yes)
 263  * <2:0>   :: USB highest speed
 264  */
 265 /* Cable VDO Version */
 266 #define CABLE_VDO_VER1_0        0
 267 #define CABLE_VDO_VER1_3        3
 268
 269 /* Connector Type */
 270 #define CABLE_CTYPE             2
 271 #define CABLE_CAPTIVE           3
 272
 273 /* Cable Latency */
 274 #define CABLE_LATENCY_1M        1
 275 #define CABLE_LATENCY_2M        2
 276 #define CABLE_LATENCY_3M        3
 277 #define CABLE_LATENCY_4M        4
 278 #define CABLE_LATENCY_5M        5
 279 #define CABLE_LATENCY_6M        6
 280 #define CABLE_LATENCY_7M        7
 281 #define CABLE_LATENCY_7M_PLUS   8
 282
 283 /* Cable Termination Type */
 284 #define PCABLE_VCONN_NOT_REQ    0
 285 #define PCABLE_VCONN_REQ        1
 286 #define ACABLE_ONE_END          2
 287 #define ACABLE_BOTH_END         3
 288
 289 /* Maximum Vbus Voltage */
 290 #define CABLE_MAX_VBUS_20V      0
 291 #define CABLE_MAX_VBUS_30V      1
 292 #define CABLE_MAX_VBUS_40V      2
 293 #define CABLE_MAX_VBUS_50V      3
 294
 295 /* Active Cable SBU Supported/Type */
 296 #define ACABLE_SBU_SUPP         0
 297 #define ACABLE_SBU_NOT_SUPP     1
 298 #define ACABLE_SBU_PASSIVE      0
 299 #define ACABLE_SBU_ACTIVE       1
 300
 301 /* Vbus Current Handling Capability */
 302 #define CABLE_CURR_DEF          0
 303 #define CABLE_CURR_3A           1
 304 #define CABLE_CURR_5A           2
 305
 306 /* USB Highest Speed */
 307 #define CABLE_USB2_ONLY         0
 308 #define CABLE_USB32_GEN1        1
 309 #define CABLE_USB32_4_GEN2      2
 310 #define CABLE_USB4_GEN3         3
 311
 312 #define VDO_PCABLE(hw, fw, ver, conn, lat, term, vbm, cur, spd)                 \
 313         (((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21          \
 314          | ((conn) & 0x3) << 18 | ((lat) & 0xf) << 13 | ((term) & 0x3) << 11    \
 315          | ((vbm) & 0x3) << 9 | ((cur) & 0x3) << 5 | ((spd) & 0x7))
 316 #define VDO_ACABLE1(hw, fw, ver, conn, lat, term, vbm, sbu, sbut, cur, vbt, sopp, spd) \
 317         (((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21          \
 318          | ((conn) & 0x3) << 18 | ((lat) & 0xf) << 13 | ((term) & 0x3) << 11    \
 319          | ((vbm) & 0x3) << 9 | (sbu) << 8 | (sbut) << 7 | ((cur) & 0x3) << 5   \
 320          | (vbt) << 4 | (sopp) << 3 | ((spd) & 0x7))
 321
 322 /*
 323  * Active Cable VDO 2
 324  * ---------
 325  * <31:24> :: Maximum operating temperature
 326  * <23:16> :: Shutdown temperature
 327  * <15>    :: Reserved, Shall be set to zero
 328  * <14:12> :: U3/CLd power
 329  * <11>    :: U3 to U0 transition mode (0b == direct, 1b == through U3S)
 330  * <10>    :: Physical connection (0b == copper, 1b == optical)
 331  * <9>     :: Active element (0b == redriver, 1b == retimer)
 332  * <8>     :: USB4 supported (0b == yes, 1b == no)
 333  * <7:6>   :: USB2 hub hops consumed
 334  * <5>     :: USB2 supported (0b == yes, 1b == no)
 335  * <4>     :: USB3.2 supported (0b == yes, 1b == no)
 336  * <3>     :: USB lanes supported (0b == one lane, 1b == two lanes)
 337  * <2>     :: Optically isolated active cable (0b == no, 1b == yes)
 338  * <1>     :: Reserved, Shall be set to zero
 339  * <0>     :: USB gen (0b == gen1, 1b == gen2+)
 340  */
 341 /* U3/CLd Power*/
 342 #define ACAB2_U3_CLD_10MW_PLUS  0
 343 #define ACAB2_U3_CLD_10MW       1
 344 #define ACAB2_U3_CLD_5MW        2
 345 #define ACAB2_U3_CLD_1MW        3
 346 #define ACAB2_U3_CLD_500UW      4
 347 #define ACAB2_U3_CLD_200UW      5
 348 #define ACAB2_U3_CLD_50UW       6
 349
 350 /* Other Active Cable VDO 2 Fields */
 351 #define ACAB2_U3U0_DIRECT       0
 352 #define ACAB2_U3U0_U3S          1
 353 #define ACAB2_PHY_COPPER        0
 354 #define ACAB2_PHY_OPTICAL       1
 355 #define ACAB2_REDRIVER          0
 356 #define ACAB2_RETIMER           1
 357 #define ACAB2_USB4_SUPP         0
 358 #define ACAB2_USB4_NOT_SUPP     1
 359 #define ACAB2_USB2_SUPP         0
 360 #define ACAB2_USB2_NOT_SUPP     1
 361 #define ACAB2_USB32_SUPP        0
 362 #define ACAB2_USB32_NOT_SUPP    1
 363 #define ACAB2_LANES_ONE         0
 364 #define ACAB2_LANES_TWO         1
 365 #define ACAB2_OPT_ISO_NO        0
 366 #define ACAB2_OPT_ISO_YES       1
 367 #define ACAB2_GEN_1             0
 368 #define ACAB2_GEN_2_PLUS        1
 369
 370 #define VDO_ACABLE2(mtemp, stemp, u3p, trans, phy, ele, u4, hops, u2, u32, lane, iso, gen)      \
 371         (((mtemp) & 0xff) << 24 | ((stemp) & 0xff) << 16 | ((u3p) & 0x7) << 12  \
 372          | (trans) << 11 | (phy) << 10 | (ele) << 9 | (u4) << 8                 \
 373          | ((hops) & 0x3) << 6 | (u2) << 5 | (u32) << 4 | (lane) << 3           \
 374          | (iso) << 2 | (gen))
 375
 376 /*
 377  * VPD VDO
 378  * ---------
 379  * <31:28> :: HW version
 380  * <27:24> :: FW version
 381  * <23:21> :: VDO version
 382  * <20:17> :: Reserved, Shall be set to zero
 383  * <16:15> :: Maximum Vbus voltage (00b == 20V, 01b == 30V, 10b == 40V, 11b == 50V)
 384  * <14>    :: Charge through current support (0b == 3A, 1b == 5A)
 385  * <13>    :: Reserved, Shall be set to zero
 386  * <12:7>  :: Vbus impedance
 387  * <6:1>   :: Ground impedance
 388  * <0>     :: Charge through support (0b == no, 1b == yes)
 389  */
 390 #define VPD_VDO_VER1_0          0
 391 #define VPD_MAX_VBUS_20V        0
 392 #define VPD_MAX_VBUS_30V        1
 393 #define VPD_MAX_VBUS_40V        2
 394 #define VPD_MAX_VBUS_50V        3
 395 #define VPDCT_CURR_3A           0
 396 #define VPDCT_CURR_5A           1
 397 #define VPDCT_NOT_SUPP          0
 398 #define VPDCT_SUPP              1
 399
 400 #define VDO_VPD(hw, fw, ver, vbm, curr, vbi, gi, ct)                    \
 401         (((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21  \
 402          | ((vbm) & 0x3) << 15 | (curr) << 14 | ((vbi) & 0x3f) << 7     \
 403          | ((gi) & 0x3f) << 1 | (ct))
 404
 405 #endif /* __DT_POWER_DELIVERY_H */