1 /* SPDX-License-Identifier: GPL-2.0 */
2
3 #ifndef __LINUX_USB_TYPEC_H
4 #define __LINUX_USB_TYPEC_H
5
6 #include <linux/types.h>
7
8 /* USB Type-C Specification releases */
9 #define USB_TYPEC_REV_1_0 0x100 /* 1.0 */
10 #define USB_TYPEC_REV_1_1 0x110 /* 1.1 */
11 #define USB_TYPEC_REV_1_2 0x120 /* 1.2 */
12 #define USB_TYPEC_REV_1_3 0x130 /* 1.3 */
13 #define USB_TYPEC_REV_1_4 0x140 /* 1.4 */
14 #define USB_TYPEC_REV_2_0 0x200 /* 2.0 */
15
16 struct typec_partner;
17 struct typec_cable;
18 struct typec_plug;
19 struct typec_port;
20 struct typec_altmode_ops;
21 struct typec_cable_ops;
22
23 struct fwnode_handle;
24 struct device;
25
26 struct usb_power_delivery;
27 struct usb_power_delivery_desc;
28
29 enum typec_port_type {
30 TYPEC_PORT_SRC,
31 TYPEC_PORT_SNK,
32 TYPEC_PORT_DRP,
33 };
34
35 enum typec_port_data {
36 TYPEC_PORT_DFP,
37 TYPEC_PORT_UFP,
38 TYPEC_PORT_DRD,
39 };
40
41 enum typec_plug_type {
42 USB_PLUG_NONE,
43 USB_PLUG_TYPE_A,
44 USB_PLUG_TYPE_B,
45 USB_PLUG_TYPE_C,
46 USB_PLUG_CAPTIVE,
47 };
48
49 enum typec_data_role {
50 TYPEC_DEVICE,
51 TYPEC_HOST,
52 };
53
54 enum typec_role {
55 TYPEC_SINK,
56 TYPEC_SOURCE,
57 };
58
is_sink(enum typec_role role)59 static inline int is_sink(enum typec_role role)
60 {
61 return role == TYPEC_SINK;
62 }
63
is_source(enum typec_role role)64 static inline int is_source(enum typec_role role)
65 {
66 return role == TYPEC_SOURCE;
67 }
68
69 enum typec_pwr_opmode {
70 TYPEC_PWR_MODE_USB,
71 TYPEC_PWR_MODE_1_5A,
72 TYPEC_PWR_MODE_3_0A,
73 TYPEC_PWR_MODE_PD,
74 };
75
76 enum typec_accessory {
77 TYPEC_ACCESSORY_NONE,
78 TYPEC_ACCESSORY_AUDIO,
79 TYPEC_ACCESSORY_DEBUG,
80 };
81
82 #define TYPEC_MAX_ACCESSORY 3
83
84 enum typec_orientation {
85 TYPEC_ORIENTATION_NONE,
86 TYPEC_ORIENTATION_NORMAL,
87 TYPEC_ORIENTATION_REVERSE,
88 };
89
90 enum usb_mode {
91 USB_MODE_NONE,
92 USB_MODE_USB2,
93 USB_MODE_USB3,
94 USB_MODE_USB4
95 };
96
97 #define USB_CAPABILITY_USB2 BIT(0)
98 #define USB_CAPABILITY_USB3 BIT(1)
99 #define USB_CAPABILITY_USB4 BIT(2)
100
101 /*
102 * struct enter_usb_data - Enter_USB Message details
103 * @eudo: Enter_USB Data Object
104 * @active_link_training: Active Cable Plug Link Training
105 *
106 * @active_link_training is a flag that should be set with uni-directional SBRX
107 * communication, and left 0 with passive cables and with bi-directional SBRX
108 * communication.
109 */
110 struct enter_usb_data {
111 u32 eudo;
112 unsigned char active_link_training:1;
113 };
114
115 /*
116 * struct usb_pd_identity - USB Power Delivery identity data
117 * @id_header: ID Header VDO
118 * @cert_stat: Cert Stat VDO
119 * @product: Product VDO
120 * @vdo: Product Type Specific VDOs
121 *
122 * USB power delivery Discover Identity command response data.
123 *
124 * REVISIT: This is USB Power Delivery specific information, so this structure
125 * probable belongs to USB Power Delivery header file once we have them.
126 */
127 struct usb_pd_identity {
128 u32 id_header;
129 u32 cert_stat;
130 u32 product;
131 u32 vdo[3];
132 };
133
134 int typec_partner_set_identity(struct typec_partner *partner);
135 int typec_cable_set_identity(struct typec_cable *cable);
136
137 /*
138 * struct typec_altmode_desc - USB Type-C Alternate Mode Descriptor
139 * @svid: Standard or Vendor ID
140 * @mode: Index of the Mode
141 * @vdo: VDO returned by Discover Modes USB PD command
142 * @roles: Only for ports. DRP if the mode is available in both roles
143 * @inactive: Only for ports. Make this port inactive (default is active).
144 *
145 * Description of an Alternate Mode which a connector, cable plug or partner
146 * supports.
147 */
148 struct typec_altmode_desc {
149 u16 svid;
150 u8 mode;
151 u32 vdo;
152 /* Only used with ports */
153 enum typec_port_data roles;
154 bool inactive;
155 };
156
157 void typec_partner_set_pd_revision(struct typec_partner *partner, u16 pd_revision);
158 int typec_partner_set_num_altmodes(struct typec_partner *partner, int num_altmodes);
159 struct typec_altmode
160 *typec_partner_register_altmode(struct typec_partner *partner,
161 const struct typec_altmode_desc *desc);
162 int typec_plug_set_num_altmodes(struct typec_plug *plug, int num_altmodes);
163 struct typec_altmode
164 *typec_plug_register_altmode(struct typec_plug *plug,
165 const struct typec_altmode_desc *desc);
166 struct typec_altmode
167 *typec_port_register_altmode(struct typec_port *port,
168 const struct typec_altmode_desc *desc);
169
170 void typec_port_register_altmodes(struct typec_port *port,
171 const struct typec_altmode_ops *ops, void *drvdata,
172 struct typec_altmode **altmodes, size_t n);
173
174 void typec_port_register_cable_ops(struct typec_altmode **altmodes, int max_altmodes,
175 const struct typec_cable_ops *ops);
176
177 void typec_unregister_altmode(struct typec_altmode *altmode);
178
179 struct typec_port *typec_altmode2port(struct typec_altmode *alt);
180
181 void typec_altmode_update_active(struct typec_altmode *alt, bool active);
182
183 void typec_altmode_set_ops(struct typec_altmode *alt,
184 const struct typec_altmode_ops *ops);
185
186 enum typec_plug_index {
187 TYPEC_PLUG_SOP_P,
188 TYPEC_PLUG_SOP_PP,
189 };
190
191 /*
192 * struct typec_plug_desc - USB Type-C Cable Plug Descriptor
193 * @index: SOP Prime for the plug connected to DFP and SOP Double Prime for the
194 * plug connected to UFP
195 *
196 * Represents USB Type-C Cable Plug.
197 */
198 struct typec_plug_desc {
199 enum typec_plug_index index;
200 };
201
202 /*
203 * struct typec_cable_desc - USB Type-C Cable Descriptor
204 * @type: The plug type from USB PD Cable VDO
205 * @active: Is the cable active or passive
206 * @identity: Result of Discover Identity command
207 * @pd_revision: USB Power Delivery Specification revision if supported
208 *
209 * Represents USB Type-C Cable attached to USB Type-C port.
210 */
211 struct typec_cable_desc {
212 enum typec_plug_type type;
213 unsigned int active:1;
214 struct usb_pd_identity *identity;
215 u16 pd_revision; /* 0300H = "3.0" */
216
217 };
218
219 /*
220 * struct typec_partner_desc - USB Type-C Partner Descriptor
221 * @usb_pd: USB Power Delivery support
222 * @accessory: Audio, Debug or none.
223 * @identity: Discover Identity command data
224 * @pd_revision: USB Power Delivery Specification Revision if supported
225 * @usb_capability: Supported USB Modes
226 * @attach: Notification about attached USB device
227 * @deattach: Notification about removed USB device
228 *
229 * Details about a partner that is attached to USB Type-C port. If @identity
230 * member exists when partner is registered, a directory named "identity" is
231 * created to sysfs for the partner device.
232 *
233 * @pd_revision is based on the setting of the "Specification Revision" field
234 * in the message header on the initial "Source Capabilities" message received
235 * from the partner, or a "Request" message received from the partner, depending
236 * on whether our port is a Sink or a Source.
237 */
238 struct typec_partner_desc {
239 unsigned int usb_pd:1;
240 enum typec_accessory accessory;
241 struct usb_pd_identity *identity;
242 u16 pd_revision; /* 0300H = "3.0" */
243 u8 usb_capability;
244
245 void (*attach)(struct typec_partner *partner, struct device *dev);
246 void (*deattach)(struct typec_partner *partner, struct device *dev);
247 };
248
249 /**
250 * struct typec_operations - USB Type-C Port Operations
251 * @try_role: Set data role preference for DRP port
252 * @dr_set: Set Data Role
253 * @pr_set: Set Power Role
254 * @vconn_set: Source VCONN
255 * @port_type_set: Set port type
256 * @pd_get: Get available USB Power Delivery Capabilities.
257 * @pd_set: Set USB Power Delivery Capabilities.
258 * @default_usb_mode_set: USB Mode to be used by default with Enter_USB Message
259 * @enter_usb_mode: Change the active USB Mode
260 */
261 struct typec_operations {
262 int (*try_role)(struct typec_port *port, int role);
263 int (*dr_set)(struct typec_port *port, enum typec_data_role role);
264 int (*pr_set)(struct typec_port *port, enum typec_role role);
265 int (*vconn_set)(struct typec_port *port, enum typec_role role);
266 int (*port_type_set)(struct typec_port *port,
267 enum typec_port_type type);
268 struct usb_power_delivery **(*pd_get)(struct typec_port *port);
269 int (*pd_set)(struct typec_port *port, struct usb_power_delivery *pd);
270 int (*default_usb_mode_set)(struct typec_port *port, enum usb_mode mode);
271 int (*enter_usb_mode)(struct typec_port *port, enum usb_mode mode);
272 };
273
274 enum usb_pd_svdm_ver {
275 SVDM_VER_1_0 = 0,
276 SVDM_VER_2_0 = 1,
277 SVDM_VER_MAX = SVDM_VER_2_0,
278 };
279
280 /*
281 * struct typec_capability - USB Type-C Port Capabilities
282 * @type: Supported power role of the port
283 * @data: Supported data role of the port
284 * @revision: USB Type-C Specification release. Binary coded decimal
285 * @pd_revision: USB Power Delivery Specification revision if supported
286 * @svdm_version: USB PD Structured VDM version if supported
287 * @prefer_role: Initial role preference (DRP ports).
288 * @accessory: Supported Accessory Modes
289 * @usb_capability: Supported USB Modes
290 * @fwnode: Optional fwnode of the port
291 * @driver_data: Private pointer for driver specific info
292 * @pd: Optional USB Power Delivery Support
293 * @ops: Port operations vector
294 *
295 * Static capabilities of a single USB Type-C port.
296 */
297 struct typec_capability {
298 enum typec_port_type type;
299 enum typec_port_data data;
300 u16 revision; /* 0120H = "1.2" */
301 u16 pd_revision; /* 0300H = "3.0" */
302 enum usb_pd_svdm_ver svdm_version;
303 int prefer_role;
304 enum typec_accessory accessory[TYPEC_MAX_ACCESSORY];
305 unsigned int orientation_aware:1;
306 u8 usb_capability;
307
308 struct fwnode_handle *fwnode;
309 void *driver_data;
310
311 struct usb_power_delivery *pd;
312
313 const struct typec_operations *ops;
314 };
315
316 /* Specific to try_role(). Indicates the user want's to clear the preference. */
317 #define TYPEC_NO_PREFERRED_ROLE (-1)
318
319 struct typec_port *typec_register_port(struct device *parent,
320 const struct typec_capability *cap);
321 void typec_unregister_port(struct typec_port *port);
322
323 struct typec_partner *typec_register_partner(struct typec_port *port,
324 struct typec_partner_desc *desc);
325 void typec_unregister_partner(struct typec_partner *partner);
326
327 struct typec_cable *typec_register_cable(struct typec_port *port,
328 struct typec_cable_desc *desc);
329 void typec_unregister_cable(struct typec_cable *cable);
330
331 struct typec_cable *typec_cable_get(struct typec_port *port);
332 void typec_cable_put(struct typec_cable *cable);
333 int typec_cable_is_active(struct typec_cable *cable);
334
335 struct typec_plug *typec_register_plug(struct typec_cable *cable,
336 struct typec_plug_desc *desc);
337 void typec_unregister_plug(struct typec_plug *plug);
338
339 void typec_set_data_role(struct typec_port *port, enum typec_data_role role);
340 void typec_set_pwr_role(struct typec_port *port, enum typec_role role);
341 void typec_set_vconn_role(struct typec_port *port, enum typec_role role);
342 void typec_set_pwr_opmode(struct typec_port *port, enum typec_pwr_opmode mode);
343
344 int typec_set_orientation(struct typec_port *port,
345 enum typec_orientation orientation);
346 enum typec_orientation typec_get_orientation(struct typec_port *port);
347 int typec_set_mode(struct typec_port *port, int mode);
348
349 void *typec_get_drvdata(struct typec_port *port);
350
351 int typec_get_fw_cap(struct typec_capability *cap,
352 struct fwnode_handle *fwnode);
353
354 int typec_find_pwr_opmode(const char *name);
355 int typec_find_orientation(const char *name);
356 int typec_find_port_power_role(const char *name);
357 int typec_find_power_role(const char *name);
358 int typec_find_port_data_role(const char *name);
359
360 void typec_partner_set_svdm_version(struct typec_partner *partner,
361 enum usb_pd_svdm_ver svdm_version);
362 int typec_get_negotiated_svdm_version(struct typec_port *port);
363
364 int typec_get_cable_svdm_version(struct typec_port *port);
365 void typec_cable_set_svdm_version(struct typec_cable *cable, enum usb_pd_svdm_ver svdm_version);
366
367 struct usb_power_delivery *typec_partner_usb_power_delivery_register(struct typec_partner *partner,
368 struct usb_power_delivery_desc *desc);
369
370 int typec_port_set_usb_power_delivery(struct typec_port *port, struct usb_power_delivery *pd);
371 int typec_partner_set_usb_power_delivery(struct typec_partner *partner,
372 struct usb_power_delivery *pd);
373
374 void typec_partner_set_usb_mode(struct typec_partner *partner, enum usb_mode usb_mode);
375 void typec_port_set_usb_mode(struct typec_port *port, enum usb_mode mode);
376
377 /**
378 * struct typec_connector - Representation of Type-C port for external drivers
379 * @attach: notification about device removal
380 * @deattach: notification about device removal
381 *
382 * Drivers that control the USB and other ports (DisplayPorts, etc.), that are
383 * connected to the Type-C connectors, can use these callbacks to inform the
384 * Type-C connector class about connections and disconnections. That information
385 * can then be used by the typec-port drivers to power on or off parts that are
386 * needed or not needed - as an example, in USB mode if USB2 device is
387 * enumerated, USB3 components (retimers, phys, and what have you) do not need
388 * to be powered on.
389 *
390 * The attached (enumerated) devices will be liked with the typec-partner device.
391 */
392 struct typec_connector {
393 void (*attach)(struct typec_connector *con, struct device *dev);
394 void (*deattach)(struct typec_connector *con, struct device *dev);
395 };
396
typec_attach(struct typec_connector * con,struct device * dev)397 static inline void typec_attach(struct typec_connector *con, struct device *dev)
398 {
399 if (con && con->attach)
400 con->attach(con, dev);
401 }
402
typec_deattach(struct typec_connector * con,struct device * dev)403 static inline void typec_deattach(struct typec_connector *con, struct device *dev)
404 {
405 if (con && con->deattach)
406 con->deattach(con, dev);
407 }
408
409 #endif /* __LINUX_USB_TYPEC_H */
410