xref: /openbmc/linux/drivers/usb/host/fhci-hcd.c (revision a8fe58ce) 
1 /*
2  * Freescale QUICC Engine USB Host Controller Driver
3  *
4  * Copyright (c) Freescale Semicondutor, Inc. 2006.
5  *               Shlomi Gridish <gridish@freescale.com>
6  *               Jerry Huang <Chang-Ming.Huang@freescale.com>
7  * Copyright (c) Logic Product Development, Inc. 2007
8  *               Peter Barada <peterb@logicpd.com>
9  * Copyright (c) MontaVista Software, Inc. 2008.
10  *               Anton Vorontsov <avorontsov@ru.mvista.com>
11  *
12  * This program is free software; you can redistribute  it and/or modify it
13  * under  the terms of  the GNU General  Public License as published by the
14  * Free Software Foundation;  either version 2 of the  License, or (at your
15  * option) any later version.
16  */
17 
18 #include <linux/module.h>
19 #include <linux/types.h>
20 #include <linux/spinlock.h>
21 #include <linux/kernel.h>
22 #include <linux/delay.h>
23 #include <linux/errno.h>
24 #include <linux/list.h>
25 #include <linux/interrupt.h>
26 #include <linux/io.h>
27 #include <linux/usb.h>
28 #include <linux/usb/hcd.h>
29 #include <linux/of_address.h>
30 #include <linux/of_irq.h>
31 #include <linux/of_platform.h>
32 #include <linux/of_gpio.h>
33 #include <linux/slab.h>
34 #include <soc/fsl/qe/qe.h>
35 #include <asm/fsl_gtm.h>
36 #include "fhci.h"
37 
38 void fhci_start_sof_timer(struct fhci_hcd *fhci)
39 {
40 	fhci_dbg(fhci, "-> %s\n", __func__);
41 
42 	/* clear frame_n */
43 	out_be16(&fhci->pram->frame_num, 0);
44 
45 	out_be16(&fhci->regs->usb_ussft, 0);
46 	setbits8(&fhci->regs->usb_usmod, USB_MODE_SFTE);
47 
48 	fhci_dbg(fhci, "<- %s\n", __func__);
49 }
50 
51 void fhci_stop_sof_timer(struct fhci_hcd *fhci)
52 {
53 	fhci_dbg(fhci, "-> %s\n", __func__);
54 
55 	clrbits8(&fhci->regs->usb_usmod, USB_MODE_SFTE);
56 	gtm_stop_timer16(fhci->timer);
57 
58 	fhci_dbg(fhci, "<- %s\n", __func__);
59 }
60 
61 u16 fhci_get_sof_timer_count(struct fhci_usb *usb)
62 {
63 	return be16_to_cpu(in_be16(&usb->fhci->regs->usb_ussft) / 12);
64 }
65 
66 /* initialize the endpoint zero */
67 static u32 endpoint_zero_init(struct fhci_usb *usb,
68 			      enum fhci_mem_alloc data_mem,
69 			      u32 ring_len)
70 {
71 	u32 rc;
72 
73 	rc = fhci_create_ep(usb, data_mem, ring_len);
74 	if (rc)
75 		return rc;
76 
77 	/* inilialize endpoint registers */
78 	fhci_init_ep_registers(usb, usb->ep0, data_mem);
79 
80 	return 0;
81 }
82 
83 /* enable the USB interrupts */
84 void fhci_usb_enable_interrupt(struct fhci_usb *usb)
85 {
86 	struct fhci_hcd *fhci = usb->fhci;
87 
88 	if (usb->intr_nesting_cnt == 1) {
89 		/* initialize the USB interrupt */
90 		enable_irq(fhci_to_hcd(fhci)->irq);
91 
92 		/* initialize the event register and mask register */
93 		out_be16(&usb->fhci->regs->usb_usber, 0xffff);
94 		out_be16(&usb->fhci->regs->usb_usbmr, usb->saved_msk);
95 
96 		/* enable the timer interrupts */
97 		enable_irq(fhci->timer->irq);
98 	} else if (usb->intr_nesting_cnt > 1)
99 		fhci_info(fhci, "unbalanced USB interrupts nesting\n");
100 	usb->intr_nesting_cnt--;
101 }
102 
103 /* disable the usb interrupt */
104 void fhci_usb_disable_interrupt(struct fhci_usb *usb)
105 {
106 	struct fhci_hcd *fhci = usb->fhci;
107 
108 	if (usb->intr_nesting_cnt == 0) {
109 		/* disable the timer interrupt */
110 		disable_irq_nosync(fhci->timer->irq);
111 
112 		/* disable the usb interrupt */
113 		disable_irq_nosync(fhci_to_hcd(fhci)->irq);
114 		out_be16(&usb->fhci->regs->usb_usbmr, 0);
115 	}
116 	usb->intr_nesting_cnt++;
117 }
118 
119 /* enable the USB controller */
120 static u32 fhci_usb_enable(struct fhci_hcd *fhci)
121 {
122 	struct fhci_usb *usb = fhci->usb_lld;
123 
124 	out_be16(&usb->fhci->regs->usb_usber, 0xffff);
125 	out_be16(&usb->fhci->regs->usb_usbmr, usb->saved_msk);
126 	setbits8(&usb->fhci->regs->usb_usmod, USB_MODE_EN);
127 
128 	mdelay(100);
129 
130 	return 0;
131 }
132 
133 /* disable the USB controller */
134 static u32 fhci_usb_disable(struct fhci_hcd *fhci)
135 {
136 	struct fhci_usb *usb = fhci->usb_lld;
137 
138 	fhci_usb_disable_interrupt(usb);
139 	fhci_port_disable(fhci);
140 
141 	/* disable the usb controller */
142 	if (usb->port_status == FHCI_PORT_FULL ||
143 			usb->port_status == FHCI_PORT_LOW)
144 		fhci_device_disconnected_interrupt(fhci);
145 
146 	clrbits8(&usb->fhci->regs->usb_usmod, USB_MODE_EN);
147 
148 	return 0;
149 }
150 
151 /* check the bus state by polling the QE bit on the IO ports */
152 int fhci_ioports_check_bus_state(struct fhci_hcd *fhci)
153 {
154 	u8 bits = 0;
155 
156 	/* check USBOE,if transmitting,exit */
157 	if (!gpio_get_value(fhci->gpios[GPIO_USBOE]))
158 		return -1;
159 
160 	/* check USBRP */
161 	if (gpio_get_value(fhci->gpios[GPIO_USBRP]))
162 		bits |= 0x2;
163 
164 	/* check USBRN */
165 	if (gpio_get_value(fhci->gpios[GPIO_USBRN]))
166 		bits |= 0x1;
167 
168 	return bits;
169 }
170 
171 static void fhci_mem_free(struct fhci_hcd *fhci)
172 {
173 	struct ed *ed;
174 	struct ed *next_ed;
175 	struct td *td;
176 	struct td *next_td;
177 
178 	list_for_each_entry_safe(ed, next_ed, &fhci->empty_eds, node) {
179 		list_del(&ed->node);
180 		kfree(ed);
181 	}
182 
183 	list_for_each_entry_safe(td, next_td, &fhci->empty_tds, node) {
184 		list_del(&td->node);
185 		kfree(td);
186 	}
187 
188 	kfree(fhci->vroot_hub);
189 	fhci->vroot_hub = NULL;
190 
191 	kfree(fhci->hc_list);
192 	fhci->hc_list = NULL;
193 }
194 
195 static int fhci_mem_init(struct fhci_hcd *fhci)
196 {
197 	int i;
198 
199 	fhci->hc_list = kzalloc(sizeof(*fhci->hc_list), GFP_KERNEL);
200 	if (!fhci->hc_list)
201 		goto err;
202 
203 	INIT_LIST_HEAD(&fhci->hc_list->ctrl_list);
204 	INIT_LIST_HEAD(&fhci->hc_list->bulk_list);
205 	INIT_LIST_HEAD(&fhci->hc_list->iso_list);
206 	INIT_LIST_HEAD(&fhci->hc_list->intr_list);
207 	INIT_LIST_HEAD(&fhci->hc_list->done_list);
208 
209 	fhci->vroot_hub = kzalloc(sizeof(*fhci->vroot_hub), GFP_KERNEL);
210 	if (!fhci->vroot_hub)
211 		goto err;
212 
213 	INIT_LIST_HEAD(&fhci->empty_eds);
214 	INIT_LIST_HEAD(&fhci->empty_tds);
215 
216 	/* initialize work queue to handle done list */
217 	fhci_tasklet.data = (unsigned long)fhci;
218 	fhci->process_done_task = &fhci_tasklet;
219 
220 	for (i = 0; i < MAX_TDS; i++) {
221 		struct td *td;
222 
223 		td = kmalloc(sizeof(*td), GFP_KERNEL);
224 		if (!td)
225 			goto err;
226 		fhci_recycle_empty_td(fhci, td);
227 	}
228 	for (i = 0; i < MAX_EDS; i++) {
229 		struct ed *ed;
230 
231 		ed = kmalloc(sizeof(*ed), GFP_KERNEL);
232 		if (!ed)
233 			goto err;
234 		fhci_recycle_empty_ed(fhci, ed);
235 	}
236 
237 	fhci->active_urbs = 0;
238 	return 0;
239 err:
240 	fhci_mem_free(fhci);
241 	return -ENOMEM;
242 }
243 
244 /* destroy the fhci_usb structure */
245 static void fhci_usb_free(void *lld)
246 {
247 	struct fhci_usb *usb = lld;
248 	struct fhci_hcd *fhci;
249 
250 	if (usb) {
251 		fhci = usb->fhci;
252 		fhci_config_transceiver(fhci, FHCI_PORT_POWER_OFF);
253 		fhci_ep0_free(usb);
254 		kfree(usb->actual_frame);
255 		kfree(usb);
256 	}
257 }
258 
259 /* initialize the USB */
260 static int fhci_usb_init(struct fhci_hcd *fhci)
261 {
262 	struct fhci_usb *usb = fhci->usb_lld;
263 
264 	memset_io(usb->fhci->pram, 0, FHCI_PRAM_SIZE);
265 
266 	usb->port_status = FHCI_PORT_DISABLED;
267 	usb->max_frame_usage = FRAME_TIME_USAGE;
268 	usb->sw_transaction_time = SW_FIX_TIME_BETWEEN_TRANSACTION;
269 
270 	usb->actual_frame = kzalloc(sizeof(*usb->actual_frame), GFP_KERNEL);
271 	if (!usb->actual_frame) {
272 		fhci_usb_free(usb);
273 		return -ENOMEM;
274 	}
275 
276 	INIT_LIST_HEAD(&usb->actual_frame->tds_list);
277 
278 	/* initializing registers on chip, clear frame number */
279 	out_be16(&fhci->pram->frame_num, 0);
280 
281 	/* clear rx state */
282 	out_be32(&fhci->pram->rx_state, 0);
283 
284 	/* set mask register */
285 	usb->saved_msk = (USB_E_TXB_MASK |
286 			  USB_E_TXE1_MASK |
287 			  USB_E_IDLE_MASK |
288 			  USB_E_RESET_MASK | USB_E_SFT_MASK | USB_E_MSF_MASK);
289 
290 	out_8(&usb->fhci->regs->usb_usmod, USB_MODE_HOST | USB_MODE_EN);
291 
292 	/* clearing the mask register */
293 	out_be16(&usb->fhci->regs->usb_usbmr, 0);
294 
295 	/* initialing the event register */
296 	out_be16(&usb->fhci->regs->usb_usber, 0xffff);
297 
298 	if (endpoint_zero_init(usb, DEFAULT_DATA_MEM, DEFAULT_RING_LEN) != 0) {
299 		fhci_usb_free(usb);
300 		return -EINVAL;
301 	}
302 
303 	return 0;
304 }
305 
306 /* initialize the fhci_usb struct and the corresponding data staruct */
307 static struct fhci_usb *fhci_create_lld(struct fhci_hcd *fhci)
308 {
309 	struct fhci_usb *usb;
310 
311 	/* allocate memory for SCC data structure */
312 	usb = kzalloc(sizeof(*usb), GFP_KERNEL);
313 	if (!usb) {
314 		fhci_err(fhci, "no memory for SCC data struct\n");
315 		return NULL;
316 	}
317 
318 	usb->fhci = fhci;
319 	usb->hc_list = fhci->hc_list;
320 	usb->vroot_hub = fhci->vroot_hub;
321 
322 	usb->transfer_confirm = fhci_transfer_confirm_callback;
323 
324 	return usb;
325 }
326 
327 static int fhci_start(struct usb_hcd *hcd)
328 {
329 	int ret;
330 	struct fhci_hcd *fhci = hcd_to_fhci(hcd);
331 
332 	ret = fhci_mem_init(fhci);
333 	if (ret) {
334 		fhci_err(fhci, "failed to allocate memory\n");
335 		goto err;
336 	}
337 
338 	fhci->usb_lld = fhci_create_lld(fhci);
339 	if (!fhci->usb_lld) {
340 		fhci_err(fhci, "low level driver config failed\n");
341 		ret = -ENOMEM;
342 		goto err;
343 	}
344 
345 	ret = fhci_usb_init(fhci);
346 	if (ret) {
347 		fhci_err(fhci, "low level driver initialize failed\n");
348 		goto err;
349 	}
350 
351 	spin_lock_init(&fhci->lock);
352 
353 	/* connect the virtual root hub */
354 	fhci->vroot_hub->dev_num = 1;	/* this field may be needed to fix */
355 	fhci->vroot_hub->hub.wHubStatus = 0;
356 	fhci->vroot_hub->hub.wHubChange = 0;
357 	fhci->vroot_hub->port.wPortStatus = 0;
358 	fhci->vroot_hub->port.wPortChange = 0;
359 
360 	hcd->state = HC_STATE_RUNNING;
361 
362 	/*
363 	 * From here on, hub_wq concurrently accesses the root
364 	 * hub; drivers will be talking to enumerated devices.
365 	 * (On restart paths, hub_wq already knows about the root
366 	 * hub and could find work as soon as we wrote FLAG_CF.)
367 	 *
368 	 * Before this point the HC was idle/ready.  After, hub_wq
369 	 * and device drivers may start it running.
370 	 */
371 	fhci_usb_enable(fhci);
372 	return 0;
373 err:
374 	fhci_mem_free(fhci);
375 	return ret;
376 }
377 
378 static void fhci_stop(struct usb_hcd *hcd)
379 {
380 	struct fhci_hcd *fhci = hcd_to_fhci(hcd);
381 
382 	fhci_usb_disable_interrupt(fhci->usb_lld);
383 	fhci_usb_disable(fhci);
384 
385 	fhci_usb_free(fhci->usb_lld);
386 	fhci->usb_lld = NULL;
387 	fhci_mem_free(fhci);
388 }
389 
390 static int fhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
391 			    gfp_t mem_flags)
392 {
393 	struct fhci_hcd *fhci = hcd_to_fhci(hcd);
394 	u32 pipe = urb->pipe;
395 	int ret;
396 	int i;
397 	int size = 0;
398 	struct urb_priv *urb_priv;
399 	unsigned long flags;
400 
401 	switch (usb_pipetype(pipe)) {
402 	case PIPE_CONTROL:
403 		/* 1 td fro setup,1 for ack */
404 		size = 2;
405 	case PIPE_BULK:
406 		/* one td for every 4096 bytes(can be up to 8k) */
407 		size += urb->transfer_buffer_length / 4096;
408 		/* ...add for any remaining bytes... */
409 		if ((urb->transfer_buffer_length % 4096) != 0)
410 			size++;
411 		/* ..and maybe a zero length packet to wrap it up */
412 		if (size == 0)
413 			size++;
414 		else if ((urb->transfer_flags & URB_ZERO_PACKET) != 0
415 			 && (urb->transfer_buffer_length
416 			     % usb_maxpacket(urb->dev, pipe,
417 					     usb_pipeout(pipe))) != 0)
418 			size++;
419 		break;
420 	case PIPE_ISOCHRONOUS:
421 		size = urb->number_of_packets;
422 		if (size <= 0)
423 			return -EINVAL;
424 		for (i = 0; i < urb->number_of_packets; i++) {
425 			urb->iso_frame_desc[i].actual_length = 0;
426 			urb->iso_frame_desc[i].status = (u32) (-EXDEV);
427 		}
428 		break;
429 	case PIPE_INTERRUPT:
430 		size = 1;
431 	}
432 
433 	/* allocate the private part of the URB */
434 	urb_priv = kzalloc(sizeof(*urb_priv), mem_flags);
435 	if (!urb_priv)
436 		return -ENOMEM;
437 
438 	/* allocate the private part of the URB */
439 	urb_priv->tds = kcalloc(size, sizeof(*urb_priv->tds), mem_flags);
440 	if (!urb_priv->tds) {
441 		kfree(urb_priv);
442 		return -ENOMEM;
443 	}
444 
445 	spin_lock_irqsave(&fhci->lock, flags);
446 
447 	ret = usb_hcd_link_urb_to_ep(hcd, urb);
448 	if (ret)
449 		goto err;
450 
451 	/* fill the private part of the URB */
452 	urb_priv->num_of_tds = size;
453 
454 	urb->status = -EINPROGRESS;
455 	urb->actual_length = 0;
456 	urb->error_count = 0;
457 	urb->hcpriv = urb_priv;
458 
459 	fhci_queue_urb(fhci, urb);
460 err:
461 	if (ret) {
462 		kfree(urb_priv->tds);
463 		kfree(urb_priv);
464 	}
465 	spin_unlock_irqrestore(&fhci->lock, flags);
466 	return ret;
467 }
468 
469 /* dequeue FHCI URB */
470 static int fhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
471 {
472 	struct fhci_hcd *fhci = hcd_to_fhci(hcd);
473 	struct fhci_usb *usb = fhci->usb_lld;
474 	int ret = -EINVAL;
475 	unsigned long flags;
476 
477 	if (!urb || !urb->dev || !urb->dev->bus)
478 		goto out;
479 
480 	spin_lock_irqsave(&fhci->lock, flags);
481 
482 	ret = usb_hcd_check_unlink_urb(hcd, urb, status);
483 	if (ret)
484 		goto out2;
485 
486 	if (usb->port_status != FHCI_PORT_DISABLED) {
487 		struct urb_priv *urb_priv;
488 
489 		/*
490 		 * flag the urb's data for deletion in some upcoming
491 		 * SF interrupt's delete list processing
492 		 */
493 		urb_priv = urb->hcpriv;
494 
495 		if (!urb_priv || (urb_priv->state == URB_DEL))
496 			goto out2;
497 
498 		urb_priv->state = URB_DEL;
499 
500 		/* already pending? */
501 		urb_priv->ed->state = FHCI_ED_URB_DEL;
502 	} else {
503 		fhci_urb_complete_free(fhci, urb);
504 	}
505 
506 out2:
507 	spin_unlock_irqrestore(&fhci->lock, flags);
508 out:
509 	return ret;
510 }
511 
512 static void fhci_endpoint_disable(struct usb_hcd *hcd,
513 				  struct usb_host_endpoint *ep)
514 {
515 	struct fhci_hcd *fhci;
516 	struct ed *ed;
517 	unsigned long flags;
518 
519 	fhci = hcd_to_fhci(hcd);
520 	spin_lock_irqsave(&fhci->lock, flags);
521 	ed = ep->hcpriv;
522 	if (ed) {
523 		while (ed->td_head != NULL) {
524 			struct td *td = fhci_remove_td_from_ed(ed);
525 			fhci_urb_complete_free(fhci, td->urb);
526 		}
527 		fhci_recycle_empty_ed(fhci, ed);
528 		ep->hcpriv = NULL;
529 	}
530 	spin_unlock_irqrestore(&fhci->lock, flags);
531 }
532 
533 static int fhci_get_frame_number(struct usb_hcd *hcd)
534 {
535 	struct fhci_hcd *fhci = hcd_to_fhci(hcd);
536 
537 	return get_frame_num(fhci);
538 }
539 
540 static const struct hc_driver fhci_driver = {
541 	.description = "fsl,usb-fhci",
542 	.product_desc = "FHCI HOST Controller",
543 	.hcd_priv_size = sizeof(struct fhci_hcd),
544 
545 	/* generic hardware linkage */
546 	.irq = fhci_irq,
547 	.flags = HCD_USB11 | HCD_MEMORY,
548 
549 	/* basic lifecycle operation */
550 	.start = fhci_start,
551 	.stop = fhci_stop,
552 
553 	/* managing i/o requests and associated device resources */
554 	.urb_enqueue = fhci_urb_enqueue,
555 	.urb_dequeue = fhci_urb_dequeue,
556 	.endpoint_disable = fhci_endpoint_disable,
557 
558 	/* scheduling support */
559 	.get_frame_number = fhci_get_frame_number,
560 
561 	/* root hub support */
562 	.hub_status_data = fhci_hub_status_data,
563 	.hub_control = fhci_hub_control,
564 };
565 
566 static int of_fhci_probe(struct platform_device *ofdev)
567 {
568 	struct device *dev = &ofdev->dev;
569 	struct device_node *node = dev->of_node;
570 	struct usb_hcd *hcd;
571 	struct fhci_hcd *fhci;
572 	struct resource usb_regs;
573 	unsigned long pram_addr;
574 	unsigned int usb_irq;
575 	const char *sprop;
576 	const u32 *iprop;
577 	int size;
578 	int ret;
579 	int i;
580 	int j;
581 
582 	if (usb_disabled())
583 		return -ENODEV;
584 
585 	sprop = of_get_property(node, "mode", NULL);
586 	if (sprop && strcmp(sprop, "host"))
587 		return -ENODEV;
588 
589 	hcd = usb_create_hcd(&fhci_driver, dev, dev_name(dev));
590 	if (!hcd) {
591 		dev_err(dev, "could not create hcd\n");
592 		return -ENOMEM;
593 	}
594 
595 	fhci = hcd_to_fhci(hcd);
596 	hcd->self.controller = dev;
597 	dev_set_drvdata(dev, hcd);
598 
599 	iprop = of_get_property(node, "hub-power-budget", &size);
600 	if (iprop && size == sizeof(*iprop))
601 		hcd->power_budget = *iprop;
602 
603 	/* FHCI registers. */
604 	ret = of_address_to_resource(node, 0, &usb_regs);
605 	if (ret) {
606 		dev_err(dev, "could not get regs\n");
607 		goto err_regs;
608 	}
609 
610 	hcd->regs = ioremap(usb_regs.start, resource_size(&usb_regs));
611 	if (!hcd->regs) {
612 		dev_err(dev, "could not ioremap regs\n");
613 		ret = -ENOMEM;
614 		goto err_regs;
615 	}
616 	fhci->regs = hcd->regs;
617 
618 	/* Parameter RAM. */
619 	iprop = of_get_property(node, "reg", &size);
620 	if (!iprop || size < sizeof(*iprop) * 4) {
621 		dev_err(dev, "can't get pram offset\n");
622 		ret = -EINVAL;
623 		goto err_pram;
624 	}
625 
626 	pram_addr = cpm_muram_alloc(FHCI_PRAM_SIZE, 64);
627 	if (IS_ERR_VALUE(pram_addr)) {
628 		dev_err(dev, "failed to allocate usb pram\n");
629 		ret = -ENOMEM;
630 		goto err_pram;
631 	}
632 
633 	qe_issue_cmd(QE_ASSIGN_PAGE_TO_DEVICE, QE_CR_SUBBLOCK_USB,
634 		     QE_CR_PROTOCOL_UNSPECIFIED, pram_addr);
635 	fhci->pram = cpm_muram_addr(pram_addr);
636 
637 	/* GPIOs and pins */
638 	for (i = 0; i < NUM_GPIOS; i++) {
639 		int gpio;
640 		enum of_gpio_flags flags;
641 
642 		gpio = of_get_gpio_flags(node, i, &flags);
643 		fhci->gpios[i] = gpio;
644 		fhci->alow_gpios[i] = flags & OF_GPIO_ACTIVE_LOW;
645 
646 		if (!gpio_is_valid(gpio)) {
647 			if (i < GPIO_SPEED) {
648 				dev_err(dev, "incorrect GPIO%d: %d\n",
649 					i, gpio);
650 				goto err_gpios;
651 			} else {
652 				dev_info(dev, "assuming board doesn't have "
653 					"%s gpio\n", i == GPIO_SPEED ?
654 					"speed" : "power");
655 				continue;
656 			}
657 		}
658 
659 		ret = gpio_request(gpio, dev_name(dev));
660 		if (ret) {
661 			dev_err(dev, "failed to request gpio %d", i);
662 			goto err_gpios;
663 		}
664 
665 		if (i >= GPIO_SPEED) {
666 			ret = gpio_direction_output(gpio, 0);
667 			if (ret) {
668 				dev_err(dev, "failed to set gpio %d as "
669 					"an output\n", i);
670 				i++;
671 				goto err_gpios;
672 			}
673 		}
674 	}
675 
676 	for (j = 0; j < NUM_PINS; j++) {
677 		fhci->pins[j] = qe_pin_request(node, j);
678 		if (IS_ERR(fhci->pins[j])) {
679 			ret = PTR_ERR(fhci->pins[j]);
680 			dev_err(dev, "can't get pin %d: %d\n", j, ret);
681 			goto err_pins;
682 		}
683 	}
684 
685 	/* Frame limit timer and its interrupt. */
686 	fhci->timer = gtm_get_timer16();
687 	if (IS_ERR(fhci->timer)) {
688 		ret = PTR_ERR(fhci->timer);
689 		dev_err(dev, "failed to request qe timer: %i", ret);
690 		goto err_get_timer;
691 	}
692 
693 	ret = request_irq(fhci->timer->irq, fhci_frame_limit_timer_irq,
694 			  0, "qe timer (usb)", hcd);
695 	if (ret) {
696 		dev_err(dev, "failed to request timer irq");
697 		goto err_timer_irq;
698 	}
699 
700 	/* USB Host interrupt. */
701 	usb_irq = irq_of_parse_and_map(node, 0);
702 	if (usb_irq == NO_IRQ) {
703 		dev_err(dev, "could not get usb irq\n");
704 		ret = -EINVAL;
705 		goto err_usb_irq;
706 	}
707 
708 	/* Clocks. */
709 	sprop = of_get_property(node, "fsl,fullspeed-clock", NULL);
710 	if (sprop) {
711 		fhci->fullspeed_clk = qe_clock_source(sprop);
712 		if (fhci->fullspeed_clk == QE_CLK_DUMMY) {
713 			dev_err(dev, "wrong fullspeed-clock\n");
714 			ret = -EINVAL;
715 			goto err_clocks;
716 		}
717 	}
718 
719 	sprop = of_get_property(node, "fsl,lowspeed-clock", NULL);
720 	if (sprop) {
721 		fhci->lowspeed_clk = qe_clock_source(sprop);
722 		if (fhci->lowspeed_clk == QE_CLK_DUMMY) {
723 			dev_err(dev, "wrong lowspeed-clock\n");
724 			ret = -EINVAL;
725 			goto err_clocks;
726 		}
727 	}
728 
729 	if (fhci->fullspeed_clk == QE_CLK_NONE &&
730 			fhci->lowspeed_clk == QE_CLK_NONE) {
731 		dev_err(dev, "no clocks specified\n");
732 		ret = -EINVAL;
733 		goto err_clocks;
734 	}
735 
736 	dev_info(dev, "at 0x%p, irq %d\n", hcd->regs, usb_irq);
737 
738 	fhci_config_transceiver(fhci, FHCI_PORT_POWER_OFF);
739 
740 	/* Start with full-speed, if possible. */
741 	if (fhci->fullspeed_clk != QE_CLK_NONE) {
742 		fhci_config_transceiver(fhci, FHCI_PORT_FULL);
743 		qe_usb_clock_set(fhci->fullspeed_clk, USB_CLOCK);
744 	} else {
745 		fhci_config_transceiver(fhci, FHCI_PORT_LOW);
746 		qe_usb_clock_set(fhci->lowspeed_clk, USB_CLOCK >> 3);
747 	}
748 
749 	/* Clear and disable any pending interrupts. */
750 	out_be16(&fhci->regs->usb_usber, 0xffff);
751 	out_be16(&fhci->regs->usb_usbmr, 0);
752 
753 	ret = usb_add_hcd(hcd, usb_irq, 0);
754 	if (ret < 0)
755 		goto err_add_hcd;
756 
757 	device_wakeup_enable(hcd->self.controller);
758 
759 	fhci_dfs_create(fhci);
760 
761 	return 0;
762 
763 err_add_hcd:
764 err_clocks:
765 	irq_dispose_mapping(usb_irq);
766 err_usb_irq:
767 	free_irq(fhci->timer->irq, hcd);
768 err_timer_irq:
769 	gtm_put_timer16(fhci->timer);
770 err_get_timer:
771 err_pins:
772 	while (--j >= 0)
773 		qe_pin_free(fhci->pins[j]);
774 err_gpios:
775 	while (--i >= 0) {
776 		if (gpio_is_valid(fhci->gpios[i]))
777 			gpio_free(fhci->gpios[i]);
778 	}
779 	cpm_muram_free(pram_addr);
780 err_pram:
781 	iounmap(hcd->regs);
782 err_regs:
783 	usb_put_hcd(hcd);
784 	return ret;
785 }
786 
787 static int fhci_remove(struct device *dev)
788 {
789 	struct usb_hcd *hcd = dev_get_drvdata(dev);
790 	struct fhci_hcd *fhci = hcd_to_fhci(hcd);
791 	int i;
792 	int j;
793 
794 	usb_remove_hcd(hcd);
795 	free_irq(fhci->timer->irq, hcd);
796 	gtm_put_timer16(fhci->timer);
797 	cpm_muram_free(cpm_muram_offset(fhci->pram));
798 	for (i = 0; i < NUM_GPIOS; i++) {
799 		if (!gpio_is_valid(fhci->gpios[i]))
800 			continue;
801 		gpio_free(fhci->gpios[i]);
802 	}
803 	for (j = 0; j < NUM_PINS; j++)
804 		qe_pin_free(fhci->pins[j]);
805 	fhci_dfs_destroy(fhci);
806 	usb_put_hcd(hcd);
807 	return 0;
808 }
809 
810 static int of_fhci_remove(struct platform_device *ofdev)
811 {
812 	return fhci_remove(&ofdev->dev);
813 }
814 
815 static const struct of_device_id of_fhci_match[] = {
816 	{ .compatible = "fsl,mpc8323-qe-usb", },
817 	{},
818 };
819 MODULE_DEVICE_TABLE(of, of_fhci_match);
820 
821 static struct platform_driver of_fhci_driver = {
822 	.driver = {
823 		.name = "fsl,usb-fhci",
824 		.of_match_table = of_fhci_match,
825 	},
826 	.probe		= of_fhci_probe,
827 	.remove		= of_fhci_remove,
828 };
829 
830 module_platform_driver(of_fhci_driver);
831 
832 MODULE_DESCRIPTION("USB Freescale Host Controller Interface Driver");
833 MODULE_AUTHOR("Shlomi Gridish <gridish@freescale.com>, "
834 	      "Jerry Huang <Chang-Ming.Huang@freescale.com>, "
835 	      "Anton Vorontsov <avorontsov@ru.mvista.com>");
836 MODULE_LICENSE("GPL");
837