Commit | Line | Data |
---|---|---|
41dceed5 | 1 | /* USB OTG (On The Go) defines */ |
1da177e4 | 2 | /* |
dda43a0e | 3 | * |
1da177e4 LT |
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 | ||
dda43a0e RD |
9 | #ifndef __LINUX_USB_OTG_H |
10 | #define __LINUX_USB_OTG_H | |
1da177e4 | 11 | |
e9a20171 FB |
12 | #include <linux/notifier.h> |
13 | ||
1da177e4 LT |
14 | /* OTG defines lots of enumeration states before device reset */ |
15 | enum usb_otg_state { | |
16 | OTG_STATE_UNDEFINED = 0, | |
17 | ||
18 | /* single-role peripheral, and dual-role default-b */ | |
19 | OTG_STATE_B_IDLE, | |
20 | OTG_STATE_B_SRP_INIT, | |
21 | OTG_STATE_B_PERIPHERAL, | |
22 | ||
23 | /* extra dual-role default-b states */ | |
24 | OTG_STATE_B_WAIT_ACON, | |
25 | OTG_STATE_B_HOST, | |
26 | ||
27 | /* dual-role default-a */ | |
28 | OTG_STATE_A_IDLE, | |
29 | OTG_STATE_A_WAIT_VRISE, | |
30 | OTG_STATE_A_WAIT_BCON, | |
31 | OTG_STATE_A_HOST, | |
32 | OTG_STATE_A_SUSPEND, | |
33 | OTG_STATE_A_PERIPHERAL, | |
34 | OTG_STATE_A_WAIT_VFALL, | |
35 | OTG_STATE_A_VBUS_ERR, | |
36 | }; | |
37 | ||
de07e18c | 38 | enum usb_phy_events { |
e9a20171 FB |
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 */ | |
44 | }; | |
45 | ||
86753811 | 46 | struct usb_phy; |
91c8a5a9 DM |
47 | |
48 | /* for transceivers connected thru an ULPI interface, the user must | |
49 | * provide access ops | |
50 | */ | |
7a8a3a9b | 51 | struct usb_phy_io_ops { |
86753811 HK |
52 | int (*read)(struct usb_phy *x, u32 reg); |
53 | int (*write)(struct usb_phy *x, u32 val, u32 reg); | |
91c8a5a9 DM |
54 | }; |
55 | ||
7a8a3a9b HK |
56 | struct usb_otg { |
57 | u8 default_a; | |
58 | ||
59 | struct usb_phy *phy; | |
60 | struct usb_bus *host; | |
61 | struct usb_gadget *gadget; | |
62 | ||
63 | /* bind/unbind the host controller */ | |
64 | int (*set_host)(struct usb_otg *otg, struct usb_bus *host); | |
65 | ||
66 | /* bind/unbind the peripheral controller */ | |
67 | int (*set_peripheral)(struct usb_otg *otg, | |
68 | struct usb_gadget *gadget); | |
69 | ||
70 | /* effective for A-peripheral, ignored for B devices */ | |
71 | int (*set_vbus)(struct usb_otg *otg, bool enabled); | |
72 | ||
73 | /* for B devices only: start session with A-Host */ | |
74 | int (*start_srp)(struct usb_otg *otg); | |
75 | ||
76 | /* start or continue HNP role switch */ | |
77 | int (*start_hnp)(struct usb_otg *otg); | |
78 | ||
79 | }; | |
80 | ||
1da177e4 LT |
81 | /* |
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"). | |
86 | */ | |
86753811 | 87 | struct usb_phy { |
1da177e4 LT |
88 | struct device *dev; |
89 | const char *label; | |
91c8a5a9 | 90 | unsigned int flags; |
1da177e4 | 91 | |
1da177e4 | 92 | enum usb_otg_state state; |
de07e18c | 93 | enum usb_phy_events last_event; |
1da177e4 | 94 | |
7a8a3a9b HK |
95 | struct usb_otg *otg; |
96 | ||
bf070bc1 | 97 | struct device *io_dev; |
7a8a3a9b HK |
98 | struct usb_phy_io_ops *io_ops; |
99 | void __iomem *io_priv; | |
91c8a5a9 | 100 | |
de07e18c | 101 | /* for notification of usb_phy_events */ |
cccad6d4 | 102 | struct atomic_notifier_head notifier; |
e9a20171 | 103 | |
1da177e4 LT |
104 | /* to pass extra port status to the root hub */ |
105 | u16 port_status; | |
106 | u16 port_change; | |
107 | ||
91c8a5a9 | 108 | /* initialize/shutdown the OTG controller */ |
86753811 HK |
109 | int (*init)(struct usb_phy *x); |
110 | void (*shutdown)(struct usb_phy *x); | |
91c8a5a9 | 111 | |
1da177e4 | 112 | /* effective for B devices, ignored for A-peripheral */ |
86753811 | 113 | int (*set_power)(struct usb_phy *x, |
1da177e4 LT |
114 | unsigned mA); |
115 | ||
4e67185a | 116 | /* for non-OTG B devices: set transceiver into suspend mode */ |
86753811 | 117 | int (*set_suspend)(struct usb_phy *x, |
4e67185a JY |
118 | int suspend); |
119 | ||
1da177e4 LT |
120 | }; |
121 | ||
122 | ||
123 | /* for board-specific init logic */ | |
7a8a3a9b | 124 | extern int usb_set_transceiver(struct usb_phy *); |
cc835e32 | 125 | |
352a3378 | 126 | #if defined(CONFIG_NOP_USB_XCEIV) || (defined(CONFIG_NOP_USB_XCEIV_MODULE) && defined(MODULE)) |
cc835e32 | 127 | /* sometimes transceivers are accessed only through e.g. ULPI */ |
f6d92a05 AKG |
128 | extern void usb_nop_xceiv_register(void); |
129 | extern void usb_nop_xceiv_unregister(void); | |
224e1542 MM |
130 | #else |
131 | static inline void usb_nop_xceiv_register(void) | |
132 | { | |
133 | } | |
134 | ||
135 | static inline void usb_nop_xceiv_unregister(void) | |
136 | { | |
137 | } | |
138 | #endif | |
1da177e4 | 139 | |
91c8a5a9 | 140 | /* helpers for direct access thru low-level io interface */ |
7a8a3a9b | 141 | static inline int usb_phy_io_read(struct usb_phy *x, u32 reg) |
91c8a5a9 | 142 | { |
86753811 HK |
143 | if (x->io_ops && x->io_ops->read) |
144 | return x->io_ops->read(x, reg); | |
91c8a5a9 DM |
145 | |
146 | return -EINVAL; | |
147 | } | |
148 | ||
7a8a3a9b | 149 | static inline int usb_phy_io_write(struct usb_phy *x, u32 val, u32 reg) |
91c8a5a9 | 150 | { |
86753811 HK |
151 | if (x->io_ops && x->io_ops->write) |
152 | return x->io_ops->write(x, val, reg); | |
91c8a5a9 DM |
153 | |
154 | return -EINVAL; | |
155 | } | |
156 | ||
157 | static inline int | |
7a8a3a9b | 158 | usb_phy_init(struct usb_phy *x) |
91c8a5a9 | 159 | { |
86753811 HK |
160 | if (x->init) |
161 | return x->init(x); | |
91c8a5a9 DM |
162 | |
163 | return 0; | |
164 | } | |
165 | ||
166 | static inline void | |
7a8a3a9b | 167 | usb_phy_shutdown(struct usb_phy *x) |
91c8a5a9 | 168 | { |
86753811 HK |
169 | if (x->shutdown) |
170 | x->shutdown(x); | |
91c8a5a9 | 171 | } |
1da177e4 LT |
172 | |
173 | /* for usb host and peripheral controller drivers */ | |
748eee09 | 174 | #ifdef CONFIG_USB_OTG_UTILS |
7a8a3a9b HK |
175 | extern struct usb_phy *usb_get_transceiver(void); |
176 | extern void usb_put_transceiver(struct usb_phy *); | |
3df00453 | 177 | extern const char *otg_state_string(enum usb_otg_state state); |
748eee09 | 178 | #else |
7a8a3a9b | 179 | static inline struct usb_phy *usb_get_transceiver(void) |
748eee09 GI |
180 | { |
181 | return NULL; | |
182 | } | |
183 | ||
7a8a3a9b | 184 | static inline void usb_put_transceiver(struct usb_phy *x) |
748eee09 GI |
185 | { |
186 | } | |
3df00453 AG |
187 | |
188 | static inline const char *otg_state_string(enum usb_otg_state state) | |
189 | { | |
190 | return NULL; | |
191 | } | |
748eee09 | 192 | #endif |
1da177e4 | 193 | |
c2344f13 | 194 | /* Context: can sleep */ |
1da177e4 | 195 | static inline int |
6e13c650 | 196 | otg_start_hnp(struct usb_otg *otg) |
1da177e4 | 197 | { |
6e13c650 HK |
198 | if (otg && otg->start_hnp) |
199 | return otg->start_hnp(otg); | |
7a8a3a9b | 200 | |
136ced89 | 201 | return -ENOTSUPP; |
1da177e4 LT |
202 | } |
203 | ||
91c8a5a9 DM |
204 | /* Context: can sleep */ |
205 | static inline int | |
6e13c650 | 206 | otg_set_vbus(struct usb_otg *otg, bool enabled) |
91c8a5a9 | 207 | { |
6e13c650 HK |
208 | if (otg && otg->set_vbus) |
209 | return otg->set_vbus(otg, enabled); | |
7a8a3a9b | 210 | |
136ced89 | 211 | return -ENOTSUPP; |
91c8a5a9 | 212 | } |
1da177e4 LT |
213 | |
214 | /* for HCDs */ | |
215 | static inline int | |
6e13c650 | 216 | otg_set_host(struct usb_otg *otg, struct usb_bus *host) |
1da177e4 | 217 | { |
6e13c650 HK |
218 | if (otg && otg->set_host) |
219 | return otg->set_host(otg, host); | |
7a8a3a9b | 220 | |
136ced89 | 221 | return -ENOTSUPP; |
1da177e4 LT |
222 | } |
223 | ||
1da177e4 | 224 | /* for usb peripheral controller drivers */ |
c2344f13 RJ |
225 | |
226 | /* Context: can sleep */ | |
1da177e4 | 227 | static inline int |
6e13c650 | 228 | otg_set_peripheral(struct usb_otg *otg, struct usb_gadget *periph) |
1da177e4 | 229 | { |
6e13c650 HK |
230 | if (otg && otg->set_peripheral) |
231 | return otg->set_peripheral(otg, periph); | |
7a8a3a9b | 232 | |
136ced89 | 233 | return -ENOTSUPP; |
1da177e4 LT |
234 | } |
235 | ||
236 | static inline int | |
7a8a3a9b | 237 | usb_phy_set_power(struct usb_phy *x, unsigned mA) |
1da177e4 | 238 | { |
7a8a3a9b HK |
239 | if (x && x->set_power) |
240 | return x->set_power(x, mA); | |
241 | return 0; | |
1da177e4 LT |
242 | } |
243 | ||
c2344f13 | 244 | /* Context: can sleep */ |
4e67185a | 245 | static inline int |
7a8a3a9b | 246 | usb_phy_set_suspend(struct usb_phy *x, int suspend) |
4e67185a | 247 | { |
86753811 HK |
248 | if (x->set_suspend != NULL) |
249 | return x->set_suspend(x, suspend); | |
4e67185a JY |
250 | else |
251 | return 0; | |
252 | } | |
253 | ||
1da177e4 | 254 | static inline int |
6e13c650 | 255 | otg_start_srp(struct usb_otg *otg) |
1da177e4 | 256 | { |
6e13c650 HK |
257 | if (otg && otg->start_srp) |
258 | return otg->start_srp(otg); | |
7a8a3a9b | 259 | |
136ced89 | 260 | return -ENOTSUPP; |
1da177e4 LT |
261 | } |
262 | ||
e9a20171 FB |
263 | /* notifiers */ |
264 | static inline int | |
7a8a3a9b | 265 | usb_register_notifier(struct usb_phy *x, struct notifier_block *nb) |
e9a20171 | 266 | { |
86753811 | 267 | return atomic_notifier_chain_register(&x->notifier, nb); |
e9a20171 FB |
268 | } |
269 | ||
270 | static inline void | |
7a8a3a9b | 271 | usb_unregister_notifier(struct usb_phy *x, struct notifier_block *nb) |
e9a20171 | 272 | { |
86753811 | 273 | atomic_notifier_chain_unregister(&x->notifier, nb); |
e9a20171 | 274 | } |
1da177e4 LT |
275 | |
276 | /* for OTG controller drivers (and maybe other stuff) */ | |
277 | extern int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num); | |
dda43a0e RD |
278 | |
279 | #endif /* __LINUX_USB_OTG_H */ |