drivers/usb/host/ohci-tmio.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * OHCI HCD(Host Controller Driver) for USB.
   4  *
   5  *(C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
   6  *(C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
   7  *(C) Copyright 2002 Hewlett-Packard Company
   8  *
   9  * Bus glue for Toshiba Mobile IO(TMIO) Controller's OHCI core
  10  * (C) Copyright 2005 Chris Humbert <mahadri-usb@drigon.com>
  11  * (C) Copyright 2007, 2008 Dmitry Baryshkov <dbaryshkov@gmail.com>
  12  *
  13  * This is known to work with the following variants:
  14  *      TC6393XB revision 3     (32kB SRAM)
  15  *
  16  * The TMIO's OHCI core DMAs through a small internal buffer that
  17  * is directly addressable by the CPU.
  18  *
  19  * Written from sparse documentation from Toshiba and Sharp's driver
  20  * for the 2.4 kernel,
  21  *      usb-ohci-tc6393.c(C) Copyright 2004 Lineo Solutions, Inc.
  22  */
  23
  24 /*#include <linux/fs.h>
  25 #include <linux/mount.h>
  26 #include <linux/pagemap.h>
  27 #include <linux/namei.h>
  28 #include <linux/sched.h>*/
  29 #include <linux/platform_device.h>
  30 #include <linux/mfd/core.h>
  31 #include <linux/mfd/tmio.h>
  32 #include <linux/dma-mapping.h>
  33
  34 /*-------------------------------------------------------------------------*/
  35
  36 /*
  37  * USB Host Controller Configuration Register
  38  */
  39 #define CCR_REVID       0x08    /* b Revision ID                                */
  40 #define CCR_BASE        0x10    /* l USB Control Register Base Address Low      */
  41 #define CCR_ILME        0x40    /* b Internal Local Memory Enable               */
  42 #define CCR_PM          0x4c    /* w Power Management                   */
  43 #define CCR_INTC        0x50    /* b INT Control                                */
  44 #define CCR_LMW1L       0x54    /* w Local Memory Window 1 LMADRS Low   */
  45 #define CCR_LMW1H       0x56    /* w Local Memory Window 1 LMADRS High  */
  46 #define CCR_LMW1BL      0x58    /* w Local Memory Window 1 Base Address Low     */
  47 #define CCR_LMW1BH      0x5A    /* w Local Memory Window 1 Base Address High    */
  48 #define CCR_LMW2L       0x5C    /* w Local Memory Window 2 LMADRS Low   */
  49 #define CCR_LMW2H       0x5E    /* w Local Memory Window 2 LMADRS High  */
  50 #define CCR_LMW2BL      0x60    /* w Local Memory Window 2 Base Address Low     */
  51 #define CCR_LMW2BH      0x62    /* w Local Memory Window 2 Base Address High    */
  52 #define CCR_MISC        0xFC    /* b MISC                                       */
  53
  54 #define CCR_PM_GKEN      0x0001
  55 #define CCR_PM_CKRNEN    0x0002
  56 #define CCR_PM_USBPW1    0x0004
  57 #define CCR_PM_USBPW2    0x0008
  58 #define CCR_PM_USBPW3    0x0010
  59 #define CCR_PM_PMEE      0x0100
  60 #define CCR_PM_PMES      0x8000
  61
  62 /*-------------------------------------------------------------------------*/
  63
  64 struct tmio_hcd {
  65         void __iomem            *ccr;
  66         spinlock_t              lock; /* protects RMW cycles */
  67 };
  68
  69 #define hcd_to_tmio(hcd)        ((struct tmio_hcd *)(hcd_to_ohci(hcd) + 1))
  70
  71 /*-------------------------------------------------------------------------*/
  72
  73 static void tmio_write_pm(struct platform_device *dev)
  74 {
  75         struct usb_hcd *hcd = platform_get_drvdata(dev);
  76         struct tmio_hcd *tmio = hcd_to_tmio(hcd);
  77         u16 pm;
  78         unsigned long flags;
  79
  80         spin_lock_irqsave(&tmio->lock, flags);
  81
  82         pm = CCR_PM_GKEN | CCR_PM_CKRNEN |
  83              CCR_PM_PMEE | CCR_PM_PMES;
  84
  85         tmio_iowrite16(pm, tmio->ccr + CCR_PM);
  86         spin_unlock_irqrestore(&tmio->lock, flags);
  87 }
  88
  89 static void tmio_stop_hc(struct platform_device *dev)
  90 {
  91         struct usb_hcd *hcd = platform_get_drvdata(dev);
  92         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
  93         struct tmio_hcd *tmio = hcd_to_tmio(hcd);
  94         u16 pm;
  95
  96         pm = CCR_PM_GKEN | CCR_PM_CKRNEN;
  97         switch (ohci->num_ports) {
  98                 default:
  99                         dev_err(&dev->dev, "Unsupported amount of ports: %d\n", ohci->num_ports);
 100                 case 3:
 101                         pm |= CCR_PM_USBPW3;
 102                 case 2:
 103                         pm |= CCR_PM_USBPW2;
 104                 case 1:
 105                         pm |= CCR_PM_USBPW1;
 106         }
 107         tmio_iowrite8(0, tmio->ccr + CCR_INTC);
 108         tmio_iowrite8(0, tmio->ccr + CCR_ILME);
 109         tmio_iowrite16(0, tmio->ccr + CCR_BASE);
 110         tmio_iowrite16(0, tmio->ccr + CCR_BASE + 2);
 111         tmio_iowrite16(pm, tmio->ccr + CCR_PM);
 112 }
 113
 114 static void tmio_start_hc(struct platform_device *dev)
 115 {
 116         struct usb_hcd *hcd = platform_get_drvdata(dev);
 117         struct tmio_hcd *tmio = hcd_to_tmio(hcd);
 118         unsigned long base = hcd->rsrc_start;
 119
 120         tmio_write_pm(dev);
 121         tmio_iowrite16(base, tmio->ccr + CCR_BASE);
 122         tmio_iowrite16(base >> 16, tmio->ccr + CCR_BASE + 2);
 123         tmio_iowrite8(1, tmio->ccr + CCR_ILME);
 124         tmio_iowrite8(2, tmio->ccr + CCR_INTC);
 125
 126         dev_info(&dev->dev, "revision %d @ 0x%08llx, irq %d\n",
 127                         tmio_ioread8(tmio->ccr + CCR_REVID),
 128                         (u64) hcd->rsrc_start, hcd->irq);
 129 }
 130
 131 static int ohci_tmio_start(struct usb_hcd *hcd)
 132 {
 133         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
 134         int ret;
 135
 136         if ((ret = ohci_init(ohci)) < 0)
 137                 return ret;
 138
 139         if ((ret = ohci_run(ohci)) < 0) {
 140                 dev_err(hcd->self.controller, "can't start %s\n",
 141                         hcd->self.bus_name);
 142                 ohci_stop(hcd);
 143                 return ret;
 144         }
 145
 146         return 0;
 147 }
 148
 149 static const struct hc_driver ohci_tmio_hc_driver = {
 150         .description =          hcd_name,
 151         .product_desc =         "TMIO OHCI USB Host Controller",
 152         .hcd_priv_size =        sizeof(struct ohci_hcd) + sizeof (struct tmio_hcd),
 153
 154         /* generic hardware linkage */
 155         .irq =                  ohci_irq,
 156         .flags =                HCD_USB11 | HCD_MEMORY | HCD_LOCAL_MEM,
 157
 158         /* basic lifecycle operations */
 159         .start =                ohci_tmio_start,
 160         .stop =                 ohci_stop,
 161         .shutdown =             ohci_shutdown,
 162
 163         /* managing i/o requests and associated device resources */
 164         .urb_enqueue =          ohci_urb_enqueue,
 165         .urb_dequeue =          ohci_urb_dequeue,
 166         .endpoint_disable =     ohci_endpoint_disable,
 167
 168         /* scheduling support */
 169         .get_frame_number =     ohci_get_frame,
 170
 171         /* root hub support */
 172         .hub_status_data =      ohci_hub_status_data,
 173         .hub_control =          ohci_hub_control,
 174 #ifdef  CONFIG_PM
 175         .bus_suspend =          ohci_bus_suspend,
 176         .bus_resume =           ohci_bus_resume,
 177 #endif
 178         .start_port_reset =     ohci_start_port_reset,
 179 };
 180
 181 /*-------------------------------------------------------------------------*/
 182 static struct platform_driver ohci_hcd_tmio_driver;
 183
 184 static int ohci_hcd_tmio_drv_probe(struct platform_device *dev)
 185 {
 186         const struct mfd_cell *cell = mfd_get_cell(dev);
 187         struct resource *regs = platform_get_resource(dev, IORESOURCE_MEM, 0);
 188         struct resource *config = platform_get_resource(dev, IORESOURCE_MEM, 1);
 189         struct resource *sram = platform_get_resource(dev, IORESOURCE_MEM, 2);
 190         int irq = platform_get_irq(dev, 0);
 191         struct tmio_hcd *tmio;
 192         struct ohci_hcd *ohci;
 193         struct usb_hcd *hcd;
 194         int ret;
 195
 196         if (usb_disabled())
 197                 return -ENODEV;
 198
 199         if (!cell || !regs || !config || !sram)
 200                 return -EINVAL;
 201
 202         if (irq < 0)
 203                 return irq;
 204
 205         hcd = usb_create_hcd(&ohci_tmio_hc_driver, &dev->dev, dev_name(&dev->dev));
 206         if (!hcd) {
 207                 ret = -ENOMEM;
 208                 goto err_usb_create_hcd;
 209         }
 210
 211         hcd->rsrc_start = regs->start;
 212         hcd->rsrc_len = resource_size(regs);
 213
 214         tmio = hcd_to_tmio(hcd);
 215
 216         spin_lock_init(&tmio->lock);
 217
 218         tmio->ccr = ioremap(config->start, resource_size(config));
 219         if (!tmio->ccr) {
 220                 ret = -ENOMEM;
 221                 goto err_ioremap_ccr;
 222         }
 223
 224         hcd->regs = ioremap(hcd->rsrc_start, hcd->rsrc_len);
 225         if (!hcd->regs) {
 226                 ret = -ENOMEM;
 227                 goto err_ioremap_regs;
 228         }
 229
 230         ret = dma_declare_coherent_memory(&dev->dev, sram->start, sram->start,
 231                                 resource_size(sram), DMA_MEMORY_EXCLUSIVE);
 232         if (ret)
 233                 goto err_dma_declare;
 234
 235         if (cell->enable) {
 236                 ret = cell->enable(dev);
 237                 if (ret)
 238                         goto err_enable;
 239         }
 240
 241         tmio_start_hc(dev);
 242         ohci = hcd_to_ohci(hcd);
 243         ohci_hcd_init(ohci);
 244
 245         ret = usb_add_hcd(hcd, irq, 0);
 246         if (ret)
 247                 goto err_add_hcd;
 248
 249         device_wakeup_enable(hcd->self.controller);
 250         if (ret == 0)
 251                 return ret;
 252
 253         usb_remove_hcd(hcd);
 254
 255 err_add_hcd:
 256         tmio_stop_hc(dev);
 257         if (cell->disable)
 258                 cell->disable(dev);
 259 err_enable:
 260         dma_release_declared_memory(&dev->dev);
 261 err_dma_declare:
 262         iounmap(hcd->regs);
 263 err_ioremap_regs:
 264         iounmap(tmio->ccr);
 265 err_ioremap_ccr:
 266         usb_put_hcd(hcd);
 267 err_usb_create_hcd:
 268
 269         return ret;
 270 }
 271
 272 static int ohci_hcd_tmio_drv_remove(struct platform_device *dev)
 273 {
 274         struct usb_hcd *hcd = platform_get_drvdata(dev);
 275         struct tmio_hcd *tmio = hcd_to_tmio(hcd);
 276         const struct mfd_cell *cell = mfd_get_cell(dev);
 277
 278         usb_remove_hcd(hcd);
 279         tmio_stop_hc(dev);
 280         if (cell->disable)
 281                 cell->disable(dev);
 282         dma_release_declared_memory(&dev->dev);
 283         iounmap(hcd->regs);
 284         iounmap(tmio->ccr);
 285         usb_put_hcd(hcd);
 286
 287         return 0;
 288 }
 289
 290 #ifdef CONFIG_PM
 291 static int ohci_hcd_tmio_drv_suspend(struct platform_device *dev, pm_message_t state)
 292 {
 293         const struct mfd_cell *cell = mfd_get_cell(dev);
 294         struct usb_hcd *hcd = platform_get_drvdata(dev);
 295         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
 296         struct tmio_hcd *tmio = hcd_to_tmio(hcd);
 297         unsigned long flags;
 298         u8 misc;
 299         int ret;
 300
 301         if (time_before(jiffies, ohci->next_statechange))
 302                 msleep(5);
 303         ohci->next_statechange = jiffies;
 304
 305         spin_lock_irqsave(&tmio->lock, flags);
 306
 307         misc = tmio_ioread8(tmio->ccr + CCR_MISC);
 308         misc |= 1 << 3; /* USSUSP */
 309         tmio_iowrite8(misc, tmio->ccr + CCR_MISC);
 310
 311         spin_unlock_irqrestore(&tmio->lock, flags);
 312
 313         if (cell->suspend) {
 314                 ret = cell->suspend(dev);
 315                 if (ret)
 316                         return ret;
 317         }
 318         return 0;
 319 }
 320
 321 static int ohci_hcd_tmio_drv_resume(struct platform_device *dev)
 322 {
 323         const struct mfd_cell *cell = mfd_get_cell(dev);
 324         struct usb_hcd *hcd = platform_get_drvdata(dev);
 325         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
 326         struct tmio_hcd *tmio = hcd_to_tmio(hcd);
 327         unsigned long flags;
 328         u8 misc;
 329         int ret;
 330
 331         if (time_before(jiffies, ohci->next_statechange))
 332                 msleep(5);
 333         ohci->next_statechange = jiffies;
 334
 335         if (cell->resume) {
 336                 ret = cell->resume(dev);
 337                 if (ret)
 338                         return ret;
 339         }
 340
 341         tmio_start_hc(dev);
 342
 343         spin_lock_irqsave(&tmio->lock, flags);
 344
 345         misc = tmio_ioread8(tmio->ccr + CCR_MISC);
 346         misc &= ~(1 << 3); /* USSUSP */
 347         tmio_iowrite8(misc, tmio->ccr + CCR_MISC);
 348
 349         spin_unlock_irqrestore(&tmio->lock, flags);
 350
 351         ohci_resume(hcd, false);
 352
 353         return 0;
 354 }
 355 #else
 356 #define ohci_hcd_tmio_drv_suspend NULL
 357 #define ohci_hcd_tmio_drv_resume NULL
 358 #endif
 359
 360 static struct platform_driver ohci_hcd_tmio_driver = {
 361         .probe          = ohci_hcd_tmio_drv_probe,
 362         .remove         = ohci_hcd_tmio_drv_remove,
 363         .shutdown       = usb_hcd_platform_shutdown,
 364         .suspend        = ohci_hcd_tmio_drv_suspend,
 365         .resume         = ohci_hcd_tmio_drv_resume,
 366         .driver         = {
 367                 .name   = "tmio-ohci",
 368         },
 369 };