]>
git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - drivers/staging/typec/pd.h
2 * Copyright 2015-2017 Google, Inc
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.
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.
15 #ifndef __LINUX_USB_PD_H
16 #define __LINUX_USB_PD_H
18 #include <linux/types.h>
19 #include <linux/usb/typec.h>
22 enum pd_ctrl_msg_type
{
30 PD_CTRL_GET_SOURCE_CAP
= 7,
31 PD_CTRL_GET_SINK_CAP
= 8,
34 PD_CTRL_VCONN_SWAP
= 11,
36 PD_CTRL_SOFT_RESET
= 13,
40 enum pd_data_msg_type
{
42 PD_DATA_SOURCE_CAP
= 1,
47 PD_DATA_VENDOR_DEF
= 15,
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
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))
72 #define PD_HEADER_LE(type, pwr, data, id, cnt) \
73 cpu_to_le16(PD_HEADER((type), (pwr), (data), (id), (cnt)))
75 static inline unsigned int pd_header_cnt(u16 header
)
77 return (header
>> PD_HEADER_CNT_SHIFT
) & PD_HEADER_CNT_MASK
;
80 static inline unsigned int pd_header_cnt_le(__le16 header
)
82 return pd_header_cnt(le16_to_cpu(header
));
85 static inline unsigned int pd_header_type(u16 header
)
87 return (header
>> PD_HEADER_TYPE_SHIFT
) & PD_HEADER_TYPE_MASK
;
90 static inline unsigned int pd_header_type_le(__le16 header
)
92 return pd_header_type(le16_to_cpu(header
));
95 #define PD_MAX_PAYLOAD 7
99 __le32 payload
[PD_MAX_PAYLOAD
];
102 /* PDO: Power Data Object */
103 #define PDO_MAX_OBJECTS 7
111 #define PDO_TYPE_SHIFT 30
112 #define PDO_TYPE_MASK 0x3
114 #define PDO_TYPE(t) ((t) << PDO_TYPE_SHIFT)
116 #define PDO_VOLT_MASK 0x3ff
117 #define PDO_CURR_MASK 0x3ff
118 #define PDO_PWR_MASK 0x3ff
120 #define PDO_FIXED_DUAL_ROLE BIT(29) /* Power role swap supported */
121 #define PDO_FIXED_SUSPEND BIT(28) /* USB Suspend supported (Source) */
122 #define PDO_FIXED_HIGHER_CAP BIT(28) /* Requires more than vSafe5V (Sink) */
123 #define PDO_FIXED_EXTPOWER BIT(27) /* Externally powered */
124 #define PDO_FIXED_USB_COMM BIT(26) /* USB communications capable */
125 #define PDO_FIXED_DATA_SWAP BIT(25) /* Data role swap supported */
126 #define PDO_FIXED_VOLT_SHIFT 10 /* 50mV units */
127 #define PDO_FIXED_CURR_SHIFT 0 /* 10mA units */
129 #define PDO_FIXED_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
130 #define PDO_FIXED_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
132 #define PDO_FIXED(mv, ma, flags) \
133 (PDO_TYPE(PDO_TYPE_FIXED) | (flags) | \
134 PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
136 #define PDO_BATT_MAX_VOLT_SHIFT 20 /* 50mV units */
137 #define PDO_BATT_MIN_VOLT_SHIFT 10 /* 50mV units */
138 #define PDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
140 #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
141 #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
142 #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
144 #define PDO_BATT(min_mv, max_mv, max_mw) \
145 (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) | \
146 PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
148 #define PDO_VAR_MAX_VOLT_SHIFT 20 /* 50mV units */
149 #define PDO_VAR_MIN_VOLT_SHIFT 10 /* 50mV units */
150 #define PDO_VAR_MAX_CURR_SHIFT 0 /* 10mA units */
152 #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
153 #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
154 #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
156 #define PDO_VAR(min_mv, max_mv, max_ma) \
157 (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) | \
158 PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
160 static inline enum pd_pdo_type
pdo_type(u32 pdo
)
162 return (pdo
>> PDO_TYPE_SHIFT
) & PDO_TYPE_MASK
;
165 static inline unsigned int pdo_fixed_voltage(u32 pdo
)
167 return ((pdo
>> PDO_FIXED_VOLT_SHIFT
) & PDO_VOLT_MASK
) * 50;
170 static inline unsigned int pdo_min_voltage(u32 pdo
)
172 return ((pdo
>> PDO_VAR_MIN_VOLT_SHIFT
) & PDO_VOLT_MASK
) * 50;
175 static inline unsigned int pdo_max_voltage(u32 pdo
)
177 return ((pdo
>> PDO_VAR_MAX_VOLT_SHIFT
) & PDO_VOLT_MASK
) * 50;
180 static inline unsigned int pdo_max_current(u32 pdo
)
182 return ((pdo
>> PDO_VAR_MAX_CURR_SHIFT
) & PDO_CURR_MASK
) * 10;
185 static inline unsigned int pdo_max_power(u32 pdo
)
187 return ((pdo
>> PDO_BATT_MAX_PWR_SHIFT
) & PDO_PWR_MASK
) * 250;
190 /* RDO: Request Data Object */
191 #define RDO_OBJ_POS_SHIFT 28
192 #define RDO_OBJ_POS_MASK 0x7
193 #define RDO_GIVE_BACK BIT(27) /* Supports reduced operating current */
194 #define RDO_CAP_MISMATCH BIT(26) /* Not satisfied by source caps */
195 #define RDO_USB_COMM BIT(25) /* USB communications capable */
196 #define RDO_NO_SUSPEND BIT(24) /* USB Suspend not supported */
198 #define RDO_PWR_MASK 0x3ff
199 #define RDO_CURR_MASK 0x3ff
201 #define RDO_FIXED_OP_CURR_SHIFT 10
202 #define RDO_FIXED_MAX_CURR_SHIFT 0
204 #define RDO_OBJ(idx) (((idx) & RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT)
206 #define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT)
207 #define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT)
209 #define RDO_FIXED(idx, op_ma, max_ma, flags) \
210 (RDO_OBJ(idx) | (flags) | \
211 PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma))
213 #define RDO_BATT_OP_PWR_SHIFT 10 /* 250mW units */
214 #define RDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
216 #define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT)
217 #define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT)
219 #define RDO_BATT(idx, op_mw, max_mw, flags) \
220 (RDO_OBJ(idx) | (flags) | \
221 RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw))
223 static inline unsigned int rdo_index(u32 rdo
)
225 return (rdo
>> RDO_OBJ_POS_SHIFT
) & RDO_OBJ_POS_MASK
;
228 static inline unsigned int rdo_op_current(u32 rdo
)
230 return ((rdo
>> RDO_FIXED_OP_CURR_SHIFT
) & RDO_CURR_MASK
) * 10;
233 static inline unsigned int rdo_max_current(u32 rdo
)
235 return ((rdo
>> RDO_FIXED_MAX_CURR_SHIFT
) &
239 static inline unsigned int rdo_op_power(u32 rdo
)
241 return ((rdo
>> RDO_BATT_OP_PWR_SHIFT
) & RDO_PWR_MASK
) * 250;
244 static inline unsigned int rdo_max_power(u32 rdo
)
246 return ((rdo
>> RDO_BATT_MAX_PWR_SHIFT
) & RDO_PWR_MASK
) * 250;
249 /* USB PD timers and counters */
250 #define PD_T_NO_RESPONSE 5000 /* 4.5 - 5.5 seconds */
251 #define PD_T_DB_DETECT 10000 /* 10 - 15 seconds */
252 #define PD_T_SEND_SOURCE_CAP 150 /* 100 - 200 ms */
253 #define PD_T_SENDER_RESPONSE 60 /* 24 - 30 ms, relaxed */
254 #define PD_T_SOURCE_ACTIVITY 45
255 #define PD_T_SINK_ACTIVITY 135
256 #define PD_T_SINK_WAIT_CAP 240
257 #define PD_T_PS_TRANSITION 500
258 #define PD_T_SRC_TRANSITION 35
259 #define PD_T_DRP_SNK 40
260 #define PD_T_DRP_SRC 30
261 #define PD_T_PS_SOURCE_OFF 920
262 #define PD_T_PS_SOURCE_ON 480
263 #define PD_T_PS_HARD_RESET 30
264 #define PD_T_SRC_RECOVER 760
265 #define PD_T_SRC_RECOVER_MAX 1000
266 #define PD_T_SRC_TURN_ON 275
267 #define PD_T_SAFE_0V 650
268 #define PD_T_VCONN_SOURCE_ON 100
269 #define PD_T_SINK_REQUEST 100 /* 100 ms minimum */
270 #define PD_T_ERROR_RECOVERY 100 /* minimum 25 is insufficient */
272 #define PD_T_DRP_TRY 100 /* 75 - 150 ms */
273 #define PD_T_DRP_TRYWAIT 600 /* 400 - 800 ms */
275 #define PD_T_CC_DEBOUNCE 200 /* 100 - 200 ms */
276 #define PD_T_PD_DEBOUNCE 20 /* 10 - 20 ms */
278 #define PD_N_CAPS_COUNT (PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP)
279 #define PD_N_HARD_RESET_COUNT 2
281 #endif /* __LINUX_USB_PD_H */