drivers/usb/host/ohci-nxp.c

   1 /*
   2  * driver for NXP USB Host devices
   3  *
   4  * Currently supported OHCI host devices:
   5  * - NXP LPC32xx
   6  *
   7  * Authors: Dmitry Chigirev <source@mvista.com>
   8  *          Vitaly Wool <vitalywool@gmail.com>
   9  *
  10  * register initialization is based on code examples provided by Philips
  11  * Copyright (c) 2005 Koninklijke Philips Electronics N.V.
  12  *
  13  * NOTE: This driver does not have suspend/resume functionality
  14  * This driver is intended for engineering development purposes only
  15  *
  16  * 2005-2006 (c) MontaVista Software, Inc. This file is licensed under
  17  * the terms of the GNU General Public License version 2. This program
  18  * is licensed "as is" without any warranty of any kind, whether express
  19  * or implied.
  20  */
  21 #include <linux/clk.h>
  22 #include <linux/platform_device.h>
  23 #include <linux/i2c.h>
  24 #include <linux/of.h>
  25 #include <linux/usb/isp1301.h>
  26
  27 #include <mach/hardware.h>
  28 #include <asm/mach-types.h>
  29 #include <asm/io.h>
  30
  31 #include <mach/platform.h>
  32 #include <mach/irqs.h>
  33
  34 #define USB_CONFIG_BASE         0x31020000
  35 #define PWRMAN_BASE             0x40004000
  36
  37 #define USB_CTRL                IO_ADDRESS(PWRMAN_BASE + 0x64)
  38
  39 /* USB_CTRL bit defines */
  40 #define USB_SLAVE_HCLK_EN       (1 << 24)
  41 #define USB_DEV_NEED_CLK_EN     (1 << 22)
  42 #define USB_HOST_NEED_CLK_EN    (1 << 21)
  43 #define PAD_CONTROL_LAST_DRIVEN (1 << 19)
  44
  45 #define USB_OTG_STAT_CONTROL    IO_ADDRESS(USB_CONFIG_BASE + 0x110)
  46
  47 /* USB_OTG_STAT_CONTROL bit defines */
  48 #define TRANSPARENT_I2C_EN      (1 << 7)
  49 #define HOST_EN                 (1 << 0)
  50
  51 /* On LPC32xx, those are undefined */
  52 #ifndef start_int_set_falling_edge
  53 #define start_int_set_falling_edge(irq)
  54 #define start_int_set_rising_edge(irq)
  55 #define start_int_ack(irq)
  56 #define start_int_mask(irq)
  57 #define start_int_umask(irq)
  58 #endif
  59
  60 static struct i2c_client *isp1301_i2c_client;
  61
  62 extern int usb_disabled(void);
  63
  64 static struct clk *usb_pll_clk;
  65 static struct clk *usb_dev_clk;
  66 static struct clk *usb_otg_clk;
  67
  68 static void isp1301_configure_lpc32xx(void)
  69 {
  70         /* LPC32XX only supports DAT_SE0 USB mode */
  71         /* This sequence is important */
  72
  73         /* Disable transparent UART mode first */
  74         i2c_smbus_write_byte_data(isp1301_i2c_client,
  75                 (ISP1301_I2C_MODE_CONTROL_1 | ISP1301_I2C_REG_CLEAR_ADDR),
  76                 MC1_UART_EN);
  77         i2c_smbus_write_byte_data(isp1301_i2c_client,
  78                 (ISP1301_I2C_MODE_CONTROL_1 | ISP1301_I2C_REG_CLEAR_ADDR),
  79                 ~MC1_SPEED_REG);
  80         i2c_smbus_write_byte_data(isp1301_i2c_client,
  81                                   ISP1301_I2C_MODE_CONTROL_1, MC1_SPEED_REG);
  82         i2c_smbus_write_byte_data(isp1301_i2c_client,
  83                   (ISP1301_I2C_MODE_CONTROL_2 | ISP1301_I2C_REG_CLEAR_ADDR),
  84                   ~0);
  85         i2c_smbus_write_byte_data(isp1301_i2c_client,
  86                 ISP1301_I2C_MODE_CONTROL_2,
  87                 (MC2_BI_DI | MC2_PSW_EN | MC2_SPD_SUSP_CTRL));
  88         i2c_smbus_write_byte_data(isp1301_i2c_client,
  89                 (ISP1301_I2C_OTG_CONTROL_1 | ISP1301_I2C_REG_CLEAR_ADDR), ~0);
  90         i2c_smbus_write_byte_data(isp1301_i2c_client,
  91                 ISP1301_I2C_MODE_CONTROL_1, MC1_DAT_SE0);
  92         i2c_smbus_write_byte_data(isp1301_i2c_client,
  93                 ISP1301_I2C_OTG_CONTROL_1,
  94                 (OTG1_DM_PULLDOWN | OTG1_DP_PULLDOWN));
  95         i2c_smbus_write_byte_data(isp1301_i2c_client,
  96                 (ISP1301_I2C_OTG_CONTROL_1 | ISP1301_I2C_REG_CLEAR_ADDR),
  97                 (OTG1_DM_PULLUP | OTG1_DP_PULLUP));
  98         i2c_smbus_write_byte_data(isp1301_i2c_client,
  99                 ISP1301_I2C_INTERRUPT_LATCH | ISP1301_I2C_REG_CLEAR_ADDR, ~0);
 100         i2c_smbus_write_byte_data(isp1301_i2c_client,
 101                 ISP1301_I2C_INTERRUPT_FALLING | ISP1301_I2C_REG_CLEAR_ADDR,
 102                 ~0);
 103         i2c_smbus_write_byte_data(isp1301_i2c_client,
 104                 ISP1301_I2C_INTERRUPT_RISING | ISP1301_I2C_REG_CLEAR_ADDR, ~0);
 105
 106         /* Enable usb_need_clk clock after transceiver is initialized */
 107         __raw_writel(__raw_readl(USB_CTRL) | USB_HOST_NEED_CLK_EN, USB_CTRL);
 108
 109         printk(KERN_INFO "ISP1301 Vendor ID  : 0x%04x\n",
 110               i2c_smbus_read_word_data(isp1301_i2c_client, 0x00));
 111         printk(KERN_INFO "ISP1301 Product ID : 0x%04x\n",
 112               i2c_smbus_read_word_data(isp1301_i2c_client, 0x02));
 113         printk(KERN_INFO "ISP1301 Version ID : 0x%04x\n",
 114               i2c_smbus_read_word_data(isp1301_i2c_client, 0x14));
 115 }
 116
 117 static void isp1301_configure(void)
 118 {
 119         isp1301_configure_lpc32xx();
 120 }
 121
 122 static inline void isp1301_vbus_on(void)
 123 {
 124         i2c_smbus_write_byte_data(isp1301_i2c_client, ISP1301_I2C_OTG_CONTROL_1,
 125                                   OTG1_VBUS_DRV);
 126 }
 127
 128 static inline void isp1301_vbus_off(void)
 129 {
 130         i2c_smbus_write_byte_data(isp1301_i2c_client,
 131                 ISP1301_I2C_OTG_CONTROL_1 | ISP1301_I2C_REG_CLEAR_ADDR,
 132                 OTG1_VBUS_DRV);
 133 }
 134
 135 static void nxp_start_hc(void)
 136 {
 137         unsigned long tmp = __raw_readl(USB_OTG_STAT_CONTROL) | HOST_EN;
 138         __raw_writel(tmp, USB_OTG_STAT_CONTROL);
 139         isp1301_vbus_on();
 140 }
 141
 142 static void nxp_stop_hc(void)
 143 {
 144         unsigned long tmp;
 145         isp1301_vbus_off();
 146         tmp = __raw_readl(USB_OTG_STAT_CONTROL) & ~HOST_EN;
 147         __raw_writel(tmp, USB_OTG_STAT_CONTROL);
 148 }
 149
 150 static int ohci_nxp_start(struct usb_hcd *hcd)
 151 {
 152         struct ohci_hcd *ohci = hcd_to_ohci(hcd);
 153         int ret;
 154
 155         if ((ret = ohci_init(ohci)) < 0)
 156                 return ret;
 157
 158         if ((ret = ohci_run(ohci)) < 0) {
 159                 dev_err(hcd->self.controller, "can't start\n");
 160                 ohci_stop(hcd);
 161                 return ret;
 162         }
 163         return 0;
 164 }
 165
 166 static const struct hc_driver ohci_nxp_hc_driver = {
 167         .description = hcd_name,
 168         .product_desc =         "nxp OHCI",
 169
 170         /*
 171          * generic hardware linkage
 172          */
 173         .irq = ohci_irq,
 174         .flags = HCD_USB11 | HCD_MEMORY,
 175
 176         .hcd_priv_size =        sizeof(struct ohci_hcd),
 177         /*
 178          * basic lifecycle operations
 179          */
 180         .start = ohci_nxp_start,
 181         .stop = ohci_stop,
 182         .shutdown = ohci_shutdown,
 183
 184         /*
 185          * managing i/o requests and associated device resources
 186          */
 187         .urb_enqueue = ohci_urb_enqueue,
 188         .urb_dequeue = ohci_urb_dequeue,
 189         .endpoint_disable = ohci_endpoint_disable,
 190
 191         /*
 192          * scheduling support
 193          */
 194         .get_frame_number = ohci_get_frame,
 195
 196         /*
 197          * root hub support
 198          */
 199         .hub_status_data = ohci_hub_status_data,
 200         .hub_control = ohci_hub_control,
 201 #ifdef  CONFIG_PM
 202         .bus_suspend = ohci_bus_suspend,
 203         .bus_resume = ohci_bus_resume,
 204 #endif
 205         .start_port_reset = ohci_start_port_reset,
 206 };
 207
 208 static int usb_hcd_nxp_probe(struct platform_device *pdev)
 209 {
 210         struct usb_hcd *hcd = 0;
 211         struct ohci_hcd *ohci;
 212         const struct hc_driver *driver = &ohci_nxp_hc_driver;
 213         struct resource *res;
 214         int ret = 0, irq;
 215         struct device_node *isp1301_node;
 216
 217         if (pdev->dev.of_node) {
 218                 isp1301_node = of_parse_phandle(pdev->dev.of_node,
 219                                                 "transceiver", 0);
 220         } else {
 221                 isp1301_node = NULL;
 222         }
 223
 224         isp1301_i2c_client = isp1301_get_client(isp1301_node);
 225         if (!isp1301_i2c_client) {
 226                 ret = -EPROBE_DEFER;
 227                 goto out;
 228         }
 229
 230         pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
 231         pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
 232
 233         dev_dbg(&pdev->dev, "%s: " DRIVER_DESC " (nxp)\n", hcd_name);
 234         if (usb_disabled()) {
 235                 dev_err(&pdev->dev, "USB is disabled\n");
 236                 ret = -ENODEV;
 237                 goto out;
 238         }
 239
 240         /* Enable AHB slave USB clock, needed for further USB clock control */
 241         __raw_writel(USB_SLAVE_HCLK_EN | PAD_CONTROL_LAST_DRIVEN, USB_CTRL);
 242
 243         /* Enable USB PLL */
 244         usb_pll_clk = clk_get(&pdev->dev, "ck_pll5");
 245         if (IS_ERR(usb_pll_clk)) {
 246                 dev_err(&pdev->dev, "failed to acquire USB PLL\n");
 247                 ret = PTR_ERR(usb_pll_clk);
 248                 goto out1;
 249         }
 250
 251         ret = clk_enable(usb_pll_clk);
 252         if (ret < 0) {
 253                 dev_err(&pdev->dev, "failed to start USB PLL\n");
 254                 goto out2;
 255         }
 256
 257         ret = clk_set_rate(usb_pll_clk, 48000);
 258         if (ret < 0) {
 259                 dev_err(&pdev->dev, "failed to set USB clock rate\n");
 260                 goto out3;
 261         }
 262
 263         /* Enable USB device clock */
 264         usb_dev_clk = clk_get(&pdev->dev, "ck_usbd");
 265         if (IS_ERR(usb_dev_clk)) {
 266                 dev_err(&pdev->dev, "failed to acquire USB DEV Clock\n");
 267                 ret = PTR_ERR(usb_dev_clk);
 268                 goto out4;
 269         }
 270
 271         ret = clk_enable(usb_dev_clk);
 272         if (ret < 0) {
 273                 dev_err(&pdev->dev, "failed to start USB DEV Clock\n");
 274                 goto out5;
 275         }
 276
 277         /* Enable USB otg clocks */
 278         usb_otg_clk = clk_get(&pdev->dev, "ck_usb_otg");
 279         if (IS_ERR(usb_otg_clk)) {
 280                 dev_err(&pdev->dev, "failed to acquire USB DEV Clock\n");
 281                 ret = PTR_ERR(usb_otg_clk);
 282                 goto out6;
 283         }
 284
 285         __raw_writel(__raw_readl(USB_CTRL) | USB_HOST_NEED_CLK_EN, USB_CTRL);
 286
 287         ret = clk_enable(usb_otg_clk);
 288         if (ret < 0) {
 289                 dev_err(&pdev->dev, "failed to start USB DEV Clock\n");
 290                 goto out7;
 291         }
 292
 293         isp1301_configure();
 294
 295         hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev));
 296         if (!hcd) {
 297                 dev_err(&pdev->dev, "Failed to allocate HC buffer\n");
 298                 ret = -ENOMEM;
 299                 goto out8;
 300         }
 301
 302         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 303         if (!res) {
 304                 dev_err(&pdev->dev, "Failed to get MEM resource\n");
 305                 ret =  -ENOMEM;
 306                 goto out8;
 307         }
 308
 309         hcd->regs = devm_request_and_ioremap(&pdev->dev, res);
 310         if (!hcd->regs) {
 311                 dev_err(&pdev->dev, "Failed to devm_request_and_ioremap\n");
 312                 ret =  -ENOMEM;
 313                 goto out8;
 314         }
 315         hcd->rsrc_start = res->start;
 316         hcd->rsrc_len = resource_size(res);
 317
 318         irq = platform_get_irq(pdev, 0);
 319         if (irq < 0) {
 320                 ret = -ENXIO;
 321                 goto out8;
 322         }
 323
 324         nxp_start_hc();
 325         platform_set_drvdata(pdev, hcd);
 326         ohci = hcd_to_ohci(hcd);
 327         ohci_hcd_init(ohci);
 328
 329         dev_info(&pdev->dev, "at 0x%p, irq %d\n", hcd->regs, hcd->irq);
 330         ret = usb_add_hcd(hcd, irq, 0);
 331         if (ret == 0)
 332                 return ret;
 333
 334         nxp_stop_hc();
 335 out8:
 336         usb_put_hcd(hcd);
 337 out7:
 338         clk_disable(usb_otg_clk);
 339 out6:
 340         clk_put(usb_otg_clk);
 341 out5:
 342         clk_disable(usb_dev_clk);
 343 out4:
 344         clk_put(usb_dev_clk);
 345 out3:
 346         clk_disable(usb_pll_clk);
 347 out2:
 348         clk_put(usb_pll_clk);
 349 out1:
 350         isp1301_i2c_client = NULL;
 351 out:
 352         return ret;
 353 }
 354
 355 static int usb_hcd_nxp_remove(struct platform_device *pdev)
 356 {
 357         struct usb_hcd *hcd = platform_get_drvdata(pdev);
 358
 359         usb_remove_hcd(hcd);
 360         nxp_stop_hc();
 361         release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 362         usb_put_hcd(hcd);
 363         clk_disable(usb_pll_clk);
 364         clk_put(usb_pll_clk);
 365         clk_disable(usb_dev_clk);
 366         clk_put(usb_dev_clk);
 367         i2c_unregister_device(isp1301_i2c_client);
 368         isp1301_i2c_client = NULL;
 369
 370         platform_set_drvdata(pdev, NULL);
 371
 372         return 0;
 373 }
 374
 375 /* work with hotplug and coldplug */
 376 MODULE_ALIAS("platform:usb-ohci");
 377
 378 #ifdef CONFIG_OF
 379 static const struct of_device_id usb_hcd_nxp_match[] = {
 380         { .compatible = "nxp,ohci-nxp" },
 381         {},
 382 };
 383 MODULE_DEVICE_TABLE(of, usb_hcd_nxp_match);
 384 #endif
 385
 386 static struct platform_driver usb_hcd_nxp_driver = {
 387         .driver = {
 388                 .name = "usb-ohci",
 389                 .owner  = THIS_MODULE,
 390                 .of_match_table = of_match_ptr(usb_hcd_nxp_match),
 391         },
 392         .probe = usb_hcd_nxp_probe,
 393         .remove = usb_hcd_nxp_remove,
 394 };
 395