| 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
|---|
| 2 | /* |
|---|
| 3 | * Copyright 2015-2017 Google, Inc |
|---|
| 4 | */ |
|---|
| 5 | |
|---|
| 6 | #ifndef __LINUX_USB_PD_VDO_H |
|---|
| 7 | #define __LINUX_USB_PD_VDO_H |
|---|
| 8 | |
|---|
| 9 | #include "pd.h" |
|---|
| 10 | #include <linux/bitfield.h> |
|---|
| 11 | |
|---|
| 12 | /* |
|---|
| 13 | * VDO : Vendor Defined Message Object |
|---|
| 14 | * VDM object is minimum of VDM header + 6 additional data objects. |
|---|
| 15 | */ |
|---|
| 16 | |
|---|
| 17 | #define VDO_MAX_OBJECTS 6 |
|---|
| 18 | #define VDO_MAX_SIZE (VDO_MAX_OBJECTS + 1) |
|---|
| 19 | |
|---|
| 20 | /* |
|---|
| 21 | * VDM header |
|---|
| 22 | * ---------- |
|---|
| 23 | * <31:16> :: SVID |
|---|
| 24 | * <15> :: VDM type ( 1b == structured, 0b == unstructured ) |
|---|
| 25 | * <14:13> :: Structured VDM version |
|---|
| 26 | * <12:11> :: reserved |
|---|
| 27 | * <10:8> :: object position (1-7 valid ... used for enter/exit mode only) |
|---|
| 28 | * <7:6> :: command type (SVDM only?) |
|---|
| 29 | * <5> :: reserved (SVDM), command type (UVDM) |
|---|
| 30 | * <4:0> :: command |
|---|
| 31 | */ |
|---|
| 32 | #define VDO(vid, type, ver, custom) \ |
|---|
| 33 | (((vid) << 16) | \ |
|---|
| 34 | ((type) << 15) | \ |
|---|
| 35 | ((ver) << 13) | \ |
|---|
| 36 | ((custom) & 0x7FFF)) |
|---|
| 37 | |
|---|
| 38 | #define VDO_SVDM_TYPE (1 << 15) |
|---|
| 39 | #define VDO_SVDM_VERS(x) ((x) << 13) |
|---|
| 40 | #define VDO_OPOS(x) ((x) << 8) |
|---|
| 41 | #define VDO_CMDT(x) ((x) << 6) |
|---|
| 42 | #define VDO_SVDM_VERS_MASK VDO_SVDM_VERS(0x3) |
|---|
| 43 | #define VDO_OPOS_MASK VDO_OPOS(0x7) |
|---|
| 44 | #define VDO_CMDT_MASK VDO_CMDT(0x3) |
|---|
| 45 | |
|---|
| 46 | #define CMDT_INIT 0 |
|---|
| 47 | #define CMDT_RSP_ACK 1 |
|---|
| 48 | #define CMDT_RSP_NAK 2 |
|---|
| 49 | #define CMDT_RSP_BUSY 3 |
|---|
| 50 | |
|---|
| 51 | /* reserved for SVDM ... for Google UVDM */ |
|---|
| 52 | #define VDO_SRC_INITIATOR (0 << 5) |
|---|
| 53 | #define VDO_SRC_RESPONDER (1 << 5) |
|---|
| 54 | |
|---|
| 55 | #define CMD_DISCOVER_IDENT 1 |
|---|
| 56 | #define CMD_DISCOVER_SVID 2 |
|---|
| 57 | #define CMD_DISCOVER_MODES 3 |
|---|
| 58 | #define CMD_ENTER_MODE 4 |
|---|
| 59 | #define CMD_EXIT_MODE 5 |
|---|
| 60 | #define CMD_ATTENTION 6 |
|---|
| 61 | |
|---|
| 62 | #define VDO_CMD_VENDOR(x) (((0x10 + (x)) & 0x1f)) |
|---|
| 63 | |
|---|
| 64 | /* ChromeOS specific commands */ |
|---|
| 65 | #define VDO_CMD_VERSION VDO_CMD_VENDOR(0) |
|---|
| 66 | #define VDO_CMD_SEND_INFO VDO_CMD_VENDOR(1) |
|---|
| 67 | #define VDO_CMD_READ_INFO VDO_CMD_VENDOR(2) |
|---|
| 68 | #define VDO_CMD_REBOOT VDO_CMD_VENDOR(5) |
|---|
| 69 | #define VDO_CMD_FLASH_ERASE VDO_CMD_VENDOR(6) |
|---|
| 70 | #define VDO_CMD_FLASH_WRITE VDO_CMD_VENDOR(7) |
|---|
| 71 | #define VDO_CMD_ERASE_SIG VDO_CMD_VENDOR(8) |
|---|
| 72 | #define VDO_CMD_PING_ENABLE VDO_CMD_VENDOR(10) |
|---|
| 73 | #define VDO_CMD_CURRENT VDO_CMD_VENDOR(11) |
|---|
| 74 | #define VDO_CMD_FLIP VDO_CMD_VENDOR(12) |
|---|
| 75 | #define VDO_CMD_GET_LOG VDO_CMD_VENDOR(13) |
|---|
| 76 | #define VDO_CMD_CCD_EN VDO_CMD_VENDOR(14) |
|---|
| 77 | |
|---|
| 78 | #define PD_VDO_VID(vdo) ((vdo) >> 16) |
|---|
| 79 | #define PD_VDO_SVDM(vdo) (((vdo) >> 15) & 1) |
|---|
| 80 | #define PD_VDO_SVDM_VER(vdo) (((vdo) >> 13) & 0x3) |
|---|
| 81 | #define PD_VDO_OPOS(vdo) (((vdo) >> 8) & 0x7) |
|---|
| 82 | #define PD_VDO_CMD(vdo) ((vdo) & 0x1f) |
|---|
| 83 | #define PD_VDO_CMDT(vdo) (((vdo) >> 6) & 0x3) |
|---|
| 84 | |
|---|
| 85 | /* |
|---|
| 86 | * SVDM Identity request -> response |
|---|
| 87 | * |
|---|
| 88 | * Request is simply properly formatted SVDM header |
|---|
| 89 | * |
|---|
| 90 | * Response is 4 data objects for Power Delivery 2.0 and Passive Cables for |
|---|
| 91 | * Power Delivery 3.0. Active Cables in Power Delivery 3.0 have 5 data objects. |
|---|
| 92 | * [0] :: SVDM header |
|---|
| 93 | * [1] :: Identitiy header |
|---|
| 94 | * [2] :: Cert Stat VDO |
|---|
| 95 | * [3] :: (Product | Cable) VDO |
|---|
| 96 | * [4] :: Cable VDO 1 |
|---|
| 97 | * [4] :: AMA VDO |
|---|
| 98 | * [5] :: Cable VDO 2 |
|---|
| 99 | * |
|---|
| 100 | */ |
|---|
| 101 | #define VDO_INDEX_HDR 0 |
|---|
| 102 | #define VDO_INDEX_IDH 1 |
|---|
| 103 | #define VDO_INDEX_CSTAT 2 |
|---|
| 104 | #define VDO_INDEX_CABLE 3 |
|---|
| 105 | #define VDO_INDEX_PRODUCT 3 |
|---|
| 106 | #define VDO_INDEX_AMA 4 |
|---|
| 107 | #define VDO_INDEX_CABLE_1 4 |
|---|
| 108 | #define VDO_INDEX_CABLE_2 5 |
|---|
| 109 | |
|---|
| 110 | /* |
|---|
| 111 | * SVDM Identity Header |
|---|
| 112 | * -------------------- |
|---|
| 113 | * <31> :: data capable as a USB host |
|---|
| 114 | * <30> :: data capable as a USB device |
|---|
| 115 | * <29:27> :: product type (UFP / Cable / VPD) |
|---|
| 116 | * <26> :: modal operation supported (1b == yes) |
|---|
| 117 | * <25:23> :: product type (DFP) (SVDM version 2.0+ only; set to zero in version 1.0) |
|---|
| 118 | * <22:21> :: connector type (SVDM version 2.0+ only; set to zero in version 1.0) |
|---|
| 119 | * <20:16> :: Reserved, Shall be set to zero |
|---|
| 120 | * <15:0> :: USB-IF assigned VID for this cable vendor |
|---|
| 121 | */ |
|---|
| 122 | |
|---|
| 123 | /* PD Rev2.0 definition */ |
|---|
| 124 | #define IDH_PTYPE_UNDEF 0 |
|---|
| 125 | |
|---|
| 126 | /* SOP Product Type (UFP) */ |
|---|
| 127 | #define IDH_PTYPE_NOT_UFP 0 |
|---|
| 128 | #define IDH_PTYPE_HUB 1 |
|---|
| 129 | #define IDH_PTYPE_PERIPH 2 |
|---|
| 130 | #define IDH_PTYPE_PSD 3 |
|---|
| 131 | #define IDH_PTYPE_AMA 5 |
|---|
| 132 | |
|---|
| 133 | /* SOP' Product Type (Cable Plug / VPD) */ |
|---|
| 134 | #define IDH_PTYPE_NOT_CABLE 0 |
|---|
| 135 | #define IDH_PTYPE_PCABLE 3 |
|---|
| 136 | #define IDH_PTYPE_ACABLE 4 |
|---|
| 137 | #define IDH_PTYPE_VPD 6 |
|---|
| 138 | |
|---|
| 139 | /* SOP Product Type (DFP) */ |
|---|
| 140 | #define IDH_PTYPE_NOT_DFP 0 |
|---|
| 141 | #define IDH_PTYPE_DFP_HUB 1 |
|---|
| 142 | #define IDH_PTYPE_DFP_HOST 2 |
|---|
| 143 | #define IDH_PTYPE_DFP_PB 3 |
|---|
| 144 | |
|---|
| 145 | /* ID Header Mask */ |
|---|
| 146 | #define IDH_DFP_MASK GENMASK(25, 23) |
|---|
| 147 | #define IDH_CONN_MASK GENMASK(22, 21) |
|---|
| 148 | |
|---|
| 149 | #define VDO_IDH(usbh, usbd, ufp_cable, is_modal, dfp, conn, vid) \ |
|---|
| 150 | ((usbh) << 31 | (usbd) << 30 | ((ufp_cable) & 0x7) << 27 \ |
|---|
| 151 | | (is_modal) << 26 | ((dfp) & 0x7) << 23 | ((conn) & 0x3) << 21 \ |
|---|
| 152 | | ((vid) & 0xffff)) |
|---|
| 153 | |
|---|
| 154 | #define PD_IDH_PTYPE(vdo) (((vdo) >> 27) & 0x7) |
|---|
| 155 | #define PD_IDH_VID(vdo) ((vdo) & 0xffff) |
|---|
| 156 | #define PD_IDH_MODAL_SUPP(vdo) ((vdo) & (1 << 26)) |
|---|
| 157 | #define PD_IDH_DFP_PTYPE(vdo) (((vdo) >> 23) & 0x7) |
|---|
| 158 | #define PD_IDH_CONN_TYPE(vdo) (((vdo) >> 21) & 0x3) |
|---|
| 159 | #define PD_IDH_HOST_SUPP(vdo) ((vdo) & (1 << 31)) |
|---|
| 160 | |
|---|
| 161 | /* |
|---|
| 162 | * Cert Stat VDO |
|---|
| 163 | * ------------- |
|---|
| 164 | * <31:0> : USB-IF assigned XID for this cable |
|---|
| 165 | */ |
|---|
| 166 | #define PD_CSTAT_XID(vdo) (vdo) |
|---|
| 167 | #define VDO_CERT(xid) ((xid) & 0xffffffff) |
|---|
| 168 | |
|---|
| 169 | /* |
|---|
| 170 | * Product VDO |
|---|
| 171 | * ----------- |
|---|
| 172 | * <31:16> : USB Product ID |
|---|
| 173 | * <15:0> : USB bcdDevice |
|---|
| 174 | */ |
|---|
| 175 | #define VDO_PRODUCT(pid, bcd) (((pid) & 0xffff) << 16 | ((bcd) & 0xffff)) |
|---|
| 176 | #define PD_PRODUCT_PID(vdo) (((vdo) >> 16) & 0xffff) |
|---|
| 177 | |
|---|
| 178 | /* |
|---|
| 179 | * UFP VDO (PD Revision 3.0+ only) |
|---|
| 180 | * -------- |
|---|
| 181 | * <31:29> :: UFP VDO version |
|---|
| 182 | * <28> :: Reserved |
|---|
| 183 | * <27:24> :: Device capability |
|---|
| 184 | * <23:22> :: Connector type (10b == receptacle, 11b == captive plug) |
|---|
| 185 | * <21:11> :: Reserved |
|---|
| 186 | * <10:8> :: Vconn power (AMA only) |
|---|
| 187 | * <7> :: Vconn required (AMA only, 0b == no, 1b == yes) |
|---|
| 188 | * <6> :: Vbus required (AMA only, 0b == yes, 1b == no) |
|---|
| 189 | * <5:3> :: Alternate modes |
|---|
| 190 | * <2:0> :: USB highest speed |
|---|
| 191 | */ |
|---|
| 192 | #define PD_VDO_UFP_DEVCAP(vdo) FIELD_GET(GENMASK(27, 24), vdo) |
|---|
| 193 | |
|---|
| 194 | /* UFP VDO Version */ |
|---|
| 195 | #define UFP_VDO_VER1_2 2 |
|---|
| 196 | |
|---|
| 197 | /* Device Capability */ |
|---|
| 198 | #define DEV_USB2_CAPABLE BIT(0) |
|---|
| 199 | #define DEV_USB2_BILLBOARD BIT(1) |
|---|
| 200 | #define DEV_USB3_CAPABLE BIT(2) |
|---|
| 201 | #define DEV_USB4_CAPABLE BIT(3) |
|---|
| 202 | |
|---|
| 203 | /* Connector Type */ |
|---|
| 204 | #define UFP_RECEPTACLE 2 |
|---|
| 205 | #define UFP_CAPTIVE 3 |
|---|
| 206 | |
|---|
| 207 | /* Vconn Power (AMA only, set to AMA_VCONN_NOT_REQ if Vconn is not required) */ |
|---|
| 208 | #define AMA_VCONN_PWR_1W 0 |
|---|
| 209 | #define AMA_VCONN_PWR_1W5 1 |
|---|
| 210 | #define AMA_VCONN_PWR_2W 2 |
|---|
| 211 | #define AMA_VCONN_PWR_3W 3 |
|---|
| 212 | #define AMA_VCONN_PWR_4W 4 |
|---|
| 213 | #define AMA_VCONN_PWR_5W 5 |
|---|
| 214 | #define AMA_VCONN_PWR_6W 6 |
|---|
| 215 | |
|---|
| 216 | /* Vconn Required (AMA only) */ |
|---|
| 217 | #define AMA_VCONN_NOT_REQ 0 |
|---|
| 218 | #define AMA_VCONN_REQ 1 |
|---|
| 219 | |
|---|
| 220 | /* Vbus Required (AMA only) */ |
|---|
| 221 | #define AMA_VBUS_REQ 0 |
|---|
| 222 | #define AMA_VBUS_NOT_REQ 1 |
|---|
| 223 | |
|---|
| 224 | /* Alternate Modes */ |
|---|
| 225 | #define UFP_ALTMODE_NOT_SUPP 0 |
|---|
| 226 | #define UFP_ALTMODE_TBT3 BIT(0) |
|---|
| 227 | #define UFP_ALTMODE_RECFG BIT(1) |
|---|
| 228 | #define UFP_ALTMODE_NO_RECFG BIT(2) |
|---|
| 229 | |
|---|
| 230 | /* USB Highest Speed */ |
|---|
| 231 | #define UFP_USB2_ONLY 0 |
|---|
| 232 | #define UFP_USB32_GEN1 1 |
|---|
| 233 | #define UFP_USB32_4_GEN2 2 |
|---|
| 234 | #define UFP_USB4_GEN3 3 |
|---|
| 235 | |
|---|
| 236 | #define VDO_UFP(ver, cap, conn, vcpwr, vcr, vbr, alt, spd) \ |
|---|
| 237 | (((ver) & 0x7) << 29 | ((cap) & 0xf) << 24 | ((conn) & 0x3) << 22 \ |
|---|
| 238 | | ((vcpwr) & 0x7) << 8 | (vcr) << 7 | (vbr) << 6 | ((alt) & 0x7) << 3 \ |
|---|
| 239 | | ((spd) & 0x7)) |
|---|
| 240 | |
|---|
| 241 | /* |
|---|
| 242 | * DFP VDO (PD Revision 3.0+ only) |
|---|
| 243 | * -------- |
|---|
| 244 | * <31:29> :: DFP VDO version |
|---|
| 245 | * <28:27> :: Reserved |
|---|
| 246 | * <26:24> :: Host capability |
|---|
| 247 | * <23:22> :: Connector type (10b == receptacle, 11b == captive plug) |
|---|
| 248 | * <21:5> :: Reserved |
|---|
| 249 | * <4:0> :: Port number |
|---|
| 250 | */ |
|---|
| 251 | #define PD_VDO_DFP_HOSTCAP(vdo) FIELD_GET(GENMASK(26, 24), vdo) |
|---|
| 252 | |
|---|
| 253 | #define DFP_VDO_VER1_1 1 |
|---|
| 254 | #define HOST_USB2_CAPABLE BIT(0) |
|---|
| 255 | #define HOST_USB3_CAPABLE BIT(1) |
|---|
| 256 | #define HOST_USB4_CAPABLE BIT(2) |
|---|
| 257 | #define DFP_RECEPTACLE 2 |
|---|
| 258 | #define DFP_CAPTIVE 3 |
|---|
| 259 | |
|---|
| 260 | #define VDO_DFP(ver, cap, conn, pnum) \ |
|---|
| 261 | (((ver) & 0x7) << 29 | ((cap) & 0x7) << 24 | ((conn) & 0x3) << 22 \ |
|---|
| 262 | | ((pnum) & 0x1f)) |
|---|
| 263 | |
|---|
| 264 | /* |
|---|
| 265 | * Cable VDO (for both Passive and Active Cable VDO in PD Rev2.0) |
|---|
| 266 | * --------- |
|---|
| 267 | * <31:28> :: Cable HW version |
|---|
| 268 | * <27:24> :: Cable FW version |
|---|
| 269 | * <23:20> :: Reserved, Shall be set to zero |
|---|
| 270 | * <19:18> :: type-C to Type-A/B/C/Captive (00b == A, 01 == B, 10 == C, 11 == Captive) |
|---|
| 271 | * <17> :: Reserved, Shall be set to zero |
|---|
| 272 | * <16:13> :: cable latency (0001 == <10ns(~1m length)) |
|---|
| 273 | * <12:11> :: cable termination type (11b == both ends active VCONN req) |
|---|
| 274 | * <10> :: SSTX1 Directionality support (0b == fixed, 1b == cfgable) |
|---|
| 275 | * <9> :: SSTX2 Directionality support |
|---|
| 276 | * <8> :: SSRX1 Directionality support |
|---|
| 277 | * <7> :: SSRX2 Directionality support |
|---|
| 278 | * <6:5> :: Vbus current handling capability (01b == 3A, 10b == 5A) |
|---|
| 279 | * <4> :: Vbus through cable (0b == no, 1b == yes) |
|---|
| 280 | * <3> :: SOP" controller present? (0b == no, 1b == yes) |
|---|
| 281 | * <2:0> :: USB SS Signaling support |
|---|
| 282 | * |
|---|
| 283 | * Passive Cable VDO (PD Rev3.0+) |
|---|
| 284 | * --------- |
|---|
| 285 | * <31:28> :: Cable HW version |
|---|
| 286 | * <27:24> :: Cable FW version |
|---|
| 287 | * <23:21> :: VDO version |
|---|
| 288 | * <20> :: Reserved, Shall be set to zero |
|---|
| 289 | * <19:18> :: Type-C to Type-C/Captive (10b == C, 11b == Captive) |
|---|
| 290 | * <17> :: Reserved, Shall be set to zero |
|---|
| 291 | * <16:13> :: cable latency (0001 == <10ns(~1m length)) |
|---|
| 292 | * <12:11> :: cable termination type (10b == Vconn not req, 01b == Vconn req) |
|---|
| 293 | * <10:9> :: Maximum Vbus voltage (00b == 20V, 01b == 30V, 10b == 40V, 11b == 50V) |
|---|
| 294 | * <8:7> :: Reserved, Shall be set to zero |
|---|
| 295 | * <6:5> :: Vbus current handling capability (01b == 3A, 10b == 5A) |
|---|
| 296 | * <4:3> :: Reserved, Shall be set to zero |
|---|
| 297 | * <2:0> :: USB highest speed |
|---|
| 298 | * |
|---|
| 299 | * Active Cable VDO 1 (PD Rev3.0+) |
|---|
| 300 | * --------- |
|---|
| 301 | * <31:28> :: Cable HW version |
|---|
| 302 | * <27:24> :: Cable FW version |
|---|
| 303 | * <23:21> :: VDO version |
|---|
| 304 | * <20> :: Reserved, Shall be set to zero |
|---|
| 305 | * <19:18> :: Connector type (10b == C, 11b == Captive) |
|---|
| 306 | * <17> :: Reserved, Shall be set to zero |
|---|
| 307 | * <16:13> :: cable latency (0001 == <10ns(~1m length)) |
|---|
| 308 | * <12:11> :: cable termination type (10b == one end active, 11b == both ends active VCONN req) |
|---|
| 309 | * <10:9> :: Maximum Vbus voltage (00b == 20V, 01b == 30V, 10b == 40V, 11b == 50V) |
|---|
| 310 | * <8> :: SBU supported (0b == supported, 1b == not supported) |
|---|
| 311 | * <7> :: SBU type (0b == passive, 1b == active) |
|---|
| 312 | * <6:5> :: Vbus current handling capability (01b == 3A, 10b == 5A) |
|---|
| 313 | * <4> :: Vbus through cable (0b == no, 1b == yes) |
|---|
| 314 | * <3> :: SOP" controller present? (0b == no, 1b == yes) |
|---|
| 315 | * <2:0> :: USB highest speed |
|---|
| 316 | */ |
|---|
| 317 | /* Cable VDO Version */ |
|---|
| 318 | #define CABLE_VDO_VER1_0 0 |
|---|
| 319 | #define CABLE_VDO_VER1_3 3 |
|---|
| 320 | |
|---|
| 321 | /* Connector Type (_ATYPE and _BTYPE are for PD Rev2.0 only) */ |
|---|
| 322 | #define CABLE_ATYPE 0 |
|---|
| 323 | #define CABLE_BTYPE 1 |
|---|
| 324 | #define CABLE_CTYPE 2 |
|---|
| 325 | #define CABLE_CAPTIVE 3 |
|---|
| 326 | |
|---|
| 327 | /* Cable Latency */ |
|---|
| 328 | #define CABLE_LATENCY_1M 1 |
|---|
| 329 | #define CABLE_LATENCY_2M 2 |
|---|
| 330 | #define CABLE_LATENCY_3M 3 |
|---|
| 331 | #define CABLE_LATENCY_4M 4 |
|---|
| 332 | #define CABLE_LATENCY_5M 5 |
|---|
| 333 | #define CABLE_LATENCY_6M 6 |
|---|
| 334 | #define CABLE_LATENCY_7M 7 |
|---|
| 335 | #define CABLE_LATENCY_7M_PLUS 8 |
|---|
| 336 | |
|---|
| 337 | /* Cable Termination Type */ |
|---|
| 338 | #define PCABLE_VCONN_NOT_REQ 0 |
|---|
| 339 | #define PCABLE_VCONN_REQ 1 |
|---|
| 340 | #define ACABLE_ONE_END 2 |
|---|
| 341 | #define ACABLE_BOTH_END 3 |
|---|
| 342 | |
|---|
| 343 | /* Maximum Vbus Voltage */ |
|---|
| 344 | #define CABLE_MAX_VBUS_20V 0 |
|---|
| 345 | #define CABLE_MAX_VBUS_30V 1 |
|---|
| 346 | #define CABLE_MAX_VBUS_40V 2 |
|---|
| 347 | #define CABLE_MAX_VBUS_50V 3 |
|---|
| 348 | |
|---|
| 349 | /* Active Cable SBU Supported/Type */ |
|---|
| 350 | #define ACABLE_SBU_SUPP 0 |
|---|
| 351 | #define ACABLE_SBU_NOT_SUPP 1 |
|---|
| 352 | #define ACABLE_SBU_PASSIVE 0 |
|---|
| 353 | #define ACABLE_SBU_ACTIVE 1 |
|---|
| 354 | |
|---|
| 355 | /* Vbus Current Handling Capability */ |
|---|
| 356 | #define CABLE_CURR_DEF 0 |
|---|
| 357 | #define CABLE_CURR_3A 1 |
|---|
| 358 | #define CABLE_CURR_5A 2 |
|---|
| 359 | |
|---|
| 360 | /* USB SuperSpeed Signaling Support (PD Rev2.0) */ |
|---|
| 361 | #define CABLE_USBSS_U2_ONLY 0 |
|---|
| 362 | #define CABLE_USBSS_U31_GEN1 1 |
|---|
| 363 | #define CABLE_USBSS_U31_GEN2 2 |
|---|
| 364 | |
|---|
| 365 | /* USB Highest Speed */ |
|---|
| 366 | #define CABLE_USB2_ONLY 0 |
|---|
| 367 | #define CABLE_USB32_GEN1 1 |
|---|
| 368 | #define CABLE_USB32_4_GEN2 2 |
|---|
| 369 | #define CABLE_USB4_GEN3 3 |
|---|
| 370 | |
|---|
| 371 | #define VDO_CABLE(hw, fw, cbl, lat, term, tx1d, tx2d, rx1d, rx2d, cur, vps, sopp, usbss) \ |
|---|
| 372 | (((hw) & 0x7) << 28 | ((fw) & 0x7) << 24 | ((cbl) & 0x3) << 18 \ |
|---|
| 373 | | ((lat) & 0x7) << 13 | ((term) & 0x3) << 11 | (tx1d) << 10 \ |
|---|
| 374 | | (tx2d) << 9 | (rx1d) << 8 | (rx2d) << 7 | ((cur) & 0x3) << 5 \ |
|---|
| 375 | | (vps) << 4 | (sopp) << 3 | ((usbss) & 0x7)) |
|---|
| 376 | #define VDO_PCABLE(hw, fw, ver, conn, lat, term, vbm, cur, spd) \ |
|---|
| 377 | (((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21 \ |
|---|
| 378 | | ((conn) & 0x3) << 18 | ((lat) & 0xf) << 13 | ((term) & 0x3) << 11 \ |
|---|
| 379 | | ((vbm) & 0x3) << 9 | ((cur) & 0x3) << 5 | ((spd) & 0x7)) |
|---|
| 380 | #define VDO_ACABLE1(hw, fw, ver, conn, lat, term, vbm, sbu, sbut, cur, vbt, sopp, spd) \ |
|---|
| 381 | (((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21 \ |
|---|
| 382 | | ((conn) & 0x3) << 18 | ((lat) & 0xf) << 13 | ((term) & 0x3) << 11 \ |
|---|
| 383 | | ((vbm) & 0x3) << 9 | (sbu) << 8 | (sbut) << 7 | ((cur) & 0x3) << 5 \ |
|---|
| 384 | | (vbt) << 4 | (sopp) << 3 | ((spd) & 0x7)) |
|---|
| 385 | |
|---|
| 386 | #define VDO_TYPEC_CABLE_SPEED(vdo) ((vdo) & 0x7) |
|---|
| 387 | #define VDO_TYPEC_CABLE_TYPE(vdo) (((vdo) >> 18) & 0x3) |
|---|
| 388 | |
|---|
| 389 | /* |
|---|
| 390 | * Active Cable VDO 2 |
|---|
| 391 | * --------- |
|---|
| 392 | * <31:24> :: Maximum operating temperature |
|---|
| 393 | * <23:16> :: Shutdown temperature |
|---|
| 394 | * <15> :: Reserved, Shall be set to zero |
|---|
| 395 | * <14:12> :: U3/CLd power |
|---|
| 396 | * <11> :: U3 to U0 transition mode (0b == direct, 1b == through U3S) |
|---|
| 397 | * <10> :: Physical connection (0b == copper, 1b == optical) |
|---|
| 398 | * <9> :: Active element (0b == redriver, 1b == retimer) |
|---|
| 399 | * <8> :: USB4 supported (0b == yes, 1b == no) |
|---|
| 400 | * <7:6> :: USB2 hub hops consumed |
|---|
| 401 | * <5> :: USB2 supported (0b == yes, 1b == no) |
|---|
| 402 | * <4> :: USB3.2 supported (0b == yes, 1b == no) |
|---|
| 403 | * <3> :: USB lanes supported (0b == one lane, 1b == two lanes) |
|---|
| 404 | * <2> :: Optically isolated active cable (0b == no, 1b == yes) |
|---|
| 405 | * <1> :: Reserved, Shall be set to zero |
|---|
| 406 | * <0> :: USB gen (0b == gen1, 1b == gen2+) |
|---|
| 407 | */ |
|---|
| 408 | /* U3/CLd Power*/ |
|---|
| 409 | #define ACAB2_U3_CLD_10MW_PLUS 0 |
|---|
| 410 | #define ACAB2_U3_CLD_10MW 1 |
|---|
| 411 | #define ACAB2_U3_CLD_5MW 2 |
|---|
| 412 | #define ACAB2_U3_CLD_1MW 3 |
|---|
| 413 | #define ACAB2_U3_CLD_500UW 4 |
|---|
| 414 | #define ACAB2_U3_CLD_200UW 5 |
|---|
| 415 | #define ACAB2_U3_CLD_50UW 6 |
|---|
| 416 | |
|---|
| 417 | /* Other Active Cable VDO 2 Fields */ |
|---|
| 418 | #define ACAB2_U3U0_DIRECT 0 |
|---|
| 419 | #define ACAB2_U3U0_U3S 1 |
|---|
| 420 | #define ACAB2_PHY_COPPER 0 |
|---|
| 421 | #define ACAB2_PHY_OPTICAL 1 |
|---|
| 422 | #define ACAB2_REDRIVER 0 |
|---|
| 423 | #define ACAB2_RETIMER 1 |
|---|
| 424 | #define ACAB2_USB4_SUPP 0 |
|---|
| 425 | #define ACAB2_USB4_NOT_SUPP 1 |
|---|
| 426 | #define ACAB2_USB2_SUPP 0 |
|---|
| 427 | #define ACAB2_USB2_NOT_SUPP 1 |
|---|
| 428 | #define ACAB2_USB32_SUPP 0 |
|---|
| 429 | #define ACAB2_USB32_NOT_SUPP 1 |
|---|
| 430 | #define ACAB2_LANES_ONE 0 |
|---|
| 431 | #define ACAB2_LANES_TWO 1 |
|---|
| 432 | #define ACAB2_OPT_ISO_NO 0 |
|---|
| 433 | #define ACAB2_OPT_ISO_YES 1 |
|---|
| 434 | #define ACAB2_GEN_1 0 |
|---|
| 435 | #define ACAB2_GEN_2_PLUS 1 |
|---|
| 436 | |
|---|
| 437 | #define VDO_ACABLE2(mtemp, stemp, u3p, trans, phy, ele, u4, hops, u2, u32, lane, iso, gen) \ |
|---|
| 438 | (((mtemp) & 0xff) << 24 | ((stemp) & 0xff) << 16 | ((u3p) & 0x7) << 12 \ |
|---|
| 439 | | (trans) << 11 | (phy) << 10 | (ele) << 9 | (u4) << 8 \ |
|---|
| 440 | | ((hops) & 0x3) << 6 | (u2) << 5 | (u32) << 4 | (lane) << 3 \ |
|---|
| 441 | | (iso) << 2 | (gen)) |
|---|
| 442 | |
|---|
| 443 | /* |
|---|
| 444 | * AMA VDO (PD Rev2.0) |
|---|
| 445 | * --------- |
|---|
| 446 | * <31:28> :: Cable HW version |
|---|
| 447 | * <27:24> :: Cable FW version |
|---|
| 448 | * <23:12> :: Reserved, Shall be set to zero |
|---|
| 449 | * <11> :: SSTX1 Directionality support (0b == fixed, 1b == cfgable) |
|---|
| 450 | * <10> :: SSTX2 Directionality support |
|---|
| 451 | * <9> :: SSRX1 Directionality support |
|---|
| 452 | * <8> :: SSRX2 Directionality support |
|---|
| 453 | * <7:5> :: Vconn power |
|---|
| 454 | * <4> :: Vconn power required |
|---|
| 455 | * <3> :: Vbus power required |
|---|
| 456 | * <2:0> :: USB SS Signaling support |
|---|
| 457 | */ |
|---|
| 458 | #define VDO_AMA(hw, fw, tx1d, tx2d, rx1d, rx2d, vcpwr, vcr, vbr, usbss) \ |
|---|
| 459 | (((hw) & 0x7) << 28 | ((fw) & 0x7) << 24 \ |
|---|
| 460 | | (tx1d) << 11 | (tx2d) << 10 | (rx1d) << 9 | (rx2d) << 8 \ |
|---|
| 461 | | ((vcpwr) & 0x7) << 5 | (vcr) << 4 | (vbr) << 3 \ |
|---|
| 462 | | ((usbss) & 0x7)) |
|---|
| 463 | |
|---|
| 464 | #define PD_VDO_AMA_VCONN_REQ(vdo) (((vdo) >> 4) & 1) |
|---|
| 465 | #define PD_VDO_AMA_VBUS_REQ(vdo) (((vdo) >> 3) & 1) |
|---|
| 466 | |
|---|
| 467 | #define AMA_USBSS_U2_ONLY 0 |
|---|
| 468 | #define AMA_USBSS_U31_GEN1 1 |
|---|
| 469 | #define AMA_USBSS_U31_GEN2 2 |
|---|
| 470 | #define AMA_USBSS_BBONLY 3 |
|---|
| 471 | |
|---|
| 472 | /* |
|---|
| 473 | * VPD VDO |
|---|
| 474 | * --------- |
|---|
| 475 | * <31:28> :: HW version |
|---|
| 476 | * <27:24> :: FW version |
|---|
| 477 | * <23:21> :: VDO version |
|---|
| 478 | * <20:17> :: Reserved, Shall be set to zero |
|---|
| 479 | * <16:15> :: Maximum Vbus voltage (00b == 20V, 01b == 30V, 10b == 40V, 11b == 50V) |
|---|
| 480 | * <14> :: Charge through current support (0b == 3A, 1b == 5A) |
|---|
| 481 | * <13> :: Reserved, Shall be set to zero |
|---|
| 482 | * <12:7> :: Vbus impedance |
|---|
| 483 | * <6:1> :: Ground impedance |
|---|
| 484 | * <0> :: Charge through support (0b == no, 1b == yes) |
|---|
| 485 | */ |
|---|
| 486 | #define VPD_VDO_VER1_0 0 |
|---|
| 487 | #define VPD_MAX_VBUS_20V 0 |
|---|
| 488 | #define VPD_MAX_VBUS_30V 1 |
|---|
| 489 | #define VPD_MAX_VBUS_40V 2 |
|---|
| 490 | #define VPD_MAX_VBUS_50V 3 |
|---|
| 491 | #define VPDCT_CURR_3A 0 |
|---|
| 492 | #define VPDCT_CURR_5A 1 |
|---|
| 493 | #define VPDCT_NOT_SUPP 0 |
|---|
| 494 | #define VPDCT_SUPP 1 |
|---|
| 495 | |
|---|
| 496 | #define VDO_VPD(hw, fw, ver, vbm, curr, vbi, gi, ct) \ |
|---|
| 497 | (((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21 \ |
|---|
| 498 | | ((vbm) & 0x3) << 15 | (curr) << 14 | ((vbi) & 0x3f) << 7 \ |
|---|
| 499 | | ((gi) & 0x3f) << 1 | (ct)) |
|---|
| 500 | |
|---|
| 501 | /* |
|---|
| 502 | * SVDM Discover SVIDs request -> response |
|---|
| 503 | * |
|---|
| 504 | * Request is properly formatted VDM Header with discover SVIDs command. |
|---|
| 505 | * Response is a set of SVIDs of all supported SVIDs with all zero's to |
|---|
| 506 | * mark the end of SVIDs. If more than 12 SVIDs are supported command SHOULD be |
|---|
| 507 | * repeated. |
|---|
| 508 | */ |
|---|
| 509 | #define VDO_SVID(svid0, svid1) (((svid0) & 0xffff) << 16 | ((svid1) & 0xffff)) |
|---|
| 510 | #define PD_VDO_SVID_SVID0(vdo) ((vdo) >> 16) |
|---|
| 511 | #define PD_VDO_SVID_SVID1(vdo) ((vdo) & 0xffff) |
|---|
| 512 | |
|---|
| 513 | /* USB-IF SIDs */ |
|---|
| 514 | #define USB_SID_PD 0xff00 /* power delivery */ |
|---|
| 515 | #define USB_SID_DISPLAYPORT 0xff01 |
|---|
| 516 | #define USB_SID_MHL 0xff02 /* Mobile High-Definition Link */ |
|---|
| 517 | |
|---|
| 518 | /* VDM command timeouts (in ms) */ |
|---|
| 519 | |
|---|
| 520 | #define PD_T_VDM_UNSTRUCTURED 500 |
|---|
| 521 | #define PD_T_VDM_BUSY 100 |
|---|
| 522 | #define PD_T_VDM_WAIT_MODE_E 100 |
|---|
| 523 | #define PD_T_VDM_SNDR_RSP 30 |
|---|
| 524 | #define PD_T_VDM_E_MODE 25 |
|---|
| 525 | #define PD_T_VDM_RCVR_RSP 15 |
|---|
| 526 | |
|---|
| 527 | #endif /* __LINUX_USB_PD_VDO_H */ |
|---|
| 528 | |
|---|
