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 */
48 /* for transceivers connected thru an ULPI interface, the user must
51 struct usb_phy_io_ops {
52 int (*read)(struct usb_phy *x, u32 reg);
53 int (*write)(struct usb_phy *x, u32 val, u32 reg);
61 struct usb_gadget *gadget;
63 /* bind/unbind the host controller */
64 int (*set_host)(struct usb_otg *otg, struct usb_bus *host);
66 /* bind/unbind the peripheral controller */
67 int (*set_peripheral)(struct usb_otg *otg,
68 struct usb_gadget *gadget);
70 /* effective for A-peripheral, ignored for B devices */
71 int (*set_vbus)(struct usb_otg *otg, bool enabled);
73 /* for B devices only: start session with A-Host */
74 int (*start_srp)(struct usb_otg *otg);
76 /* start or continue HNP role switch */
77 int (*start_hnp)(struct usb_otg *otg);
82 * the otg driver needs to interact with both device side and host side
83 * usb controllers. it decides which controller is active at a given
84 * moment, using the transceiver, ID signal, HNP and sometimes static
85 * configuration information (including "board isn't wired for otg").
92 enum usb_otg_state state;
93 enum usb_phy_events last_event;
97 struct device *io_dev;
98 struct usb_phy_io_ops *io_ops;
99 void __iomem *io_priv;
101 /* for notification of usb_phy_events */
102 struct atomic_notifier_head notifier;
104 /* to pass extra port status to the root hub */
108 /* initialize/shutdown the OTG controller */
109 int (*init)(struct usb_phy *x);
110 void (*shutdown)(struct usb_phy *x);
112 /* effective for B devices, ignored for A-peripheral */
113 int (*set_power)(struct usb_phy *x,
116 /* for non-OTG B devices: set transceiver into suspend mode */
117 int (*set_suspend)(struct usb_phy *x,
123 /* for board-specific init logic */
124 extern int usb_set_transceiver(struct usb_phy *);
126 #if defined(CONFIG_NOP_USB_XCEIV) || (defined(CONFIG_NOP_USB_XCEIV_MODULE) && defined(MODULE))
127 /* sometimes transceivers are accessed only through e.g. ULPI */
128 extern void usb_nop_xceiv_register(void);
129 extern void usb_nop_xceiv_unregister(void);
131 static inline void usb_nop_xceiv_register(void)
135 static inline void usb_nop_xceiv_unregister(void)
140 /* helpers for direct access thru low-level io interface */
141 static inline int usb_phy_io_read(struct usb_phy *x, u32 reg)
143 if (x->io_ops && x->io_ops->read)
144 return x->io_ops->read(x, reg);
149 static inline int usb_phy_io_write(struct usb_phy *x, u32 val, u32 reg)
151 if (x->io_ops && x->io_ops->write)
152 return x->io_ops->write(x, val, reg);
158 usb_phy_init(struct usb_phy *x)
167 usb_phy_shutdown(struct usb_phy *x)
173 /* for usb host and peripheral controller drivers */
174 #ifdef CONFIG_USB_OTG_UTILS
175 extern struct usb_phy *usb_get_transceiver(void);
176 extern void usb_put_transceiver(struct usb_phy *);
177 extern const char *otg_state_string(enum usb_otg_state state);
179 static inline struct usb_phy *usb_get_transceiver(void)
184 static inline void usb_put_transceiver(struct usb_phy *x)
188 static inline const char *otg_state_string(enum usb_otg_state state)
194 /* Context: can sleep */
196 otg_start_hnp(struct usb_otg *otg)
198 if (otg && otg->start_hnp)
199 return otg->start_hnp(otg);
204 /* Context: can sleep */
206 otg_set_vbus(struct usb_otg *otg, bool enabled)
208 if (otg && otg->set_vbus)
209 return otg->set_vbus(otg, enabled);
216 otg_set_host(struct usb_otg *otg, struct usb_bus *host)
218 if (otg && otg->set_host)
219 return otg->set_host(otg, host);
224 /* for usb peripheral controller drivers */
226 /* Context: can sleep */
228 otg_set_peripheral(struct usb_otg *otg, struct usb_gadget *periph)
230 if (otg && otg->set_peripheral)
231 return otg->set_peripheral(otg, periph);
237 usb_phy_set_power(struct usb_phy *x, unsigned mA)
239 if (x && x->set_power)
240 return x->set_power(x, mA);
244 /* Context: can sleep */
246 usb_phy_set_suspend(struct usb_phy *x, int suspend)
248 if (x->set_suspend != NULL)
249 return x->set_suspend(x, suspend);
255 otg_start_srp(struct usb_otg *otg)
257 if (otg && otg->start_srp)
258 return otg->start_srp(otg);
265 usb_register_notifier(struct usb_phy *x, struct notifier_block *nb)
267 return atomic_notifier_chain_register(&x->notifier, nb);
271 usb_unregister_notifier(struct usb_phy *x, struct notifier_block *nb)
273 atomic_notifier_chain_unregister(&x->notifier, nb);
276 /* for OTG controller drivers (and maybe other stuff) */
277 extern int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num);
279 #endif /* __LINUX_USB_OTG_H */