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