drivers/usb/host/ehci-ps3.c

   1 /*
   2  *  PS3 EHCI Host Controller driver
   3  *
   4  *  Copyright (C) 2006 Sony Computer Entertainment Inc.
   5  *  Copyright 2006 Sony Corp.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; version 2 of the License.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include <asm/firmware.h>
  22 #include <asm/ps3.h>
  23
  24 static void ps3_ehci_setup_insnreg(struct ehci_hcd *ehci)
  25 {
  26         /* PS3 HC internal setup register offsets. */
  27
  28         enum ps3_ehci_hc_insnreg {
  29                 ps3_ehci_hc_insnreg01 = 0x084,
  30                 ps3_ehci_hc_insnreg02 = 0x088,
  31                 ps3_ehci_hc_insnreg03 = 0x08c,
  32         };
  33
  34         /* PS3 EHCI HC errata fix 316 - The PS3 EHCI HC will reset its
  35          * internal INSNREGXX setup regs back to the chip default values
  36          * on Host Controller Reset (CMD_RESET) or Light Host Controller
  37          * Reset (CMD_LRESET).  The work-around for this is for the HC
  38          * driver to re-initialise these regs when ever the HC is reset.
  39          */
  40
  41         /* Set burst transfer counts to 256 out, 32 in. */
  42
  43         writel_be(0x01000020, (void __iomem *)ehci->regs +
  44                 ps3_ehci_hc_insnreg01);
  45
  46         /* Enable burst transfer counts. */
  47
  48         writel_be(0x00000001, (void __iomem *)ehci->regs +
  49                 ps3_ehci_hc_insnreg03);
  50 }
  51
  52 static int ps3_ehci_hc_reset(struct usb_hcd *hcd)
  53 {
  54         int result;
  55         struct ehci_hcd *ehci = hcd_to_ehci(hcd);
  56
  57         ehci->big_endian_mmio = 1;
  58
  59         ehci->caps = hcd->regs;
  60         ehci->regs = hcd->regs + HC_LENGTH(ehci, ehci_readl(ehci,
  61                 &ehci->caps->hc_capbase));
  62
  63         dbg_hcs_params(ehci, "reset");
  64         dbg_hcc_params(ehci, "reset");
  65
  66         ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
  67
  68         result = ehci_halt(ehci);
  69
  70         if (result)
  71                 return result;
  72
  73         result = ehci_init(hcd);
  74
  75         if (result)
  76                 return result;
  77
  78         ehci_reset(ehci);
  79
  80         ps3_ehci_setup_insnreg(ehci);
  81
  82         return result;
  83 }
  84
  85 static const struct hc_driver ps3_ehci_hc_driver = {
  86         .description            = hcd_name,
  87         .product_desc           = "PS3 EHCI Host Controller",
  88         .hcd_priv_size          = sizeof(struct ehci_hcd),
  89         .irq                    = ehci_irq,
  90         .flags                  = HCD_MEMORY | HCD_USB2,
  91         .reset                  = ps3_ehci_hc_reset,
  92         .start                  = ehci_run,
  93         .stop                   = ehci_stop,
  94         .shutdown               = ehci_shutdown,
  95         .urb_enqueue            = ehci_urb_enqueue,
  96         .urb_dequeue            = ehci_urb_dequeue,
  97         .endpoint_disable       = ehci_endpoint_disable,
  98         .endpoint_reset         = ehci_endpoint_reset,
  99         .get_frame_number       = ehci_get_frame,
 100         .hub_status_data        = ehci_hub_status_data,
 101         .hub_control            = ehci_hub_control,
 102 #if defined(CONFIG_PM)
 103         .bus_suspend            = ehci_bus_suspend,
 104         .bus_resume             = ehci_bus_resume,
 105 #endif
 106         .relinquish_port        = ehci_relinquish_port,
 107         .port_handed_over       = ehci_port_handed_over,
 108
 109         .clear_tt_buffer_complete       = ehci_clear_tt_buffer_complete,
 110 };
 111
 112 static int __devinit ps3_ehci_probe(struct ps3_system_bus_device *dev)
 113 {
 114         int result;
 115         struct usb_hcd *hcd;
 116         unsigned int virq;
 117         static u64 dummy_mask = DMA_BIT_MASK(32);
 118
 119         if (usb_disabled()) {
 120                 result = -ENODEV;
 121                 goto fail_start;
 122         }
 123
 124         result = ps3_open_hv_device(dev);
 125
 126         if (result) {
 127                 dev_dbg(&dev->core, "%s:%d: ps3_open_hv_device failed\n",
 128                         __func__, __LINE__);
 129                 goto fail_open;
 130         }
 131
 132         result = ps3_dma_region_create(dev->d_region);
 133
 134         if (result) {
 135                 dev_dbg(&dev->core, "%s:%d: ps3_dma_region_create failed: "
 136                         "(%d)\n", __func__, __LINE__, result);
 137                 BUG_ON("check region type");
 138                 goto fail_dma_region;
 139         }
 140
 141         result = ps3_mmio_region_create(dev->m_region);
 142
 143         if (result) {
 144                 dev_dbg(&dev->core, "%s:%d: ps3_map_mmio_region failed\n",
 145                         __func__, __LINE__);
 146                 result = -EPERM;
 147                 goto fail_mmio_region;
 148         }
 149
 150         dev_dbg(&dev->core, "%s:%d: mmio mapped_addr %lxh\n", __func__,
 151                 __LINE__, dev->m_region->lpar_addr);
 152
 153         result = ps3_io_irq_setup(PS3_BINDING_CPU_ANY, dev->interrupt_id, &virq);
 154
 155         if (result) {
 156                 dev_dbg(&dev->core, "%s:%d: ps3_construct_io_irq(%d) failed.\n",
 157                         __func__, __LINE__, virq);
 158                 result = -EPERM;
 159                 goto fail_irq;
 160         }
 161
 162         dev->core.dma_mask = &dummy_mask; /* FIXME: for improper usb code */
 163
 164         hcd = usb_create_hcd(&ps3_ehci_hc_driver, &dev->core, dev_name(&dev->core));
 165
 166         if (!hcd) {
 167                 dev_dbg(&dev->core, "%s:%d: usb_create_hcd failed\n", __func__,
 168                         __LINE__);
 169                 result = -ENOMEM;
 170                 goto fail_create_hcd;
 171         }
 172
 173         hcd->rsrc_start = dev->m_region->lpar_addr;
 174         hcd->rsrc_len = dev->m_region->len;
 175
 176         if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name))
 177                 dev_dbg(&dev->core, "%s:%d: request_mem_region failed\n",
 178                         __func__, __LINE__);
 179
 180         hcd->regs = ioremap(dev->m_region->lpar_addr, dev->m_region->len);
 181
 182         if (!hcd->regs) {
 183                 dev_dbg(&dev->core, "%s:%d: ioremap failed\n", __func__,
 184                         __LINE__);
 185                 result = -EPERM;
 186                 goto fail_ioremap;
 187         }
 188
 189         dev_dbg(&dev->core, "%s:%d: hcd->rsrc_start %lxh\n", __func__, __LINE__,
 190                 (unsigned long)hcd->rsrc_start);
 191         dev_dbg(&dev->core, "%s:%d: hcd->rsrc_len   %lxh\n", __func__, __LINE__,
 192                 (unsigned long)hcd->rsrc_len);
 193         dev_dbg(&dev->core, "%s:%d: hcd->regs       %lxh\n", __func__, __LINE__,
 194                 (unsigned long)hcd->regs);
 195         dev_dbg(&dev->core, "%s:%d: virq            %lu\n", __func__, __LINE__,
 196                 (unsigned long)virq);
 197
 198         ps3_system_bus_set_drvdata(dev, hcd);
 199
 200         result = usb_add_hcd(hcd, virq, 0);
 201
 202         if (result) {
 203                 dev_dbg(&dev->core, "%s:%d: usb_add_hcd failed (%d)\n",
 204                         __func__, __LINE__, result);
 205                 goto fail_add_hcd;
 206         }
 207
 208         return result;
 209
 210 fail_add_hcd:
 211         iounmap(hcd->regs);
 212 fail_ioremap:
 213         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 214         usb_put_hcd(hcd);
 215 fail_create_hcd:
 216         ps3_io_irq_destroy(virq);
 217 fail_irq:
 218         ps3_free_mmio_region(dev->m_region);
 219 fail_mmio_region:
 220         ps3_dma_region_free(dev->d_region);
 221 fail_dma_region:
 222         ps3_close_hv_device(dev);
 223 fail_open:
 224 fail_start:
 225         return result;
 226 }
 227
 228 static int ps3_ehci_remove(struct ps3_system_bus_device *dev)
 229 {
 230         unsigned int tmp;
 231         struct usb_hcd *hcd = ps3_system_bus_get_drvdata(dev);
 232
 233         BUG_ON(!hcd);
 234
 235         dev_dbg(&dev->core, "%s:%d: regs %p\n", __func__, __LINE__, hcd->regs);
 236         dev_dbg(&dev->core, "%s:%d: irq %u\n", __func__, __LINE__, hcd->irq);
 237
 238         tmp = hcd->irq;
 239
 240         ehci_shutdown(hcd);
 241         usb_remove_hcd(hcd);
 242
 243         ps3_system_bus_set_drvdata(dev, NULL);
 244
 245         BUG_ON(!hcd->regs);
 246         iounmap(hcd->regs);
 247
 248         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 249         usb_put_hcd(hcd);
 250
 251         ps3_io_irq_destroy(tmp);
 252         ps3_free_mmio_region(dev->m_region);
 253
 254         ps3_dma_region_free(dev->d_region);
 255         ps3_close_hv_device(dev);
 256
 257         return 0;
 258 }
 259
 260 static int __init ps3_ehci_driver_register(struct ps3_system_bus_driver *drv)
 261 {
 262         return firmware_has_feature(FW_FEATURE_PS3_LV1)
 263                 ? ps3_system_bus_driver_register(drv)
 264                 : 0;
 265 }
 266
 267 static void ps3_ehci_driver_unregister(struct ps3_system_bus_driver *drv)
 268 {
 269         if (firmware_has_feature(FW_FEATURE_PS3_LV1))
 270                 ps3_system_bus_driver_unregister(drv);
 271 }
 272
 273 MODULE_ALIAS(PS3_MODULE_ALIAS_EHCI);
 274
 275 static struct ps3_system_bus_driver ps3_ehci_driver = {
 276         .core.name = "ps3-ehci-driver",
 277         .core.owner = THIS_MODULE,
 278         .match_id = PS3_MATCH_ID_EHCI,
 279         .probe = ps3_ehci_probe,
 280         .remove = ps3_ehci_remove,
 281         .shutdown = ps3_ehci_remove,
 282 };