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/mach-types.h>
24 #include <asm/hardware/clock.h>
25 #include <asm/arch/usb-control.h>
27 #define valid_port(idx) ((idx) == 1 || (idx) == 2)
29 /* clock device associated with the hcd */
31 static struct clk *clk;
33 /* forward definitions */
35 static void s3c2410_hcd_oc(struct s3c2410_hcd_info *info, int port_oc);
37 /* conversion functions */
39 struct s3c2410_hcd_info *to_s3c2410_info(struct usb_hcd *hcd)
41 return hcd->self.controller->platform_data;
44 static void s3c2410_start_hc(struct platform_device *dev, struct usb_hcd *hcd)
46 struct s3c2410_hcd_info *info = dev->dev.platform_data;
48 dev_dbg(&dev->dev, "s3c2410_start_hc:\n");
53 info->report_oc = s3c2410_hcd_oc;
55 if (info->enable_oc != NULL) {
56 (info->enable_oc)(info, 1);
61 static void s3c2410_stop_hc(struct platform_device *dev)
63 struct s3c2410_hcd_info *info = dev->dev.platform_data;
65 dev_dbg(&dev->dev, "s3c2410_stop_hc:\n");
68 info->report_oc = NULL;
71 if (info->enable_oc != NULL) {
72 (info->enable_oc)(info, 0);
79 /* ohci_s3c2410_hub_status_data
81 * update the status data from the hub with anything that
82 * has been detected by our system
86 ohci_s3c2410_hub_status_data (struct usb_hcd *hcd, char *buf)
88 struct s3c2410_hcd_info *info = to_s3c2410_info(hcd);
89 struct s3c2410_hcd_port *port;
93 orig = ohci_hub_status_data (hcd, buf);
98 port = &info->port[0];
100 /* mark any changed port as changed */
102 for (portno = 0; portno < 2; port++, portno++) {
103 if (port->oc_changed == 1 &&
104 port->flags & S3C_HCDFLG_USED) {
105 dev_dbg(hcd->self.controller,
106 "oc change on port %d\n", portno);
111 buf[0] |= 1<<(portno+1);
118 /* s3c2410_usb_set_power
120 * configure the power on a port, by calling the platform device
121 * routine registered with the platform device
124 static void s3c2410_usb_set_power(struct s3c2410_hcd_info *info,
130 if (info->power_control != NULL) {
131 info->port[port-1].power = to;
132 (info->power_control)(port, to);
136 /* ohci_s3c2410_hub_control
138 * look at control requests to the hub, and see if we need
139 * to take any action or over-ride the results from the
143 static int ohci_s3c2410_hub_control (
151 struct s3c2410_hcd_info *info = to_s3c2410_info(hcd);
152 struct usb_hub_descriptor *desc;
154 u32 *data = (u32 *)buf;
156 dev_dbg(hcd->self.controller,
157 "s3c2410_hub_control(%p,0x%04x,0x%04x,0x%04x,%p,%04x)\n",
158 hcd, typeReq, wValue, wIndex, buf, wLength);
160 /* if we are only an humble host without any special capabilites
161 * process the request straight away and exit */
164 ret = ohci_hub_control(hcd, typeReq, wValue,
165 wIndex, buf, wLength);
169 /* check the request to see if it needs handling */
173 if (wValue == USB_PORT_FEAT_POWER) {
174 dev_dbg(hcd->self.controller, "SetPortFeat: POWER\n");
175 s3c2410_usb_set_power(info, wIndex, 1);
180 case ClearPortFeature:
182 case USB_PORT_FEAT_C_OVER_CURRENT:
183 dev_dbg(hcd->self.controller,
184 "ClearPortFeature: C_OVER_CURRENT\n");
186 if (valid_port(wIndex)) {
187 info->port[wIndex-1].oc_changed = 0;
188 info->port[wIndex-1].oc_status = 0;
193 case USB_PORT_FEAT_OVER_CURRENT:
194 dev_dbg(hcd->self.controller,
195 "ClearPortFeature: OVER_CURRENT\n");
197 if (valid_port(wIndex)) {
198 info->port[wIndex-1].oc_status = 0;
203 case USB_PORT_FEAT_POWER:
204 dev_dbg(hcd->self.controller,
205 "ClearPortFeature: POWER\n");
207 if (valid_port(wIndex)) {
208 s3c2410_usb_set_power(info, wIndex, 0);
215 ret = ohci_hub_control(hcd, typeReq, wValue, wIndex, buf, wLength);
220 case GetHubDescriptor:
222 /* update the hub's descriptor */
224 desc = (struct usb_hub_descriptor *)buf;
226 if (info->power_control == NULL)
229 dev_dbg(hcd->self.controller, "wHubCharacteristics 0x%04x\n",
230 desc->wHubCharacteristics);
232 /* remove the old configurations for power-switching, and
233 * over-current protection, and insert our new configuration
236 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_LPSM);
237 desc->wHubCharacteristics |= cpu_to_le16(0x0001);
239 if (info->enable_oc) {
240 desc->wHubCharacteristics &= ~cpu_to_le16(HUB_CHAR_OCPM);
241 desc->wHubCharacteristics |= cpu_to_le16(0x0008|0x0001);
244 dev_dbg(hcd->self.controller, "wHubCharacteristics after 0x%04x\n",
245 desc->wHubCharacteristics);
250 /* check port status */
252 dev_dbg(hcd->self.controller, "GetPortStatus(%d)\n", wIndex);
254 if (valid_port(wIndex)) {
255 if (info->port[wIndex-1].oc_changed) {
256 *data |= cpu_to_le32(RH_PS_OCIC);
259 if (info->port[wIndex-1].oc_status) {
260 *data |= cpu_to_le32(RH_PS_POCI);
271 * handle an over-current report
274 static void s3c2410_hcd_oc(struct s3c2410_hcd_info *info, int port_oc)
276 struct s3c2410_hcd_port *port;
284 port = &info->port[0];
287 local_irq_save(flags);
289 for (portno = 0; portno < 2; port++, portno++) {
290 if (port_oc & (1<<portno) &&
291 port->flags & S3C_HCDFLG_USED) {
293 port->oc_changed = 1;
295 /* ok, once over-current is detected,
296 the port needs to be powered down */
297 s3c2410_usb_set_power(info, portno+1, 0);
301 local_irq_restore(flags);
304 /* may be called without controller electrically present */
305 /* may be called with controller, bus, and devices active */
308 * usb_hcd_s3c2410_remove - shutdown processing for HCD
309 * @dev: USB Host Controller being removed
310 * Context: !in_interrupt()
312 * Reverses the effect of usb_hcd_3c2410_probe(), first invoking
313 * the HCD's stop() method. It is always called from a thread
314 * context, normally "rmmod", "apmd", or something similar.
318 void usb_hcd_s3c2410_remove (struct usb_hcd *hcd, struct platform_device *dev)
321 s3c2410_stop_hc(dev);
323 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
328 * usb_hcd_s3c2410_probe - initialize S3C2410-based HCDs
329 * Context: !in_interrupt()
331 * Allocates basic resources for this USB host controller, and
332 * then invokes the start() method for the HCD associated with it
333 * through the hotplug entry's driver_data.
336 int usb_hcd_s3c2410_probe (const struct hc_driver *driver,
337 struct platform_device *dev)
339 struct usb_hcd *hcd = NULL;
342 s3c2410_usb_set_power(dev->dev.platform_data, 0, 1);
343 s3c2410_usb_set_power(dev->dev.platform_data, 1, 1);
345 hcd = usb_create_hcd(driver, &dev->dev, "s3c24xx");
349 hcd->rsrc_start = dev->resource[0].start;
350 hcd->rsrc_len = dev->resource[0].end - dev->resource[0].start + 1;
352 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
353 dev_err(&dev->dev, "request_mem_region failed");
358 clk = clk_get(NULL, "usb-host");
360 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);
390 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
397 /*-------------------------------------------------------------------------*/
400 ohci_s3c2410_start (struct usb_hcd *hcd)
402 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
405 if ((ret = ohci_init(ohci)) < 0)
408 if ((ret = ohci_run (ohci)) < 0) {
409 err ("can't start %s", hcd->self.bus_name);
418 static const struct hc_driver ohci_s3c2410_hc_driver = {
419 .description = hcd_name,
420 .product_desc = "S3C24XX OHCI",
421 .hcd_priv_size = sizeof(struct ohci_hcd),
424 * generic hardware linkage
427 .flags = HCD_USB11 | HCD_MEMORY,
430 * basic lifecycle operations
432 .start = ohci_s3c2410_start,
436 * managing i/o requests and associated device resources
438 .urb_enqueue = ohci_urb_enqueue,
439 .urb_dequeue = ohci_urb_dequeue,
440 .endpoint_disable = ohci_endpoint_disable,
445 .get_frame_number = ohci_get_frame,
450 .hub_status_data = ohci_s3c2410_hub_status_data,
451 .hub_control = ohci_s3c2410_hub_control,
453 #if defined(CONFIG_USB_SUSPEND) && 0
454 .hub_suspend = ohci_hub_suspend,
455 .hub_resume = ohci_hub_resume,
461 static int ohci_hcd_s3c2410_drv_probe(struct device *dev)
463 struct platform_device *pdev = to_platform_device(dev);
464 return usb_hcd_s3c2410_probe(&ohci_s3c2410_hc_driver, pdev);
467 static int ohci_hcd_s3c2410_drv_remove(struct device *dev)
469 struct platform_device *pdev = to_platform_device(dev);
470 struct usb_hcd *hcd = dev_get_drvdata(dev);
472 usb_hcd_s3c2410_remove(hcd, pdev);
476 static struct device_driver ohci_hcd_s3c2410_driver = {
477 .name = "s3c2410-ohci",
478 .bus = &platform_bus_type,
479 .probe = ohci_hcd_s3c2410_drv_probe,
480 .remove = ohci_hcd_s3c2410_drv_remove,
481 /*.suspend = ohci_hcd_s3c2410_drv_suspend, */
482 /*.resume = ohci_hcd_s3c2410_drv_resume, */
485 static int __init ohci_hcd_s3c2410_init (void)
487 return driver_register(&ohci_hcd_s3c2410_driver);
490 static void __exit ohci_hcd_s3c2410_cleanup (void)
492 driver_unregister(&ohci_hcd_s3c2410_driver);
495 module_init (ohci_hcd_s3c2410_init);
496 module_exit (ohci_hcd_s3c2410_cleanup);