Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
15enum 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 */
24enum 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 */
31enum 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
54struct usb_phy;
55struct usb_otg;
56
57/* for transceivers connected thru an ULPI interface, the user must
58 * provide access ops
59 */
60struct 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
65struct 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 /* effective for B devices, ignored for A-peripheral */
95 int (*set_power)(struct usb_phy *x,
96 unsigned mA);
97
98 /* for non-OTG B devices: set transceiver into suspend mode */
99 int (*set_suspend)(struct usb_phy *x,
100 int suspend);
101
102 /* notify phy connect status change */
103 int (*notify_connect)(struct usb_phy *x,
104 enum usb_device_speed speed);
105 int (*notify_disconnect)(struct usb_phy *x,
106 enum usb_device_speed speed);
107};
108
109/**
110 * struct usb_phy_bind - represent the binding for the phy
111 * @dev_name: the device name of the device that will bind to the phy
112 * @phy_dev_name: the device name of the phy
113 * @index: used if a single controller uses multiple phys
114 * @phy: reference to the phy
115 * @list: to maintain a linked list of the binding information
116 */
117struct usb_phy_bind {
118 const char *dev_name;
119 const char *phy_dev_name;
120 u8 index;
121 struct usb_phy *phy;
122 struct list_head list;
123};
124
125/* for board-specific init logic */
126extern int usb_add_phy(struct usb_phy *, enum usb_phy_type type);
127extern int usb_add_phy_dev(struct usb_phy *);
128extern void usb_remove_phy(struct usb_phy *);
129
130/* helpers for direct access thru low-level io interface */
131static inline int usb_phy_io_read(struct usb_phy *x, u32 reg)
132{
133 if (x->io_ops && x->io_ops->read)
134 return x->io_ops->read(x, reg);
135
136 return -EINVAL;
137}
138
139static inline int usb_phy_io_write(struct usb_phy *x, u32 val, u32 reg)
140{
141 if (x->io_ops && x->io_ops->write)
142 return x->io_ops->write(x, val, reg);
143
144 return -EINVAL;
145}
146
147static inline int
148usb_phy_init(struct usb_phy *x)
149{
150 if (x->init)
151 return x->init(x);
152
153 return 0;
154}
155
156static inline void
157usb_phy_shutdown(struct usb_phy *x)
158{
159 if (x->shutdown)
160 x->shutdown(x);
161}
162
163/* for usb host and peripheral controller drivers */
164#ifdef CONFIG_USB_OTG_UTILS
165extern struct usb_phy *usb_get_phy(enum usb_phy_type type);
166extern struct usb_phy *devm_usb_get_phy(struct device *dev,
167 enum usb_phy_type type);
168extern struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index);
169extern struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index);
170extern struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
171 const char *phandle, u8 index);
172extern void usb_put_phy(struct usb_phy *);
173extern void devm_usb_put_phy(struct device *dev, struct usb_phy *x);
174extern int usb_bind_phy(const char *dev_name, u8 index,
175 const char *phy_dev_name);
176#else
177static inline struct usb_phy *usb_get_phy(enum usb_phy_type type)
178{
179 return NULL;
180}
181
182static inline struct usb_phy *devm_usb_get_phy(struct device *dev,
183 enum usb_phy_type type)
184{
185 return NULL;
186}
187
188static inline struct usb_phy *usb_get_phy_dev(struct device *dev, u8 index)
189{
190 return NULL;
191}
192
193static inline struct usb_phy *devm_usb_get_phy_dev(struct device *dev, u8 index)
194{
195 return NULL;
196}
197
198static inline struct usb_phy *devm_usb_get_phy_by_phandle(struct device *dev,
199 const char *phandle, u8 index)
200{
201 return NULL;
202}
203
204static inline void usb_put_phy(struct usb_phy *x)
205{
206}
207
208static inline void devm_usb_put_phy(struct device *dev, struct usb_phy *x)
209{
210}
211
212static inline int usb_bind_phy(const char *dev_name, u8 index,
213 const char *phy_dev_name)
214{
215 return -EOPNOTSUPP;
216}
217#endif
218
219static inline int
220usb_phy_set_power(struct usb_phy *x, unsigned mA)
221{
222 if (x && x->set_power)
223 return x->set_power(x, mA);
224 return 0;
225}
226
227/* Context: can sleep */
228static inline int
229usb_phy_set_suspend(struct usb_phy *x, int suspend)
230{
231 if (x->set_suspend != NULL)
232 return x->set_suspend(x, suspend);
233 else
234 return 0;
235}
236
237static inline int
238usb_phy_notify_connect(struct usb_phy *x, enum usb_device_speed speed)
239{
240 if (x->notify_connect)
241 return x->notify_connect(x, speed);
242 else
243 return 0;
244}
245
246static inline int
247usb_phy_notify_disconnect(struct usb_phy *x, enum usb_device_speed speed)
248{
249 if (x->notify_disconnect)
250 return x->notify_disconnect(x, speed);
251 else
252 return 0;
253}
254
255/* notifiers */
256static inline int
257usb_register_notifier(struct usb_phy *x, struct notifier_block *nb)
258{
259 return atomic_notifier_chain_register(&x->notifier, nb);
260}
261
262static inline void
263usb_unregister_notifier(struct usb_phy *x, struct notifier_block *nb)
264{
265 atomic_notifier_chain_unregister(&x->notifier, nb);
266}
267
268static inline const char *usb_phy_type_string(enum usb_phy_type type)
269{
270 switch (type) {
271 case USB_PHY_TYPE_USB2:
272 return "USB2 PHY";
273 case USB_PHY_TYPE_USB3:
274 return "USB3 PHY";
275 default:
276 return "UNKNOWN PHY TYPE";
277 }
278}
279#endif /* __LINUX_USB_PHY_H */