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
,
38 enum usb_xceiv_events
{
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 struct otg_transceiver
;
48 /* for transceivers connected thru an ULPI interface, the user must
51 struct otg_io_access_ops
{
52 int (*read
)(struct otg_transceiver
*otg
, u32 reg
);
53 int (*write
)(struct otg_transceiver
*otg
, u32 val
, u32 reg
);
57 * the otg driver needs to interact with both device side and host side
58 * usb controllers. it decides which controller is active at a given
59 * moment, using the transceiver, ID signal, HNP and sometimes static
60 * configuration information (including "board isn't wired for otg").
62 struct otg_transceiver
{
68 enum usb_otg_state state
;
71 struct usb_gadget
*gadget
;
73 struct otg_io_access_ops
*io_ops
;
74 void __iomem
*io_priv
;
76 /* for notification of usb_xceiv_events */
77 struct blocking_notifier_head notifier
;
79 /* to pass extra port status to the root hub */
83 /* initialize/shutdown the OTG controller */
84 int (*init
)(struct otg_transceiver
*otg
);
85 void (*shutdown
)(struct otg_transceiver
*otg
);
87 /* bind/unbind the host controller */
88 int (*set_host
)(struct otg_transceiver
*otg
,
89 struct usb_bus
*host
);
91 /* bind/unbind the peripheral controller */
92 int (*set_peripheral
)(struct otg_transceiver
*otg
,
93 struct usb_gadget
*gadget
);
95 /* effective for B devices, ignored for A-peripheral */
96 int (*set_power
)(struct otg_transceiver
*otg
,
99 /* effective for A-peripheral, ignored for B devices */
100 int (*set_vbus
)(struct otg_transceiver
*otg
,
103 /* for non-OTG B devices: set transceiver into suspend mode */
104 int (*set_suspend
)(struct otg_transceiver
*otg
,
107 /* for B devices only: start session with A-Host */
108 int (*start_srp
)(struct otg_transceiver
*otg
);
110 /* start or continue HNP role switch */
111 int (*start_hnp
)(struct otg_transceiver
*otg
);
116 /* for board-specific init logic */
117 extern int otg_set_transceiver(struct otg_transceiver
*);
119 #if defined(CONFIG_NOP_USB_XCEIV) || defined(CONFIG_NOP_USB_XCEIV_MODULE)
120 /* sometimes transceivers are accessed only through e.g. ULPI */
121 extern void usb_nop_xceiv_register(void);
122 extern void usb_nop_xceiv_unregister(void);
124 static inline void usb_nop_xceiv_register(void)
128 static inline void usb_nop_xceiv_unregister(void)
133 /* helpers for direct access thru low-level io interface */
134 static inline int otg_io_read(struct otg_transceiver
*otg
, u32 reg
)
136 if (otg
->io_ops
&& otg
->io_ops
->read
)
137 return otg
->io_ops
->read(otg
, reg
);
142 static inline int otg_io_write(struct otg_transceiver
*otg
, u32 val
, u32 reg
)
144 if (otg
->io_ops
&& otg
->io_ops
->write
)
145 return otg
->io_ops
->write(otg
, val
, reg
);
151 otg_init(struct otg_transceiver
*otg
)
154 return otg
->init(otg
);
160 otg_shutdown(struct otg_transceiver
*otg
)
166 /* for usb host and peripheral controller drivers */
167 #ifdef CONFIG_USB_OTG_UTILS
168 extern struct otg_transceiver
*otg_get_transceiver(void);
169 extern void otg_put_transceiver(struct otg_transceiver
*);
171 static inline struct otg_transceiver
*otg_get_transceiver(void)
176 static inline void otg_put_transceiver(struct otg_transceiver
*x
)
181 /* Context: can sleep */
183 otg_start_hnp(struct otg_transceiver
*otg
)
185 return otg
->start_hnp(otg
);
188 /* Context: can sleep */
190 otg_set_vbus(struct otg_transceiver
*otg
, bool enabled
)
192 return otg
->set_vbus(otg
, enabled
);
197 otg_set_host(struct otg_transceiver
*otg
, struct usb_bus
*host
)
199 return otg
->set_host(otg
, host
);
202 /* for usb peripheral controller drivers */
204 /* Context: can sleep */
206 otg_set_peripheral(struct otg_transceiver
*otg
, struct usb_gadget
*periph
)
208 return otg
->set_peripheral(otg
, periph
);
212 otg_set_power(struct otg_transceiver
*otg
, unsigned mA
)
214 return otg
->set_power(otg
, mA
);
217 /* Context: can sleep */
219 otg_set_suspend(struct otg_transceiver
*otg
, int suspend
)
221 if (otg
->set_suspend
!= NULL
)
222 return otg
->set_suspend(otg
, suspend
);
228 otg_start_srp(struct otg_transceiver
*otg
)
230 return otg
->start_srp(otg
);
235 otg_register_notifier(struct otg_transceiver
*otg
, struct notifier_block
*nb
)
237 return blocking_notifier_chain_register(&otg
->notifier
, nb
);
241 otg_unregister_notifier(struct otg_transceiver
*otg
, struct notifier_block
*nb
)
243 blocking_notifier_chain_unregister(&otg
->notifier
, nb
);
246 /* for OTG controller drivers (and maybe other stuff) */
247 extern int usb_bus_start_enum(struct usb_bus
*bus
, unsigned port_num
);
249 #endif /* __LINUX_USB_OTG_H */