projects / deliverable / linux.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
usb: chipidea: move platform related things to ci_get_platdata
[deliverable/linux.git] / drivers / usb / chipidea / core.c
1 /*
2 * core.c - ChipIdea USB IP core family device controller
3 *
4 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
5 *
6 * Author: David Lopo
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13 /*
14 * Description: ChipIdea USB IP core family device controller
15 *
16 * This driver is composed of several blocks:
17 * - HW: hardware interface
18 * - DBG: debug facilities (optional)
19 * - UTIL: utilities
20 * - ISR: interrupts handling
21 * - ENDPT: endpoint operations (Gadget API)
22 * - GADGET: gadget operations (Gadget API)
23 * - BUS: bus glue code, bus abstraction layer
24 *
25 * Compile Options
26 * - CONFIG_USB_GADGET_DEBUG_FILES: enable debug facilities
27 * - STALL_IN: non-empty bulk-in pipes cannot be halted
28 * if defined mass storage compliance succeeds but with warnings
29 * => case 4: Hi > Dn
30 * => case 5: Hi > Di
31 * => case 8: Hi <> Do
32 * if undefined usbtest 13 fails
33 * - TRACE: enable function tracing (depends on DEBUG)
34 *
35 * Main Features
36 * - Chapter 9 & Mass Storage Compliance with Gadget File Storage
37 * - Chapter 9 Compliance with Gadget Zero (STALL_IN undefined)
38 * - Normal & LPM support
39 *
40 * USBTEST Report
41 * - OK: 0-12, 13 (STALL_IN defined) & 14
42 * - Not Supported: 15 & 16 (ISO)
43 *
44 * TODO List
45 * - OTG
46 * - Interrupt Traffic
47 * - GET_STATUS(device) - always reports 0
48 * - Gadget API (majority of optional features)
49 * - Suspend & Remote Wakeup
50 */
51 #include <linux/delay.h>
52 #include <linux/device.h>
53 #include <linux/dma-mapping.h>
54 #include <linux/platform_device.h>
55 #include <linux/module.h>
56 #include <linux/idr.h>
57 #include <linux/interrupt.h>
58 #include <linux/io.h>
59 #include <linux/kernel.h>
60 #include <linux/slab.h>
61 #include <linux/pm_runtime.h>
62 #include <linux/usb/ch9.h>
63 #include <linux/usb/gadget.h>
64 #include <linux/usb/otg.h>
65 #include <linux/usb/chipidea.h>
66 #include <linux/usb/of.h>
67 #include <linux/phy.h>
68 #include <linux/regulator/consumer.h>
69
70 #include "ci.h"
71 #include "udc.h"
72 #include "bits.h"
73 #include "host.h"
74 #include "debug.h"
75 #include "otg.h"
76
77 /* Controller register map */
78 static uintptr_t ci_regs_nolpm[] = {
79 [CAP_CAPLENGTH] = 0x000UL,
80 [CAP_HCCPARAMS] = 0x008UL,
81 [CAP_DCCPARAMS] = 0x024UL,
82 [CAP_TESTMODE] = 0x038UL,
83 [OP_USBCMD] = 0x000UL,
84 [OP_USBSTS] = 0x004UL,
85 [OP_USBINTR] = 0x008UL,
86 [OP_DEVICEADDR] = 0x014UL,
87 [OP_ENDPTLISTADDR] = 0x018UL,
88 [OP_PORTSC] = 0x044UL,
89 [OP_DEVLC] = 0x084UL,
90 [OP_OTGSC] = 0x064UL,
91 [OP_USBMODE] = 0x068UL,
92 [OP_ENDPTSETUPSTAT] = 0x06CUL,
93 [OP_ENDPTPRIME] = 0x070UL,
94 [OP_ENDPTFLUSH] = 0x074UL,
95 [OP_ENDPTSTAT] = 0x078UL,
96 [OP_ENDPTCOMPLETE] = 0x07CUL,
97 [OP_ENDPTCTRL] = 0x080UL,
98 };
99
100 static uintptr_t ci_regs_lpm[] = {
101 [CAP_CAPLENGTH] = 0x000UL,
102 [CAP_HCCPARAMS] = 0x008UL,
103 [CAP_DCCPARAMS] = 0x024UL,
104 [CAP_TESTMODE] = 0x0FCUL,
105 [OP_USBCMD] = 0x000UL,
106 [OP_USBSTS] = 0x004UL,
107 [OP_USBINTR] = 0x008UL,
108 [OP_DEVICEADDR] = 0x014UL,
109 [OP_ENDPTLISTADDR] = 0x018UL,
110 [OP_PORTSC] = 0x044UL,
111 [OP_DEVLC] = 0x084UL,
112 [OP_OTGSC] = 0x0C4UL,
113 [OP_USBMODE] = 0x0C8UL,
114 [OP_ENDPTSETUPSTAT] = 0x0D8UL,
115 [OP_ENDPTPRIME] = 0x0DCUL,
116 [OP_ENDPTFLUSH] = 0x0E0UL,
117 [OP_ENDPTSTAT] = 0x0E4UL,
118 [OP_ENDPTCOMPLETE] = 0x0E8UL,
119 [OP_ENDPTCTRL] = 0x0ECUL,
120 };
121
122 static int hw_alloc_regmap(struct ci_hdrc *ci, bool is_lpm)
123 {
124 int i;
125
126 kfree(ci->hw_bank.regmap);
127
128 ci->hw_bank.regmap = kzalloc((OP_LAST + 1) * sizeof(void *),
129 GFP_KERNEL);
130 if (!ci->hw_bank.regmap)
131 return -ENOMEM;
132
133 for (i = 0; i < OP_ENDPTCTRL; i++)
134 ci->hw_bank.regmap[i] =
135 (i <= CAP_LAST ? ci->hw_bank.cap : ci->hw_bank.op) +
136 (is_lpm ? ci_regs_lpm[i] : ci_regs_nolpm[i]);
137
138 for (; i <= OP_LAST; i++)
139 ci->hw_bank.regmap[i] = ci->hw_bank.op +
140 4 * (i - OP_ENDPTCTRL) +
141 (is_lpm
142 ? ci_regs_lpm[OP_ENDPTCTRL]
143 : ci_regs_nolpm[OP_ENDPTCTRL]);
144
145 return 0;
146 }
147
148 /**
149 * hw_port_test_set: writes port test mode (execute without interruption)
150 * @mode: new value
151 *
152 * This function returns an error code
153 */
154 int hw_port_test_set(struct ci_hdrc *ci, u8 mode)
155 {
156 const u8 TEST_MODE_MAX = 7;
157
158 if (mode > TEST_MODE_MAX)
159 return -EINVAL;
160
161 hw_write(ci, OP_PORTSC, PORTSC_PTC, mode << __ffs(PORTSC_PTC));
162 return 0;
163 }
164
165 /**
166 * hw_port_test_get: reads port test mode value
167 *
168 * This function returns port test mode value
169 */
170 u8 hw_port_test_get(struct ci_hdrc *ci)
171 {
172 return hw_read(ci, OP_PORTSC, PORTSC_PTC) >> __ffs(PORTSC_PTC);
173 }
174
175 static int hw_device_init(struct ci_hdrc *ci, void __iomem *base)
176 {
177 u32 reg;
178
179 /* bank is a module variable */
180 ci->hw_bank.abs = base;
181
182 ci->hw_bank.cap = ci->hw_bank.abs;
183 ci->hw_bank.cap += ci->platdata->capoffset;
184 ci->hw_bank.op = ci->hw_bank.cap + (ioread32(ci->hw_bank.cap) & 0xff);
185
186 hw_alloc_regmap(ci, false);
187 reg = hw_read(ci, CAP_HCCPARAMS, HCCPARAMS_LEN) >>
188 __ffs(HCCPARAMS_LEN);
189 ci->hw_bank.lpm = reg;
190 hw_alloc_regmap(ci, !!reg);
191 ci->hw_bank.size = ci->hw_bank.op - ci->hw_bank.abs;
192 ci->hw_bank.size += OP_LAST;
193 ci->hw_bank.size /= sizeof(u32);
194
195 reg = hw_read(ci, CAP_DCCPARAMS, DCCPARAMS_DEN) >>
196 __ffs(DCCPARAMS_DEN);
197 ci->hw_ep_max = reg * 2; /* cache hw ENDPT_MAX */
198
199 if (ci->hw_ep_max > ENDPT_MAX)
200 return -ENODEV;
201
202 /* Disable all interrupts bits */
203 hw_write(ci, OP_USBINTR, 0xffffffff, 0);
204
205 /* Clear all interrupts status bits*/
206 hw_write(ci, OP_USBSTS, 0xffffffff, 0xffffffff);
207
208 dev_dbg(ci->dev, "ChipIdea HDRC found, lpm: %d; cap: %p op: %p\n",
209 ci->hw_bank.lpm, ci->hw_bank.cap, ci->hw_bank.op);
210
211 /* setup lock mode ? */
212
213 /* ENDPTSETUPSTAT is '0' by default */
214
215 /* HCSPARAMS.bf.ppc SHOULD BE zero for device */
216
217 return 0;
218 }
219
220 static void hw_phymode_configure(struct ci_hdrc *ci)
221 {
222 u32 portsc, lpm, sts;
223
224 switch (ci->platdata->phy_mode) {
225 case USBPHY_INTERFACE_MODE_UTMI:
226 portsc = PORTSC_PTS(PTS_UTMI);
227 lpm = DEVLC_PTS(PTS_UTMI);
228 break;
229 case USBPHY_INTERFACE_MODE_UTMIW:
230 portsc = PORTSC_PTS(PTS_UTMI) | PORTSC_PTW;
231 lpm = DEVLC_PTS(PTS_UTMI) | DEVLC_PTW;
232 break;
233 case USBPHY_INTERFACE_MODE_ULPI:
234 portsc = PORTSC_PTS(PTS_ULPI);
235 lpm = DEVLC_PTS(PTS_ULPI);
236 break;
237 case USBPHY_INTERFACE_MODE_SERIAL:
238 portsc = PORTSC_PTS(PTS_SERIAL);
239 lpm = DEVLC_PTS(PTS_SERIAL);
240 sts = 1;
241 break;
242 case USBPHY_INTERFACE_MODE_HSIC:
243 portsc = PORTSC_PTS(PTS_HSIC);
244 lpm = DEVLC_PTS(PTS_HSIC);
245 break;
246 default:
247 return;
248 }
249
250 if (ci->hw_bank.lpm) {
251 hw_write(ci, OP_DEVLC, DEVLC_PTS(7) | DEVLC_PTW, lpm);
252 hw_write(ci, OP_DEVLC, DEVLC_STS, sts);
253 } else {
254 hw_write(ci, OP_PORTSC, PORTSC_PTS(7) | PORTSC_PTW, portsc);
255 hw_write(ci, OP_PORTSC, PORTSC_STS, sts);
256 }
257 }
258
259 /**
260 * hw_device_reset: resets chip (execute without interruption)
261 * @ci: the controller
262 *
263 * This function returns an error code
264 */
265 int hw_device_reset(struct ci_hdrc *ci, u32 mode)
266 {
267 /* should flush & stop before reset */
268 hw_write(ci, OP_ENDPTFLUSH, ~0, ~0);
269 hw_write(ci, OP_USBCMD, USBCMD_RS, 0);
270
271 hw_write(ci, OP_USBCMD, USBCMD_RST, USBCMD_RST);
272 while (hw_read(ci, OP_USBCMD, USBCMD_RST))
273 udelay(10); /* not RTOS friendly */
274
275 if (ci->platdata->notify_event)
276 ci->platdata->notify_event(ci,
277 CI_HDRC_CONTROLLER_RESET_EVENT);
278
279 if (ci->platdata->flags & CI_HDRC_DISABLE_STREAMING)
280 hw_write(ci, OP_USBMODE, USBMODE_CI_SDIS, USBMODE_CI_SDIS);
281
282 /* USBMODE should be configured step by step */
283 hw_write(ci, OP_USBMODE, USBMODE_CM, USBMODE_CM_IDLE);
284 hw_write(ci, OP_USBMODE, USBMODE_CM, mode);
285 /* HW >= 2.3 */
286 hw_write(ci, OP_USBMODE, USBMODE_SLOM, USBMODE_SLOM);
287
288 if (hw_read(ci, OP_USBMODE, USBMODE_CM) != mode) {
289 pr_err("cannot enter in %s mode", ci_role(ci)->name);
290 pr_err("lpm = %i", ci->hw_bank.lpm);
291 return -ENODEV;
292 }
293
294 return 0;
295 }
296
297 /**
298 * hw_wait_reg: wait the register value
299 *
300 * Sometimes, it needs to wait register value before going on.
301 * Eg, when switch to device mode, the vbus value should be lower
302 * than OTGSC_BSV before connects to host.
303 *
304 * @ci: the controller
305 * @reg: register index
306 * @mask: mast bit
307 * @value: the bit value to wait
308 * @timeout_ms: timeout in millisecond
309 *
310 * This function returns an error code if timeout
311 */
312 int hw_wait_reg(struct ci_hdrc *ci, enum ci_hw_regs reg, u32 mask,
313 u32 value, unsigned int timeout_ms)
314 {
315 unsigned long elapse = jiffies + msecs_to_jiffies(timeout_ms);
316
317 while (hw_read(ci, reg, mask) != value) {
318 if (time_after(jiffies, elapse)) {
319 dev_err(ci->dev, "timeout waiting for %08x in %d\n",
320 mask, reg);
321 return -ETIMEDOUT;
322 }
323 msleep(20);
324 }
325
326 return 0;
327 }
328
329 static irqreturn_t ci_irq(int irq, void *data)
330 {
331 struct ci_hdrc *ci = data;
332 irqreturn_t ret = IRQ_NONE;
333 u32 otgsc = 0;
334
335 if (ci->is_otg)
336 otgsc = hw_read(ci, OP_OTGSC, ~0);
337
338 /*
339 * Handle id change interrupt, it indicates device/host function
340 * switch.
341 */
342 if (ci->is_otg && (otgsc & OTGSC_IDIE) && (otgsc & OTGSC_IDIS)) {
343 ci->id_event = true;
344 ci_clear_otg_interrupt(ci, OTGSC_IDIS);
345 disable_irq_nosync(ci->irq);
346 queue_work(ci->wq, &ci->work);
347 return IRQ_HANDLED;
348 }
349
350 /*
351 * Handle vbus change interrupt, it indicates device connection
352 * and disconnection events.
353 */
354 if (ci->is_otg && (otgsc & OTGSC_BSVIE) && (otgsc & OTGSC_BSVIS)) {
355 ci->b_sess_valid_event = true;
356 ci_clear_otg_interrupt(ci, OTGSC_BSVIS);
357 disable_irq_nosync(ci->irq);
358 queue_work(ci->wq, &ci->work);
359 return IRQ_HANDLED;
360 }
361
362 /* Handle device/host interrupt */
363 if (ci->role != CI_ROLE_END)
364 ret = ci_role(ci)->irq(ci);
365
366 return ret;
367 }
368
369 static int ci_get_platdata(struct device *dev,
370 struct ci_hdrc_platform_data *platdata)
371 {
372 /* Get the vbus regulator */
373 platdata->reg_vbus = devm_regulator_get(dev, "vbus");
374 if (PTR_ERR(platdata->reg_vbus) == -EPROBE_DEFER) {
375 return -EPROBE_DEFER;
376 } else if (PTR_ERR(platdata->reg_vbus) == -ENODEV) {
377 platdata->reg_vbus = NULL; /* no vbus regualator is needed */
378 } else if (IS_ERR(platdata->reg_vbus)) {
379 dev_err(dev, "Getting regulator error: %ld\n",
380 PTR_ERR(platdata->reg_vbus));
381 return PTR_ERR(platdata->reg_vbus);
382 }
383
384 if (!platdata->phy_mode)
385 platdata->phy_mode = of_usb_get_phy_mode(dev->of_node);
386
387 if (!platdata->dr_mode)
388 platdata->dr_mode = of_usb_get_dr_mode(dev->of_node);
389
390 if (platdata->dr_mode == USB_DR_MODE_UNKNOWN)
391 platdata->dr_mode = USB_DR_MODE_OTG;
392
393 return 0;
394 }
395
396 static DEFINE_IDA(ci_ida);
397
398 struct platform_device *ci_hdrc_add_device(struct device *dev,
399 struct resource *res, int nres,
400 struct ci_hdrc_platform_data *platdata)
401 {
402 struct platform_device *pdev;
403 int id, ret;
404
405 ret = ci_get_platdata(dev, platdata);
406 if (ret)
407 return ERR_PTR(ret);
408
409 id = ida_simple_get(&ci_ida, 0, 0, GFP_KERNEL);
410 if (id < 0)
411 return ERR_PTR(id);
412
413 pdev = platform_device_alloc("ci_hdrc", id);
414 if (!pdev) {
415 ret = -ENOMEM;
416 goto put_id;
417 }
418
419 pdev->dev.parent = dev;
420 pdev->dev.dma_mask = dev->dma_mask;
421 pdev->dev.dma_parms = dev->dma_parms;
422 dma_set_coherent_mask(&pdev->dev, dev->coherent_dma_mask);
423
424 ret = platform_device_add_resources(pdev, res, nres);
425 if (ret)
426 goto err;
427
428 ret = platform_device_add_data(pdev, platdata, sizeof(*platdata));
429 if (ret)
430 goto err;
431
432 ret = platform_device_add(pdev);
433 if (ret)
434 goto err;
435
436 return pdev;
437
438 err:
439 platform_device_put(pdev);
440 put_id:
441 ida_simple_remove(&ci_ida, id);
442 return ERR_PTR(ret);
443 }
444 EXPORT_SYMBOL_GPL(ci_hdrc_add_device);
445
446 void ci_hdrc_remove_device(struct platform_device *pdev)
447 {
448 int id = pdev->id;
449 platform_device_unregister(pdev);
450 ida_simple_remove(&ci_ida, id);
451 }
452 EXPORT_SYMBOL_GPL(ci_hdrc_remove_device);
453
454 static inline void ci_role_destroy(struct ci_hdrc *ci)
455 {
456 ci_hdrc_gadget_destroy(ci);
457 ci_hdrc_host_destroy(ci);
458 if (ci->is_otg)
459 ci_hdrc_otg_destroy(ci);
460 }
461
462 static void ci_get_otg_capable(struct ci_hdrc *ci)
463 {
464 if (ci->platdata->flags & CI_HDRC_DUAL_ROLE_NOT_OTG)
465 ci->is_otg = false;
466 else
467 ci->is_otg = (hw_read(ci, CAP_DCCPARAMS,
468 DCCPARAMS_DC | DCCPARAMS_HC)
469 == (DCCPARAMS_DC | DCCPARAMS_HC));
470 if (ci->is_otg) {
471 dev_dbg(ci->dev, "It is OTG capable controller\n");
472 ci_disable_otg_interrupt(ci, OTGSC_INT_EN_BITS);
473 ci_clear_otg_interrupt(ci, OTGSC_INT_STATUS_BITS);
474 }
475 }
476
477 static int ci_hdrc_probe(struct platform_device *pdev)
478 {
479 struct device *dev = &pdev->dev;
480 struct ci_hdrc *ci;
481 struct resource *res;
482 void __iomem *base;
483 int ret;
484 enum usb_dr_mode dr_mode;
485
486 if (!dev->platform_data) {
487 dev_err(dev, "platform data missing\n");
488 return -ENODEV;
489 }
490
491 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
492 base = devm_ioremap_resource(dev, res);
493 if (IS_ERR(base))
494 return PTR_ERR(base);
495
496 ci = devm_kzalloc(dev, sizeof(*ci), GFP_KERNEL);
497 if (!ci) {
498 dev_err(dev, "can't allocate device\n");
499 return -ENOMEM;
500 }
501
502 ci->dev = dev;
503 ci->platdata = dev->platform_data;
504 if (ci->platdata->phy)
505 ci->transceiver = ci->platdata->phy;
506 else
507 ci->global_phy = true;
508
509 ret = hw_device_init(ci, base);
510 if (ret < 0) {
511 dev_err(dev, "can't initialize hardware\n");
512 return -ENODEV;
513 }
514
515 ci->hw_bank.phys = res->start;
516
517 ci->irq = platform_get_irq(pdev, 0);
518 if (ci->irq < 0) {
519 dev_err(dev, "missing IRQ\n");
520 return -ENODEV;
521 }
522
523 ci_get_otg_capable(ci);
524
525 hw_phymode_configure(ci);
526
527 dr_mode = ci->platdata->dr_mode;
528 /* initialize role(s) before the interrupt is requested */
529 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
530 ret = ci_hdrc_host_init(ci);
531 if (ret)
532 dev_info(dev, "doesn't support host\n");
533 }
534
535 if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
536 ret = ci_hdrc_gadget_init(ci);
537 if (ret)
538 dev_info(dev, "doesn't support gadget\n");
539 }
540
541 if (!ci->roles[CI_ROLE_HOST] && !ci->roles[CI_ROLE_GADGET]) {
542 dev_err(dev, "no supported roles\n");
543 return -ENODEV;
544 }
545
546 if (ci->is_otg) {
547 ret = ci_hdrc_otg_init(ci);
548 if (ret) {
549 dev_err(dev, "init otg fails, ret = %d\n", ret);
550 goto stop;
551 }
552 }
553
554 if (ci->roles[CI_ROLE_HOST] && ci->roles[CI_ROLE_GADGET]) {
555 if (ci->is_otg) {
556 /*
557 * ID pin needs 1ms debouce time,
558 * we delay 2ms for safe.
559 */
560 mdelay(2);
561 ci->role = ci_otg_role(ci);
562 ci_enable_otg_interrupt(ci, OTGSC_IDIE);
563 } else {
564 /*
565 * If the controller is not OTG capable, but support
566 * role switch, the defalt role is gadget, and the
567 * user can switch it through debugfs.
568 */
569 ci->role = CI_ROLE_GADGET;
570 }
571 } else {
572 ci->role = ci->roles[CI_ROLE_HOST]
573 ? CI_ROLE_HOST
574 : CI_ROLE_GADGET;
575 }
576
577 ret = ci_role_start(ci, ci->role);
578 if (ret) {
579 dev_err(dev, "can't start %s role\n", ci_role(ci)->name);
580 goto stop;
581 }
582
583 platform_set_drvdata(pdev, ci);
584 ret = request_irq(ci->irq, ci_irq, IRQF_SHARED, ci->platdata->name,
585 ci);
586 if (ret)
587 goto stop;
588
589 ret = dbg_create_files(ci);
590 if (!ret)
591 return 0;
592
593 free_irq(ci->irq, ci);
594 stop:
595 ci_role_destroy(ci);
596
597 return ret;
598 }
599
600 static int ci_hdrc_remove(struct platform_device *pdev)
601 {
602 struct ci_hdrc *ci = platform_get_drvdata(pdev);
603
604 dbg_remove_files(ci);
605 free_irq(ci->irq, ci);
606 ci_role_destroy(ci);
607
608 return 0;
609 }
610
611 static struct platform_driver ci_hdrc_driver = {
612 .probe = ci_hdrc_probe,
613 .remove = ci_hdrc_remove,
614 .driver = {
615 .name = "ci_hdrc",
616 },
617 };
618
619 module_platform_driver(ci_hdrc_driver);
620
621 MODULE_ALIAS("platform:ci_hdrc");
622 MODULE_LICENSE("GPL v2");
623 MODULE_AUTHOR("David Lopo <dlopo@chipidea.mips.com>");
624 MODULE_DESCRIPTION("ChipIdea HDRC Driver");
Linux kernel - Deliverables
This page took 0.043633 seconds and 6 git commands to generate.