1 /* SPDX-License-Identifier: GPL-2.0 */
3 #ifndef __DRIVER_USB_TYPEC_UCSI_H
4 #define __DRIVER_USB_TYPEC_UCSI_H
6 #include <linux/bitops.h>
7 #include <linux/device.h>
8 #include <linux/types.h>
9 #include <linux/usb/typec.h>
11 /* -------------------------------------------------------------------------- */
16 /* UCSI offsets (Bytes) */
17 #define UCSI_VERSION 0
19 #define UCSI_CONTROL 8
20 #define UCSI_MESSAGE_IN 16
21 #define UCSI_MESSAGE_OUT 32
23 /* Command Status and Connector Change Indication (CCI) bits */
24 #define UCSI_CCI_CONNECTOR(_c_) (((_c_) & GENMASK(7, 0)) >> 1)
25 #define UCSI_CCI_LENGTH(_c_) (((_c_) & GENMASK(15, 8)) >> 8)
26 #define UCSI_CCI_NOT_SUPPORTED BIT(25)
27 #define UCSI_CCI_CANCEL_COMPLETE BIT(26)
28 #define UCSI_CCI_RESET_COMPLETE BIT(27)
29 #define UCSI_CCI_BUSY BIT(28)
30 #define UCSI_CCI_ACK_COMPLETE BIT(29)
31 #define UCSI_CCI_ERROR BIT(30)
32 #define UCSI_CCI_COMMAND_COMPLETE BIT(31)
35 * struct ucsi_operations - UCSI I/O operations
36 * @read: Read operation
37 * @sync_write: Blocking write operation
38 * @async_write: Non-blocking write operation
39 * @update_altmodes: Squashes duplicate DP altmodes
41 * Read and write routines for UCSI interface. @sync_write must wait for the
42 * Command Completion Event from the PPM before returning, and @async_write must
43 * return immediately after sending the data to the PPM.
45 struct ucsi_operations {
46 int (*read)(struct ucsi *ucsi, unsigned int offset,
47 void *val, size_t val_len);
48 int (*sync_write)(struct ucsi *ucsi, unsigned int offset,
49 const void *val, size_t val_len);
50 int (*async_write)(struct ucsi *ucsi, unsigned int offset,
51 const void *val, size_t val_len);
52 bool (*update_altmodes)(struct ucsi *ucsi, struct ucsi_altmode *orig,
53 struct ucsi_altmode *updated);
56 struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops);
57 void ucsi_destroy(struct ucsi *ucsi);
58 int ucsi_register(struct ucsi *ucsi);
59 void ucsi_unregister(struct ucsi *ucsi);
60 void *ucsi_get_drvdata(struct ucsi *ucsi);
61 void ucsi_set_drvdata(struct ucsi *ucsi, void *data);
63 void ucsi_connector_change(struct ucsi *ucsi, u8 num);
65 /* -------------------------------------------------------------------------- */
68 #define UCSI_PPM_RESET 0x01
69 #define UCSI_CANCEL 0x02
70 #define UCSI_CONNECTOR_RESET 0x03
71 #define UCSI_ACK_CC_CI 0x04
72 #define UCSI_SET_NOTIFICATION_ENABLE 0x05
73 #define UCSI_GET_CAPABILITY 0x06
74 #define UCSI_GET_CONNECTOR_CAPABILITY 0x07
75 #define UCSI_SET_UOM 0x08
76 #define UCSI_SET_UOR 0x09
77 #define UCSI_SET_PDM 0x0a
78 #define UCSI_SET_PDR 0x0b
79 #define UCSI_GET_ALTERNATE_MODES 0x0c
80 #define UCSI_GET_CAM_SUPPORTED 0x0d
81 #define UCSI_GET_CURRENT_CAM 0x0e
82 #define UCSI_SET_NEW_CAM 0x0f
83 #define UCSI_GET_PDOS 0x10
84 #define UCSI_GET_CABLE_PROPERTY 0x11
85 #define UCSI_GET_CONNECTOR_STATUS 0x12
86 #define UCSI_GET_ERROR_STATUS 0x13
88 #define UCSI_CONNECTOR_NUMBER(_num_) ((u64)(_num_) << 16)
89 #define UCSI_COMMAND(_cmd_) ((_cmd_) & 0xff)
91 /* CONNECTOR_RESET command bits */
92 #define UCSI_CONNECTOR_RESET_HARD BIT(23) /* Deprecated in v1.1 */
95 #define UCSI_ACK_CONNECTOR_CHANGE BIT(16)
96 #define UCSI_ACK_COMMAND_COMPLETE BIT(17)
98 /* SET_NOTIFICATION_ENABLE command bits */
99 #define UCSI_ENABLE_NTFY_CMD_COMPLETE BIT(16)
100 #define UCSI_ENABLE_NTFY_EXT_PWR_SRC_CHANGE BIT(17)
101 #define UCSI_ENABLE_NTFY_PWR_OPMODE_CHANGE BIT(18)
102 #define UCSI_ENABLE_NTFY_CAP_CHANGE BIT(21)
103 #define UCSI_ENABLE_NTFY_PWR_LEVEL_CHANGE BIT(22)
104 #define UCSI_ENABLE_NTFY_PD_RESET_COMPLETE BIT(23)
105 #define UCSI_ENABLE_NTFY_CAM_CHANGE BIT(24)
106 #define UCSI_ENABLE_NTFY_BAT_STATUS_CHANGE BIT(25)
107 #define UCSI_ENABLE_NTFY_PARTNER_CHANGE BIT(27)
108 #define UCSI_ENABLE_NTFY_PWR_DIR_CHANGE BIT(28)
109 #define UCSI_ENABLE_NTFY_CONNECTOR_CHANGE BIT(30)
110 #define UCSI_ENABLE_NTFY_ERROR BIT(31)
111 #define UCSI_ENABLE_NTFY_ALL 0xdbe70000
113 /* SET_UOR command bits */
114 #define UCSI_SET_UOR_ROLE(_r_) (((_r_) == TYPEC_HOST ? 1 : 2) << 23)
115 #define UCSI_SET_UOR_ACCEPT_ROLE_SWAPS BIT(25)
117 /* SET_PDF command bits */
118 #define UCSI_SET_PDR_ROLE(_r_) (((_r_) == TYPEC_SOURCE ? 1 : 2) << 23)
119 #define UCSI_SET_PDR_ACCEPT_ROLE_SWAPS BIT(25)
121 /* GET_ALTERNATE_MODES command bits */
122 #define UCSI_GET_ALTMODE_RECIPIENT(_r_) ((u64)(_r_) << 16)
123 #define UCSI_RECIPIENT_CON 0
124 #define UCSI_RECIPIENT_SOP 1
125 #define UCSI_RECIPIENT_SOP_P 2
126 #define UCSI_RECIPIENT_SOP_PP 3
127 #define UCSI_GET_ALTMODE_CONNECTOR_NUMBER(_r_) ((u64)(_r_) << 24)
128 #define UCSI_GET_ALTMODE_OFFSET(_r_) ((u64)(_r_) << 32)
129 #define UCSI_GET_ALTMODE_NUM_ALTMODES(_r_) ((u64)(_r_) << 40)
131 /* -------------------------------------------------------------------------- */
133 /* Error information returned by PPM in response to GET_ERROR_STATUS command. */
134 #define UCSI_ERROR_UNREGONIZED_CMD BIT(0)
135 #define UCSI_ERROR_INVALID_CON_NUM BIT(1)
136 #define UCSI_ERROR_INVALID_CMD_ARGUMENT BIT(2)
137 #define UCSI_ERROR_INCOMPATIBLE_PARTNER BIT(3)
138 #define UCSI_ERROR_CC_COMMUNICATION_ERR BIT(4)
139 #define UCSI_ERROR_DEAD_BATTERY BIT(5)
140 #define UCSI_ERROR_CONTRACT_NEGOTIATION_FAIL BIT(6)
141 #define UCSI_ERROR_OVERCURRENT BIT(7)
142 #define UCSI_ERROR_UNDEFINED BIT(8)
143 #define UCSI_ERROR_PARTNER_REJECTED_SWAP BIT(9)
144 #define UCSI_ERROR_HARD_RESET BIT(10)
145 #define UCSI_ERROR_PPM_POLICY_CONFLICT BIT(11)
146 #define UCSI_ERROR_SWAP_REJECTED BIT(12)
148 #define UCSI_SET_NEW_CAM_ENTER(x) (((x) >> 23) & 0x1)
149 #define UCSI_SET_NEW_CAM_GET_AM(x) (((x) >> 24) & 0xff)
150 #define UCSI_SET_NEW_CAM_AM_MASK (0xff << 24)
151 #define UCSI_SET_NEW_CAM_SET_AM(x) (((x) & 0xff) << 24)
152 #define UCSI_CMD_CONNECTOR_MASK (0x7)
154 /* Data structure filled by PPM in response to GET_CAPABILITY command. */
155 struct ucsi_capability {
157 #define UCSI_CAP_ATTR_DISABLE_STATE BIT(0)
158 #define UCSI_CAP_ATTR_BATTERY_CHARGING BIT(1)
159 #define UCSI_CAP_ATTR_USB_PD BIT(2)
160 #define UCSI_CAP_ATTR_TYPEC_CURRENT BIT(6)
161 #define UCSI_CAP_ATTR_POWER_AC_SUPPLY BIT(8)
162 #define UCSI_CAP_ATTR_POWER_OTHER BIT(10)
163 #define UCSI_CAP_ATTR_POWER_VBUS BIT(14)
166 #define UCSI_CAP_SET_UOM BIT(0)
167 #define UCSI_CAP_SET_PDM BIT(1)
168 #define UCSI_CAP_ALT_MODE_DETAILS BIT(2)
169 #define UCSI_CAP_ALT_MODE_OVERRIDE BIT(3)
170 #define UCSI_CAP_PDO_DETAILS BIT(4)
171 #define UCSI_CAP_CABLE_DETAILS BIT(5)
172 #define UCSI_CAP_EXT_SUPPLY_NOTIFICATIONS BIT(6)
173 #define UCSI_CAP_PD_RESET BIT(7)
182 /* Data structure filled by PPM in response to GET_CONNECTOR_CAPABILITY cmd. */
183 struct ucsi_connector_capability {
185 #define UCSI_CONCAP_OPMODE_DFP BIT(0)
186 #define UCSI_CONCAP_OPMODE_UFP BIT(1)
187 #define UCSI_CONCAP_OPMODE_DRP BIT(2)
188 #define UCSI_CONCAP_OPMODE_AUDIO_ACCESSORY BIT(3)
189 #define UCSI_CONCAP_OPMODE_DEBUG_ACCESSORY BIT(4)
190 #define UCSI_CONCAP_OPMODE_USB2 BIT(5)
191 #define UCSI_CONCAP_OPMODE_USB3 BIT(6)
192 #define UCSI_CONCAP_OPMODE_ALT_MODE BIT(7)
194 #define UCSI_CONCAP_FLAG_PROVIDER BIT(0)
195 #define UCSI_CONCAP_FLAG_CONSUMER BIT(1)
198 struct ucsi_altmode {
203 /* Data structure filled by PPM in response to GET_CABLE_PROPERTY command. */
204 struct ucsi_cable_property {
206 u8 current_capability;
208 #define UCSI_CABLE_PROP_FLAG_VBUS_IN_CABLE BIT(0)
209 #define UCSI_CABLE_PROP_FLAG_ACTIVE_CABLE BIT(1)
210 #define UCSI_CABLE_PROP_FLAG_DIRECTIONALITY BIT(2)
211 #define UCSI_CABLE_PROP_FLAG_PLUG_TYPE(_f_) ((_f_) & GENMASK(3, 0))
212 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_A 0
213 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_B 1
214 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_C 2
215 #define UCSI_CABLE_PROPERTY_PLUG_OTHER 3
216 #define UCSI_CABLE_PROP_MODE_SUPPORT BIT(5)
220 /* Data structure filled by PPM in response to GET_CONNECTOR_STATUS command. */
221 struct ucsi_connector_status {
223 #define UCSI_CONSTAT_EXT_SUPPLY_CHANGE BIT(1)
224 #define UCSI_CONSTAT_POWER_OPMODE_CHANGE BIT(2)
225 #define UCSI_CONSTAT_PDOS_CHANGE BIT(5)
226 #define UCSI_CONSTAT_POWER_LEVEL_CHANGE BIT(6)
227 #define UCSI_CONSTAT_PD_RESET_COMPLETE BIT(7)
228 #define UCSI_CONSTAT_CAM_CHANGE BIT(8)
229 #define UCSI_CONSTAT_BC_CHANGE BIT(9)
230 #define UCSI_CONSTAT_PARTNER_CHANGE BIT(11)
231 #define UCSI_CONSTAT_POWER_DIR_CHANGE BIT(12)
232 #define UCSI_CONSTAT_CONNECT_CHANGE BIT(14)
233 #define UCSI_CONSTAT_ERROR BIT(15)
235 #define UCSI_CONSTAT_PWR_OPMODE(_f_) ((_f_) & GENMASK(2, 0))
236 #define UCSI_CONSTAT_PWR_OPMODE_NONE 0
237 #define UCSI_CONSTAT_PWR_OPMODE_DEFAULT 1
238 #define UCSI_CONSTAT_PWR_OPMODE_BC 2
239 #define UCSI_CONSTAT_PWR_OPMODE_PD 3
240 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC1_5 4
241 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC3_0 5
242 #define UCSI_CONSTAT_CONNECTED BIT(3)
243 #define UCSI_CONSTAT_PWR_DIR BIT(4)
244 #define UCSI_CONSTAT_PARTNER_FLAGS(_f_) (((_f_) & GENMASK(12, 5)) >> 5)
245 #define UCSI_CONSTAT_PARTNER_FLAG_USB 1
246 #define UCSI_CONSTAT_PARTNER_FLAG_ALT_MODE 2
247 #define UCSI_CONSTAT_PARTNER_TYPE(_f_) (((_f_) & GENMASK(15, 13)) >> 13)
248 #define UCSI_CONSTAT_PARTNER_TYPE_DFP 1
249 #define UCSI_CONSTAT_PARTNER_TYPE_UFP 2
250 #define UCSI_CONSTAT_PARTNER_TYPE_CABLE 3 /* Powered Cable */
251 #define UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP 4 /* Powered Cable */
252 #define UCSI_CONSTAT_PARTNER_TYPE_DEBUG 5
253 #define UCSI_CONSTAT_PARTNER_TYPE_AUDIO 6
254 u32 request_data_obj;
256 #define UCSI_CONSTAT_BC_STATUS(_p_) ((_p_) & GENMASK(2, 0))
257 #define UCSI_CONSTAT_BC_NOT_CHARGING 0
258 #define UCSI_CONSTAT_BC_NOMINAL_CHARGING 1
259 #define UCSI_CONSTAT_BC_SLOW_CHARGING 2
260 #define UCSI_CONSTAT_BC_TRICKLE_CHARGING 3
261 #define UCSI_CONSTAT_PROVIDER_CAP_LIMIT(_p_) (((_p_) & GENMASK(6, 3)) >> 3)
262 #define UCSI_CONSTAT_CAP_PWR_LOWERED 0
263 #define UCSI_CONSTAT_CAP_PWR_BUDGET_LIMIT 1
266 /* -------------------------------------------------------------------------- */
271 struct driver_data *driver_data;
273 const struct ucsi_operations *ops;
275 struct ucsi_capability cap;
276 struct ucsi_connector *connector;
278 struct work_struct work;
280 /* PPM Communication lock */
281 struct mutex ppm_lock;
283 /* The latest "Notification Enable" bits (SET_NOTIFICATION_ENABLE) */
286 /* PPM communication flags */
288 #define EVENT_PENDING 0
289 #define COMMAND_PENDING 1
290 #define ACK_PENDING 2
293 #define UCSI_MAX_SVID 5
294 #define UCSI_MAX_ALTMODES (UCSI_MAX_SVID * 6)
296 struct ucsi_connector {
300 struct mutex lock; /* port lock */
301 struct work_struct work;
302 struct completion complete;
304 struct typec_port *port;
305 struct typec_partner *partner;
307 struct typec_altmode *port_altmode[UCSI_MAX_ALTMODES];
308 struct typec_altmode *partner_altmode[UCSI_MAX_ALTMODES];
310 struct typec_capability typec_cap;
312 struct ucsi_connector_status status;
313 struct ucsi_connector_capability cap;
316 int ucsi_send_command(struct ucsi *ucsi, u64 command,
317 void *retval, size_t size);
319 void ucsi_altmode_update_active(struct ucsi_connector *con);
320 int ucsi_resume(struct ucsi *ucsi);
322 #if IS_ENABLED(CONFIG_TYPEC_DP_ALTMODE)
323 struct typec_altmode *
324 ucsi_register_displayport(struct ucsi_connector *con,
325 bool override, int offset,
326 struct typec_altmode_desc *desc);
328 void ucsi_displayport_remove_partner(struct typec_altmode *adev);
331 static inline struct typec_altmode *
332 ucsi_register_displayport(struct ucsi_connector *con,
333 bool override, int offset,
334 struct typec_altmode_desc *desc)
340 ucsi_displayport_remove_partner(struct typec_altmode *adev) { }
341 #endif /* CONFIG_TYPEC_DP_ALTMODE */
343 #endif /* __DRIVER_USB_TYPEC_UCSI_H */