1 /* SPDX-License-Identifier: GPL-2.0 */ !! 1 /* USB OTG (On The Go) defines */
2 /* 2 /*
3 * USB PHY defines <<
4 * 3 *
5 * These APIs may be used between USB controll 4 * These APIs may be used between USB controllers. USB device drivers
6 * (for either host or peripheral roles) don't 5 * (for either host or peripheral roles) don't use these calls; they
7 * continue to use just usb_device and usb_gad 6 * continue to use just usb_device and usb_gadget.
8 */ 7 */
9 8
10 #ifndef __LINUX_USB_PHY_H 9 #ifndef __LINUX_USB_PHY_H
11 #define __LINUX_USB_PHY_H 10 #define __LINUX_USB_PHY_H
12 11
13 #include <linux/extcon.h> <<
14 #include <linux/notifier.h> 12 #include <linux/notifier.h>
15 #include <linux/usb.h> 13 #include <linux/usb.h>
16 #include <uapi/linux/usb/charger.h> <<
17 <<
18 enum usb_phy_interface { <<
19 USBPHY_INTERFACE_MODE_UNKNOWN, <<
20 USBPHY_INTERFACE_MODE_UTMI, <<
21 USBPHY_INTERFACE_MODE_UTMIW, <<
22 USBPHY_INTERFACE_MODE_ULPI, <<
23 USBPHY_INTERFACE_MODE_SERIAL, <<
24 USBPHY_INTERFACE_MODE_HSIC, <<
25 }; <<
26 14
27 enum usb_phy_events { 15 enum usb_phy_events {
28 USB_EVENT_NONE, /* no events o 16 USB_EVENT_NONE, /* no events or cable disconnected */
29 USB_EVENT_VBUS, /* vbus valid 17 USB_EVENT_VBUS, /* vbus valid event */
30 USB_EVENT_ID, /* id was grou 18 USB_EVENT_ID, /* id was grounded */
31 USB_EVENT_CHARGER, /* usb dedicat 19 USB_EVENT_CHARGER, /* usb dedicated charger */
32 USB_EVENT_ENUMERATED, /* gadget driv 20 USB_EVENT_ENUMERATED, /* gadget driver enumerated */
33 }; 21 };
34 22
35 /* associate a type with PHY */ 23 /* associate a type with PHY */
36 enum usb_phy_type { 24 enum usb_phy_type {
37 USB_PHY_TYPE_UNDEFINED, 25 USB_PHY_TYPE_UNDEFINED,
38 USB_PHY_TYPE_USB2, 26 USB_PHY_TYPE_USB2,
39 USB_PHY_TYPE_USB3, 27 USB_PHY_TYPE_USB3,
40 }; 28 };
41 29
42 /* OTG defines lots of enumeration states befo 30 /* OTG defines lots of enumeration states before device reset */
43 enum usb_otg_state { 31 enum usb_otg_state {
44 OTG_STATE_UNDEFINED = 0, 32 OTG_STATE_UNDEFINED = 0,
45 33
46 /* single-role peripheral, and dual-ro 34 /* single-role peripheral, and dual-role default-b */
47 OTG_STATE_B_IDLE, 35 OTG_STATE_B_IDLE,
48 OTG_STATE_B_SRP_INIT, 36 OTG_STATE_B_SRP_INIT,
49 OTG_STATE_B_PERIPHERAL, 37 OTG_STATE_B_PERIPHERAL,
50 38
51 /* extra dual-role default-b states */ 39 /* extra dual-role default-b states */
52 OTG_STATE_B_WAIT_ACON, 40 OTG_STATE_B_WAIT_ACON,
53 OTG_STATE_B_HOST, 41 OTG_STATE_B_HOST,
54 42
55 /* dual-role default-a */ 43 /* dual-role default-a */
56 OTG_STATE_A_IDLE, 44 OTG_STATE_A_IDLE,
57 OTG_STATE_A_WAIT_VRISE, 45 OTG_STATE_A_WAIT_VRISE,
58 OTG_STATE_A_WAIT_BCON, 46 OTG_STATE_A_WAIT_BCON,
59 OTG_STATE_A_HOST, 47 OTG_STATE_A_HOST,
60 OTG_STATE_A_SUSPEND, 48 OTG_STATE_A_SUSPEND,
61 OTG_STATE_A_PERIPHERAL, 49 OTG_STATE_A_PERIPHERAL,
62 OTG_STATE_A_WAIT_VFALL, 50 OTG_STATE_A_WAIT_VFALL,
63 OTG_STATE_A_VBUS_ERR, 51 OTG_STATE_A_VBUS_ERR,
64 }; 52 };
65 53
66 struct usb_phy; 54 struct usb_phy;
67 struct usb_otg; 55 struct usb_otg;
68 56
69 /* for phys connected thru an ULPI interface, !! 57 /* for transceivers connected thru an ULPI interface, the user must
70 * provide access ops 58 * provide access ops
71 */ 59 */
72 struct usb_phy_io_ops { 60 struct usb_phy_io_ops {
73 int (*read)(struct usb_phy *x, u32 reg 61 int (*read)(struct usb_phy *x, u32 reg);
74 int (*write)(struct usb_phy *x, u32 va 62 int (*write)(struct usb_phy *x, u32 val, u32 reg);
75 }; 63 };
76 64
77 struct usb_charger_current { <<
78 unsigned int sdp_min; <<
79 unsigned int sdp_max; <<
80 unsigned int dcp_min; <<
81 unsigned int dcp_max; <<
82 unsigned int cdp_min; <<
83 unsigned int cdp_max; <<
84 unsigned int aca_min; <<
85 unsigned int aca_max; <<
86 }; <<
87 <<
88 struct usb_phy { 65 struct usb_phy {
89 struct device *dev; 66 struct device *dev;
90 const char *label; 67 const char *label;
91 unsigned int flags; 68 unsigned int flags;
92 69
93 enum usb_phy_type type; 70 enum usb_phy_type type;
>> 71 enum usb_otg_state state;
94 enum usb_phy_events last_event; 72 enum usb_phy_events last_event;
95 73
96 struct usb_otg *otg; 74 struct usb_otg *otg;
97 75
98 struct device *io_dev; 76 struct device *io_dev;
99 struct usb_phy_io_ops *io_ops; 77 struct usb_phy_io_ops *io_ops;
100 void __iomem *io_priv; 78 void __iomem *io_priv;
101 79
102 /* to support extcon device */ <<
103 struct extcon_dev *edev; <<
104 struct extcon_dev *id_edev; <<
105 struct notifier_block vbus_nb; <<
106 struct notifier_block id_nb; <<
107 struct notifier_block type_nb; <<
108 <<
109 /* Support USB charger */ <<
110 enum usb_charger_type chg_type; <<
111 enum usb_charger_state chg_state; <<
112 struct usb_charger_current chg_cu <<
113 struct work_struct chg_wo <<
114 <<
115 /* for notification of usb_phy_events 80 /* for notification of usb_phy_events */
116 struct atomic_notifier_head notifi 81 struct atomic_notifier_head notifier;
117 82
118 /* to pass extra port status to the ro 83 /* to pass extra port status to the root hub */
119 u16 port_status; 84 u16 port_status;
120 u16 port_change; 85 u16 port_change;
121 86
122 /* to support controllers that have mu !! 87 /* to support controllers that have multiple transceivers */
123 struct list_head head; 88 struct list_head head;
124 89
125 /* initialize/shutdown the phy */ !! 90 /* initialize/shutdown the OTG controller */
126 int (*init)(struct usb_phy *x); 91 int (*init)(struct usb_phy *x);
127 void (*shutdown)(struct usb_phy *x) 92 void (*shutdown)(struct usb_phy *x);
128 93
129 /* enable/disable VBUS */ 94 /* enable/disable VBUS */
130 int (*set_vbus)(struct usb_phy *x, 95 int (*set_vbus)(struct usb_phy *x, int on);
131 96
132 /* effective for B devices, ignored fo 97 /* effective for B devices, ignored for A-peripheral */
133 int (*set_power)(struct usb_phy *x 98 int (*set_power)(struct usb_phy *x,
134 unsigned mA); 99 unsigned mA);
135 100
136 /* Set phy into suspend mode */ !! 101 /* for non-OTG B devices: set transceiver into suspend mode */
137 int (*set_suspend)(struct usb_phy 102 int (*set_suspend)(struct usb_phy *x,
138 int suspend); 103 int suspend);
139 104
140 /* <<
141 * Set wakeup enable for PHY, in that <<
142 * woken up from suspend status due to <<
143 * like vbus change, dp/dm change and <<
144 */ <<
145 int (*set_wakeup)(struct usb_phy * <<
146 <<
147 /* notify phy connect status change */ 105 /* notify phy connect status change */
148 int (*notify_connect)(struct usb_p 106 int (*notify_connect)(struct usb_phy *x,
149 enum usb_device_speed 107 enum usb_device_speed speed);
150 int (*notify_disconnect)(struct us 108 int (*notify_disconnect)(struct usb_phy *x,
151 enum usb_device_speed 109 enum usb_device_speed speed);
>> 110 };
152 111
153 /* !! 112 /**
154 * Charger detection method can be imp !! 113 * struct usb_phy_bind - represent the binding for the phy
155 * manually detect the charger type. !! 114 * @dev_name: the device name of the device that will bind to the phy
156 */ !! 115 * @phy_dev_name: the device name of the phy
157 enum usb_charger_type (*charger_detect !! 116 * @index: used if a single controller uses multiple phys
>> 117 * @phy: reference to the phy
>> 118 * @list: to maintain a linked list of the binding information
>> 119 */
>> 120 struct usb_phy_bind {
>> 121 const char *dev_name;
>> 122 const char *phy_dev_name;
>> 123 u8 index;
>> 124 struct usb_phy *phy;
>> 125 struct list_head list;
158 }; 126 };
159 127
160 /* for board-specific init logic */ 128 /* for board-specific init logic */
161 extern int usb_add_phy(struct usb_phy *, enum 129 extern int usb_add_phy(struct usb_phy *, enum usb_phy_type type);
162 extern int usb_add_phy_dev(struct usb_phy *); 130 extern int usb_add_phy_dev(struct usb_phy *);
163 extern void usb_remove_phy(struct usb_phy *); 131 extern void usb_remove_phy(struct usb_phy *);
164 132
165 /* helpers for direct access thru low-level io 133 /* helpers for direct access thru low-level io interface */
166 static inline int usb_phy_io_read(struct usb_p 134 static inline int usb_phy_io_read(struct usb_phy *x, u32 reg)
167 { 135 {
168 if (x && x->io_ops && x->io_ops->read) !! 136 if (x->io_ops && x->io_ops->read)
169 return x->io_ops->read(x, reg) 137 return x->io_ops->read(x, reg);
170 138
171 return -EINVAL; 139 return -EINVAL;
172 } 140 }
173 141
174 static inline int usb_phy_io_write(struct usb_ 142 static inline int usb_phy_io_write(struct usb_phy *x, u32 val, u32 reg)
175 { 143 {
176 if (x && x->io_ops && x->io_ops->write !! 144 if (x->io_ops && x->io_ops->write)
177 return x->io_ops->write(x, val 145 return x->io_ops->write(x, val, reg);
178 146
179 return -EINVAL; 147 return -EINVAL;
180 } 148 }
181 149
182 static inline int 150 static inline int
183 usb_phy_init(struct usb_phy *x) 151 usb_phy_init(struct usb_phy *x)
184 { 152 {
185 if (x && x->init) !! 153 if (x->init)
186 return x->init(x); 154 return x->init(x);
187 155
188 return 0; 156 return 0;
189 } 157 }
190 158
191 static inline void 159 static inline void
192 usb_phy_shutdown(struct usb_phy *x) 160 usb_phy_shutdown(struct usb_phy *x)
193 { 161 {
194 if (x && x->shutdown) !! 162 if (x->shutdown)
195 x->shutdown(x); 163 x->shutdown(x);
196 } 164 }
197 165
198 static inline int 166 static inline int
199 usb_phy_vbus_on(struct usb_phy *x) 167 usb_phy_vbus_on(struct usb_phy *x)
200 { 168 {
201 if (!x || !x->set_vbus) !! 169 if (!x->set_vbus)
202 return 0; 170 return 0;
203 171
204 return x->set_vbus(x, true); 172 return x->set_vbus(x, true);
205 } 173 }
206 174
207 static inline int 175 static inline int
208 usb_phy_vbus_off(struct usb_phy *x) 176 usb_phy_vbus_off(struct usb_phy *x)
209 { 177 {
210 if (!x || !x->set_vbus) !! 178 if (!x->set_vbus)
211 return 0; 179 return 0;
212 180
213 return x->set_vbus(x, false); 181 return x->set_vbus(x, false);
214 } 182 }
215 183
216 /* for usb host and peripheral controller driv 184 /* for usb host and peripheral controller drivers */
217 #if IS_ENABLED(CONFIG_USB_PHY) 185 #if IS_ENABLED(CONFIG_USB_PHY)
218 extern struct usb_phy *usb_get_phy(enum usb_ph 186 extern struct usb_phy *usb_get_phy(enum usb_phy_type type);
219 extern struct usb_phy *devm_usb_get_phy(struct 187 extern struct usb_phy *devm_usb_get_phy(struct device *dev,
220 enum usb_phy_type type); 188 enum usb_phy_type type);
>> 189 extern struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index);
>> 190 extern struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index);
221 extern struct usb_phy *devm_usb_get_phy_by_pha 191 extern struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
222 const char *phandle, u8 index); 192 const char *phandle, u8 index);
223 extern struct usb_phy *devm_usb_get_phy_by_nod <<
224 struct device_node *node, struct notif <<
225 extern void usb_put_phy(struct usb_phy *); 193 extern void usb_put_phy(struct usb_phy *);
226 extern void devm_usb_put_phy(struct device *de 194 extern void devm_usb_put_phy(struct device *dev, struct usb_phy *x);
227 extern void usb_phy_set_event(struct usb_phy * !! 195 extern int usb_bind_phy(const char *dev_name, u8 index,
228 extern void usb_phy_set_charger_current(struct !! 196 const char *phy_dev_name);
229 unsign <<
230 extern void usb_phy_get_charger_current(struct <<
231 unsign <<
232 extern void usb_phy_set_charger_state(struct u <<
233 enum usb <<
234 #else 197 #else
235 static inline struct usb_phy *usb_get_phy(enum 198 static inline struct usb_phy *usb_get_phy(enum usb_phy_type type)
236 { 199 {
237 return ERR_PTR(-ENXIO); 200 return ERR_PTR(-ENXIO);
238 } 201 }
239 202
240 static inline struct usb_phy *devm_usb_get_phy 203 static inline struct usb_phy *devm_usb_get_phy(struct device *dev,
241 enum usb_phy_type type) 204 enum usb_phy_type type)
242 { 205 {
243 return ERR_PTR(-ENXIO); 206 return ERR_PTR(-ENXIO);
244 } 207 }
245 208
246 static inline struct usb_phy *devm_usb_get_phy !! 209 static inline struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index)
247 const char *phandle, u8 index) <<
248 { 210 {
249 return ERR_PTR(-ENXIO); 211 return ERR_PTR(-ENXIO);
250 } 212 }
251 213
252 static inline struct usb_phy *devm_usb_get_phy !! 214 static inline struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index)
253 struct device_node *node, struct notif <<
254 { 215 {
255 return ERR_PTR(-ENXIO); 216 return ERR_PTR(-ENXIO);
256 } 217 }
257 218
258 static inline void usb_put_phy(struct usb_phy !! 219 static inline struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
259 { !! 220 const char *phandle, u8 index)
260 } <<
261 <<
262 static inline void devm_usb_put_phy(struct dev <<
263 { <<
264 } <<
265 <<
266 static inline void usb_phy_set_event(struct us <<
267 { 221 {
>> 222 return ERR_PTR(-ENXIO);
268 } 223 }
269 224
270 static inline void usb_phy_set_charger_current !! 225 static inline void usb_put_phy(struct usb_phy *x)
271 <<
272 { 226 {
273 } 227 }
274 228
275 static inline void usb_phy_get_charger_current !! 229 static inline void devm_usb_put_phy(struct device *dev, struct usb_phy *x)
276 <<
277 <<
278 { 230 {
279 } 231 }
280 232
281 static inline void usb_phy_set_charger_state(s !! 233 static inline int usb_bind_phy(const char *dev_name, u8 index,
282 e !! 234 const char *phy_dev_name)
283 { 235 {
>> 236 return -EOPNOTSUPP;
284 } 237 }
285 #endif 238 #endif
286 239
287 static inline int 240 static inline int
288 usb_phy_set_power(struct usb_phy *x, unsigned 241 usb_phy_set_power(struct usb_phy *x, unsigned mA)
289 { 242 {
290 if (!x) !! 243 if (x && x->set_power)
291 return 0; <<
292 <<
293 usb_phy_set_charger_current(x, mA); <<
294 <<
295 if (x->set_power) <<
296 return x->set_power(x, mA); 244 return x->set_power(x, mA);
297 return 0; 245 return 0;
298 } 246 }
299 247
300 /* Context: can sleep */ 248 /* Context: can sleep */
301 static inline int 249 static inline int
302 usb_phy_set_suspend(struct usb_phy *x, int sus 250 usb_phy_set_suspend(struct usb_phy *x, int suspend)
303 { 251 {
304 if (x && x->set_suspend != NULL) !! 252 if (x->set_suspend != NULL)
305 return x->set_suspend(x, suspe 253 return x->set_suspend(x, suspend);
306 else 254 else
307 return 0; 255 return 0;
308 } 256 }
309 257
310 static inline int 258 static inline int
311 usb_phy_set_wakeup(struct usb_phy *x, bool ena <<
312 { <<
313 if (x && x->set_wakeup) <<
314 return x->set_wakeup(x, enable <<
315 else <<
316 return 0; <<
317 } <<
318 <<
319 static inline int <<
320 usb_phy_notify_connect(struct usb_phy *x, enum 259 usb_phy_notify_connect(struct usb_phy *x, enum usb_device_speed speed)
321 { 260 {
322 if (x && x->notify_connect) !! 261 if (x->notify_connect)
323 return x->notify_connect(x, sp 262 return x->notify_connect(x, speed);
324 else 263 else
325 return 0; 264 return 0;
326 } 265 }
327 266
328 static inline int 267 static inline int
329 usb_phy_notify_disconnect(struct usb_phy *x, e 268 usb_phy_notify_disconnect(struct usb_phy *x, enum usb_device_speed speed)
330 { 269 {
331 if (x && x->notify_disconnect) !! 270 if (x->notify_disconnect)
332 return x->notify_disconnect(x, 271 return x->notify_disconnect(x, speed);
333 else 272 else
334 return 0; 273 return 0;
335 } 274 }
336 275
337 /* notifiers */ 276 /* notifiers */
338 static inline int 277 static inline int
339 usb_register_notifier(struct usb_phy *x, struc 278 usb_register_notifier(struct usb_phy *x, struct notifier_block *nb)
340 { 279 {
341 return atomic_notifier_chain_register( 280 return atomic_notifier_chain_register(&x->notifier, nb);
342 } 281 }
343 282
344 static inline void 283 static inline void
345 usb_unregister_notifier(struct usb_phy *x, str 284 usb_unregister_notifier(struct usb_phy *x, struct notifier_block *nb)
346 { 285 {
347 atomic_notifier_chain_unregister(&x->n 286 atomic_notifier_chain_unregister(&x->notifier, nb);
348 } 287 }
349 288
350 static inline const char *usb_phy_type_string( 289 static inline const char *usb_phy_type_string(enum usb_phy_type type)
351 { 290 {
352 switch (type) { 291 switch (type) {
353 case USB_PHY_TYPE_USB2: 292 case USB_PHY_TYPE_USB2:
354 return "USB2 PHY"; 293 return "USB2 PHY";
355 case USB_PHY_TYPE_USB3: 294 case USB_PHY_TYPE_USB3:
356 return "USB3 PHY"; 295 return "USB3 PHY";
357 default: 296 default:
358 return "UNKNOWN PHY TYPE"; 297 return "UNKNOWN PHY TYPE";
359 } 298 }
360 } 299 }
361 #endif /* __LINUX_USB_PHY_H */ 300 #endif /* __LINUX_USB_PHY_H */
362 301
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.