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 #include <linux/android_kabi.h>
8
9 /* USB Type-C Specification releases */
10 #define USB_TYPEC_REV_1_0 0x100 /* 1.0 */
11 #define USB_TYPEC_REV_1_1 0x110 /* 1.1 */
12 #define USB_TYPEC_REV_1_2 0x120 /* 1.2 */
13 #define USB_TYPEC_REV_1_3 0x130 /* 1.3 */
14 #define USB_TYPEC_REV_1_4 0x140 /* 1.4 */
15 #define USB_TYPEC_REV_2_0 0x200 /* 2.0 */
16
17 struct typec_partner;
18 struct typec_cable;
19 struct typec_plug;
20 struct typec_port;
21 struct typec_altmode_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 /*
91 * struct enter_usb_data - Enter_USB Message details
92 * @eudo: Enter_USB Data Object
93 * @active_link_training: Active Cable Plug Link Training
94 *
95 * @active_link_training is a flag that should be set with uni-directional SBRX
96 * communication, and left 0 with passive cables and with bi-directional SBRX
97 * communication.
98 */
99 struct enter_usb_data {
100 u32 eudo;
101 unsigned char active_link_training:1;
102 };
103
104 /*
105 * struct usb_pd_identity - USB Power Delivery identity data
106 * @id_header: ID Header VDO
107 * @cert_stat: Cert Stat VDO
108 * @product: Product VDO
109 * @vdo: Product Type Specific VDOs
110 *
111 * USB power delivery Discover Identity command response data.
112 *
113 * REVISIT: This is USB Power Delivery specific information, so this structure
114 * probable belongs to USB Power Delivery header file once we have them.
115 */
116 struct usb_pd_identity {
117 u32 id_header;
118 u32 cert_stat;
119 u32 product;
120 u32 vdo[3];
121 };
122
123 int typec_partner_set_identity(struct typec_partner *partner);
124 int typec_cable_set_identity(struct typec_cable *cable);
125
126 /*
127 * struct typec_altmode_desc - USB Type-C Alternate Mode Descriptor
128 * @svid: Standard or Vendor ID
129 * @mode: Index of the Mode
130 * @vdo: VDO returned by Discover Modes USB PD command
131 * @roles: Only for ports. DRP if the mode is available in both roles
132 *
133 * Description of an Alternate Mode which a connector, cable plug or partner
134 * supports.
135 */
136 struct typec_altmode_desc {
137 u16 svid;
138 u8 mode;
139 u32 vdo;
140 /* Only used with ports */
141 enum typec_port_data roles;
142 };
143
144 void typec_partner_set_pd_revision(struct typec_partner *partner, u16 pd_revision);
145 int typec_partner_set_num_altmodes(struct typec_partner *partner, int num_altmodes);
146 struct typec_altmode
147 *typec_partner_register_altmode(struct typec_partner *partner,
148 const struct typec_altmode_desc *desc);
149 int typec_plug_set_num_altmodes(struct typec_plug *plug, int num_altmodes);
150 struct typec_altmode
151 *typec_plug_register_altmode(struct typec_plug *plug,
152 const struct typec_altmode_desc *desc);
153 struct typec_altmode
154 *typec_port_register_altmode(struct typec_port *port,
155 const struct typec_altmode_desc *desc);
156
157 void typec_port_register_altmodes(struct typec_port *port,
158 const struct typec_altmode_ops *ops, void *drvdata,
159 struct typec_altmode **altmodes, size_t n);
160
161 void typec_unregister_altmode(struct typec_altmode *altmode);
162
163 struct typec_port *typec_altmode2port(struct typec_altmode *alt);
164
165 void typec_altmode_update_active(struct typec_altmode *alt, bool active);
166
167 enum typec_plug_index {
168 TYPEC_PLUG_SOP_P,
169 TYPEC_PLUG_SOP_PP,
170 };
171
172 /*
173 * struct typec_plug_desc - USB Type-C Cable Plug Descriptor
174 * @index: SOP Prime for the plug connected to DFP and SOP Double Prime for the
175 * plug connected to UFP
176 *
177 * Represents USB Type-C Cable Plug.
178 */
179 struct typec_plug_desc {
180 enum typec_plug_index index;
181 };
182
183 /*
184 * struct typec_cable_desc - USB Type-C Cable Descriptor
185 * @type: The plug type from USB PD Cable VDO
186 * @active: Is the cable active or passive
187 * @identity: Result of Discover Identity command
188 * @pd_revision: USB Power Delivery Specification revision if supported
189 *
190 * Represents USB Type-C Cable attached to USB Type-C port.
191 */
192 struct typec_cable_desc {
193 enum typec_plug_type type;
194 unsigned int active:1;
195 struct usb_pd_identity *identity;
196 u16 pd_revision; /* 0300H = "3.0" */
197
198 };
199
200 /*
201 * struct typec_partner_desc - USB Type-C Partner Descriptor
202 * @usb_pd: USB Power Delivery support
203 * @accessory: Audio, Debug or none.
204 * @identity: Discover Identity command data
205 * @pd_revision: USB Power Delivery Specification Revision if supported
206 *
207 * Details about a partner that is attached to USB Type-C port. If @identity
208 * member exists when partner is registered, a directory named "identity" is
209 * created to sysfs for the partner device.
210 *
211 * @pd_revision is based on the setting of the "Specification Revision" field
212 * in the message header on the initial "Source Capabilities" message received
213 * from the partner, or a "Request" message received from the partner, depending
214 * on whether our port is a Sink or a Source.
215 */
216 struct typec_partner_desc {
217 unsigned int usb_pd:1;
218 enum typec_accessory accessory;
219 struct usb_pd_identity *identity;
220 u16 pd_revision; /* 0300H = "3.0" */
221 };
222
223 /**
224 * struct typec_operations - USB Type-C Port Operations
225 * @try_role: Set data role preference for DRP port
226 * @dr_set: Set Data Role
227 * @pr_set: Set Power Role
228 * @vconn_set: Source VCONN
229 * @port_type_set: Set port type
230 * @pd_get: Get available USB Power Delivery Capabilities.
231 * @pd_set: Set USB Power Delivery Capabilities.
232 */
233 struct typec_operations {
234 int (*try_role)(struct typec_port *port, int role);
235 int (*dr_set)(struct typec_port *port, enum typec_data_role role);
236 int (*pr_set)(struct typec_port *port, enum typec_role role);
237 int (*vconn_set)(struct typec_port *port, enum typec_role role);
238 int (*port_type_set)(struct typec_port *port,
239 enum typec_port_type type);
240 struct usb_power_delivery **(*pd_get)(struct typec_port *port);
241 int (*pd_set)(struct typec_port *port, struct usb_power_delivery *pd);
242
243 ANDROID_KABI_RESERVE(1);
244 ANDROID_KABI_RESERVE(2);
245 };
246
247 enum usb_pd_svdm_ver {
248 SVDM_VER_1_0 = 0,
249 SVDM_VER_2_0 = 1,
250 SVDM_VER_MAX = SVDM_VER_2_0,
251 };
252
253 /*
254 * struct typec_capability - USB Type-C Port Capabilities
255 * @type: Supported power role of the port
256 * @data: Supported data role of the port
257 * @revision: USB Type-C Specification release. Binary coded decimal
258 * @pd_revision: USB Power Delivery Specification revision if supported
259 * @svdm_version: USB PD Structured VDM version if supported
260 * @prefer_role: Initial role preference (DRP ports).
261 * @accessory: Supported Accessory Modes
262 * @fwnode: Optional fwnode of the port
263 * @driver_data: Private pointer for driver specific info
264 * @pd: Optional USB Power Delivery Support
265 * @ops: Port operations vector
266 *
267 * Static capabilities of a single USB Type-C port.
268 */
269 struct typec_capability {
270 enum typec_port_type type;
271 enum typec_port_data data;
272 u16 revision; /* 0120H = "1.2" */
273 u16 pd_revision; /* 0300H = "3.0" */
274 enum usb_pd_svdm_ver svdm_version;
275 int prefer_role;
276 enum typec_accessory accessory[TYPEC_MAX_ACCESSORY];
277 unsigned int orientation_aware:1;
278
279 struct fwnode_handle *fwnode;
280 void *driver_data;
281
282 struct usb_power_delivery *pd;
283
284 const struct typec_operations *ops;
285
286 ANDROID_KABI_RESERVE(1);
287 ANDROID_KABI_RESERVE(2);
288 };
289
290 /* Specific to try_role(). Indicates the user want's to clear the preference. */
291 #define TYPEC_NO_PREFERRED_ROLE (-1)
292
293 struct typec_port *typec_register_port(struct device *parent,
294 const struct typec_capability *cap);
295 void typec_unregister_port(struct typec_port *port);
296
297 struct typec_partner *typec_register_partner(struct typec_port *port,
298 struct typec_partner_desc *desc);
299 void typec_unregister_partner(struct typec_partner *partner);
300
301 struct typec_cable *typec_register_cable(struct typec_port *port,
302 struct typec_cable_desc *desc);
303 void typec_unregister_cable(struct typec_cable *cable);
304
305 struct typec_cable *typec_cable_get(struct typec_port *port);
306 void typec_cable_put(struct typec_cable *cable);
307 int typec_cable_is_active(struct typec_cable *cable);
308
309 struct typec_plug *typec_register_plug(struct typec_cable *cable,
310 struct typec_plug_desc *desc);
311 void typec_unregister_plug(struct typec_plug *plug);
312
313 void typec_set_data_role(struct typec_port *port, enum typec_data_role role);
314 void typec_set_pwr_role(struct typec_port *port, enum typec_role role);
315 void typec_set_vconn_role(struct typec_port *port, enum typec_role role);
316 void typec_set_pwr_opmode(struct typec_port *port, enum typec_pwr_opmode mode);
317
318 int typec_set_orientation(struct typec_port *port,
319 enum typec_orientation orientation);
320 enum typec_orientation typec_get_orientation(struct typec_port *port);
321 int typec_set_mode(struct typec_port *port, int mode);
322
323 void *typec_get_drvdata(struct typec_port *port);
324
325 int typec_get_fw_cap(struct typec_capability *cap,
326 struct fwnode_handle *fwnode);
327
328 int typec_find_pwr_opmode(const char *name);
329 int typec_find_orientation(const char *name);
330 int typec_find_port_power_role(const char *name);
331 int typec_find_power_role(const char *name);
332 int typec_find_port_data_role(const char *name);
333
334 void typec_partner_set_svdm_version(struct typec_partner *partner,
335 enum usb_pd_svdm_ver svdm_version);
336 int typec_get_negotiated_svdm_version(struct typec_port *port);
337
338 struct usb_power_delivery *typec_partner_usb_power_delivery_register(struct typec_partner *partner,
339 struct usb_power_delivery_desc *desc);
340
341 int typec_port_set_usb_power_delivery(struct typec_port *port, struct usb_power_delivery *pd);
342 int typec_partner_set_usb_power_delivery(struct typec_partner *partner,
343 struct usb_power_delivery *pd);
344
345 #endif /* __LINUX_USB_TYPEC_H */
346