Linux Audio

Check our new training course

Buildroot integration, development and maintenance

Need a Buildroot system for your embedded project?
Loading...
v6.2
  1// SPDX-License-Identifier: GPL-1.0+
  2/*
  3 * OHCI HCD (Host Controller Driver) for USB.
  4 *
  5 *  Copyright (C) 2004 SAN People (Pty) Ltd.
  6 *  Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
  7 *
  8 * AT91 Bus Glue
  9 *
 10 * Based on fragments of 2.4 driver by Rick Bronson.
 11 * Based on ohci-omap.c
 12 *
 13 * This file is licenced under the GPL.
 14 */
 15
 16#include <linux/arm-smccc.h>
 17#include <linux/clk.h>
 18#include <linux/dma-mapping.h>
 19#include <linux/gpio/consumer.h>
 20#include <linux/of_platform.h>
 21#include <linux/platform_device.h>
 22#include <linux/platform_data/atmel.h>
 23#include <linux/io.h>
 24#include <linux/kernel.h>
 25#include <linux/module.h>
 26#include <linux/mfd/syscon.h>
 27#include <linux/regmap.h>
 28#include <linux/usb.h>
 29#include <linux/usb/hcd.h>
 30#include <soc/at91/atmel-sfr.h>
 31
 32#include "ohci.h"
 33
 34#define valid_port(index)	((index) >= 0 && (index) < AT91_MAX_USBH_PORTS)
 35#define at91_for_each_port(index)	\
 36		for ((index) = 0; (index) < AT91_MAX_USBH_PORTS; (index)++)
 37
 38/* interface, function and usb clocks; sometimes also an AHB clock */
 39#define hcd_to_ohci_at91_priv(h) \
 40	((struct ohci_at91_priv *)hcd_to_ohci(h)->priv)
 41
 42#define AT91_MAX_USBH_PORTS	3
 43struct at91_usbh_data {
 44	struct gpio_desc *vbus_pin[AT91_MAX_USBH_PORTS];
 45	struct gpio_desc *overcurrent_pin[AT91_MAX_USBH_PORTS];
 46	u8 ports;				/* number of ports on root hub */
 47	u8 overcurrent_supported;
 48	u8 overcurrent_status[AT91_MAX_USBH_PORTS];
 49	u8 overcurrent_changed[AT91_MAX_USBH_PORTS];
 50};
 51
 52struct ohci_at91_priv {
 53	struct clk *iclk;
 54	struct clk *fclk;
 55	struct clk *hclk;
 56	bool clocked;
 57	bool wakeup;		/* Saved wake-up state for resume */
 58	struct regmap *sfr_regmap;
 59	u32 suspend_smc_id;
 60};
 61/* interface and function clocks; sometimes also an AHB clock */
 62
 63#define DRIVER_DESC "OHCI Atmel driver"
 64
 
 
 65static struct hc_driver __read_mostly ohci_at91_hc_driver;
 66
 67static const struct ohci_driver_overrides ohci_at91_drv_overrides __initconst = {
 68	.extra_priv_size = sizeof(struct ohci_at91_priv),
 69};
 70
 71/*-------------------------------------------------------------------------*/
 72
 73static 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
 85static 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
 96static 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	 * Start the USB clocks.
106	 */
107	at91_start_clock(ohci_at91);
108
109	/*
110	 * The USB host controller must remain in reset.
111	 */
112	writel(0, &regs->control);
113}
114
115static void at91_stop_hc(struct platform_device *pdev)
116{
117	struct usb_hcd *hcd = platform_get_drvdata(pdev);
 
118	struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
119
120	dev_dbg(&pdev->dev, "stop\n");
121
122	/*
123	 * Put the USB host controller into reset.
124	 */
125	usb_hcd_platform_shutdown(pdev);
126
127	/*
128	 * Stop the USB clocks.
129	 */
130	at91_stop_clock(ohci_at91);
131}
132
133
134/*-------------------------------------------------------------------------*/
135
136static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
137
138static u32 at91_dt_suspend_smc(struct device *dev)
139{
140	u32 suspend_smc_id;
141
142	if (!dev->of_node)
143		return 0;
144
145	if (of_property_read_u32(dev->of_node, "microchip,suspend-smc-id", &suspend_smc_id))
146		return 0;
147
148	return suspend_smc_id;
149}
150
151static struct regmap *at91_dt_syscon_sfr(void)
152{
153	struct regmap *regmap;
154
155	regmap = syscon_regmap_lookup_by_compatible("atmel,sama5d2-sfr");
156	if (IS_ERR(regmap)) {
157		regmap = syscon_regmap_lookup_by_compatible("microchip,sam9x60-sfr");
158		if (IS_ERR(regmap))
159			regmap = NULL;
160	}
161
162	return regmap;
163}
164
165/* configure so an HC device and id are always provided */
166/* always called with process context; sleeping is OK */
167
168
169/*
170 * usb_hcd_at91_probe - initialize AT91-based HCDs
171 * @driver:	Pointer to hc driver instance
172 * @pdev:	USB controller to probe
173 *
174 * Context: task context, might sleep
175 *
176 * Allocates basic resources for this USB host controller, and
177 * then invokes the start() method for the HCD associated with it
178 * through the hotplug entry's driver_data.
179 */
180static int usb_hcd_at91_probe(const struct hc_driver *driver,
181			struct platform_device *pdev)
182{
183	struct at91_usbh_data *board;
184	struct ohci_hcd *ohci;
185	int retval;
186	struct usb_hcd *hcd;
187	struct ohci_at91_priv *ohci_at91;
188	struct device *dev = &pdev->dev;
189	struct resource *res;
190	int irq;
191
192	irq = platform_get_irq(pdev, 0);
193	if (irq < 0) {
194		dev_dbg(dev, "hcd probe: missing irq resource\n");
195		return irq;
196	}
197
198	hcd = usb_create_hcd(driver, dev, "at91");
199	if (!hcd)
200		return -ENOMEM;
201	ohci_at91 = hcd_to_ohci_at91_priv(hcd);
202
203	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
204	hcd->regs = devm_ioremap_resource(dev, res);
205	if (IS_ERR(hcd->regs)) {
206		retval = PTR_ERR(hcd->regs);
207		goto err;
208	}
209	hcd->rsrc_start = res->start;
210	hcd->rsrc_len = resource_size(res);
211
212	ohci_at91->iclk = devm_clk_get(dev, "ohci_clk");
213	if (IS_ERR(ohci_at91->iclk)) {
214		dev_err(dev, "failed to get ohci_clk\n");
215		retval = PTR_ERR(ohci_at91->iclk);
216		goto err;
217	}
218	ohci_at91->fclk = devm_clk_get(dev, "uhpck");
219	if (IS_ERR(ohci_at91->fclk)) {
220		dev_err(dev, "failed to get uhpck\n");
221		retval = PTR_ERR(ohci_at91->fclk);
222		goto err;
223	}
224	ohci_at91->hclk = devm_clk_get(dev, "hclk");
225	if (IS_ERR(ohci_at91->hclk)) {
226		dev_err(dev, "failed to get hclk\n");
227		retval = PTR_ERR(ohci_at91->hclk);
228		goto err;
229	}
230
231	ohci_at91->suspend_smc_id = at91_dt_suspend_smc(dev);
232	if (!ohci_at91->suspend_smc_id)  {
233		dev_dbg(dev, "failed to find sfr suspend smc id, using regmap\n");
234		ohci_at91->sfr_regmap = at91_dt_syscon_sfr();
235		if (!ohci_at91->sfr_regmap)
236			dev_dbg(dev, "failed to find sfr node\n");
237	}
238
239	board = hcd->self.controller->platform_data;
240	ohci = hcd_to_ohci(hcd);
241	ohci->num_ports = board->ports;
242	at91_start_hc(pdev);
243
244	/*
245	 * The RemoteWakeupConnected bit has to be set explicitly
246	 * before calling ohci_run. The reset value of this bit is 0.
247	 */
248	ohci->hc_control = OHCI_CTRL_RWC;
249
250	retval = usb_add_hcd(hcd, irq, IRQF_SHARED);
251	if (retval == 0) {
252		device_wakeup_enable(hcd->self.controller);
253		return retval;
254	}
255
256	/* Error handling */
257	at91_stop_hc(pdev);
258
259 err:
260	usb_put_hcd(hcd);
261	return retval;
262}
263
264
265/* may be called with controller, bus, and devices active */
266
267/*
268 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
269 * @hcd:	USB controller to remove
270 * @pdev:	Platform device required for cleanup
271 *
272 * Context: task context, might sleep
273 *
274 * Reverses the effect of usb_hcd_at91_probe(), first invoking
275 * the HCD's stop() method.  It is always called from a thread
276 * context, "rmmod" or something similar.
 
277 */
278static void usb_hcd_at91_remove(struct usb_hcd *hcd,
279				struct platform_device *pdev)
280{
281	usb_remove_hcd(hcd);
282	at91_stop_hc(pdev);
283	usb_put_hcd(hcd);
284}
285
286/*-------------------------------------------------------------------------*/
287static void ohci_at91_usb_set_power(struct at91_usbh_data *pdata, int port, int enable)
288{
289	if (!valid_port(port))
290		return;
291
292	gpiod_set_value(pdata->vbus_pin[port], enable);
293}
294
295static int ohci_at91_usb_get_power(struct at91_usbh_data *pdata, int port)
296{
297	if (!valid_port(port))
298		return -EINVAL;
299
300	return gpiod_get_value(pdata->vbus_pin[port]);
301}
302
303/*
304 * Update the status data from the hub with the over-current indicator change.
305 */
306static int ohci_at91_hub_status_data(struct usb_hcd *hcd, char *buf)
307{
308	struct at91_usbh_data *pdata = hcd->self.controller->platform_data;
309	int length = ohci_hub_status_data(hcd, buf);
310	int port;
311
312	at91_for_each_port(port) {
313		if (pdata->overcurrent_changed[port]) {
314			if (!length)
315				length = 1;
316			buf[0] |= 1 << (port + 1);
317		}
318	}
319
320	return length;
321}
322
323static int ohci_at91_port_suspend(struct ohci_at91_priv *ohci_at91, u8 set)
324{
325	struct regmap *regmap = ohci_at91->sfr_regmap;
326	u32 regval;
327	int ret;
328
329	if (ohci_at91->suspend_smc_id) {
330		struct arm_smccc_res res;
331
332		arm_smccc_smc(ohci_at91->suspend_smc_id, set, 0, 0, 0, 0, 0, 0, &res);
333		if (res.a0)
334			return -EINVAL;
335	} else if (regmap) {
336		ret = regmap_read(regmap, AT91_SFR_OHCIICR, &regval);
337		if (ret)
338			return ret;
339
340		if (set)
341			regval |= AT91_OHCIICR_USB_SUSPEND;
342		else
343			regval &= ~AT91_OHCIICR_USB_SUSPEND;
344
345		regmap_write(regmap, AT91_SFR_OHCIICR, regval);
346	}
347
348	return 0;
349}
350
351/*
352 * Look at the control requests to the root hub and see if we need to override.
353 */
354static int ohci_at91_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
355				 u16 wIndex, char *buf, u16 wLength)
356{
357	struct at91_usbh_data *pdata = dev_get_platdata(hcd->self.controller);
358	struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
359	struct usb_hub_descriptor *desc;
360	int ret = -EINVAL;
361	u32 *data = (u32 *)buf;
362
363	dev_dbg(hcd->self.controller,
364		"ohci_at91_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
365		hcd, typeReq, wValue, wIndex, buf, wLength);
366
367	wIndex--;
368
369	switch (typeReq) {
370	case SetPortFeature:
371		switch (wValue) {
372		case USB_PORT_FEAT_POWER:
373			dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
374			if (valid_port(wIndex)) {
375				ohci_at91_usb_set_power(pdata, wIndex, 1);
376				ret = 0;
377			}
378
379			goto out;
380
381		case USB_PORT_FEAT_SUSPEND:
382			dev_dbg(hcd->self.controller, "SetPortFeat: SUSPEND\n");
383			if (valid_port(wIndex)) {
384				ohci_at91_port_suspend(ohci_at91, 1);
 
385				return 0;
386			}
387			break;
388		}
389		break;
390
391	case ClearPortFeature:
392		switch (wValue) {
393		case USB_PORT_FEAT_C_OVER_CURRENT:
394			dev_dbg(hcd->self.controller,
395				"ClearPortFeature: C_OVER_CURRENT\n");
396
397			if (valid_port(wIndex)) {
398				pdata->overcurrent_changed[wIndex] = 0;
399				pdata->overcurrent_status[wIndex] = 0;
400			}
401
402			goto out;
403
404		case USB_PORT_FEAT_OVER_CURRENT:
405			dev_dbg(hcd->self.controller,
406				"ClearPortFeature: OVER_CURRENT\n");
407
408			if (valid_port(wIndex))
409				pdata->overcurrent_status[wIndex] = 0;
410
411			goto out;
412
413		case USB_PORT_FEAT_POWER:
414			dev_dbg(hcd->self.controller,
415				"ClearPortFeature: POWER\n");
416
417			if (valid_port(wIndex)) {
418				ohci_at91_usb_set_power(pdata, wIndex, 0);
419				return 0;
420			}
421			break;
422
423		case USB_PORT_FEAT_SUSPEND:
424			dev_dbg(hcd->self.controller, "ClearPortFeature: SUSPEND\n");
425			if (valid_port(wIndex)) {
426				ohci_at91_port_suspend(ohci_at91, 0);
 
427				return 0;
428			}
429			break;
430		}
431		break;
432	}
433
434	ret = ohci_hub_control(hcd, typeReq, wValue, wIndex + 1, buf, wLength);
435	if (ret)
436		goto out;
437
438	switch (typeReq) {
439	case GetHubDescriptor:
440
441		/* update the hub's descriptor */
442
443		desc = (struct usb_hub_descriptor *)buf;
444
445		dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
446			desc->wHubCharacteristics);
447
448		/* remove the old configurations for power-switching, and
449		 * over-current protection, and insert our new configuration
450		 */
451
452		desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
453		desc->wHubCharacteristics |=
454			cpu_to_le16(HUB_CHAR_INDV_PORT_LPSM);
455
456		if (pdata->overcurrent_supported) {
457			desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
458			desc->wHubCharacteristics |=
459				cpu_to_le16(HUB_CHAR_INDV_PORT_OCPM);
460		}
461
462		dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
463			desc->wHubCharacteristics);
464
465		return ret;
466
467	case GetPortStatus:
468		/* check port status */
469
470		dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
471
472		if (valid_port(wIndex)) {
473			if (!ohci_at91_usb_get_power(pdata, wIndex))
474				*data &= ~cpu_to_le32(RH_PS_PPS);
475
476			if (pdata->overcurrent_changed[wIndex])
477				*data |= cpu_to_le32(RH_PS_OCIC);
478
479			if (pdata->overcurrent_status[wIndex])
480				*data |= cpu_to_le32(RH_PS_POCI);
481		}
482	}
483
484 out:
485	return ret;
486}
487
488/*-------------------------------------------------------------------------*/
489
490static irqreturn_t ohci_hcd_at91_overcurrent_irq(int irq, void *data)
491{
492	struct platform_device *pdev = data;
493	struct at91_usbh_data *pdata = dev_get_platdata(&pdev->dev);
494	int val, port;
495
496	/* From the GPIO notifying the over-current situation, find
497	 * out the corresponding port */
498	at91_for_each_port(port) {
499		if (gpiod_to_irq(pdata->overcurrent_pin[port]) == irq)
500			break;
501	}
502
503	if (port == AT91_MAX_USBH_PORTS) {
504		dev_err(& pdev->dev, "overcurrent interrupt from unknown GPIO\n");
505		return IRQ_HANDLED;
506	}
507
508	val = gpiod_get_value(pdata->overcurrent_pin[port]);
509
510	/* When notified of an over-current situation, disable power
511	   on the corresponding port, and mark this port in
512	   over-current. */
513	if (!val) {
514		ohci_at91_usb_set_power(pdata, port, 0);
515		pdata->overcurrent_status[port]  = 1;
516		pdata->overcurrent_changed[port] = 1;
517	}
518
519	dev_dbg(& pdev->dev, "overcurrent situation %s\n",
520		val ? "exited" : "notified");
521
522	return IRQ_HANDLED;
523}
524
525static const struct of_device_id at91_ohci_dt_ids[] = {
526	{ .compatible = "atmel,at91rm9200-ohci" },
527	{ /* sentinel */ }
528};
529
530MODULE_DEVICE_TABLE(of, at91_ohci_dt_ids);
531
532/*-------------------------------------------------------------------------*/
533
534static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
535{
536	struct device_node *np = pdev->dev.of_node;
537	struct at91_usbh_data	*pdata;
538	int			i;
539	int			ret;
540	int			err;
541	u32			ports;
542
543	/* Right now device-tree probed devices don't get dma_mask set.
544	 * Since shared usb code relies on it, set it here for now.
545	 * Once we have dma capability bindings this can go away.
546	 */
547	ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
548	if (ret)
549		return ret;
550
551	pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
552	if (!pdata)
553		return -ENOMEM;
554
555	pdev->dev.platform_data = pdata;
556
557	if (!of_property_read_u32(np, "num-ports", &ports))
558		pdata->ports = ports;
559
560	at91_for_each_port(i) {
561		if (i >= pdata->ports)
562			break;
563
564		pdata->vbus_pin[i] =
565			devm_gpiod_get_index_optional(&pdev->dev, "atmel,vbus",
566						      i, GPIOD_OUT_HIGH);
567		if (IS_ERR(pdata->vbus_pin[i])) {
568			err = PTR_ERR(pdata->vbus_pin[i]);
569			dev_err(&pdev->dev, "unable to claim gpio \"vbus\": %d\n", err);
570			continue;
571		}
572	}
573
574	at91_for_each_port(i) {
575		if (i >= pdata->ports)
576			break;
577
578		pdata->overcurrent_pin[i] =
579			devm_gpiod_get_index_optional(&pdev->dev, "atmel,oc",
580						      i, GPIOD_IN);
581		if (!pdata->overcurrent_pin[i])
582			continue;
583		if (IS_ERR(pdata->overcurrent_pin[i])) {
584			err = PTR_ERR(pdata->overcurrent_pin[i]);
585			dev_err(&pdev->dev, "unable to claim gpio \"overcurrent\": %d\n", err);
586			continue;
587		}
588
589		ret = devm_request_irq(&pdev->dev,
590				       gpiod_to_irq(pdata->overcurrent_pin[i]),
591				       ohci_hcd_at91_overcurrent_irq,
592				       IRQF_SHARED,
593				       "ohci_overcurrent", pdev);
594		if (ret)
595			dev_info(&pdev->dev, "failed to request gpio \"overcurrent\" IRQ\n");
596	}
597
598	device_init_wakeup(&pdev->dev, 1);
599	return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
600}
601
602static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
603{
604	struct at91_usbh_data	*pdata = dev_get_platdata(&pdev->dev);
605	int			i;
606
607	if (pdata) {
608		at91_for_each_port(i)
609			ohci_at91_usb_set_power(pdata, i, 0);
610	}
611
612	device_init_wakeup(&pdev->dev, 0);
613	usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
614	return 0;
615}
616
617static int __maybe_unused
618ohci_hcd_at91_drv_suspend(struct device *dev)
619{
620	struct usb_hcd	*hcd = dev_get_drvdata(dev);
621	struct ohci_hcd	*ohci = hcd_to_ohci(hcd);
622	struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
623	int		ret;
624
625	/*
626	 * Disable wakeup if we are going to sleep with slow clock mode
627	 * enabled.
628	 */
629	ohci_at91->wakeup = device_may_wakeup(dev)
630			&& !at91_suspend_entering_slow_clock();
631
632	if (ohci_at91->wakeup)
633		enable_irq_wake(hcd->irq);
634
 
 
635	ret = ohci_suspend(hcd, ohci_at91->wakeup);
636	if (ret) {
637		if (ohci_at91->wakeup)
638			disable_irq_wake(hcd->irq);
639		return ret;
640	}
641	/*
642	 * The integrated transceivers seem unable to notice disconnect,
643	 * reconnect, or wakeup without the 48 MHz clock active.  so for
644	 * correctness, always discard connection state (using reset).
645	 *
646	 * REVISIT: some boards will be able to turn VBUS off...
647	 */
648	if (!ohci_at91->wakeup) {
649		ohci->rh_state = OHCI_RH_HALTED;
650
651		/* flush the writes */
652		(void) ohci_readl (ohci, &ohci->regs->control);
653		msleep(1);
654		ohci_at91_port_suspend(ohci_at91, 1);
655		at91_stop_clock(ohci_at91);
656	} else {
657		ohci_at91_port_suspend(ohci_at91, 1);
658	}
659
660	return ret;
661}
662
663static int __maybe_unused
664ohci_hcd_at91_drv_resume(struct device *dev)
665{
666	struct usb_hcd	*hcd = dev_get_drvdata(dev);
667	struct ohci_at91_priv *ohci_at91 = hcd_to_ohci_at91_priv(hcd);
668
669	ohci_at91_port_suspend(ohci_at91, 0);
670
671	if (ohci_at91->wakeup)
672		disable_irq_wake(hcd->irq);
673	else
674		at91_start_clock(ohci_at91);
675
676	ohci_resume(hcd, false);
677
 
 
678	return 0;
679}
680
681static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops, ohci_hcd_at91_drv_suspend,
682					ohci_hcd_at91_drv_resume);
683
684static struct platform_driver ohci_hcd_at91_driver = {
685	.probe		= ohci_hcd_at91_drv_probe,
686	.remove		= ohci_hcd_at91_drv_remove,
687	.shutdown	= usb_hcd_platform_shutdown,
688	.driver		= {
689		.name	= "at91_ohci",
690		.pm	= &ohci_hcd_at91_pm_ops,
691		.of_match_table	= at91_ohci_dt_ids,
692	},
693};
694
695static int __init ohci_at91_init(void)
696{
697	if (usb_disabled())
698		return -ENODEV;
699
 
700	ohci_init_driver(&ohci_at91_hc_driver, &ohci_at91_drv_overrides);
701
702	/*
703	 * The Atmel HW has some unusual quirks, which require Atmel-specific
704	 * workarounds. We override certain hc_driver functions here to
705	 * achieve that. We explicitly do not enhance ohci_driver_overrides to
706	 * allow this more easily, since this is an unusual case, and we don't
707	 * want to encourage others to override these functions by making it
708	 * too easy.
709	 */
710
711	ohci_at91_hc_driver.hub_status_data	= ohci_at91_hub_status_data;
712	ohci_at91_hc_driver.hub_control		= ohci_at91_hub_control;
713
714	return platform_driver_register(&ohci_hcd_at91_driver);
715}
716module_init(ohci_at91_init);
717
718static void __exit ohci_at91_cleanup(void)
719{
720	platform_driver_unregister(&ohci_hcd_at91_driver);
721}
722module_exit(ohci_at91_cleanup);
723
724MODULE_DESCRIPTION(DRIVER_DESC);
725MODULE_LICENSE("GPL");
726MODULE_ALIAS("platform:at91_ohci");
v5.4
  1// SPDX-License-Identifier: GPL-1.0+
  2/*
  3 * OHCI HCD (Host Controller Driver) for USB.
  4 *
  5 *  Copyright (C) 2004 SAN People (Pty) Ltd.
  6 *  Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
  7 *
  8 * AT91 Bus Glue
  9 *
 10 * Based on fragments of 2.4 driver by Rick Bronson.
 11 * Based on ohci-omap.c
 12 *
 13 * This file is licenced under the GPL.
 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/* interface, function and usb clocks; sometimes also an AHB clock */
 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
 42struct 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;				/* number of ports on root hub */
 46	u8 overcurrent_supported;
 47	u8 overcurrent_status[AT91_MAX_USBH_PORTS];
 48	u8 overcurrent_changed[AT91_MAX_USBH_PORTS];
 49};
 50
 51struct ohci_at91_priv {
 52	struct clk *iclk;
 53	struct clk *fclk;
 54	struct clk *hclk;
 55	bool clocked;
 56	bool wakeup;		/* Saved wake-up state for resume */
 57	struct regmap *sfr_regmap;
 
 58};
 59/* interface and function clocks; sometimes also an AHB clock */
 60
 61#define DRIVER_DESC "OHCI Atmel driver"
 62
 63static const char hcd_name[] = "ohci-atmel";
 64
 65static struct hc_driver __read_mostly ohci_at91_hc_driver;
 66
 67static const struct ohci_driver_overrides ohci_at91_drv_overrides __initconst = {
 68	.extra_priv_size = sizeof(struct ohci_at91_priv),
 69};
 70
 71/*-------------------------------------------------------------------------*/
 72
 73static 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
 85static 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
 96static 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	 * Start the USB clocks.
106	 */
107	at91_start_clock(ohci_at91);
108
109	/*
110	 * The USB host controller must remain in reset.
111	 */
112	writel(0, &regs->control);
113}
114
115static 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	 * Put the USB host controller into reset.
125	 */
126	writel(0, &regs->control);
127
128	/*
129	 * Stop the USB clocks.
130	 */
131	at91_stop_clock(ohci_at91);
132}
133
134
135/*-------------------------------------------------------------------------*/
136
137static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
138
 
 
 
 
 
 
 
 
 
 
 
 
 
139static 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/* configure so an HC device and id are always provided */
154/* always called with process context; sleeping is OK */
155
156
157/**
158 * usb_hcd_at91_probe - initialize AT91-based HCDs
159 * Context: !in_interrupt()
 
 
 
160 *
161 * Allocates basic resources for this USB host controller, and
162 * then invokes the start() method for the HCD associated with it
163 * through the hotplug entry's driver_data.
164 */
165static 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	 * The RemoteWakeupConnected bit has to be set explicitly
227	 * before calling ohci_run. The reset value of this bit is 0.
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	/* Error handling */
238	at91_stop_hc(pdev);
239
240 err:
241	usb_put_hcd(hcd);
242	return retval;
243}
244
245
246/* may be called with controller, bus, and devices active */
247
248/**
249 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
250 * @dev: USB Host Controller being removed
251 * Context: !in_interrupt()
 
 
252 *
253 * Reverses the effect of usb_hcd_at91_probe(), first invoking
254 * the HCD's stop() method.  It is always called from a thread
255 * context, "rmmod" or something similar.
256 *
257 */
258static 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/*-------------------------------------------------------------------------*/
267static 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
275static 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 * Update the status data from the hub with the over-current indicator change.
285 */
286static 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
303static 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, &regval);
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 * Look at the control requests to the root hub and see if we need to override.
327 */
328static 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		/* update the hub's descriptor */
418
419		desc = (struct usb_hub_descriptor *)buf;
420
421		dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
422			desc->wHubCharacteristics);
423
424		/* remove the old configurations for power-switching, and
425		 * over-current protection, and insert our new configuration
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		/* check port status */
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
466static 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	/* From the GPIO notifying the over-current situation, find
473	 * out the corresponding port */
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	/* When notified of an over-current situation, disable power
487	   on the corresponding port, and mark this port in
488	   over-current. */
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
501static const struct of_device_id at91_ohci_dt_ids[] = {
502	{ .compatible = "atmel,at91rm9200-ohci" },
503	{ /* sentinel */ }
504};
505
506MODULE_DEVICE_TABLE(of, at91_ohci_dt_ids);
507
508/*-------------------------------------------------------------------------*/
509
510static 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	/* Right now device-tree probed devices don't get dma_mask set.
520	 * Since shared usb code relies on it, set it here for now.
521	 * Once we have dma capability bindings this can go away.
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
578static 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
593static int __maybe_unused
594ohci_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	 * Disable wakeup if we are going to sleep with slow clock mode
603	 * enabled.
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	 * The integrated transceivers seem unable to notice disconnect,
621	 * reconnect, or wakeup without the 48 MHz clock active.  so for
622	 * correctness, always discard connection state (using reset).
623	 *
624	 * REVISIT: some boards will be able to turn VBUS off...
625	 */
626	if (!ohci_at91->wakeup) {
627		ohci->rh_state = OHCI_RH_HALTED;
628
629		/* flush the writes */
630		(void) ohci_readl (ohci, &ohci->regs->control);
 
 
631		at91_stop_clock(ohci_at91);
 
 
632	}
633
634	return ret;
635}
636
637static int __maybe_unused
638ohci_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
655static SIMPLE_DEV_PM_OPS(ohci_hcd_at91_pm_ops, ohci_hcd_at91_drv_suspend,
656					ohci_hcd_at91_drv_resume);
657
658static 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
669static 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	 * The Atmel HW has some unusual quirks, which require Atmel-specific
679	 * workarounds. We override certain hc_driver functions here to
680	 * achieve that. We explicitly do not enhance ohci_driver_overrides to
681	 * allow this more easily, since this is an unusual case, and we don't
682	 * want to encourage others to override these functions by making it
683	 * too easy.
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}
691module_init(ohci_at91_init);
692
693static void __exit ohci_at91_cleanup(void)
694{
695	platform_driver_unregister(&ohci_hcd_at91_driver);
696}
697module_exit(ohci_at91_cleanup);
698
699MODULE_DESCRIPTION(DRIVER_DESC);
700MODULE_LICENSE("GPL");
701MODULE_ALIAS("platform:at91_ohci");