1 /*
2 * Renesas USB driver
3 *
4 * Copyright (C) 2011 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
15 *
16 */
17 #include <linux/interrupt.h>
18
19 #include "common.h"
20 #include "mod.h"
21
22 #define usbhs_priv_to_modinfo(priv) (&priv->mod_info)
23 #define usbhs_mod_info_call(priv, func, param...) \
24 ({ \
25 struct usbhs_mod_info *info; \
26 info = usbhs_priv_to_modinfo(priv); \
27 !info->func ? 0 : \
28 info->func(param); \
29 })
30
31 /*
32 * autonomy
33 *
34 * these functions are used if platform doesn't have external phy.
35 * -> there is no "notify_hotplug" callback from platform
36 * -> call "notify_hotplug" by itself
37 * -> use own interrupt to connect/disconnect
38 * -> it mean module clock is always ON
39 * ~~~~~~~~~~~~~~~~~~~~~~~~~
40 */
usbhsm_autonomy_get_vbus(struct platform_device * pdev)41 static int usbhsm_autonomy_get_vbus(struct platform_device *pdev)
42 {
43 struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
44
45 return VBSTS & usbhs_read(priv, INTSTS0);
46 }
47
usbhsm_autonomy_irq_vbus(struct usbhs_priv * priv,struct usbhs_irq_state * irq_state)48 static int usbhsm_autonomy_irq_vbus(struct usbhs_priv *priv,
49 struct usbhs_irq_state *irq_state)
50 {
51 struct platform_device *pdev = usbhs_priv_to_pdev(priv);
52
53 renesas_usbhs_call_notify_hotplug(pdev);
54
55 return 0;
56 }
57
usbhs_mod_autonomy_mode(struct usbhs_priv * priv)58 void usbhs_mod_autonomy_mode(struct usbhs_priv *priv)
59 {
60 struct usbhs_mod_info *info = usbhs_priv_to_modinfo(priv);
61
62 info->irq_vbus = usbhsm_autonomy_irq_vbus;
63 priv->pfunc.get_vbus = usbhsm_autonomy_get_vbus;
64
65 usbhs_irq_callback_update(priv, NULL);
66 }
67
68 /*
69 * host / gadget functions
70 *
71 * renesas_usbhs host/gadget can register itself by below functions.
72 * these functions are called when probe
73 *
74 */
usbhs_mod_register(struct usbhs_priv * priv,struct usbhs_mod * mod,int id)75 void usbhs_mod_register(struct usbhs_priv *priv, struct usbhs_mod *mod, int id)
76 {
77 struct usbhs_mod_info *info = usbhs_priv_to_modinfo(priv);
78
79 info->mod[id] = mod;
80 mod->priv = priv;
81 }
82
usbhs_mod_get(struct usbhs_priv * priv,int id)83 struct usbhs_mod *usbhs_mod_get(struct usbhs_priv *priv, int id)
84 {
85 struct usbhs_mod_info *info = usbhs_priv_to_modinfo(priv);
86 struct usbhs_mod *ret = NULL;
87
88 switch (id) {
89 case USBHS_HOST:
90 case USBHS_GADGET:
91 ret = info->mod[id];
92 break;
93 }
94
95 return ret;
96 }
97
usbhs_mod_is_host(struct usbhs_priv * priv)98 int usbhs_mod_is_host(struct usbhs_priv *priv)
99 {
100 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
101 struct usbhs_mod_info *info = usbhs_priv_to_modinfo(priv);
102
103 if (!mod)
104 return -EINVAL;
105
106 return info->mod[USBHS_HOST] == mod;
107 }
108
usbhs_mod_get_current(struct usbhs_priv * priv)109 struct usbhs_mod *usbhs_mod_get_current(struct usbhs_priv *priv)
110 {
111 struct usbhs_mod_info *info = usbhs_priv_to_modinfo(priv);
112
113 return info->curt;
114 }
115
usbhs_mod_change(struct usbhs_priv * priv,int id)116 int usbhs_mod_change(struct usbhs_priv *priv, int id)
117 {
118 struct usbhs_mod_info *info = usbhs_priv_to_modinfo(priv);
119 struct usbhs_mod *mod = NULL;
120 int ret = 0;
121
122 /* id < 0 mean no current */
123 switch (id) {
124 case USBHS_HOST:
125 case USBHS_GADGET:
126 mod = info->mod[id];
127 break;
128 default:
129 ret = -EINVAL;
130 }
131 info->curt = mod;
132
133 return ret;
134 }
135
136 static irqreturn_t usbhs_interrupt(int irq, void *data);
usbhs_mod_probe(struct usbhs_priv * priv)137 int usbhs_mod_probe(struct usbhs_priv *priv)
138 {
139 struct device *dev = usbhs_priv_to_dev(priv);
140 int ret;
141
142 /*
143 * install host/gadget driver
144 */
145 ret = usbhs_mod_host_probe(priv);
146 if (ret < 0)
147 return ret;
148
149 ret = usbhs_mod_gadget_probe(priv);
150 if (ret < 0)
151 goto mod_init_host_err;
152
153 /* irq settings */
154 ret = devm_request_irq(dev, priv->irq, usbhs_interrupt,
155 priv->irqflags, dev_name(dev), priv);
156 if (ret) {
157 dev_err(dev, "irq request err\n");
158 goto mod_init_gadget_err;
159 }
160
161 return ret;
162
163 mod_init_gadget_err:
164 usbhs_mod_gadget_remove(priv);
165 mod_init_host_err:
166 usbhs_mod_host_remove(priv);
167
168 return ret;
169 }
170
usbhs_mod_remove(struct usbhs_priv * priv)171 void usbhs_mod_remove(struct usbhs_priv *priv)
172 {
173 usbhs_mod_host_remove(priv);
174 usbhs_mod_gadget_remove(priv);
175 }
176
177 /*
178 * status functions
179 */
usbhs_status_get_device_state(struct usbhs_irq_state * irq_state)180 int usbhs_status_get_device_state(struct usbhs_irq_state *irq_state)
181 {
182 int state = irq_state->intsts0 & DVSQ_MASK;
183
184 switch (state) {
185 case POWER_STATE:
186 case DEFAULT_STATE:
187 case ADDRESS_STATE:
188 case CONFIGURATION_STATE:
189 return state;
190 }
191
192 return -EIO;
193 }
194
usbhs_status_get_ctrl_stage(struct usbhs_irq_state * irq_state)195 int usbhs_status_get_ctrl_stage(struct usbhs_irq_state *irq_state)
196 {
197 /*
198 * return value
199 *
200 * IDLE_SETUP_STAGE
201 * READ_DATA_STAGE
202 * READ_STATUS_STAGE
203 * WRITE_DATA_STAGE
204 * WRITE_STATUS_STAGE
205 * NODATA_STATUS_STAGE
206 * SEQUENCE_ERROR
207 */
208 return (int)irq_state->intsts0 & CTSQ_MASK;
209 }
210
usbhs_status_get_each_irq(struct usbhs_priv * priv,struct usbhs_irq_state * state)211 static int usbhs_status_get_each_irq(struct usbhs_priv *priv,
212 struct usbhs_irq_state *state)
213 {
214 struct usbhs_mod *mod = usbhs_mod_get_current(priv);
215 u16 intenb0, intenb1;
216 unsigned long flags;
217
218 /******************** spin lock ********************/
219 usbhs_lock(priv, flags);
220 state->intsts0 = usbhs_read(priv, INTSTS0);
221 state->intsts1 = usbhs_read(priv, INTSTS1);
222
223 intenb0 = usbhs_read(priv, INTENB0);
224 intenb1 = usbhs_read(priv, INTENB1);
225
226 /* mask */
227 if (mod) {
228 state->brdysts = usbhs_read(priv, BRDYSTS);
229 state->nrdysts = usbhs_read(priv, NRDYSTS);
230 state->bempsts = usbhs_read(priv, BEMPSTS);
231
232 state->bempsts &= mod->irq_bempsts;
233 state->brdysts &= mod->irq_brdysts;
234 }
235 usbhs_unlock(priv, flags);
236 /******************** spin unlock ******************/
237
238 /*
239 * Check whether the irq enable registers and the irq status are set
240 * when IRQF_SHARED is set.
241 */
242 if (priv->irqflags & IRQF_SHARED) {
243 if (!(intenb0 & state->intsts0) &&
244 !(intenb1 & state->intsts1) &&
245 !(state->bempsts) &&
246 !(state->brdysts))
247 return -EIO;
248 }
249
250 return 0;
251 }
252
253 /*
254 * interrupt
255 */
256 #define INTSTS0_MAGIC 0xF800 /* acknowledge magical interrupt sources */
257 #define INTSTS1_MAGIC 0xA870 /* acknowledge magical interrupt sources */
usbhs_interrupt(int irq,void * data)258 static irqreturn_t usbhs_interrupt(int irq, void *data)
259 {
260 struct usbhs_priv *priv = data;
261 struct usbhs_irq_state irq_state;
262
263 if (usbhs_status_get_each_irq(priv, &irq_state) < 0)
264 return IRQ_NONE;
265
266 /*
267 * clear interrupt
268 *
269 * The hardware is _very_ picky to clear interrupt bit.
270 * Especially INTSTS0_MAGIC, INTSTS1_MAGIC value.
271 *
272 * see
273 * "Operation"
274 * - "Control Transfer (DCP)"
275 * - Function :: VALID bit should 0
276 */
277 usbhs_write(priv, INTSTS0, ~irq_state.intsts0 & INTSTS0_MAGIC);
278 usbhs_write(priv, INTSTS1, ~irq_state.intsts1 & INTSTS1_MAGIC);
279
280 /*
281 * The driver should not clear the xxxSTS after the line of
282 * "call irq callback functions" because each "if" statement is
283 * possible to call the callback function for avoiding any side effects.
284 */
285 if (irq_state.intsts0 & BRDY)
286 usbhs_write(priv, BRDYSTS, ~irq_state.brdysts);
287 usbhs_write(priv, NRDYSTS, ~irq_state.nrdysts);
288 if (irq_state.intsts0 & BEMP)
289 usbhs_write(priv, BEMPSTS, ~irq_state.bempsts);
290
291 /*
292 * call irq callback functions
293 * see also
294 * usbhs_irq_setting_update
295 */
296
297 /* INTSTS0 */
298 if (irq_state.intsts0 & VBINT)
299 usbhs_mod_info_call(priv, irq_vbus, priv, &irq_state);
300
301 if (irq_state.intsts0 & DVST)
302 usbhs_mod_call(priv, irq_dev_state, priv, &irq_state);
303
304 if (irq_state.intsts0 & CTRT)
305 usbhs_mod_call(priv, irq_ctrl_stage, priv, &irq_state);
306
307 if (irq_state.intsts0 & BEMP)
308 usbhs_mod_call(priv, irq_empty, priv, &irq_state);
309
310 if (irq_state.intsts0 & BRDY)
311 usbhs_mod_call(priv, irq_ready, priv, &irq_state);
312
313 /* INTSTS1 */
314 if (irq_state.intsts1 & ATTCH)
315 usbhs_mod_call(priv, irq_attch, priv, &irq_state);
316
317 if (irq_state.intsts1 & DTCH)
318 usbhs_mod_call(priv, irq_dtch, priv, &irq_state);
319
320 if (irq_state.intsts1 & SIGN)
321 usbhs_mod_call(priv, irq_sign, priv, &irq_state);
322
323 if (irq_state.intsts1 & SACK)
324 usbhs_mod_call(priv, irq_sack, priv, &irq_state);
325
326 return IRQ_HANDLED;
327 }
328
usbhs_irq_callback_update(struct usbhs_priv * priv,struct usbhs_mod * mod)329 void usbhs_irq_callback_update(struct usbhs_priv *priv, struct usbhs_mod *mod)
330 {
331 u16 intenb0 = 0;
332 u16 intenb1 = 0;
333 struct usbhs_mod_info *info = usbhs_priv_to_modinfo(priv);
334
335 /*
336 * BEMPENB/BRDYENB are picky.
337 * below method is required
338 *
339 * - clear INTSTS0
340 * - update BEMPENB/BRDYENB
341 * - update INTSTS0
342 */
343 usbhs_write(priv, INTENB0, 0);
344 usbhs_write(priv, INTENB1, 0);
345
346 usbhs_write(priv, BEMPENB, 0);
347 usbhs_write(priv, BRDYENB, 0);
348
349 /*
350 * see also
351 * usbhs_interrupt
352 */
353
354 /*
355 * it don't enable DVSE (intenb0) here
356 * but "mod->irq_dev_state" will be called.
357 */
358 if (info->irq_vbus)
359 intenb0 |= VBSE;
360
361 if (mod) {
362 /*
363 * INTSTS0
364 */
365 if (mod->irq_ctrl_stage)
366 intenb0 |= CTRE;
367
368 if (mod->irq_empty && mod->irq_bempsts) {
369 usbhs_write(priv, BEMPENB, mod->irq_bempsts);
370 intenb0 |= BEMPE;
371 }
372
373 if (mod->irq_ready && mod->irq_brdysts) {
374 usbhs_write(priv, BRDYENB, mod->irq_brdysts);
375 intenb0 |= BRDYE;
376 }
377
378 /*
379 * INTSTS1
380 */
381 if (mod->irq_attch)
382 intenb1 |= ATTCHE;
383
384 if (mod->irq_dtch)
385 intenb1 |= DTCHE;
386
387 if (mod->irq_sign)
388 intenb1 |= SIGNE;
389
390 if (mod->irq_sack)
391 intenb1 |= SACKE;
392 }
393
394 if (intenb0)
395 usbhs_write(priv, INTENB0, intenb0);
396
397 if (intenb1)
398 usbhs_write(priv, INTENB1, intenb1);
399 }
400