ucsi.h

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