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  *
8  * SA1111 Bus Glue
9  *
10  * Written by Christopher Hoover <ch@hpl.hp.com>
11  * Based on fragments of previous driver by Russell King et al.
12  *
13  * This file is licenced under the GPL.
14  */
15 
16 #include <mach/hardware.h>
17 #include <asm/mach-types.h>
18 #include <mach/assabet.h>
19 #include <mach/badge4.h>
20 #include <asm/hardware/sa1111.h>
21 
22 #ifndef CONFIG_SA1111
23 #error "This file is SA-1111 bus glue.  CONFIG_SA1111 must be defined."
24 #endif
25 
26 extern int usb_disabled(void);
27 
28 /*-------------------------------------------------------------------------*/
29 
sa1111_start_hc(struct sa1111_dev * dev)30 static void sa1111_start_hc(struct sa1111_dev *dev)
31 {
32 	unsigned int usb_rst = 0;
33 
34 	printk(KERN_DEBUG "%s: starting SA-1111 OHCI USB Controller\n",
35 	       __FILE__);
36 
37 #ifdef CONFIG_SA1100_BADGE4
38 	if (machine_is_badge4()) {
39 		badge4_set_5V(BADGE4_5V_USB, 1);
40 	}
41 #endif
42 
43 	if (machine_is_xp860() ||
44 	    machine_has_neponset() ||
45 	    machine_is_pfs168() ||
46 	    machine_is_badge4())
47 		usb_rst = USB_RESET_PWRSENSELOW | USB_RESET_PWRCTRLLOW;
48 
49 	/*
50 	 * Configure the power sense and control lines.  Place the USB
51 	 * host controller in reset.
52 	 */
53 	sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
54 		      dev->mapbase + SA1111_USB_RESET);
55 
56 	/*
57 	 * Now, carefully enable the USB clock, and take
58 	 * the USB host controller out of reset.
59 	 */
60 	sa1111_enable_device(dev);
61 	udelay(11);
62 	sa1111_writel(usb_rst, dev->mapbase + SA1111_USB_RESET);
63 }
64 
sa1111_stop_hc(struct sa1111_dev * dev)65 static void sa1111_stop_hc(struct sa1111_dev *dev)
66 {
67 	unsigned int usb_rst;
68 	printk(KERN_DEBUG "%s: stopping SA-1111 OHCI USB Controller\n",
69 	       __FILE__);
70 
71 	/*
72 	 * Put the USB host controller into reset.
73 	 */
74 	usb_rst = sa1111_readl(dev->mapbase + SA1111_USB_RESET);
75 	sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
76 		      dev->mapbase + SA1111_USB_RESET);
77 
78 	/*
79 	 * Stop the USB clock.
80 	 */
81 	sa1111_disable_device(dev);
82 
83 #ifdef CONFIG_SA1100_BADGE4
84 	if (machine_is_badge4()) {
85 		/* Disable power to the USB bus */
86 		badge4_set_5V(BADGE4_5V_USB, 0);
87 	}
88 #endif
89 }
90 
91 
92 /*-------------------------------------------------------------------------*/
93 
94 #if 0
95 static void dump_hci_status(struct usb_hcd *hcd, const char *label)
96 {
97 	unsigned long status = sa1111_readl(hcd->regs + SA1111_USB_STATUS);
98 
99 	dbg ("%s USB_STATUS = { %s%s%s%s%s}", label,
100 	     ((status & USB_STATUS_IRQHCIRMTWKUP) ? "IRQHCIRMTWKUP " : ""),
101 	     ((status & USB_STATUS_IRQHCIBUFFACC) ? "IRQHCIBUFFACC " : ""),
102 	     ((status & USB_STATUS_NIRQHCIM) ? "" : "IRQHCIM "),
103 	     ((status & USB_STATUS_NHCIMFCLR) ? "" : "HCIMFCLR "),
104 	     ((status & USB_STATUS_USBPWRSENSE) ? "USBPWRSENSE " : ""));
105 }
106 #endif
107 
108 /*-------------------------------------------------------------------------*/
109 
110 /* configure so an HC device and id are always provided */
111 /* always called with process context; sleeping is OK */
112 
113 
114 /**
115  * usb_hcd_sa1111_probe - initialize SA-1111-based HCDs
116  * Context: !in_interrupt()
117  *
118  * Allocates basic resources for this USB host controller, and
119  * then invokes the start() method for the HCD associated with it
120  * through the hotplug entry's driver_data.
121  *
122  * Store this function in the HCD's struct pci_driver as probe().
123  */
usb_hcd_sa1111_probe(const struct hc_driver * driver,struct sa1111_dev * dev)124 int usb_hcd_sa1111_probe (const struct hc_driver *driver,
125 			  struct sa1111_dev *dev)
126 {
127 	struct usb_hcd *hcd;
128 	int retval;
129 
130 	hcd = usb_create_hcd (driver, &dev->dev, "sa1111");
131 	if (!hcd)
132 		return -ENOMEM;
133 	hcd->rsrc_start = dev->res.start;
134 	hcd->rsrc_len = dev->res.end - dev->res.start + 1;
135 
136 	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
137 		dbg("request_mem_region failed");
138 		retval = -EBUSY;
139 		goto err1;
140 	}
141 	hcd->regs = dev->mapbase;
142 
143 	sa1111_start_hc(dev);
144 	ohci_hcd_init(hcd_to_ohci(hcd));
145 
146 	retval = usb_add_hcd(hcd, dev->irq[1], IRQF_DISABLED);
147 	if (retval == 0)
148 		return retval;
149 
150 	sa1111_stop_hc(dev);
151 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
152  err1:
153 	usb_put_hcd(hcd);
154 	return retval;
155 }
156 
157 
158 /* may be called without controller electrically present */
159 /* may be called with controller, bus, and devices active */
160 
161 /**
162  * usb_hcd_sa1111_remove - shutdown processing for SA-1111-based HCDs
163  * @dev: USB Host Controller being removed
164  * Context: !in_interrupt()
165  *
166  * Reverses the effect of usb_hcd_sa1111_probe(), first invoking
167  * the HCD's stop() method.  It is always called from a thread
168  * context, normally "rmmod", "apmd", or something similar.
169  *
170  */
usb_hcd_sa1111_remove(struct usb_hcd * hcd,struct sa1111_dev * dev)171 void usb_hcd_sa1111_remove (struct usb_hcd *hcd, struct sa1111_dev *dev)
172 {
173 	usb_remove_hcd(hcd);
174 	sa1111_stop_hc(dev);
175 	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
176 	usb_put_hcd(hcd);
177 }
178 
179 /*-------------------------------------------------------------------------*/
180 
181 static int __devinit
ohci_sa1111_start(struct usb_hcd * hcd)182 ohci_sa1111_start (struct usb_hcd *hcd)
183 {
184 	struct ohci_hcd	*ohci = hcd_to_ohci (hcd);
185 	int		ret;
186 
187 	if ((ret = ohci_init(ohci)) < 0)
188 		return ret;
189 
190 	if ((ret = ohci_run (ohci)) < 0) {
191 		err ("can't start %s", hcd->self.bus_name);
192 		ohci_stop (hcd);
193 		return ret;
194 	}
195 	return 0;
196 }
197 
198 /*-------------------------------------------------------------------------*/
199 
200 static const struct hc_driver ohci_sa1111_hc_driver = {
201 	.description =		hcd_name,
202 	.product_desc =		"SA-1111 OHCI",
203 	.hcd_priv_size =	sizeof(struct ohci_hcd),
204 
205 	/*
206 	 * generic hardware linkage
207 	 */
208 	.irq =			ohci_irq,
209 	.flags =		HCD_USB11 | HCD_MEMORY,
210 
211 	/*
212 	 * basic lifecycle operations
213 	 */
214 	.start =		ohci_sa1111_start,
215 	.stop =			ohci_stop,
216 
217 	/*
218 	 * managing i/o requests and associated device resources
219 	 */
220 	.urb_enqueue =		ohci_urb_enqueue,
221 	.urb_dequeue =		ohci_urb_dequeue,
222 	.endpoint_disable =	ohci_endpoint_disable,
223 
224 	/*
225 	 * scheduling support
226 	 */
227 	.get_frame_number =	ohci_get_frame,
228 
229 	/*
230 	 * root hub support
231 	 */
232 	.hub_status_data =	ohci_hub_status_data,
233 	.hub_control =		ohci_hub_control,
234 #ifdef	CONFIG_PM
235 	.bus_suspend =		ohci_bus_suspend,
236 	.bus_resume =		ohci_bus_resume,
237 #endif
238 	.start_port_reset =	ohci_start_port_reset,
239 };
240 
241 /*-------------------------------------------------------------------------*/
242 
ohci_hcd_sa1111_drv_probe(struct sa1111_dev * dev)243 static int ohci_hcd_sa1111_drv_probe(struct sa1111_dev *dev)
244 {
245 	int ret;
246 
247 	if (usb_disabled())
248 		return -ENODEV;
249 
250 	ret = usb_hcd_sa1111_probe(&ohci_sa1111_hc_driver, dev);
251 	return ret;
252 }
253 
ohci_hcd_sa1111_drv_remove(struct sa1111_dev * dev)254 static int ohci_hcd_sa1111_drv_remove(struct sa1111_dev *dev)
255 {
256 	struct usb_hcd *hcd = sa1111_get_drvdata(dev);
257 
258 	usb_hcd_sa1111_remove(hcd, dev);
259 	return 0;
260 }
261 
262 static struct sa1111_driver ohci_hcd_sa1111_driver = {
263 	.drv = {
264 		.name	= "sa1111-ohci",
265 	},
266 	.devid		= SA1111_DEVID_USB,
267 	.probe		= ohci_hcd_sa1111_drv_probe,
268 	.remove		= ohci_hcd_sa1111_drv_remove,
269 };
270 
271