musb_virthub.c revision 30d361bf0f81ece8de42c5e0a4e560270ad72b65
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 46void 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 77void 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 142void 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 * If RESUME is set, we must make sure it stays minimum 20 ms. 163 * Then we must clear RESUME and wait a bit to let musb start 164 * generating SOFs. If we don't do this, OPT HS A 6.8 tests 165 * fail with "Error! Did not receive an SOF before suspend 166 * detected". 167 */ 168 if (power & MUSB_POWER_RESUME) { 169 long remain = (unsigned long) musb->rh_timer - jiffies; 170 171 if (musb->rh_timer > 0 && remain > 0) { 172 /* take into account the minimum delay after resume */ 173 schedule_delayed_work( 174 &musb->deassert_reset_work, 175 jiffies_to_msecs(remain)); 176 return; 177 } 178 179 musb_writeb(mbase, MUSB_POWER, 180 power & ~MUSB_POWER_RESUME); 181 182 /* Give the core 1 ms to clear MUSB_POWER_RESUME */ 183 schedule_delayed_work(&musb->deassert_reset_work, 1); 184 return; 185 } 186 187 power &= 0xf0; 188 musb_writeb(mbase, MUSB_POWER, 189 power | MUSB_POWER_RESET); 190 191 musb->port1_status |= USB_PORT_STAT_RESET; 192 musb->port1_status &= ~USB_PORT_STAT_ENABLE; 193 schedule_delayed_work(&musb->deassert_reset_work, 50); 194 } else { 195 dev_dbg(musb->controller, "root port reset stopped\n"); 196 musb_writeb(mbase, MUSB_POWER, 197 power & ~MUSB_POWER_RESET); 198 199 power = musb_readb(mbase, MUSB_POWER); 200 if (power & MUSB_POWER_HSMODE) { 201 dev_dbg(musb->controller, "high-speed device connected\n"); 202 musb->port1_status |= USB_PORT_STAT_HIGH_SPEED; 203 } 204 205 musb->port1_status &= ~USB_PORT_STAT_RESET; 206 musb->port1_status |= USB_PORT_STAT_ENABLE 207 | (USB_PORT_STAT_C_RESET << 16) 208 | (USB_PORT_STAT_C_ENABLE << 16); 209 usb_hcd_poll_rh_status(musb->hcd); 210 211 musb->vbuserr_retry = VBUSERR_RETRY_COUNT; 212 } 213} 214 215void musb_root_disconnect(struct musb *musb) 216{ 217 struct usb_otg *otg = musb->xceiv->otg; 218 219 musb->port1_status = USB_PORT_STAT_POWER 220 | (USB_PORT_STAT_C_CONNECTION << 16); 221 222 usb_hcd_poll_rh_status(musb->hcd); 223 musb->is_active = 0; 224 225 switch (musb->xceiv->state) { 226 case OTG_STATE_A_SUSPEND: 227 if (otg->host->b_hnp_enable) { 228 musb->xceiv->state = OTG_STATE_A_PERIPHERAL; 229 musb->g.is_a_peripheral = 1; 230 break; 231 } 232 /* FALLTHROUGH */ 233 case OTG_STATE_A_HOST: 234 musb->xceiv->state = OTG_STATE_A_WAIT_BCON; 235 musb->is_active = 0; 236 break; 237 case OTG_STATE_A_WAIT_VFALL: 238 musb->xceiv->state = OTG_STATE_B_IDLE; 239 break; 240 default: 241 dev_dbg(musb->controller, "host disconnect (%s)\n", 242 usb_otg_state_string(musb->xceiv->state)); 243 } 244} 245 246 247/*---------------------------------------------------------------------*/ 248 249/* Caller may or may not hold musb->lock */ 250int musb_hub_status_data(struct usb_hcd *hcd, char *buf) 251{ 252 struct musb *musb = hcd_to_musb(hcd); 253 int retval = 0; 254 255 /* called in_irq() via usb_hcd_poll_rh_status() */ 256 if (musb->port1_status & 0xffff0000) { 257 *buf = 0x02; 258 retval = 1; 259 } 260 return retval; 261} 262 263static int musb_has_gadget(struct musb *musb) 264{ 265 /* 266 * In host-only mode we start a connection right away. In OTG mode 267 * we have to wait until we loaded a gadget. We don't really need a 268 * gadget if we operate as a host but we should not start a session 269 * as a device without a gadget or else we explode. 270 */ 271#ifdef CONFIG_USB_MUSB_HOST 272 return 1; 273#else 274 if (musb->port_mode == MUSB_PORT_MODE_HOST) 275 return 1; 276 return musb->g.dev.driver != NULL; 277#endif 278} 279 280int musb_hub_control( 281 struct usb_hcd *hcd, 282 u16 typeReq, 283 u16 wValue, 284 u16 wIndex, 285 char *buf, 286 u16 wLength) 287{ 288 struct musb *musb = hcd_to_musb(hcd); 289 u32 temp; 290 int retval = 0; 291 unsigned long flags; 292 293 spin_lock_irqsave(&musb->lock, flags); 294 295 if (unlikely(!HCD_HW_ACCESSIBLE(hcd))) { 296 spin_unlock_irqrestore(&musb->lock, flags); 297 return -ESHUTDOWN; 298 } 299 300 /* hub features: always zero, setting is a NOP 301 * port features: reported, sometimes updated when host is active 302 * no indicators 303 */ 304 switch (typeReq) { 305 case ClearHubFeature: 306 case SetHubFeature: 307 switch (wValue) { 308 case C_HUB_OVER_CURRENT: 309 case C_HUB_LOCAL_POWER: 310 break; 311 default: 312 goto error; 313 } 314 break; 315 case ClearPortFeature: 316 if ((wIndex & 0xff) != 1) 317 goto error; 318 319 switch (wValue) { 320 case USB_PORT_FEAT_ENABLE: 321 break; 322 case USB_PORT_FEAT_SUSPEND: 323 musb_port_suspend(musb, false); 324 break; 325 case USB_PORT_FEAT_POWER: 326 if (!hcd->self.is_b_host) 327 musb_platform_set_vbus(musb, 0); 328 break; 329 case USB_PORT_FEAT_C_CONNECTION: 330 case USB_PORT_FEAT_C_ENABLE: 331 case USB_PORT_FEAT_C_OVER_CURRENT: 332 case USB_PORT_FEAT_C_RESET: 333 case USB_PORT_FEAT_C_SUSPEND: 334 break; 335 default: 336 goto error; 337 } 338 dev_dbg(musb->controller, "clear feature %d\n", wValue); 339 musb->port1_status &= ~(1 << wValue); 340 break; 341 case GetHubDescriptor: 342 { 343 struct usb_hub_descriptor *desc = (void *)buf; 344 345 desc->bDescLength = 9; 346 desc->bDescriptorType = 0x29; 347 desc->bNbrPorts = 1; 348 desc->wHubCharacteristics = cpu_to_le16( 349 0x0001 /* per-port power switching */ 350 | 0x0010 /* no overcurrent reporting */ 351 ); 352 desc->bPwrOn2PwrGood = 5; /* msec/2 */ 353 desc->bHubContrCurrent = 0; 354 355 /* workaround bogus struct definition */ 356 desc->u.hs.DeviceRemovable[0] = 0x02; /* port 1 */ 357 desc->u.hs.DeviceRemovable[1] = 0xff; 358 } 359 break; 360 case GetHubStatus: 361 temp = 0; 362 *(__le32 *) buf = cpu_to_le32(temp); 363 break; 364 case GetPortStatus: 365 if (wIndex != 1) 366 goto error; 367 368 put_unaligned(cpu_to_le32(musb->port1_status 369 & ~MUSB_PORT_STAT_RESUME), 370 (__le32 *) buf); 371 372 /* port change status is more interesting */ 373 dev_dbg(musb->controller, "port status %08x\n", 374 musb->port1_status); 375 break; 376 case SetPortFeature: 377 if ((wIndex & 0xff) != 1) 378 goto error; 379 380 switch (wValue) { 381 case USB_PORT_FEAT_POWER: 382 /* NOTE: this controller has a strange state machine 383 * that involves "requesting sessions" according to 384 * magic side effects from incompletely-described 385 * rules about startup... 386 * 387 * This call is what really starts the host mode; be 388 * very careful about side effects if you reorder any 389 * initialization logic, e.g. for OTG, or change any 390 * logic relating to VBUS power-up. 391 */ 392 if (!hcd->self.is_b_host && musb_has_gadget(musb)) 393 musb_start(musb); 394 break; 395 case USB_PORT_FEAT_RESET: 396 musb_port_reset(musb, true); 397 break; 398 case USB_PORT_FEAT_SUSPEND: 399 musb_port_suspend(musb, true); 400 break; 401 case USB_PORT_FEAT_TEST: 402 if (unlikely(is_host_active(musb))) 403 goto error; 404 405 wIndex >>= 8; 406 switch (wIndex) { 407 case 1: 408 pr_debug("TEST_J\n"); 409 temp = MUSB_TEST_J; 410 break; 411 case 2: 412 pr_debug("TEST_K\n"); 413 temp = MUSB_TEST_K; 414 break; 415 case 3: 416 pr_debug("TEST_SE0_NAK\n"); 417 temp = MUSB_TEST_SE0_NAK; 418 break; 419 case 4: 420 pr_debug("TEST_PACKET\n"); 421 temp = MUSB_TEST_PACKET; 422 musb_load_testpacket(musb); 423 break; 424 case 5: 425 pr_debug("TEST_FORCE_ENABLE\n"); 426 temp = MUSB_TEST_FORCE_HOST 427 | MUSB_TEST_FORCE_HS; 428 429 musb_writeb(musb->mregs, MUSB_DEVCTL, 430 MUSB_DEVCTL_SESSION); 431 break; 432 case 6: 433 pr_debug("TEST_FIFO_ACCESS\n"); 434 temp = MUSB_TEST_FIFO_ACCESS; 435 break; 436 default: 437 goto error; 438 } 439 musb_writeb(musb->mregs, MUSB_TESTMODE, temp); 440 break; 441 default: 442 goto error; 443 } 444 dev_dbg(musb->controller, "set feature %d\n", wValue); 445 musb->port1_status |= 1 << wValue; 446 break; 447 448 default: 449error: 450 /* "protocol stall" on error */ 451 retval = -EPIPE; 452 } 453 spin_unlock_irqrestore(&musb->lock, flags); 454 return retval; 455} 456