1 /* SPDX-License-Identifier: GPL-2.0 */
2
3 #ifndef __DRIVER_USB_TYPEC_UCSI_H
4 #define __DRIVER_USB_TYPEC_UCSI_H
5
6 #include <linux/bitops.h>
7 #include <linux/bitmap.h>
8 #include <linux/completion.h>
9 #include <linux/device.h>
10 #include <linux/power_supply.h>
11 #include <linux/types.h>
12 #include <linux/usb/typec.h>
13 #include <linux/usb/pd.h>
14 #include <linux/usb/role.h>
15 #include <linux/unaligned.h>
16
17 /* -------------------------------------------------------------------------- */
18
19 struct ucsi;
20 struct ucsi_altmode;
21 struct ucsi_connector;
22 struct dentry;
23
24 /* UCSI offsets (Bytes) */
25 #define UCSI_VERSION 0
26 #define UCSI_CCI 4
27 #define UCSI_CONTROL 8
28 #define UCSI_MESSAGE_IN 16
29 #define UCSI_MESSAGE_OUT 32
30 #define UCSIv2_MESSAGE_OUT 272
31
32 /* Define maximum lengths for message buffers */
33 #define UCSI_MAX_MESSAGE_IN_LENGTH 256
34 #define UCSI_MAX_MESSAGE_OUT_LENGTH 256
35
36 /* UCSI versions */
37 #define UCSI_VERSION_1_0 0x0100
38 #define UCSI_VERSION_1_1 0x0110
39 #define UCSI_VERSION_1_2 0x0120
40 #define UCSI_VERSION_2_0 0x0200
41 #define UCSI_VERSION_2_1 0x0210
42 #define UCSI_VERSION_3_0 0x0300
43
44 #define UCSI_BCD_GET_MAJOR(_v_) (((_v_) >> 8) & 0xFF)
45 #define UCSI_BCD_GET_MINOR(_v_) (((_v_) >> 4) & 0x0F)
46 #define UCSI_BCD_GET_SUBMINOR(_v_) ((_v_) & 0x0F)
47
48 /*
49 * Per USB PD 3.2, Section 6.2.1.1.5, the spec revision is represented by 2 bits
50 * 0b00 = 1.0, 0b01 = 2.0, 0b10 = 3.0, 0b11 = Reserved, Shall NOT be used.
51 */
52 #define UCSI_SPEC_REVISION_TO_BCD(_v_) (((_v_) + 1) << 8)
53
54 /* Command Status and Connector Change Indication (CCI) bits */
55 #define UCSI_CCI_CONNECTOR(_c_) (((_c_) & GENMASK(7, 1)) >> 1)
56 #define UCSI_CCI_LENGTH(_c_) (((_c_) & GENMASK(15, 8)) >> 8)
57 #define UCSI_SET_CCI_LENGTH(_c_) ((_c_) << 8)
58 #define UCSI_CCI_NOT_SUPPORTED BIT(25)
59 #define UCSI_CCI_CANCEL_COMPLETE BIT(26)
60 #define UCSI_CCI_RESET_COMPLETE BIT(27)
61 #define UCSI_CCI_BUSY BIT(28)
62 #define UCSI_CCI_ACK_COMPLETE BIT(29)
63 #define UCSI_CCI_ERROR BIT(30)
64 #define UCSI_CCI_COMMAND_COMPLETE BIT(31)
65
66 /**
67 * struct ucsi_operations - UCSI I/O operations
68 * @read_version: Read implemented UCSI version
69 * @read_cci: Read CCI register
70 * @poll_cci: Read CCI register while polling with notifications disabled
71 * @read_message_in: Read message data from UCSI
72 * @write_message_out: Write message data to UCSI
73 * @sync_control: Blocking control operation
74 * @async_control: Non-blocking control operation
75 * @update_altmodes: Squashes duplicate DP altmodes
76 * @update_connector: Update connector capabilities before registering
77 * @connector_status: Updates connector status, called holding connector lock
78 *
79 * Read and write routines for UCSI interface. @sync_write must wait for the
80 * Command Completion Event from the PPM before returning, and @async_write must
81 * return immediately after sending the data to the PPM.
82 */
83 struct ucsi_operations {
84 int (*read_version)(struct ucsi *ucsi, u16 *version);
85 int (*read_cci)(struct ucsi *ucsi, u32 *cci);
86 int (*poll_cci)(struct ucsi *ucsi, u32 *cci);
87 int (*read_message_in)(struct ucsi *ucsi, void *val, size_t val_len);
88 int (*write_message_out)(struct ucsi *ucsi, void *data, size_t data_len);
89 int (*sync_control)(struct ucsi *ucsi, u64 command, u32 *cci);
90 int (*async_control)(struct ucsi *ucsi, u64 command);
91 bool (*update_altmodes)(struct ucsi *ucsi, u8 recipient,
92 struct ucsi_altmode *orig,
93 struct ucsi_altmode *updated);
94 void (*update_connector)(struct ucsi_connector *con);
95 void (*connector_status)(struct ucsi_connector *con);
96 };
97
98 struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops);
99 void ucsi_destroy(struct ucsi *ucsi);
100 int ucsi_register(struct ucsi *ucsi);
101 void ucsi_unregister(struct ucsi *ucsi);
102 void *ucsi_get_drvdata(struct ucsi *ucsi);
103 void ucsi_set_drvdata(struct ucsi *ucsi, void *data);
104 bool ucsi_con_mutex_lock(struct ucsi_connector *con);
105 void ucsi_con_mutex_unlock(struct ucsi_connector *con);
106
107 void ucsi_connector_change(struct ucsi *ucsi, u8 num);
108
109 /* -------------------------------------------------------------------------- */
110
111 /* Commands */
112 #define UCSI_PPM_RESET 0x01
113 #define UCSI_CANCEL 0x02
114 #define UCSI_CONNECTOR_RESET 0x03
115 #define UCSI_ACK_CC_CI 0x04
116 #define UCSI_SET_NOTIFICATION_ENABLE 0x05
117 #define UCSI_GET_CAPABILITY 0x06
118 #define UCSI_GET_CAPABILITY_SIZE 128
119 #define UCSI_GET_CONNECTOR_CAPABILITY 0x07
120 #define UCSI_GET_CONNECTOR_CAPABILITY_SIZE 32
121 #define UCSI_SET_CCOM 0x08
122 #define UCSI_SET_UOR 0x09
123 #define UCSI_SET_PDM 0x0a
124 #define UCSI_SET_PDR 0x0b
125 #define UCSI_GET_ALTERNATE_MODES 0x0c
126 #define UCSI_GET_CAM_SUPPORTED 0x0d
127 #define UCSI_GET_CURRENT_CAM 0x0e
128 #define UCSI_SET_NEW_CAM 0x0f
129 #define UCSI_GET_PDOS 0x10
130 #define UCSI_GET_CABLE_PROPERTY 0x11
131 #define UCSI_GET_CABLE_PROPERTY_SIZE 64
132 #define UCSI_GET_CONNECTOR_STATUS 0x12
133 #define UCSI_GET_CONNECTOR_STATUS_SIZE 152
134 #define UCSI_GET_ERROR_STATUS 0x13
135 #define UCSI_SET_POWER_LEVEL 0x14
136 #define UCSI_GET_ATTENTION_VDO 0x16
137 #define UCSI_GET_PD_MESSAGE 0x15
138 #define UCSI_GET_CAM_CS 0x18
139 #define UCSI_SET_SINK_PATH 0x1c
140 #define UCSI_SET_PDOS 0x1d
141 #define UCSI_READ_POWER_LEVEL 0x1e
142 #define UCSI_SET_USB 0x21
143 #define UCSI_GET_LPM_PPM_INFO 0x22
144
145 #define UCSI_CONNECTOR_NUMBER(_num_) ((u64)(_num_) << 16)
146 #define UCSI_COMMAND(_cmd_) ((_cmd_) & 0xff)
147
148 #define UCSI_GET_ALTMODE_GET_CONNECTOR_NUMBER(_cmd_) (((_cmd_) >> 24) & GENMASK(6, 0))
149 #define UCSI_DEFAULT_GET_CONNECTOR_NUMBER(_cmd_) (((_cmd_) >> 16) & GENMASK(6, 0))
150
151 /* CONNECTOR_RESET command bits */
152 #define UCSI_CONNECTOR_RESET_HARD_VER_1_0 BIT(23) /* Deprecated in v1.1 */
153 #define UCSI_CONNECTOR_RESET_DATA_VER_2_0 BIT(23) /* Redefined in v2.0 */
154
155 /* ACK_CC_CI bits */
156 #define UCSI_ACK_CONNECTOR_CHANGE BIT(16)
157 #define UCSI_ACK_COMMAND_COMPLETE BIT(17)
158
159 /* SET_NOTIFICATION_ENABLE command bits */
160 #define UCSI_ENABLE_NTFY_CMD_COMPLETE BIT_ULL(16)
161 #define UCSI_ENABLE_NTFY_EXT_PWR_SRC_CHANGE BIT_ULL(17)
162 #define UCSI_ENABLE_NTFY_PWR_OPMODE_CHANGE BIT_ULL(18)
163 #define UCSI_ENABLE_NTFY_ATTENTION BIT_ULL(19)
164 #define UCSI_ENABLE_NTFY_LPM_FW_UPDATE_REQ BIT_ULL(20)
165 #define UCSI_ENABLE_NTFY_CAP_CHANGE BIT_ULL(21)
166 #define UCSI_ENABLE_NTFY_PWR_LEVEL_CHANGE BIT_ULL(22)
167 #define UCSI_ENABLE_NTFY_PD_RESET_COMPLETE BIT_ULL(23)
168 #define UCSI_ENABLE_NTFY_CAM_CHANGE BIT_ULL(24)
169 #define UCSI_ENABLE_NTFY_BAT_STATUS_CHANGE BIT_ULL(25)
170 #define UCSI_ENABLE_NTFY_SECURITY_REQ_PARTNER BIT_ULL(26)
171 #define UCSI_ENABLE_NTFY_PARTNER_CHANGE BIT_ULL(27)
172 #define UCSI_ENABLE_NTFY_PWR_DIR_CHANGE BIT_ULL(28)
173 #define UCSI_ENABLE_NTFY_SET_RETIMER_MODE BIT_ULL(29)
174 #define UCSI_ENABLE_NTFY_CONNECTOR_CHANGE BIT_ULL(30)
175 #define UCSI_ENABLE_NTFY_ERROR BIT_ULL(31)
176 #define UCSI_ENABLE_NTFY_SINK_PATH_STS_CHANGE BIT_ULL(32)
177 #define UCSI_ENABLE_NTFY_ALL 0xdbe70000
178
179 /* SET_UOR command bits */
180 #define UCSI_SET_UOR_ROLE(_r_) (((_r_) == TYPEC_HOST ? 1 : 2) << 23)
181 #define UCSI_SET_UOR_ACCEPT_ROLE_SWAPS BIT(25)
182
183 /* SET_PDF command bits */
184 #define UCSI_SET_PDR_ROLE(_r_) (((_r_) == TYPEC_SOURCE ? 1 : 2) << 23)
185 #define UCSI_SET_PDR_ACCEPT_ROLE_SWAPS BIT(25)
186
187 /* GET_ALTERNATE_MODES command bits */
188 #define UCSI_ALTMODE_RECIPIENT(_r_) (((_r_) >> 16) & 0x7)
189 #define UCSI_GET_ALTMODE_RECIPIENT(_r_) ((u64)(_r_) << 16)
190 #define UCSI_RECIPIENT_CON 0
191 #define UCSI_RECIPIENT_SOP 1
192 #define UCSI_RECIPIENT_SOP_P 2
193 #define UCSI_RECIPIENT_SOP_PP 3
194 #define UCSI_GET_ALTMODE_CONNECTOR_NUMBER(_r_) ((u64)(_r_) << 24)
195 #define UCSI_ALTMODE_OFFSET(_r_) (((_r_) >> 32) & 0xff)
196 #define UCSI_GET_ALTMODE_OFFSET(_r_) ((u64)(_r_) << 32)
197 #define UCSI_GET_ALTMODE_NUM_ALTMODES(_r_) ((u64)(_r_) << 40)
198
199 /* GET_PDOS command bits */
200 #define UCSI_GET_PDOS_PARTNER_PDO(_r_) ((u64)(_r_) << 23)
201 #define UCSI_GET_PDOS_PDO_OFFSET(_r_) ((u64)(_r_) << 24)
202 #define UCSI_GET_PDOS_NUM_PDOS(_r_) ((u64)(_r_) << 32)
203 #define UCSI_MAX_PDOS (4)
204 #define UCSI_GET_PDOS_SRC_PDOS ((u64)1 << 34)
205
206 /* GET_PD_MESSAGE command bits */
207 #define UCSI_GET_PD_MESSAGE_RECIPIENT(_r_) ((u64)(_r_) << 23)
208 #define UCSI_GET_PD_MESSAGE_OFFSET(_r_) ((u64)(_r_) << 26)
209 #define UCSI_GET_PD_MESSAGE_BYTES(_r_) ((u64)(_r_) << 34)
210 #define UCSI_GET_PD_MESSAGE_TYPE(_r_) ((u64)(_r_) << 42)
211 #define UCSI_GET_PD_MESSAGE_TYPE_SNK_CAP_EXT 0
212 #define UCSI_GET_PD_MESSAGE_TYPE_SRC_CAP_EXT 1
213 #define UCSI_GET_PD_MESSAGE_TYPE_BAT_CAP 2
214 #define UCSI_GET_PD_MESSAGE_TYPE_BAT_STAT 3
215 #define UCSI_GET_PD_MESSAGE_TYPE_IDENTITY 4
216 #define UCSI_GET_PD_MESSAGE_TYPE_REVISION 5
217
218 /* -------------------------------------------------------------------------- */
219
220 /* Error information returned by PPM in response to GET_ERROR_STATUS command. */
221 #define UCSI_ERROR_UNREGONIZED_CMD BIT(0)
222 #define UCSI_ERROR_INVALID_CON_NUM BIT(1)
223 #define UCSI_ERROR_INVALID_CMD_ARGUMENT BIT(2)
224 #define UCSI_ERROR_INCOMPATIBLE_PARTNER BIT(3)
225 #define UCSI_ERROR_CC_COMMUNICATION_ERR BIT(4)
226 #define UCSI_ERROR_DEAD_BATTERY BIT(5)
227 #define UCSI_ERROR_CONTRACT_NEGOTIATION_FAIL BIT(6)
228 #define UCSI_ERROR_OVERCURRENT BIT(7)
229 #define UCSI_ERROR_UNDEFINED BIT(8)
230 #define UCSI_ERROR_PARTNER_REJECTED_SWAP BIT(9)
231 #define UCSI_ERROR_HARD_RESET BIT(10)
232 #define UCSI_ERROR_PPM_POLICY_CONFLICT BIT(11)
233 #define UCSI_ERROR_SWAP_REJECTED BIT(12)
234 #define UCSI_ERROR_REVERSE_CURRENT_PROTECTION BIT(13)
235 #define UCSI_ERROR_SET_SINK_PATH_REJECTED BIT(14)
236
237 #define UCSI_SET_NEW_CAM_ENTER(x) (((x) >> 23) & 0x1)
238 #define UCSI_SET_NEW_CAM_GET_AM(x) (((x) >> 24) & 0xff)
239 #define UCSI_SET_NEW_CAM_AM_MASK (0xff << 24)
240 #define UCSI_SET_NEW_CAM_SET_AM(x) (((x) & 0xff) << 24)
241 #define UCSI_CMD_CONNECTOR_MASK (0x7)
242
243 /* Data structure filled by PPM in response to GET_CAPABILITY command. */
244 struct ucsi_capability {
245 u32 attributes;
246 #define UCSI_CAP_ATTR_DISABLE_STATE BIT(0)
247 #define UCSI_CAP_ATTR_BATTERY_CHARGING BIT(1)
248 #define UCSI_CAP_ATTR_USB_PD BIT(2)
249 #define UCSI_CAP_ATTR_TYPEC_CURRENT BIT(6)
250 #define UCSI_CAP_ATTR_POWER_AC_SUPPLY BIT(8)
251 #define UCSI_CAP_ATTR_POWER_OTHER BIT(10)
252 #define UCSI_CAP_ATTR_POWER_VBUS BIT(14)
253 u8 num_connectors;
254 u16 features;
255 #define UCSI_CAP_SET_UOM BIT(0)
256 #define UCSI_CAP_SET_PDM BIT(1)
257 #define UCSI_CAP_ALT_MODE_DETAILS BIT(2)
258 #define UCSI_CAP_ALT_MODE_OVERRIDE BIT(3)
259 #define UCSI_CAP_PDO_DETAILS BIT(4)
260 #define UCSI_CAP_CABLE_DETAILS BIT(5)
261 #define UCSI_CAP_EXT_SUPPLY_NOTIFICATIONS BIT(6)
262 #define UCSI_CAP_PD_RESET BIT(7)
263 #define UCSI_CAP_GET_PD_MESSAGE BIT(8)
264 #define UCSI_CAP_GET_ATTENTION_VDO BIT(9)
265 #define UCSI_CAP_FW_UPDATE_REQUEST BIT(10)
266 #define UCSI_CAP_NEGOTIATED_PWR_LEVEL_CHANGE BIT(11)
267 #define UCSI_CAP_SECURITY_REQUEST BIT(12)
268 #define UCSI_CAP_SET_RETIMER_MODE BIT(13)
269 #define UCSI_CAP_CHUNKING_SUPPORT BIT(14)
270 u8 reserved_1;
271 u8 num_alt_modes;
272 u8 reserved_2;
273 u16 bc_version;
274 u16 pd_version;
275 u16 typec_version;
276 } __packed;
277
278 struct ucsi_altmode {
279 u16 svid;
280 u32 mid;
281 } __packed;
282
283 /* Data structure filled by PPM in response to GET_CABLE_PROPERTY command. */
284 struct ucsi_cable_property {
285 u16 speed_supported;
286 u8 current_capability;
287 u8 flags;
288 #define UCSI_CABLE_PROP_FLAG_VBUS_IN_CABLE BIT(0)
289 #define UCSI_CABLE_PROP_FLAG_ACTIVE_CABLE BIT(1)
290 #define UCSI_CABLE_PROP_FLAG_DIRECTIONALITY BIT(2)
291 #define UCSI_CABLE_PROP_FLAG_PLUG_TYPE(_f_) (((_f_) & GENMASK(4, 3)) >> 3)
292 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_A 0
293 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_B 1
294 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_C 2
295 #define UCSI_CABLE_PROPERTY_PLUG_OTHER 3
296 #define UCSI_CABLE_PROP_FLAG_MODE_SUPPORT BIT(5)
297 #define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_) (((_f_) & GENMASK(7, 6)) >> 6)
298 #define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV_AS_BCD(_f_) \
299 UCSI_SPEC_REVISION_TO_BCD(UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_))
300 u8 latency;
301 } __packed;
302
303 /* Get Connector Capability Fields. */
304 #define UCSI_CONCAP_OPMODE UCSI_DECLARE_BITFIELD(0, 0, 8)
305 #define UCSI_CONCAP_OPMODE_DFP UCSI_DECLARE_BITFIELD(0, 0, 1)
306 #define UCSI_CONCAP_OPMODE_UFP UCSI_DECLARE_BITFIELD(0, 1, 1)
307 #define UCSI_CONCAP_OPMODE_DRP UCSI_DECLARE_BITFIELD(0, 2, 1)
308 #define UCSI_CONCAP_OPMODE_AUDIO_ACCESSORY UCSI_DECLARE_BITFIELD(0, 3, 1)
309 #define UCSI_CONCAP_OPMODE_DEBUG_ACCESSORY UCSI_DECLARE_BITFIELD(0, 4, 1)
310 #define UCSI_CONCAP_OPMODE_USB2 UCSI_DECLARE_BITFIELD(0, 5, 1)
311 #define UCSI_CONCAP_OPMODE_USB3 UCSI_DECLARE_BITFIELD(0, 6, 1)
312 #define UCSI_CONCAP_OPMODE_ALT_MODE UCSI_DECLARE_BITFIELD(0, 7, 1)
313 #define UCSI_CONCAP_PROVIDER UCSI_DECLARE_BITFIELD(0, 8, 1)
314 #define UCSI_CONCAP_CONSUMER UCSI_DECLARE_BITFIELD(0, 9, 1)
315 #define UCSI_CONCAP_SWAP_TO_DFP_V1_1 UCSI_DECLARE_BITFIELD_V1_1(10, 1)
316 #define UCSI_CONCAP_SWAP_TO_UFP_V1_1 UCSI_DECLARE_BITFIELD_V1_1(11, 1)
317 #define UCSI_CONCAP_SWAP_TO_SRC_V1_1 UCSI_DECLARE_BITFIELD_V1_1(12, 1)
318 #define UCSI_CONCAP_SWAP_TO_SNK_V1_1 UCSI_DECLARE_BITFIELD_V1_1(13, 1)
319 #define UCSI_CONCAP_EXT_OPMODE_V2_0 UCSI_DECLARE_BITFIELD_V2_0(14, 8)
320 #define UCSI_CONCAP_EXT_OPMODE_USB4_GEN2_V2_0 UCSI_DECLARE_BITFIELD_V2_0(14, 1)
321 #define UCSI_CONCAP_EXT_OPMODE_EPR_SRC_V2_0 UCSI_DECLARE_BITFIELD_V2_0(15, 1)
322 #define UCSI_CONCAP_EXT_OPMODE_EPR_SINK_V2_0 UCSI_DECLARE_BITFIELD_V2_0(16, 1)
323 #define UCSI_CONCAP_EXT_OPMODE_USB4_GEN3_V2_0 UCSI_DECLARE_BITFIELD_V2_0(17, 1)
324 #define UCSI_CONCAP_EXT_OPMODE_USB4_GEN4_V2_0 UCSI_DECLARE_BITFIELD_V2_0(18, 1)
325 #define UCSI_CONCAP_MISC_V2_0 UCSI_DECLARE_BITFIELD_V2_0(22, 4)
326 #define UCSI_CONCAP_MISC_FW_UPDATE_V2_0 UCSI_DECLARE_BITFIELD_V2_0(22, 1)
327 #define UCSI_CONCAP_MISC_SECURITY_V2_0 UCSI_DECLARE_BITFIELD_V2_0(23, 1)
328 #define UCSI_CONCAP_REV_CURR_PROT_SUPPORT_V2_0 UCSI_DECLARE_BITFIELD_V2_0(26, 1)
329 #define UCSI_CONCAP_PARTNER_PD_REVISION_V2_1 UCSI_DECLARE_BITFIELD_V2_1(27, 2)
330
331 /* Helpers for USB capability checks. */
332 #define UCSI_CONCAP_USB2_SUPPORT(_con_) UCSI_CONCAP((_con_), OPMODE_USB2)
333 #define UCSI_CONCAP_USB3_SUPPORT(_con_) UCSI_CONCAP((_con_), OPMODE_USB3)
334 #define UCSI_CONCAP_USB4_SUPPORT(_con_) \
335 ((_con_)->ucsi->version >= UCSI_VERSION_2_0 && \
336 (UCSI_CONCAP((_con_), EXT_OPMODE_USB4_GEN2_V2_0) | \
337 UCSI_CONCAP((_con_), EXT_OPMODE_USB4_GEN3_V2_0) | \
338 UCSI_CONCAP((_con_), EXT_OPMODE_USB4_GEN4_V2_0)))
339
340 /* Get Connector Status Fields. */
341 #define UCSI_CONSTAT_CHANGE UCSI_DECLARE_BITFIELD(0, 0, 16)
342 #define UCSI_CONSTAT_PWR_OPMODE UCSI_DECLARE_BITFIELD(0, 16, 3)
343 #define UCSI_CONSTAT_PWR_OPMODE_NONE 0
344 #define UCSI_CONSTAT_PWR_OPMODE_DEFAULT 1
345 #define UCSI_CONSTAT_PWR_OPMODE_BC 2
346 #define UCSI_CONSTAT_PWR_OPMODE_PD 3
347 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC1_5 4
348 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC3_0 5
349 #define UCSI_CONSTAT_CONNECTED UCSI_DECLARE_BITFIELD(0, 19, 1)
350 #define UCSI_CONSTAT_PWR_DIR UCSI_DECLARE_BITFIELD(0, 20, 1)
351 #define UCSI_CONSTAT_PARTNER_FLAGS UCSI_DECLARE_BITFIELD(0, 21, 8)
352 #define UCSI_CONSTAT_PARTNER_FLAG_USB UCSI_DECLARE_BITFIELD(0, 21, 1)
353 #define UCSI_CONSTAT_PARTNER_FLAG_ALT_MODE UCSI_DECLARE_BITFIELD(0, 22, 1)
354 #define UCSI_CONSTAT_PARTNER_FLAG_USB4_GEN3 UCSI_DECLARE_BITFIELD(0, 23, 1)
355 #define UCSI_CONSTAT_PARTNER_FLAG_USB4_GEN4 UCSI_DECLARE_BITFIELD(0, 24, 1)
356 #define UCSI_CONSTAT_PARTNER_TYPE UCSI_DECLARE_BITFIELD(0, 29, 3)
357 #define UCSI_CONSTAT_PARTNER_TYPE_DFP 1
358 #define UCSI_CONSTAT_PARTNER_TYPE_UFP 2
359 #define UCSI_CONSTAT_PARTNER_TYPE_CABLE 3 /* Powered Cable */
360 #define UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP 4 /* Powered Cable */
361 #define UCSI_CONSTAT_PARTNER_TYPE_DEBUG 5
362 #define UCSI_CONSTAT_PARTNER_TYPE_AUDIO 6
363 #define UCSI_CONSTAT_RDO UCSI_DECLARE_BITFIELD(0, 32, 32)
364 #define UCSI_CONSTAT_BC_STATUS UCSI_DECLARE_BITFIELD(0, 64, 2)
365 #define UCSI_CONSTAT_BC_NOT_CHARGING 0
366 #define UCSI_CONSTAT_BC_NOMINAL_CHARGING 1
367 #define UCSI_CONSTAT_BC_SLOW_CHARGING 2
368 #define UCSI_CONSTAT_BC_TRICKLE_CHARGING 3
369 #define UCSI_CONSTAT_PD_VERSION_V1_2 UCSI_DECLARE_BITFIELD_V1_2(70, 16)
370 #define UCSI_CONSTAT_ORIENTATION UCSI_DECLARE_BITFIELD_V2_0(86, 1)
371 #define UCSI_CONSTAT_ORIENTATION_NORMAL 0
372 #define UCSI_CONSTAT_ORIENTATION_REVERSE 1
373 #define UCSI_CONSTAT_SINK_PATH_STATUS_V2_0 UCSI_DECLARE_BITFIELD_V2_0(87, 1)
374 #define UCSI_CONSTAT_SINK_PATH_DISABLED 0
375 #define UCSI_CONSTAT_SINK_PATH_ENABLED 1
376 #define UCSI_CONSTAT_PWR_READING_READY_V2_1 UCSI_DECLARE_BITFIELD_V2_1(89, 1)
377 #define UCSI_CONSTAT_CURRENT_SCALE_V2_1 UCSI_DECLARE_BITFIELD_V2_1(90, 3)
378 #define UCSI_CONSTAT_PEAK_CURRENT_V2_1 UCSI_DECLARE_BITFIELD_V2_1(93, 16)
379 #define UCSI_CONSTAT_AVG_CURRENT_V2_1 UCSI_DECLARE_BITFIELD_V2_1(109, 16)
380 #define UCSI_CONSTAT_VOLTAGE_SCALE_V2_1 UCSI_DECLARE_BITFIELD_V2_1(125, 4)
381 #define UCSI_CONSTAT_VBUS_VOLTAGE_V2_1 UCSI_DECLARE_BITFIELD_V2_1(129, 16)
382 #define UCSI_CONSTAT_CURR_SCALE_MULT 5
383 #define UCSI_CONSTAT_VOLT_SCALE_MULT 5
384
385 /* Connector Status Change Bits. */
386 #define UCSI_CONSTAT_EXT_SUPPLY_CHANGE BIT(1)
387 #define UCSI_CONSTAT_POWER_OPMODE_CHANGE BIT(2)
388 #define UCSI_CONSTAT_PDOS_CHANGE BIT(5)
389 #define UCSI_CONSTAT_POWER_LEVEL_CHANGE BIT(6)
390 #define UCSI_CONSTAT_PD_RESET_COMPLETE BIT(7)
391 #define UCSI_CONSTAT_CAM_CHANGE BIT(8)
392 #define UCSI_CONSTAT_BC_CHANGE BIT(9)
393 #define UCSI_CONSTAT_PARTNER_CHANGE BIT(11)
394 #define UCSI_CONSTAT_POWER_DIR_CHANGE BIT(12)
395 #define UCSI_CONSTAT_SINK_PATH_CHANGE BIT(13)
396 #define UCSI_CONSTAT_CONNECT_CHANGE BIT(14)
397 #define UCSI_CONSTAT_ERROR BIT(15)
398
399 #define UCSI_DECLARE_BITFIELD_V1_1(_offset_, _size_) \
400 UCSI_DECLARE_BITFIELD(UCSI_VERSION_1_1, (_offset_), (_size_))
401 #define UCSI_DECLARE_BITFIELD_V1_2(_offset_, _size_) \
402 UCSI_DECLARE_BITFIELD(UCSI_VERSION_1_2, (_offset_), (_size_))
403 #define UCSI_DECLARE_BITFIELD_V2_0(_offset_, _size_) \
404 UCSI_DECLARE_BITFIELD(UCSI_VERSION_2_0, (_offset_), (_size_))
405 #define UCSI_DECLARE_BITFIELD_V2_1(_offset_, _size_) \
406 UCSI_DECLARE_BITFIELD(UCSI_VERSION_2_1, (_offset_), (_size_))
407 #define UCSI_DECLARE_BITFIELD_V3_0(_offset_, _size_) \
408 UCSI_DECLARE_BITFIELD(UCSI_VERSION_3_0, (_offset_), (_size_))
409
410 #define UCSI_DECLARE_BITFIELD(_ver_, _offset_, _size_) \
411 (struct ucsi_bitfield) { \
412 .version = _ver_, \
413 .offset = _offset_, \
414 .size = _size_, \
415 }
416
417 struct ucsi_bitfield {
418 const u16 version;
419 const u8 offset;
420 const u8 size;
421 };
422
423 /**
424 * ucsi_bitfield_read - Read a field from UCSI command response
425 * @_map_: UCSI command response
426 * @_field_: The field offset in the response data structure
427 * @_ver_: UCSI version where the field was introduced
428 *
429 * Reads the fields in the command responses by first checking that the field is
430 * valid with the UCSI interface version that is used in the system.
431 * @_ver_ is the minimum UCSI version for the @_field_. If the UCSI interface is
432 * older than @_ver_, a warning is generated.
433 *
434 * Caveats:
435 * - Removed fields are not checked - @_ver_ is just the minimum UCSI version.
436 *
437 * Returns the value of @_field_, or 0 when the UCSI interface is older than
438 * @_ver_.
439 */
440 #define ucsi_bitfield_read(_map_, _field_, _ver_) \
441 ({ \
442 struct ucsi_bitfield f = (_field_); \
443 WARN((_ver_) < f.version, \
444 "Access to unsupported field at offset 0x%x (need version %04x)", \
445 f.offset, f.version) ? 0 : \
446 bitmap_read((_map_), f.offset, f.size); \
447 })
448
449 /* Helpers to access cached command responses. */
450 #define UCSI_CONCAP(_con_, _field_) \
451 ucsi_bitfield_read((_con_)->cap, UCSI_CONCAP_##_field_, (_con_)->ucsi->version)
452
453 #define UCSI_CONSTAT(_con_, _field_) \
454 ucsi_bitfield_read((_con_)->status, UCSI_CONSTAT_##_field_, (_con_)->ucsi->version)
455
456 /* -------------------------------------------------------------------------- */
457
458 struct ucsi_debugfs_entry {
459 u64 command;
460 struct ucsi_data {
461 u64 low;
462 u64 high;
463 } response;
464 int status;
465 struct dentry *dentry;
466 };
467
468 struct ucsi {
469 u16 version;
470 struct device *dev;
471 void *driver_data;
472
473 const struct ucsi_operations *ops;
474
475 struct ucsi_capability cap;
476 struct ucsi_connector *connector;
477 struct ucsi_debugfs_entry *debugfs;
478
479 struct work_struct resume_work;
480 struct delayed_work work;
481 int work_count;
482 #define UCSI_ROLE_SWITCH_RETRY_PER_HZ 10
483 #define UCSI_ROLE_SWITCH_INTERVAL (HZ / UCSI_ROLE_SWITCH_RETRY_PER_HZ)
484 #define UCSI_ROLE_SWITCH_WAIT_COUNT (10 * UCSI_ROLE_SWITCH_RETRY_PER_HZ)
485
486 /* PPM Communication lock */
487 struct mutex ppm_lock;
488
489 /* The latest "Notification Enable" bits (SET_NOTIFICATION_ENABLE) */
490 u64 ntfy;
491
492 /* PPM communication flags */
493 unsigned long flags;
494 #define EVENT_PENDING 0
495 #define COMMAND_PENDING 1
496 #define ACK_PENDING 2
497 struct completion complete;
498
499 unsigned long quirks;
500 #define UCSI_NO_PARTNER_PDOS BIT(0) /* Don't read partner's PDOs */
501 #define UCSI_DELAY_DEVICE_PDOS BIT(1) /* Reading PDOs fails until the parter is in PD mode */
502
503 /* Fixed-size buffers for incoming and outgoing messages */
504 u8 message_in[UCSI_MAX_MESSAGE_IN_LENGTH];
505 size_t message_in_size;
506 u8 message_out[UCSI_MAX_MESSAGE_OUT_LENGTH];
507 size_t message_out_size;
508 };
509
510 #define UCSI_MAX_DATA_LENGTH(u) (((u)->version < UCSI_VERSION_2_0) ? 0x10 : 0xff)
511
512 #define UCSI_MAX_SVID 5
513 #define UCSI_MAX_ALTMODES (UCSI_MAX_SVID * 6)
514
515 #define UCSI_TYPEC_VSAFE5V 5000
516 #define UCSI_TYPEC_DEFAULT_CURRENT 100
517 #define UCSI_TYPEC_1_5_CURRENT 1500
518 #define UCSI_TYPEC_3_0_CURRENT 3000
519
520 struct ucsi_connector {
521 int num;
522
523 struct ucsi *ucsi;
524 struct mutex lock; /* port lock */
525 struct work_struct work;
526 struct completion complete;
527 struct workqueue_struct *wq;
528 struct list_head partner_tasks;
529
530 struct typec_port *port;
531 struct typec_partner *partner;
532 struct typec_cable *cable;
533 struct typec_plug *plug;
534
535 struct typec_altmode *port_altmode[UCSI_MAX_ALTMODES];
536 struct typec_altmode *partner_altmode[UCSI_MAX_ALTMODES];
537 struct typec_altmode *plug_altmode[UCSI_MAX_ALTMODES];
538
539 struct typec_capability typec_cap;
540
541 /* Cached command responses. */
542 DECLARE_BITMAP(cap, UCSI_GET_CONNECTOR_CAPABILITY_SIZE);
543 DECLARE_BITMAP(status, UCSI_GET_CONNECTOR_STATUS_SIZE);
544
545 struct power_supply *psy;
546 struct power_supply_desc psy_desc;
547 u32 rdo;
548 u32 src_pdos[PDO_MAX_OBJECTS];
549 int num_pdos;
550
551 u32 peak_current;
552 u32 avg_current;
553 u32 vbus_voltage;
554
555 /* USB PD objects */
556 struct usb_power_delivery *pd;
557 struct usb_power_delivery_capabilities *port_source_caps;
558 struct usb_power_delivery_capabilities *port_sink_caps;
559 struct usb_power_delivery *partner_pd;
560 struct usb_power_delivery_capabilities *partner_source_caps;
561 struct usb_power_delivery_capabilities *partner_sink_caps;
562
563 struct usb_role_switch *usb_role_sw;
564
565 /* USB PD identity */
566 struct usb_pd_identity partner_identity;
567 struct usb_pd_identity cable_identity;
568 };
569
570 int ucsi_send_command(struct ucsi *ucsi, u64 command);
571
572 void ucsi_altmode_update_active(struct ucsi_connector *con);
573 int ucsi_resume(struct ucsi *ucsi);
574
575 void ucsi_notify_common(struct ucsi *ucsi, u32 cci);
576 int ucsi_sync_control_common(struct ucsi *ucsi, u64 command, u32 *cci);
577
578 #if IS_ENABLED(CONFIG_POWER_SUPPLY)
579 int ucsi_register_port_psy(struct ucsi_connector *con);
580 void ucsi_unregister_port_psy(struct ucsi_connector *con);
581 void ucsi_port_psy_changed(struct ucsi_connector *con);
582 #else
ucsi_register_port_psy(struct ucsi_connector * con)583 static inline int ucsi_register_port_psy(struct ucsi_connector *con) { return 0; }
ucsi_unregister_port_psy(struct ucsi_connector * con)584 static inline void ucsi_unregister_port_psy(struct ucsi_connector *con) { }
ucsi_port_psy_changed(struct ucsi_connector * con)585 static inline void ucsi_port_psy_changed(struct ucsi_connector *con) { }
586 #endif /* CONFIG_POWER_SUPPLY */
587
588 #if IS_ENABLED(CONFIG_TYPEC_DP_ALTMODE)
589 struct typec_altmode *
590 ucsi_register_displayport(struct ucsi_connector *con,
591 bool override, int offset,
592 struct typec_altmode_desc *desc);
593
594 void ucsi_displayport_remove_partner(struct typec_altmode *adev);
595
596 #else
597 static inline struct typec_altmode *
ucsi_register_displayport(struct ucsi_connector * con,bool override,int offset,struct typec_altmode_desc * desc)598 ucsi_register_displayport(struct ucsi_connector *con,
599 bool override, int offset,
600 struct typec_altmode_desc *desc)
601 {
602 return typec_port_register_altmode(con->port, desc);
603 }
604
605 static inline void
ucsi_displayport_remove_partner(struct typec_altmode * adev)606 ucsi_displayport_remove_partner(struct typec_altmode *adev) { }
607 #endif /* CONFIG_TYPEC_DP_ALTMODE */
608
609 #ifdef CONFIG_DEBUG_FS
610 void ucsi_debugfs_init(void);
611 void ucsi_debugfs_exit(void);
612 void ucsi_debugfs_register(struct ucsi *ucsi);
613 void ucsi_debugfs_unregister(struct ucsi *ucsi);
614 #else
ucsi_debugfs_init(void)615 static inline void ucsi_debugfs_init(void) { }
ucsi_debugfs_exit(void)616 static inline void ucsi_debugfs_exit(void) { }
ucsi_debugfs_register(struct ucsi * ucsi)617 static inline void ucsi_debugfs_register(struct ucsi *ucsi) { }
ucsi_debugfs_unregister(struct ucsi * ucsi)618 static inline void ucsi_debugfs_unregister(struct ucsi *ucsi) { }
619 #endif /* CONFIG_DEBUG_FS */
620
621 /*
622 * NVIDIA VirtualLink (svid 0x955) has two altmode. VirtualLink
623 * DP mode with vdo=0x1 and NVIDIA test mode with vdo=0x3
624 */
625 #define USB_TYPEC_NVIDIA_VLINK_DP_VDO 0x1
626 #define USB_TYPEC_NVIDIA_VLINK_DBG_VDO 0x3
627
628 #endif /* __DRIVER_USB_TYPEC_UCSI_H */
629