1 /* USB OTG (On The Go) defines */
2 /*
3 *
4 * These APIs may be used between USB controllers. USB device drivers
5 * (for either host or peripheral roles) don't use these calls; they
6 * continue to use just usb_device and usb_gadget.
7 */
8
9 #ifndef __LINUX_USB_PHY_H
10 #define __LINUX_USB_PHY_H
11
12 #include <linux/notifier.h>
13 #include <linux/usb.h>
14
15 enum usb_phy_events {
16 USB_EVENT_NONE, /* no events or cable disconnected */
17 USB_EVENT_VBUS, /* vbus valid event */
18 USB_EVENT_ID, /* id was grounded */
19 USB_EVENT_CHARGER, /* usb dedicated charger */
20 USB_EVENT_ENUMERATED, /* gadget driver enumerated */
21 };
22
23 /* associate a type with PHY */
24 enum usb_phy_type {
25 USB_PHY_TYPE_UNDEFINED,
26 USB_PHY_TYPE_USB2,
27 USB_PHY_TYPE_USB3,
28 };
29
30 /* OTG defines lots of enumeration states before device reset */
31 enum usb_otg_state {
32 OTG_STATE_UNDEFINED = 0,
33
34 /* single-role peripheral, and dual-role default-b */
35 OTG_STATE_B_IDLE,
36 OTG_STATE_B_SRP_INIT,
37 OTG_STATE_B_PERIPHERAL,
38
39 /* extra dual-role default-b states */
40 OTG_STATE_B_WAIT_ACON,
41 OTG_STATE_B_HOST,
42
43 /* dual-role default-a */
44 OTG_STATE_A_IDLE,
45 OTG_STATE_A_WAIT_VRISE,
46 OTG_STATE_A_WAIT_BCON,
47 OTG_STATE_A_HOST,
48 OTG_STATE_A_SUSPEND,
49 OTG_STATE_A_PERIPHERAL,
50 OTG_STATE_A_WAIT_VFALL,
51 OTG_STATE_A_VBUS_ERR,
52 };
53
54 struct usb_phy;
55 struct usb_otg;
56
57 /* for transceivers connected thru an ULPI interface, the user must
58 * provide access ops
59 */
60 struct usb_phy_io_ops {
61 int (*read)(struct usb_phy *x, u32 reg);
62 int (*write)(struct usb_phy *x, u32 val, u32 reg);
63 };
64
65 struct usb_phy {
66 struct device *dev;
67 const char *label;
68 unsigned int flags;
69
70 enum usb_phy_type type;
71 enum usb_otg_state state;
72 enum usb_phy_events last_event;
73
74 struct usb_otg *otg;
75
76 struct device *io_dev;
77 struct usb_phy_io_ops *io_ops;
78 void __iomem *io_priv;
79
80 /* for notification of usb_phy_events */
81 struct atomic_notifier_head notifier;
82
83 /* to pass extra port status to the root hub */
84 u16 port_status;
85 u16 port_change;
86
87 /* to support controllers that have multiple transceivers */
88 struct list_head head;
89
90 /* initialize/shutdown the OTG controller */
91 int (*init)(struct usb_phy *x);
92 void (*shutdown)(struct usb_phy *x);
93
94 /* enable/disable VBUS */
95 int (*set_vbus)(struct usb_phy *x, int on);
96
97 /* effective for B devices, ignored for A-peripheral */
98 int (*set_power)(struct usb_phy *x,
99 unsigned mA);
100
101 /* for non-OTG B devices: set transceiver into suspend mode */
102 int (*set_suspend)(struct usb_phy *x,
103 int suspend);
104
105 /* notify phy connect status change */
106 int (*notify_connect)(struct usb_phy *x,
107 enum usb_device_speed speed);
108 int (*notify_disconnect)(struct usb_phy *x,
109 enum usb_device_speed speed);
110 };
111
112 /**
113 * struct usb_phy_bind - represent the binding for the phy
114 * @dev_name: the device name of the device that will bind to the phy
115 * @phy_dev_name: the device name of the phy
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;
126 };
127
128 /* for board-specific init logic */
129 extern int usb_add_phy(struct usb_phy *, enum usb_phy_type type);
130 extern int usb_add_phy_dev(struct usb_phy *);
131 extern void usb_remove_phy(struct usb_phy *);
132
133 /* helpers for direct access thru low-level io interface */
usb_phy_io_read(struct usb_phy * x,u32 reg)134 static inline int usb_phy_io_read(struct usb_phy *x, u32 reg)
135 {
136 if (x->io_ops && x->io_ops->read)
137 return x->io_ops->read(x, reg);
138
139 return -EINVAL;
140 }
141
usb_phy_io_write(struct usb_phy * x,u32 val,u32 reg)142 static inline int usb_phy_io_write(struct usb_phy *x, u32 val, u32 reg)
143 {
144 if (x->io_ops && x->io_ops->write)
145 return x->io_ops->write(x, val, reg);
146
147 return -EINVAL;
148 }
149
150 static inline int
usb_phy_init(struct usb_phy * x)151 usb_phy_init(struct usb_phy *x)
152 {
153 if (x->init)
154 return x->init(x);
155
156 return 0;
157 }
158
159 static inline void
usb_phy_shutdown(struct usb_phy * x)160 usb_phy_shutdown(struct usb_phy *x)
161 {
162 if (x->shutdown)
163 x->shutdown(x);
164 }
165
166 static inline int
usb_phy_vbus_on(struct usb_phy * x)167 usb_phy_vbus_on(struct usb_phy *x)
168 {
169 if (!x->set_vbus)
170 return 0;
171
172 return x->set_vbus(x, true);
173 }
174
175 static inline int
usb_phy_vbus_off(struct usb_phy * x)176 usb_phy_vbus_off(struct usb_phy *x)
177 {
178 if (!x->set_vbus)
179 return 0;
180
181 return x->set_vbus(x, false);
182 }
183
184 /* for usb host and peripheral controller drivers */
185 #if IS_ENABLED(CONFIG_USB_PHY)
186 extern struct usb_phy *usb_get_phy(enum usb_phy_type type);
187 extern struct usb_phy *devm_usb_get_phy(struct device *dev,
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);
191 extern struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
192 const char *phandle, u8 index);
193 extern void usb_put_phy(struct usb_phy *);
194 extern void devm_usb_put_phy(struct device *dev, struct usb_phy *x);
195 extern int usb_bind_phy(const char *dev_name, u8 index,
196 const char *phy_dev_name);
197 #else
usb_get_phy(enum usb_phy_type type)198 static inline struct usb_phy *usb_get_phy(enum usb_phy_type type)
199 {
200 return ERR_PTR(-ENXIO);
201 }
202
devm_usb_get_phy(struct device * dev,enum usb_phy_type type)203 static inline struct usb_phy *devm_usb_get_phy(struct device *dev,
204 enum usb_phy_type type)
205 {
206 return ERR_PTR(-ENXIO);
207 }
208
usb_get_phy_dev(struct device * dev,u8 index)209 static inline struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index)
210 {
211 return ERR_PTR(-ENXIO);
212 }
213
devm_usb_get_phy_dev(struct device * dev,u8 index)214 static inline struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index)
215 {
216 return ERR_PTR(-ENXIO);
217 }
218
devm_usb_get_phy_by_phandle(struct device * dev,const char * phandle,u8 index)219 static inline struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
220 const char *phandle, u8 index)
221 {
222 return ERR_PTR(-ENXIO);
223 }
224
usb_put_phy(struct usb_phy * x)225 static inline void usb_put_phy(struct usb_phy *x)
226 {
227 }
228
devm_usb_put_phy(struct device * dev,struct usb_phy * x)229 static inline void devm_usb_put_phy(struct device *dev, struct usb_phy *x)
230 {
231 }
232
usb_bind_phy(const char * dev_name,u8 index,const char * phy_dev_name)233 static inline int usb_bind_phy(const char *dev_name, u8 index,
234 const char *phy_dev_name)
235 {
236 return -EOPNOTSUPP;
237 }
238 #endif
239
240 static inline int
usb_phy_set_power(struct usb_phy * x,unsigned mA)241 usb_phy_set_power(struct usb_phy *x, unsigned mA)
242 {
243 if (x && x->set_power)
244 return x->set_power(x, mA);
245 return 0;
246 }
247
248 /* Context: can sleep */
249 static inline int
usb_phy_set_suspend(struct usb_phy * x,int suspend)250 usb_phy_set_suspend(struct usb_phy *x, int suspend)
251 {
252 if (x->set_suspend != NULL)
253 return x->set_suspend(x, suspend);
254 else
255 return 0;
256 }
257
258 static inline int
usb_phy_notify_connect(struct usb_phy * x,enum usb_device_speed speed)259 usb_phy_notify_connect(struct usb_phy *x, enum usb_device_speed speed)
260 {
261 if (x->notify_connect)
262 return x->notify_connect(x, speed);
263 else
264 return 0;
265 }
266
267 static inline int
usb_phy_notify_disconnect(struct usb_phy * x,enum usb_device_speed speed)268 usb_phy_notify_disconnect(struct usb_phy *x, enum usb_device_speed speed)
269 {
270 if (x->notify_disconnect)
271 return x->notify_disconnect(x, speed);
272 else
273 return 0;
274 }
275
276 /* notifiers */
277 static inline int
usb_register_notifier(struct usb_phy * x,struct notifier_block * nb)278 usb_register_notifier(struct usb_phy *x, struct notifier_block *nb)
279 {
280 return atomic_notifier_chain_register(&x->notifier, nb);
281 }
282
283 static inline void
usb_unregister_notifier(struct usb_phy * x,struct notifier_block * nb)284 usb_unregister_notifier(struct usb_phy *x, struct notifier_block *nb)
285 {
286 atomic_notifier_chain_unregister(&x->notifier, nb);
287 }
288
usb_phy_type_string(enum usb_phy_type type)289 static inline const char *usb_phy_type_string(enum usb_phy_type type)
290 {
291 switch (type) {
292 case USB_PHY_TYPE_USB2:
293 return "USB2 PHY";
294 case USB_PHY_TYPE_USB3:
295 return "USB3 PHY";
296 default:
297 return "UNKNOWN PHY TYPE";
298 }
299 }
300 #endif /* __LINUX_USB_PHY_H */
301