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