1 /* 2 * MUSB OTG driver virtual root hub support 3 * 4 * Copyright 2005 Mentor Graphics Corporation 5 * Copyright (C) 2005-2006 by Texas Instruments 6 * Copyright (C) 2006-2007 Nokia Corporation 7 * 8 * This program is free software; you can redistribute it and/or 9 * modify it under the terms of the GNU General Public License 10 * version 2 as published by the Free Software Foundation. 11 * 12 * This program is distributed in the hope that it will be useful, but 13 * WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 * General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program; if not, write to the Free Software 19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 20 * 02110-1301 USA 21 * 22 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED 23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 25 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 28 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 29 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 * 33 */ 34 35 #include <linux/module.h> 36 #include <linux/kernel.h> 37 #include <linux/sched.h> 38 #include <linux/errno.h> 39 #include <linux/time.h> 40 #include <linux/timer.h> 41 42 #include <asm/unaligned.h> 43 44 #include "musb_core.h" 45 46 void musb_host_finish_resume(struct work_struct *work) 47 { 48 struct musb *musb; 49 unsigned long flags; 50 u8 power; 51 52 musb = container_of(work, struct musb, finish_resume_work.work); 53 54 spin_lock_irqsave(&musb->lock, flags); 55 56 power = musb_readb(musb->mregs, MUSB_POWER); 57 power &= ~MUSB_POWER_RESUME; 58 dev_dbg(musb->controller, "root port resume stopped, power %02x\n", 59 power); 60 musb_writeb(musb->mregs, MUSB_POWER, power); 61 62 /* 63 * ISSUE: DaVinci (RTL 1.300) disconnects after 64 * resume of high speed peripherals (but not full 65 * speed ones). 66 */ 67 musb->is_active = 1; 68 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND | MUSB_PORT_STAT_RESUME); 69 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16; 70 usb_hcd_poll_rh_status(musb->hcd); 71 /* NOTE: it might really be A_WAIT_BCON ... */ 72 musb->xceiv->state = OTG_STATE_A_HOST; 73 74 spin_unlock_irqrestore(&musb->lock, flags); 75 } 76 77 void musb_port_suspend(struct musb *musb, bool do_suspend) 78 { 79 struct usb_otg *otg = musb->xceiv->otg; 80 u8 power; 81 void __iomem *mbase = musb->mregs; 82 83 if (!is_host_active(musb)) 84 return; 85 86 /* NOTE: this doesn't necessarily put PHY into low power mode, 87 * turning off its clock; that's a function of PHY integration and 88 * MUSB_POWER_ENSUSPEND. PHY may need a clock (sigh) to detect 89 * SE0 changing to connect (J) or wakeup (K) states. 90 */ 91 power = musb_readb(mbase, MUSB_POWER); 92 if (do_suspend) { 93 int retries = 10000; 94 95 power &= ~MUSB_POWER_RESUME; 96 power |= MUSB_POWER_SUSPENDM; 97 musb_writeb(mbase, MUSB_POWER, power); 98 99 /* Needed for OPT A tests */ 100 power = musb_readb(mbase, MUSB_POWER); 101 while (power & MUSB_POWER_SUSPENDM) { 102 power = musb_readb(mbase, MUSB_POWER); 103 if (retries-- < 1) 104 break; 105 } 106 107 dev_dbg(musb->controller, "Root port suspended, power %02x\n", power); 108 109 musb->port1_status |= USB_PORT_STAT_SUSPEND; 110 switch (musb->xceiv->state) { 111 case OTG_STATE_A_HOST: 112 musb->xceiv->state = OTG_STATE_A_SUSPEND; 113 musb->is_active = otg->host->b_hnp_enable; 114 if (musb->is_active) 115 mod_timer(&musb->otg_timer, jiffies 116 + msecs_to_jiffies( 117 OTG_TIME_A_AIDL_BDIS)); 118 musb_platform_try_idle(musb, 0); 119 break; 120 case OTG_STATE_B_HOST: 121 musb->xceiv->state = OTG_STATE_B_WAIT_ACON; 122 musb->is_active = otg->host->b_hnp_enable; 123 musb_platform_try_idle(musb, 0); 124 break; 125 default: 126 dev_dbg(musb->controller, "bogus rh suspend? %s\n", 127 usb_otg_state_string(musb->xceiv->state)); 128 } 129 } else if (power & MUSB_POWER_SUSPENDM) { 130 power &= ~MUSB_POWER_SUSPENDM; 131 power |= MUSB_POWER_RESUME; 132 musb_writeb(mbase, MUSB_POWER, power); 133 134 dev_dbg(musb->controller, "Root port resuming, power %02x\n", power); 135 136 /* later, GetPortStatus will stop RESUME signaling */ 137 musb->port1_status |= MUSB_PORT_STAT_RESUME; 138 schedule_delayed_work(&musb->finish_resume_work, 20); 139 } 140 } 141 142 void musb_port_reset(struct musb *musb, bool do_reset) 143 { 144 u8 power; 145 void __iomem *mbase = musb->mregs; 146 147 if (musb->xceiv->state == OTG_STATE_B_IDLE) { 148 dev_dbg(musb->controller, "HNP: Returning from HNP; no hub reset from b_idle\n"); 149 musb->port1_status &= ~USB_PORT_STAT_RESET; 150 return; 151 } 152 153 if (!is_host_active(musb)) 154 return; 155 156 /* NOTE: caller guarantees it will turn off the reset when 157 * the appropriate amount of time has passed 158 */ 159 power = musb_readb(mbase, MUSB_POWER); 160 if (do_reset) { 161 162 /* 163 * If RESUME is set, we must make sure it stays minimum 20 ms. 164 * Then we must clear RESUME and wait a bit to let musb start 165 * generating SOFs. If we don't do this, OPT HS A 6.8 tests 166 * fail with "Error! Did not receive an SOF before suspend 167 * detected". 168 */ 169 if (power & MUSB_POWER_RESUME) { 170 while (time_before(jiffies, musb->rh_timer)) 171 msleep(1); 172 musb_writeb(mbase, MUSB_POWER, 173 power & ~MUSB_POWER_RESUME); 174 msleep(1); 175 } 176 177 power &= 0xf0; 178 musb_writeb(mbase, MUSB_POWER, 179 power | MUSB_POWER_RESET); 180 181 musb->port1_status |= USB_PORT_STAT_RESET; 182 musb->port1_status &= ~USB_PORT_STAT_ENABLE; 183 schedule_delayed_work(&musb->deassert_reset_work, 50); 184 } else { 185 dev_dbg(musb->controller, "root port reset stopped\n"); 186 musb_writeb(mbase, MUSB_POWER, 187 power & ~MUSB_POWER_RESET); 188 189 power = musb_readb(mbase, MUSB_POWER); 190 if (power & MUSB_POWER_HSMODE) { 191 dev_dbg(musb->controller, "high-speed device connected\n"); 192 musb->port1_status |= USB_PORT_STAT_HIGH_SPEED; 193 } 194 195 musb->port1_status &= ~USB_PORT_STAT_RESET; 196 musb->port1_status |= USB_PORT_STAT_ENABLE 197 | (USB_PORT_STAT_C_RESET << 16) 198 | (USB_PORT_STAT_C_ENABLE << 16); 199 usb_hcd_poll_rh_status(musb->hcd); 200 201 musb->vbuserr_retry = VBUSERR_RETRY_COUNT; 202 } 203 } 204 205 void musb_root_disconnect(struct musb *musb) 206 { 207 struct usb_otg *otg = musb->xceiv->otg; 208 209 musb->port1_status = USB_PORT_STAT_POWER 210 | (USB_PORT_STAT_C_CONNECTION << 16); 211 212 usb_hcd_poll_rh_status(musb->hcd); 213 musb->is_active = 0; 214 215 switch (musb->xceiv->state) { 216 case OTG_STATE_A_SUSPEND: 217 if (otg->host->b_hnp_enable) { 218 musb->xceiv->state = OTG_STATE_A_PERIPHERAL; 219 musb->g.is_a_peripheral = 1; 220 break; 221 } 222 /* FALLTHROUGH */ 223 case OTG_STATE_A_HOST: 224 musb->xceiv->state = OTG_STATE_A_WAIT_BCON; 225 musb->is_active = 0; 226 break; 227 case OTG_STATE_A_WAIT_VFALL: 228 musb->xceiv->state = OTG_STATE_B_IDLE; 229 break; 230 default: 231 dev_dbg(musb->controller, "host disconnect (%s)\n", 232 usb_otg_state_string(musb->xceiv->state)); 233 } 234 } 235 236 237 /*---------------------------------------------------------------------*/ 238 239 /* Caller may or may not hold musb->lock */ 240 int musb_hub_status_data(struct usb_hcd *hcd, char *buf) 241 { 242 struct musb *musb = hcd_to_musb(hcd); 243 int retval = 0; 244 245 /* called in_irq() via usb_hcd_poll_rh_status() */ 246 if (musb->port1_status & 0xffff0000) { 247 *buf = 0x02; 248 retval = 1; 249 } 250 return retval; 251 } 252 253 static int musb_has_gadget(struct musb *musb) 254 { 255 /* 256 * In host-only mode we start a connection right away. In OTG mode 257 * we have to wait until we loaded a gadget. We don't really need a 258 * gadget if we operate as a host but we should not start a session 259 * as a device without a gadget or else we explode. 260 */ 261 #ifdef CONFIG_USB_MUSB_HOST 262 return 1; 263 #else 264 if (musb->port_mode == MUSB_PORT_MODE_HOST) 265 return 1; 266 return musb->g.dev.driver != NULL; 267 #endif 268 } 269 270 int musb_hub_control( 271 struct usb_hcd *hcd, 272 u16 typeReq, 273 u16 wValue, 274 u16 wIndex, 275 char *buf, 276 u16 wLength) 277 { 278 struct musb *musb = hcd_to_musb(hcd); 279 u32 temp; 280 int retval = 0; 281 unsigned long flags; 282 283 spin_lock_irqsave(&musb->lock, flags); 284 285 if (unlikely(!HCD_HW_ACCESSIBLE(hcd))) { 286 spin_unlock_irqrestore(&musb->lock, flags); 287 return -ESHUTDOWN; 288 } 289 290 /* hub features: always zero, setting is a NOP 291 * port features: reported, sometimes updated when host is active 292 * no indicators 293 */ 294 switch (typeReq) { 295 case ClearHubFeature: 296 case SetHubFeature: 297 switch (wValue) { 298 case C_HUB_OVER_CURRENT: 299 case C_HUB_LOCAL_POWER: 300 break; 301 default: 302 goto error; 303 } 304 break; 305 case ClearPortFeature: 306 if ((wIndex & 0xff) != 1) 307 goto error; 308 309 switch (wValue) { 310 case USB_PORT_FEAT_ENABLE: 311 break; 312 case USB_PORT_FEAT_SUSPEND: 313 musb_port_suspend(musb, false); 314 break; 315 case USB_PORT_FEAT_POWER: 316 if (!hcd->self.is_b_host) 317 musb_platform_set_vbus(musb, 0); 318 break; 319 case USB_PORT_FEAT_C_CONNECTION: 320 case USB_PORT_FEAT_C_ENABLE: 321 case USB_PORT_FEAT_C_OVER_CURRENT: 322 case USB_PORT_FEAT_C_RESET: 323 case USB_PORT_FEAT_C_SUSPEND: 324 break; 325 default: 326 goto error; 327 } 328 dev_dbg(musb->controller, "clear feature %d\n", wValue); 329 musb->port1_status &= ~(1 << wValue); 330 break; 331 case GetHubDescriptor: 332 { 333 struct usb_hub_descriptor *desc = (void *)buf; 334 335 desc->bDescLength = 9; 336 desc->bDescriptorType = 0x29; 337 desc->bNbrPorts = 1; 338 desc->wHubCharacteristics = cpu_to_le16( 339 0x0001 /* per-port power switching */ 340 | 0x0010 /* no overcurrent reporting */ 341 ); 342 desc->bPwrOn2PwrGood = 5; /* msec/2 */ 343 desc->bHubContrCurrent = 0; 344 345 /* workaround bogus struct definition */ 346 desc->u.hs.DeviceRemovable[0] = 0x02; /* port 1 */ 347 desc->u.hs.DeviceRemovable[1] = 0xff; 348 } 349 break; 350 case GetHubStatus: 351 temp = 0; 352 *(__le32 *) buf = cpu_to_le32(temp); 353 break; 354 case GetPortStatus: 355 if (wIndex != 1) 356 goto error; 357 358 put_unaligned(cpu_to_le32(musb->port1_status 359 & ~MUSB_PORT_STAT_RESUME), 360 (__le32 *) buf); 361 362 /* port change status is more interesting */ 363 dev_dbg(musb->controller, "port status %08x\n", 364 musb->port1_status); 365 break; 366 case SetPortFeature: 367 if ((wIndex & 0xff) != 1) 368 goto error; 369 370 switch (wValue) { 371 case USB_PORT_FEAT_POWER: 372 /* NOTE: this controller has a strange state machine 373 * that involves "requesting sessions" according to 374 * magic side effects from incompletely-described 375 * rules about startup... 376 * 377 * This call is what really starts the host mode; be 378 * very careful about side effects if you reorder any 379 * initialization logic, e.g. for OTG, or change any 380 * logic relating to VBUS power-up. 381 */ 382 if (!hcd->self.is_b_host && musb_has_gadget(musb)) 383 musb_start(musb); 384 break; 385 case USB_PORT_FEAT_RESET: 386 musb_port_reset(musb, true); 387 break; 388 case USB_PORT_FEAT_SUSPEND: 389 musb_port_suspend(musb, true); 390 break; 391 case USB_PORT_FEAT_TEST: 392 if (unlikely(is_host_active(musb))) 393 goto error; 394 395 wIndex >>= 8; 396 switch (wIndex) { 397 case 1: 398 pr_debug("TEST_J\n"); 399 temp = MUSB_TEST_J; 400 break; 401 case 2: 402 pr_debug("TEST_K\n"); 403 temp = MUSB_TEST_K; 404 break; 405 case 3: 406 pr_debug("TEST_SE0_NAK\n"); 407 temp = MUSB_TEST_SE0_NAK; 408 break; 409 case 4: 410 pr_debug("TEST_PACKET\n"); 411 temp = MUSB_TEST_PACKET; 412 musb_load_testpacket(musb); 413 break; 414 case 5: 415 pr_debug("TEST_FORCE_ENABLE\n"); 416 temp = MUSB_TEST_FORCE_HOST 417 | MUSB_TEST_FORCE_HS; 418 419 musb_writeb(musb->mregs, MUSB_DEVCTL, 420 MUSB_DEVCTL_SESSION); 421 break; 422 case 6: 423 pr_debug("TEST_FIFO_ACCESS\n"); 424 temp = MUSB_TEST_FIFO_ACCESS; 425 break; 426 default: 427 goto error; 428 } 429 musb_writeb(musb->mregs, MUSB_TESTMODE, temp); 430 break; 431 default: 432 goto error; 433 } 434 dev_dbg(musb->controller, "set feature %d\n", wValue); 435 musb->port1_status |= 1 << wValue; 436 break; 437 438 default: 439 error: 440 /* "protocol stall" on error */ 441 retval = -EPIPE; 442 } 443 spin_unlock_irqrestore(&musb->lock, flags); 444 return retval; 445 } 446