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 <linux/platform_device.h>
23 #include <linux/clk.h>
25 #include <asm/hardware.h>
26 #include <asm/arch/usb-control.h>
28 #define valid_port(idx) ((idx) == 1 || (idx) == 2)
30 /* clock device associated with the hcd */
32 static struct clk *clk;
34 /* forward definitions */
36 static void s3c2410_hcd_oc(struct s3c2410_hcd_info *info, int port_oc);
38 /* conversion functions */
40 struct s3c2410_hcd_info *to_s3c2410_info(struct usb_hcd *hcd)
42 return hcd->self.controller->platform_data;
45 static void s3c2410_start_hc(struct platform_device *dev, struct usb_hcd *hcd)
47 struct s3c2410_hcd_info *info = dev->dev.platform_data;
49 dev_dbg(&dev->dev, "s3c2410_start_hc:\n");
54 info->report_oc = s3c2410_hcd_oc;
56 if (info->enable_oc != NULL) {
57 (info->enable_oc)(info, 1);
62 static void s3c2410_stop_hc(struct platform_device *dev)
64 struct s3c2410_hcd_info *info = dev->dev.platform_data;
66 dev_dbg(&dev->dev, "s3c2410_stop_hc:\n");
69 info->report_oc = NULL;
72 if (info->enable_oc != NULL) {
73 (info->enable_oc)(info, 0);
80 /* ohci_s3c2410_hub_status_data
82 * update the status data from the hub with anything that
83 * has been detected by our system
87 ohci_s3c2410_hub_status_data (struct usb_hcd *hcd, char *buf)
89 struct s3c2410_hcd_info *info = to_s3c2410_info(hcd);
90 struct s3c2410_hcd_port *port;
94 orig = ohci_hub_status_data (hcd, buf);
99 port = &info->port[0];
101 /* mark any changed port as changed */
103 for (portno = 0; portno < 2; port++, portno++) {
104 if (port->oc_changed == 1 &&
105 port->flags & S3C_HCDFLG_USED) {
106 dev_dbg(hcd->self.controller,
107 "oc change on port %d\n", portno);
112 buf[0] |= 1<<(portno+1);
119 /* s3c2410_usb_set_power
121 * configure the power on a port, by calling the platform device
122 * routine registered with the platform device
125 static void s3c2410_usb_set_power(struct s3c2410_hcd_info *info,
131 if (info->power_control != NULL) {
132 info->port[port-1].power = to;
133 (info->power_control)(port-1, to);
137 /* ohci_s3c2410_hub_control
139 * look at control requests to the hub, and see if we need
140 * to take any action or over-ride the results from the
144 static int ohci_s3c2410_hub_control (
152 struct s3c2410_hcd_info *info = to_s3c2410_info(hcd);
153 struct usb_hub_descriptor *desc;
155 u32 *data = (u32 *)buf;
157 dev_dbg(hcd->self.controller,
158 "s3c2410_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
159 hcd, typeReq, wValue, wIndex, buf, wLength);
161 /* if we are only an humble host without any special capabilites
162 * process the request straight away and exit */
165 ret = ohci_hub_control(hcd, typeReq, wValue,
166 wIndex, buf, wLength);
170 /* check the request to see if it needs handling */
174 if (wValue == USB_PORT_FEAT_POWER) {
175 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
176 s3c2410_usb_set_power(info, wIndex, 1);
181 case ClearPortFeature:
183 case USB_PORT_FEAT_C_OVER_CURRENT:
184 dev_dbg(hcd->self.controller,
185 "ClearPortFeature: C_OVER_CURRENT\n");
187 if (valid_port(wIndex)) {
188 info->port[wIndex-1].oc_changed = 0;
189 info->port[wIndex-1].oc_status = 0;
194 case USB_PORT_FEAT_OVER_CURRENT:
195 dev_dbg(hcd->self.controller,
196 "ClearPortFeature: OVER_CURRENT\n");
198 if (valid_port(wIndex)) {
199 info->port[wIndex-1].oc_status = 0;
204 case USB_PORT_FEAT_POWER:
205 dev_dbg(hcd->self.controller,
206 "ClearPortFeature: POWER\n");
208 if (valid_port(wIndex)) {
209 s3c2410_usb_set_power(info, wIndex, 0);
216 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
221 case GetHubDescriptor:
223 /* update the hub's descriptor */
225 desc = (struct usb_hub_descriptor *)buf;
227 if (info->power_control == NULL)
230 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
231 desc->wHubCharacteristics);
233 /* remove the old configurations for power-switching, and
234 * over-current protection, and insert our new configuration
237 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
238 desc->wHubCharacteristics |= cpu_to_le16(0x0001);
240 if (info->enable_oc) {
241 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
242 desc->wHubCharacteristics |= cpu_to_le16(0x0008|0x0001);
245 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
246 desc->wHubCharacteristics);
251 /* check port status */
253 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
255 if (valid_port(wIndex)) {
256 if (info->port[wIndex-1].oc_changed) {
257 *data |= cpu_to_le32(RH_PS_OCIC);
260 if (info->port[wIndex-1].oc_status) {
261 *data |= cpu_to_le32(RH_PS_POCI);
272 * handle an over-current report
275 static void s3c2410_hcd_oc(struct s3c2410_hcd_info *info, int port_oc)
277 struct s3c2410_hcd_port *port;
285 port = &info->port[0];
288 local_irq_save(flags);
290 for (portno = 0; portno < 2; port++, portno++) {
291 if (port_oc & (1<<portno) &&
292 port->flags & S3C_HCDFLG_USED) {
294 port->oc_changed = 1;
296 /* ok, once over-current is detected,
297 the port needs to be powered down */
298 s3c2410_usb_set_power(info, portno+1, 0);
302 local_irq_restore(flags);
305 /* may be called without controller electrically present */
306 /* may be called with controller, bus, and devices active */
309 * usb_hcd_s3c2410_remove - shutdown processing for HCD
310 * @dev: USB Host Controller being removed
311 * Context: !in_interrupt()
313 * Reverses the effect of usb_hcd_3c2410_probe(), first invoking
314 * the HCD's stop() method. It is always called from a thread
315 * context, normally "rmmod", "apmd", or something similar.
319 void usb_hcd_s3c2410_remove (struct usb_hcd *hcd, struct platform_device *dev)
322 s3c2410_stop_hc(dev);
324 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
329 * usb_hcd_s3c2410_probe - initialize S3C2410-based HCDs
330 * Context: !in_interrupt()
332 * Allocates basic resources for this USB host controller, and
333 * then invokes the start() method for the HCD associated with it
334 * through the hotplug entry's driver_data.
337 int usb_hcd_s3c2410_probe (const struct hc_driver *driver,
338 struct platform_device *dev)
340 struct usb_hcd *hcd = NULL;
343 s3c2410_usb_set_power(dev->dev.platform_data, 1, 1);
344 s3c2410_usb_set_power(dev->dev.platform_data, 2, 1);
346 hcd = usb_create_hcd(driver, &dev->dev, "s3c24xx");
350 hcd->rsrc_start = dev->resource[0].start;
351 hcd->rsrc_len = dev->resource[0].end - dev->resource[0].start + 1;
353 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
354 dev_err(&dev->dev, "request_mem_region failed");
359 clk = clk_get(NULL, "usb-host");
361 dev_err(&dev->dev, "cannot get usb-host clock\n");
366 s3c2410_start_hc(dev, hcd);
368 hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
370 dev_err(&dev->dev, "ioremap failed\n");
375 ohci_hcd_init(hcd_to_ohci(hcd));
377 retval = usb_add_hcd(hcd, dev->resource[1].start, SA_INTERRUPT);
384 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 .bus_suspend = ohci_bus_suspend,
453 .bus_resume = ohci_bus_resume,
455 .start_port_reset = ohci_start_port_reset,
460 static int ohci_hcd_s3c2410_drv_probe(struct platform_device *pdev)
462 return usb_hcd_s3c2410_probe(&ohci_s3c2410_hc_driver, pdev);
465 static int ohci_hcd_s3c2410_drv_remove(struct platform_device *pdev)
467 struct usb_hcd *hcd = platform_get_drvdata(pdev);
469 usb_hcd_s3c2410_remove(hcd, pdev);
473 static struct platform_driver ohci_hcd_s3c2410_driver = {
474 .probe = ohci_hcd_s3c2410_drv_probe,
475 .remove = ohci_hcd_s3c2410_drv_remove,
476 /*.suspend = ohci_hcd_s3c2410_drv_suspend, */
477 /*.resume = ohci_hcd_s3c2410_drv_resume, */
479 .owner = THIS_MODULE,
480 .name = "s3c2410-ohci",
484 static int __init ohci_hcd_s3c2410_init (void)
486 return platform_driver_register(&ohci_hcd_s3c2410_driver);
489 static void __exit ohci_hcd_s3c2410_cleanup (void)
491 platform_driver_unregister(&ohci_hcd_s3c2410_driver);
494 module_init (ohci_hcd_s3c2410_init);
495 module_exit (ohci_hcd_s3c2410_cleanup);