This source file includes following definitions.
- at91_start_clock
- at91_stop_clock
- at91_start_hc
- at91_stop_hc
- at91_dt_syscon_sfr
- usb_hcd_at91_probe
- usb_hcd_at91_remove
- ohci_at91_usb_set_power
- ohci_at91_usb_get_power
- ohci_at91_hub_status_data
- ohci_at91_port_suspend
- ohci_at91_hub_control
- ohci_hcd_at91_overcurrent_irq
- ohci_hcd_at91_drv_probe
- ohci_hcd_at91_drv_remove
- ohci_hcd_at91_drv_suspend
- ohci_hcd_at91_drv_resume
- ohci_at91_init
- ohci_at91_cleanup
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 #include <linux/clk.h>
17 #include <linux/dma-mapping.h>
18 #include <linux/gpio/consumer.h>
19 #include <linux/of_platform.h>
20 #include <linux/platform_device.h>
21 #include <linux/platform_data/atmel.h>
22 #include <linux/io.h>
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/mfd/syscon.h>
26 #include <linux/regmap.h>
27 #include <linux/usb.h>
28 #include <linux/usb/hcd.h>
29 #include <soc/at91/atmel-sfr.h>
30
31 #include "ohci.h"
32
33 #define valid_port(index) ((index) >= 0 && (index) < AT91_MAX_USBH_PORTS)
34 #define at91_for_each_port(index) \
35 for ((index) = 0; (index) < AT91_MAX_USBH_PORTS; (index)++)
36
37
38 #define hcd_to_ohci_at91_priv(h) \
39 ((struct ohci_at91_priv *)hcd_to_ohci(h)->priv)
40
41 #define AT91_MAX_USBH_PORTS 3
42 struct at91_usbh_data {
43 struct gpio_desc *vbus_pin[AT91_MAX_USBH_PORTS];
44 struct gpio_desc *overcurrent_pin[AT91_MAX_USBH_PORTS];
45 u8 ports;
46 u8 overcurrent_supported;
47 u8 overcurrent_status[AT91_MAX_USBH_PORTS];
48 u8 overcurrent_changed[AT91_MAX_USBH_PORTS];
49 };
50
51 struct ohci_at91_priv {
52 struct clk *iclk;
53 struct clk *fclk;
54 struct clk *hclk;
55 bool clocked;
56 bool wakeup;
57 struct regmap *sfr_regmap;
58 };
59
60
61 #define DRIVER_DESC "OHCI Atmel driver"
62
63 static const char hcd_name[] = "ohci-atmel";
64
65 static struct hc_driver __read_mostly ohci_at91_hc_driver;
66
67 static const struct ohci_driver_overrides ohci_at91_drv_overrides __initconst = {
68 .extra_priv_size = sizeof(struct ohci_at91_priv),
69 };
70
71
72
73 static void at91_start_clock(struct ohci_at91_priv *ohci_at91)
74 {
75 if (ohci_at91->clocked)
76 return;
77
78 clk_set_rate(ohci_at91->fclk, 48000000);
79 clk_prepare_enable(ohci_at91->hclk);
80 clk_prepare_enable(ohci_at91->iclk);
81 clk_prepare_enable(ohci_at91->fclk);
82 ohci_at91->clocked = true;
83 }
84
85 static void at91_stop_clock(struct ohci_at91_priv *ohci_at91)
86 {
87 if (!ohci_at91->clocked)
88 return;
89
90 clk_disable_unprepare(ohci_at91->fclk);
91 clk_disable_unprepare(ohci_at91->iclk);
92 clk_disable_unprepare(ohci_at91->hclk);
93 ohci_at91->clocked = false;
94 }
95
96 static void at91_start_hc(struct platform_device *pdev)
97 {
98 struct usb_hcd *hcd = platform_get_drvdata(pdev);
99 struct ohci_regs __iomem *regs = hcd->regs;
100 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
101
102 dev_dbg(&pdev->dev, "start\n");
103
104
105
106
107 at91_start_clock(ohci_at91);
108
109
110
111
112 writel(0, ®s->control);
113 }
114
115 static void at91_stop_hc(struct platform_device *pdev)
116 {
117 struct usb_hcd *hcd = platform_get_drvdata(pdev);
118 struct ohci_regs __iomem *regs = hcd->regs;
119 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
120
121 dev_dbg(&pdev->dev, "stop\n");
122
123
124
125
126 writel(0, ®s->control);
127
128
129
130
131 at91_stop_clock(ohci_at91);
132 }
133
134
135
136
137 static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
138
139 static struct regmap *at91_dt_syscon_sfr(void)
140 {
141 struct regmap *regmap;
142
143 regmap = syscon_regmap_lookup_by_compatible("atmel,sama5d2-sfr");
144 if (IS_ERR(regmap)) {
145 regmap = syscon_regmap_lookup_by_compatible("microchip,sam9x60-sfr");
146 if (IS_ERR(regmap))
147 regmap = NULL;
148 }
149
150 return regmap;
151 }
152
153
154
155
156
157
158
159
160
161
162
163
164
165 static int usb_hcd_at91_probe(const struct hc_driver *driver,
166 struct platform_device *pdev)
167 {
168 struct at91_usbh_data *board;
169 struct ohci_hcd *ohci;
170 int retval;
171 struct usb_hcd *hcd;
172 struct ohci_at91_priv *ohci_at91;
173 struct device *dev = &pdev->dev;
174 struct resource *res;
175 int irq;
176
177 irq = platform_get_irq(pdev, 0);
178 if (irq < 0) {
179 dev_dbg(dev, "hcd probe: missing irq resource\n");
180 return irq;
181 }
182
183 hcd = usb_create_hcd(driver, dev, "at91");
184 if (!hcd)
185 return -ENOMEM;
186 ohci_at91 = hcd_to_ohci_at91_priv(hcd);
187
188 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
189 hcd->regs = devm_ioremap_resource(dev, res);
190 if (IS_ERR(hcd->regs)) {
191 retval = PTR_ERR(hcd->regs);
192 goto err;
193 }
194 hcd->rsrc_start = res->start;
195 hcd->rsrc_len = resource_size(res);
196
197 ohci_at91->iclk = devm_clk_get(dev, "ohci_clk");
198 if (IS_ERR(ohci_at91->iclk)) {
199 dev_err(dev, "failed to get ohci_clk\n");
200 retval = PTR_ERR(ohci_at91->iclk);
201 goto err;
202 }
203 ohci_at91->fclk = devm_clk_get(dev, "uhpck");
204 if (IS_ERR(ohci_at91->fclk)) {
205 dev_err(dev, "failed to get uhpck\n");
206 retval = PTR_ERR(ohci_at91->fclk);
207 goto err;
208 }
209 ohci_at91->hclk = devm_clk_get(dev, "hclk");
210 if (IS_ERR(ohci_at91->hclk)) {
211 dev_err(dev, "failed to get hclk\n");
212 retval = PTR_ERR(ohci_at91->hclk);
213 goto err;
214 }
215
216 ohci_at91->sfr_regmap = at91_dt_syscon_sfr();
217 if (!ohci_at91->sfr_regmap)
218 dev_dbg(dev, "failed to find sfr node\n");
219
220 board = hcd->self.controller->platform_data;
221 ohci = hcd_to_ohci(hcd);
222 ohci->num_ports = board->ports;
223 at91_start_hc(pdev);
224
225
226
227
228
229 ohci->hc_control = OHCI_CTRL_RWC;
230
231 retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
232 if (retval == 0) {
233 device_wakeup_enable(hcd->self.controller);
234 return retval;
235 }
236
237
238 at91_stop_hc(pdev);
239
240 err:
241 usb_put_hcd(hcd);
242 return retval;
243 }
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258 static void usb_hcd_at91_remove(struct usb_hcd *hcd,
259 struct platform_device *pdev)
260 {
261 usb_remove_hcd(hcd);
262 at91_stop_hc(pdev);
263 usb_put_hcd(hcd);
264 }
265
266
267 static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
268 {
269 if (!valid_port(port))
270 return;
271
272 gpiod_set_value(pdata->vbus_pin[port], enable);
273 }
274
275 static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
276 {
277 if (!valid_port(port))
278 return -EINVAL;
279
280 return gpiod_get_value(pdata->vbus_pin[port]);
281 }
282
283
284
285
286 static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
287 {
288 struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
289 int length = ohci_hub_status_data(hcd, buf);
290 int port;
291
292 at91_for_each_port(port) {
293 if (pdata->overcurrent_changed[port]) {
294 if (!length)
295 length = 1;
296 buf[0] |= 1 << (port + 1);
297 }
298 }
299
300 return length;
301 }
302
303 static int ohci_at91_port_suspend(struct regmap *regmap, u8 set)
304 {
305 u32 regval;
306 int ret;
307
308 if (!regmap)
309 return 0;
310
311 ret = regmap_read(regmap, AT91_SFR_OHCIICR, ®val);
312 if (ret)
313 return ret;
314
315 if (set)
316 regval |= AT91_OHCIICR_USB_SUSPEND;
317 else
318 regval &= ~AT91_OHCIICR_USB_SUSPEND;
319
320 regmap_write(regmap, AT91_SFR_OHCIICR, regval);
321
322 return 0;
323 }
324
325
326
327
328 static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
329 u16 wIndex, char *buf, u16 wLength)
330 {
331 struct at91_usbh_data *pdata = dev_get_platdata(hcd->self.controller);
332 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
333 struct usb_hub_descriptor *desc;
334 int ret = -EINVAL;
335 u32 *data = (u32 *)buf;
336
337 dev_dbg(hcd->self.controller,
338 "ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
339 hcd, typeReq, wValue, wIndex, buf, wLength);
340
341 wIndex--;
342
343 switch (typeReq) {
344 case SetPortFeature:
345 switch (wValue) {
346 case USB_PORT_FEAT_POWER:
347 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
348 if (valid_port(wIndex)) {
349 ohci_at91_usb_set_power(pdata, wIndex, 1);
350 ret = 0;
351 }
352
353 goto out;
354
355 case USB_PORT_FEAT_SUSPEND:
356 dev_dbg(hcd->self.controller, "SetPortFeat: SUSPEND\n");
357 if (valid_port(wIndex) && ohci_at91->sfr_regmap) {
358 ohci_at91_port_suspend(ohci_at91->sfr_regmap,
359 1);
360 return 0;
361 }
362 break;
363 }
364 break;
365
366 case ClearPortFeature:
367 switch (wValue) {
368 case USB_PORT_FEAT_C_OVER_CURRENT:
369 dev_dbg(hcd->self.controller,
370 "ClearPortFeature: C_OVER_CURRENT\n");
371
372 if (valid_port(wIndex)) {
373 pdata->overcurrent_changed[wIndex] = 0;
374 pdata->overcurrent_status[wIndex] = 0;
375 }
376
377 goto out;
378
379 case USB_PORT_FEAT_OVER_CURRENT:
380 dev_dbg(hcd->self.controller,
381 "ClearPortFeature: OVER_CURRENT\n");
382
383 if (valid_port(wIndex))
384 pdata->overcurrent_status[wIndex] = 0;
385
386 goto out;
387
388 case USB_PORT_FEAT_POWER:
389 dev_dbg(hcd->self.controller,
390 "ClearPortFeature: POWER\n");
391
392 if (valid_port(wIndex)) {
393 ohci_at91_usb_set_power(pdata, wIndex, 0);
394 return 0;
395 }
396 break;
397
398 case USB_PORT_FEAT_SUSPEND:
399 dev_dbg(hcd->self.controller, "ClearPortFeature: SUSPEND\n");
400 if (valid_port(wIndex) && ohci_at91->sfr_regmap) {
401 ohci_at91_port_suspend(ohci_at91->sfr_regmap,
402 0);
403 return 0;
404 }
405 break;
406 }
407 break;
408 }
409
410 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex + 1, buf, wLength);
411 if (ret)
412 goto out;
413
414 switch (typeReq) {
415 case GetHubDescriptor:
416
417
418
419 desc = (struct usb_hub_descriptor *)buf;
420
421 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
422 desc->wHubCharacteristics);
423
424
425
426
427
428 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
429 desc->wHubCharacteristics |=
430 cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM);
431
432 if (pdata->overcurrent_supported) {
433 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
434 desc->wHubCharacteristics |=
435 cpu_to_le16(HUB_CHAR_INDV_PORT_OCPM);
436 }
437
438 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
439 desc->wHubCharacteristics);
440
441 return ret;
442
443 case GetPortStatus:
444
445
446 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
447
448 if (valid_port(wIndex)) {
449 if (!ohci_at91_usb_get_power(pdata, wIndex))
450 *data &= ~cpu_to_le32(RH_PS_PPS);
451
452 if (pdata->overcurrent_changed[wIndex])
453 *data |= cpu_to_le32(RH_PS_OCIC);
454
455 if (pdata->overcurrent_status[wIndex])
456 *data |= cpu_to_le32(RH_PS_POCI);
457 }
458 }
459
460 out:
461 return ret;
462 }
463
464
465
466 static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
467 {
468 struct platform_device *pdev = data;
469 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
470 int val, port;
471
472
473
474 at91_for_each_port(port) {
475 if (gpiod_to_irq(pdata->overcurrent_pin[port]) == irq)
476 break;
477 }
478
479 if (port == AT91_MAX_USBH_PORTS) {
480 dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
481 return IRQ_HANDLED;
482 }
483
484 val = gpiod_get_value(pdata->overcurrent_pin[port]);
485
486
487
488
489 if (!val) {
490 ohci_at91_usb_set_power(pdata, port, 0);
491 pdata->overcurrent_status[port] = 1;
492 pdata->overcurrent_changed[port] = 1;
493 }
494
495 dev_dbg(& pdev->dev, "overcurrent situation %s\n",
496 val ? "exited" : "notified");
497
498 return IRQ_HANDLED;
499 }
500
501 static const struct of_device_id at91_ohci_dt_ids[] = {
502 { .compatible = "atmel,at91rm9200-ohci" },
503 { }
504 };
505
506 MODULE_DEVICE_TABLE(of, at91_ohci_dt_ids);
507
508
509
510 static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
511 {
512 struct device_node *np = pdev->dev.of_node;
513 struct at91_usbh_data *pdata;
514 int i;
515 int ret;
516 int err;
517 u32 ports;
518
519
520
521
522
523 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
524 if (ret)
525 return ret;
526
527 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
528 if (!pdata)
529 return -ENOMEM;
530
531 pdev->dev.platform_data = pdata;
532
533 if (!of_property_read_u32(np, "num-ports", &ports))
534 pdata->ports = ports;
535
536 at91_for_each_port(i) {
537 if (i >= pdata->ports)
538 break;
539
540 pdata->vbus_pin[i] =
541 devm_gpiod_get_index_optional(&pdev->dev, "atmel,vbus",
542 i, GPIOD_OUT_HIGH);
543 if (IS_ERR(pdata->vbus_pin[i])) {
544 err = PTR_ERR(pdata->vbus_pin[i]);
545 dev_err(&pdev->dev, "unable to claim gpio \"vbus\": %d\n", err);
546 continue;
547 }
548 }
549
550 at91_for_each_port(i) {
551 if (i >= pdata->ports)
552 break;
553
554 pdata->overcurrent_pin[i] =
555 devm_gpiod_get_index_optional(&pdev->dev, "atmel,oc",
556 i, GPIOD_IN);
557 if (!pdata->overcurrent_pin[i])
558 continue;
559 if (IS_ERR(pdata->overcurrent_pin[i])) {
560 err = PTR_ERR(pdata->overcurrent_pin[i]);
561 dev_err(&pdev->dev, "unable to claim gpio \"overcurrent\": %d\n", err);
562 continue;
563 }
564
565 ret = devm_request_irq(&pdev->dev,
566 gpiod_to_irq(pdata->overcurrent_pin[i]),
567 ohci_hcd_at91_overcurrent_irq,
568 IRQF_SHARED,
569 "ohci_overcurrent", pdev);
570 if (ret)
571 dev_info(&pdev->dev, "failed to request gpio \"overcurrent\" IRQ\n");
572 }
573
574 device_init_wakeup(&pdev->dev, 1);
575 return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
576 }
577
578 static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
579 {
580 struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
581 int i;
582
583 if (pdata) {
584 at91_for_each_port(i)
585 ohci_at91_usb_set_power(pdata, i, 0);
586 }
587
588 device_init_wakeup(&pdev->dev, 0);
589 usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
590 return 0;
591 }
592
593 static int __maybe_unused
594 ohci_hcd_at91_drv_suspend(struct device *dev)
595 {
596 struct usb_hcd *hcd = dev_get_drvdata(dev);
597 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
598 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
599 int ret;
600
601
602
603
604
605 ohci_at91->wakeup = device_may_wakeup(dev)
606 && !at91_suspend_entering_slow_clock();
607
608 if (ohci_at91->wakeup)
609 enable_irq_wake(hcd->irq);
610
611 ohci_at91_port_suspend(ohci_at91->sfr_regmap, 1);
612
613 ret = ohci_suspend(hcd, ohci_at91->wakeup);
614 if (ret) {
615 if (ohci_at91->wakeup)
616 disable_irq_wake(hcd->irq);
617 return ret;
618 }
619
620
621
622
623
624
625
626 if (!ohci_at91->wakeup) {
627 ohci->rh_state = OHCI_RH_HALTED;
628
629
630 (void) ohci_readl (ohci, &ohci->regs->control);
631 at91_stop_clock(ohci_at91);
632 }
633
634 return ret;
635 }
636
637 static int __maybe_unused
638 ohci_hcd_at91_drv_resume(struct device *dev)
639 {
640 struct usb_hcd *hcd = dev_get_drvdata(dev);
641 struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
642
643 if (ohci_at91->wakeup)
644 disable_irq_wake(hcd->irq);
645
646 at91_start_clock(ohci_at91);
647
648 ohci_resume(hcd, false);
649
650 ohci_at91_port_suspend(ohci_at91->sfr_regmap, 0);
651
652 return 0;
653 }
654
655 static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops, ohci_hcd_at91_drv_suspend,
656 ohci_hcd_at91_drv_resume);
657
658 static struct platform_driver ohci_hcd_at91_driver = {
659 .probe = ohci_hcd_at91_drv_probe,
660 .remove = ohci_hcd_at91_drv_remove,
661 .shutdown = usb_hcd_platform_shutdown,
662 .driver = {
663 .name = "at91_ohci",
664 .pm = &ohci_hcd_at91_pm_ops,
665 .of_match_table = at91_ohci_dt_ids,
666 },
667 };
668
669 static int __init ohci_at91_init(void)
670 {
671 if (usb_disabled())
672 return -ENODEV;
673
674 pr_info("%s: " DRIVER_DESC "\n", hcd_name);
675 ohci_init_driver(&ohci_at91_hc_driver, &ohci_at91_drv_overrides);
676
677
678
679
680
681
682
683
684
685
686 ohci_at91_hc_driver.hub_status_data = ohci_at91_hub_status_data;
687 ohci_at91_hc_driver.hub_control = ohci_at91_hub_control;
688
689 return platform_driver_register(&ohci_hcd_at91_driver);
690 }
691 module_init(ohci_at91_init);
692
693 static void __exit ohci_at91_cleanup(void)
694 {
695 platform_driver_unregister(&ohci_hcd_at91_driver);
696 }
697 module_exit(ohci_at91_cleanup);
698
699 MODULE_DESCRIPTION(DRIVER_DESC);
700 MODULE_LICENSE("GPL");
701 MODULE_ALIAS("platform:at91_ohci");