musb_virthub.c revision 1de00dae8036dfee44ebea2c38f942fb6072e0b7
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/slab.h> 39#include <linux/errno.h> 40#include <linux/init.h> 41#include <linux/time.h> 42#include <linux/timer.h> 43 44#include <asm/unaligned.h> 45 46#include "musb_core.h" 47 48 49static void musb_port_suspend(struct musb *musb, bool do_suspend) 50{ 51 u8 power; 52 void __iomem *mbase = musb->mregs; 53 54 if (!is_host_active(musb)) 55 return; 56 57 /* NOTE: this doesn't necessarily put PHY into low power mode, 58 * turning off its clock; that's a function of PHY integration and 59 * MUSB_POWER_ENSUSPEND. PHY may need a clock (sigh) to detect 60 * SE0 changing to connect (J) or wakeup (K) states. 61 */ 62 power = musb_readb(mbase, MUSB_POWER); 63 if (do_suspend) { 64 int retries = 10000; 65 66 power &= ~MUSB_POWER_RESUME; 67 power |= MUSB_POWER_SUSPENDM; 68 musb_writeb(mbase, MUSB_POWER, power); 69 70 /* Needed for OPT A tests */ 71 power = musb_readb(mbase, MUSB_POWER); 72 while (power & MUSB_POWER_SUSPENDM) { 73 power = musb_readb(mbase, MUSB_POWER); 74 if (retries-- < 1) 75 break; 76 } 77 78 DBG(3, "Root port suspended, power %02x\n", power); 79 80 musb->port1_status |= USB_PORT_STAT_SUSPEND; 81 switch (musb->xceiv->state) { 82 case OTG_STATE_A_HOST: 83 musb->xceiv->state = OTG_STATE_A_SUSPEND; 84 musb->is_active = is_otg_enabled(musb) 85 && musb->xceiv->host->b_hnp_enable; 86 musb_platform_try_idle(musb, 0); 87 break; 88#ifdef CONFIG_USB_MUSB_OTG 89 case OTG_STATE_B_HOST: 90 musb->xceiv->state = OTG_STATE_B_WAIT_ACON; 91 musb->is_active = is_otg_enabled(musb) 92 && musb->xceiv->host->b_hnp_enable; 93 musb_platform_try_idle(musb, 0); 94 break; 95#endif 96 default: 97 DBG(1, "bogus rh suspend? %s\n", 98 otg_state_string(musb)); 99 } 100 } else if (power & MUSB_POWER_SUSPENDM) { 101 power &= ~MUSB_POWER_SUSPENDM; 102 power |= MUSB_POWER_RESUME; 103 musb_writeb(mbase, MUSB_POWER, power); 104 105 DBG(3, "Root port resuming, power %02x\n", power); 106 107 /* later, GetPortStatus will stop RESUME signaling */ 108 musb->port1_status |= MUSB_PORT_STAT_RESUME; 109 musb->rh_timer = jiffies + msecs_to_jiffies(20); 110 } 111} 112 113static void musb_port_reset(struct musb *musb, bool do_reset) 114{ 115 u8 power; 116 void __iomem *mbase = musb->mregs; 117 118#ifdef CONFIG_USB_MUSB_OTG 119 if (musb->xceiv->state == OTG_STATE_B_IDLE) { 120 DBG(2, "HNP: Returning from HNP; no hub reset from b_idle\n"); 121 musb->port1_status &= ~USB_PORT_STAT_RESET; 122 return; 123 } 124#endif 125 126 if (!is_host_active(musb)) 127 return; 128 129 /* NOTE: caller guarantees it will turn off the reset when 130 * the appropriate amount of time has passed 131 */ 132 power = musb_readb(mbase, MUSB_POWER); 133 if (do_reset) { 134 135 /* 136 * If RESUME is set, we must make sure it stays minimum 20 ms. 137 * Then we must clear RESUME and wait a bit to let musb start 138 * generating SOFs. If we don't do this, OPT HS A 6.8 tests 139 * fail with "Error! Did not receive an SOF before suspend 140 * detected". 141 */ 142 if (power & MUSB_POWER_RESUME) { 143 while (time_before(jiffies, musb->rh_timer)) 144 msleep(1); 145 musb_writeb(mbase, MUSB_POWER, 146 power & ~MUSB_POWER_RESUME); 147 msleep(1); 148 } 149 150 musb->ignore_disconnect = true; 151 power &= 0xf0; 152 musb_writeb(mbase, MUSB_POWER, 153 power | MUSB_POWER_RESET); 154 155 musb->port1_status |= USB_PORT_STAT_RESET; 156 musb->port1_status &= ~USB_PORT_STAT_ENABLE; 157 musb->rh_timer = jiffies + msecs_to_jiffies(50); 158 } else { 159 DBG(4, "root port reset stopped\n"); 160 musb_writeb(mbase, MUSB_POWER, 161 power & ~MUSB_POWER_RESET); 162 163 musb->ignore_disconnect = false; 164 165 power = musb_readb(mbase, MUSB_POWER); 166 if (power & MUSB_POWER_HSMODE) { 167 DBG(4, "high-speed device connected\n"); 168 musb->port1_status |= USB_PORT_STAT_HIGH_SPEED; 169 } 170 171 musb->port1_status &= ~USB_PORT_STAT_RESET; 172 musb->port1_status |= USB_PORT_STAT_ENABLE 173 | (USB_PORT_STAT_C_RESET << 16) 174 | (USB_PORT_STAT_C_ENABLE << 16); 175 usb_hcd_poll_rh_status(musb_to_hcd(musb)); 176 177 musb->vbuserr_retry = VBUSERR_RETRY_COUNT; 178 } 179} 180 181void musb_root_disconnect(struct musb *musb) 182{ 183 musb->port1_status = (1 << USB_PORT_FEAT_POWER) 184 | (1 << USB_PORT_FEAT_C_CONNECTION); 185 186 usb_hcd_poll_rh_status(musb_to_hcd(musb)); 187 musb->is_active = 0; 188 189 switch (musb->xceiv->state) { 190 case OTG_STATE_A_SUSPEND: 191#ifdef CONFIG_USB_MUSB_OTG 192 if (is_otg_enabled(musb) 193 && musb->xceiv->host->b_hnp_enable) { 194 musb->xceiv->state = OTG_STATE_A_PERIPHERAL; 195 musb->g.is_a_peripheral = 1; 196 break; 197 } 198#endif 199 /* FALLTHROUGH */ 200 case OTG_STATE_A_HOST: 201 musb->xceiv->state = OTG_STATE_A_WAIT_BCON; 202 musb->is_active = 0; 203 break; 204 case OTG_STATE_A_WAIT_VFALL: 205 musb->xceiv->state = OTG_STATE_B_IDLE; 206 break; 207 default: 208 DBG(1, "host disconnect (%s)\n", otg_state_string(musb)); 209 } 210} 211 212 213/*---------------------------------------------------------------------*/ 214 215/* Caller may or may not hold musb->lock */ 216int musb_hub_status_data(struct usb_hcd *hcd, char *buf) 217{ 218 struct musb *musb = hcd_to_musb(hcd); 219 int retval = 0; 220 221 /* called in_irq() via usb_hcd_poll_rh_status() */ 222 if (musb->port1_status & 0xffff0000) { 223 *buf = 0x02; 224 retval = 1; 225 } 226 return retval; 227} 228 229int musb_hub_control( 230 struct usb_hcd *hcd, 231 u16 typeReq, 232 u16 wValue, 233 u16 wIndex, 234 char *buf, 235 u16 wLength) 236{ 237 struct musb *musb = hcd_to_musb(hcd); 238 u32 temp; 239 int retval = 0; 240 unsigned long flags; 241 242 spin_lock_irqsave(&musb->lock, flags); 243 244 if (unlikely(!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))) { 245 spin_unlock_irqrestore(&musb->lock, flags); 246 return -ESHUTDOWN; 247 } 248 249 /* hub features: always zero, setting is a NOP 250 * port features: reported, sometimes updated when host is active 251 * no indicators 252 */ 253 switch (typeReq) { 254 case ClearHubFeature: 255 case SetHubFeature: 256 switch (wValue) { 257 case C_HUB_OVER_CURRENT: 258 case C_HUB_LOCAL_POWER: 259 break; 260 default: 261 goto error; 262 } 263 break; 264 case ClearPortFeature: 265 if ((wIndex & 0xff) != 1) 266 goto error; 267 268 switch (wValue) { 269 case USB_PORT_FEAT_ENABLE: 270 break; 271 case USB_PORT_FEAT_SUSPEND: 272 musb_port_suspend(musb, false); 273 break; 274 case USB_PORT_FEAT_POWER: 275 if (!(is_otg_enabled(musb) && hcd->self.is_b_host)) 276 musb_set_vbus(musb, 0); 277 break; 278 case USB_PORT_FEAT_C_CONNECTION: 279 case USB_PORT_FEAT_C_ENABLE: 280 case USB_PORT_FEAT_C_OVER_CURRENT: 281 case USB_PORT_FEAT_C_RESET: 282 case USB_PORT_FEAT_C_SUSPEND: 283 break; 284 default: 285 goto error; 286 } 287 DBG(5, "clear feature %d\n", wValue); 288 musb->port1_status &= ~(1 << wValue); 289 break; 290 case GetHubDescriptor: 291 { 292 struct usb_hub_descriptor *desc = (void *)buf; 293 294 desc->bDescLength = 9; 295 desc->bDescriptorType = 0x29; 296 desc->bNbrPorts = 1; 297 desc->wHubCharacteristics = cpu_to_le16( 298 0x0001 /* per-port power switching */ 299 | 0x0010 /* no overcurrent reporting */ 300 ); 301 desc->bPwrOn2PwrGood = 5; /* msec/2 */ 302 desc->bHubContrCurrent = 0; 303 304 /* workaround bogus struct definition */ 305 desc->DeviceRemovable[0] = 0x02; /* port 1 */ 306 desc->DeviceRemovable[1] = 0xff; 307 } 308 break; 309 case GetHubStatus: 310 temp = 0; 311 *(__le32 *) buf = cpu_to_le32(temp); 312 break; 313 case GetPortStatus: 314 if (wIndex != 1) 315 goto error; 316 317 /* finish RESET signaling? */ 318 if ((musb->port1_status & USB_PORT_STAT_RESET) 319 && time_after_eq(jiffies, musb->rh_timer)) 320 musb_port_reset(musb, false); 321 322 /* finish RESUME signaling? */ 323 if ((musb->port1_status & MUSB_PORT_STAT_RESUME) 324 && time_after_eq(jiffies, musb->rh_timer)) { 325 u8 power; 326 327 power = musb_readb(musb->mregs, MUSB_POWER); 328 power &= ~MUSB_POWER_RESUME; 329 DBG(4, "root port resume stopped, power %02x\n", 330 power); 331 musb_writeb(musb->mregs, MUSB_POWER, power); 332 333 /* ISSUE: DaVinci (RTL 1.300) disconnects after 334 * resume of high speed peripherals (but not full 335 * speed ones). 336 */ 337 338 musb->is_active = 1; 339 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND 340 | MUSB_PORT_STAT_RESUME); 341 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16; 342 usb_hcd_poll_rh_status(musb_to_hcd(musb)); 343 /* NOTE: it might really be A_WAIT_BCON ... */ 344 musb->xceiv->state = OTG_STATE_A_HOST; 345 } 346 347 put_unaligned(cpu_to_le32(musb->port1_status 348 & ~MUSB_PORT_STAT_RESUME), 349 (__le32 *) buf); 350 351 /* port change status is more interesting */ 352 DBG(get_unaligned((u16 *)(buf+2)) ? 2 : 5, "port status %08x\n", 353 musb->port1_status); 354 break; 355 case SetPortFeature: 356 if ((wIndex & 0xff) != 1) 357 goto error; 358 359 switch (wValue) { 360 case USB_PORT_FEAT_POWER: 361 /* NOTE: this controller has a strange state machine 362 * that involves "requesting sessions" according to 363 * magic side effects from incompletely-described 364 * rules about startup... 365 * 366 * This call is what really starts the host mode; be 367 * very careful about side effects if you reorder any 368 * initialization logic, e.g. for OTG, or change any 369 * logic relating to VBUS power-up. 370 */ 371 if (!(is_otg_enabled(musb) && hcd->self.is_b_host)) 372 musb_start(musb); 373 break; 374 case USB_PORT_FEAT_RESET: 375 musb_port_reset(musb, true); 376 break; 377 case USB_PORT_FEAT_SUSPEND: 378 musb_port_suspend(musb, true); 379 break; 380 case USB_PORT_FEAT_TEST: 381 if (unlikely(is_host_active(musb))) 382 goto error; 383 384 wIndex >>= 8; 385 switch (wIndex) { 386 case 1: 387 pr_debug("TEST_J\n"); 388 temp = MUSB_TEST_J; 389 break; 390 case 2: 391 pr_debug("TEST_K\n"); 392 temp = MUSB_TEST_K; 393 break; 394 case 3: 395 pr_debug("TEST_SE0_NAK\n"); 396 temp = MUSB_TEST_SE0_NAK; 397 break; 398 case 4: 399 pr_debug("TEST_PACKET\n"); 400 temp = MUSB_TEST_PACKET; 401 musb_load_testpacket(musb); 402 break; 403 case 5: 404 pr_debug("TEST_FORCE_ENABLE\n"); 405 temp = MUSB_TEST_FORCE_HOST 406 | MUSB_TEST_FORCE_HS; 407 408 musb_writeb(musb->mregs, MUSB_DEVCTL, 409 MUSB_DEVCTL_SESSION); 410 break; 411 case 6: 412 pr_debug("TEST_FIFO_ACCESS\n"); 413 temp = MUSB_TEST_FIFO_ACCESS; 414 break; 415 default: 416 goto error; 417 } 418 musb_writeb(musb->mregs, MUSB_TESTMODE, temp); 419 break; 420 default: 421 goto error; 422 } 423 DBG(5, "set feature %d\n", wValue); 424 musb->port1_status |= 1 << wValue; 425 break; 426 427 default: 428error: 429 /* "protocol stall" on error */ 430 retval = -EPIPE; 431 } 432 spin_unlock_irqrestore(&musb->lock, flags); 433 return retval; 434} 435