drivers/staging/typec/pd_vdo.h

   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_VDO_H
  16 #define __LINUX_USB_PD_VDO_H
  17
  18 #include "pd.h"
  19
  20 /*
  21  * VDO : Vendor Defined Message Object
  22  * VDM object is minimum of VDM header + 6 additional data objects.
  23  */
  24
  25 /*
  26  * VDM header
  27  * ----------
  28  * <31:16>  :: SVID
  29  * <15>     :: VDM type ( 1b == structured, 0b == unstructured )
  30  * <14:13>  :: Structured VDM version (can only be 00 == 1.0 currently)
  31  * <12:11>  :: reserved
  32  * <10:8>   :: object position (1-7 valid ... used for enter/exit mode only)
  33  * <7:6>    :: command type (SVDM only?)
  34  * <5>      :: reserved (SVDM), command type (UVDM)
  35  * <4:0>    :: command
  36  */
  37 #define VDO_MAX_SIZE 7
  38 #define VDO(vid, type, custom)                          \
  39         (((vid) << 16) |                                \
  40          ((type) << 15) |                               \
  41          ((custom) & 0x7FFF))
  42
  43 #define VDO_SVDM_TYPE           (1 << 15)
  44 #define VDO_SVDM_VERS(x)        ((x) << 13)
  45 #define VDO_OPOS(x)             ((x) << 8)
  46 #define VDO_CMDT(x)             ((x) << 6)
  47 #define VDO_OPOS_MASK           VDO_OPOS(0x7)
  48 #define VDO_CMDT_MASK           VDO_CMDT(0x3)
  49
  50 #define CMDT_INIT               0
  51 #define CMDT_RSP_ACK            1
  52 #define CMDT_RSP_NAK            2
  53 #define CMDT_RSP_BUSY           3
  54
  55 /* reserved for SVDM ... for Google UVDM */
  56 #define VDO_SRC_INITIATOR       (0 << 5)
  57 #define VDO_SRC_RESPONDER       (1 << 5)
  58
  59 #define CMD_DISCOVER_IDENT      1
  60 #define CMD_DISCOVER_SVID       2
  61 #define CMD_DISCOVER_MODES      3
  62 #define CMD_ENTER_MODE          4
  63 #define CMD_EXIT_MODE           5
  64 #define CMD_ATTENTION           6
  65
  66 #define VDO_CMD_VENDOR(x)    (((10 + (x)) & 0x1f))
  67
  68 /* ChromeOS specific commands */
  69 #define VDO_CMD_VERSION         VDO_CMD_VENDOR(0)
  70 #define VDO_CMD_SEND_INFO       VDO_CMD_VENDOR(1)
  71 #define VDO_CMD_READ_INFO       VDO_CMD_VENDOR(2)
  72 #define VDO_CMD_REBOOT          VDO_CMD_VENDOR(5)
  73 #define VDO_CMD_FLASH_ERASE     VDO_CMD_VENDOR(6)
  74 #define VDO_CMD_FLASH_WRITE     VDO_CMD_VENDOR(7)
  75 #define VDO_CMD_ERASE_SIG       VDO_CMD_VENDOR(8)
  76 #define VDO_CMD_PING_ENABLE     VDO_CMD_VENDOR(10)
  77 #define VDO_CMD_CURRENT         VDO_CMD_VENDOR(11)
  78 #define VDO_CMD_FLIP            VDO_CMD_VENDOR(12)
  79 #define VDO_CMD_GET_LOG         VDO_CMD_VENDOR(13)
  80 #define VDO_CMD_CCD_EN          VDO_CMD_VENDOR(14)
  81
  82 #define PD_VDO_VID(vdo)         ((vdo) >> 16)
  83 #define PD_VDO_SVDM(vdo)        (((vdo) >> 15) & 1)
  84 #define PD_VDO_OPOS(vdo)        (((vdo) >> 8) & 0x7)
  85 #define PD_VDO_CMD(vdo)         ((vdo) & 0x1f)
  86 #define PD_VDO_CMDT(vdo)        (((vdo) >> 6) & 0x3)
  87
  88 /*
  89  * SVDM Identity request -> response
  90  *
  91  * Request is simply properly formatted SVDM header
  92  *
  93  * Response is 4 data objects:
  94  * [0] :: SVDM header
  95  * [1] :: Identitiy header
  96  * [2] :: Cert Stat VDO
  97  * [3] :: (Product | Cable) VDO
  98  * [4] :: AMA VDO
  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
 108 /*
 109  * SVDM Identity Header
 110  * --------------------
 111  * <31>     :: data capable as a USB host
 112  * <30>     :: data capable as a USB device
 113  * <29:27>  :: product type
 114  * <26>     :: modal operation supported (1b == yes)
 115  * <25:16>  :: Reserved, Shall be set to zero
 116  * <15:0>   :: USB-IF assigned VID for this cable vendor
 117  */
 118 #define IDH_PTYPE_UNDEF         0
 119 #define IDH_PTYPE_HUB           1
 120 #define IDH_PTYPE_PERIPH        2
 121 #define IDH_PTYPE_PCABLE        3
 122 #define IDH_PTYPE_ACABLE        4
 123 #define IDH_PTYPE_AMA           5
 124
 125 #define VDO_IDH(usbh, usbd, ptype, is_modal, vid)               \
 126         ((usbh) << 31 | (usbd) << 30 | ((ptype) & 0x7) << 27    \
 127          | (is_modal) << 26 | ((vid) & 0xffff))
 128
 129 #define PD_IDH_PTYPE(vdo)       (((vdo) >> 27) & 0x7)
 130 #define PD_IDH_VID(vdo)         ((vdo) & 0xffff)
 131 #define PD_IDH_MODAL_SUPP(vdo)  ((vdo) & (1 << 26))
 132
 133 /*
 134  * Cert Stat VDO
 135  * -------------
 136  * <31:0>  : USB-IF assigned XID for this cable
 137  */
 138 #define PD_CSTAT_XID(vdo)       (vdo)
 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 #define PD_PRODUCT_PID(vdo)     (((vdo) >> 16) & 0xffff)
 148
 149 /*
 150  * Cable VDO
 151  * ---------
 152  * <31:28> :: Cable HW version
 153  * <27:24> :: Cable FW version
 154  * <23:20> :: Reserved, Shall be set to zero
 155  * <19:18> :: type-C to Type-A/B/C (00b == A, 01 == B, 10 == C)
 156  * <17>    :: Type-C to Plug/Receptacle (0b == plug, 1b == receptacle)
 157  * <16:13> :: cable latency (0001 == <10ns(~1m length))
 158  * <12:11> :: cable termination type (11b == both ends active VCONN req)
 159  * <10>    :: SSTX1 Directionality support (0b == fixed, 1b == cfgable)
 160  * <9>     :: SSTX2 Directionality support
 161  * <8>     :: SSRX1 Directionality support
 162  * <7>     :: SSRX2 Directionality support
 163  * <6:5>   :: Vbus current handling capability
 164  * <4>     :: Vbus through cable (0b == no, 1b == yes)
 165  * <3>     :: SOP" controller present? (0b == no, 1b == yes)
 166  * <2:0>   :: USB SS Signaling support
 167  */
 168 #define CABLE_ATYPE             0
 169 #define CABLE_BTYPE             1
 170 #define CABLE_CTYPE             2
 171 #define CABLE_PLUG              0
 172 #define CABLE_RECEPTACLE        1
 173 #define CABLE_CURR_1A5          0
 174 #define CABLE_CURR_3A           1
 175 #define CABLE_CURR_5A           2
 176 #define CABLE_USBSS_U2_ONLY     0
 177 #define CABLE_USBSS_U31_GEN1    1
 178 #define CABLE_USBSS_U31_GEN2    2
 179 #define VDO_CABLE(hw, fw, cbl, gdr, lat, term, tx1d, tx2d, rx1d, rx2d, cur,\
 180                   vps, sopp, usbss) \
 181         (((hw) & 0x7) << 28 | ((fw) & 0x7) << 24 | ((cbl) & 0x3) << 18  \
 182          | (gdr) << 17 | ((lat) & 0x7) << 13 | ((term) & 0x3) << 11     \
 183          | (tx1d) << 10 | (tx2d) << 9 | (rx1d) << 8 | (rx2d) << 7       \
 184          | ((cur) & 0x3) << 5 | (vps) << 4 | (sopp) << 3                \
 185          | ((usbss) & 0x7))
 186
 187 /*
 188  * AMA VDO
 189  * ---------
 190  * <31:28> :: Cable HW version
 191  * <27:24> :: Cable FW version
 192  * <23:12> :: Reserved, Shall be set to zero
 193  * <11>    :: SSTX1 Directionality support (0b == fixed, 1b == cfgable)
 194  * <10>    :: SSTX2 Directionality support
 195  * <9>     :: SSRX1 Directionality support
 196  * <8>     :: SSRX2 Directionality support
 197  * <7:5>   :: Vconn power
 198  * <4>     :: Vconn power required
 199  * <3>     :: Vbus power required
 200  * <2:0>   :: USB SS Signaling support
 201  */
 202 #define VDO_AMA(hw, fw, tx1d, tx2d, rx1d, rx2d, vcpwr, vcr, vbr, usbss) \
 203         (((hw) & 0x7) << 28 | ((fw) & 0x7) << 24                        \
 204          | (tx1d) << 11 | (tx2d) << 10 | (rx1d) << 9 | (rx2d) << 8      \
 205          | ((vcpwr) & 0x7) << 5 | (vcr) << 4 | (vbr) << 3               \
 206          | ((usbss) & 0x7))
 207
 208 #define PD_VDO_AMA_VCONN_REQ(vdo)       (((vdo) >> 4) & 1)
 209 #define PD_VDO_AMA_VBUS_REQ(vdo)        (((vdo) >> 3) & 1)
 210
 211 #define AMA_VCONN_PWR_1W        0
 212 #define AMA_VCONN_PWR_1W5       1
 213 #define AMA_VCONN_PWR_2W        2
 214 #define AMA_VCONN_PWR_3W        3
 215 #define AMA_VCONN_PWR_4W        4
 216 #define AMA_VCONN_PWR_5W        5
 217 #define AMA_VCONN_PWR_6W        6
 218 #define AMA_USBSS_U2_ONLY       0
 219 #define AMA_USBSS_U31_GEN1      1
 220 #define AMA_USBSS_U31_GEN2      2
 221 #define AMA_USBSS_BBONLY        3
 222
 223 /*
 224  * SVDM Discover SVIDs request -> response
 225  *
 226  * Request is properly formatted VDM Header with discover SVIDs command.
 227  * Response is a set of SVIDs of all all supported SVIDs with all zero's to
 228  * mark the end of SVIDs.  If more than 12 SVIDs are supported command SHOULD be
 229  * repeated.
 230  */
 231 #define VDO_SVID(svid0, svid1)  (((svid0) & 0xffff) << 16 | ((svid1) & 0xffff))
 232 #define PD_VDO_SVID_SVID0(vdo)  ((vdo) >> 16)
 233 #define PD_VDO_SVID_SVID1(vdo)  ((vdo) & 0xffff)
 234
 235 /* USB-IF SIDs */
 236 #define USB_SID_PD              0xff00 /* power delivery */
 237 #define USB_SID_DISPLAYPORT     0xff01
 238 #define USB_SID_MHL             0xff02  /* Mobile High-Definition Link */
 239
 240 /* VDM command timeouts (in ms) */
 241
 242 #define PD_T_VDM_UNSTRUCTURED   500
 243 #define PD_T_VDM_BUSY           100
 244 #define PD_T_VDM_WAIT_MODE_E    100
 245 #define PD_T_VDM_SNDR_RSP       30
 246 #define PD_T_VDM_E_MODE         25
 247 #define PD_T_VDM_RCVR_RSP       15
 248
 249 #endif /* __LINUX_USB_PD_VDO_H */