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 return -EPROBE_DEFER; 227 } 228 229 pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32); 230 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask; 231 232 dev_dbg(&pdev->dev, "%s: " DRIVER_DESC " (nxp)\n", hcd_name); 233 if (usb_disabled()) { 234 dev_err(&pdev->dev, "USB is disabled\n"); 235 ret = -ENODEV; 236 goto fail_disable; 237 } 238 239 /* Enable AHB slave USB clock, needed for further USB clock control */ 240 __raw_writel(USB_SLAVE_HCLK_EN | PAD_CONTROL_LAST_DRIVEN, USB_CTRL); 241 242 /* Enable USB PLL */ 243 usb_pll_clk = clk_get(&pdev->dev, "ck_pll5"); 244 if (IS_ERR(usb_pll_clk)) { 245 dev_err(&pdev->dev, "failed to acquire USB PLL\n"); 246 ret = PTR_ERR(usb_pll_clk); 247 goto fail_pll; 248 } 249 250 ret = clk_enable(usb_pll_clk); 251 if (ret < 0) { 252 dev_err(&pdev->dev, "failed to start USB PLL\n"); 253 goto fail_pllen; 254 } 255 256 ret = clk_set_rate(usb_pll_clk, 48000); 257 if (ret < 0) { 258 dev_err(&pdev->dev, "failed to set USB clock rate\n"); 259 goto fail_rate; 260 } 261 262 /* Enable USB device clock */ 263 usb_dev_clk = clk_get(&pdev->dev, "ck_usbd"); 264 if (IS_ERR(usb_dev_clk)) { 265 dev_err(&pdev->dev, "failed to acquire USB DEV Clock\n"); 266 ret = PTR_ERR(usb_dev_clk); 267 goto fail_dev; 268 } 269 270 ret = clk_enable(usb_dev_clk); 271 if (ret < 0) { 272 dev_err(&pdev->dev, "failed to start USB DEV Clock\n"); 273 goto fail_deven; 274 } 275 276 /* Enable USB otg clocks */ 277 usb_otg_clk = clk_get(&pdev->dev, "ck_usb_otg"); 278 if (IS_ERR(usb_otg_clk)) { 279 dev_err(&pdev->dev, "failed to acquire USB DEV Clock\n"); 280 ret = PTR_ERR(usb_otg_clk); 281 goto fail_otg; 282 } 283 284 __raw_writel(__raw_readl(USB_CTRL) | USB_HOST_NEED_CLK_EN, USB_CTRL); 285 286 ret = clk_enable(usb_otg_clk); 287 if (ret < 0) { 288 dev_err(&pdev->dev, "failed to start USB DEV Clock\n"); 289 goto fail_otgen; 290 } 291 292 isp1301_configure(); 293 294 hcd = usb_create_hcd(driver, &pdev->dev, dev_name(&pdev->dev)); 295 if (!hcd) { 296 dev_err(&pdev->dev, "Failed to allocate HC buffer\n"); 297 ret = -ENOMEM; 298 goto fail_hcd; 299 } 300 301 res = platform_get_resource(pdev, IORESOURCE_MEM, 0); 302 hcd->regs = devm_ioremap_resource(&pdev->dev, res); 303 if (IS_ERR(hcd->regs)) { 304 ret = PTR_ERR(hcd->regs); 305 goto fail_resource; 306 } 307 hcd->rsrc_start = res->start; 308 hcd->rsrc_len = resource_size(res); 309 310 irq = platform_get_irq(pdev, 0); 311 if (irq < 0) { 312 ret = -ENXIO; 313 goto fail_resource; 314 } 315 316 nxp_start_hc(); 317 platform_set_drvdata(pdev, hcd); 318 ohci = hcd_to_ohci(hcd); 319 ohci_hcd_init(ohci); 320 321 dev_info(&pdev->dev, "at 0x%p, irq %d\n", hcd->regs, hcd->irq); 322 ret = usb_add_hcd(hcd, irq, 0); 323 if (ret == 0) 324 return ret; 325 326 nxp_stop_hc(); 327 fail_resource: 328 usb_put_hcd(hcd); 329 fail_hcd: 330 clk_disable(usb_otg_clk); 331 fail_otgen: 332 clk_put(usb_otg_clk); 333 fail_otg: 334 clk_disable(usb_dev_clk); 335 fail_deven: 336 clk_put(usb_dev_clk); 337 fail_dev: 338 fail_rate: 339 clk_disable(usb_pll_clk); 340 fail_pllen: 341 clk_put(usb_pll_clk); 342 fail_pll: 343 fail_disable: 344 isp1301_i2c_client = NULL; 345 return ret; 346 } 347 348 static int usb_hcd_nxp_remove(struct platform_device *pdev) 349 { 350 struct usb_hcd *hcd = platform_get_drvdata(pdev); 351 352 usb_remove_hcd(hcd); 353 nxp_stop_hc(); 354 usb_put_hcd(hcd); 355 clk_disable(usb_pll_clk); 356 clk_put(usb_pll_clk); 357 clk_disable(usb_dev_clk); 358 clk_put(usb_dev_clk); 359 i2c_unregister_device(isp1301_i2c_client); 360 isp1301_i2c_client = NULL; 361 362 return 0; 363 } 364 365 /* work with hotplug and coldplug */ 366 MODULE_ALIAS("platform:usb-ohci"); 367 368 #ifdef CONFIG_OF 369 static const struct of_device_id usb_hcd_nxp_match[] = { 370 { .compatible = "nxp,ohci-nxp" }, 371 {}, 372 }; 373 MODULE_DEVICE_TABLE(of, usb_hcd_nxp_match); 374 #endif 375 376 static struct platform_driver usb_hcd_nxp_driver = { 377 .driver = { 378 .name = "usb-ohci", 379 .owner = THIS_MODULE, 380 .of_match_table = of_match_ptr(usb_hcd_nxp_match), 381 }, 382 .probe = usb_hcd_nxp_probe, 383 .remove = usb_hcd_nxp_remove, 384 }; 385 386