dwc2.h revision 1.7 1 /* $NetBSD: dwc2.h,v 1.7 2015/08/30 13:02:42 skrll Exp $ */
2
3 /*-
4 * Copyright (c) 2013 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Nick Hudson
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef _EXTERNAL_BSD_DWC2_DWC2_H_
33 #define _EXTERNAL_BSD_DWC2_DWC2_H_
34
35 #include <sys/param.h>
36
37 #include <sys/callout.h>
38 #include <sys/kernel.h>
39 #include <sys/proc.h>
40 #include <sys/workqueue.h>
41
42 #include <linux/list.h>
43
44 #include "opt_usb.h"
45 // #define VERBOSE_DEBUG
46 // #define DWC2_DUMP_FRREM
47 // #define CONFIG_USB_DWC2_TRACK_MISSED_SOFS
48
49 #define CONFIG_USB_DWC2_HOST 1
50 #define CONFIG_USB_DWC2_DUAL_ROLE 0
51 #define CONFIG_USB_DWC2_PERIPHERAL 0
52
53 typedef int irqreturn_t;
54 #define IRQ_NONE 0
55 #define IRQ_HANDLED 1
56
57 #define u8 uint8_t
58 #define u16 uint16_t
59 #define s16 int16_t
60 #define u32 uint32_t
61 #define u64 uint64_t
62
63 #define dma_addr_t bus_addr_t
64
65 #define DWC2_READ_4(hsotg, reg) \
66 bus_space_read_4((hsotg)->hsotg_sc->sc_iot, (hsotg)->hsotg_sc->sc_ioh, (reg))
67 #define DWC2_WRITE_4(hsotg, reg, data) \
68 bus_space_write_4((hsotg)->hsotg_sc->sc_iot, (hsotg)->hsotg_sc->sc_ioh, (reg), (data));
69
70 #ifdef DWC2_DEBUG
71 extern int dwc2debug;
72 #define WARN_ON(x) KASSERT(!(x))
73
74 #define dev_info(d,fmt,...) do { \
75 printf("%s: " fmt, device_xname(d), \
76 ## __VA_ARGS__); \
77 } while (0)
78 #define dev_warn(d,fmt,...) do { \
79 printf("%s: " fmt, device_xname(d), \
80 ## __VA_ARGS__); \
81 } while (0)
82 #define dev_err(d,fmt,...) do { \
83 printf("%s: " fmt, device_xname(d), \
84 ## __VA_ARGS__); \
85 } while (0)
86 #define dev_dbg(d,fmt,...) do { \
87 if (dwc2debug >= 1) { \
88 printf("%s: " fmt, device_xname(d), \
89 ## __VA_ARGS__); \
90 } \
91 } while (0)
92 #define dev_vdbg(d,fmt,...) do { \
93 if (dwc2debug >= 2) { \
94 printf("%s: " fmt, device_xname(d), \
95 ## __VA_ARGS__); \
96 } \
97 } while (0)
98 #else
99 #define WARN_ON(x)
100 #define dev_info(...) do { } while (0)
101 #define dev_warn(...) do { } while (0)
102 #define dev_err(...) do { } while (0)
103 #define dev_dbg(...) do { } while (0)
104 #define dev_vdbg(...) do { } while (0)
105 #endif
106
107 #define jiffies hardclock_ticks
108 #define msecs_to_jiffies mstohz
109
110 #define gfp_t int
111 #define GFP_KERNEL KM_SLEEP
112 #define GFP_ATOMIC KM_NOSLEEP
113
114 enum usb_otg_state {
115 OTG_STATE_RESERVED = 0,
116
117 OTG_STATE_A_HOST,
118 OTG_STATE_A_PERIPHERAL,
119 OTG_STATE_A_SUSPEND,
120 OTG_STATE_B_HOST,
121 OTG_STATE_B_PERIPHERAL,
122 };
123
124 #define usleep_range(l, u) do { DELAY(u); } while (0)
125
126 #define spinlock_t kmutex_t
127 #define spin_lock_init(lock) mutex_init(lock, MUTEX_DEFAULT, IPL_VM)
128 #define spin_lock(l) do { mutex_spin_enter(l); } while (0)
129 #define spin_unlock(l) do { mutex_spin_exit(l); } while (0)
130
131 #define spin_lock_irqsave(l, f) \
132 do { mutex_spin_enter(l); (void)(f); } while (0)
133
134 #define spin_unlock_irqrestore(l, f) \
135 do { mutex_spin_exit(l); (void)(f); } while (0)
136
137 #define IRQ_RETVAL(r) (r)
138
139 #define USB_ENDPOINT_XFER_CONTROL UE_CONTROL /* 0 */
140 #define USB_ENDPOINT_XFER_ISOC UE_ISOCHRONOUS /* 1 */
141 #define USB_ENDPOINT_XFER_BULK UE_BULK /* 2 */
142 #define USB_ENDPOINT_XFER_INT UE_INTERRUPT /* 3 */
143
144 #define USB_DIR_IN UE_DIR_IN
145 #define USB_DIR_OUT UE_DIR_OUT
146
147 #define USB_PORT_FEAT_CONNECTION UHF_PORT_CONNECTION
148 #define USB_PORT_FEAT_ENABLE UHF_PORT_ENABLE
149 #define USB_PORT_FEAT_SUSPEND UHF_PORT_SUSPEND
150 #define USB_PORT_FEAT_OVER_CURRENT UHF_PORT_OVER_CURRENT
151 #define USB_PORT_FEAT_RESET UHF_PORT_RESET
152 // #define USB_PORT_FEAT_L1 5 /* L1 suspend */
153 #define USB_PORT_FEAT_POWER UHF_PORT_POWER
154 #define USB_PORT_FEAT_LOWSPEED UHF_PORT_LOW_SPEED
155 #define USB_PORT_FEAT_C_CONNECTION UHF_C_PORT_CONNECTION
156 #define USB_PORT_FEAT_C_ENABLE UHF_C_PORT_ENABLE
157 #define USB_PORT_FEAT_C_SUSPEND UHF_C_PORT_SUSPEND
158 #define USB_PORT_FEAT_C_OVER_CURRENT UHF_C_PORT_OVER_CURRENT
159 #define USB_PORT_FEAT_C_RESET UHF_C_PORT_RESET
160 #define USB_PORT_FEAT_TEST UHF_PORT_TEST
161 #define USB_PORT_FEAT_INDICATOR UHF_PORT_INDICATOR
162 #define USB_PORT_FEAT_C_PORT_L1 UHF_C_PORT_L1
163
164 #define C_HUB_LOCAL_POWER UHF_C_HUB_LOCAL_POWER
165 #define C_HUB_OVER_CURRENT UHF_C_HUB_OVER_CURRENT
166
167 #define USB_REQ_GET_STATUS UR_GET_STATUS
168 #define USB_REQ_CLEAR_FEATURE UR_CLEAR_FEATURE
169 #define USB_REQ_SET_FEATURE UR_SET_FEATURE
170 #define USB_REQ_GET_DESCRIPTOR UR_GET_DESCRIPTOR
171
172 #define ClearHubFeature ((UT_WRITE_CLASS_DEVICE << 8) | USB_REQ_CLEAR_FEATURE)
173 #define ClearPortFeature ((UT_WRITE_CLASS_OTHER << 8) | USB_REQ_CLEAR_FEATURE)
174 #define GetHubDescriptor ((UT_READ_CLASS_DEVICE << 8) | USB_REQ_GET_DESCRIPTOR)
175 #define GetHubStatus ((UT_READ_CLASS_DEVICE << 8) | USB_REQ_GET_STATUS)
176 #define GetPortStatus ((UT_READ_CLASS_OTHER << 8) | USB_REQ_GET_STATUS)
177 #define SetHubFeature ((UT_WRITE_CLASS_DEVICE << 8) | USB_REQ_SET_FEATURE)
178 #define SetPortFeature ((UT_WRITE_CLASS_OTHER << 8) | USB_REQ_SET_FEATURE)
179
180 #define USB_PORT_STAT_CONNECTION UPS_CURRENT_CONNECT_STATUS
181 #define USB_PORT_STAT_ENABLE UPS_PORT_ENABLED
182 #define USB_PORT_STAT_SUSPEND UPS_SUSPEND
183 #define USB_PORT_STAT_OVERCURRENT UPS_OVERCURRENT_INDICATOR
184 #define USB_PORT_STAT_RESET UPS_RESET
185 #define USB_PORT_STAT_L1 UPS_PORT_L1
186 #define USB_PORT_STAT_POWER UPS_PORT_POWER
187 #define USB_PORT_STAT_LOW_SPEED UPS_LOW_SPEED
188 #define USB_PORT_STAT_HIGH_SPEED UPS_HIGH_SPEED
189 #define USB_PORT_STAT_TEST UPS_PORT_TEST
190 #define USB_PORT_STAT_INDICATOR UPS_PORT_INDICATOR
191
192 #define USB_PORT_STAT_C_CONNECTION UPS_C_CONNECT_STATUS
193 #define USB_PORT_STAT_C_ENABLE UPS_C_PORT_ENABLED
194 #define USB_PORT_STAT_C_SUSPEND UPS_C_SUSPEND
195 #define USB_PORT_STAT_C_OVERCURRENT UPS_C_OVERCURRENT_INDICATOR
196 #define USB_PORT_STAT_C_RESET UPS_C_PORT_RESET
197 #define USB_PORT_STAT_C_L1 UPS_C_PORT_L1
198
199 #define USB_DT_HUB UDESC_HUB
200
201 /* See USB 2.0 spec Table 11-13, offset 3 */
202 #define HUB_CHAR_LPSM UHD_PWR
203 #define HUB_CHAR_COMMON_LPSM UHD_PWR_GANGED
204 #define HUB_CHAR_INDV_PORT_LPSM UHD_PWR_INDIVIDUAL
205 #define HUB_CHAR_NO_LPSM UHD_PWR_NO_SWITCH
206
207 #define HUB_CHAR_COMPOUND UHD_COMPOUND
208
209 #define HUB_CHAR_OCPM UHD_OC
210 #define HUB_CHAR_COMMON_OCPM UHD_OC_GLOBAL
211 #define HUB_CHAR_INDV_PORT_OCPM UHD_OC_INDIVIDUAL
212 #define HUB_CHAR_NO_OCPM UHD_OC_NONE
213
214 #define HUB_CHAR_TTTT UHD_TT_THINK
215 #define HUB_CHAR_PORTIND UHD_PORT_IND
216
217 enum usb_dr_mode {
218 USB_DR_MODE_UNKNOWN,
219 USB_DR_MODE_HOST,
220 USB_DR_MODE_PERIPHERAL,
221 USB_DR_MODE_OTG,
222 };
223
224 struct usb_phy;
225 struct usb_hcd;
226
227 static inline int
228 usb_phy_set_suspend(struct usb_phy *x, int suspend)
229 {
230
231 return 0;
232 }
233
234 static inline void
235 usb_hcd_resume_root_hub(struct usb_hcd *hcd)
236 {
237
238 return;
239 }
240
241 static inline int
242 usb_disabled(void)
243 {
244
245 return 0;
246 }
247
248 static inline void
249 udelay(unsigned long usecs)
250 {
251
252 DELAY(usecs);
253 }
254
255 static inline void
256 ndelay(unsigned long nsecs)
257 {
258
259 DELAY(nsecs / 1000);
260 }
261
262 static inline void
263 msleep(unsigned int msecs)
264 {
265
266 kpause("mdelay", false, mstohz(msecs), NULL);
267 }
268
269 #define EREMOTEIO EIO
270 #define ECOMM EIO
271 #define ENOTSUPP ENOTSUP
272
273 #define NS_TO_US(ns) ((ns + 500L) / 1000L)
274
275 #define USB_RESUME_TIMEOUT 40 /* ms */
276
277 void dw_callout(void *);
278 void dwc2_worker(struct work *, void *);
279
280 struct delayed_work {
281 struct work work;
282 struct callout dw_timer;
283
284 struct workqueue *dw_wq;
285 };
286
287 static inline void
288 INIT_DELAYED_WORK(struct delayed_work *dw, void (*fn)(struct work *))
289 {
290 callout_init(&dw->dw_timer, CALLOUT_MPSAFE);
291 }
292
293 static inline void
294 queue_delayed_work(struct workqueue *wq, struct delayed_work *dw, int j)
295 {
296 callout_reset(&dw->dw_timer, j, dw_callout, dw);
297 }
298
299 #endif
300