drivers/usb/host/ohci-at91.c

   1 /*
   2  * OHCI HCD (Host Controller Driver) for USB.
   3  *
   4  *  Copyright (C) 2004 SAN People (Pty) Ltd.
   5  *  Copyright (C) 2005 Thibaut VARENE <varenet@parisc-linux.org>
   6  *
   7  * AT91 Bus Glue
   8  *
   9  * Based on fragments of 2.4 driver by Rick Bronson.
  10  * Based on ohci-omap.c
  11  *
  12  * This file is licenced under the GPL.
  13  */
  14
  15 #include <linux/clk.h>
  16 #include <linux/platform_device.h>
  17
  18 #include <mach/hardware.h>
  19 #include <asm/gpio.h>
  20
  21 #include <mach/board.h>
  22 #include <mach/cpu.h>
  23
  24 #ifndef CONFIG_ARCH_AT91
  25 #error "CONFIG_ARCH_AT91 must be defined."
  26 #endif
  27
  28 /* interface and function clocks; sometimes also an AHB clock */
  29 static struct clk *iclk, *fclk, *hclk;
  30 static int clocked;
  31
  32 extern int usb_disabled(void);
  33
  34 /*-------------------------------------------------------------------------*/
  35
  36 static void at91_start_clock(void)
  37 {
  38         clk_enable(hclk);
  39         clk_enable(iclk);
  40         clk_enable(fclk);
  41         clocked = 1;
  42 }
  43
  44 static void at91_stop_clock(void)
  45 {
  46         clk_disable(fclk);
  47         clk_disable(iclk);
  48         clk_disable(hclk);
  49         clocked = 0;
  50 }
  51
  52 static void at91_start_hc(struct platform_device *pdev)
  53 {
  54         struct usb_hcd *hcd = platform_get_drvdata(pdev);
  55         struct ohci_regs __iomem *regs = hcd->regs;
  56
  57         dev_dbg(&pdev->dev, "start\n");
  58
  59         /*
  60          * Start the USB clocks.
  61          */
  62         at91_start_clock();
  63
  64         /*
  65          * The USB host controller must remain in reset.
  66          */
  67         writel(0, &regs->control);
  68 }
  69
  70 static void at91_stop_hc(struct platform_device *pdev)
  71 {
  72         struct usb_hcd *hcd = platform_get_drvdata(pdev);
  73         struct ohci_regs __iomem *regs = hcd->regs;
  74
  75         dev_dbg(&pdev->dev, "stop\n");
  76
  77         /*
  78          * Put the USB host controller into reset.
  79          */
  80         writel(0, &regs->control);
  81
  82         /*
  83          * Stop the USB clocks.
  84          */
  85         at91_stop_clock();
  86 }
  87
  88
  89 /*-------------------------------------------------------------------------*/
  90
  91 static void usb_hcd_at91_remove (struct usb_hcd *, struct platform_device *);
  92
  93 /* configure so an HC device and id are always provided */
  94 /* always called with process context; sleeping is OK */
  95
  96
  97 /**
  98  * usb_hcd_at91_probe - initialize AT91-based HCDs
  99  * Context: !in_interrupt()
 100  *
 101  * Allocates basic resources for this USB host controller, and
 102  * then invokes the start() method for the HCD associated with it
 103  * through the hotplug entry's driver_data.
 104  */
 105 static int usb_hcd_at91_probe(const struct hc_driver *driver,
 106                         struct platform_device *pdev)
 107 {
 108         int retval;
 109         struct usb_hcd *hcd = NULL;
 110
 111         if (pdev->num_resources != 2) {
 112                 pr_debug("hcd probe: invalid num_resources");
 113                 return -ENODEV;
 114         }
 115
 116         if ((pdev->resource[0].flags != IORESOURCE_MEM)
 117                         || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
 118                 pr_debug("hcd probe: invalid resource type\n");
 119                 return -ENODEV;
 120         }
 121
 122         hcd = usb_create_hcd(driver, &pdev->dev, "at91");
 123         if (!hcd)
 124                 return -ENOMEM;
 125         hcd->rsrc_start = pdev->resource[0].start;
 126         hcd->rsrc_len = pdev->resource[0].end - pdev->resource[0].start + 1;
 127
 128         if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
 129                 pr_debug("request_mem_region failed\n");
 130                 retval = -EBUSY;
 131                 goto err1;
 132         }
 133
 134         hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
 135         if (!hcd->regs) {
 136                 pr_debug("ioremap failed\n");
 137                 retval = -EIO;
 138                 goto err2;
 139         }
 140
 141         iclk = clk_get(&pdev->dev, "ohci_clk");
 142         fclk = clk_get(&pdev->dev, "uhpck");
 143         hclk = clk_get(&pdev->dev, "hclk");
 144
 145         at91_start_hc(pdev);
 146         ohci_hcd_init(hcd_to_ohci(hcd));
 147
 148         retval = usb_add_hcd(hcd, pdev->resource[1].start, IRQF_SHARED);
 149         if (retval == 0)
 150                 return retval;
 151
 152         /* Error handling */
 153         at91_stop_hc(pdev);
 154
 155         clk_put(hclk);
 156         clk_put(fclk);
 157         clk_put(iclk);
 158
 159         iounmap(hcd->regs);
 160
 161  err2:
 162         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 163
 164  err1:
 165         usb_put_hcd(hcd);
 166         return retval;
 167 }
 168
 169
 170 /* may be called with controller, bus, and devices active */
 171
 172 /**
 173  * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs
 174  * @dev: USB Host Controller being removed
 175  * Context: !in_interrupt()
 176  *
 177  * Reverses the effect of usb_hcd_at91_probe(), first invoking
 178  * the HCD's stop() method.  It is always called from a thread
 179  * context, "rmmod" or something similar.
 180  *
 181  */
 182 static void usb_hcd_at91_remove(struct usb_hcd *hcd,
 183                                 struct platform_device *pdev)
 184 {
 185         usb_remove_hcd(hcd);
 186         at91_stop_hc(pdev);
 187         iounmap(hcd->regs);
 188         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 189         usb_put_hcd(hcd);
 190
 191         clk_put(hclk);
 192         clk_put(fclk);
 193         clk_put(iclk);
 194         fclk = iclk = hclk = NULL;
 195
 196         dev_set_drvdata(&pdev->dev, NULL);
 197 }
 198
 199 /*-------------------------------------------------------------------------*/
 200
 201 static int __devinit
 202 ohci_at91_start (struct usb_hcd *hcd)
 203 {
 204         struct at91_usbh_data   *board = hcd->self.controller->platform_data;
 205         struct ohci_hcd         *ohci = hcd_to_ohci (hcd);
 206         int                     ret;
 207
 208         if ((ret = ohci_init(ohci)) < 0)
 209                 return ret;
 210
 211         ohci->num_ports = board->ports;
 212
 213         if ((ret = ohci_run(ohci)) < 0) {
 214                 err("can't start %s", hcd->self.bus_name);
 215                 ohci_stop(hcd);
 216                 return ret;
 217         }
 218         return 0;
 219 }
 220
 221 /*-------------------------------------------------------------------------*/
 222
 223 static const struct hc_driver ohci_at91_hc_driver = {
 224         .description =          hcd_name,
 225         .product_desc =         "AT91 OHCI",
 226         .hcd_priv_size =        sizeof(struct ohci_hcd),
 227
 228         /*
 229          * generic hardware linkage
 230          */
 231         .irq =                  ohci_irq,
 232         .flags =                HCD_USB11 | HCD_MEMORY,
 233
 234         /*
 235          * basic lifecycle operations
 236          */
 237         .start =                ohci_at91_start,
 238         .stop =                 ohci_stop,
 239         .shutdown =             ohci_shutdown,
 240
 241         /*
 242          * managing i/o requests and associated device resources
 243          */
 244         .urb_enqueue =          ohci_urb_enqueue,
 245         .urb_dequeue =          ohci_urb_dequeue,
 246         .endpoint_disable =     ohci_endpoint_disable,
 247
 248         /*
 249          * scheduling support
 250          */
 251         .get_frame_number =     ohci_get_frame,
 252
 253         /*
 254          * root hub support
 255          */
 256         .hub_status_data =      ohci_hub_status_data,
 257         .hub_control =          ohci_hub_control,
 258 #ifdef CONFIG_PM
 259         .bus_suspend =          ohci_bus_suspend,
 260         .bus_resume =           ohci_bus_resume,
 261 #endif
 262         .start_port_reset =     ohci_start_port_reset,
 263 };
 264
 265 /*-------------------------------------------------------------------------*/
 266
 267 static int ohci_hcd_at91_drv_probe(struct platform_device *pdev)
 268 {
 269         struct at91_usbh_data   *pdata = pdev->dev.platform_data;
 270         int                     i;
 271
 272         if (pdata) {
 273                 /* REVISIT make the driver support per-port power switching,
 274                  * and also overcurrent detection.  Here we assume the ports
 275                  * are always powered while this driver is active, and use
 276                  * active-low power switches.
 277                  */
 278                 for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
 279                         if (pdata->vbus_pin[i] <= 0)
 280                                 continue;
 281                         gpio_request(pdata->vbus_pin[i], "ohci_vbus");
 282                         gpio_direction_output(pdata->vbus_pin[i], pdata->vbus_pin_inverted);
 283                 }
 284         }
 285
 286         device_init_wakeup(&pdev->dev, 1);
 287         return usb_hcd_at91_probe(&ohci_at91_hc_driver, pdev);
 288 }
 289
 290 static int ohci_hcd_at91_drv_remove(struct platform_device *pdev)
 291 {
 292         struct at91_usbh_data   *pdata = pdev->dev.platform_data;
 293         int                     i;
 294
 295         if (pdata) {
 296                 for (i = 0; i < ARRAY_SIZE(pdata->vbus_pin); i++) {
 297                         if (pdata->vbus_pin[i] <= 0)
 298                                 continue;
 299                         gpio_direction_output(pdata->vbus_pin[i], !pdata->vbus_pin_inverted);
 300                         gpio_free(pdata->vbus_pin[i]);
 301                 }
 302         }
 303
 304         device_init_wakeup(&pdev->dev, 0);
 305         usb_hcd_at91_remove(platform_get_drvdata(pdev), pdev);
 306         return 0;
 307 }
 308
 309 #ifdef CONFIG_PM
 310
 311 static int
 312 ohci_hcd_at91_drv_suspend(struct platform_device *pdev, pm_message_t mesg)
 313 {
 314         struct usb_hcd  *hcd = platform_get_drvdata(pdev);
 315         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
 316
 317         if (device_may_wakeup(&pdev->dev))
 318                 enable_irq_wake(hcd->irq);
 319
 320         /*
 321          * The integrated transceivers seem unable to notice disconnect,
 322          * reconnect, or wakeup without the 48 MHz clock active.  so for
 323          * correctness, always discard connection state (using reset).
 324          *
 325          * REVISIT: some boards will be able to turn VBUS off...
 326          */
 327         if (at91_suspend_entering_slow_clock()) {
 328                 ohci_usb_reset (ohci);
 329                 /* flush the writes */
 330                 (void) ohci_readl (ohci, &ohci->regs->control);
 331                 at91_stop_clock();
 332         }
 333
 334         return 0;
 335 }
 336
 337 static int ohci_hcd_at91_drv_resume(struct platform_device *pdev)
 338 {
 339         struct usb_hcd  *hcd = platform_get_drvdata(pdev);
 340
 341         if (device_may_wakeup(&pdev->dev))
 342                 disable_irq_wake(hcd->irq);
 343
 344         if (!clocked)
 345                 at91_start_clock();
 346
 347         ohci_finish_controller_resume(hcd);
 348         return 0;
 349 }
 350 #else
 351 #define ohci_hcd_at91_drv_suspend NULL
 352 #define ohci_hcd_at91_drv_resume  NULL
 353 #endif
 354
 355 MODULE_ALIAS("platform:at91_ohci");
 356
 357 static struct platform_driver ohci_hcd_at91_driver = {
 358         .probe          = ohci_hcd_at91_drv_probe,
 359         .remove         = ohci_hcd_at91_drv_remove,
 360         .shutdown       = usb_hcd_platform_shutdown,
 361         .suspend        = ohci_hcd_at91_drv_suspend,
 362         .resume         = ohci_hcd_at91_drv_resume,
 363         .driver         = {
 364                 .name   = "at91_ohci",
 365                 .owner  = THIS_MODULE,
 366         },
 367 };