drivers/staging/typec/pd.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_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 };
  39
  40 enum pd_data_msg_type {
  41         /* 0 Reserved */
  42         PD_DATA_SOURCE_CAP = 1,
  43         PD_DATA_REQUEST = 2,
  44         PD_DATA_BIST = 3,
  45         PD_DATA_SINK_CAP = 4,
  46         /* 5-14 Reserved */
  47         PD_DATA_VENDOR_DEF = 15,
  48 };
  49
  50 #define PD_REV10        0x0
  51 #define PD_REV20        0x1
  52
  53 #define PD_HEADER_CNT_SHIFT     12
  54 #define PD_HEADER_CNT_MASK      0x7
  55 #define PD_HEADER_ID_SHIFT      9
  56 #define PD_HEADER_ID_MASK       0x7
  57 #define PD_HEADER_PWR_ROLE      BIT(8)
  58 #define PD_HEADER_REV_SHIFT     6
  59 #define PD_HEADER_REV_MASK      0x3
  60 #define PD_HEADER_DATA_ROLE     BIT(5)
  61 #define PD_HEADER_TYPE_SHIFT    0
  62 #define PD_HEADER_TYPE_MASK     0xf
  63
  64 #define PD_HEADER(type, pwr, data, id, cnt)                             \
  65         ((((type) & PD_HEADER_TYPE_MASK) << PD_HEADER_TYPE_SHIFT) |     \
  66          ((pwr) == TYPEC_SOURCE ? PD_HEADER_PWR_ROLE : 0) |             \
  67          ((data) == TYPEC_HOST ? PD_HEADER_DATA_ROLE : 0) |             \
  68          (PD_REV20 << PD_HEADER_REV_SHIFT) |                            \
  69          (((id) & PD_HEADER_ID_MASK) << PD_HEADER_ID_SHIFT) |           \
  70          (((cnt) & PD_HEADER_CNT_MASK) << PD_HEADER_CNT_SHIFT))
  71
  72 #define PD_HEADER_LE(type, pwr, data, id, cnt) \
  73         cpu_to_le16(PD_HEADER((type), (pwr), (data), (id), (cnt)))
  74
  75 static inline unsigned int pd_header_cnt(u16 header)
  76 {
  77         return (header >> PD_HEADER_CNT_SHIFT) & PD_HEADER_CNT_MASK;
  78 }
  79
  80 static inline unsigned int pd_header_cnt_le(__le16 header)
  81 {
  82         return pd_header_cnt(le16_to_cpu(header));
  83 }
  84
  85 static inline unsigned int pd_header_type(u16 header)
  86 {
  87         return (header >> PD_HEADER_TYPE_SHIFT) & PD_HEADER_TYPE_MASK;
  88 }
  89
  90 static inline unsigned int pd_header_type_le(__le16 header)
  91 {
  92         return pd_header_type(le16_to_cpu(header));
  93 }
  94
  95 static inline unsigned int pd_header_msgid(u16 header)
  96 {
  97         return (header >> PD_HEADER_ID_SHIFT) & PD_HEADER_ID_MASK;
  98 }
  99
 100 static inline unsigned int pd_header_msgid_le(__le16 header)
 101 {
 102         return pd_header_msgid(le16_to_cpu(header));
 103 }
 104
 105 #define PD_MAX_PAYLOAD          7
 106
 107 struct pd_message {
 108         __le16 header;
 109         __le32 payload[PD_MAX_PAYLOAD];
 110 } __packed;
 111
 112 /* PDO: Power Data Object */
 113 #define PDO_MAX_OBJECTS         7
 114
 115 enum pd_pdo_type {
 116         PDO_TYPE_FIXED = 0,
 117         PDO_TYPE_BATT = 1,
 118         PDO_TYPE_VAR = 2,
 119 };
 120
 121 #define PDO_TYPE_SHIFT          30
 122 #define PDO_TYPE_MASK           0x3
 123
 124 #define PDO_TYPE(t)     ((t) << PDO_TYPE_SHIFT)
 125
 126 #define PDO_VOLT_MASK           0x3ff
 127 #define PDO_CURR_MASK           0x3ff
 128 #define PDO_PWR_MASK            0x3ff
 129
 130 #define PDO_FIXED_DUAL_ROLE     BIT(29) /* Power role swap supported */
 131 #define PDO_FIXED_SUSPEND       BIT(28) /* USB Suspend supported (Source) */
 132 #define PDO_FIXED_HIGHER_CAP    BIT(28) /* Requires more than vSafe5V (Sink) */
 133 #define PDO_FIXED_EXTPOWER      BIT(27) /* Externally powered */
 134 #define PDO_FIXED_USB_COMM      BIT(26) /* USB communications capable */
 135 #define PDO_FIXED_DATA_SWAP     BIT(25) /* Data role swap supported */
 136 #define PDO_FIXED_VOLT_SHIFT    10      /* 50mV units */
 137 #define PDO_FIXED_CURR_SHIFT    0       /* 10mA units */
 138
 139 #define PDO_FIXED_VOLT(mv)      ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
 140 #define PDO_FIXED_CURR(ma)      ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
 141
 142 #define PDO_FIXED(mv, ma, flags)                        \
 143         (PDO_TYPE(PDO_TYPE_FIXED) | (flags) |           \
 144          PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
 145
 146 #define PDO_BATT_MAX_VOLT_SHIFT 20      /* 50mV units */
 147 #define PDO_BATT_MIN_VOLT_SHIFT 10      /* 50mV units */
 148 #define PDO_BATT_MAX_PWR_SHIFT  0       /* 250mW units */
 149
 150 #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
 151 #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
 152 #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
 153
 154 #define PDO_BATT(min_mv, max_mv, max_mw)                        \
 155         (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) |  \
 156          PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
 157
 158 #define PDO_VAR_MAX_VOLT_SHIFT  20      /* 50mV units */
 159 #define PDO_VAR_MIN_VOLT_SHIFT  10      /* 50mV units */
 160 #define PDO_VAR_MAX_CURR_SHIFT  0       /* 10mA units */
 161
 162 #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
 163 #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
 164 #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
 165
 166 #define PDO_VAR(min_mv, max_mv, max_ma)                         \
 167         (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) |    \
 168          PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
 169
 170 static inline enum pd_pdo_type pdo_type(u32 pdo)
 171 {
 172         return (pdo >> PDO_TYPE_SHIFT) & PDO_TYPE_MASK;
 173 }
 174
 175 static inline unsigned int pdo_fixed_voltage(u32 pdo)
 176 {
 177         return ((pdo >> PDO_FIXED_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
 178 }
 179
 180 static inline unsigned int pdo_min_voltage(u32 pdo)
 181 {
 182         return ((pdo >> PDO_VAR_MIN_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
 183 }
 184
 185 static inline unsigned int pdo_max_voltage(u32 pdo)
 186 {
 187         return ((pdo >> PDO_VAR_MAX_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
 188 }
 189
 190 static inline unsigned int pdo_max_current(u32 pdo)
 191 {
 192         return ((pdo >> PDO_VAR_MAX_CURR_SHIFT) & PDO_CURR_MASK) * 10;
 193 }
 194
 195 static inline unsigned int pdo_max_power(u32 pdo)
 196 {
 197         return ((pdo >> PDO_BATT_MAX_PWR_SHIFT) & PDO_PWR_MASK) * 250;
 198 }
 199
 200 /* RDO: Request Data Object */
 201 #define RDO_OBJ_POS_SHIFT       28
 202 #define RDO_OBJ_POS_MASK        0x7
 203 #define RDO_GIVE_BACK           BIT(27) /* Supports reduced operating current */
 204 #define RDO_CAP_MISMATCH        BIT(26) /* Not satisfied by source caps */
 205 #define RDO_USB_COMM            BIT(25) /* USB communications capable */
 206 #define RDO_NO_SUSPEND          BIT(24) /* USB Suspend not supported */
 207
 208 #define RDO_PWR_MASK                    0x3ff
 209 #define RDO_CURR_MASK                   0x3ff
 210
 211 #define RDO_FIXED_OP_CURR_SHIFT         10
 212 #define RDO_FIXED_MAX_CURR_SHIFT        0
 213
 214 #define RDO_OBJ(idx) (((idx) & RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT)
 215
 216 #define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT)
 217 #define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT)
 218
 219 #define RDO_FIXED(idx, op_ma, max_ma, flags)                    \
 220         (RDO_OBJ(idx) | (flags) |                               \
 221          PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma))
 222
 223 #define RDO_BATT_OP_PWR_SHIFT           10      /* 250mW units */
 224 #define RDO_BATT_MAX_PWR_SHIFT          0       /* 250mW units */
 225
 226 #define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT)
 227 #define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT)
 228
 229 #define RDO_BATT(idx, op_mw, max_mw, flags)                     \
 230         (RDO_OBJ(idx) | (flags) |                               \
 231          RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw))
 232
 233 static inline unsigned int rdo_index(u32 rdo)
 234 {
 235         return (rdo >> RDO_OBJ_POS_SHIFT) & RDO_OBJ_POS_MASK;
 236 }
 237
 238 static inline unsigned int rdo_op_current(u32 rdo)
 239 {
 240         return ((rdo >> RDO_FIXED_OP_CURR_SHIFT) & RDO_CURR_MASK) * 10;
 241 }
 242
 243 static inline unsigned int rdo_max_current(u32 rdo)
 244 {
 245         return ((rdo >> RDO_FIXED_MAX_CURR_SHIFT) &
 246                 RDO_CURR_MASK) * 10;
 247 }
 248
 249 static inline unsigned int rdo_op_power(u32 rdo)
 250 {
 251         return ((rdo >> RDO_BATT_OP_PWR_SHIFT) & RDO_PWR_MASK) * 250;
 252 }
 253
 254 static inline unsigned int rdo_max_power(u32 rdo)
 255 {
 256         return ((rdo >> RDO_BATT_MAX_PWR_SHIFT) & RDO_PWR_MASK) * 250;
 257 }
 258
 259 /* USB PD timers and counters */
 260 #define PD_T_NO_RESPONSE        5000    /* 4.5 - 5.5 seconds */
 261 #define PD_T_DB_DETECT          10000   /* 10 - 15 seconds */
 262 #define PD_T_SEND_SOURCE_CAP    150     /* 100 - 200 ms */
 263 #define PD_T_SENDER_RESPONSE    60      /* 24 - 30 ms, relaxed */
 264 #define PD_T_SOURCE_ACTIVITY    45
 265 #define PD_T_SINK_ACTIVITY      135
 266 #define PD_T_SINK_WAIT_CAP      240
 267 #define PD_T_PS_TRANSITION      500
 268 #define PD_T_SRC_TRANSITION     35
 269 #define PD_T_DRP_SNK            40
 270 #define PD_T_DRP_SRC            30
 271 #define PD_T_PS_SOURCE_OFF      920
 272 #define PD_T_PS_SOURCE_ON       480
 273 #define PD_T_PS_HARD_RESET      30
 274 #define PD_T_SRC_RECOVER        760
 275 #define PD_T_SRC_RECOVER_MAX    1000
 276 #define PD_T_SRC_TURN_ON        275
 277 #define PD_T_SAFE_0V            650
 278 #define PD_T_VCONN_SOURCE_ON    100
 279 #define PD_T_SINK_REQUEST       100     /* 100 ms minimum */
 280 #define PD_T_ERROR_RECOVERY     100     /* minimum 25 is insufficient */
 281
 282 #define PD_T_DRP_TRY            100     /* 75 - 150 ms */
 283 #define PD_T_DRP_TRYWAIT        600     /* 400 - 800 ms */
 284
 285 #define PD_T_CC_DEBOUNCE        200     /* 100 - 200 ms */
 286 #define PD_T_PD_DEBOUNCE        20      /* 10 - 20 ms */
 287
 288 #define PD_N_CAPS_COUNT         (PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP)
 289 #define PD_N_HARD_RESET_COUNT   2
 290
 291 #endif /* __LINUX_USB_PD_H */