1 /*- 2 * Copyright (c) 2011 3 * Ben Gray <ben.r.gray@gmail.com>. 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 #include <sys/cdefs.h> 29 __FBSDID("$FreeBSD$"); 30 31 #include <sys/param.h> 32 #include <sys/systm.h> 33 #include <sys/conf.h> 34 #include <sys/kernel.h> 35 #include <sys/rman.h> 36 #include <sys/module.h> 37 38 #include <dev/ofw/ofw_bus_subr.h> 39 40 #include <machine/bus.h> 41 42 #include <arm/ti/ti_prcm.h> 43 #include <arm/ti/usb/omap_usb.h> 44 45 /* 46 * USB TLL Module 47 */ 48 #define OMAP_USBTLL_REVISION 0x0000 49 #define OMAP_USBTLL_SYSCONFIG 0x0010 50 #define OMAP_USBTLL_SYSSTATUS 0x0014 51 #define OMAP_USBTLL_IRQSTATUS 0x0018 52 #define OMAP_USBTLL_IRQENABLE 0x001C 53 #define OMAP_USBTLL_TLL_SHARED_CONF 0x0030 54 #define OMAP_USBTLL_TLL_CHANNEL_CONF(i) (0x0040 + (0x04 * (i))) 55 #define OMAP_USBTLL_SAR_CNTX(i) (0x0400 + (0x04 * (i))) 56 #define OMAP_USBTLL_ULPI_VENDOR_ID_LO(i) (0x0800 + (0x100 * (i))) 57 #define OMAP_USBTLL_ULPI_VENDOR_ID_HI(i) (0x0801 + (0x100 * (i))) 58 #define OMAP_USBTLL_ULPI_PRODUCT_ID_LO(i) (0x0802 + (0x100 * (i))) 59 #define OMAP_USBTLL_ULPI_PRODUCT_ID_HI(i) (0x0803 + (0x100 * (i))) 60 #define OMAP_USBTLL_ULPI_FUNCTION_CTRL(i) (0x0804 + (0x100 * (i))) 61 #define OMAP_USBTLL_ULPI_FUNCTION_CTRL_SET(i) (0x0805 + (0x100 * (i))) 62 #define OMAP_USBTLL_ULPI_FUNCTION_CTRL_CLR(i) (0x0806 + (0x100 * (i))) 63 #define OMAP_USBTLL_ULPI_INTERFACE_CTRL(i) (0x0807 + (0x100 * (i))) 64 #define OMAP_USBTLL_ULPI_INTERFACE_CTRL_SET(i) (0x0808 + (0x100 * (i))) 65 #define OMAP_USBTLL_ULPI_INTERFACE_CTRL_CLR(i) (0x0809 + (0x100 * (i))) 66 #define OMAP_USBTLL_ULPI_OTG_CTRL(i) (0x080A + (0x100 * (i))) 67 #define OMAP_USBTLL_ULPI_OTG_CTRL_SET(i) (0x080B + (0x100 * (i))) 68 #define OMAP_USBTLL_ULPI_OTG_CTRL_CLR(i) (0x080C + (0x100 * (i))) 69 #define OMAP_USBTLL_ULPI_USB_INT_EN_RISE(i) (0x080D + (0x100 * (i))) 70 #define OMAP_USBTLL_ULPI_USB_INT_EN_RISE_SET(i) (0x080E + (0x100 * (i))) 71 #define OMAP_USBTLL_ULPI_USB_INT_EN_RISE_CLR(i) (0x080F + (0x100 * (i))) 72 #define OMAP_USBTLL_ULPI_USB_INT_EN_FALL(i) (0x0810 + (0x100 * (i))) 73 #define OMAP_USBTLL_ULPI_USB_INT_EN_FALL_SET(i) (0x0811 + (0x100 * (i))) 74 #define OMAP_USBTLL_ULPI_USB_INT_EN_FALL_CLR(i) (0x0812 + (0x100 * (i))) 75 #define OMAP_USBTLL_ULPI_USB_INT_STATUS(i) (0x0813 + (0x100 * (i))) 76 #define OMAP_USBTLL_ULPI_USB_INT_LATCH(i) (0x0814 + (0x100 * (i))) 77 #define OMAP_USBTLL_ULPI_DEBUG(i) (0x0815 + (0x100 * (i))) 78 #define OMAP_USBTLL_ULPI_SCRATCH_REGISTER(i) (0x0816 + (0x100 * (i))) 79 #define OMAP_USBTLL_ULPI_SCRATCH_REGISTER_SET(i) (0x0817 + (0x100 * (i))) 80 #define OMAP_USBTLL_ULPI_SCRATCH_REGISTER_CLR(i) (0x0818 + (0x100 * (i))) 81 #define OMAP_USBTLL_ULPI_EXTENDED_SET_ACCESS(i) (0x082F + (0x100 * (i))) 82 #define OMAP_USBTLL_ULPI_UTMI_VCONTROL_EN(i) (0x0830 + (0x100 * (i))) 83 #define OMAP_USBTLL_ULPI_UTMI_VCONTROL_EN_SET(i) (0x0831 + (0x100 * (i))) 84 #define OMAP_USBTLL_ULPI_UTMI_VCONTROL_EN_CLR(i) (0x0832 + (0x100 * (i))) 85 #define OMAP_USBTLL_ULPI_UTMI_VCONTROL_STATUS(i) (0x0833 + (0x100 * (i))) 86 #define OMAP_USBTLL_ULPI_UTMI_VCONTROL_LATCH(i) (0x0834 + (0x100 * (i))) 87 #define OMAP_USBTLL_ULPI_UTMI_VSTATUS(i) (0x0835 + (0x100 * (i))) 88 #define OMAP_USBTLL_ULPI_UTMI_VSTATUS_SET(i) (0x0836 + (0x100 * (i))) 89 #define OMAP_USBTLL_ULPI_UTMI_VSTATUS_CLR(i) (0x0837 + (0x100 * (i))) 90 #define OMAP_USBTLL_ULPI_USB_INT_LATCH_NOCLR(i) (0x0838 + (0x100 * (i))) 91 #define OMAP_USBTLL_ULPI_VENDOR_INT_EN(i) (0x083B + (0x100 * (i))) 92 #define OMAP_USBTLL_ULPI_VENDOR_INT_EN_SET(i) (0x083C + (0x100 * (i))) 93 #define OMAP_USBTLL_ULPI_VENDOR_INT_EN_CLR(i) (0x083D + (0x100 * (i))) 94 #define OMAP_USBTLL_ULPI_VENDOR_INT_STATUS(i) (0x083E + (0x100 * (i))) 95 #define OMAP_USBTLL_ULPI_VENDOR_INT_LATCH(i) (0x083F + (0x100 * (i))) 96 97 /* TLL Register Set */ 98 #define TLL_SYSCONFIG_CACTIVITY (1UL << 8) 99 #define TLL_SYSCONFIG_SIDLE_SMART_IDLE (2UL << 3) 100 #define TLL_SYSCONFIG_SIDLE_NO_IDLE (1UL << 3) 101 #define TLL_SYSCONFIG_SIDLE_FORCED_IDLE (0UL << 3) 102 #define TLL_SYSCONFIG_ENAWAKEUP (1UL << 2) 103 #define TLL_SYSCONFIG_SOFTRESET (1UL << 1) 104 #define TLL_SYSCONFIG_AUTOIDLE (1UL << 0) 105 106 #define TLL_SYSSTATUS_RESETDONE (1UL << 0) 107 108 #define TLL_SHARED_CONF_USB_90D_DDR_EN (1UL << 6) 109 #define TLL_SHARED_CONF_USB_180D_SDR_EN (1UL << 5) 110 #define TLL_SHARED_CONF_USB_DIVRATIO_MASK (7UL << 2) 111 #define TLL_SHARED_CONF_USB_DIVRATIO_128 (7UL << 2) 112 #define TLL_SHARED_CONF_USB_DIVRATIO_64 (6UL << 2) 113 #define TLL_SHARED_CONF_USB_DIVRATIO_32 (5UL << 2) 114 #define TLL_SHARED_CONF_USB_DIVRATIO_16 (4UL << 2) 115 #define TLL_SHARED_CONF_USB_DIVRATIO_8 (3UL << 2) 116 #define TLL_SHARED_CONF_USB_DIVRATIO_4 (2UL << 2) 117 #define TLL_SHARED_CONF_USB_DIVRATIO_2 (1UL << 2) 118 #define TLL_SHARED_CONF_USB_DIVRATIO_1 (0UL << 2) 119 #define TLL_SHARED_CONF_FCLK_REQ (1UL << 1) 120 #define TLL_SHARED_CONF_FCLK_IS_ON (1UL << 0) 121 122 #define TLL_CHANNEL_CONF_DRVVBUS (1UL << 16) 123 #define TLL_CHANNEL_CONF_CHRGVBUS (1UL << 15) 124 #define TLL_CHANNEL_CONF_ULPINOBITSTUFF (1UL << 11) 125 #define TLL_CHANNEL_CONF_ULPIAUTOIDLE (1UL << 10) 126 #define TLL_CHANNEL_CONF_UTMIAUTOIDLE (1UL << 9) 127 #define TLL_CHANNEL_CONF_ULPIDDRMODE (1UL << 8) 128 #define TLL_CHANNEL_CONF_ULPIOUTCLKMODE (1UL << 7) 129 #define TLL_CHANNEL_CONF_TLLFULLSPEED (1UL << 6) 130 #define TLL_CHANNEL_CONF_TLLCONNECT (1UL << 5) 131 #define TLL_CHANNEL_CONF_TLLATTACH (1UL << 4) 132 #define TLL_CHANNEL_CONF_UTMIISADEV (1UL << 3) 133 #define TLL_CHANNEL_CONF_CHANEN (1UL << 0) 134 135 struct omap_tll_softc { 136 device_t sc_dev; 137 138 /* TLL register set */ 139 struct resource* tll_mem_res; 140 int tll_mem_rid; 141 }; 142 143 static struct omap_tll_softc *omap_tll_sc; 144 145 static int omap_tll_attach(device_t dev); 146 static int omap_tll_detach(device_t dev); 147 148 static inline uint32_t 149 omap_tll_read_4(struct omap_tll_softc *sc, bus_size_t off) 150 { 151 return bus_read_4(sc->tll_mem_res, off); 152 } 153 154 static inline void 155 omap_tll_write_4(struct omap_tll_softc *sc, bus_size_t off, uint32_t val) 156 { 157 bus_write_4(sc->tll_mem_res, off, val); 158 } 159 160 void 161 omap_tll_utmi_enable(unsigned int en_mask) 162 { 163 struct omap_tll_softc *sc; 164 unsigned int i; 165 uint32_t reg; 166 167 sc = omap_tll_sc; 168 if (sc == NULL) 169 return; 170 171 /* There are 3 TLL channels, one per USB controller so set them all up the 172 * same, SDR mode, bit stuffing and no autoidle. 173 */ 174 for (i=0; i<3; i++) { 175 reg = omap_tll_read_4(sc, OMAP_USBTLL_TLL_CHANNEL_CONF(i)); 176 177 reg &= ~(TLL_CHANNEL_CONF_UTMIAUTOIDLE 178 | TLL_CHANNEL_CONF_ULPINOBITSTUFF 179 | TLL_CHANNEL_CONF_ULPIDDRMODE); 180 181 omap_tll_write_4(sc, OMAP_USBTLL_TLL_CHANNEL_CONF(i), reg); 182 } 183 184 /* Program the common TLL register */ 185 reg = omap_tll_read_4(sc, OMAP_USBTLL_TLL_SHARED_CONF); 186 187 reg &= ~( TLL_SHARED_CONF_USB_90D_DDR_EN 188 | TLL_SHARED_CONF_USB_DIVRATIO_MASK); 189 reg |= ( TLL_SHARED_CONF_FCLK_IS_ON 190 | TLL_SHARED_CONF_USB_DIVRATIO_2 191 | TLL_SHARED_CONF_USB_180D_SDR_EN); 192 193 omap_tll_write_4(sc, OMAP_USBTLL_TLL_SHARED_CONF, reg); 194 195 /* Enable channels now */ 196 for (i = 0; i < 3; i++) { 197 reg = omap_tll_read_4(sc, OMAP_USBTLL_TLL_CHANNEL_CONF(i)); 198 199 /* Enable only the reg that is needed */ 200 if ((en_mask & (1 << i)) == 0) 201 continue; 202 203 reg |= TLL_CHANNEL_CONF_CHANEN; 204 omap_tll_write_4(sc, OMAP_USBTLL_TLL_CHANNEL_CONF(i), reg); 205 } 206 } 207 208 static int 209 omap_tll_init(struct omap_tll_softc *sc) 210 { 211 unsigned long timeout; 212 int ret = 0; 213 214 /* Enable the USB TLL */ 215 ti_prcm_clk_enable(USBTLL_CLK); 216 217 /* Perform TLL soft reset, and wait until reset is complete */ 218 omap_tll_write_4(sc, OMAP_USBTLL_SYSCONFIG, TLL_SYSCONFIG_SOFTRESET); 219 220 /* Set the timeout to 100ms*/ 221 timeout = (hz < 10) ? 1 : ((100 * hz) / 1000); 222 223 /* Wait for TLL reset to complete */ 224 while ((omap_tll_read_4(sc, OMAP_USBTLL_SYSSTATUS) & 225 TLL_SYSSTATUS_RESETDONE) == 0x00) { 226 227 /* Sleep for a tick */ 228 pause("USBRESET", 1); 229 230 if (timeout-- == 0) { 231 device_printf(sc->sc_dev, "TLL reset operation timed out\n"); 232 ret = EINVAL; 233 goto err_sys_status; 234 } 235 } 236 237 /* CLOCKACTIVITY = 1 : OCP-derived internal clocks ON during idle 238 * SIDLEMODE = 2 : Smart-idle mode. Sidleack asserted after Idlereq 239 * assertion when no more activity on the USB. 240 * ENAWAKEUP = 1 : Wakeup generation enabled 241 */ 242 omap_tll_write_4(sc, OMAP_USBTLL_SYSCONFIG, TLL_SYSCONFIG_ENAWAKEUP | 243 TLL_SYSCONFIG_AUTOIDLE | 244 TLL_SYSCONFIG_SIDLE_SMART_IDLE | 245 TLL_SYSCONFIG_CACTIVITY); 246 247 return(0); 248 249 err_sys_status: 250 /* Disable the TLL clocks */ 251 ti_prcm_clk_disable(USBTLL_CLK); 252 253 return(ret); 254 } 255 256 static void 257 omap_tll_disable(struct omap_tll_softc *sc) 258 { 259 unsigned long timeout; 260 261 timeout = (hz < 10) ? 1 : ((100 * hz) / 1000); 262 263 /* Reset the TLL module */ 264 omap_tll_write_4(sc, OMAP_USBTLL_SYSCONFIG, 0x0002); 265 while ((omap_tll_read_4(sc, OMAP_USBTLL_SYSSTATUS) & (0x01)) == 0x00) { 266 /* Sleep for a tick */ 267 pause("USBRESET", 1); 268 269 if (timeout-- == 0) { 270 device_printf(sc->sc_dev, "operation timed out\n"); 271 break; 272 } 273 } 274 275 /* Disable functional and interface clocks for the TLL and HOST modules */ 276 ti_prcm_clk_disable(USBTLL_CLK); 277 } 278 279 static int 280 omap_tll_probe(device_t dev) 281 { 282 283 if (!ofw_bus_status_okay(dev)) 284 return (ENXIO); 285 286 if (!ofw_bus_is_compatible(dev, "ti,usbhs-tll")) 287 return (ENXIO); 288 289 device_set_desc(dev, "TI OMAP USB 2.0 TLL module"); 290 291 return (BUS_PROBE_DEFAULT); 292 } 293 294 static int 295 omap_tll_attach(device_t dev) 296 { 297 struct omap_tll_softc *sc; 298 299 sc = device_get_softc(dev); 300 /* save the device */ 301 sc->sc_dev = dev; 302 303 /* Allocate resource for the TLL register set */ 304 sc->tll_mem_rid = 0; 305 sc->tll_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, 306 &sc->tll_mem_rid, RF_ACTIVE); 307 if (!sc->tll_mem_res) { 308 device_printf(dev, "Error: Could not map TLL memory\n"); 309 goto error; 310 } 311 312 omap_tll_init(sc); 313 314 omap_tll_sc = sc; 315 316 return (0); 317 318 error: 319 omap_tll_detach(dev); 320 return (ENXIO); 321 } 322 323 static int 324 omap_tll_detach(device_t dev) 325 { 326 struct omap_tll_softc *sc; 327 328 sc = device_get_softc(dev); 329 omap_tll_disable(sc); 330 331 /* Release the other register set memory maps */ 332 if (sc->tll_mem_res) { 333 bus_release_resource(dev, SYS_RES_MEMORY, 334 sc->tll_mem_rid, sc->tll_mem_res); 335 sc->tll_mem_res = NULL; 336 } 337 338 omap_tll_sc = NULL; 339 340 return (0); 341 } 342 343 static device_method_t omap_tll_methods[] = { 344 /* Device interface */ 345 DEVMETHOD(device_probe, omap_tll_probe), 346 DEVMETHOD(device_attach, omap_tll_attach), 347 DEVMETHOD(device_detach, omap_tll_detach), 348 DEVMETHOD(device_suspend, bus_generic_suspend), 349 DEVMETHOD(device_resume, bus_generic_resume), 350 DEVMETHOD(device_shutdown, bus_generic_shutdown), 351 352 {0, 0} 353 }; 354 355 static driver_t omap_tll_driver = { 356 "omap_tll", 357 omap_tll_methods, 358 sizeof(struct omap_tll_softc), 359 }; 360 361 static devclass_t omap_tll_devclass; 362 363 DRIVER_MODULE(omap_tll, simplebus, omap_tll_driver, omap_tll_devclass, 0, 0); 364