1/*
2 * OHCI HCD (Host Controller Driver) for USB.
3 *
4 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
6 * (C) Copyright 2002 Hewlett-Packard Company
7 * (C) Copyright 2006 Sylvain Munaut <tnt@246tNt.com>
8 *
9 * Bus glue for OHCI HC on the of_platform bus
10 *
11 * Modified for of_platform bus from ohci-sa1111.c
12 *
13 * This file is licenced under the GPL.
14 */
15
16#include <linux/signal.h>
17#include <linux/of_address.h>
18#include <linux/of_irq.h>
19#include <linux/of_platform.h>
20
21#include <asm/prom.h>
22
23
24static int
25ohci_ppc_of_start(struct usb_hcd *hcd)
26{
27	struct ohci_hcd	*ohci = hcd_to_ohci(hcd);
28	int		ret;
29
30	if ((ret = ohci_init(ohci)) < 0)
31		return ret;
32
33	if ((ret = ohci_run(ohci)) < 0) {
34		dev_err(hcd->self.controller, "can't start %s\n",
35			hcd->self.bus_name);
36		ohci_stop(hcd);
37		return ret;
38	}
39
40	return 0;
41}
42
43static const struct hc_driver ohci_ppc_of_hc_driver = {
44	.description =		hcd_name,
45	.product_desc =		"OF OHCI",
46	.hcd_priv_size =	sizeof(struct ohci_hcd),
47
48	/*
49	 * generic hardware linkage
50	 */
51	.irq =			ohci_irq,
52	.flags =		HCD_USB11 | HCD_MEMORY,
53
54	/*
55	 * basic lifecycle operations
56	 */
57	.start =		ohci_ppc_of_start,
58	.stop =			ohci_stop,
59	.shutdown = 		ohci_shutdown,
60
61	/*
62	 * managing i/o requests and associated device resources
63	 */
64	.urb_enqueue =		ohci_urb_enqueue,
65	.urb_dequeue =		ohci_urb_dequeue,
66	.endpoint_disable =	ohci_endpoint_disable,
67
68	/*
69	 * scheduling support
70	 */
71	.get_frame_number =	ohci_get_frame,
72
73	/*
74	 * root hub support
75	 */
76	.hub_status_data =	ohci_hub_status_data,
77	.hub_control =		ohci_hub_control,
78#ifdef	CONFIG_PM
79	.bus_suspend =		ohci_bus_suspend,
80	.bus_resume =		ohci_bus_resume,
81#endif
82	.start_port_reset =	ohci_start_port_reset,
83};
84
85
86static int ohci_hcd_ppc_of_probe(struct platform_device *op)
87{
88	struct device_node *dn = op->dev.of_node;
89	struct usb_hcd *hcd;
90	struct ohci_hcd	*ohci;
91	struct resource res;
92	int irq;
93
94	int rv;
95	int is_bigendian;
96	struct device_node *np;
97
98	if (usb_disabled())
99		return -ENODEV;
100
101	is_bigendian =
102		of_device_is_compatible(dn, "ohci-bigendian") ||
103		of_device_is_compatible(dn, "ohci-be");
104
105	dev_dbg(&op->dev, "initializing PPC-OF USB Controller\n");
106
107	rv = of_address_to_resource(dn, 0, &res);
108	if (rv)
109		return rv;
110
111	hcd = usb_create_hcd(&ohci_ppc_of_hc_driver, &op->dev, "PPC-OF USB");
112	if (!hcd)
113		return -ENOMEM;
114
115	hcd->rsrc_start = res.start;
116	hcd->rsrc_len = resource_size(&res);
117
118	hcd->regs = devm_ioremap_resource(&op->dev, &res);
119	if (IS_ERR(hcd->regs)) {
120		rv = PTR_ERR(hcd->regs);
121		goto err_rmr;
122	}
123
124	irq = irq_of_parse_and_map(dn, 0);
125	if (irq == NO_IRQ) {
126		dev_err(&op->dev, "%s: irq_of_parse_and_map failed\n",
127			__FILE__);
128		rv = -EBUSY;
129		goto err_rmr;
130	}
131
132	ohci = hcd_to_ohci(hcd);
133	if (is_bigendian) {
134		ohci->flags |= OHCI_QUIRK_BE_MMIO | OHCI_QUIRK_BE_DESC;
135		if (of_device_is_compatible(dn, "fsl,mpc5200-ohci"))
136			ohci->flags |= OHCI_QUIRK_FRAME_NO;
137		if (of_device_is_compatible(dn, "mpc5200-ohci"))
138			ohci->flags |= OHCI_QUIRK_FRAME_NO;
139	}
140
141	ohci_hcd_init(ohci);
142
143	rv = usb_add_hcd(hcd, irq, 0);
144	if (rv == 0) {
145		device_wakeup_enable(hcd->self.controller);
146		return 0;
147	}
148
149	/* by now, 440epx is known to show usb_23 erratum */
150	np = of_find_compatible_node(NULL, NULL, "ibm,usb-ehci-440epx");
151
152	/* Work around - At this point ohci_run has executed, the
153	* controller is running, everything, the root ports, etc., is
154	* set up.  If the ehci driver is loaded, put the ohci core in
155	* the suspended state.  The ehci driver will bring it out of
156	* suspended state when / if a non-high speed USB device is
157	* attached to the USB Host port.  If the ehci driver is not
158	* loaded, do nothing. request_mem_region is used to test if
159	* the ehci driver is loaded.
160	*/
161	if (np !=  NULL) {
162		if (!of_address_to_resource(np, 0, &res)) {
163			if (!request_mem_region(res.start, 0x4, hcd_name)) {
164				writel_be((readl_be(&ohci->regs->control) |
165					OHCI_USB_SUSPEND), &ohci->regs->control);
166					(void) readl_be(&ohci->regs->control);
167			} else
168				release_mem_region(res.start, 0x4);
169		} else
170			pr_debug("%s: cannot get ehci offset from fdt\n", __FILE__);
171	}
172
173	irq_dispose_mapping(irq);
174err_rmr:
175 	usb_put_hcd(hcd);
176
177	return rv;
178}
179
180static int ohci_hcd_ppc_of_remove(struct platform_device *op)
181{
182	struct usb_hcd *hcd = platform_get_drvdata(op);
183
184	dev_dbg(&op->dev, "stopping PPC-OF USB Controller\n");
185
186	usb_remove_hcd(hcd);
187
188	irq_dispose_mapping(hcd->irq);
189
190	usb_put_hcd(hcd);
191
192	return 0;
193}
194
195static const struct of_device_id ohci_hcd_ppc_of_match[] = {
196#ifdef CONFIG_USB_OHCI_HCD_PPC_OF_BE
197	{
198		.name = "usb",
199		.compatible = "ohci-bigendian",
200	},
201	{
202		.name = "usb",
203		.compatible = "ohci-be",
204	},
205#endif
206#ifdef CONFIG_USB_OHCI_HCD_PPC_OF_LE
207	{
208		.name = "usb",
209		.compatible = "ohci-littledian",
210	},
211	{
212		.name = "usb",
213		.compatible = "ohci-le",
214	},
215#endif
216	{},
217};
218MODULE_DEVICE_TABLE(of, ohci_hcd_ppc_of_match);
219
220#if	!defined(CONFIG_USB_OHCI_HCD_PPC_OF_BE) && \
221	!defined(CONFIG_USB_OHCI_HCD_PPC_OF_LE)
222#error "No endianness selected for ppc-of-ohci"
223#endif
224
225
226static struct platform_driver ohci_hcd_ppc_of_driver = {
227	.probe		= ohci_hcd_ppc_of_probe,
228	.remove		= ohci_hcd_ppc_of_remove,
229	.shutdown	= usb_hcd_platform_shutdown,
230	.driver = {
231		.name = "ppc-of-ohci",
232		.of_match_table = ohci_hcd_ppc_of_match,
233	},
234};
235
236