2 * OHCI HCD (Host Controller Driver) for USB.
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
8 * USB Bus Glue for Samsung S3C2410
10 * Written by Christopher Hoover <ch@hpl.hp.com>
11 * Based on fragments of previous driver by Rusell King et al.
13 * Modified for S3C2410 from ohci-sa1111.c, ohci-omap.c and ohci-lh7a40.c
14 * by Ben Dooks, <ben@simtec.co.uk>
15 * Copyright (C) 2004 Simtec Electronics
17 * Thanks to basprog@mail.ru for updates to newer kernels
19 * This file is licenced under the GPL.
22 #include <asm/hardware.h>
23 #include <asm/hardware/clock.h>
24 #include <asm/arch/usb-control.h>
26 #define valid_port(idx) ((idx) == 1 || (idx) == 2)
28 /* clock device associated with the hcd */
30 static struct clk *clk;
32 /* forward definitions */
34 static void s3c2410_hcd_oc(struct s3c2410_hcd_info *info, int port_oc);
36 /* conversion functions */
38 struct s3c2410_hcd_info *to_s3c2410_info(struct usb_hcd *hcd)
40 return hcd->self.controller->platform_data;
43 static void s3c2410_start_hc(struct platform_device *dev, struct usb_hcd *hcd)
45 struct s3c2410_hcd_info *info = dev->dev.platform_data;
47 dev_dbg(&dev->dev, "s3c2410_start_hc:\n");
52 info->report_oc = s3c2410_hcd_oc;
54 if (info->enable_oc != NULL) {
55 (info->enable_oc)(info, 1);
60 static void s3c2410_stop_hc(struct platform_device *dev)
62 struct s3c2410_hcd_info *info = dev->dev.platform_data;
64 dev_dbg(&dev->dev, "s3c2410_stop_hc:\n");
67 info->report_oc = NULL;
70 if (info->enable_oc != NULL) {
71 (info->enable_oc)(info, 0);
78 /* ohci_s3c2410_hub_status_data
80 * update the status data from the hub with anything that
81 * has been detected by our system
85 ohci_s3c2410_hub_status_data (struct usb_hcd *hcd, char *buf)
87 struct s3c2410_hcd_info *info = to_s3c2410_info(hcd);
88 struct s3c2410_hcd_port *port;
92 orig = ohci_hub_status_data (hcd, buf);
97 port = &info->port[0];
99 /* mark any changed port as changed */
101 for (portno = 0; portno < 2; port++, portno++) {
102 if (port->oc_changed == 1 &&
103 port->flags & S3C_HCDFLG_USED) {
104 dev_dbg(hcd->self.controller,
105 "oc change on port %d\n", portno);
110 buf[0] |= 1<<(portno+1);
117 /* s3c2410_usb_set_power
119 * configure the power on a port, by calling the platform device
120 * routine registered with the platform device
123 static void s3c2410_usb_set_power(struct s3c2410_hcd_info *info,
129 if (info->power_control != NULL) {
130 info->port[port-1].power = to;
131 (info->power_control)(port-1, to);
135 /* ohci_s3c2410_hub_control
137 * look at control requests to the hub, and see if we need
138 * to take any action or over-ride the results from the
142 static int ohci_s3c2410_hub_control (
150 struct s3c2410_hcd_info *info = to_s3c2410_info(hcd);
151 struct usb_hub_descriptor *desc;
153 u32 *data = (u32 *)buf;
155 dev_dbg(hcd->self.controller,
156 "s3c2410_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
157 hcd, typeReq, wValue, wIndex, buf, wLength);
159 /* if we are only an humble host without any special capabilites
160 * process the request straight away and exit */
163 ret = ohci_hub_control(hcd, typeReq, wValue,
164 wIndex, buf, wLength);
168 /* check the request to see if it needs handling */
172 if (wValue == USB_PORT_FEAT_POWER) {
173 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
174 s3c2410_usb_set_power(info, wIndex, 1);
179 case ClearPortFeature:
181 case USB_PORT_FEAT_C_OVER_CURRENT:
182 dev_dbg(hcd->self.controller,
183 "ClearPortFeature: C_OVER_CURRENT\n");
185 if (valid_port(wIndex)) {
186 info->port[wIndex-1].oc_changed = 0;
187 info->port[wIndex-1].oc_status = 0;
192 case USB_PORT_FEAT_OVER_CURRENT:
193 dev_dbg(hcd->self.controller,
194 "ClearPortFeature: OVER_CURRENT\n");
196 if (valid_port(wIndex)) {
197 info->port[wIndex-1].oc_status = 0;
202 case USB_PORT_FEAT_POWER:
203 dev_dbg(hcd->self.controller,
204 "ClearPortFeature: POWER\n");
206 if (valid_port(wIndex)) {
207 s3c2410_usb_set_power(info, wIndex, 0);
214 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
219 case GetHubDescriptor:
221 /* update the hub's descriptor */
223 desc = (struct usb_hub_descriptor *)buf;
225 if (info->power_control == NULL)
228 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
229 desc->wHubCharacteristics);
231 /* remove the old configurations for power-switching, and
232 * over-current protection, and insert our new configuration
235 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
236 desc->wHubCharacteristics |= cpu_to_le16(0x0001);
238 if (info->enable_oc) {
239 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
240 desc->wHubCharacteristics |= cpu_to_le16(0x0008|0x0001);
243 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
244 desc->wHubCharacteristics);
249 /* check port status */
251 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
253 if (valid_port(wIndex)) {
254 if (info->port[wIndex-1].oc_changed) {
255 *data |= cpu_to_le32(RH_PS_OCIC);
258 if (info->port[wIndex-1].oc_status) {
259 *data |= cpu_to_le32(RH_PS_POCI);
270 * handle an over-current report
273 static void s3c2410_hcd_oc(struct s3c2410_hcd_info *info, int port_oc)
275 struct s3c2410_hcd_port *port;
283 port = &info->port[0];
286 local_irq_save(flags);
288 for (portno = 0; portno < 2; port++, portno++) {
289 if (port_oc & (1<<portno) &&
290 port->flags & S3C_HCDFLG_USED) {
292 port->oc_changed = 1;
294 /* ok, once over-current is detected,
295 the port needs to be powered down */
296 s3c2410_usb_set_power(info, portno+1, 0);
300 local_irq_restore(flags);
303 /* may be called without controller electrically present */
304 /* may be called with controller, bus, and devices active */
307 * usb_hcd_s3c2410_remove - shutdown processing for HCD
308 * @dev: USB Host Controller being removed
309 * Context: !in_interrupt()
311 * Reverses the effect of usb_hcd_3c2410_probe(), first invoking
312 * the HCD's stop() method. It is always called from a thread
313 * context, normally "rmmod", "apmd", or something similar.
317 void usb_hcd_s3c2410_remove (struct usb_hcd *hcd, struct platform_device *dev)
320 s3c2410_stop_hc(dev);
322 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
327 * usb_hcd_s3c2410_probe - initialize S3C2410-based HCDs
328 * Context: !in_interrupt()
330 * Allocates basic resources for this USB host controller, and
331 * then invokes the start() method for the HCD associated with it
332 * through the hotplug entry's driver_data.
335 int usb_hcd_s3c2410_probe (const struct hc_driver *driver,
336 struct platform_device *dev)
338 struct usb_hcd *hcd = NULL;
341 s3c2410_usb_set_power(dev->dev.platform_data, 1, 1);
342 s3c2410_usb_set_power(dev->dev.platform_data, 2, 1);
344 hcd = usb_create_hcd(driver, &dev->dev, "s3c24xx");
348 hcd->rsrc_start = dev->resource[0].start;
349 hcd->rsrc_len = dev->resource[0].end - dev->resource[0].start + 1;
351 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
352 dev_err(&dev->dev, "request_mem_region failed");
357 clk = clk_get(NULL, "usb-host");
359 dev_err(&dev->dev, "cannot get usb-host clock\n");
365 s3c2410_start_hc(dev, hcd);
367 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
369 dev_err(&dev->dev, "ioremap failed\n");
374 ohci_hcd_init(hcd_to_ohci(hcd));
376 retval = usb_add_hcd(hcd, dev->resource[1].start, SA_INTERRUPT);
383 s3c2410_stop_hc(dev);
389 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
396 /*-------------------------------------------------------------------------*/
399 ohci_s3c2410_start (struct usb_hcd *hcd)
401 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
404 if ((ret = ohci_init(ohci)) < 0)
407 if ((ret = ohci_run (ohci)) < 0) {
408 err ("can't start %s", hcd->self.bus_name);
417 static const struct hc_driver ohci_s3c2410_hc_driver = {
418 .description = hcd_name,
419 .product_desc = "S3C24XX OHCI",
420 .hcd_priv_size = sizeof(struct ohci_hcd),
423 * generic hardware linkage
426 .flags = HCD_USB11 | HCD_MEMORY,
429 * basic lifecycle operations
431 .start = ohci_s3c2410_start,
435 * managing i/o requests and associated device resources
437 .urb_enqueue = ohci_urb_enqueue,
438 .urb_dequeue = ohci_urb_dequeue,
439 .endpoint_disable = ohci_endpoint_disable,
444 .get_frame_number = ohci_get_frame,
449 .hub_status_data = ohci_s3c2410_hub_status_data,
450 .hub_control = ohci_s3c2410_hub_control,
452 #if defined(CONFIG_USB_SUSPEND) && 0
453 .hub_suspend = ohci_hub_suspend,
454 .hub_resume = ohci_hub_resume,
460 static int ohci_hcd_s3c2410_drv_probe(struct device *dev)
462 struct platform_device *pdev = to_platform_device(dev);
463 return usb_hcd_s3c2410_probe(&ohci_s3c2410_hc_driver, pdev);
466 static int ohci_hcd_s3c2410_drv_remove(struct device *dev)
468 struct platform_device *pdev = to_platform_device(dev);
469 struct usb_hcd *hcd = dev_get_drvdata(dev);
471 usb_hcd_s3c2410_remove(hcd, pdev);
475 static struct device_driver ohci_hcd_s3c2410_driver = {
476 .name = "s3c2410-ohci",
477 .bus = &platform_bus_type,
478 .probe = ohci_hcd_s3c2410_drv_probe,
479 .remove = ohci_hcd_s3c2410_drv_remove,
480 /*.suspend = ohci_hcd_s3c2410_drv_suspend, */
481 /*.resume = ohci_hcd_s3c2410_drv_resume, */
484 static int __init ohci_hcd_s3c2410_init (void)
486 return driver_register(&ohci_hcd_s3c2410_driver);
489 static void __exit ohci_hcd_s3c2410_cleanup (void)
491 driver_unregister(&ohci_hcd_s3c2410_driver);
494 module_init (ohci_hcd_s3c2410_init);
495 module_exit (ohci_hcd_s3c2410_cleanup);