1 /* USB OTG (On The Go) defines */
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.
9 #ifndef __LINUX_USB_OTG_H
10 #define __LINUX_USB_OTG_H
12 #include <linux/notifier.h>
14 /* OTG defines lots of enumeration states before device reset */
16 OTG_STATE_UNDEFINED = 0,
18 /* single-role peripheral, and dual-role default-b */
21 OTG_STATE_B_PERIPHERAL,
23 /* extra dual-role default-b states */
24 OTG_STATE_B_WAIT_ACON,
27 /* dual-role default-a */
29 OTG_STATE_A_WAIT_VRISE,
30 OTG_STATE_A_WAIT_BCON,
33 OTG_STATE_A_PERIPHERAL,
34 OTG_STATE_A_WAIT_VFALL,
39 USB_EVENT_NONE, /* no events or cable disconnected */
40 USB_EVENT_VBUS, /* vbus valid event */
41 USB_EVENT_ID, /* id was grounded */
42 USB_EVENT_CHARGER, /* usb dedicated charger */
43 USB_EVENT_ENUMERATED, /* gadget driver enumerated */
46 /* associate a type with PHY */
48 USB_PHY_TYPE_UNDEFINED,
55 /* for transceivers connected thru an ULPI interface, the user must
58 struct usb_phy_io_ops {
59 int (*read)(struct usb_phy *x, u32 reg);
60 int (*write)(struct usb_phy *x, u32 val, u32 reg);
68 struct usb_gadget *gadget;
70 /* bind/unbind the host controller */
71 int (*set_host)(struct usb_otg *otg, struct usb_bus *host);
73 /* bind/unbind the peripheral controller */
74 int (*set_peripheral)(struct usb_otg *otg,
75 struct usb_gadget *gadget);
77 /* effective for A-peripheral, ignored for B devices */
78 int (*set_vbus)(struct usb_otg *otg, bool enabled);
80 /* for B devices only: start session with A-Host */
81 int (*start_srp)(struct usb_otg *otg);
83 /* start or continue HNP role switch */
84 int (*start_hnp)(struct usb_otg *otg);
89 * the otg driver needs to interact with both device side and host side
90 * usb controllers. it decides which controller is active at a given
91 * moment, using the transceiver, ID signal, HNP and sometimes static
92 * configuration information (including "board isn't wired for otg").
99 enum usb_phy_type type;
100 enum usb_otg_state state;
101 enum usb_phy_events last_event;
105 struct device *io_dev;
106 struct usb_phy_io_ops *io_ops;
107 void __iomem *io_priv;
109 /* for notification of usb_phy_events */
110 struct atomic_notifier_head notifier;
112 /* to pass extra port status to the root hub */
116 /* to support controllers that have multiple transceivers */
117 struct list_head head;
119 /* initialize/shutdown the OTG controller */
120 int (*init)(struct usb_phy *x);
121 void (*shutdown)(struct usb_phy *x);
123 /* effective for B devices, ignored for A-peripheral */
124 int (*set_power)(struct usb_phy *x,
127 /* for non-OTG B devices: set transceiver into suspend mode */
128 int (*set_suspend)(struct usb_phy *x,
131 /* notify phy connect status change */
132 int (*notify_connect)(struct usb_phy *x, int port);
133 int (*notify_disconnect)(struct usb_phy *x, int port);
137 /* for board-specific init logic */
138 extern int usb_add_phy(struct usb_phy *, enum usb_phy_type type);
139 extern void usb_remove_phy(struct usb_phy *);
141 #if defined(CONFIG_NOP_USB_XCEIV) || (defined(CONFIG_NOP_USB_XCEIV_MODULE) && defined(MODULE))
142 /* sometimes transceivers are accessed only through e.g. ULPI */
143 extern void usb_nop_xceiv_register(void);
144 extern void usb_nop_xceiv_unregister(void);
146 static inline void usb_nop_xceiv_register(void)
150 static inline void usb_nop_xceiv_unregister(void)
155 /* helpers for direct access thru low-level io interface */
156 static inline int usb_phy_io_read(struct usb_phy *x, u32 reg)
158 if (x->io_ops && x->io_ops->read)
159 return x->io_ops->read(x, reg);
164 static inline int usb_phy_io_write(struct usb_phy *x, u32 val, u32 reg)
166 if (x->io_ops && x->io_ops->write)
167 return x->io_ops->write(x, val, reg);
173 usb_phy_init(struct usb_phy *x)
182 usb_phy_shutdown(struct usb_phy *x)
188 /* for usb host and peripheral controller drivers */
189 #ifdef CONFIG_USB_OTG_UTILS
190 extern struct usb_phy *usb_get_phy(enum usb_phy_type type);
191 extern struct usb_phy *devm_usb_get_phy(struct device *dev,
192 enum usb_phy_type type);
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 const char *otg_state_string(enum usb_otg_state state);
197 static inline struct usb_phy *usb_get_phy(enum usb_phy_type type)
202 static inline struct usb_phy *devm_usb_get_phy(struct device *dev,
203 enum usb_phy_type type)
208 static inline void usb_put_phy(struct usb_phy *x)
212 static inline void devm_usb_put_phy(struct device *dev, struct usb_phy *x)
216 static inline const char *otg_state_string(enum usb_otg_state state)
222 /* Context: can sleep */
224 otg_start_hnp(struct usb_otg *otg)
226 if (otg && otg->start_hnp)
227 return otg->start_hnp(otg);
232 /* Context: can sleep */
234 otg_set_vbus(struct usb_otg *otg, bool enabled)
236 if (otg && otg->set_vbus)
237 return otg->set_vbus(otg, enabled);
244 otg_set_host(struct usb_otg *otg, struct usb_bus *host)
246 if (otg && otg->set_host)
247 return otg->set_host(otg, host);
252 /* for usb peripheral controller drivers */
254 /* Context: can sleep */
256 otg_set_peripheral(struct usb_otg *otg, struct usb_gadget *periph)
258 if (otg && otg->set_peripheral)
259 return otg->set_peripheral(otg, periph);
265 usb_phy_set_power(struct usb_phy *x, unsigned mA)
267 if (x && x->set_power)
268 return x->set_power(x, mA);
272 /* Context: can sleep */
274 usb_phy_set_suspend(struct usb_phy *x, int suspend)
276 if (x->set_suspend != NULL)
277 return x->set_suspend(x, suspend);
283 usb_phy_notify_connect(struct usb_phy *x, int port)
285 if (x->notify_connect)
286 return x->notify_connect(x, port);
292 usb_phy_notify_disconnect(struct usb_phy *x, int port)
294 if (x->notify_disconnect)
295 return x->notify_disconnect(x, port);
301 otg_start_srp(struct usb_otg *otg)
303 if (otg && otg->start_srp)
304 return otg->start_srp(otg);
311 usb_register_notifier(struct usb_phy *x, struct notifier_block *nb)
313 return atomic_notifier_chain_register(&x->notifier, nb);
317 usb_unregister_notifier(struct usb_phy *x, struct notifier_block *nb)
319 atomic_notifier_chain_unregister(&x->notifier, nb);
322 /* for OTG controller drivers (and maybe other stuff) */
323 extern int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num);
325 static inline const char *usb_phy_type_string(enum usb_phy_type type)
328 case USB_PHY_TYPE_USB2:
330 case USB_PHY_TYPE_USB3:
333 return "UNKNOWN PHY TYPE";
336 #endif /* __LINUX_USB_OTG_H */