musb_virthub.c revision 84e250ffa76dddc1bad84e04248a27f442c25986
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_HOST: 191 case OTG_STATE_A_SUSPEND: 192 musb->xceiv->state = OTG_STATE_A_WAIT_BCON; 193 musb->is_active = 0; 194 break; 195 case OTG_STATE_A_WAIT_VFALL: 196 musb->xceiv->state = OTG_STATE_B_IDLE; 197 break; 198 default: 199 DBG(1, "host disconnect (%s)\n", otg_state_string(musb)); 200 } 201} 202 203 204/*---------------------------------------------------------------------*/ 205 206/* Caller may or may not hold musb->lock */ 207int musb_hub_status_data(struct usb_hcd *hcd, char *buf) 208{ 209 struct musb *musb = hcd_to_musb(hcd); 210 int retval = 0; 211 212 /* called in_irq() via usb_hcd_poll_rh_status() */ 213 if (musb->port1_status & 0xffff0000) { 214 *buf = 0x02; 215 retval = 1; 216 } 217 return retval; 218} 219 220int musb_hub_control( 221 struct usb_hcd *hcd, 222 u16 typeReq, 223 u16 wValue, 224 u16 wIndex, 225 char *buf, 226 u16 wLength) 227{ 228 struct musb *musb = hcd_to_musb(hcd); 229 u32 temp; 230 int retval = 0; 231 unsigned long flags; 232 233 spin_lock_irqsave(&musb->lock, flags); 234 235 if (unlikely(!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))) { 236 spin_unlock_irqrestore(&musb->lock, flags); 237 return -ESHUTDOWN; 238 } 239 240 /* hub features: always zero, setting is a NOP 241 * port features: reported, sometimes updated when host is active 242 * no indicators 243 */ 244 switch (typeReq) { 245 case ClearHubFeature: 246 case SetHubFeature: 247 switch (wValue) { 248 case C_HUB_OVER_CURRENT: 249 case C_HUB_LOCAL_POWER: 250 break; 251 default: 252 goto error; 253 } 254 break; 255 case ClearPortFeature: 256 if ((wIndex & 0xff) != 1) 257 goto error; 258 259 switch (wValue) { 260 case USB_PORT_FEAT_ENABLE: 261 break; 262 case USB_PORT_FEAT_SUSPEND: 263 musb_port_suspend(musb, false); 264 break; 265 case USB_PORT_FEAT_POWER: 266 if (!(is_otg_enabled(musb) && hcd->self.is_b_host)) 267 musb_set_vbus(musb, 0); 268 break; 269 case USB_PORT_FEAT_C_CONNECTION: 270 case USB_PORT_FEAT_C_ENABLE: 271 case USB_PORT_FEAT_C_OVER_CURRENT: 272 case USB_PORT_FEAT_C_RESET: 273 case USB_PORT_FEAT_C_SUSPEND: 274 break; 275 default: 276 goto error; 277 } 278 DBG(5, "clear feature %d\n", wValue); 279 musb->port1_status &= ~(1 << wValue); 280 break; 281 case GetHubDescriptor: 282 { 283 struct usb_hub_descriptor *desc = (void *)buf; 284 285 desc->bDescLength = 9; 286 desc->bDescriptorType = 0x29; 287 desc->bNbrPorts = 1; 288 desc->wHubCharacteristics = cpu_to_le16( 289 0x0001 /* per-port power switching */ 290 | 0x0010 /* no overcurrent reporting */ 291 ); 292 desc->bPwrOn2PwrGood = 5; /* msec/2 */ 293 desc->bHubContrCurrent = 0; 294 295 /* workaround bogus struct definition */ 296 desc->DeviceRemovable[0] = 0x02; /* port 1 */ 297 desc->DeviceRemovable[1] = 0xff; 298 } 299 break; 300 case GetHubStatus: 301 temp = 0; 302 *(__le32 *) buf = cpu_to_le32(temp); 303 break; 304 case GetPortStatus: 305 if (wIndex != 1) 306 goto error; 307 308 /* finish RESET signaling? */ 309 if ((musb->port1_status & USB_PORT_STAT_RESET) 310 && time_after_eq(jiffies, musb->rh_timer)) 311 musb_port_reset(musb, false); 312 313 /* finish RESUME signaling? */ 314 if ((musb->port1_status & MUSB_PORT_STAT_RESUME) 315 && time_after_eq(jiffies, musb->rh_timer)) { 316 u8 power; 317 318 power = musb_readb(musb->mregs, MUSB_POWER); 319 power &= ~MUSB_POWER_RESUME; 320 DBG(4, "root port resume stopped, power %02x\n", 321 power); 322 musb_writeb(musb->mregs, MUSB_POWER, power); 323 324 /* ISSUE: DaVinci (RTL 1.300) disconnects after 325 * resume of high speed peripherals (but not full 326 * speed ones). 327 */ 328 329 musb->is_active = 1; 330 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND 331 | MUSB_PORT_STAT_RESUME); 332 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16; 333 usb_hcd_poll_rh_status(musb_to_hcd(musb)); 334 /* NOTE: it might really be A_WAIT_BCON ... */ 335 musb->xceiv->state = OTG_STATE_A_HOST; 336 } 337 338 put_unaligned(cpu_to_le32(musb->port1_status 339 & ~MUSB_PORT_STAT_RESUME), 340 (__le32 *) buf); 341 342 /* port change status is more interesting */ 343 DBG(get_unaligned((u16 *)(buf+2)) ? 2 : 5, "port status %08x\n", 344 musb->port1_status); 345 break; 346 case SetPortFeature: 347 if ((wIndex & 0xff) != 1) 348 goto error; 349 350 switch (wValue) { 351 case USB_PORT_FEAT_POWER: 352 /* NOTE: this controller has a strange state machine 353 * that involves "requesting sessions" according to 354 * magic side effects from incompletely-described 355 * rules about startup... 356 * 357 * This call is what really starts the host mode; be 358 * very careful about side effects if you reorder any 359 * initialization logic, e.g. for OTG, or change any 360 * logic relating to VBUS power-up. 361 */ 362 if (!(is_otg_enabled(musb) && hcd->self.is_b_host)) 363 musb_start(musb); 364 break; 365 case USB_PORT_FEAT_RESET: 366 musb_port_reset(musb, true); 367 break; 368 case USB_PORT_FEAT_SUSPEND: 369 musb_port_suspend(musb, true); 370 break; 371 case USB_PORT_FEAT_TEST: 372 if (unlikely(is_host_active(musb))) 373 goto error; 374 375 wIndex >>= 8; 376 switch (wIndex) { 377 case 1: 378 pr_debug("TEST_J\n"); 379 temp = MUSB_TEST_J; 380 break; 381 case 2: 382 pr_debug("TEST_K\n"); 383 temp = MUSB_TEST_K; 384 break; 385 case 3: 386 pr_debug("TEST_SE0_NAK\n"); 387 temp = MUSB_TEST_SE0_NAK; 388 break; 389 case 4: 390 pr_debug("TEST_PACKET\n"); 391 temp = MUSB_TEST_PACKET; 392 musb_load_testpacket(musb); 393 break; 394 case 5: 395 pr_debug("TEST_FORCE_ENABLE\n"); 396 temp = MUSB_TEST_FORCE_HOST 397 | MUSB_TEST_FORCE_HS; 398 399 musb_writeb(musb->mregs, MUSB_DEVCTL, 400 MUSB_DEVCTL_SESSION); 401 break; 402 case 6: 403 pr_debug("TEST_FIFO_ACCESS\n"); 404 temp = MUSB_TEST_FIFO_ACCESS; 405 break; 406 default: 407 goto error; 408 } 409 musb_writeb(musb->mregs, MUSB_TESTMODE, temp); 410 break; 411 default: 412 goto error; 413 } 414 DBG(5, "set feature %d\n", wValue); 415 musb->port1_status |= 1 << wValue; 416 break; 417 418 default: 419error: 420 /* "protocol stall" on error */ 421 retval = -EPIPE; 422 } 423 spin_unlock_irqrestore(&musb->lock, flags); 424 return retval; 425} 426