Linux Audio

Check our new training course

Real-Time Linux with PREEMPT_RT training

Feb 18-20, 2025
Register
Loading...
v6.8
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3 * MUSB OTG driver core code
   4 *
   5 * Copyright 2005 Mentor Graphics Corporation
   6 * Copyright (C) 2005-2006 by Texas Instruments
   7 * Copyright (C) 2006-2007 Nokia Corporation
   8 */
   9
  10/*
  11 * Inventra (Multipoint) Dual-Role Controller Driver for Linux.
  12 *
  13 * This consists of a Host Controller Driver (HCD) and a peripheral
  14 * controller driver implementing the "Gadget" API; OTG support is
  15 * in the works.  These are normal Linux-USB controller drivers which
  16 * use IRQs and have no dedicated thread.
  17 *
  18 * This version of the driver has only been used with products from
  19 * Texas Instruments.  Those products integrate the Inventra logic
  20 * with other DMA, IRQ, and bus modules, as well as other logic that
  21 * needs to be reflected in this driver.
  22 *
  23 *
  24 * NOTE:  the original Mentor code here was pretty much a collection
  25 * of mechanisms that don't seem to have been fully integrated/working
  26 * for *any* Linux kernel version.  This version aims at Linux 2.6.now,
  27 * Key open issues include:
  28 *
  29 *  - Lack of host-side transaction scheduling, for all transfer types.
  30 *    The hardware doesn't do it; instead, software must.
  31 *
  32 *    This is not an issue for OTG devices that don't support external
  33 *    hubs, but for more "normal" USB hosts it's a user issue that the
  34 *    "multipoint" support doesn't scale in the expected ways.  That
  35 *    includes DaVinci EVM in a common non-OTG mode.
  36 *
  37 *      * Control and bulk use dedicated endpoints, and there's as
  38 *        yet no mechanism to either (a) reclaim the hardware when
  39 *        peripherals are NAKing, which gets complicated with bulk
  40 *        endpoints, or (b) use more than a single bulk endpoint in
  41 *        each direction.
  42 *
  43 *        RESULT:  one device may be perceived as blocking another one.
  44 *
  45 *      * Interrupt and isochronous will dynamically allocate endpoint
  46 *        hardware, but (a) there's no record keeping for bandwidth;
  47 *        (b) in the common case that few endpoints are available, there
  48 *        is no mechanism to reuse endpoints to talk to multiple devices.
  49 *
  50 *        RESULT:  At one extreme, bandwidth can be overcommitted in
  51 *        some hardware configurations, no faults will be reported.
  52 *        At the other extreme, the bandwidth capabilities which do
  53 *        exist tend to be severely undercommitted.  You can't yet hook
  54 *        up both a keyboard and a mouse to an external USB hub.
  55 */
  56
  57/*
  58 * This gets many kinds of configuration information:
  59 *	- Kconfig for everything user-configurable
  60 *	- platform_device for addressing, irq, and platform_data
  61 *	- platform_data is mostly for board-specific information
  62 *	  (plus recentrly, SOC or family details)
  63 *
  64 * Most of the conditional compilation will (someday) vanish.
  65 */
  66
  67#include <linux/module.h>
  68#include <linux/kernel.h>
  69#include <linux/sched.h>
  70#include <linux/slab.h>
  71#include <linux/list.h>
  72#include <linux/kobject.h>
  73#include <linux/prefetch.h>
  74#include <linux/platform_device.h>
  75#include <linux/io.h>
  76#include <linux/iopoll.h>
  77#include <linux/dma-mapping.h>
  78#include <linux/usb.h>
  79#include <linux/usb/of.h>
  80
  81#include "musb_core.h"
  82#include "musb_trace.h"
  83
  84#define TA_WAIT_BCON(m) max_t(int, (m)->a_wait_bcon, OTG_TIME_A_WAIT_BCON)
  85
  86
  87#define DRIVER_AUTHOR "Mentor Graphics, Texas Instruments, Nokia"
  88#define DRIVER_DESC "Inventra Dual-Role USB Controller Driver"
  89
  90#define MUSB_VERSION "6.0"
  91
  92#define DRIVER_INFO DRIVER_DESC ", v" MUSB_VERSION
  93
  94#define MUSB_DRIVER_NAME "musb-hdrc"
  95const char musb_driver_name[] = MUSB_DRIVER_NAME;
  96
  97MODULE_DESCRIPTION(DRIVER_INFO);
  98MODULE_AUTHOR(DRIVER_AUTHOR);
  99MODULE_LICENSE("GPL");
 100MODULE_ALIAS("platform:" MUSB_DRIVER_NAME);
 101
 102
 103/*-------------------------------------------------------------------------*/
 104
 105static inline struct musb *dev_to_musb(struct device *dev)
 106{
 107	return dev_get_drvdata(dev);
 108}
 109
 110enum musb_mode musb_get_mode(struct device *dev)
 111{
 112	enum usb_dr_mode mode;
 113
 114	mode = usb_get_dr_mode(dev);
 115	switch (mode) {
 116	case USB_DR_MODE_HOST:
 117		return MUSB_HOST;
 118	case USB_DR_MODE_PERIPHERAL:
 119		return MUSB_PERIPHERAL;
 120	case USB_DR_MODE_OTG:
 121	case USB_DR_MODE_UNKNOWN:
 122	default:
 123		return MUSB_OTG;
 124	}
 125}
 126EXPORT_SYMBOL_GPL(musb_get_mode);
 127
 128/*-------------------------------------------------------------------------*/
 129
 130static int musb_ulpi_read(struct usb_phy *phy, u32 reg)
 131{
 132	void __iomem *addr = phy->io_priv;
 133	int	i = 0;
 134	u8	r;
 135	u8	power;
 136	int	ret;
 137
 138	pm_runtime_get_sync(phy->io_dev);
 139
 140	/* Make sure the transceiver is not in low power mode */
 141	power = musb_readb(addr, MUSB_POWER);
 142	power &= ~MUSB_POWER_SUSPENDM;
 143	musb_writeb(addr, MUSB_POWER, power);
 144
 145	/* REVISIT: musbhdrc_ulpi_an.pdf recommends setting the
 146	 * ULPICarKitControlDisableUTMI after clearing POWER_SUSPENDM.
 147	 */
 148
 149	musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)reg);
 150	musb_writeb(addr, MUSB_ULPI_REG_CONTROL,
 151			MUSB_ULPI_REG_REQ | MUSB_ULPI_RDN_WR);
 152
 153	while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
 154				& MUSB_ULPI_REG_CMPLT)) {
 155		i++;
 156		if (i == 10000) {
 157			ret = -ETIMEDOUT;
 158			goto out;
 159		}
 160
 161	}
 162	r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
 163	r &= ~MUSB_ULPI_REG_CMPLT;
 164	musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
 165
 166	ret = musb_readb(addr, MUSB_ULPI_REG_DATA);
 167
 168out:
 169	pm_runtime_put(phy->io_dev);
 170
 171	return ret;
 172}
 173
 174static int musb_ulpi_write(struct usb_phy *phy, u32 val, u32 reg)
 175{
 176	void __iomem *addr = phy->io_priv;
 177	int	i = 0;
 178	u8	r = 0;
 179	u8	power;
 180	int	ret = 0;
 181
 182	pm_runtime_get_sync(phy->io_dev);
 183
 184	/* Make sure the transceiver is not in low power mode */
 185	power = musb_readb(addr, MUSB_POWER);
 186	power &= ~MUSB_POWER_SUSPENDM;
 187	musb_writeb(addr, MUSB_POWER, power);
 188
 189	musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)reg);
 190	musb_writeb(addr, MUSB_ULPI_REG_DATA, (u8)val);
 191	musb_writeb(addr, MUSB_ULPI_REG_CONTROL, MUSB_ULPI_REG_REQ);
 192
 193	while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
 194				& MUSB_ULPI_REG_CMPLT)) {
 195		i++;
 196		if (i == 10000) {
 197			ret = -ETIMEDOUT;
 198			goto out;
 199		}
 200	}
 201
 202	r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
 203	r &= ~MUSB_ULPI_REG_CMPLT;
 204	musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
 205
 206out:
 207	pm_runtime_put(phy->io_dev);
 208
 209	return ret;
 210}
 211
 212static struct usb_phy_io_ops musb_ulpi_access = {
 213	.read = musb_ulpi_read,
 214	.write = musb_ulpi_write,
 215};
 216
 217/*-------------------------------------------------------------------------*/
 218
 219static u32 musb_default_fifo_offset(u8 epnum)
 220{
 221	return 0x20 + (epnum * 4);
 222}
 223
 224/* "flat" mapping: each endpoint has its own i/o address */
 225static void musb_flat_ep_select(void __iomem *mbase, u8 epnum)
 226{
 227}
 228
 229static u32 musb_flat_ep_offset(u8 epnum, u16 offset)
 230{
 231	return 0x100 + (0x10 * epnum) + offset;
 232}
 233
 234/* "indexed" mapping: INDEX register controls register bank select */
 235static void musb_indexed_ep_select(void __iomem *mbase, u8 epnum)
 236{
 237	musb_writeb(mbase, MUSB_INDEX, epnum);
 238}
 239
 240static u32 musb_indexed_ep_offset(u8 epnum, u16 offset)
 241{
 242	return 0x10 + offset;
 243}
 244
 245static u32 musb_default_busctl_offset(u8 epnum, u16 offset)
 246{
 247	return 0x80 + (0x08 * epnum) + offset;
 248}
 249
 250static u8 musb_default_readb(void __iomem *addr, u32 offset)
 251{
 252	u8 data =  __raw_readb(addr + offset);
 253
 254	trace_musb_readb(__builtin_return_address(0), addr, offset, data);
 255	return data;
 256}
 257
 258static void musb_default_writeb(void __iomem *addr, u32 offset, u8 data)
 259{
 260	trace_musb_writeb(__builtin_return_address(0), addr, offset, data);
 261	__raw_writeb(data, addr + offset);
 262}
 263
 264static u16 musb_default_readw(void __iomem *addr, u32 offset)
 265{
 266	u16 data = __raw_readw(addr + offset);
 267
 268	trace_musb_readw(__builtin_return_address(0), addr, offset, data);
 269	return data;
 270}
 271
 272static void musb_default_writew(void __iomem *addr, u32 offset, u16 data)
 273{
 274	trace_musb_writew(__builtin_return_address(0), addr, offset, data);
 275	__raw_writew(data, addr + offset);
 276}
 277
 278static u16 musb_default_get_toggle(struct musb_qh *qh, int is_out)
 279{
 280	void __iomem *epio = qh->hw_ep->regs;
 281	u16 csr;
 282
 283	if (is_out)
 284		csr = musb_readw(epio, MUSB_TXCSR) & MUSB_TXCSR_H_DATATOGGLE;
 285	else
 286		csr = musb_readw(epio, MUSB_RXCSR) & MUSB_RXCSR_H_DATATOGGLE;
 287
 288	return csr;
 289}
 290
 291static u16 musb_default_set_toggle(struct musb_qh *qh, int is_out,
 292				   struct urb *urb)
 293{
 294	u16 csr;
 295	u16 toggle;
 296
 297	toggle = usb_gettoggle(urb->dev, qh->epnum, is_out);
 298
 299	if (is_out)
 300		csr = toggle ? (MUSB_TXCSR_H_WR_DATATOGGLE
 301				| MUSB_TXCSR_H_DATATOGGLE)
 302				: MUSB_TXCSR_CLRDATATOG;
 303	else
 304		csr = toggle ? (MUSB_RXCSR_H_WR_DATATOGGLE
 305				| MUSB_RXCSR_H_DATATOGGLE) : 0;
 306
 307	return csr;
 308}
 309
 310/*
 311 * Load an endpoint's FIFO
 312 */
 313static void musb_default_write_fifo(struct musb_hw_ep *hw_ep, u16 len,
 314				    const u8 *src)
 315{
 316	struct musb *musb = hw_ep->musb;
 317	void __iomem *fifo = hw_ep->fifo;
 318
 319	if (unlikely(len == 0))
 320		return;
 321
 322	prefetch((u8 *)src);
 323
 324	dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
 325			'T', hw_ep->epnum, fifo, len, src);
 326
 327	/* we can't assume unaligned reads work */
 328	if (likely((0x01 & (unsigned long) src) == 0)) {
 329		u16	index = 0;
 330
 331		/* best case is 32bit-aligned source address */
 332		if ((0x02 & (unsigned long) src) == 0) {
 333			if (len >= 4) {
 334				iowrite32_rep(fifo, src + index, len >> 2);
 335				index += len & ~0x03;
 336			}
 337			if (len & 0x02) {
 338				__raw_writew(*(u16 *)&src[index], fifo);
 339				index += 2;
 340			}
 341		} else {
 342			if (len >= 2) {
 343				iowrite16_rep(fifo, src + index, len >> 1);
 344				index += len & ~0x01;
 345			}
 346		}
 347		if (len & 0x01)
 348			__raw_writeb(src[index], fifo);
 349	} else  {
 350		/* byte aligned */
 351		iowrite8_rep(fifo, src, len);
 352	}
 353}
 354
 355/*
 356 * Unload an endpoint's FIFO
 357 */
 358static void musb_default_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
 359{
 360	struct musb *musb = hw_ep->musb;
 361	void __iomem *fifo = hw_ep->fifo;
 362
 363	if (unlikely(len == 0))
 364		return;
 365
 366	dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
 367			'R', hw_ep->epnum, fifo, len, dst);
 368
 369	/* we can't assume unaligned writes work */
 370	if (likely((0x01 & (unsigned long) dst) == 0)) {
 371		u16	index = 0;
 372
 373		/* best case is 32bit-aligned destination address */
 374		if ((0x02 & (unsigned long) dst) == 0) {
 375			if (len >= 4) {
 376				ioread32_rep(fifo, dst, len >> 2);
 377				index = len & ~0x03;
 378			}
 379			if (len & 0x02) {
 380				*(u16 *)&dst[index] = __raw_readw(fifo);
 381				index += 2;
 382			}
 383		} else {
 384			if (len >= 2) {
 385				ioread16_rep(fifo, dst, len >> 1);
 386				index = len & ~0x01;
 387			}
 388		}
 389		if (len & 0x01)
 390			dst[index] = __raw_readb(fifo);
 391	} else  {
 392		/* byte aligned */
 393		ioread8_rep(fifo, dst, len);
 394	}
 395}
 396
 397/*
 398 * Old style IO functions
 399 */
 400u8 (*musb_readb)(void __iomem *addr, u32 offset);
 401EXPORT_SYMBOL_GPL(musb_readb);
 402
 403void (*musb_writeb)(void __iomem *addr, u32 offset, u8 data);
 404EXPORT_SYMBOL_GPL(musb_writeb);
 405
 406u8 (*musb_clearb)(void __iomem *addr, u32 offset);
 407EXPORT_SYMBOL_GPL(musb_clearb);
 408
 409u16 (*musb_readw)(void __iomem *addr, u32 offset);
 410EXPORT_SYMBOL_GPL(musb_readw);
 411
 412void (*musb_writew)(void __iomem *addr, u32 offset, u16 data);
 413EXPORT_SYMBOL_GPL(musb_writew);
 414
 415u16 (*musb_clearw)(void __iomem *addr, u32 offset);
 416EXPORT_SYMBOL_GPL(musb_clearw);
 417
 418u32 musb_readl(void __iomem *addr, u32 offset)
 419{
 420	u32 data = __raw_readl(addr + offset);
 421
 422	trace_musb_readl(__builtin_return_address(0), addr, offset, data);
 423	return data;
 424}
 425EXPORT_SYMBOL_GPL(musb_readl);
 426
 427void musb_writel(void __iomem *addr, u32 offset, u32 data)
 428{
 429	trace_musb_writel(__builtin_return_address(0), addr, offset, data);
 430	__raw_writel(data, addr + offset);
 431}
 432EXPORT_SYMBOL_GPL(musb_writel);
 433
 434#ifndef CONFIG_MUSB_PIO_ONLY
 435struct dma_controller *
 436(*musb_dma_controller_create)(struct musb *musb, void __iomem *base);
 437EXPORT_SYMBOL(musb_dma_controller_create);
 438
 439void (*musb_dma_controller_destroy)(struct dma_controller *c);
 440EXPORT_SYMBOL(musb_dma_controller_destroy);
 441#endif
 442
 443/*
 444 * New style IO functions
 445 */
 446void musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
 447{
 448	return hw_ep->musb->io.read_fifo(hw_ep, len, dst);
 449}
 450
 451void musb_write_fifo(struct musb_hw_ep *hw_ep, u16 len, const u8 *src)
 452{
 453	return hw_ep->musb->io.write_fifo(hw_ep, len, src);
 454}
 455
 456static u8 musb_read_devctl(struct musb *musb)
 457{
 458	return musb_readb(musb->mregs, MUSB_DEVCTL);
 459}
 460
 461/**
 462 * musb_set_host - set and initialize host mode
 463 * @musb: musb controller driver data
 464 *
 465 * At least some musb revisions need to enable devctl session bit in
 466 * peripheral mode to switch to host mode. Initializes things to host
 467 * mode and sets A_IDLE. SoC glue needs to advance state further
 468 * based on phy provided VBUS state.
 469 *
 470 * Note that the SoC glue code may need to wait for musb to settle
 471 * on enable before calling this to avoid babble.
 472 */
 473int musb_set_host(struct musb *musb)
 474{
 475	int error = 0;
 476	u8 devctl;
 477
 478	if (!musb)
 479		return -EINVAL;
 480
 481	devctl = musb_read_devctl(musb);
 482	if (!(devctl & MUSB_DEVCTL_BDEVICE)) {
 483		trace_musb_state(musb, devctl, "Already in host mode");
 484		goto init_data;
 485	}
 486
 487	devctl |= MUSB_DEVCTL_SESSION;
 488	musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 489
 490	error = readx_poll_timeout(musb_read_devctl, musb, devctl,
 491				   !(devctl & MUSB_DEVCTL_BDEVICE), 5000,
 492				   1000000);
 493	if (error) {
 494		dev_err(musb->controller, "%s: could not set host: %02x\n",
 495			__func__, devctl);
 496
 497		return error;
 498	}
 499
 500	devctl = musb_read_devctl(musb);
 501	trace_musb_state(musb, devctl, "Host mode set");
 502
 503init_data:
 504	musb->is_active = 1;
 505	musb_set_state(musb, OTG_STATE_A_IDLE);
 506	MUSB_HST_MODE(musb);
 507
 508	return error;
 509}
 510EXPORT_SYMBOL_GPL(musb_set_host);
 511
 512/**
 513 * musb_set_peripheral - set and initialize peripheral mode
 514 * @musb: musb controller driver data
 515 *
 516 * Clears devctl session bit and initializes things for peripheral
 517 * mode and sets B_IDLE. SoC glue needs to advance state further
 518 * based on phy provided VBUS state.
 519 */
 520int musb_set_peripheral(struct musb *musb)
 521{
 522	int error = 0;
 523	u8 devctl;
 524
 525	if (!musb)
 526		return -EINVAL;
 527
 528	devctl = musb_read_devctl(musb);
 529	if (devctl & MUSB_DEVCTL_BDEVICE) {
 530		trace_musb_state(musb, devctl, "Already in peripheral mode");
 531		goto init_data;
 532	}
 533
 534	devctl &= ~MUSB_DEVCTL_SESSION;
 535	musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
 536
 537	error = readx_poll_timeout(musb_read_devctl, musb, devctl,
 538				   devctl & MUSB_DEVCTL_BDEVICE, 5000,
 539				   1000000);
 540	if (error) {
 541		dev_err(musb->controller, "%s: could not set peripheral: %02x\n",
 542			__func__, devctl);
 543
 544		return error;
 545	}
 546
 547	devctl = musb_read_devctl(musb);
 548	trace_musb_state(musb, devctl, "Peripheral mode set");
 549
 550init_data:
 551	musb->is_active = 0;
 552	musb_set_state(musb, OTG_STATE_B_IDLE);
 553	MUSB_DEV_MODE(musb);
 554
 555	return error;
 556}
 557EXPORT_SYMBOL_GPL(musb_set_peripheral);
 558
 559/*-------------------------------------------------------------------------*/
 560
 561/* for high speed test mode; see USB 2.0 spec 7.1.20 */
 562static const u8 musb_test_packet[53] = {
 563	/* implicit SYNC then DATA0 to start */
 564
 565	/* JKJKJKJK x9 */
 566	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 567	/* JJKKJJKK x8 */
 568	0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
 569	/* JJJJKKKK x8 */
 570	0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee,
 571	/* JJJJJJJKKKKKKK x8 */
 572	0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
 573	/* JJJJJJJK x8 */
 574	0x7f, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd,
 575	/* JKKKKKKK x10, JK */
 576	0xfc, 0x7e, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd, 0x7e
 577
 578	/* implicit CRC16 then EOP to end */
 579};
 580
 581void musb_load_testpacket(struct musb *musb)
 582{
 583	void __iomem	*regs = musb->endpoints[0].regs;
 584
 585	musb_ep_select(musb->mregs, 0);
 586	musb_write_fifo(musb->control_ep,
 587			sizeof(musb_test_packet), musb_test_packet);
 588	musb_writew(regs, MUSB_CSR0, MUSB_CSR0_TXPKTRDY);
 589}
 590
 591/*-------------------------------------------------------------------------*/
 592
 593/*
 594 * Handles OTG hnp timeouts, such as b_ase0_brst
 595 */
 596static void musb_otg_timer_func(struct timer_list *t)
 597{
 598	struct musb	*musb = from_timer(musb, t, otg_timer);
 599	unsigned long	flags;
 600
 601	spin_lock_irqsave(&musb->lock, flags);
 602	switch (musb_get_state(musb)) {
 603	case OTG_STATE_B_WAIT_ACON:
 604		musb_dbg(musb,
 605			"HNP: b_wait_acon timeout; back to b_peripheral");
 606		musb_g_disconnect(musb);
 607		musb_set_state(musb, OTG_STATE_B_PERIPHERAL);
 608		musb->is_active = 0;
 609		break;
 610	case OTG_STATE_A_SUSPEND:
 611	case OTG_STATE_A_WAIT_BCON:
 612		musb_dbg(musb, "HNP: %s timeout",
 613			 musb_otg_state_string(musb));
 614		musb_platform_set_vbus(musb, 0);
 615		musb_set_state(musb, OTG_STATE_A_WAIT_VFALL);
 616		break;
 617	default:
 618		musb_dbg(musb, "HNP: Unhandled mode %s",
 619			 musb_otg_state_string(musb));
 620	}
 621	spin_unlock_irqrestore(&musb->lock, flags);
 622}
 623
 624/*
 625 * Stops the HNP transition. Caller must take care of locking.
 626 */
 627void musb_hnp_stop(struct musb *musb)
 628{
 629	struct usb_hcd	*hcd = musb->hcd;
 630	void __iomem	*mbase = musb->mregs;
 631	u8	reg;
 632
 633	musb_dbg(musb, "HNP: stop from %s", musb_otg_state_string(musb));
 
 634
 635	switch (musb_get_state(musb)) {
 636	case OTG_STATE_A_PERIPHERAL:
 637		musb_g_disconnect(musb);
 638		musb_dbg(musb, "HNP: back to %s", musb_otg_state_string(musb));
 
 639		break;
 640	case OTG_STATE_B_HOST:
 641		musb_dbg(musb, "HNP: Disabling HR");
 642		if (hcd)
 643			hcd->self.is_b_host = 0;
 644		musb_set_state(musb, OTG_STATE_B_PERIPHERAL);
 645		MUSB_DEV_MODE(musb);
 646		reg = musb_readb(mbase, MUSB_POWER);
 647		reg |= MUSB_POWER_SUSPENDM;
 648		musb_writeb(mbase, MUSB_POWER, reg);
 649		/* REVISIT: Start SESSION_REQUEST here? */
 650		break;
 651	default:
 652		musb_dbg(musb, "HNP: Stopping in unknown state %s",
 653			 musb_otg_state_string(musb));
 654	}
 655
 656	/*
 657	 * When returning to A state after HNP, avoid hub_port_rebounce(),
 658	 * which cause occasional OPT A "Did not receive reset after connect"
 659	 * errors.
 660	 */
 661	musb->port1_status &= ~(USB_PORT_STAT_C_CONNECTION << 16);
 662}
 663
 664static void musb_recover_from_babble(struct musb *musb);
 665
 666static void musb_handle_intr_resume(struct musb *musb, u8 devctl)
 667{
 668	musb_dbg(musb, "RESUME (%s)", musb_otg_state_string(musb));
 
 669
 670	if (devctl & MUSB_DEVCTL_HM) {
 671		switch (musb_get_state(musb)) {
 672		case OTG_STATE_A_SUSPEND:
 673			/* remote wakeup? */
 674			musb->port1_status |=
 675					(USB_PORT_STAT_C_SUSPEND << 16)
 676					| MUSB_PORT_STAT_RESUME;
 677			musb->rh_timer = jiffies
 678				+ msecs_to_jiffies(USB_RESUME_TIMEOUT);
 679			musb_set_state(musb, OTG_STATE_A_HOST);
 680			musb->is_active = 1;
 681			musb_host_resume_root_hub(musb);
 682			schedule_delayed_work(&musb->finish_resume_work,
 683				msecs_to_jiffies(USB_RESUME_TIMEOUT));
 684			break;
 685		case OTG_STATE_B_WAIT_ACON:
 686			musb_set_state(musb, OTG_STATE_B_PERIPHERAL);
 687			musb->is_active = 1;
 688			MUSB_DEV_MODE(musb);
 689			break;
 690		default:
 691			WARNING("bogus %s RESUME (%s)\n",
 692				"host",
 693				musb_otg_state_string(musb));
 694		}
 695	} else {
 696		switch (musb_get_state(musb)) {
 697		case OTG_STATE_A_SUSPEND:
 698			/* possibly DISCONNECT is upcoming */
 699			musb_set_state(musb, OTG_STATE_A_HOST);
 700			musb_host_resume_root_hub(musb);
 701			break;
 702		case OTG_STATE_B_WAIT_ACON:
 703		case OTG_STATE_B_PERIPHERAL:
 704			/* disconnect while suspended?  we may
 705			 * not get a disconnect irq...
 706			 */
 707			if ((devctl & MUSB_DEVCTL_VBUS)
 708					!= (3 << MUSB_DEVCTL_VBUS_SHIFT)
 709					) {
 710				musb->int_usb |= MUSB_INTR_DISCONNECT;
 711				musb->int_usb &= ~MUSB_INTR_SUSPEND;
 712				break;
 713			}
 714			musb_g_resume(musb);
 715			break;
 716		case OTG_STATE_B_IDLE:
 717			musb->int_usb &= ~MUSB_INTR_SUSPEND;
 718			break;
 719		default:
 720			WARNING("bogus %s RESUME (%s)\n",
 721				"peripheral",
 722				musb_otg_state_string(musb));
 723		}
 724	}
 725}
 726
 727/* return IRQ_HANDLED to tell the caller to return immediately */
 728static irqreturn_t musb_handle_intr_sessreq(struct musb *musb, u8 devctl)
 729{
 730	void __iomem *mbase = musb->mregs;
 731
 732	if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS
 733			&& (devctl & MUSB_DEVCTL_BDEVICE)) {
 734		musb_dbg(musb, "SessReq while on B state");
 735		return IRQ_HANDLED;
 736	}
 737
 738	musb_dbg(musb, "SESSION_REQUEST (%s)", musb_otg_state_string(musb));
 
 739
 740	/* IRQ arrives from ID pin sense or (later, if VBUS power
 741	 * is removed) SRP.  responses are time critical:
 742	 *  - turn on VBUS (with silicon-specific mechanism)
 743	 *  - go through A_WAIT_VRISE
 744	 *  - ... to A_WAIT_BCON.
 745	 * a_wait_vrise_tmout triggers VBUS_ERROR transitions
 746	 */
 747	musb_writeb(mbase, MUSB_DEVCTL, MUSB_DEVCTL_SESSION);
 748	musb->ep0_stage = MUSB_EP0_START;
 749	musb_set_state(musb, OTG_STATE_A_IDLE);
 750	MUSB_HST_MODE(musb);
 751	musb_platform_set_vbus(musb, 1);
 752
 753	return IRQ_NONE;
 754}
 755
 756static void musb_handle_intr_vbuserr(struct musb *musb, u8 devctl)
 757{
 758	int	ignore = 0;
 759
 760	/* During connection as an A-Device, we may see a short
 761	 * current spikes causing voltage drop, because of cable
 762	 * and peripheral capacitance combined with vbus draw.
 763	 * (So: less common with truly self-powered devices, where
 764	 * vbus doesn't act like a power supply.)
 765	 *
 766	 * Such spikes are short; usually less than ~500 usec, max
 767	 * of ~2 msec.  That is, they're not sustained overcurrent
 768	 * errors, though they're reported using VBUSERROR irqs.
 769	 *
 770	 * Workarounds:  (a) hardware: use self powered devices.
 771	 * (b) software:  ignore non-repeated VBUS errors.
 772	 *
 773	 * REVISIT:  do delays from lots of DEBUG_KERNEL checks
 774	 * make trouble here, keeping VBUS < 4.4V ?
 775	 */
 776	switch (musb_get_state(musb)) {
 777	case OTG_STATE_A_HOST:
 778		/* recovery is dicey once we've gotten past the
 779		 * initial stages of enumeration, but if VBUS
 780		 * stayed ok at the other end of the link, and
 781		 * another reset is due (at least for high speed,
 782		 * to redo the chirp etc), it might work OK...
 783		 */
 784	case OTG_STATE_A_WAIT_BCON:
 785	case OTG_STATE_A_WAIT_VRISE:
 786		if (musb->vbuserr_retry) {
 787			void __iomem *mbase = musb->mregs;
 788
 789			musb->vbuserr_retry--;
 790			ignore = 1;
 791			devctl |= MUSB_DEVCTL_SESSION;
 792			musb_writeb(mbase, MUSB_DEVCTL, devctl);
 793		} else {
 794			musb->port1_status |=
 795				  USB_PORT_STAT_OVERCURRENT
 796				| (USB_PORT_STAT_C_OVERCURRENT << 16);
 797		}
 798		break;
 799	default:
 800		break;
 801	}
 802
 803	dev_printk(ignore ? KERN_DEBUG : KERN_ERR, musb->controller,
 804			"VBUS_ERROR in %s (%02x, %s), retry #%d, port1 %08x\n",
 805			musb_otg_state_string(musb),
 806			devctl,
 807			({ char *s;
 808			switch (devctl & MUSB_DEVCTL_VBUS) {
 809			case 0 << MUSB_DEVCTL_VBUS_SHIFT:
 810				s = "<SessEnd"; break;
 811			case 1 << MUSB_DEVCTL_VBUS_SHIFT:
 812				s = "<AValid"; break;
 813			case 2 << MUSB_DEVCTL_VBUS_SHIFT:
 814				s = "<VBusValid"; break;
 815			/* case 3 << MUSB_DEVCTL_VBUS_SHIFT: */
 816			default:
 817				s = "VALID"; break;
 818			} s; }),
 819			VBUSERR_RETRY_COUNT - musb->vbuserr_retry,
 820			musb->port1_status);
 821
 822	/* go through A_WAIT_VFALL then start a new session */
 823	if (!ignore)
 824		musb_platform_set_vbus(musb, 0);
 825}
 826
 827static void musb_handle_intr_suspend(struct musb *musb, u8 devctl)
 828{
 829	musb_dbg(musb, "SUSPEND (%s) devctl %02x",
 830		 musb_otg_state_string(musb), devctl);
 831
 832	switch (musb_get_state(musb)) {
 833	case OTG_STATE_A_PERIPHERAL:
 834		/* We also come here if the cable is removed, since
 835		 * this silicon doesn't report ID-no-longer-grounded.
 836		 *
 837		 * We depend on T(a_wait_bcon) to shut us down, and
 838		 * hope users don't do anything dicey during this
 839		 * undesired detour through A_WAIT_BCON.
 840		 */
 841		musb_hnp_stop(musb);
 842		musb_host_resume_root_hub(musb);
 843		musb_root_disconnect(musb);
 844		musb_platform_try_idle(musb, jiffies
 845				+ msecs_to_jiffies(musb->a_wait_bcon
 846					? : OTG_TIME_A_WAIT_BCON));
 847
 848		break;
 849	case OTG_STATE_B_IDLE:
 850		if (!musb->is_active)
 851			break;
 852		fallthrough;
 853	case OTG_STATE_B_PERIPHERAL:
 854		musb_g_suspend(musb);
 855		musb->is_active = musb->g.b_hnp_enable;
 856		if (musb->is_active) {
 857			musb_set_state(musb, OTG_STATE_B_WAIT_ACON);
 858			musb_dbg(musb, "HNP: Setting timer for b_ase0_brst");
 859			mod_timer(&musb->otg_timer, jiffies
 860				+ msecs_to_jiffies(
 861						OTG_TIME_B_ASE0_BRST));
 862		}
 863		break;
 864	case OTG_STATE_A_WAIT_BCON:
 865		if (musb->a_wait_bcon != 0)
 866			musb_platform_try_idle(musb, jiffies
 867				+ msecs_to_jiffies(musb->a_wait_bcon));
 868		break;
 869	case OTG_STATE_A_HOST:
 870		musb_set_state(musb, OTG_STATE_A_SUSPEND);
 871		musb->is_active = musb->hcd->self.b_hnp_enable;
 872		break;
 873	case OTG_STATE_B_HOST:
 874		/* Transition to B_PERIPHERAL, see 6.8.2.6 p 44 */
 875		musb_dbg(musb, "REVISIT: SUSPEND as B_HOST");
 876		break;
 877	default:
 878		/* "should not happen" */
 879		musb->is_active = 0;
 880		break;
 881	}
 882}
 883
 884static void musb_handle_intr_connect(struct musb *musb, u8 devctl, u8 int_usb)
 885{
 886	struct usb_hcd *hcd = musb->hcd;
 887
 888	musb->is_active = 1;
 889	musb->ep0_stage = MUSB_EP0_START;
 890
 891	musb->intrtxe = musb->epmask;
 892	musb_writew(musb->mregs, MUSB_INTRTXE, musb->intrtxe);
 893	musb->intrrxe = musb->epmask & 0xfffe;
 894	musb_writew(musb->mregs, MUSB_INTRRXE, musb->intrrxe);
 895	musb_writeb(musb->mregs, MUSB_INTRUSBE, 0xf7);
 896	musb->port1_status &= ~(USB_PORT_STAT_LOW_SPEED
 897				|USB_PORT_STAT_HIGH_SPEED
 898				|USB_PORT_STAT_ENABLE
 899				);
 900	musb->port1_status |= USB_PORT_STAT_CONNECTION
 901				|(USB_PORT_STAT_C_CONNECTION << 16);
 902
 903	/* high vs full speed is just a guess until after reset */
 904	if (devctl & MUSB_DEVCTL_LSDEV)
 905		musb->port1_status |= USB_PORT_STAT_LOW_SPEED;
 906
 907	/* indicate new connection to OTG machine */
 908	switch (musb_get_state(musb)) {
 909	case OTG_STATE_B_PERIPHERAL:
 910		if (int_usb & MUSB_INTR_SUSPEND) {
 911			musb_dbg(musb, "HNP: SUSPEND+CONNECT, now b_host");
 912			int_usb &= ~MUSB_INTR_SUSPEND;
 913			goto b_host;
 914		} else
 915			musb_dbg(musb, "CONNECT as b_peripheral???");
 916		break;
 917	case OTG_STATE_B_WAIT_ACON:
 918		musb_dbg(musb, "HNP: CONNECT, now b_host");
 919b_host:
 920		musb_set_state(musb, OTG_STATE_B_HOST);
 921		if (musb->hcd)
 922			musb->hcd->self.is_b_host = 1;
 923		del_timer(&musb->otg_timer);
 924		break;
 925	default:
 926		if ((devctl & MUSB_DEVCTL_VBUS)
 927				== (3 << MUSB_DEVCTL_VBUS_SHIFT)) {
 928			musb_set_state(musb, OTG_STATE_A_HOST);
 929			if (hcd)
 930				hcd->self.is_b_host = 0;
 931		}
 932		break;
 933	}
 934
 935	musb_host_poke_root_hub(musb);
 936
 937	musb_dbg(musb, "CONNECT (%s) devctl %02x",
 938			musb_otg_state_string(musb), devctl);
 939}
 940
 941static void musb_handle_intr_disconnect(struct musb *musb, u8 devctl)
 942{
 943	musb_dbg(musb, "DISCONNECT (%s) as %s, devctl %02x",
 944			musb_otg_state_string(musb),
 945			MUSB_MODE(musb), devctl);
 946
 947	switch (musb_get_state(musb)) {
 948	case OTG_STATE_A_HOST:
 949	case OTG_STATE_A_SUSPEND:
 950		musb_host_resume_root_hub(musb);
 951		musb_root_disconnect(musb);
 952		if (musb->a_wait_bcon != 0)
 953			musb_platform_try_idle(musb, jiffies
 954				+ msecs_to_jiffies(musb->a_wait_bcon));
 955		break;
 956	case OTG_STATE_B_HOST:
 957		/* REVISIT this behaves for "real disconnect"
 958		 * cases; make sure the other transitions from
 959		 * from B_HOST act right too.  The B_HOST code
 960		 * in hnp_stop() is currently not used...
 961		 */
 962		musb_root_disconnect(musb);
 963		if (musb->hcd)
 964			musb->hcd->self.is_b_host = 0;
 965		musb_set_state(musb, OTG_STATE_B_PERIPHERAL);
 966		MUSB_DEV_MODE(musb);
 967		musb_g_disconnect(musb);
 968		break;
 969	case OTG_STATE_A_PERIPHERAL:
 970		musb_hnp_stop(musb);
 971		musb_root_disconnect(musb);
 972		fallthrough;
 973	case OTG_STATE_B_WAIT_ACON:
 
 974	case OTG_STATE_B_PERIPHERAL:
 975	case OTG_STATE_B_IDLE:
 976		musb_g_disconnect(musb);
 977		break;
 978	default:
 979		WARNING("unhandled DISCONNECT transition (%s)\n",
 980			musb_otg_state_string(musb));
 981		break;
 982	}
 983}
 984
 985/*
 986 * mentor saves a bit: bus reset and babble share the same irq.
 987 * only host sees babble; only peripheral sees bus reset.
 988 */
 989static void musb_handle_intr_reset(struct musb *musb)
 990{
 991	if (is_host_active(musb)) {
 992		/*
 993		 * When BABBLE happens what we can depends on which
 994		 * platform MUSB is running, because some platforms
 995		 * implemented proprietary means for 'recovering' from
 996		 * Babble conditions. One such platform is AM335x. In
 997		 * most cases, however, the only thing we can do is
 998		 * drop the session.
 999		 */
1000		dev_err(musb->controller, "Babble\n");
1001		musb_recover_from_babble(musb);
1002	} else {
1003		musb_dbg(musb, "BUS RESET as %s", musb_otg_state_string(musb));
1004		switch (musb_get_state(musb)) {
 
1005		case OTG_STATE_A_SUSPEND:
1006			musb_g_reset(musb);
1007			fallthrough;
1008		case OTG_STATE_A_WAIT_BCON:	/* OPT TD.4.7-900ms */
1009			/* never use invalid T(a_wait_bcon) */
1010			musb_dbg(musb, "HNP: in %s, %d msec timeout",
1011				 musb_otg_state_string(musb),
1012				TA_WAIT_BCON(musb));
1013			mod_timer(&musb->otg_timer, jiffies
1014				+ msecs_to_jiffies(TA_WAIT_BCON(musb)));
1015			break;
1016		case OTG_STATE_A_PERIPHERAL:
1017			del_timer(&musb->otg_timer);
1018			musb_g_reset(musb);
1019			break;
1020		case OTG_STATE_B_WAIT_ACON:
1021			musb_dbg(musb, "HNP: RESET (%s), to b_peripheral",
1022				 musb_otg_state_string(musb));
1023			musb_set_state(musb, OTG_STATE_B_PERIPHERAL);
1024			musb_g_reset(musb);
1025			break;
1026		case OTG_STATE_B_IDLE:
1027			musb_set_state(musb, OTG_STATE_B_PERIPHERAL);
1028			fallthrough;
1029		case OTG_STATE_B_PERIPHERAL:
1030			musb_g_reset(musb);
1031			break;
1032		default:
1033			musb_dbg(musb, "Unhandled BUS RESET as %s",
1034				 musb_otg_state_string(musb));
1035		}
1036	}
1037}
1038
1039/*
1040 * Interrupt Service Routine to record USB "global" interrupts.
1041 * Since these do not happen often and signify things of
1042 * paramount importance, it seems OK to check them individually;
1043 * the order of the tests is specified in the manual
1044 *
1045 * @param musb instance pointer
1046 * @param int_usb register contents
1047 * @param devctl
 
1048 */
1049
1050static irqreturn_t musb_stage0_irq(struct musb *musb, u8 int_usb,
1051				u8 devctl)
1052{
1053	irqreturn_t handled = IRQ_NONE;
1054
1055	musb_dbg(musb, "<== DevCtl=%02x, int_usb=0x%x", devctl, int_usb);
1056
1057	/* in host mode, the peripheral may issue remote wakeup.
1058	 * in peripheral mode, the host may resume the link.
1059	 * spurious RESUME irqs happen too, paired with SUSPEND.
1060	 */
1061	if (int_usb & MUSB_INTR_RESUME) {
1062		musb_handle_intr_resume(musb, devctl);
1063		handled = IRQ_HANDLED;
1064	}
1065
1066	/* see manual for the order of the tests */
1067	if (int_usb & MUSB_INTR_SESSREQ) {
1068		if (musb_handle_intr_sessreq(musb, devctl))
1069			return IRQ_HANDLED;
1070		handled = IRQ_HANDLED;
1071	}
1072
1073	if (int_usb & MUSB_INTR_VBUSERROR) {
1074		musb_handle_intr_vbuserr(musb, devctl);
1075		handled = IRQ_HANDLED;
1076	}
1077
1078	if (int_usb & MUSB_INTR_SUSPEND) {
1079		musb_handle_intr_suspend(musb, devctl);
1080		handled = IRQ_HANDLED;
1081	}
1082
1083	if (int_usb & MUSB_INTR_CONNECT) {
1084		musb_handle_intr_connect(musb, devctl, int_usb);
1085		handled = IRQ_HANDLED;
1086	}
1087
1088	if (int_usb & MUSB_INTR_DISCONNECT) {
1089		musb_handle_intr_disconnect(musb, devctl);
1090		handled = IRQ_HANDLED;
1091	}
1092
1093	if (int_usb & MUSB_INTR_RESET) {
1094		musb_handle_intr_reset(musb);
1095		handled = IRQ_HANDLED;
1096	}
1097
1098#if 0
1099/* REVISIT ... this would be for multiplexing periodic endpoints, or
1100 * supporting transfer phasing to prevent exceeding ISO bandwidth
1101 * limits of a given frame or microframe.
1102 *
1103 * It's not needed for peripheral side, which dedicates endpoints;
1104 * though it _might_ use SOF irqs for other purposes.
1105 *
1106 * And it's not currently needed for host side, which also dedicates
1107 * endpoints, relies on TX/RX interval registers, and isn't claimed
1108 * to support ISO transfers yet.
1109 */
1110	if (int_usb & MUSB_INTR_SOF) {
1111		void __iomem *mbase = musb->mregs;
1112		struct musb_hw_ep	*ep;
1113		u8 epnum;
1114		u16 frame;
1115
1116		dev_dbg(musb->controller, "START_OF_FRAME\n");
1117		handled = IRQ_HANDLED;
1118
1119		/* start any periodic Tx transfers waiting for current frame */
1120		frame = musb_readw(mbase, MUSB_FRAME);
1121		ep = musb->endpoints;
1122		for (epnum = 1; (epnum < musb->nr_endpoints)
1123					&& (musb->epmask >= (1 << epnum));
1124				epnum++, ep++) {
1125			/*
1126			 * FIXME handle framecounter wraps (12 bits)
1127			 * eliminate duplicated StartUrb logic
1128			 */
1129			if (ep->dwWaitFrame >= frame) {
1130				ep->dwWaitFrame = 0;
1131				pr_debug("SOF --> periodic TX%s on %d\n",
1132					ep->tx_channel ? " DMA" : "",
1133					epnum);
1134				if (!ep->tx_channel)
1135					musb_h_tx_start(musb, epnum);
1136				else
1137					cppi_hostdma_start(musb, epnum);
1138			}
1139		}		/* end of for loop */
1140	}
1141#endif
1142
1143	schedule_delayed_work(&musb->irq_work, 0);
1144
1145	return handled;
1146}
1147
1148/*-------------------------------------------------------------------------*/
1149
1150static void musb_disable_interrupts(struct musb *musb)
1151{
1152	void __iomem	*mbase = musb->mregs;
 
1153
1154	/* disable interrupts */
1155	musb_writeb(mbase, MUSB_INTRUSBE, 0);
1156	musb->intrtxe = 0;
1157	musb_writew(mbase, MUSB_INTRTXE, 0);
1158	musb->intrrxe = 0;
1159	musb_writew(mbase, MUSB_INTRRXE, 0);
1160
1161	/*  flush pending interrupts */
1162	musb_clearb(mbase, MUSB_INTRUSB);
1163	musb_clearw(mbase, MUSB_INTRTX);
1164	musb_clearw(mbase, MUSB_INTRRX);
1165}
1166
1167static void musb_enable_interrupts(struct musb *musb)
1168{
1169	void __iomem    *regs = musb->mregs;
1170
1171	/*  Set INT enable registers, enable interrupts */
1172	musb->intrtxe = musb->epmask;
1173	musb_writew(regs, MUSB_INTRTXE, musb->intrtxe);
1174	musb->intrrxe = musb->epmask & 0xfffe;
1175	musb_writew(regs, MUSB_INTRRXE, musb->intrrxe);
1176	musb_writeb(regs, MUSB_INTRUSBE, 0xf7);
1177
1178}
1179
1180/*
1181 * Program the HDRC to start (enable interrupts, dma, etc.).
1182 */
1183void musb_start(struct musb *musb)
1184{
1185	void __iomem    *regs = musb->mregs;
1186	u8              devctl = musb_readb(regs, MUSB_DEVCTL);
1187	u8		power;
1188
1189	musb_dbg(musb, "<== devctl %02x", devctl);
1190
1191	musb_enable_interrupts(musb);
1192	musb_writeb(regs, MUSB_TESTMODE, 0);
1193
1194	power = MUSB_POWER_ISOUPDATE;
1195	/*
1196	 * treating UNKNOWN as unspecified maximum speed, in which case
1197	 * we will default to high-speed.
1198	 */
1199	if (musb->config->maximum_speed == USB_SPEED_HIGH ||
1200			musb->config->maximum_speed == USB_SPEED_UNKNOWN)
1201		power |= MUSB_POWER_HSENAB;
1202	musb_writeb(regs, MUSB_POWER, power);
1203
1204	musb->is_active = 0;
1205	devctl = musb_readb(regs, MUSB_DEVCTL);
1206	devctl &= ~MUSB_DEVCTL_SESSION;
1207
1208	/* session started after:
1209	 * (a) ID-grounded irq, host mode;
1210	 * (b) vbus present/connect IRQ, peripheral mode;
1211	 * (c) peripheral initiates, using SRP
1212	 */
1213	if (musb->port_mode != MUSB_HOST &&
1214	    musb_get_state(musb) != OTG_STATE_A_WAIT_BCON &&
1215	    (devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS) {
1216		musb->is_active = 1;
1217	} else {
1218		devctl |= MUSB_DEVCTL_SESSION;
1219	}
1220
1221	musb_platform_enable(musb);
1222	musb_writeb(regs, MUSB_DEVCTL, devctl);
1223}
1224
1225/*
1226 * Make the HDRC stop (disable interrupts, etc.);
1227 * reversible by musb_start
1228 * called on gadget driver unregister
1229 * with controller locked, irqs blocked
1230 * acts as a NOP unless some role activated the hardware
1231 */
1232void musb_stop(struct musb *musb)
1233{
1234	/* stop IRQs, timers, ... */
1235	musb_platform_disable(musb);
1236	musb_disable_interrupts(musb);
1237	musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
1238
1239	/* FIXME
1240	 *  - mark host and/or peripheral drivers unusable/inactive
1241	 *  - disable DMA (and enable it in HdrcStart)
1242	 *  - make sure we can musb_start() after musb_stop(); with
1243	 *    OTG mode, gadget driver module rmmod/modprobe cycles that
1244	 *  - ...
1245	 */
1246	musb_platform_try_idle(musb, 0);
1247}
1248
1249/*-------------------------------------------------------------------------*/
1250
1251/*
1252 * The silicon either has hard-wired endpoint configurations, or else
1253 * "dynamic fifo" sizing.  The driver has support for both, though at this
1254 * writing only the dynamic sizing is very well tested.   Since we switched
1255 * away from compile-time hardware parameters, we can no longer rely on
1256 * dead code elimination to leave only the relevant one in the object file.
1257 *
1258 * We don't currently use dynamic fifo setup capability to do anything
1259 * more than selecting one of a bunch of predefined configurations.
1260 */
1261static ushort fifo_mode;
1262
1263/* "modprobe ... fifo_mode=1" etc */
1264module_param(fifo_mode, ushort, 0);
1265MODULE_PARM_DESC(fifo_mode, "initial endpoint configuration");
1266
1267/*
1268 * tables defining fifo_mode values.  define more if you like.
1269 * for host side, make sure both halves of ep1 are set up.
1270 */
1271
1272/* mode 0 - fits in 2KB */
1273static struct musb_fifo_cfg mode_0_cfg[] = {
1274{ .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, },
1275{ .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, },
1276{ .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, },
1277{ .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1278{ .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1279};
1280
1281/* mode 1 - fits in 4KB */
1282static struct musb_fifo_cfg mode_1_cfg[] = {
1283{ .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1284{ .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1285{ .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1286{ .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1287{ .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1288};
1289
1290/* mode 2 - fits in 4KB */
1291static struct musb_fifo_cfg mode_2_cfg[] = {
1292{ .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, },
1293{ .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, },
1294{ .hw_ep_num = 2, .style = FIFO_TX,   .maxpacket = 512, },
1295{ .hw_ep_num = 2, .style = FIFO_RX,   .maxpacket = 512, },
1296{ .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 960, },
1297{ .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 1024, },
1298};
1299
1300/* mode 3 - fits in 4KB */
1301static struct musb_fifo_cfg mode_3_cfg[] = {
1302{ .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1303{ .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1304{ .hw_ep_num = 2, .style = FIFO_TX,   .maxpacket = 512, },
1305{ .hw_ep_num = 2, .style = FIFO_RX,   .maxpacket = 512, },
1306{ .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1307{ .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1308};
1309
1310/* mode 4 - fits in 16KB */
1311static struct musb_fifo_cfg mode_4_cfg[] = {
1312{ .hw_ep_num =  1, .style = FIFO_TX,   .maxpacket = 512, },
1313{ .hw_ep_num =  1, .style = FIFO_RX,   .maxpacket = 512, },
1314{ .hw_ep_num =  2, .style = FIFO_TX,   .maxpacket = 512, },
1315{ .hw_ep_num =  2, .style = FIFO_RX,   .maxpacket = 512, },
1316{ .hw_ep_num =  3, .style = FIFO_TX,   .maxpacket = 512, },
1317{ .hw_ep_num =  3, .style = FIFO_RX,   .maxpacket = 512, },
1318{ .hw_ep_num =  4, .style = FIFO_TX,   .maxpacket = 512, },
1319{ .hw_ep_num =  4, .style = FIFO_RX,   .maxpacket = 512, },
1320{ .hw_ep_num =  5, .style = FIFO_TX,   .maxpacket = 512, },
1321{ .hw_ep_num =  5, .style = FIFO_RX,   .maxpacket = 512, },
1322{ .hw_ep_num =  6, .style = FIFO_TX,   .maxpacket = 512, },
1323{ .hw_ep_num =  6, .style = FIFO_RX,   .maxpacket = 512, },
1324{ .hw_ep_num =  7, .style = FIFO_TX,   .maxpacket = 512, },
1325{ .hw_ep_num =  7, .style = FIFO_RX,   .maxpacket = 512, },
1326{ .hw_ep_num =  8, .style = FIFO_TX,   .maxpacket = 512, },
1327{ .hw_ep_num =  8, .style = FIFO_RX,   .maxpacket = 512, },
1328{ .hw_ep_num =  9, .style = FIFO_TX,   .maxpacket = 512, },
1329{ .hw_ep_num =  9, .style = FIFO_RX,   .maxpacket = 512, },
1330{ .hw_ep_num = 10, .style = FIFO_TX,   .maxpacket = 256, },
1331{ .hw_ep_num = 10, .style = FIFO_RX,   .maxpacket = 64, },
1332{ .hw_ep_num = 11, .style = FIFO_TX,   .maxpacket = 256, },
1333{ .hw_ep_num = 11, .style = FIFO_RX,   .maxpacket = 64, },
1334{ .hw_ep_num = 12, .style = FIFO_TX,   .maxpacket = 256, },
1335{ .hw_ep_num = 12, .style = FIFO_RX,   .maxpacket = 64, },
1336{ .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 4096, },
1337{ .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1338{ .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1339};
1340
1341/* mode 5 - fits in 8KB */
1342static struct musb_fifo_cfg mode_5_cfg[] = {
1343{ .hw_ep_num =  1, .style = FIFO_TX,   .maxpacket = 512, },
1344{ .hw_ep_num =  1, .style = FIFO_RX,   .maxpacket = 512, },
1345{ .hw_ep_num =  2, .style = FIFO_TX,   .maxpacket = 512, },
1346{ .hw_ep_num =  2, .style = FIFO_RX,   .maxpacket = 512, },
1347{ .hw_ep_num =  3, .style = FIFO_TX,   .maxpacket = 512, },
1348{ .hw_ep_num =  3, .style = FIFO_RX,   .maxpacket = 512, },
1349{ .hw_ep_num =  4, .style = FIFO_TX,   .maxpacket = 512, },
1350{ .hw_ep_num =  4, .style = FIFO_RX,   .maxpacket = 512, },
1351{ .hw_ep_num =  5, .style = FIFO_TX,   .maxpacket = 512, },
1352{ .hw_ep_num =  5, .style = FIFO_RX,   .maxpacket = 512, },
1353{ .hw_ep_num =  6, .style = FIFO_TX,   .maxpacket = 32, },
1354{ .hw_ep_num =  6, .style = FIFO_RX,   .maxpacket = 32, },
1355{ .hw_ep_num =  7, .style = FIFO_TX,   .maxpacket = 32, },
1356{ .hw_ep_num =  7, .style = FIFO_RX,   .maxpacket = 32, },
1357{ .hw_ep_num =  8, .style = FIFO_TX,   .maxpacket = 32, },
1358{ .hw_ep_num =  8, .style = FIFO_RX,   .maxpacket = 32, },
1359{ .hw_ep_num =  9, .style = FIFO_TX,   .maxpacket = 32, },
1360{ .hw_ep_num =  9, .style = FIFO_RX,   .maxpacket = 32, },
1361{ .hw_ep_num = 10, .style = FIFO_TX,   .maxpacket = 32, },
1362{ .hw_ep_num = 10, .style = FIFO_RX,   .maxpacket = 32, },
1363{ .hw_ep_num = 11, .style = FIFO_TX,   .maxpacket = 32, },
1364{ .hw_ep_num = 11, .style = FIFO_RX,   .maxpacket = 32, },
1365{ .hw_ep_num = 12, .style = FIFO_TX,   .maxpacket = 32, },
1366{ .hw_ep_num = 12, .style = FIFO_RX,   .maxpacket = 32, },
1367{ .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 512, },
1368{ .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1369{ .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1370};
1371
1372/*
1373 * configure a fifo; for non-shared endpoints, this may be called
1374 * once for a tx fifo and once for an rx fifo.
1375 *
1376 * returns negative errno or offset for next fifo.
1377 */
1378static int
1379fifo_setup(struct musb *musb, struct musb_hw_ep  *hw_ep,
1380		const struct musb_fifo_cfg *cfg, u16 offset)
1381{
1382	void __iomem	*mbase = musb->mregs;
1383	int	size = 0;
1384	u16	maxpacket = cfg->maxpacket;
1385	u16	c_off = offset >> 3;
1386	u8	c_size;
1387
1388	/* expect hw_ep has already been zero-initialized */
1389
1390	size = ffs(max(maxpacket, (u16) 8)) - 1;
1391	maxpacket = 1 << size;
1392
1393	c_size = size - 3;
1394	if (cfg->mode == BUF_DOUBLE) {
1395		if ((offset + (maxpacket << 1)) >
1396				(1 << (musb->config->ram_bits + 2)))
1397			return -EMSGSIZE;
1398		c_size |= MUSB_FIFOSZ_DPB;
1399	} else {
1400		if ((offset + maxpacket) > (1 << (musb->config->ram_bits + 2)))
1401			return -EMSGSIZE;
1402	}
1403
1404	/* configure the FIFO */
1405	musb_writeb(mbase, MUSB_INDEX, hw_ep->epnum);
1406
1407	/* EP0 reserved endpoint for control, bidirectional;
1408	 * EP1 reserved for bulk, two unidirectional halves.
1409	 */
1410	if (hw_ep->epnum == 1)
1411		musb->bulk_ep = hw_ep;
1412	/* REVISIT error check:  be sure ep0 can both rx and tx ... */
1413	switch (cfg->style) {
1414	case FIFO_TX:
1415		musb_writeb(mbase, MUSB_TXFIFOSZ, c_size);
1416		musb_writew(mbase, MUSB_TXFIFOADD, c_off);
1417		hw_ep->tx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1418		hw_ep->max_packet_sz_tx = maxpacket;
1419		break;
1420	case FIFO_RX:
1421		musb_writeb(mbase, MUSB_RXFIFOSZ, c_size);
1422		musb_writew(mbase, MUSB_RXFIFOADD, c_off);
1423		hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1424		hw_ep->max_packet_sz_rx = maxpacket;
1425		break;
1426	case FIFO_RXTX:
1427		musb_writeb(mbase, MUSB_TXFIFOSZ, c_size);
1428		musb_writew(mbase, MUSB_TXFIFOADD, c_off);
1429		hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1430		hw_ep->max_packet_sz_rx = maxpacket;
1431
1432		musb_writeb(mbase, MUSB_RXFIFOSZ, c_size);
1433		musb_writew(mbase, MUSB_RXFIFOADD, c_off);
1434		hw_ep->tx_double_buffered = hw_ep->rx_double_buffered;
1435		hw_ep->max_packet_sz_tx = maxpacket;
1436
1437		hw_ep->is_shared_fifo = true;
1438		break;
1439	}
1440
1441	/* NOTE rx and tx endpoint irqs aren't managed separately,
1442	 * which happens to be ok
1443	 */
1444	musb->epmask |= (1 << hw_ep->epnum);
1445
1446	return offset + (maxpacket << ((c_size & MUSB_FIFOSZ_DPB) ? 1 : 0));
1447}
1448
1449static struct musb_fifo_cfg ep0_cfg = {
1450	.style = FIFO_RXTX, .maxpacket = 64,
1451};
1452
1453static int ep_config_from_table(struct musb *musb)
1454{
1455	const struct musb_fifo_cfg	*cfg;
1456	unsigned		i, n;
1457	int			offset;
1458	struct musb_hw_ep	*hw_ep = musb->endpoints;
1459
1460	if (musb->config->fifo_cfg) {
1461		cfg = musb->config->fifo_cfg;
1462		n = musb->config->fifo_cfg_size;
1463		goto done;
1464	}
1465
1466	switch (fifo_mode) {
1467	default:
1468		fifo_mode = 0;
1469		fallthrough;
1470	case 0:
1471		cfg = mode_0_cfg;
1472		n = ARRAY_SIZE(mode_0_cfg);
1473		break;
1474	case 1:
1475		cfg = mode_1_cfg;
1476		n = ARRAY_SIZE(mode_1_cfg);
1477		break;
1478	case 2:
1479		cfg = mode_2_cfg;
1480		n = ARRAY_SIZE(mode_2_cfg);
1481		break;
1482	case 3:
1483		cfg = mode_3_cfg;
1484		n = ARRAY_SIZE(mode_3_cfg);
1485		break;
1486	case 4:
1487		cfg = mode_4_cfg;
1488		n = ARRAY_SIZE(mode_4_cfg);
1489		break;
1490	case 5:
1491		cfg = mode_5_cfg;
1492		n = ARRAY_SIZE(mode_5_cfg);
1493		break;
1494	}
1495
1496	pr_debug("%s: setup fifo_mode %d\n", musb_driver_name, fifo_mode);
1497
1498
1499done:
1500	offset = fifo_setup(musb, hw_ep, &ep0_cfg, 0);
1501	/* assert(offset > 0) */
1502
1503	/* NOTE:  for RTL versions >= 1.400 EPINFO and RAMINFO would
1504	 * be better than static musb->config->num_eps and DYN_FIFO_SIZE...
1505	 */
1506
1507	for (i = 0; i < n; i++) {
1508		u8	epn = cfg->hw_ep_num;
1509
1510		if (epn >= musb->config->num_eps) {
1511			pr_debug("%s: invalid ep %d\n",
1512					musb_driver_name, epn);
1513			return -EINVAL;
1514		}
1515		offset = fifo_setup(musb, hw_ep + epn, cfg++, offset);
1516		if (offset < 0) {
1517			pr_debug("%s: mem overrun, ep %d\n",
1518					musb_driver_name, epn);
1519			return offset;
1520		}
1521		epn++;
1522		musb->nr_endpoints = max(epn, musb->nr_endpoints);
1523	}
1524
1525	pr_debug("%s: %d/%d max ep, %d/%d memory\n",
1526			musb_driver_name,
1527			n + 1, musb->config->num_eps * 2 - 1,
1528			offset, (1 << (musb->config->ram_bits + 2)));
1529
1530	if (!musb->bulk_ep) {
1531		pr_debug("%s: missing bulk\n", musb_driver_name);
1532		return -EINVAL;
1533	}
1534
1535	return 0;
1536}
1537
1538
1539/*
1540 * ep_config_from_hw - when MUSB_C_DYNFIFO_DEF is false
1541 * @param musb the controller
1542 */
1543static int ep_config_from_hw(struct musb *musb)
1544{
1545	u8 epnum = 0;
1546	struct musb_hw_ep *hw_ep;
1547	void __iomem *mbase = musb->mregs;
1548	int ret = 0;
1549
1550	musb_dbg(musb, "<== static silicon ep config");
1551
1552	/* FIXME pick up ep0 maxpacket size */
1553
1554	for (epnum = 1; epnum < musb->config->num_eps; epnum++) {
1555		musb_ep_select(mbase, epnum);
1556		hw_ep = musb->endpoints + epnum;
1557
1558		ret = musb_read_fifosize(musb, hw_ep, epnum);
1559		if (ret < 0)
1560			break;
1561
1562		/* FIXME set up hw_ep->{rx,tx}_double_buffered */
1563
1564		/* pick an RX/TX endpoint for bulk */
1565		if (hw_ep->max_packet_sz_tx < 512
1566				|| hw_ep->max_packet_sz_rx < 512)
1567			continue;
1568
1569		/* REVISIT:  this algorithm is lazy, we should at least
1570		 * try to pick a double buffered endpoint.
1571		 */
1572		if (musb->bulk_ep)
1573			continue;
1574		musb->bulk_ep = hw_ep;
1575	}
1576
1577	if (!musb->bulk_ep) {
1578		pr_debug("%s: missing bulk\n", musb_driver_name);
1579		return -EINVAL;
1580	}
1581
1582	return 0;
1583}
1584
1585enum { MUSB_CONTROLLER_MHDRC, MUSB_CONTROLLER_HDRC, };
1586
1587/* Initialize MUSB (M)HDRC part of the USB hardware subsystem;
1588 * configure endpoints, or take their config from silicon
1589 */
1590static int musb_core_init(u16 musb_type, struct musb *musb)
1591{
1592	u8 reg;
1593	char *type;
1594	char aInfo[90];
1595	void __iomem	*mbase = musb->mregs;
1596	int		status = 0;
1597	int		i;
1598
1599	/* log core options (read using indexed model) */
1600	reg = musb_read_configdata(mbase);
1601
1602	strcpy(aInfo, (reg & MUSB_CONFIGDATA_UTMIDW) ? "UTMI-16" : "UTMI-8");
1603	if (reg & MUSB_CONFIGDATA_DYNFIFO) {
1604		strcat(aInfo, ", dyn FIFOs");
1605		musb->dyn_fifo = true;
1606	}
1607	if (reg & MUSB_CONFIGDATA_MPRXE) {
1608		strcat(aInfo, ", bulk combine");
1609		musb->bulk_combine = true;
1610	}
1611	if (reg & MUSB_CONFIGDATA_MPTXE) {
1612		strcat(aInfo, ", bulk split");
1613		musb->bulk_split = true;
1614	}
1615	if (reg & MUSB_CONFIGDATA_HBRXE) {
1616		strcat(aInfo, ", HB-ISO Rx");
1617		musb->hb_iso_rx = true;
1618	}
1619	if (reg & MUSB_CONFIGDATA_HBTXE) {
1620		strcat(aInfo, ", HB-ISO Tx");
1621		musb->hb_iso_tx = true;
1622	}
1623	if (reg & MUSB_CONFIGDATA_SOFTCONE)
1624		strcat(aInfo, ", SoftConn");
1625
1626	pr_debug("%s: ConfigData=0x%02x (%s)\n", musb_driver_name, reg, aInfo);
1627
1628	if (MUSB_CONTROLLER_MHDRC == musb_type) {
1629		musb->is_multipoint = 1;
1630		type = "M";
1631	} else {
1632		musb->is_multipoint = 0;
1633		type = "";
1634		if (IS_ENABLED(CONFIG_USB) &&
1635		    !IS_ENABLED(CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB)) {
1636			pr_err("%s: kernel must disable external hubs, please fix the configuration\n",
1637			       musb_driver_name);
1638		}
1639	}
1640
1641	/* log release info */
1642	musb->hwvers = musb_readw(mbase, MUSB_HWVERS);
1643	pr_debug("%s: %sHDRC RTL version %d.%d%s\n",
1644		 musb_driver_name, type, MUSB_HWVERS_MAJOR(musb->hwvers),
1645		 MUSB_HWVERS_MINOR(musb->hwvers),
1646		 (musb->hwvers & MUSB_HWVERS_RC) ? "RC" : "");
1647
1648	/* configure ep0 */
1649	musb_configure_ep0(musb);
1650
1651	/* discover endpoint configuration */
1652	musb->nr_endpoints = 1;
1653	musb->epmask = 1;
1654
1655	if (musb->dyn_fifo)
1656		status = ep_config_from_table(musb);
1657	else
1658		status = ep_config_from_hw(musb);
1659
1660	if (status < 0)
1661		return status;
1662
1663	/* finish init, and print endpoint config */
1664	for (i = 0; i < musb->nr_endpoints; i++) {
1665		struct musb_hw_ep	*hw_ep = musb->endpoints + i;
1666
1667		hw_ep->fifo = musb->io.fifo_offset(i) + mbase;
1668#if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010)
1669		if (musb->ops->quirks & MUSB_IN_TUSB) {
1670			hw_ep->fifo_async = musb->async + 0x400 +
1671				musb->io.fifo_offset(i);
1672			hw_ep->fifo_sync = musb->sync + 0x400 +
1673				musb->io.fifo_offset(i);
1674			hw_ep->fifo_sync_va =
1675				musb->sync_va + 0x400 + musb->io.fifo_offset(i);
1676
1677			if (i == 0)
1678				hw_ep->conf = mbase - 0x400 + TUSB_EP0_CONF;
1679			else
1680				hw_ep->conf = mbase + 0x400 +
1681					(((i - 1) & 0xf) << 2);
1682		}
1683#endif
1684
1685		hw_ep->regs = musb->io.ep_offset(i, 0) + mbase;
1686		hw_ep->rx_reinit = 1;
1687		hw_ep->tx_reinit = 1;
1688
1689		if (hw_ep->max_packet_sz_tx) {
1690			musb_dbg(musb, "%s: hw_ep %d%s, %smax %d",
1691				musb_driver_name, i,
1692				hw_ep->is_shared_fifo ? "shared" : "tx",
1693				hw_ep->tx_double_buffered
1694					? "doublebuffer, " : "",
1695				hw_ep->max_packet_sz_tx);
1696		}
1697		if (hw_ep->max_packet_sz_rx && !hw_ep->is_shared_fifo) {
1698			musb_dbg(musb, "%s: hw_ep %d%s, %smax %d",
1699				musb_driver_name, i,
1700				"rx",
1701				hw_ep->rx_double_buffered
1702					? "doublebuffer, " : "",
1703				hw_ep->max_packet_sz_rx);
1704		}
1705		if (!(hw_ep->max_packet_sz_tx || hw_ep->max_packet_sz_rx))
1706			musb_dbg(musb, "hw_ep %d not configured", i);
1707	}
1708
1709	return 0;
1710}
1711
1712/*-------------------------------------------------------------------------*/
1713
1714/*
1715 * handle all the irqs defined by the HDRC core. for now we expect:  other
1716 * irq sources (phy, dma, etc) will be handled first, musb->int_* values
1717 * will be assigned, and the irq will already have been acked.
1718 *
1719 * called in irq context with spinlock held, irqs blocked
1720 */
1721irqreturn_t musb_interrupt(struct musb *musb)
1722{
1723	irqreturn_t	retval = IRQ_NONE;
1724	unsigned long	status;
1725	unsigned long	epnum;
1726	u8		devctl;
1727
1728	if (!musb->int_usb && !musb->int_tx && !musb->int_rx)
1729		return IRQ_NONE;
1730
1731	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1732
1733	trace_musb_isr(musb);
1734
1735	/**
1736	 * According to Mentor Graphics' documentation, flowchart on page 98,
1737	 * IRQ should be handled as follows:
1738	 *
1739	 * . Resume IRQ
1740	 * . Session Request IRQ
1741	 * . VBUS Error IRQ
1742	 * . Suspend IRQ
1743	 * . Connect IRQ
1744	 * . Disconnect IRQ
1745	 * . Reset/Babble IRQ
1746	 * . SOF IRQ (we're not using this one)
1747	 * . Endpoint 0 IRQ
1748	 * . TX Endpoints
1749	 * . RX Endpoints
1750	 *
1751	 * We will be following that flowchart in order to avoid any problems
1752	 * that might arise with internal Finite State Machine.
1753	 */
1754
1755	if (musb->int_usb)
1756		retval |= musb_stage0_irq(musb, musb->int_usb, devctl);
1757
1758	if (musb->int_tx & 1) {
1759		if (is_host_active(musb))
1760			retval |= musb_h_ep0_irq(musb);
1761		else
1762			retval |= musb_g_ep0_irq(musb);
1763
1764		/* we have just handled endpoint 0 IRQ, clear it */
1765		musb->int_tx &= ~BIT(0);
1766	}
1767
1768	status = musb->int_tx;
1769
1770	for_each_set_bit(epnum, &status, 16) {
1771		retval = IRQ_HANDLED;
1772		if (is_host_active(musb))
1773			musb_host_tx(musb, epnum);
1774		else
1775			musb_g_tx(musb, epnum);
1776	}
1777
1778	status = musb->int_rx;
1779
1780	for_each_set_bit(epnum, &status, 16) {
1781		retval = IRQ_HANDLED;
1782		if (is_host_active(musb))
1783			musb_host_rx(musb, epnum);
1784		else
1785			musb_g_rx(musb, epnum);
1786	}
1787
1788	return retval;
1789}
1790EXPORT_SYMBOL_GPL(musb_interrupt);
1791
1792#ifndef CONFIG_MUSB_PIO_ONLY
1793static bool use_dma = true;
1794
1795/* "modprobe ... use_dma=0" etc */
1796module_param(use_dma, bool, 0644);
1797MODULE_PARM_DESC(use_dma, "enable/disable use of DMA");
1798
1799void musb_dma_completion(struct musb *musb, u8 epnum, u8 transmit)
1800{
1801	/* called with controller lock already held */
1802
1803	if (!epnum) {
1804		if (!is_cppi_enabled(musb)) {
1805			/* endpoint 0 */
1806			if (is_host_active(musb))
1807				musb_h_ep0_irq(musb);
1808			else
1809				musb_g_ep0_irq(musb);
1810		}
1811	} else {
1812		/* endpoints 1..15 */
1813		if (transmit) {
1814			if (is_host_active(musb))
1815				musb_host_tx(musb, epnum);
1816			else
1817				musb_g_tx(musb, epnum);
1818		} else {
1819			/* receive */
1820			if (is_host_active(musb))
1821				musb_host_rx(musb, epnum);
1822			else
1823				musb_g_rx(musb, epnum);
1824		}
1825	}
1826}
1827EXPORT_SYMBOL_GPL(musb_dma_completion);
1828
1829#else
1830#define use_dma			0
1831#endif
1832
1833static int (*musb_phy_callback)(enum musb_vbus_id_status status);
1834
1835/*
1836 * musb_mailbox - optional phy notifier function
1837 * @status phy state change
1838 *
1839 * Optionally gets called from the USB PHY. Note that the USB PHY must be
1840 * disabled at the point the phy_callback is registered or unregistered.
1841 */
1842int musb_mailbox(enum musb_vbus_id_status status)
1843{
1844	if (musb_phy_callback)
1845		return musb_phy_callback(status);
1846
1847	return -ENODEV;
1848};
1849EXPORT_SYMBOL_GPL(musb_mailbox);
1850
1851/*-------------------------------------------------------------------------*/
1852
1853static ssize_t
1854mode_show(struct device *dev, struct device_attribute *attr, char *buf)
1855{
1856	struct musb *musb = dev_to_musb(dev);
1857	unsigned long flags;
1858	int ret;
1859
1860	spin_lock_irqsave(&musb->lock, flags);
1861	ret = sprintf(buf, "%s\n", musb_otg_state_string(musb));
1862	spin_unlock_irqrestore(&musb->lock, flags);
1863
1864	return ret;
1865}
1866
1867static ssize_t
1868mode_store(struct device *dev, struct device_attribute *attr,
1869		const char *buf, size_t n)
1870{
1871	struct musb	*musb = dev_to_musb(dev);
1872	unsigned long	flags;
1873	int		status;
1874
1875	spin_lock_irqsave(&musb->lock, flags);
1876	if (sysfs_streq(buf, "host"))
1877		status = musb_platform_set_mode(musb, MUSB_HOST);
1878	else if (sysfs_streq(buf, "peripheral"))
1879		status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
1880	else if (sysfs_streq(buf, "otg"))
1881		status = musb_platform_set_mode(musb, MUSB_OTG);
1882	else
1883		status = -EINVAL;
1884	spin_unlock_irqrestore(&musb->lock, flags);
1885
1886	return (status == 0) ? n : status;
1887}
1888static DEVICE_ATTR_RW(mode);
1889
1890static ssize_t
1891vbus_store(struct device *dev, struct device_attribute *attr,
1892		const char *buf, size_t n)
1893{
1894	struct musb	*musb = dev_to_musb(dev);
1895	unsigned long	flags;
1896	unsigned long	val;
1897
1898	if (sscanf(buf, "%lu", &val) < 1) {
1899		dev_err(dev, "Invalid VBUS timeout ms value\n");
1900		return -EINVAL;
1901	}
1902
1903	spin_lock_irqsave(&musb->lock, flags);
1904	/* force T(a_wait_bcon) to be zero/unlimited *OR* valid */
1905	musb->a_wait_bcon = val ? max_t(int, val, OTG_TIME_A_WAIT_BCON) : 0 ;
1906	if (musb_get_state(musb) == OTG_STATE_A_WAIT_BCON)
1907		musb->is_active = 0;
1908	musb_platform_try_idle(musb, jiffies + msecs_to_jiffies(val));
1909	spin_unlock_irqrestore(&musb->lock, flags);
1910
1911	return n;
1912}
1913
1914static ssize_t
1915vbus_show(struct device *dev, struct device_attribute *attr, char *buf)
1916{
1917	struct musb	*musb = dev_to_musb(dev);
1918	unsigned long	flags;
1919	unsigned long	val;
1920	int		vbus;
1921	u8		devctl;
1922
1923	pm_runtime_get_sync(dev);
1924	spin_lock_irqsave(&musb->lock, flags);
1925	val = musb->a_wait_bcon;
1926	vbus = musb_platform_get_vbus_status(musb);
1927	if (vbus < 0) {
1928		/* Use default MUSB method by means of DEVCTL register */
1929		devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1930		if ((devctl & MUSB_DEVCTL_VBUS)
1931				== (3 << MUSB_DEVCTL_VBUS_SHIFT))
1932			vbus = 1;
1933		else
1934			vbus = 0;
1935	}
1936	spin_unlock_irqrestore(&musb->lock, flags);
1937	pm_runtime_put_sync(dev);
1938
1939	return sprintf(buf, "Vbus %s, timeout %lu msec\n",
1940			vbus ? "on" : "off", val);
1941}
1942static DEVICE_ATTR_RW(vbus);
1943
1944/* Gadget drivers can't know that a host is connected so they might want
1945 * to start SRP, but users can.  This allows userspace to trigger SRP.
1946 */
1947static ssize_t srp_store(struct device *dev, struct device_attribute *attr,
1948		const char *buf, size_t n)
1949{
1950	struct musb	*musb = dev_to_musb(dev);
1951	unsigned short	srp;
1952
1953	if (sscanf(buf, "%hu", &srp) != 1
1954			|| (srp != 1)) {
1955		dev_err(dev, "SRP: Value must be 1\n");
1956		return -EINVAL;
1957	}
1958
1959	if (srp == 1)
1960		musb_g_wakeup(musb);
1961
1962	return n;
1963}
1964static DEVICE_ATTR_WO(srp);
1965
1966static struct attribute *musb_attrs[] = {
1967	&dev_attr_mode.attr,
1968	&dev_attr_vbus.attr,
1969	&dev_attr_srp.attr,
1970	NULL
1971};
1972ATTRIBUTE_GROUPS(musb);
1973
1974#define MUSB_QUIRK_B_INVALID_VBUS_91	(MUSB_DEVCTL_BDEVICE | \
1975					 (2 << MUSB_DEVCTL_VBUS_SHIFT) | \
1976					 MUSB_DEVCTL_SESSION)
1977#define MUSB_QUIRK_B_DISCONNECT_99	(MUSB_DEVCTL_BDEVICE | \
1978					 (3 << MUSB_DEVCTL_VBUS_SHIFT) | \
1979					 MUSB_DEVCTL_SESSION)
1980#define MUSB_QUIRK_A_DISCONNECT_19	((3 << MUSB_DEVCTL_VBUS_SHIFT) | \
1981					 MUSB_DEVCTL_SESSION)
1982
1983static bool musb_state_needs_recheck(struct musb *musb, u8 devctl,
1984				     const char *desc)
1985{
1986	if (musb->quirk_retries && !musb->flush_irq_work) {
1987		trace_musb_state(musb, devctl, desc);
1988		schedule_delayed_work(&musb->irq_work,
1989				      msecs_to_jiffies(1000));
1990		musb->quirk_retries--;
1991
1992		return true;
1993	}
1994
1995	return false;
1996}
1997
1998/*
1999 * Check the musb devctl session bit to determine if we want to
2000 * allow PM runtime for the device. In general, we want to keep things
2001 * active when the session bit is set except after host disconnect.
2002 *
2003 * Only called from musb_irq_work. If this ever needs to get called
2004 * elsewhere, proper locking must be implemented for musb->session.
2005 */
2006static void musb_pm_runtime_check_session(struct musb *musb)
2007{
2008	u8 devctl, s;
2009	int error;
2010
2011	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
2012
2013	/* Handle session status quirks first */
2014	s = MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV |
2015		MUSB_DEVCTL_HR;
2016	switch (devctl & ~s) {
2017	case MUSB_QUIRK_B_DISCONNECT_99:
2018		musb_state_needs_recheck(musb, devctl,
2019			"Poll devctl in case of suspend after disconnect");
2020		break;
2021	case MUSB_QUIRK_B_INVALID_VBUS_91:
2022		if (musb_state_needs_recheck(musb, devctl,
2023				"Poll devctl on invalid vbus, assume no session"))
 
 
 
 
2024			return;
2025		fallthrough;
 
2026	case MUSB_QUIRK_A_DISCONNECT_19:
2027		if (musb_state_needs_recheck(musb, devctl,
2028				"Poll devctl on possible host mode disconnect"))
 
 
 
 
2029			return;
 
2030		if (!musb->session)
2031			break;
2032		trace_musb_state(musb, devctl, "Allow PM on possible host mode disconnect");
2033		pm_runtime_mark_last_busy(musb->controller);
2034		pm_runtime_put_autosuspend(musb->controller);
2035		musb->session = false;
2036		return;
2037	default:
2038		break;
2039	}
2040
2041	/* No need to do anything if session has not changed */
2042	s = devctl & MUSB_DEVCTL_SESSION;
2043	if (s == musb->session)
2044		return;
2045
2046	/* Block PM or allow PM? */
2047	if (s) {
2048		trace_musb_state(musb, devctl, "Block PM on active session");
2049		error = pm_runtime_get_sync(musb->controller);
2050		if (error < 0)
2051			dev_err(musb->controller, "Could not enable: %i\n",
2052				error);
2053		musb->quirk_retries = 3;
2054
2055		/*
2056		 * We can get a spurious MUSB_INTR_SESSREQ interrupt on start-up
2057		 * in B-peripheral mode with nothing connected and the session
2058		 * bit clears silently. Check status again in 3 seconds.
2059		 */
2060		if (devctl & MUSB_DEVCTL_BDEVICE)
2061			schedule_delayed_work(&musb->irq_work,
2062					      msecs_to_jiffies(3000));
2063	} else {
2064		trace_musb_state(musb, devctl, "Allow PM with no session");
2065		pm_runtime_mark_last_busy(musb->controller);
2066		pm_runtime_put_autosuspend(musb->controller);
2067	}
2068
2069	musb->session = s;
2070}
2071
2072/* Only used to provide driver mode change events */
2073static void musb_irq_work(struct work_struct *data)
2074{
2075	struct musb *musb = container_of(data, struct musb, irq_work.work);
2076	int error;
2077
2078	error = pm_runtime_resume_and_get(musb->controller);
2079	if (error < 0) {
2080		dev_err(musb->controller, "Could not enable: %i\n", error);
2081
2082		return;
2083	}
2084
2085	musb_pm_runtime_check_session(musb);
2086
2087	if (musb_get_state(musb) != musb->xceiv_old_state) {
2088		musb->xceiv_old_state = musb_get_state(musb);
2089		sysfs_notify(&musb->controller->kobj, NULL, "mode");
2090	}
2091
2092	pm_runtime_mark_last_busy(musb->controller);
2093	pm_runtime_put_autosuspend(musb->controller);
2094}
2095
2096static void musb_recover_from_babble(struct musb *musb)
2097{
2098	int ret;
2099	u8 devctl;
2100
2101	musb_disable_interrupts(musb);
2102
2103	/*
2104	 * wait at least 320 cycles of 60MHz clock. That's 5.3us, we will give
2105	 * it some slack and wait for 10us.
2106	 */
2107	udelay(10);
2108
2109	ret  = musb_platform_recover(musb);
2110	if (ret) {
2111		musb_enable_interrupts(musb);
2112		return;
2113	}
2114
2115	/* drop session bit */
2116	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
2117	devctl &= ~MUSB_DEVCTL_SESSION;
2118	musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
2119
2120	/* tell usbcore about it */
2121	musb_root_disconnect(musb);
2122
2123	/*
2124	 * When a babble condition occurs, the musb controller
2125	 * removes the session bit and the endpoint config is lost.
2126	 */
2127	if (musb->dyn_fifo)
2128		ret = ep_config_from_table(musb);
2129	else
2130		ret = ep_config_from_hw(musb);
2131
2132	/* restart session */
2133	if (ret == 0)
2134		musb_start(musb);
2135}
2136
2137/* --------------------------------------------------------------------------
2138 * Init support
2139 */
2140
2141static struct musb *allocate_instance(struct device *dev,
2142		const struct musb_hdrc_config *config, void __iomem *mbase)
2143{
2144	struct musb		*musb;
2145	struct musb_hw_ep	*ep;
2146	int			epnum;
2147	int			ret;
2148
2149	musb = devm_kzalloc(dev, sizeof(*musb), GFP_KERNEL);
2150	if (!musb)
2151		return NULL;
2152
2153	INIT_LIST_HEAD(&musb->control);
2154	INIT_LIST_HEAD(&musb->in_bulk);
2155	INIT_LIST_HEAD(&musb->out_bulk);
2156	INIT_LIST_HEAD(&musb->pending_list);
2157
2158	musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
2159	musb->a_wait_bcon = OTG_TIME_A_WAIT_BCON;
2160	musb->mregs = mbase;
2161	musb->ctrl_base = mbase;
2162	musb->nIrq = -ENODEV;
2163	musb->config = config;
2164	BUG_ON(musb->config->num_eps > MUSB_C_NUM_EPS);
2165	for (epnum = 0, ep = musb->endpoints;
2166			epnum < musb->config->num_eps;
2167			epnum++, ep++) {
2168		ep->musb = musb;
2169		ep->epnum = epnum;
2170	}
2171
2172	musb->controller = dev;
2173
2174	ret = musb_host_alloc(musb);
2175	if (ret < 0)
2176		goto err_free;
2177
2178	dev_set_drvdata(dev, musb);
2179
2180	return musb;
2181
2182err_free:
2183	return NULL;
2184}
2185
2186static void musb_free(struct musb *musb)
2187{
2188	/* this has multiple entry modes. it handles fault cleanup after
2189	 * probe(), where things may be partially set up, as well as rmmod
2190	 * cleanup after everything's been de-activated.
2191	 */
2192
2193	if (musb->nIrq >= 0) {
2194		if (musb->irq_wake)
2195			disable_irq_wake(musb->nIrq);
2196		free_irq(musb->nIrq, musb);
2197	}
2198
2199	musb_host_free(musb);
2200}
2201
2202struct musb_pending_work {
2203	int (*callback)(struct musb *musb, void *data);
2204	void *data;
2205	struct list_head node;
2206};
2207
2208#ifdef CONFIG_PM
2209/*
2210 * Called from musb_runtime_resume(), musb_resume(), and
2211 * musb_queue_resume_work(). Callers must take musb->lock.
2212 */
2213static int musb_run_resume_work(struct musb *musb)
2214{
2215	struct musb_pending_work *w, *_w;
2216	unsigned long flags;
2217	int error = 0;
2218
2219	spin_lock_irqsave(&musb->list_lock, flags);
2220	list_for_each_entry_safe(w, _w, &musb->pending_list, node) {
2221		if (w->callback) {
2222			error = w->callback(musb, w->data);
2223			if (error < 0) {
2224				dev_err(musb->controller,
2225					"resume callback %p failed: %i\n",
2226					w->callback, error);
2227			}
2228		}
2229		list_del(&w->node);
2230		devm_kfree(musb->controller, w);
2231	}
2232	spin_unlock_irqrestore(&musb->list_lock, flags);
2233
2234	return error;
2235}
2236#endif
2237
2238/*
2239 * Called to run work if device is active or else queue the work to happen
2240 * on resume. Caller must take musb->lock and must hold an RPM reference.
2241 *
2242 * Note that we cowardly refuse queuing work after musb PM runtime
2243 * resume is done calling musb_run_resume_work() and return -EINPROGRESS
2244 * instead.
2245 */
2246int musb_queue_resume_work(struct musb *musb,
2247			   int (*callback)(struct musb *musb, void *data),
2248			   void *data)
2249{
2250	struct musb_pending_work *w;
2251	unsigned long flags;
2252	bool is_suspended;
2253	int error;
2254
2255	if (WARN_ON(!callback))
2256		return -EINVAL;
2257
2258	spin_lock_irqsave(&musb->list_lock, flags);
2259	is_suspended = musb->is_runtime_suspended;
2260
2261	if (is_suspended) {
2262		w = devm_kzalloc(musb->controller, sizeof(*w), GFP_ATOMIC);
2263		if (!w) {
2264			error = -ENOMEM;
2265			goto out_unlock;
2266		}
2267
2268		w->callback = callback;
2269		w->data = data;
 
2270
 
 
 
 
2271		list_add_tail(&w->node, &musb->pending_list);
2272		error = 0;
 
 
 
 
 
2273	}
2274
2275out_unlock:
2276	spin_unlock_irqrestore(&musb->list_lock, flags);
2277
2278	if (!is_suspended)
2279		error = callback(musb, data);
2280
2281	return error;
2282}
2283EXPORT_SYMBOL_GPL(musb_queue_resume_work);
2284
2285static void musb_deassert_reset(struct work_struct *work)
2286{
2287	struct musb *musb;
2288	unsigned long flags;
2289
2290	musb = container_of(work, struct musb, deassert_reset_work.work);
2291
2292	spin_lock_irqsave(&musb->lock, flags);
2293
2294	if (musb->port1_status & USB_PORT_STAT_RESET)
2295		musb_port_reset(musb, false);
2296
2297	spin_unlock_irqrestore(&musb->lock, flags);
2298}
2299
2300/*
2301 * Perform generic per-controller initialization.
2302 *
2303 * @dev: the controller (already clocked, etc)
2304 * @nIrq: IRQ number
2305 * @ctrl: virtual address of controller registers,
2306 *	not yet corrected for platform-specific offsets
2307 */
2308static int
2309musb_init_controller(struct device *dev, int nIrq, void __iomem *ctrl)
2310{
2311	int			status;
2312	struct musb		*musb;
2313	struct musb_hdrc_platform_data *plat = dev_get_platdata(dev);
2314
2315	/* The driver might handle more features than the board; OK.
2316	 * Fail when the board needs a feature that's not enabled.
2317	 */
2318	if (!plat) {
2319		dev_err(dev, "no platform_data?\n");
2320		status = -ENODEV;
2321		goto fail0;
2322	}
2323
2324	/* allocate */
2325	musb = allocate_instance(dev, plat->config, ctrl);
2326	if (!musb) {
2327		status = -ENOMEM;
2328		goto fail0;
2329	}
2330
2331	spin_lock_init(&musb->lock);
2332	spin_lock_init(&musb->list_lock);
 
2333	musb->min_power = plat->min_power;
2334	musb->ops = plat->platform_ops;
2335	musb->port_mode = plat->mode;
2336
2337	/*
2338	 * Initialize the default IO functions. At least omap2430 needs
2339	 * these early. We initialize the platform specific IO functions
2340	 * later on.
2341	 */
2342	musb_readb = musb_default_readb;
2343	musb_writeb = musb_default_writeb;
2344	musb_readw = musb_default_readw;
2345	musb_writew = musb_default_writew;
2346
2347	/* The musb_platform_init() call:
2348	 *   - adjusts musb->mregs
2349	 *   - sets the musb->isr
2350	 *   - may initialize an integrated transceiver
2351	 *   - initializes musb->xceiv, usually by otg_get_phy()
2352	 *   - stops powering VBUS
2353	 *
2354	 * There are various transceiver configurations.
2355	 * DaVinci, TUSB60x0, and others integrate them.  OMAP3 uses
2356	 * external/discrete ones in various flavors (twl4030 family,
2357	 * isp1504, non-OTG, etc) mostly hooking up through ULPI.
2358	 */
2359	status = musb_platform_init(musb);
2360	if (status < 0)
2361		goto fail1;
2362
2363	if (!musb->isr) {
2364		status = -ENODEV;
2365		goto fail2;
2366	}
2367
2368
2369	/* Most devices use indexed offset or flat offset */
2370	if (musb->ops->quirks & MUSB_INDEXED_EP) {
2371		musb->io.ep_offset = musb_indexed_ep_offset;
2372		musb->io.ep_select = musb_indexed_ep_select;
2373	} else {
2374		musb->io.ep_offset = musb_flat_ep_offset;
2375		musb->io.ep_select = musb_flat_ep_select;
2376	}
2377
2378	if (musb->ops->quirks & MUSB_G_NO_SKB_RESERVE)
2379		musb->g.quirk_avoids_skb_reserve = 1;
2380
2381	/* At least tusb6010 has its own offsets */
2382	if (musb->ops->ep_offset)
2383		musb->io.ep_offset = musb->ops->ep_offset;
2384	if (musb->ops->ep_select)
2385		musb->io.ep_select = musb->ops->ep_select;
2386
2387	if (musb->ops->fifo_mode)
2388		fifo_mode = musb->ops->fifo_mode;
2389	else
2390		fifo_mode = 4;
2391
2392	if (musb->ops->fifo_offset)
2393		musb->io.fifo_offset = musb->ops->fifo_offset;
2394	else
2395		musb->io.fifo_offset = musb_default_fifo_offset;
2396
2397	if (musb->ops->busctl_offset)
2398		musb->io.busctl_offset = musb->ops->busctl_offset;
2399	else
2400		musb->io.busctl_offset = musb_default_busctl_offset;
2401
2402	if (musb->ops->readb)
2403		musb_readb = musb->ops->readb;
2404	if (musb->ops->writeb)
2405		musb_writeb = musb->ops->writeb;
2406	if (musb->ops->clearb)
2407		musb_clearb = musb->ops->clearb;
2408	else
2409		musb_clearb = musb_readb;
2410
2411	if (musb->ops->readw)
2412		musb_readw = musb->ops->readw;
2413	if (musb->ops->writew)
2414		musb_writew = musb->ops->writew;
2415	if (musb->ops->clearw)
2416		musb_clearw = musb->ops->clearw;
2417	else
2418		musb_clearw = musb_readw;
2419
2420#ifndef CONFIG_MUSB_PIO_ONLY
2421	if (!musb->ops->dma_init || !musb->ops->dma_exit) {
2422		dev_err(dev, "DMA controller not set\n");
2423		status = -ENODEV;
2424		goto fail2;
2425	}
2426	musb_dma_controller_create = musb->ops->dma_init;
2427	musb_dma_controller_destroy = musb->ops->dma_exit;
2428#endif
2429
2430	if (musb->ops->read_fifo)
2431		musb->io.read_fifo = musb->ops->read_fifo;
2432	else
2433		musb->io.read_fifo = musb_default_read_fifo;
2434
2435	if (musb->ops->write_fifo)
2436		musb->io.write_fifo = musb->ops->write_fifo;
2437	else
2438		musb->io.write_fifo = musb_default_write_fifo;
2439
2440	if (musb->ops->get_toggle)
2441		musb->io.get_toggle = musb->ops->get_toggle;
2442	else
2443		musb->io.get_toggle = musb_default_get_toggle;
2444
2445	if (musb->ops->set_toggle)
2446		musb->io.set_toggle = musb->ops->set_toggle;
2447	else
2448		musb->io.set_toggle = musb_default_set_toggle;
2449
2450	if (IS_ENABLED(CONFIG_USB_PHY) && musb->xceiv && !musb->xceiv->io_ops) {
2451		musb->xceiv->io_dev = musb->controller;
2452		musb->xceiv->io_priv = musb->mregs;
2453		musb->xceiv->io_ops = &musb_ulpi_access;
2454	}
2455
2456	if (musb->ops->phy_callback)
2457		musb_phy_callback = musb->ops->phy_callback;
2458
2459	/*
2460	 * We need musb_read/write functions initialized for PM.
2461	 * Note that at least 2430 glue needs autosuspend delay
2462	 * somewhere above 300 ms for the hardware to idle properly
2463	 * after disconnecting the cable in host mode. Let's use
2464	 * 500 ms for some margin.
2465	 */
2466	pm_runtime_use_autosuspend(musb->controller);
2467	pm_runtime_set_autosuspend_delay(musb->controller, 500);
2468	pm_runtime_enable(musb->controller);
2469	pm_runtime_get_sync(musb->controller);
2470
2471	status = usb_phy_init(musb->xceiv);
2472	if (status < 0)
2473		goto err_usb_phy_init;
2474
2475	if (use_dma && dev->dma_mask) {
2476		musb->dma_controller =
2477			musb_dma_controller_create(musb, musb->mregs);
2478		if (IS_ERR(musb->dma_controller)) {
2479			status = PTR_ERR(musb->dma_controller);
2480			goto fail2_5;
2481		}
2482	}
2483
2484	/* be sure interrupts are disabled before connecting ISR */
2485	musb_platform_disable(musb);
2486	musb_disable_interrupts(musb);
2487	musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
2488
2489	/* MUSB_POWER_SOFTCONN might be already set, JZ4740 does this. */
2490	musb_writeb(musb->mregs, MUSB_POWER, 0);
2491
2492	/* Init IRQ workqueue before request_irq */
2493	INIT_DELAYED_WORK(&musb->irq_work, musb_irq_work);
2494	INIT_DELAYED_WORK(&musb->deassert_reset_work, musb_deassert_reset);
2495	INIT_DELAYED_WORK(&musb->finish_resume_work, musb_host_finish_resume);
2496
2497	/* setup musb parts of the core (especially endpoints) */
2498	status = musb_core_init(plat->config->multipoint
2499			? MUSB_CONTROLLER_MHDRC
2500			: MUSB_CONTROLLER_HDRC, musb);
2501	if (status < 0)
2502		goto fail3;
2503
2504	timer_setup(&musb->otg_timer, musb_otg_timer_func, 0);
2505
2506	/* attach to the IRQ */
2507	if (request_irq(nIrq, musb->isr, IRQF_SHARED, dev_name(dev), musb)) {
2508		dev_err(dev, "request_irq %d failed!\n", nIrq);
2509		status = -ENODEV;
2510		goto fail3;
2511	}
2512	musb->nIrq = nIrq;
2513	/* FIXME this handles wakeup irqs wrong */
2514	if (enable_irq_wake(nIrq) == 0) {
2515		musb->irq_wake = 1;
2516		device_init_wakeup(dev, 1);
2517	} else {
2518		musb->irq_wake = 0;
2519	}
2520
2521	/* program PHY to use external vBus if required */
2522	if (plat->extvbus) {
2523		u8 busctl = musb_readb(musb->mregs, MUSB_ULPI_BUSCONTROL);
2524		busctl |= MUSB_ULPI_USE_EXTVBUS;
2525		musb_writeb(musb->mregs, MUSB_ULPI_BUSCONTROL, busctl);
2526	}
2527
2528	MUSB_DEV_MODE(musb);
2529	musb_set_state(musb, OTG_STATE_B_IDLE);
2530
2531	switch (musb->port_mode) {
2532	case MUSB_HOST:
2533		status = musb_host_setup(musb, plat->power);
2534		if (status < 0)
2535			goto fail3;
2536		status = musb_platform_set_mode(musb, MUSB_HOST);
2537		break;
2538	case MUSB_PERIPHERAL:
2539		status = musb_gadget_setup(musb);
2540		if (status < 0)
2541			goto fail3;
2542		status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
2543		break;
2544	case MUSB_OTG:
2545		status = musb_host_setup(musb, plat->power);
2546		if (status < 0)
2547			goto fail3;
2548		status = musb_gadget_setup(musb);
2549		if (status) {
2550			musb_host_cleanup(musb);
2551			goto fail3;
2552		}
2553		status = musb_platform_set_mode(musb, MUSB_OTG);
2554		break;
2555	default:
2556		dev_err(dev, "unsupported port mode %d\n", musb->port_mode);
2557		break;
2558	}
2559
2560	if (status < 0)
2561		goto fail3;
2562
2563	musb_init_debugfs(musb);
2564
2565	musb->is_initialized = 1;
2566	pm_runtime_mark_last_busy(musb->controller);
2567	pm_runtime_put_autosuspend(musb->controller);
2568
2569	return 0;
2570
2571fail3:
2572	cancel_delayed_work_sync(&musb->irq_work);
2573	cancel_delayed_work_sync(&musb->finish_resume_work);
2574	cancel_delayed_work_sync(&musb->deassert_reset_work);
2575	if (musb->dma_controller)
2576		musb_dma_controller_destroy(musb->dma_controller);
2577
2578fail2_5:
2579	usb_phy_shutdown(musb->xceiv);
2580
2581err_usb_phy_init:
2582	pm_runtime_dont_use_autosuspend(musb->controller);
2583	pm_runtime_put_sync(musb->controller);
2584	pm_runtime_disable(musb->controller);
2585
2586fail2:
2587	if (musb->irq_wake)
2588		device_init_wakeup(dev, 0);
2589	musb_platform_exit(musb);
2590
2591fail1:
2592	dev_err_probe(musb->controller, status, "%s failed\n", __func__);
 
 
2593
2594	musb_free(musb);
2595
2596fail0:
2597
2598	return status;
2599
2600}
2601
2602/*-------------------------------------------------------------------------*/
2603
2604/* all implementations (PCI bridge to FPGA, VLYNQ, etc) should just
2605 * bridge to a platform device; this driver then suffices.
2606 */
2607static int musb_probe(struct platform_device *pdev)
2608{
2609	struct device	*dev = &pdev->dev;
2610	int		irq = platform_get_irq_byname(pdev, "mc");
 
2611	void __iomem	*base;
2612
2613	if (irq < 0)
2614		return irq;
2615
2616	base = devm_platform_ioremap_resource(pdev, 0);
 
2617	if (IS_ERR(base))
2618		return PTR_ERR(base);
2619
2620	return musb_init_controller(dev, irq, base);
2621}
2622
2623static void musb_remove(struct platform_device *pdev)
2624{
2625	struct device	*dev = &pdev->dev;
2626	struct musb	*musb = dev_to_musb(dev);
2627	unsigned long	flags;
2628
2629	/* this gets called on rmmod.
2630	 *  - Host mode: host may still be active
2631	 *  - Peripheral mode: peripheral is deactivated (or never-activated)
2632	 *  - OTG mode: both roles are deactivated (or never-activated)
2633	 */
2634	musb_exit_debugfs(musb);
2635
2636	cancel_delayed_work_sync(&musb->irq_work);
2637	cancel_delayed_work_sync(&musb->finish_resume_work);
2638	cancel_delayed_work_sync(&musb->deassert_reset_work);
2639	pm_runtime_get_sync(musb->controller);
2640	musb_host_cleanup(musb);
2641	musb_gadget_cleanup(musb);
2642
2643	musb_platform_disable(musb);
2644	spin_lock_irqsave(&musb->lock, flags);
2645	musb_disable_interrupts(musb);
2646	musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
2647	spin_unlock_irqrestore(&musb->lock, flags);
2648	musb_platform_exit(musb);
2649
2650	pm_runtime_dont_use_autosuspend(musb->controller);
2651	pm_runtime_put_sync(musb->controller);
2652	pm_runtime_disable(musb->controller);
2653	musb_phy_callback = NULL;
2654	if (musb->dma_controller)
2655		musb_dma_controller_destroy(musb->dma_controller);
2656	usb_phy_shutdown(musb->xceiv);
2657	musb_free(musb);
2658	device_init_wakeup(dev, 0);
 
2659}
2660
2661#ifdef	CONFIG_PM
2662
2663static void musb_save_context(struct musb *musb)
2664{
2665	int i;
2666	void __iomem *musb_base = musb->mregs;
2667	void __iomem *epio;
2668
2669	musb->context.frame = musb_readw(musb_base, MUSB_FRAME);
2670	musb->context.testmode = musb_readb(musb_base, MUSB_TESTMODE);
2671	musb->context.busctl = musb_readb(musb_base, MUSB_ULPI_BUSCONTROL);
2672	musb->context.power = musb_readb(musb_base, MUSB_POWER);
2673	musb->context.intrusbe = musb_readb(musb_base, MUSB_INTRUSBE);
2674	musb->context.index = musb_readb(musb_base, MUSB_INDEX);
2675	musb->context.devctl = musb_readb(musb_base, MUSB_DEVCTL);
2676
2677	for (i = 0; i < musb->config->num_eps; ++i) {
2678		epio = musb->endpoints[i].regs;
 
 
 
 
 
 
2679		if (!epio)
2680			continue;
2681
2682		musb_writeb(musb_base, MUSB_INDEX, i);
2683		musb->context.index_regs[i].txmaxp =
2684			musb_readw(epio, MUSB_TXMAXP);
2685		musb->context.index_regs[i].txcsr =
2686			musb_readw(epio, MUSB_TXCSR);
2687		musb->context.index_regs[i].rxmaxp =
2688			musb_readw(epio, MUSB_RXMAXP);
2689		musb->context.index_regs[i].rxcsr =
2690			musb_readw(epio, MUSB_RXCSR);
2691
2692		if (musb->dyn_fifo) {
2693			musb->context.index_regs[i].txfifoadd =
2694					musb_readw(musb_base, MUSB_TXFIFOADD);
2695			musb->context.index_regs[i].rxfifoadd =
2696					musb_readw(musb_base, MUSB_RXFIFOADD);
2697			musb->context.index_regs[i].txfifosz =
2698					musb_readb(musb_base, MUSB_TXFIFOSZ);
2699			musb->context.index_regs[i].rxfifosz =
2700					musb_readb(musb_base, MUSB_RXFIFOSZ);
2701		}
2702
2703		musb->context.index_regs[i].txtype =
2704			musb_readb(epio, MUSB_TXTYPE);
2705		musb->context.index_regs[i].txinterval =
2706			musb_readb(epio, MUSB_TXINTERVAL);
2707		musb->context.index_regs[i].rxtype =
2708			musb_readb(epio, MUSB_RXTYPE);
2709		musb->context.index_regs[i].rxinterval =
2710			musb_readb(epio, MUSB_RXINTERVAL);
2711
2712		musb->context.index_regs[i].txfunaddr =
2713			musb_read_txfunaddr(musb, i);
2714		musb->context.index_regs[i].txhubaddr =
2715			musb_read_txhubaddr(musb, i);
2716		musb->context.index_regs[i].txhubport =
2717			musb_read_txhubport(musb, i);
2718
2719		musb->context.index_regs[i].rxfunaddr =
2720			musb_read_rxfunaddr(musb, i);
2721		musb->context.index_regs[i].rxhubaddr =
2722			musb_read_rxhubaddr(musb, i);
2723		musb->context.index_regs[i].rxhubport =
2724			musb_read_rxhubport(musb, i);
2725	}
2726}
2727
2728static void musb_restore_context(struct musb *musb)
2729{
2730	int i;
2731	void __iomem *musb_base = musb->mregs;
2732	void __iomem *epio;
2733	u8 power;
2734
2735	musb_writew(musb_base, MUSB_FRAME, musb->context.frame);
2736	musb_writeb(musb_base, MUSB_TESTMODE, musb->context.testmode);
2737	musb_writeb(musb_base, MUSB_ULPI_BUSCONTROL, musb->context.busctl);
2738
2739	/* Don't affect SUSPENDM/RESUME bits in POWER reg */
2740	power = musb_readb(musb_base, MUSB_POWER);
2741	power &= MUSB_POWER_SUSPENDM | MUSB_POWER_RESUME;
2742	musb->context.power &= ~(MUSB_POWER_SUSPENDM | MUSB_POWER_RESUME);
2743	power |= musb->context.power;
2744	musb_writeb(musb_base, MUSB_POWER, power);
2745
2746	musb_writew(musb_base, MUSB_INTRTXE, musb->intrtxe);
2747	musb_writew(musb_base, MUSB_INTRRXE, musb->intrrxe);
2748	musb_writeb(musb_base, MUSB_INTRUSBE, musb->context.intrusbe);
2749	if (musb->context.devctl & MUSB_DEVCTL_SESSION)
2750		musb_writeb(musb_base, MUSB_DEVCTL, musb->context.devctl);
2751
2752	for (i = 0; i < musb->config->num_eps; ++i) {
2753		epio = musb->endpoints[i].regs;
 
 
 
 
 
 
2754		if (!epio)
2755			continue;
2756
2757		musb_writeb(musb_base, MUSB_INDEX, i);
2758		musb_writew(epio, MUSB_TXMAXP,
2759			musb->context.index_regs[i].txmaxp);
2760		musb_writew(epio, MUSB_TXCSR,
2761			musb->context.index_regs[i].txcsr);
2762		musb_writew(epio, MUSB_RXMAXP,
2763			musb->context.index_regs[i].rxmaxp);
2764		musb_writew(epio, MUSB_RXCSR,
2765			musb->context.index_regs[i].rxcsr);
2766
2767		if (musb->dyn_fifo) {
2768			musb_writeb(musb_base, MUSB_TXFIFOSZ,
2769				musb->context.index_regs[i].txfifosz);
2770			musb_writeb(musb_base, MUSB_RXFIFOSZ,
2771				musb->context.index_regs[i].rxfifosz);
2772			musb_writew(musb_base, MUSB_TXFIFOADD,
2773				musb->context.index_regs[i].txfifoadd);
2774			musb_writew(musb_base, MUSB_RXFIFOADD,
2775				musb->context.index_regs[i].rxfifoadd);
2776		}
2777
2778		musb_writeb(epio, MUSB_TXTYPE,
2779				musb->context.index_regs[i].txtype);
2780		musb_writeb(epio, MUSB_TXINTERVAL,
2781				musb->context.index_regs[i].txinterval);
2782		musb_writeb(epio, MUSB_RXTYPE,
2783				musb->context.index_regs[i].rxtype);
2784		musb_writeb(epio, MUSB_RXINTERVAL,
2785
2786				musb->context.index_regs[i].rxinterval);
2787		musb_write_txfunaddr(musb, i,
2788				musb->context.index_regs[i].txfunaddr);
2789		musb_write_txhubaddr(musb, i,
2790				musb->context.index_regs[i].txhubaddr);
2791		musb_write_txhubport(musb, i,
2792				musb->context.index_regs[i].txhubport);
2793
2794		musb_write_rxfunaddr(musb, i,
2795				musb->context.index_regs[i].rxfunaddr);
2796		musb_write_rxhubaddr(musb, i,
2797				musb->context.index_regs[i].rxhubaddr);
2798		musb_write_rxhubport(musb, i,
2799				musb->context.index_regs[i].rxhubport);
2800	}
2801	musb_writeb(musb_base, MUSB_INDEX, musb->context.index);
2802}
2803
2804static int musb_suspend(struct device *dev)
2805{
2806	struct musb	*musb = dev_to_musb(dev);
2807	unsigned long	flags;
2808	int ret;
2809
2810	ret = pm_runtime_get_sync(dev);
2811	if (ret < 0) {
2812		pm_runtime_put_noidle(dev);
2813		return ret;
2814	}
2815
2816	musb_platform_disable(musb);
2817	musb_disable_interrupts(musb);
2818
2819	musb->flush_irq_work = true;
2820	while (flush_delayed_work(&musb->irq_work))
2821		;
2822	musb->flush_irq_work = false;
2823
2824	if (!(musb->ops->quirks & MUSB_PRESERVE_SESSION))
2825		musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
2826
2827	WARN_ON(!list_empty(&musb->pending_list));
2828
2829	spin_lock_irqsave(&musb->lock, flags);
2830
2831	if (is_peripheral_active(musb)) {
2832		/* FIXME force disconnect unless we know USB will wake
2833		 * the system up quickly enough to respond ...
2834		 */
2835	} else if (is_host_active(musb)) {
2836		/* we know all the children are suspended; sometimes
2837		 * they will even be wakeup-enabled.
2838		 */
2839	}
2840
2841	musb_save_context(musb);
2842
2843	spin_unlock_irqrestore(&musb->lock, flags);
2844	return 0;
2845}
2846
2847static int musb_resume(struct device *dev)
2848{
2849	struct musb *musb = dev_to_musb(dev);
2850	unsigned long flags;
2851	int error;
2852	u8 devctl;
2853	u8 mask;
2854
2855	/*
2856	 * For static cmos like DaVinci, register values were preserved
2857	 * unless for some reason the whole soc powered down or the USB
2858	 * module got reset through the PSC (vs just being disabled).
2859	 *
2860	 * For the DSPS glue layer though, a full register restore has to
2861	 * be done. As it shouldn't harm other platforms, we do it
2862	 * unconditionally.
2863	 */
2864
2865	musb_restore_context(musb);
2866
2867	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
2868	mask = MUSB_DEVCTL_BDEVICE | MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV;
2869	if ((devctl & mask) != (musb->context.devctl & mask))
2870		musb->port1_status = 0;
2871
2872	musb_enable_interrupts(musb);
2873	musb_platform_enable(musb);
2874
2875	/* session might be disabled in suspend */
2876	if (musb->port_mode == MUSB_HOST &&
2877	    !(musb->ops->quirks & MUSB_PRESERVE_SESSION)) {
2878		devctl |= MUSB_DEVCTL_SESSION;
2879		musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
2880	}
2881
2882	spin_lock_irqsave(&musb->lock, flags);
2883	error = musb_run_resume_work(musb);
2884	if (error)
2885		dev_err(musb->controller, "resume work failed with %i\n",
2886			error);
2887	spin_unlock_irqrestore(&musb->lock, flags);
2888
2889	pm_runtime_mark_last_busy(dev);
2890	pm_runtime_put_autosuspend(dev);
2891
2892	return 0;
2893}
2894
2895static int musb_runtime_suspend(struct device *dev)
2896{
2897	struct musb	*musb = dev_to_musb(dev);
2898
2899	musb_save_context(musb);
2900	musb->is_runtime_suspended = 1;
2901
2902	return 0;
2903}
2904
2905static int musb_runtime_resume(struct device *dev)
2906{
2907	struct musb *musb = dev_to_musb(dev);
2908	unsigned long flags;
2909	int error;
2910
2911	/*
2912	 * When pm_runtime_get_sync called for the first time in driver
2913	 * init,  some of the structure is still not initialized which is
2914	 * used in restore function. But clock needs to be
2915	 * enabled before any register access, so
2916	 * pm_runtime_get_sync has to be called.
2917	 * Also context restore without save does not make
2918	 * any sense
2919	 */
2920	if (!musb->is_initialized)
2921		return 0;
2922
2923	musb_restore_context(musb);
2924
2925	spin_lock_irqsave(&musb->lock, flags);
2926	error = musb_run_resume_work(musb);
2927	if (error)
2928		dev_err(musb->controller, "resume work failed with %i\n",
2929			error);
2930	musb->is_runtime_suspended = 0;
2931	spin_unlock_irqrestore(&musb->lock, flags);
2932
2933	return 0;
2934}
2935
2936static const struct dev_pm_ops musb_dev_pm_ops = {
2937	.suspend	= musb_suspend,
2938	.resume		= musb_resume,
2939	.runtime_suspend = musb_runtime_suspend,
2940	.runtime_resume = musb_runtime_resume,
2941};
2942
2943#define MUSB_DEV_PM_OPS (&musb_dev_pm_ops)
2944#else
2945#define	MUSB_DEV_PM_OPS	NULL
2946#endif
2947
2948static struct platform_driver musb_driver = {
2949	.driver = {
2950		.name		= musb_driver_name,
2951		.bus		= &platform_bus_type,
2952		.pm		= MUSB_DEV_PM_OPS,
2953		.dev_groups	= musb_groups,
2954	},
2955	.probe		= musb_probe,
2956	.remove_new	= musb_remove,
2957};
2958
2959module_platform_driver(musb_driver);
v5.4
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3 * MUSB OTG driver core code
   4 *
   5 * Copyright 2005 Mentor Graphics Corporation
   6 * Copyright (C) 2005-2006 by Texas Instruments
   7 * Copyright (C) 2006-2007 Nokia Corporation
   8 */
   9
  10/*
  11 * Inventra (Multipoint) Dual-Role Controller Driver for Linux.
  12 *
  13 * This consists of a Host Controller Driver (HCD) and a peripheral
  14 * controller driver implementing the "Gadget" API; OTG support is
  15 * in the works.  These are normal Linux-USB controller drivers which
  16 * use IRQs and have no dedicated thread.
  17 *
  18 * This version of the driver has only been used with products from
  19 * Texas Instruments.  Those products integrate the Inventra logic
  20 * with other DMA, IRQ, and bus modules, as well as other logic that
  21 * needs to be reflected in this driver.
  22 *
  23 *
  24 * NOTE:  the original Mentor code here was pretty much a collection
  25 * of mechanisms that don't seem to have been fully integrated/working
  26 * for *any* Linux kernel version.  This version aims at Linux 2.6.now,
  27 * Key open issues include:
  28 *
  29 *  - Lack of host-side transaction scheduling, for all transfer types.
  30 *    The hardware doesn't do it; instead, software must.
  31 *
  32 *    This is not an issue for OTG devices that don't support external
  33 *    hubs, but for more "normal" USB hosts it's a user issue that the
  34 *    "multipoint" support doesn't scale in the expected ways.  That
  35 *    includes DaVinci EVM in a common non-OTG mode.
  36 *
  37 *      * Control and bulk use dedicated endpoints, and there's as
  38 *        yet no mechanism to either (a) reclaim the hardware when
  39 *        peripherals are NAKing, which gets complicated with bulk
  40 *        endpoints, or (b) use more than a single bulk endpoint in
  41 *        each direction.
  42 *
  43 *        RESULT:  one device may be perceived as blocking another one.
  44 *
  45 *      * Interrupt and isochronous will dynamically allocate endpoint
  46 *        hardware, but (a) there's no record keeping for bandwidth;
  47 *        (b) in the common case that few endpoints are available, there
  48 *        is no mechanism to reuse endpoints to talk to multiple devices.
  49 *
  50 *        RESULT:  At one extreme, bandwidth can be overcommitted in
  51 *        some hardware configurations, no faults will be reported.
  52 *        At the other extreme, the bandwidth capabilities which do
  53 *        exist tend to be severely undercommitted.  You can't yet hook
  54 *        up both a keyboard and a mouse to an external USB hub.
  55 */
  56
  57/*
  58 * This gets many kinds of configuration information:
  59 *	- Kconfig for everything user-configurable
  60 *	- platform_device for addressing, irq, and platform_data
  61 *	- platform_data is mostly for board-specific information
  62 *	  (plus recentrly, SOC or family details)
  63 *
  64 * Most of the conditional compilation will (someday) vanish.
  65 */
  66
  67#include <linux/module.h>
  68#include <linux/kernel.h>
  69#include <linux/sched.h>
  70#include <linux/slab.h>
  71#include <linux/list.h>
  72#include <linux/kobject.h>
  73#include <linux/prefetch.h>
  74#include <linux/platform_device.h>
  75#include <linux/io.h>
 
  76#include <linux/dma-mapping.h>
  77#include <linux/usb.h>
  78#include <linux/usb/of.h>
  79
  80#include "musb_core.h"
  81#include "musb_trace.h"
  82
  83#define TA_WAIT_BCON(m) max_t(int, (m)->a_wait_bcon, OTG_TIME_A_WAIT_BCON)
  84
  85
  86#define DRIVER_AUTHOR "Mentor Graphics, Texas Instruments, Nokia"
  87#define DRIVER_DESC "Inventra Dual-Role USB Controller Driver"
  88
  89#define MUSB_VERSION "6.0"
  90
  91#define DRIVER_INFO DRIVER_DESC ", v" MUSB_VERSION
  92
  93#define MUSB_DRIVER_NAME "musb-hdrc"
  94const char musb_driver_name[] = MUSB_DRIVER_NAME;
  95
  96MODULE_DESCRIPTION(DRIVER_INFO);
  97MODULE_AUTHOR(DRIVER_AUTHOR);
  98MODULE_LICENSE("GPL");
  99MODULE_ALIAS("platform:" MUSB_DRIVER_NAME);
 100
 101
 102/*-------------------------------------------------------------------------*/
 103
 104static inline struct musb *dev_to_musb(struct device *dev)
 105{
 106	return dev_get_drvdata(dev);
 107}
 108
 109enum musb_mode musb_get_mode(struct device *dev)
 110{
 111	enum usb_dr_mode mode;
 112
 113	mode = usb_get_dr_mode(dev);
 114	switch (mode) {
 115	case USB_DR_MODE_HOST:
 116		return MUSB_HOST;
 117	case USB_DR_MODE_PERIPHERAL:
 118		return MUSB_PERIPHERAL;
 119	case USB_DR_MODE_OTG:
 120	case USB_DR_MODE_UNKNOWN:
 121	default:
 122		return MUSB_OTG;
 123	}
 124}
 125EXPORT_SYMBOL_GPL(musb_get_mode);
 126
 127/*-------------------------------------------------------------------------*/
 128
 129static int musb_ulpi_read(struct usb_phy *phy, u32 reg)
 130{
 131	void __iomem *addr = phy->io_priv;
 132	int	i = 0;
 133	u8	r;
 134	u8	power;
 135	int	ret;
 136
 137	pm_runtime_get_sync(phy->io_dev);
 138
 139	/* Make sure the transceiver is not in low power mode */
 140	power = musb_readb(addr, MUSB_POWER);
 141	power &= ~MUSB_POWER_SUSPENDM;
 142	musb_writeb(addr, MUSB_POWER, power);
 143
 144	/* REVISIT: musbhdrc_ulpi_an.pdf recommends setting the
 145	 * ULPICarKitControlDisableUTMI after clearing POWER_SUSPENDM.
 146	 */
 147
 148	musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)reg);
 149	musb_writeb(addr, MUSB_ULPI_REG_CONTROL,
 150			MUSB_ULPI_REG_REQ | MUSB_ULPI_RDN_WR);
 151
 152	while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
 153				& MUSB_ULPI_REG_CMPLT)) {
 154		i++;
 155		if (i == 10000) {
 156			ret = -ETIMEDOUT;
 157			goto out;
 158		}
 159
 160	}
 161	r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
 162	r &= ~MUSB_ULPI_REG_CMPLT;
 163	musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
 164
 165	ret = musb_readb(addr, MUSB_ULPI_REG_DATA);
 166
 167out:
 168	pm_runtime_put(phy->io_dev);
 169
 170	return ret;
 171}
 172
 173static int musb_ulpi_write(struct usb_phy *phy, u32 val, u32 reg)
 174{
 175	void __iomem *addr = phy->io_priv;
 176	int	i = 0;
 177	u8	r = 0;
 178	u8	power;
 179	int	ret = 0;
 180
 181	pm_runtime_get_sync(phy->io_dev);
 182
 183	/* Make sure the transceiver is not in low power mode */
 184	power = musb_readb(addr, MUSB_POWER);
 185	power &= ~MUSB_POWER_SUSPENDM;
 186	musb_writeb(addr, MUSB_POWER, power);
 187
 188	musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)reg);
 189	musb_writeb(addr, MUSB_ULPI_REG_DATA, (u8)val);
 190	musb_writeb(addr, MUSB_ULPI_REG_CONTROL, MUSB_ULPI_REG_REQ);
 191
 192	while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
 193				& MUSB_ULPI_REG_CMPLT)) {
 194		i++;
 195		if (i == 10000) {
 196			ret = -ETIMEDOUT;
 197			goto out;
 198		}
 199	}
 200
 201	r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
 202	r &= ~MUSB_ULPI_REG_CMPLT;
 203	musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
 204
 205out:
 206	pm_runtime_put(phy->io_dev);
 207
 208	return ret;
 209}
 210
 211static struct usb_phy_io_ops musb_ulpi_access = {
 212	.read = musb_ulpi_read,
 213	.write = musb_ulpi_write,
 214};
 215
 216/*-------------------------------------------------------------------------*/
 217
 218static u32 musb_default_fifo_offset(u8 epnum)
 219{
 220	return 0x20 + (epnum * 4);
 221}
 222
 223/* "flat" mapping: each endpoint has its own i/o address */
 224static void musb_flat_ep_select(void __iomem *mbase, u8 epnum)
 225{
 226}
 227
 228static u32 musb_flat_ep_offset(u8 epnum, u16 offset)
 229{
 230	return 0x100 + (0x10 * epnum) + offset;
 231}
 232
 233/* "indexed" mapping: INDEX register controls register bank select */
 234static void musb_indexed_ep_select(void __iomem *mbase, u8 epnum)
 235{
 236	musb_writeb(mbase, MUSB_INDEX, epnum);
 237}
 238
 239static u32 musb_indexed_ep_offset(u8 epnum, u16 offset)
 240{
 241	return 0x10 + offset;
 242}
 243
 244static u32 musb_default_busctl_offset(u8 epnum, u16 offset)
 245{
 246	return 0x80 + (0x08 * epnum) + offset;
 247}
 248
 249static u8 musb_default_readb(const void __iomem *addr, unsigned offset)
 250{
 251	u8 data =  __raw_readb(addr + offset);
 252
 253	trace_musb_readb(__builtin_return_address(0), addr, offset, data);
 254	return data;
 255}
 256
 257static void musb_default_writeb(void __iomem *addr, unsigned offset, u8 data)
 258{
 259	trace_musb_writeb(__builtin_return_address(0), addr, offset, data);
 260	__raw_writeb(data, addr + offset);
 261}
 262
 263static u16 musb_default_readw(const void __iomem *addr, unsigned offset)
 264{
 265	u16 data = __raw_readw(addr + offset);
 266
 267	trace_musb_readw(__builtin_return_address(0), addr, offset, data);
 268	return data;
 269}
 270
 271static void musb_default_writew(void __iomem *addr, unsigned offset, u16 data)
 272{
 273	trace_musb_writew(__builtin_return_address(0), addr, offset, data);
 274	__raw_writew(data, addr + offset);
 275}
 276
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 277/*
 278 * Load an endpoint's FIFO
 279 */
 280static void musb_default_write_fifo(struct musb_hw_ep *hw_ep, u16 len,
 281				    const u8 *src)
 282{
 283	struct musb *musb = hw_ep->musb;
 284	void __iomem *fifo = hw_ep->fifo;
 285
 286	if (unlikely(len == 0))
 287		return;
 288
 289	prefetch((u8 *)src);
 290
 291	dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
 292			'T', hw_ep->epnum, fifo, len, src);
 293
 294	/* we can't assume unaligned reads work */
 295	if (likely((0x01 & (unsigned long) src) == 0)) {
 296		u16	index = 0;
 297
 298		/* best case is 32bit-aligned source address */
 299		if ((0x02 & (unsigned long) src) == 0) {
 300			if (len >= 4) {
 301				iowrite32_rep(fifo, src + index, len >> 2);
 302				index += len & ~0x03;
 303			}
 304			if (len & 0x02) {
 305				__raw_writew(*(u16 *)&src[index], fifo);
 306				index += 2;
 307			}
 308		} else {
 309			if (len >= 2) {
 310				iowrite16_rep(fifo, src + index, len >> 1);
 311				index += len & ~0x01;
 312			}
 313		}
 314		if (len & 0x01)
 315			__raw_writeb(src[index], fifo);
 316	} else  {
 317		/* byte aligned */
 318		iowrite8_rep(fifo, src, len);
 319	}
 320}
 321
 322/*
 323 * Unload an endpoint's FIFO
 324 */
 325static void musb_default_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
 326{
 327	struct musb *musb = hw_ep->musb;
 328	void __iomem *fifo = hw_ep->fifo;
 329
 330	if (unlikely(len == 0))
 331		return;
 332
 333	dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
 334			'R', hw_ep->epnum, fifo, len, dst);
 335
 336	/* we can't assume unaligned writes work */
 337	if (likely((0x01 & (unsigned long) dst) == 0)) {
 338		u16	index = 0;
 339
 340		/* best case is 32bit-aligned destination address */
 341		if ((0x02 & (unsigned long) dst) == 0) {
 342			if (len >= 4) {
 343				ioread32_rep(fifo, dst, len >> 2);
 344				index = len & ~0x03;
 345			}
 346			if (len & 0x02) {
 347				*(u16 *)&dst[index] = __raw_readw(fifo);
 348				index += 2;
 349			}
 350		} else {
 351			if (len >= 2) {
 352				ioread16_rep(fifo, dst, len >> 1);
 353				index = len & ~0x01;
 354			}
 355		}
 356		if (len & 0x01)
 357			dst[index] = __raw_readb(fifo);
 358	} else  {
 359		/* byte aligned */
 360		ioread8_rep(fifo, dst, len);
 361	}
 362}
 363
 364/*
 365 * Old style IO functions
 366 */
 367u8 (*musb_readb)(const void __iomem *addr, unsigned offset);
 368EXPORT_SYMBOL_GPL(musb_readb);
 369
 370void (*musb_writeb)(void __iomem *addr, unsigned offset, u8 data);
 371EXPORT_SYMBOL_GPL(musb_writeb);
 372
 373u16 (*musb_readw)(const void __iomem *addr, unsigned offset);
 
 
 
 374EXPORT_SYMBOL_GPL(musb_readw);
 375
 376void (*musb_writew)(void __iomem *addr, unsigned offset, u16 data);
 377EXPORT_SYMBOL_GPL(musb_writew);
 378
 379u32 musb_readl(const void __iomem *addr, unsigned offset)
 
 
 
 380{
 381	u32 data = __raw_readl(addr + offset);
 382
 383	trace_musb_readl(__builtin_return_address(0), addr, offset, data);
 384	return data;
 385}
 386EXPORT_SYMBOL_GPL(musb_readl);
 387
 388void musb_writel(void __iomem *addr, unsigned offset, u32 data)
 389{
 390	trace_musb_writel(__builtin_return_address(0), addr, offset, data);
 391	__raw_writel(data, addr + offset);
 392}
 393EXPORT_SYMBOL_GPL(musb_writel);
 394
 395#ifndef CONFIG_MUSB_PIO_ONLY
 396struct dma_controller *
 397(*musb_dma_controller_create)(struct musb *musb, void __iomem *base);
 398EXPORT_SYMBOL(musb_dma_controller_create);
 399
 400void (*musb_dma_controller_destroy)(struct dma_controller *c);
 401EXPORT_SYMBOL(musb_dma_controller_destroy);
 402#endif
 403
 404/*
 405 * New style IO functions
 406 */
 407void musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
 408{
 409	return hw_ep->musb->io.read_fifo(hw_ep, len, dst);
 410}
 411
 412void musb_write_fifo(struct musb_hw_ep *hw_ep, u16 len, const u8 *src)
 413{
 414	return hw_ep->musb->io.write_fifo(hw_ep, len, src);
 415}
 416
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 417/*-------------------------------------------------------------------------*/
 418
 419/* for high speed test mode; see USB 2.0 spec 7.1.20 */
 420static const u8 musb_test_packet[53] = {
 421	/* implicit SYNC then DATA0 to start */
 422
 423	/* JKJKJKJK x9 */
 424	0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 425	/* JJKKJJKK x8 */
 426	0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
 427	/* JJJJKKKK x8 */
 428	0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee,
 429	/* JJJJJJJKKKKKKK x8 */
 430	0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
 431	/* JJJJJJJK x8 */
 432	0x7f, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd,
 433	/* JKKKKKKK x10, JK */
 434	0xfc, 0x7e, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd, 0x7e
 435
 436	/* implicit CRC16 then EOP to end */
 437};
 438
 439void musb_load_testpacket(struct musb *musb)
 440{
 441	void __iomem	*regs = musb->endpoints[0].regs;
 442
 443	musb_ep_select(musb->mregs, 0);
 444	musb_write_fifo(musb->control_ep,
 445			sizeof(musb_test_packet), musb_test_packet);
 446	musb_writew(regs, MUSB_CSR0, MUSB_CSR0_TXPKTRDY);
 447}
 448
 449/*-------------------------------------------------------------------------*/
 450
 451/*
 452 * Handles OTG hnp timeouts, such as b_ase0_brst
 453 */
 454static void musb_otg_timer_func(struct timer_list *t)
 455{
 456	struct musb	*musb = from_timer(musb, t, otg_timer);
 457	unsigned long	flags;
 458
 459	spin_lock_irqsave(&musb->lock, flags);
 460	switch (musb->xceiv->otg->state) {
 461	case OTG_STATE_B_WAIT_ACON:
 462		musb_dbg(musb,
 463			"HNP: b_wait_acon timeout; back to b_peripheral");
 464		musb_g_disconnect(musb);
 465		musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
 466		musb->is_active = 0;
 467		break;
 468	case OTG_STATE_A_SUSPEND:
 469	case OTG_STATE_A_WAIT_BCON:
 470		musb_dbg(musb, "HNP: %s timeout",
 471			usb_otg_state_string(musb->xceiv->otg->state));
 472		musb_platform_set_vbus(musb, 0);
 473		musb->xceiv->otg->state = OTG_STATE_A_WAIT_VFALL;
 474		break;
 475	default:
 476		musb_dbg(musb, "HNP: Unhandled mode %s",
 477			usb_otg_state_string(musb->xceiv->otg->state));
 478	}
 479	spin_unlock_irqrestore(&musb->lock, flags);
 480}
 481
 482/*
 483 * Stops the HNP transition. Caller must take care of locking.
 484 */
 485void musb_hnp_stop(struct musb *musb)
 486{
 487	struct usb_hcd	*hcd = musb->hcd;
 488	void __iomem	*mbase = musb->mregs;
 489	u8	reg;
 490
 491	musb_dbg(musb, "HNP: stop from %s",
 492			usb_otg_state_string(musb->xceiv->otg->state));
 493
 494	switch (musb->xceiv->otg->state) {
 495	case OTG_STATE_A_PERIPHERAL:
 496		musb_g_disconnect(musb);
 497		musb_dbg(musb, "HNP: back to %s",
 498			usb_otg_state_string(musb->xceiv->otg->state));
 499		break;
 500	case OTG_STATE_B_HOST:
 501		musb_dbg(musb, "HNP: Disabling HR");
 502		if (hcd)
 503			hcd->self.is_b_host = 0;
 504		musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
 505		MUSB_DEV_MODE(musb);
 506		reg = musb_readb(mbase, MUSB_POWER);
 507		reg |= MUSB_POWER_SUSPENDM;
 508		musb_writeb(mbase, MUSB_POWER, reg);
 509		/* REVISIT: Start SESSION_REQUEST here? */
 510		break;
 511	default:
 512		musb_dbg(musb, "HNP: Stopping in unknown state %s",
 513			usb_otg_state_string(musb->xceiv->otg->state));
 514	}
 515
 516	/*
 517	 * When returning to A state after HNP, avoid hub_port_rebounce(),
 518	 * which cause occasional OPT A "Did not receive reset after connect"
 519	 * errors.
 520	 */
 521	musb->port1_status &= ~(USB_PORT_STAT_C_CONNECTION << 16);
 522}
 523
 524static void musb_recover_from_babble(struct musb *musb);
 525
 526static void musb_handle_intr_resume(struct musb *musb, u8 devctl)
 527{
 528	musb_dbg(musb, "RESUME (%s)",
 529			usb_otg_state_string(musb->xceiv->otg->state));
 530
 531	if (devctl & MUSB_DEVCTL_HM) {
 532		switch (musb->xceiv->otg->state) {
 533		case OTG_STATE_A_SUSPEND:
 534			/* remote wakeup? */
 535			musb->port1_status |=
 536					(USB_PORT_STAT_C_SUSPEND << 16)
 537					| MUSB_PORT_STAT_RESUME;
 538			musb->rh_timer = jiffies
 539				+ msecs_to_jiffies(USB_RESUME_TIMEOUT);
 540			musb->xceiv->otg->state = OTG_STATE_A_HOST;
 541			musb->is_active = 1;
 542			musb_host_resume_root_hub(musb);
 543			schedule_delayed_work(&musb->finish_resume_work,
 544				msecs_to_jiffies(USB_RESUME_TIMEOUT));
 545			break;
 546		case OTG_STATE_B_WAIT_ACON:
 547			musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
 548			musb->is_active = 1;
 549			MUSB_DEV_MODE(musb);
 550			break;
 551		default:
 552			WARNING("bogus %s RESUME (%s)\n",
 553				"host",
 554				usb_otg_state_string(musb->xceiv->otg->state));
 555		}
 556	} else {
 557		switch (musb->xceiv->otg->state) {
 558		case OTG_STATE_A_SUSPEND:
 559			/* possibly DISCONNECT is upcoming */
 560			musb->xceiv->otg->state = OTG_STATE_A_HOST;
 561			musb_host_resume_root_hub(musb);
 562			break;
 563		case OTG_STATE_B_WAIT_ACON:
 564		case OTG_STATE_B_PERIPHERAL:
 565			/* disconnect while suspended?  we may
 566			 * not get a disconnect irq...
 567			 */
 568			if ((devctl & MUSB_DEVCTL_VBUS)
 569					!= (3 << MUSB_DEVCTL_VBUS_SHIFT)
 570					) {
 571				musb->int_usb |= MUSB_INTR_DISCONNECT;
 572				musb->int_usb &= ~MUSB_INTR_SUSPEND;
 573				break;
 574			}
 575			musb_g_resume(musb);
 576			break;
 577		case OTG_STATE_B_IDLE:
 578			musb->int_usb &= ~MUSB_INTR_SUSPEND;
 579			break;
 580		default:
 581			WARNING("bogus %s RESUME (%s)\n",
 582				"peripheral",
 583				usb_otg_state_string(musb->xceiv->otg->state));
 584		}
 585	}
 586}
 587
 588/* return IRQ_HANDLED to tell the caller to return immediately */
 589static irqreturn_t musb_handle_intr_sessreq(struct musb *musb, u8 devctl)
 590{
 591	void __iomem *mbase = musb->mregs;
 592
 593	if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS
 594			&& (devctl & MUSB_DEVCTL_BDEVICE)) {
 595		musb_dbg(musb, "SessReq while on B state");
 596		return IRQ_HANDLED;
 597	}
 598
 599	musb_dbg(musb, "SESSION_REQUEST (%s)",
 600		usb_otg_state_string(musb->xceiv->otg->state));
 601
 602	/* IRQ arrives from ID pin sense or (later, if VBUS power
 603	 * is removed) SRP.  responses are time critical:
 604	 *  - turn on VBUS (with silicon-specific mechanism)
 605	 *  - go through A_WAIT_VRISE
 606	 *  - ... to A_WAIT_BCON.
 607	 * a_wait_vrise_tmout triggers VBUS_ERROR transitions
 608	 */
 609	musb_writeb(mbase, MUSB_DEVCTL, MUSB_DEVCTL_SESSION);
 610	musb->ep0_stage = MUSB_EP0_START;
 611	musb->xceiv->otg->state = OTG_STATE_A_IDLE;
 612	MUSB_HST_MODE(musb);
 613	musb_platform_set_vbus(musb, 1);
 614
 615	return IRQ_NONE;
 616}
 617
 618static void musb_handle_intr_vbuserr(struct musb *musb, u8 devctl)
 619{
 620	int	ignore = 0;
 621
 622	/* During connection as an A-Device, we may see a short
 623	 * current spikes causing voltage drop, because of cable
 624	 * and peripheral capacitance combined with vbus draw.
 625	 * (So: less common with truly self-powered devices, where
 626	 * vbus doesn't act like a power supply.)
 627	 *
 628	 * Such spikes are short; usually less than ~500 usec, max
 629	 * of ~2 msec.  That is, they're not sustained overcurrent
 630	 * errors, though they're reported using VBUSERROR irqs.
 631	 *
 632	 * Workarounds:  (a) hardware: use self powered devices.
 633	 * (b) software:  ignore non-repeated VBUS errors.
 634	 *
 635	 * REVISIT:  do delays from lots of DEBUG_KERNEL checks
 636	 * make trouble here, keeping VBUS < 4.4V ?
 637	 */
 638	switch (musb->xceiv->otg->state) {
 639	case OTG_STATE_A_HOST:
 640		/* recovery is dicey once we've gotten past the
 641		 * initial stages of enumeration, but if VBUS
 642		 * stayed ok at the other end of the link, and
 643		 * another reset is due (at least for high speed,
 644		 * to redo the chirp etc), it might work OK...
 645		 */
 646	case OTG_STATE_A_WAIT_BCON:
 647	case OTG_STATE_A_WAIT_VRISE:
 648		if (musb->vbuserr_retry) {
 649			void __iomem *mbase = musb->mregs;
 650
 651			musb->vbuserr_retry--;
 652			ignore = 1;
 653			devctl |= MUSB_DEVCTL_SESSION;
 654			musb_writeb(mbase, MUSB_DEVCTL, devctl);
 655		} else {
 656			musb->port1_status |=
 657				  USB_PORT_STAT_OVERCURRENT
 658				| (USB_PORT_STAT_C_OVERCURRENT << 16);
 659		}
 660		break;
 661	default:
 662		break;
 663	}
 664
 665	dev_printk(ignore ? KERN_DEBUG : KERN_ERR, musb->controller,
 666			"VBUS_ERROR in %s (%02x, %s), retry #%d, port1 %08x\n",
 667			usb_otg_state_string(musb->xceiv->otg->state),
 668			devctl,
 669			({ char *s;
 670			switch (devctl & MUSB_DEVCTL_VBUS) {
 671			case 0 << MUSB_DEVCTL_VBUS_SHIFT:
 672				s = "<SessEnd"; break;
 673			case 1 << MUSB_DEVCTL_VBUS_SHIFT:
 674				s = "<AValid"; break;
 675			case 2 << MUSB_DEVCTL_VBUS_SHIFT:
 676				s = "<VBusValid"; break;
 677			/* case 3 << MUSB_DEVCTL_VBUS_SHIFT: */
 678			default:
 679				s = "VALID"; break;
 680			} s; }),
 681			VBUSERR_RETRY_COUNT - musb->vbuserr_retry,
 682			musb->port1_status);
 683
 684	/* go through A_WAIT_VFALL then start a new session */
 685	if (!ignore)
 686		musb_platform_set_vbus(musb, 0);
 687}
 688
 689static void musb_handle_intr_suspend(struct musb *musb, u8 devctl)
 690{
 691	musb_dbg(musb, "SUSPEND (%s) devctl %02x",
 692		usb_otg_state_string(musb->xceiv->otg->state), devctl);
 693
 694	switch (musb->xceiv->otg->state) {
 695	case OTG_STATE_A_PERIPHERAL:
 696		/* We also come here if the cable is removed, since
 697		 * this silicon doesn't report ID-no-longer-grounded.
 698		 *
 699		 * We depend on T(a_wait_bcon) to shut us down, and
 700		 * hope users don't do anything dicey during this
 701		 * undesired detour through A_WAIT_BCON.
 702		 */
 703		musb_hnp_stop(musb);
 704		musb_host_resume_root_hub(musb);
 705		musb_root_disconnect(musb);
 706		musb_platform_try_idle(musb, jiffies
 707				+ msecs_to_jiffies(musb->a_wait_bcon
 708					? : OTG_TIME_A_WAIT_BCON));
 709
 710		break;
 711	case OTG_STATE_B_IDLE:
 712		if (!musb->is_active)
 713			break;
 714		/* fall through */
 715	case OTG_STATE_B_PERIPHERAL:
 716		musb_g_suspend(musb);
 717		musb->is_active = musb->g.b_hnp_enable;
 718		if (musb->is_active) {
 719			musb->xceiv->otg->state = OTG_STATE_B_WAIT_ACON;
 720			musb_dbg(musb, "HNP: Setting timer for b_ase0_brst");
 721			mod_timer(&musb->otg_timer, jiffies
 722				+ msecs_to_jiffies(
 723						OTG_TIME_B_ASE0_BRST));
 724		}
 725		break;
 726	case OTG_STATE_A_WAIT_BCON:
 727		if (musb->a_wait_bcon != 0)
 728			musb_platform_try_idle(musb, jiffies
 729				+ msecs_to_jiffies(musb->a_wait_bcon));
 730		break;
 731	case OTG_STATE_A_HOST:
 732		musb->xceiv->otg->state = OTG_STATE_A_SUSPEND;
 733		musb->is_active = musb->hcd->self.b_hnp_enable;
 734		break;
 735	case OTG_STATE_B_HOST:
 736		/* Transition to B_PERIPHERAL, see 6.8.2.6 p 44 */
 737		musb_dbg(musb, "REVISIT: SUSPEND as B_HOST");
 738		break;
 739	default:
 740		/* "should not happen" */
 741		musb->is_active = 0;
 742		break;
 743	}
 744}
 745
 746static void musb_handle_intr_connect(struct musb *musb, u8 devctl, u8 int_usb)
 747{
 748	struct usb_hcd *hcd = musb->hcd;
 749
 750	musb->is_active = 1;
 751	musb->ep0_stage = MUSB_EP0_START;
 752
 753	musb->intrtxe = musb->epmask;
 754	musb_writew(musb->mregs, MUSB_INTRTXE, musb->intrtxe);
 755	musb->intrrxe = musb->epmask & 0xfffe;
 756	musb_writew(musb->mregs, MUSB_INTRRXE, musb->intrrxe);
 757	musb_writeb(musb->mregs, MUSB_INTRUSBE, 0xf7);
 758	musb->port1_status &= ~(USB_PORT_STAT_LOW_SPEED
 759				|USB_PORT_STAT_HIGH_SPEED
 760				|USB_PORT_STAT_ENABLE
 761				);
 762	musb->port1_status |= USB_PORT_STAT_CONNECTION
 763				|(USB_PORT_STAT_C_CONNECTION << 16);
 764
 765	/* high vs full speed is just a guess until after reset */
 766	if (devctl & MUSB_DEVCTL_LSDEV)
 767		musb->port1_status |= USB_PORT_STAT_LOW_SPEED;
 768
 769	/* indicate new connection to OTG machine */
 770	switch (musb->xceiv->otg->state) {
 771	case OTG_STATE_B_PERIPHERAL:
 772		if (int_usb & MUSB_INTR_SUSPEND) {
 773			musb_dbg(musb, "HNP: SUSPEND+CONNECT, now b_host");
 774			int_usb &= ~MUSB_INTR_SUSPEND;
 775			goto b_host;
 776		} else
 777			musb_dbg(musb, "CONNECT as b_peripheral???");
 778		break;
 779	case OTG_STATE_B_WAIT_ACON:
 780		musb_dbg(musb, "HNP: CONNECT, now b_host");
 781b_host:
 782		musb->xceiv->otg->state = OTG_STATE_B_HOST;
 783		if (musb->hcd)
 784			musb->hcd->self.is_b_host = 1;
 785		del_timer(&musb->otg_timer);
 786		break;
 787	default:
 788		if ((devctl & MUSB_DEVCTL_VBUS)
 789				== (3 << MUSB_DEVCTL_VBUS_SHIFT)) {
 790			musb->xceiv->otg->state = OTG_STATE_A_HOST;
 791			if (hcd)
 792				hcd->self.is_b_host = 0;
 793		}
 794		break;
 795	}
 796
 797	musb_host_poke_root_hub(musb);
 798
 799	musb_dbg(musb, "CONNECT (%s) devctl %02x",
 800			usb_otg_state_string(musb->xceiv->otg->state), devctl);
 801}
 802
 803static void musb_handle_intr_disconnect(struct musb *musb, u8 devctl)
 804{
 805	musb_dbg(musb, "DISCONNECT (%s) as %s, devctl %02x",
 806			usb_otg_state_string(musb->xceiv->otg->state),
 807			MUSB_MODE(musb), devctl);
 808
 809	switch (musb->xceiv->otg->state) {
 810	case OTG_STATE_A_HOST:
 811	case OTG_STATE_A_SUSPEND:
 812		musb_host_resume_root_hub(musb);
 813		musb_root_disconnect(musb);
 814		if (musb->a_wait_bcon != 0)
 815			musb_platform_try_idle(musb, jiffies
 816				+ msecs_to_jiffies(musb->a_wait_bcon));
 817		break;
 818	case OTG_STATE_B_HOST:
 819		/* REVISIT this behaves for "real disconnect"
 820		 * cases; make sure the other transitions from
 821		 * from B_HOST act right too.  The B_HOST code
 822		 * in hnp_stop() is currently not used...
 823		 */
 824		musb_root_disconnect(musb);
 825		if (musb->hcd)
 826			musb->hcd->self.is_b_host = 0;
 827		musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
 828		MUSB_DEV_MODE(musb);
 829		musb_g_disconnect(musb);
 830		break;
 831	case OTG_STATE_A_PERIPHERAL:
 832		musb_hnp_stop(musb);
 833		musb_root_disconnect(musb);
 834		/* FALLTHROUGH */
 835	case OTG_STATE_B_WAIT_ACON:
 836		/* FALLTHROUGH */
 837	case OTG_STATE_B_PERIPHERAL:
 838	case OTG_STATE_B_IDLE:
 839		musb_g_disconnect(musb);
 840		break;
 841	default:
 842		WARNING("unhandled DISCONNECT transition (%s)\n",
 843			usb_otg_state_string(musb->xceiv->otg->state));
 844		break;
 845	}
 846}
 847
 848/*
 849 * mentor saves a bit: bus reset and babble share the same irq.
 850 * only host sees babble; only peripheral sees bus reset.
 851 */
 852static void musb_handle_intr_reset(struct musb *musb)
 853{
 854	if (is_host_active(musb)) {
 855		/*
 856		 * When BABBLE happens what we can depends on which
 857		 * platform MUSB is running, because some platforms
 858		 * implemented proprietary means for 'recovering' from
 859		 * Babble conditions. One such platform is AM335x. In
 860		 * most cases, however, the only thing we can do is
 861		 * drop the session.
 862		 */
 863		dev_err(musb->controller, "Babble\n");
 864		musb_recover_from_babble(musb);
 865	} else {
 866		musb_dbg(musb, "BUS RESET as %s",
 867			usb_otg_state_string(musb->xceiv->otg->state));
 868		switch (musb->xceiv->otg->state) {
 869		case OTG_STATE_A_SUSPEND:
 870			musb_g_reset(musb);
 871			/* FALLTHROUGH */
 872		case OTG_STATE_A_WAIT_BCON:	/* OPT TD.4.7-900ms */
 873			/* never use invalid T(a_wait_bcon) */
 874			musb_dbg(musb, "HNP: in %s, %d msec timeout",
 875				usb_otg_state_string(musb->xceiv->otg->state),
 876				TA_WAIT_BCON(musb));
 877			mod_timer(&musb->otg_timer, jiffies
 878				+ msecs_to_jiffies(TA_WAIT_BCON(musb)));
 879			break;
 880		case OTG_STATE_A_PERIPHERAL:
 881			del_timer(&musb->otg_timer);
 882			musb_g_reset(musb);
 883			break;
 884		case OTG_STATE_B_WAIT_ACON:
 885			musb_dbg(musb, "HNP: RESET (%s), to b_peripheral",
 886				usb_otg_state_string(musb->xceiv->otg->state));
 887			musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
 888			musb_g_reset(musb);
 889			break;
 890		case OTG_STATE_B_IDLE:
 891			musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
 892			/* FALLTHROUGH */
 893		case OTG_STATE_B_PERIPHERAL:
 894			musb_g_reset(musb);
 895			break;
 896		default:
 897			musb_dbg(musb, "Unhandled BUS RESET as %s",
 898				usb_otg_state_string(musb->xceiv->otg->state));
 899		}
 900	}
 901}
 902
 903/*
 904 * Interrupt Service Routine to record USB "global" interrupts.
 905 * Since these do not happen often and signify things of
 906 * paramount importance, it seems OK to check them individually;
 907 * the order of the tests is specified in the manual
 908 *
 909 * @param musb instance pointer
 910 * @param int_usb register contents
 911 * @param devctl
 912 * @param power
 913 */
 914
 915static irqreturn_t musb_stage0_irq(struct musb *musb, u8 int_usb,
 916				u8 devctl)
 917{
 918	irqreturn_t handled = IRQ_NONE;
 919
 920	musb_dbg(musb, "<== DevCtl=%02x, int_usb=0x%x", devctl, int_usb);
 921
 922	/* in host mode, the peripheral may issue remote wakeup.
 923	 * in peripheral mode, the host may resume the link.
 924	 * spurious RESUME irqs happen too, paired with SUSPEND.
 925	 */
 926	if (int_usb & MUSB_INTR_RESUME) {
 927		musb_handle_intr_resume(musb, devctl);
 928		handled = IRQ_HANDLED;
 929	}
 930
 931	/* see manual for the order of the tests */
 932	if (int_usb & MUSB_INTR_SESSREQ) {
 933		if (musb_handle_intr_sessreq(musb, devctl))
 934			return IRQ_HANDLED;
 935		handled = IRQ_HANDLED;
 936	}
 937
 938	if (int_usb & MUSB_INTR_VBUSERROR) {
 939		musb_handle_intr_vbuserr(musb, devctl);
 940		handled = IRQ_HANDLED;
 941	}
 942
 943	if (int_usb & MUSB_INTR_SUSPEND) {
 944		musb_handle_intr_suspend(musb, devctl);
 945		handled = IRQ_HANDLED;
 946	}
 947
 948	if (int_usb & MUSB_INTR_CONNECT) {
 949		musb_handle_intr_connect(musb, devctl, int_usb);
 950		handled = IRQ_HANDLED;
 951	}
 952
 953	if (int_usb & MUSB_INTR_DISCONNECT) {
 954		musb_handle_intr_disconnect(musb, devctl);
 955		handled = IRQ_HANDLED;
 956	}
 957
 958	if (int_usb & MUSB_INTR_RESET) {
 959		musb_handle_intr_reset(musb);
 960		handled = IRQ_HANDLED;
 961	}
 962
 963#if 0
 964/* REVISIT ... this would be for multiplexing periodic endpoints, or
 965 * supporting transfer phasing to prevent exceeding ISO bandwidth
 966 * limits of a given frame or microframe.
 967 *
 968 * It's not needed for peripheral side, which dedicates endpoints;
 969 * though it _might_ use SOF irqs for other purposes.
 970 *
 971 * And it's not currently needed for host side, which also dedicates
 972 * endpoints, relies on TX/RX interval registers, and isn't claimed
 973 * to support ISO transfers yet.
 974 */
 975	if (int_usb & MUSB_INTR_SOF) {
 976		void __iomem *mbase = musb->mregs;
 977		struct musb_hw_ep	*ep;
 978		u8 epnum;
 979		u16 frame;
 980
 981		dev_dbg(musb->controller, "START_OF_FRAME\n");
 982		handled = IRQ_HANDLED;
 983
 984		/* start any periodic Tx transfers waiting for current frame */
 985		frame = musb_readw(mbase, MUSB_FRAME);
 986		ep = musb->endpoints;
 987		for (epnum = 1; (epnum < musb->nr_endpoints)
 988					&& (musb->epmask >= (1 << epnum));
 989				epnum++, ep++) {
 990			/*
 991			 * FIXME handle framecounter wraps (12 bits)
 992			 * eliminate duplicated StartUrb logic
 993			 */
 994			if (ep->dwWaitFrame >= frame) {
 995				ep->dwWaitFrame = 0;
 996				pr_debug("SOF --> periodic TX%s on %d\n",
 997					ep->tx_channel ? " DMA" : "",
 998					epnum);
 999				if (!ep->tx_channel)
1000					musb_h_tx_start(musb, epnum);
1001				else
1002					cppi_hostdma_start(musb, epnum);
1003			}
1004		}		/* end of for loop */
1005	}
1006#endif
1007
1008	schedule_delayed_work(&musb->irq_work, 0);
1009
1010	return handled;
1011}
1012
1013/*-------------------------------------------------------------------------*/
1014
1015static void musb_disable_interrupts(struct musb *musb)
1016{
1017	void __iomem	*mbase = musb->mregs;
1018	u16	temp;
1019
1020	/* disable interrupts */
1021	musb_writeb(mbase, MUSB_INTRUSBE, 0);
1022	musb->intrtxe = 0;
1023	musb_writew(mbase, MUSB_INTRTXE, 0);
1024	musb->intrrxe = 0;
1025	musb_writew(mbase, MUSB_INTRRXE, 0);
1026
1027	/*  flush pending interrupts */
1028	temp = musb_readb(mbase, MUSB_INTRUSB);
1029	temp = musb_readw(mbase, MUSB_INTRTX);
1030	temp = musb_readw(mbase, MUSB_INTRRX);
1031}
1032
1033static void musb_enable_interrupts(struct musb *musb)
1034{
1035	void __iomem    *regs = musb->mregs;
1036
1037	/*  Set INT enable registers, enable interrupts */
1038	musb->intrtxe = musb->epmask;
1039	musb_writew(regs, MUSB_INTRTXE, musb->intrtxe);
1040	musb->intrrxe = musb->epmask & 0xfffe;
1041	musb_writew(regs, MUSB_INTRRXE, musb->intrrxe);
1042	musb_writeb(regs, MUSB_INTRUSBE, 0xf7);
1043
1044}
1045
1046/*
1047 * Program the HDRC to start (enable interrupts, dma, etc.).
1048 */
1049void musb_start(struct musb *musb)
1050{
1051	void __iomem    *regs = musb->mregs;
1052	u8              devctl = musb_readb(regs, MUSB_DEVCTL);
1053	u8		power;
1054
1055	musb_dbg(musb, "<== devctl %02x", devctl);
1056
1057	musb_enable_interrupts(musb);
1058	musb_writeb(regs, MUSB_TESTMODE, 0);
1059
1060	power = MUSB_POWER_ISOUPDATE;
1061	/*
1062	 * treating UNKNOWN as unspecified maximum speed, in which case
1063	 * we will default to high-speed.
1064	 */
1065	if (musb->config->maximum_speed == USB_SPEED_HIGH ||
1066			musb->config->maximum_speed == USB_SPEED_UNKNOWN)
1067		power |= MUSB_POWER_HSENAB;
1068	musb_writeb(regs, MUSB_POWER, power);
1069
1070	musb->is_active = 0;
1071	devctl = musb_readb(regs, MUSB_DEVCTL);
1072	devctl &= ~MUSB_DEVCTL_SESSION;
1073
1074	/* session started after:
1075	 * (a) ID-grounded irq, host mode;
1076	 * (b) vbus present/connect IRQ, peripheral mode;
1077	 * (c) peripheral initiates, using SRP
1078	 */
1079	if (musb->port_mode != MUSB_HOST &&
1080			musb->xceiv->otg->state != OTG_STATE_A_WAIT_BCON &&
1081			(devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS) {
1082		musb->is_active = 1;
1083	} else {
1084		devctl |= MUSB_DEVCTL_SESSION;
1085	}
1086
1087	musb_platform_enable(musb);
1088	musb_writeb(regs, MUSB_DEVCTL, devctl);
1089}
1090
1091/*
1092 * Make the HDRC stop (disable interrupts, etc.);
1093 * reversible by musb_start
1094 * called on gadget driver unregister
1095 * with controller locked, irqs blocked
1096 * acts as a NOP unless some role activated the hardware
1097 */
1098void musb_stop(struct musb *musb)
1099{
1100	/* stop IRQs, timers, ... */
1101	musb_platform_disable(musb);
1102	musb_disable_interrupts(musb);
1103	musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
1104
1105	/* FIXME
1106	 *  - mark host and/or peripheral drivers unusable/inactive
1107	 *  - disable DMA (and enable it in HdrcStart)
1108	 *  - make sure we can musb_start() after musb_stop(); with
1109	 *    OTG mode, gadget driver module rmmod/modprobe cycles that
1110	 *  - ...
1111	 */
1112	musb_platform_try_idle(musb, 0);
1113}
1114
1115/*-------------------------------------------------------------------------*/
1116
1117/*
1118 * The silicon either has hard-wired endpoint configurations, or else
1119 * "dynamic fifo" sizing.  The driver has support for both, though at this
1120 * writing only the dynamic sizing is very well tested.   Since we switched
1121 * away from compile-time hardware parameters, we can no longer rely on
1122 * dead code elimination to leave only the relevant one in the object file.
1123 *
1124 * We don't currently use dynamic fifo setup capability to do anything
1125 * more than selecting one of a bunch of predefined configurations.
1126 */
1127static ushort fifo_mode;
1128
1129/* "modprobe ... fifo_mode=1" etc */
1130module_param(fifo_mode, ushort, 0);
1131MODULE_PARM_DESC(fifo_mode, "initial endpoint configuration");
1132
1133/*
1134 * tables defining fifo_mode values.  define more if you like.
1135 * for host side, make sure both halves of ep1 are set up.
1136 */
1137
1138/* mode 0 - fits in 2KB */
1139static struct musb_fifo_cfg mode_0_cfg[] = {
1140{ .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, },
1141{ .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, },
1142{ .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, },
1143{ .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1144{ .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1145};
1146
1147/* mode 1 - fits in 4KB */
1148static struct musb_fifo_cfg mode_1_cfg[] = {
1149{ .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1150{ .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1151{ .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1152{ .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1153{ .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1154};
1155
1156/* mode 2 - fits in 4KB */
1157static struct musb_fifo_cfg mode_2_cfg[] = {
1158{ .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, },
1159{ .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, },
1160{ .hw_ep_num = 2, .style = FIFO_TX,   .maxpacket = 512, },
1161{ .hw_ep_num = 2, .style = FIFO_RX,   .maxpacket = 512, },
1162{ .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 960, },
1163{ .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 1024, },
1164};
1165
1166/* mode 3 - fits in 4KB */
1167static struct musb_fifo_cfg mode_3_cfg[] = {
1168{ .hw_ep_num = 1, .style = FIFO_TX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1169{ .hw_ep_num = 1, .style = FIFO_RX,   .maxpacket = 512, .mode = BUF_DOUBLE, },
1170{ .hw_ep_num = 2, .style = FIFO_TX,   .maxpacket = 512, },
1171{ .hw_ep_num = 2, .style = FIFO_RX,   .maxpacket = 512, },
1172{ .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1173{ .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1174};
1175
1176/* mode 4 - fits in 16KB */
1177static struct musb_fifo_cfg mode_4_cfg[] = {
1178{ .hw_ep_num =  1, .style = FIFO_TX,   .maxpacket = 512, },
1179{ .hw_ep_num =  1, .style = FIFO_RX,   .maxpacket = 512, },
1180{ .hw_ep_num =  2, .style = FIFO_TX,   .maxpacket = 512, },
1181{ .hw_ep_num =  2, .style = FIFO_RX,   .maxpacket = 512, },
1182{ .hw_ep_num =  3, .style = FIFO_TX,   .maxpacket = 512, },
1183{ .hw_ep_num =  3, .style = FIFO_RX,   .maxpacket = 512, },
1184{ .hw_ep_num =  4, .style = FIFO_TX,   .maxpacket = 512, },
1185{ .hw_ep_num =  4, .style = FIFO_RX,   .maxpacket = 512, },
1186{ .hw_ep_num =  5, .style = FIFO_TX,   .maxpacket = 512, },
1187{ .hw_ep_num =  5, .style = FIFO_RX,   .maxpacket = 512, },
1188{ .hw_ep_num =  6, .style = FIFO_TX,   .maxpacket = 512, },
1189{ .hw_ep_num =  6, .style = FIFO_RX,   .maxpacket = 512, },
1190{ .hw_ep_num =  7, .style = FIFO_TX,   .maxpacket = 512, },
1191{ .hw_ep_num =  7, .style = FIFO_RX,   .maxpacket = 512, },
1192{ .hw_ep_num =  8, .style = FIFO_TX,   .maxpacket = 512, },
1193{ .hw_ep_num =  8, .style = FIFO_RX,   .maxpacket = 512, },
1194{ .hw_ep_num =  9, .style = FIFO_TX,   .maxpacket = 512, },
1195{ .hw_ep_num =  9, .style = FIFO_RX,   .maxpacket = 512, },
1196{ .hw_ep_num = 10, .style = FIFO_TX,   .maxpacket = 256, },
1197{ .hw_ep_num = 10, .style = FIFO_RX,   .maxpacket = 64, },
1198{ .hw_ep_num = 11, .style = FIFO_TX,   .maxpacket = 256, },
1199{ .hw_ep_num = 11, .style = FIFO_RX,   .maxpacket = 64, },
1200{ .hw_ep_num = 12, .style = FIFO_TX,   .maxpacket = 256, },
1201{ .hw_ep_num = 12, .style = FIFO_RX,   .maxpacket = 64, },
1202{ .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 4096, },
1203{ .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1204{ .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1205};
1206
1207/* mode 5 - fits in 8KB */
1208static struct musb_fifo_cfg mode_5_cfg[] = {
1209{ .hw_ep_num =  1, .style = FIFO_TX,   .maxpacket = 512, },
1210{ .hw_ep_num =  1, .style = FIFO_RX,   .maxpacket = 512, },
1211{ .hw_ep_num =  2, .style = FIFO_TX,   .maxpacket = 512, },
1212{ .hw_ep_num =  2, .style = FIFO_RX,   .maxpacket = 512, },
1213{ .hw_ep_num =  3, .style = FIFO_TX,   .maxpacket = 512, },
1214{ .hw_ep_num =  3, .style = FIFO_RX,   .maxpacket = 512, },
1215{ .hw_ep_num =  4, .style = FIFO_TX,   .maxpacket = 512, },
1216{ .hw_ep_num =  4, .style = FIFO_RX,   .maxpacket = 512, },
1217{ .hw_ep_num =  5, .style = FIFO_TX,   .maxpacket = 512, },
1218{ .hw_ep_num =  5, .style = FIFO_RX,   .maxpacket = 512, },
1219{ .hw_ep_num =  6, .style = FIFO_TX,   .maxpacket = 32, },
1220{ .hw_ep_num =  6, .style = FIFO_RX,   .maxpacket = 32, },
1221{ .hw_ep_num =  7, .style = FIFO_TX,   .maxpacket = 32, },
1222{ .hw_ep_num =  7, .style = FIFO_RX,   .maxpacket = 32, },
1223{ .hw_ep_num =  8, .style = FIFO_TX,   .maxpacket = 32, },
1224{ .hw_ep_num =  8, .style = FIFO_RX,   .maxpacket = 32, },
1225{ .hw_ep_num =  9, .style = FIFO_TX,   .maxpacket = 32, },
1226{ .hw_ep_num =  9, .style = FIFO_RX,   .maxpacket = 32, },
1227{ .hw_ep_num = 10, .style = FIFO_TX,   .maxpacket = 32, },
1228{ .hw_ep_num = 10, .style = FIFO_RX,   .maxpacket = 32, },
1229{ .hw_ep_num = 11, .style = FIFO_TX,   .maxpacket = 32, },
1230{ .hw_ep_num = 11, .style = FIFO_RX,   .maxpacket = 32, },
1231{ .hw_ep_num = 12, .style = FIFO_TX,   .maxpacket = 32, },
1232{ .hw_ep_num = 12, .style = FIFO_RX,   .maxpacket = 32, },
1233{ .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 512, },
1234{ .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1235{ .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1236};
1237
1238/*
1239 * configure a fifo; for non-shared endpoints, this may be called
1240 * once for a tx fifo and once for an rx fifo.
1241 *
1242 * returns negative errno or offset for next fifo.
1243 */
1244static int
1245fifo_setup(struct musb *musb, struct musb_hw_ep  *hw_ep,
1246		const struct musb_fifo_cfg *cfg, u16 offset)
1247{
1248	void __iomem	*mbase = musb->mregs;
1249	int	size = 0;
1250	u16	maxpacket = cfg->maxpacket;
1251	u16	c_off = offset >> 3;
1252	u8	c_size;
1253
1254	/* expect hw_ep has already been zero-initialized */
1255
1256	size = ffs(max(maxpacket, (u16) 8)) - 1;
1257	maxpacket = 1 << size;
1258
1259	c_size = size - 3;
1260	if (cfg->mode == BUF_DOUBLE) {
1261		if ((offset + (maxpacket << 1)) >
1262				(1 << (musb->config->ram_bits + 2)))
1263			return -EMSGSIZE;
1264		c_size |= MUSB_FIFOSZ_DPB;
1265	} else {
1266		if ((offset + maxpacket) > (1 << (musb->config->ram_bits + 2)))
1267			return -EMSGSIZE;
1268	}
1269
1270	/* configure the FIFO */
1271	musb_writeb(mbase, MUSB_INDEX, hw_ep->epnum);
1272
1273	/* EP0 reserved endpoint for control, bidirectional;
1274	 * EP1 reserved for bulk, two unidirectional halves.
1275	 */
1276	if (hw_ep->epnum == 1)
1277		musb->bulk_ep = hw_ep;
1278	/* REVISIT error check:  be sure ep0 can both rx and tx ... */
1279	switch (cfg->style) {
1280	case FIFO_TX:
1281		musb_writeb(mbase, MUSB_TXFIFOSZ, c_size);
1282		musb_writew(mbase, MUSB_TXFIFOADD, c_off);
1283		hw_ep->tx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1284		hw_ep->max_packet_sz_tx = maxpacket;
1285		break;
1286	case FIFO_RX:
1287		musb_writeb(mbase, MUSB_RXFIFOSZ, c_size);
1288		musb_writew(mbase, MUSB_RXFIFOADD, c_off);
1289		hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1290		hw_ep->max_packet_sz_rx = maxpacket;
1291		break;
1292	case FIFO_RXTX:
1293		musb_writeb(mbase, MUSB_TXFIFOSZ, c_size);
1294		musb_writew(mbase, MUSB_TXFIFOADD, c_off);
1295		hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1296		hw_ep->max_packet_sz_rx = maxpacket;
1297
1298		musb_writeb(mbase, MUSB_RXFIFOSZ, c_size);
1299		musb_writew(mbase, MUSB_RXFIFOADD, c_off);
1300		hw_ep->tx_double_buffered = hw_ep->rx_double_buffered;
1301		hw_ep->max_packet_sz_tx = maxpacket;
1302
1303		hw_ep->is_shared_fifo = true;
1304		break;
1305	}
1306
1307	/* NOTE rx and tx endpoint irqs aren't managed separately,
1308	 * which happens to be ok
1309	 */
1310	musb->epmask |= (1 << hw_ep->epnum);
1311
1312	return offset + (maxpacket << ((c_size & MUSB_FIFOSZ_DPB) ? 1 : 0));
1313}
1314
1315static struct musb_fifo_cfg ep0_cfg = {
1316	.style = FIFO_RXTX, .maxpacket = 64,
1317};
1318
1319static int ep_config_from_table(struct musb *musb)
1320{
1321	const struct musb_fifo_cfg	*cfg;
1322	unsigned		i, n;
1323	int			offset;
1324	struct musb_hw_ep	*hw_ep = musb->endpoints;
1325
1326	if (musb->config->fifo_cfg) {
1327		cfg = musb->config->fifo_cfg;
1328		n = musb->config->fifo_cfg_size;
1329		goto done;
1330	}
1331
1332	switch (fifo_mode) {
1333	default:
1334		fifo_mode = 0;
1335		/* FALLTHROUGH */
1336	case 0:
1337		cfg = mode_0_cfg;
1338		n = ARRAY_SIZE(mode_0_cfg);
1339		break;
1340	case 1:
1341		cfg = mode_1_cfg;
1342		n = ARRAY_SIZE(mode_1_cfg);
1343		break;
1344	case 2:
1345		cfg = mode_2_cfg;
1346		n = ARRAY_SIZE(mode_2_cfg);
1347		break;
1348	case 3:
1349		cfg = mode_3_cfg;
1350		n = ARRAY_SIZE(mode_3_cfg);
1351		break;
1352	case 4:
1353		cfg = mode_4_cfg;
1354		n = ARRAY_SIZE(mode_4_cfg);
1355		break;
1356	case 5:
1357		cfg = mode_5_cfg;
1358		n = ARRAY_SIZE(mode_5_cfg);
1359		break;
1360	}
1361
1362	pr_debug("%s: setup fifo_mode %d\n", musb_driver_name, fifo_mode);
1363
1364
1365done:
1366	offset = fifo_setup(musb, hw_ep, &ep0_cfg, 0);
1367	/* assert(offset > 0) */
1368
1369	/* NOTE:  for RTL versions >= 1.400 EPINFO and RAMINFO would
1370	 * be better than static musb->config->num_eps and DYN_FIFO_SIZE...
1371	 */
1372
1373	for (i = 0; i < n; i++) {
1374		u8	epn = cfg->hw_ep_num;
1375
1376		if (epn >= musb->config->num_eps) {
1377			pr_debug("%s: invalid ep %d\n",
1378					musb_driver_name, epn);
1379			return -EINVAL;
1380		}
1381		offset = fifo_setup(musb, hw_ep + epn, cfg++, offset);
1382		if (offset < 0) {
1383			pr_debug("%s: mem overrun, ep %d\n",
1384					musb_driver_name, epn);
1385			return offset;
1386		}
1387		epn++;
1388		musb->nr_endpoints = max(epn, musb->nr_endpoints);
1389	}
1390
1391	pr_debug("%s: %d/%d max ep, %d/%d memory\n",
1392			musb_driver_name,
1393			n + 1, musb->config->num_eps * 2 - 1,
1394			offset, (1 << (musb->config->ram_bits + 2)));
1395
1396	if (!musb->bulk_ep) {
1397		pr_debug("%s: missing bulk\n", musb_driver_name);
1398		return -EINVAL;
1399	}
1400
1401	return 0;
1402}
1403
1404
1405/*
1406 * ep_config_from_hw - when MUSB_C_DYNFIFO_DEF is false
1407 * @param musb the controller
1408 */
1409static int ep_config_from_hw(struct musb *musb)
1410{
1411	u8 epnum = 0;
1412	struct musb_hw_ep *hw_ep;
1413	void __iomem *mbase = musb->mregs;
1414	int ret = 0;
1415
1416	musb_dbg(musb, "<== static silicon ep config");
1417
1418	/* FIXME pick up ep0 maxpacket size */
1419
1420	for (epnum = 1; epnum < musb->config->num_eps; epnum++) {
1421		musb_ep_select(mbase, epnum);
1422		hw_ep = musb->endpoints + epnum;
1423
1424		ret = musb_read_fifosize(musb, hw_ep, epnum);
1425		if (ret < 0)
1426			break;
1427
1428		/* FIXME set up hw_ep->{rx,tx}_double_buffered */
1429
1430		/* pick an RX/TX endpoint for bulk */
1431		if (hw_ep->max_packet_sz_tx < 512
1432				|| hw_ep->max_packet_sz_rx < 512)
1433			continue;
1434
1435		/* REVISIT:  this algorithm is lazy, we should at least
1436		 * try to pick a double buffered endpoint.
1437		 */
1438		if (musb->bulk_ep)
1439			continue;
1440		musb->bulk_ep = hw_ep;
1441	}
1442
1443	if (!musb->bulk_ep) {
1444		pr_debug("%s: missing bulk\n", musb_driver_name);
1445		return -EINVAL;
1446	}
1447
1448	return 0;
1449}
1450
1451enum { MUSB_CONTROLLER_MHDRC, MUSB_CONTROLLER_HDRC, };
1452
1453/* Initialize MUSB (M)HDRC part of the USB hardware subsystem;
1454 * configure endpoints, or take their config from silicon
1455 */
1456static int musb_core_init(u16 musb_type, struct musb *musb)
1457{
1458	u8 reg;
1459	char *type;
1460	char aInfo[90];
1461	void __iomem	*mbase = musb->mregs;
1462	int		status = 0;
1463	int		i;
1464
1465	/* log core options (read using indexed model) */
1466	reg = musb_read_configdata(mbase);
1467
1468	strcpy(aInfo, (reg & MUSB_CONFIGDATA_UTMIDW) ? "UTMI-16" : "UTMI-8");
1469	if (reg & MUSB_CONFIGDATA_DYNFIFO) {
1470		strcat(aInfo, ", dyn FIFOs");
1471		musb->dyn_fifo = true;
1472	}
1473	if (reg & MUSB_CONFIGDATA_MPRXE) {
1474		strcat(aInfo, ", bulk combine");
1475		musb->bulk_combine = true;
1476	}
1477	if (reg & MUSB_CONFIGDATA_MPTXE) {
1478		strcat(aInfo, ", bulk split");
1479		musb->bulk_split = true;
1480	}
1481	if (reg & MUSB_CONFIGDATA_HBRXE) {
1482		strcat(aInfo, ", HB-ISO Rx");
1483		musb->hb_iso_rx = true;
1484	}
1485	if (reg & MUSB_CONFIGDATA_HBTXE) {
1486		strcat(aInfo, ", HB-ISO Tx");
1487		musb->hb_iso_tx = true;
1488	}
1489	if (reg & MUSB_CONFIGDATA_SOFTCONE)
1490		strcat(aInfo, ", SoftConn");
1491
1492	pr_debug("%s: ConfigData=0x%02x (%s)\n", musb_driver_name, reg, aInfo);
1493
1494	if (MUSB_CONTROLLER_MHDRC == musb_type) {
1495		musb->is_multipoint = 1;
1496		type = "M";
1497	} else {
1498		musb->is_multipoint = 0;
1499		type = "";
1500		if (IS_ENABLED(CONFIG_USB) &&
1501		    !IS_ENABLED(CONFIG_USB_OTG_BLACKLIST_HUB)) {
1502			pr_err("%s: kernel must blacklist external hubs\n",
1503			       musb_driver_name);
1504		}
1505	}
1506
1507	/* log release info */
1508	musb->hwvers = musb_readw(mbase, MUSB_HWVERS);
1509	pr_debug("%s: %sHDRC RTL version %d.%d%s\n",
1510		 musb_driver_name, type, MUSB_HWVERS_MAJOR(musb->hwvers),
1511		 MUSB_HWVERS_MINOR(musb->hwvers),
1512		 (musb->hwvers & MUSB_HWVERS_RC) ? "RC" : "");
1513
1514	/* configure ep0 */
1515	musb_configure_ep0(musb);
1516
1517	/* discover endpoint configuration */
1518	musb->nr_endpoints = 1;
1519	musb->epmask = 1;
1520
1521	if (musb->dyn_fifo)
1522		status = ep_config_from_table(musb);
1523	else
1524		status = ep_config_from_hw(musb);
1525
1526	if (status < 0)
1527		return status;
1528
1529	/* finish init, and print endpoint config */
1530	for (i = 0; i < musb->nr_endpoints; i++) {
1531		struct musb_hw_ep	*hw_ep = musb->endpoints + i;
1532
1533		hw_ep->fifo = musb->io.fifo_offset(i) + mbase;
1534#if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010)
1535		if (musb->ops->quirks & MUSB_IN_TUSB) {
1536			hw_ep->fifo_async = musb->async + 0x400 +
1537				musb->io.fifo_offset(i);
1538			hw_ep->fifo_sync = musb->sync + 0x400 +
1539				musb->io.fifo_offset(i);
1540			hw_ep->fifo_sync_va =
1541				musb->sync_va + 0x400 + musb->io.fifo_offset(i);
1542
1543			if (i == 0)
1544				hw_ep->conf = mbase - 0x400 + TUSB_EP0_CONF;
1545			else
1546				hw_ep->conf = mbase + 0x400 +
1547					(((i - 1) & 0xf) << 2);
1548		}
1549#endif
1550
1551		hw_ep->regs = musb->io.ep_offset(i, 0) + mbase;
1552		hw_ep->rx_reinit = 1;
1553		hw_ep->tx_reinit = 1;
1554
1555		if (hw_ep->max_packet_sz_tx) {
1556			musb_dbg(musb, "%s: hw_ep %d%s, %smax %d",
1557				musb_driver_name, i,
1558				hw_ep->is_shared_fifo ? "shared" : "tx",
1559				hw_ep->tx_double_buffered
1560					? "doublebuffer, " : "",
1561				hw_ep->max_packet_sz_tx);
1562		}
1563		if (hw_ep->max_packet_sz_rx && !hw_ep->is_shared_fifo) {
1564			musb_dbg(musb, "%s: hw_ep %d%s, %smax %d",
1565				musb_driver_name, i,
1566				"rx",
1567				hw_ep->rx_double_buffered
1568					? "doublebuffer, " : "",
1569				hw_ep->max_packet_sz_rx);
1570		}
1571		if (!(hw_ep->max_packet_sz_tx || hw_ep->max_packet_sz_rx))
1572			musb_dbg(musb, "hw_ep %d not configured", i);
1573	}
1574
1575	return 0;
1576}
1577
1578/*-------------------------------------------------------------------------*/
1579
1580/*
1581 * handle all the irqs defined by the HDRC core. for now we expect:  other
1582 * irq sources (phy, dma, etc) will be handled first, musb->int_* values
1583 * will be assigned, and the irq will already have been acked.
1584 *
1585 * called in irq context with spinlock held, irqs blocked
1586 */
1587irqreturn_t musb_interrupt(struct musb *musb)
1588{
1589	irqreturn_t	retval = IRQ_NONE;
1590	unsigned long	status;
1591	unsigned long	epnum;
1592	u8		devctl;
1593
1594	if (!musb->int_usb && !musb->int_tx && !musb->int_rx)
1595		return IRQ_NONE;
1596
1597	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1598
1599	trace_musb_isr(musb);
1600
1601	/**
1602	 * According to Mentor Graphics' documentation, flowchart on page 98,
1603	 * IRQ should be handled as follows:
1604	 *
1605	 * . Resume IRQ
1606	 * . Session Request IRQ
1607	 * . VBUS Error IRQ
1608	 * . Suspend IRQ
1609	 * . Connect IRQ
1610	 * . Disconnect IRQ
1611	 * . Reset/Babble IRQ
1612	 * . SOF IRQ (we're not using this one)
1613	 * . Endpoint 0 IRQ
1614	 * . TX Endpoints
1615	 * . RX Endpoints
1616	 *
1617	 * We will be following that flowchart in order to avoid any problems
1618	 * that might arise with internal Finite State Machine.
1619	 */
1620
1621	if (musb->int_usb)
1622		retval |= musb_stage0_irq(musb, musb->int_usb, devctl);
1623
1624	if (musb->int_tx & 1) {
1625		if (is_host_active(musb))
1626			retval |= musb_h_ep0_irq(musb);
1627		else
1628			retval |= musb_g_ep0_irq(musb);
1629
1630		/* we have just handled endpoint 0 IRQ, clear it */
1631		musb->int_tx &= ~BIT(0);
1632	}
1633
1634	status = musb->int_tx;
1635
1636	for_each_set_bit(epnum, &status, 16) {
1637		retval = IRQ_HANDLED;
1638		if (is_host_active(musb))
1639			musb_host_tx(musb, epnum);
1640		else
1641			musb_g_tx(musb, epnum);
1642	}
1643
1644	status = musb->int_rx;
1645
1646	for_each_set_bit(epnum, &status, 16) {
1647		retval = IRQ_HANDLED;
1648		if (is_host_active(musb))
1649			musb_host_rx(musb, epnum);
1650		else
1651			musb_g_rx(musb, epnum);
1652	}
1653
1654	return retval;
1655}
1656EXPORT_SYMBOL_GPL(musb_interrupt);
1657
1658#ifndef CONFIG_MUSB_PIO_ONLY
1659static bool use_dma = 1;
1660
1661/* "modprobe ... use_dma=0" etc */
1662module_param(use_dma, bool, 0644);
1663MODULE_PARM_DESC(use_dma, "enable/disable use of DMA");
1664
1665void musb_dma_completion(struct musb *musb, u8 epnum, u8 transmit)
1666{
1667	/* called with controller lock already held */
1668
1669	if (!epnum) {
1670		if (!is_cppi_enabled(musb)) {
1671			/* endpoint 0 */
1672			if (is_host_active(musb))
1673				musb_h_ep0_irq(musb);
1674			else
1675				musb_g_ep0_irq(musb);
1676		}
1677	} else {
1678		/* endpoints 1..15 */
1679		if (transmit) {
1680			if (is_host_active(musb))
1681				musb_host_tx(musb, epnum);
1682			else
1683				musb_g_tx(musb, epnum);
1684		} else {
1685			/* receive */
1686			if (is_host_active(musb))
1687				musb_host_rx(musb, epnum);
1688			else
1689				musb_g_rx(musb, epnum);
1690		}
1691	}
1692}
1693EXPORT_SYMBOL_GPL(musb_dma_completion);
1694
1695#else
1696#define use_dma			0
1697#endif
1698
1699static int (*musb_phy_callback)(enum musb_vbus_id_status status);
1700
1701/*
1702 * musb_mailbox - optional phy notifier function
1703 * @status phy state change
1704 *
1705 * Optionally gets called from the USB PHY. Note that the USB PHY must be
1706 * disabled at the point the phy_callback is registered or unregistered.
1707 */
1708int musb_mailbox(enum musb_vbus_id_status status)
1709{
1710	if (musb_phy_callback)
1711		return musb_phy_callback(status);
1712
1713	return -ENODEV;
1714};
1715EXPORT_SYMBOL_GPL(musb_mailbox);
1716
1717/*-------------------------------------------------------------------------*/
1718
1719static ssize_t
1720mode_show(struct device *dev, struct device_attribute *attr, char *buf)
1721{
1722	struct musb *musb = dev_to_musb(dev);
1723	unsigned long flags;
1724	int ret;
1725
1726	spin_lock_irqsave(&musb->lock, flags);
1727	ret = sprintf(buf, "%s\n", usb_otg_state_string(musb->xceiv->otg->state));
1728	spin_unlock_irqrestore(&musb->lock, flags);
1729
1730	return ret;
1731}
1732
1733static ssize_t
1734mode_store(struct device *dev, struct device_attribute *attr,
1735		const char *buf, size_t n)
1736{
1737	struct musb	*musb = dev_to_musb(dev);
1738	unsigned long	flags;
1739	int		status;
1740
1741	spin_lock_irqsave(&musb->lock, flags);
1742	if (sysfs_streq(buf, "host"))
1743		status = musb_platform_set_mode(musb, MUSB_HOST);
1744	else if (sysfs_streq(buf, "peripheral"))
1745		status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
1746	else if (sysfs_streq(buf, "otg"))
1747		status = musb_platform_set_mode(musb, MUSB_OTG);
1748	else
1749		status = -EINVAL;
1750	spin_unlock_irqrestore(&musb->lock, flags);
1751
1752	return (status == 0) ? n : status;
1753}
1754static DEVICE_ATTR_RW(mode);
1755
1756static ssize_t
1757vbus_store(struct device *dev, struct device_attribute *attr,
1758		const char *buf, size_t n)
1759{
1760	struct musb	*musb = dev_to_musb(dev);
1761	unsigned long	flags;
1762	unsigned long	val;
1763
1764	if (sscanf(buf, "%lu", &val) < 1) {
1765		dev_err(dev, "Invalid VBUS timeout ms value\n");
1766		return -EINVAL;
1767	}
1768
1769	spin_lock_irqsave(&musb->lock, flags);
1770	/* force T(a_wait_bcon) to be zero/unlimited *OR* valid */
1771	musb->a_wait_bcon = val ? max_t(int, val, OTG_TIME_A_WAIT_BCON) : 0 ;
1772	if (musb->xceiv->otg->state == OTG_STATE_A_WAIT_BCON)
1773		musb->is_active = 0;
1774	musb_platform_try_idle(musb, jiffies + msecs_to_jiffies(val));
1775	spin_unlock_irqrestore(&musb->lock, flags);
1776
1777	return n;
1778}
1779
1780static ssize_t
1781vbus_show(struct device *dev, struct device_attribute *attr, char *buf)
1782{
1783	struct musb	*musb = dev_to_musb(dev);
1784	unsigned long	flags;
1785	unsigned long	val;
1786	int		vbus;
1787	u8		devctl;
1788
1789	pm_runtime_get_sync(dev);
1790	spin_lock_irqsave(&musb->lock, flags);
1791	val = musb->a_wait_bcon;
1792	vbus = musb_platform_get_vbus_status(musb);
1793	if (vbus < 0) {
1794		/* Use default MUSB method by means of DEVCTL register */
1795		devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1796		if ((devctl & MUSB_DEVCTL_VBUS)
1797				== (3 << MUSB_DEVCTL_VBUS_SHIFT))
1798			vbus = 1;
1799		else
1800			vbus = 0;
1801	}
1802	spin_unlock_irqrestore(&musb->lock, flags);
1803	pm_runtime_put_sync(dev);
1804
1805	return sprintf(buf, "Vbus %s, timeout %lu msec\n",
1806			vbus ? "on" : "off", val);
1807}
1808static DEVICE_ATTR_RW(vbus);
1809
1810/* Gadget drivers can't know that a host is connected so they might want
1811 * to start SRP, but users can.  This allows userspace to trigger SRP.
1812 */
1813static ssize_t srp_store(struct device *dev, struct device_attribute *attr,
1814		const char *buf, size_t n)
1815{
1816	struct musb	*musb = dev_to_musb(dev);
1817	unsigned short	srp;
1818
1819	if (sscanf(buf, "%hu", &srp) != 1
1820			|| (srp != 1)) {
1821		dev_err(dev, "SRP: Value must be 1\n");
1822		return -EINVAL;
1823	}
1824
1825	if (srp == 1)
1826		musb_g_wakeup(musb);
1827
1828	return n;
1829}
1830static DEVICE_ATTR_WO(srp);
1831
1832static struct attribute *musb_attrs[] = {
1833	&dev_attr_mode.attr,
1834	&dev_attr_vbus.attr,
1835	&dev_attr_srp.attr,
1836	NULL
1837};
1838ATTRIBUTE_GROUPS(musb);
1839
1840#define MUSB_QUIRK_B_INVALID_VBUS_91	(MUSB_DEVCTL_BDEVICE | \
1841					 (2 << MUSB_DEVCTL_VBUS_SHIFT) | \
1842					 MUSB_DEVCTL_SESSION)
 
 
 
1843#define MUSB_QUIRK_A_DISCONNECT_19	((3 << MUSB_DEVCTL_VBUS_SHIFT) | \
1844					 MUSB_DEVCTL_SESSION)
1845
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1846/*
1847 * Check the musb devctl session bit to determine if we want to
1848 * allow PM runtime for the device. In general, we want to keep things
1849 * active when the session bit is set except after host disconnect.
1850 *
1851 * Only called from musb_irq_work. If this ever needs to get called
1852 * elsewhere, proper locking must be implemented for musb->session.
1853 */
1854static void musb_pm_runtime_check_session(struct musb *musb)
1855{
1856	u8 devctl, s;
1857	int error;
1858
1859	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1860
1861	/* Handle session status quirks first */
1862	s = MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV |
1863		MUSB_DEVCTL_HR;
1864	switch (devctl & ~s) {
 
 
 
 
1865	case MUSB_QUIRK_B_INVALID_VBUS_91:
1866		if (musb->quirk_retries && !musb->flush_irq_work) {
1867			musb_dbg(musb,
1868				 "Poll devctl on invalid vbus, assume no session");
1869			schedule_delayed_work(&musb->irq_work,
1870					      msecs_to_jiffies(1000));
1871			musb->quirk_retries--;
1872			return;
1873		}
1874		/* fall through */
1875	case MUSB_QUIRK_A_DISCONNECT_19:
1876		if (musb->quirk_retries && !musb->flush_irq_work) {
1877			musb_dbg(musb,
1878				 "Poll devctl on possible host mode disconnect");
1879			schedule_delayed_work(&musb->irq_work,
1880					      msecs_to_jiffies(1000));
1881			musb->quirk_retries--;
1882			return;
1883		}
1884		if (!musb->session)
1885			break;
1886		musb_dbg(musb, "Allow PM on possible host mode disconnect");
1887		pm_runtime_mark_last_busy(musb->controller);
1888		pm_runtime_put_autosuspend(musb->controller);
1889		musb->session = false;
1890		return;
1891	default:
1892		break;
1893	}
1894
1895	/* No need to do anything if session has not changed */
1896	s = devctl & MUSB_DEVCTL_SESSION;
1897	if (s == musb->session)
1898		return;
1899
1900	/* Block PM or allow PM? */
1901	if (s) {
1902		musb_dbg(musb, "Block PM on active session: %02x", devctl);
1903		error = pm_runtime_get_sync(musb->controller);
1904		if (error < 0)
1905			dev_err(musb->controller, "Could not enable: %i\n",
1906				error);
1907		musb->quirk_retries = 3;
 
 
 
 
 
 
 
 
 
1908	} else {
1909		musb_dbg(musb, "Allow PM with no session: %02x", devctl);
1910		pm_runtime_mark_last_busy(musb->controller);
1911		pm_runtime_put_autosuspend(musb->controller);
1912	}
1913
1914	musb->session = s;
1915}
1916
1917/* Only used to provide driver mode change events */
1918static void musb_irq_work(struct work_struct *data)
1919{
1920	struct musb *musb = container_of(data, struct musb, irq_work.work);
1921	int error;
1922
1923	error = pm_runtime_get_sync(musb->controller);
1924	if (error < 0) {
1925		dev_err(musb->controller, "Could not enable: %i\n", error);
1926
1927		return;
1928	}
1929
1930	musb_pm_runtime_check_session(musb);
1931
1932	if (musb->xceiv->otg->state != musb->xceiv_old_state) {
1933		musb->xceiv_old_state = musb->xceiv->otg->state;
1934		sysfs_notify(&musb->controller->kobj, NULL, "mode");
1935	}
1936
1937	pm_runtime_mark_last_busy(musb->controller);
1938	pm_runtime_put_autosuspend(musb->controller);
1939}
1940
1941static void musb_recover_from_babble(struct musb *musb)
1942{
1943	int ret;
1944	u8 devctl;
1945
1946	musb_disable_interrupts(musb);
1947
1948	/*
1949	 * wait at least 320 cycles of 60MHz clock. That's 5.3us, we will give
1950	 * it some slack and wait for 10us.
1951	 */
1952	udelay(10);
1953
1954	ret  = musb_platform_recover(musb);
1955	if (ret) {
1956		musb_enable_interrupts(musb);
1957		return;
1958	}
1959
1960	/* drop session bit */
1961	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1962	devctl &= ~MUSB_DEVCTL_SESSION;
1963	musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
1964
1965	/* tell usbcore about it */
1966	musb_root_disconnect(musb);
1967
1968	/*
1969	 * When a babble condition occurs, the musb controller
1970	 * removes the session bit and the endpoint config is lost.
1971	 */
1972	if (musb->dyn_fifo)
1973		ret = ep_config_from_table(musb);
1974	else
1975		ret = ep_config_from_hw(musb);
1976
1977	/* restart session */
1978	if (ret == 0)
1979		musb_start(musb);
1980}
1981
1982/* --------------------------------------------------------------------------
1983 * Init support
1984 */
1985
1986static struct musb *allocate_instance(struct device *dev,
1987		const struct musb_hdrc_config *config, void __iomem *mbase)
1988{
1989	struct musb		*musb;
1990	struct musb_hw_ep	*ep;
1991	int			epnum;
1992	int			ret;
1993
1994	musb = devm_kzalloc(dev, sizeof(*musb), GFP_KERNEL);
1995	if (!musb)
1996		return NULL;
1997
1998	INIT_LIST_HEAD(&musb->control);
1999	INIT_LIST_HEAD(&musb->in_bulk);
2000	INIT_LIST_HEAD(&musb->out_bulk);
2001	INIT_LIST_HEAD(&musb->pending_list);
2002
2003	musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
2004	musb->a_wait_bcon = OTG_TIME_A_WAIT_BCON;
2005	musb->mregs = mbase;
2006	musb->ctrl_base = mbase;
2007	musb->nIrq = -ENODEV;
2008	musb->config = config;
2009	BUG_ON(musb->config->num_eps > MUSB_C_NUM_EPS);
2010	for (epnum = 0, ep = musb->endpoints;
2011			epnum < musb->config->num_eps;
2012			epnum++, ep++) {
2013		ep->musb = musb;
2014		ep->epnum = epnum;
2015	}
2016
2017	musb->controller = dev;
2018
2019	ret = musb_host_alloc(musb);
2020	if (ret < 0)
2021		goto err_free;
2022
2023	dev_set_drvdata(dev, musb);
2024
2025	return musb;
2026
2027err_free:
2028	return NULL;
2029}
2030
2031static void musb_free(struct musb *musb)
2032{
2033	/* this has multiple entry modes. it handles fault cleanup after
2034	 * probe(), where things may be partially set up, as well as rmmod
2035	 * cleanup after everything's been de-activated.
2036	 */
2037
2038	if (musb->nIrq >= 0) {
2039		if (musb->irq_wake)
2040			disable_irq_wake(musb->nIrq);
2041		free_irq(musb->nIrq, musb);
2042	}
2043
2044	musb_host_free(musb);
2045}
2046
2047struct musb_pending_work {
2048	int (*callback)(struct musb *musb, void *data);
2049	void *data;
2050	struct list_head node;
2051};
2052
2053#ifdef CONFIG_PM
2054/*
2055 * Called from musb_runtime_resume(), musb_resume(), and
2056 * musb_queue_resume_work(). Callers must take musb->lock.
2057 */
2058static int musb_run_resume_work(struct musb *musb)
2059{
2060	struct musb_pending_work *w, *_w;
2061	unsigned long flags;
2062	int error = 0;
2063
2064	spin_lock_irqsave(&musb->list_lock, flags);
2065	list_for_each_entry_safe(w, _w, &musb->pending_list, node) {
2066		if (w->callback) {
2067			error = w->callback(musb, w->data);
2068			if (error < 0) {
2069				dev_err(musb->controller,
2070					"resume callback %p failed: %i\n",
2071					w->callback, error);
2072			}
2073		}
2074		list_del(&w->node);
2075		devm_kfree(musb->controller, w);
2076	}
2077	spin_unlock_irqrestore(&musb->list_lock, flags);
2078
2079	return error;
2080}
2081#endif
2082
2083/*
2084 * Called to run work if device is active or else queue the work to happen
2085 * on resume. Caller must take musb->lock and must hold an RPM reference.
2086 *
2087 * Note that we cowardly refuse queuing work after musb PM runtime
2088 * resume is done calling musb_run_resume_work() and return -EINPROGRESS
2089 * instead.
2090 */
2091int musb_queue_resume_work(struct musb *musb,
2092			   int (*callback)(struct musb *musb, void *data),
2093			   void *data)
2094{
2095	struct musb_pending_work *w;
2096	unsigned long flags;
 
2097	int error;
2098
2099	if (WARN_ON(!callback))
2100		return -EINVAL;
2101
2102	if (pm_runtime_active(musb->controller))
2103		return callback(musb, data);
 
 
 
 
 
 
 
2104
2105	w = devm_kzalloc(musb->controller, sizeof(*w), GFP_ATOMIC);
2106	if (!w)
2107		return -ENOMEM;
2108
2109	w->callback = callback;
2110	w->data = data;
2111	spin_lock_irqsave(&musb->list_lock, flags);
2112	if (musb->is_runtime_suspended) {
2113		list_add_tail(&w->node, &musb->pending_list);
2114		error = 0;
2115	} else {
2116		dev_err(musb->controller, "could not add resume work %p\n",
2117			callback);
2118		devm_kfree(musb->controller, w);
2119		error = -EINPROGRESS;
2120	}
 
 
2121	spin_unlock_irqrestore(&musb->list_lock, flags);
2122
 
 
 
2123	return error;
2124}
2125EXPORT_SYMBOL_GPL(musb_queue_resume_work);
2126
2127static void musb_deassert_reset(struct work_struct *work)
2128{
2129	struct musb *musb;
2130	unsigned long flags;
2131
2132	musb = container_of(work, struct musb, deassert_reset_work.work);
2133
2134	spin_lock_irqsave(&musb->lock, flags);
2135
2136	if (musb->port1_status & USB_PORT_STAT_RESET)
2137		musb_port_reset(musb, false);
2138
2139	spin_unlock_irqrestore(&musb->lock, flags);
2140}
2141
2142/*
2143 * Perform generic per-controller initialization.
2144 *
2145 * @dev: the controller (already clocked, etc)
2146 * @nIrq: IRQ number
2147 * @ctrl: virtual address of controller registers,
2148 *	not yet corrected for platform-specific offsets
2149 */
2150static int
2151musb_init_controller(struct device *dev, int nIrq, void __iomem *ctrl)
2152{
2153	int			status;
2154	struct musb		*musb;
2155	struct musb_hdrc_platform_data *plat = dev_get_platdata(dev);
2156
2157	/* The driver might handle more features than the board; OK.
2158	 * Fail when the board needs a feature that's not enabled.
2159	 */
2160	if (!plat) {
2161		dev_err(dev, "no platform_data?\n");
2162		status = -ENODEV;
2163		goto fail0;
2164	}
2165
2166	/* allocate */
2167	musb = allocate_instance(dev, plat->config, ctrl);
2168	if (!musb) {
2169		status = -ENOMEM;
2170		goto fail0;
2171	}
2172
2173	spin_lock_init(&musb->lock);
2174	spin_lock_init(&musb->list_lock);
2175	musb->board_set_power = plat->set_power;
2176	musb->min_power = plat->min_power;
2177	musb->ops = plat->platform_ops;
2178	musb->port_mode = plat->mode;
2179
2180	/*
2181	 * Initialize the default IO functions. At least omap2430 needs
2182	 * these early. We initialize the platform specific IO functions
2183	 * later on.
2184	 */
2185	musb_readb = musb_default_readb;
2186	musb_writeb = musb_default_writeb;
2187	musb_readw = musb_default_readw;
2188	musb_writew = musb_default_writew;
2189
2190	/* The musb_platform_init() call:
2191	 *   - adjusts musb->mregs
2192	 *   - sets the musb->isr
2193	 *   - may initialize an integrated transceiver
2194	 *   - initializes musb->xceiv, usually by otg_get_phy()
2195	 *   - stops powering VBUS
2196	 *
2197	 * There are various transceiver configurations.
2198	 * DaVinci, TUSB60x0, and others integrate them.  OMAP3 uses
2199	 * external/discrete ones in various flavors (twl4030 family,
2200	 * isp1504, non-OTG, etc) mostly hooking up through ULPI.
2201	 */
2202	status = musb_platform_init(musb);
2203	if (status < 0)
2204		goto fail1;
2205
2206	if (!musb->isr) {
2207		status = -ENODEV;
2208		goto fail2;
2209	}
2210
2211
2212	/* Most devices use indexed offset or flat offset */
2213	if (musb->ops->quirks & MUSB_INDEXED_EP) {
2214		musb->io.ep_offset = musb_indexed_ep_offset;
2215		musb->io.ep_select = musb_indexed_ep_select;
2216	} else {
2217		musb->io.ep_offset = musb_flat_ep_offset;
2218		musb->io.ep_select = musb_flat_ep_select;
2219	}
2220
2221	if (musb->ops->quirks & MUSB_G_NO_SKB_RESERVE)
2222		musb->g.quirk_avoids_skb_reserve = 1;
2223
2224	/* At least tusb6010 has its own offsets */
2225	if (musb->ops->ep_offset)
2226		musb->io.ep_offset = musb->ops->ep_offset;
2227	if (musb->ops->ep_select)
2228		musb->io.ep_select = musb->ops->ep_select;
2229
2230	if (musb->ops->fifo_mode)
2231		fifo_mode = musb->ops->fifo_mode;
2232	else
2233		fifo_mode = 4;
2234
2235	if (musb->ops->fifo_offset)
2236		musb->io.fifo_offset = musb->ops->fifo_offset;
2237	else
2238		musb->io.fifo_offset = musb_default_fifo_offset;
2239
2240	if (musb->ops->busctl_offset)
2241		musb->io.busctl_offset = musb->ops->busctl_offset;
2242	else
2243		musb->io.busctl_offset = musb_default_busctl_offset;
2244
2245	if (musb->ops->readb)
2246		musb_readb = musb->ops->readb;
2247	if (musb->ops->writeb)
2248		musb_writeb = musb->ops->writeb;
 
 
 
 
 
2249	if (musb->ops->readw)
2250		musb_readw = musb->ops->readw;
2251	if (musb->ops->writew)
2252		musb_writew = musb->ops->writew;
 
 
 
 
2253
2254#ifndef CONFIG_MUSB_PIO_ONLY
2255	if (!musb->ops->dma_init || !musb->ops->dma_exit) {
2256		dev_err(dev, "DMA controller not set\n");
2257		status = -ENODEV;
2258		goto fail2;
2259	}
2260	musb_dma_controller_create = musb->ops->dma_init;
2261	musb_dma_controller_destroy = musb->ops->dma_exit;
2262#endif
2263
2264	if (musb->ops->read_fifo)
2265		musb->io.read_fifo = musb->ops->read_fifo;
2266	else
2267		musb->io.read_fifo = musb_default_read_fifo;
2268
2269	if (musb->ops->write_fifo)
2270		musb->io.write_fifo = musb->ops->write_fifo;
2271	else
2272		musb->io.write_fifo = musb_default_write_fifo;
2273
2274	if (!musb->xceiv->io_ops) {
 
 
 
 
 
 
 
 
 
 
2275		musb->xceiv->io_dev = musb->controller;
2276		musb->xceiv->io_priv = musb->mregs;
2277		musb->xceiv->io_ops = &musb_ulpi_access;
2278	}
2279
2280	if (musb->ops->phy_callback)
2281		musb_phy_callback = musb->ops->phy_callback;
2282
2283	/*
2284	 * We need musb_read/write functions initialized for PM.
2285	 * Note that at least 2430 glue needs autosuspend delay
2286	 * somewhere above 300 ms for the hardware to idle properly
2287	 * after disconnecting the cable in host mode. Let's use
2288	 * 500 ms for some margin.
2289	 */
2290	pm_runtime_use_autosuspend(musb->controller);
2291	pm_runtime_set_autosuspend_delay(musb->controller, 500);
2292	pm_runtime_enable(musb->controller);
2293	pm_runtime_get_sync(musb->controller);
2294
2295	status = usb_phy_init(musb->xceiv);
2296	if (status < 0)
2297		goto err_usb_phy_init;
2298
2299	if (use_dma && dev->dma_mask) {
2300		musb->dma_controller =
2301			musb_dma_controller_create(musb, musb->mregs);
2302		if (IS_ERR(musb->dma_controller)) {
2303			status = PTR_ERR(musb->dma_controller);
2304			goto fail2_5;
2305		}
2306	}
2307
2308	/* be sure interrupts are disabled before connecting ISR */
2309	musb_platform_disable(musb);
2310	musb_disable_interrupts(musb);
2311	musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
2312
 
 
 
2313	/* Init IRQ workqueue before request_irq */
2314	INIT_DELAYED_WORK(&musb->irq_work, musb_irq_work);
2315	INIT_DELAYED_WORK(&musb->deassert_reset_work, musb_deassert_reset);
2316	INIT_DELAYED_WORK(&musb->finish_resume_work, musb_host_finish_resume);
2317
2318	/* setup musb parts of the core (especially endpoints) */
2319	status = musb_core_init(plat->config->multipoint
2320			? MUSB_CONTROLLER_MHDRC
2321			: MUSB_CONTROLLER_HDRC, musb);
2322	if (status < 0)
2323		goto fail3;
2324
2325	timer_setup(&musb->otg_timer, musb_otg_timer_func, 0);
2326
2327	/* attach to the IRQ */
2328	if (request_irq(nIrq, musb->isr, IRQF_SHARED, dev_name(dev), musb)) {
2329		dev_err(dev, "request_irq %d failed!\n", nIrq);
2330		status = -ENODEV;
2331		goto fail3;
2332	}
2333	musb->nIrq = nIrq;
2334	/* FIXME this handles wakeup irqs wrong */
2335	if (enable_irq_wake(nIrq) == 0) {
2336		musb->irq_wake = 1;
2337		device_init_wakeup(dev, 1);
2338	} else {
2339		musb->irq_wake = 0;
2340	}
2341
2342	/* program PHY to use external vBus if required */
2343	if (plat->extvbus) {
2344		u8 busctl = musb_readb(musb->mregs, MUSB_ULPI_BUSCONTROL);
2345		busctl |= MUSB_ULPI_USE_EXTVBUS;
2346		musb_writeb(musb->mregs, MUSB_ULPI_BUSCONTROL, busctl);
2347	}
2348
2349	MUSB_DEV_MODE(musb);
2350	musb->xceiv->otg->state = OTG_STATE_B_IDLE;
2351
2352	switch (musb->port_mode) {
2353	case MUSB_HOST:
2354		status = musb_host_setup(musb, plat->power);
2355		if (status < 0)
2356			goto fail3;
2357		status = musb_platform_set_mode(musb, MUSB_HOST);
2358		break;
2359	case MUSB_PERIPHERAL:
2360		status = musb_gadget_setup(musb);
2361		if (status < 0)
2362			goto fail3;
2363		status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
2364		break;
2365	case MUSB_OTG:
2366		status = musb_host_setup(musb, plat->power);
2367		if (status < 0)
2368			goto fail3;
2369		status = musb_gadget_setup(musb);
2370		if (status) {
2371			musb_host_cleanup(musb);
2372			goto fail3;
2373		}
2374		status = musb_platform_set_mode(musb, MUSB_OTG);
2375		break;
2376	default:
2377		dev_err(dev, "unsupported port mode %d\n", musb->port_mode);
2378		break;
2379	}
2380
2381	if (status < 0)
2382		goto fail3;
2383
2384	musb_init_debugfs(musb);
2385
2386	musb->is_initialized = 1;
2387	pm_runtime_mark_last_busy(musb->controller);
2388	pm_runtime_put_autosuspend(musb->controller);
2389
2390	return 0;
2391
2392fail3:
2393	cancel_delayed_work_sync(&musb->irq_work);
2394	cancel_delayed_work_sync(&musb->finish_resume_work);
2395	cancel_delayed_work_sync(&musb->deassert_reset_work);
2396	if (musb->dma_controller)
2397		musb_dma_controller_destroy(musb->dma_controller);
2398
2399fail2_5:
2400	usb_phy_shutdown(musb->xceiv);
2401
2402err_usb_phy_init:
2403	pm_runtime_dont_use_autosuspend(musb->controller);
2404	pm_runtime_put_sync(musb->controller);
2405	pm_runtime_disable(musb->controller);
2406
2407fail2:
2408	if (musb->irq_wake)
2409		device_init_wakeup(dev, 0);
2410	musb_platform_exit(musb);
2411
2412fail1:
2413	if (status != -EPROBE_DEFER)
2414		dev_err(musb->controller,
2415			"%s failed with status %d\n", __func__, status);
2416
2417	musb_free(musb);
2418
2419fail0:
2420
2421	return status;
2422
2423}
2424
2425/*-------------------------------------------------------------------------*/
2426
2427/* all implementations (PCI bridge to FPGA, VLYNQ, etc) should just
2428 * bridge to a platform device; this driver then suffices.
2429 */
2430static int musb_probe(struct platform_device *pdev)
2431{
2432	struct device	*dev = &pdev->dev;
2433	int		irq = platform_get_irq_byname(pdev, "mc");
2434	struct resource	*iomem;
2435	void __iomem	*base;
2436
2437	if (irq <= 0)
2438		return -ENODEV;
2439
2440	iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2441	base = devm_ioremap_resource(dev, iomem);
2442	if (IS_ERR(base))
2443		return PTR_ERR(base);
2444
2445	return musb_init_controller(dev, irq, base);
2446}
2447
2448static int musb_remove(struct platform_device *pdev)
2449{
2450	struct device	*dev = &pdev->dev;
2451	struct musb	*musb = dev_to_musb(dev);
2452	unsigned long	flags;
2453
2454	/* this gets called on rmmod.
2455	 *  - Host mode: host may still be active
2456	 *  - Peripheral mode: peripheral is deactivated (or never-activated)
2457	 *  - OTG mode: both roles are deactivated (or never-activated)
2458	 */
2459	musb_exit_debugfs(musb);
2460
2461	cancel_delayed_work_sync(&musb->irq_work);
2462	cancel_delayed_work_sync(&musb->finish_resume_work);
2463	cancel_delayed_work_sync(&musb->deassert_reset_work);
2464	pm_runtime_get_sync(musb->controller);
2465	musb_host_cleanup(musb);
2466	musb_gadget_cleanup(musb);
2467
2468	musb_platform_disable(musb);
2469	spin_lock_irqsave(&musb->lock, flags);
2470	musb_disable_interrupts(musb);
2471	musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
2472	spin_unlock_irqrestore(&musb->lock, flags);
2473	musb_platform_exit(musb);
2474
2475	pm_runtime_dont_use_autosuspend(musb->controller);
2476	pm_runtime_put_sync(musb->controller);
2477	pm_runtime_disable(musb->controller);
2478	musb_phy_callback = NULL;
2479	if (musb->dma_controller)
2480		musb_dma_controller_destroy(musb->dma_controller);
2481	usb_phy_shutdown(musb->xceiv);
2482	musb_free(musb);
2483	device_init_wakeup(dev, 0);
2484	return 0;
2485}
2486
2487#ifdef	CONFIG_PM
2488
2489static void musb_save_context(struct musb *musb)
2490{
2491	int i;
2492	void __iomem *musb_base = musb->mregs;
2493	void __iomem *epio;
2494
2495	musb->context.frame = musb_readw(musb_base, MUSB_FRAME);
2496	musb->context.testmode = musb_readb(musb_base, MUSB_TESTMODE);
2497	musb->context.busctl = musb_readb(musb_base, MUSB_ULPI_BUSCONTROL);
2498	musb->context.power = musb_readb(musb_base, MUSB_POWER);
2499	musb->context.intrusbe = musb_readb(musb_base, MUSB_INTRUSBE);
2500	musb->context.index = musb_readb(musb_base, MUSB_INDEX);
2501	musb->context.devctl = musb_readb(musb_base, MUSB_DEVCTL);
2502
2503	for (i = 0; i < musb->config->num_eps; ++i) {
2504		struct musb_hw_ep	*hw_ep;
2505
2506		hw_ep = &musb->endpoints[i];
2507		if (!hw_ep)
2508			continue;
2509
2510		epio = hw_ep->regs;
2511		if (!epio)
2512			continue;
2513
2514		musb_writeb(musb_base, MUSB_INDEX, i);
2515		musb->context.index_regs[i].txmaxp =
2516			musb_readw(epio, MUSB_TXMAXP);
2517		musb->context.index_regs[i].txcsr =
2518			musb_readw(epio, MUSB_TXCSR);
2519		musb->context.index_regs[i].rxmaxp =
2520			musb_readw(epio, MUSB_RXMAXP);
2521		musb->context.index_regs[i].rxcsr =
2522			musb_readw(epio, MUSB_RXCSR);
2523
2524		if (musb->dyn_fifo) {
2525			musb->context.index_regs[i].txfifoadd =
2526					musb_readw(musb_base, MUSB_TXFIFOADD);
2527			musb->context.index_regs[i].rxfifoadd =
2528					musb_readw(musb_base, MUSB_RXFIFOADD);
2529			musb->context.index_regs[i].txfifosz =
2530					musb_readb(musb_base, MUSB_TXFIFOSZ);
2531			musb->context.index_regs[i].rxfifosz =
2532					musb_readb(musb_base, MUSB_RXFIFOSZ);
2533		}
2534
2535		musb->context.index_regs[i].txtype =
2536			musb_readb(epio, MUSB_TXTYPE);
2537		musb->context.index_regs[i].txinterval =
2538			musb_readb(epio, MUSB_TXINTERVAL);
2539		musb->context.index_regs[i].rxtype =
2540			musb_readb(epio, MUSB_RXTYPE);
2541		musb->context.index_regs[i].rxinterval =
2542			musb_readb(epio, MUSB_RXINTERVAL);
2543
2544		musb->context.index_regs[i].txfunaddr =
2545			musb_read_txfunaddr(musb, i);
2546		musb->context.index_regs[i].txhubaddr =
2547			musb_read_txhubaddr(musb, i);
2548		musb->context.index_regs[i].txhubport =
2549			musb_read_txhubport(musb, i);
2550
2551		musb->context.index_regs[i].rxfunaddr =
2552			musb_read_rxfunaddr(musb, i);
2553		musb->context.index_regs[i].rxhubaddr =
2554			musb_read_rxhubaddr(musb, i);
2555		musb->context.index_regs[i].rxhubport =
2556			musb_read_rxhubport(musb, i);
2557	}
2558}
2559
2560static void musb_restore_context(struct musb *musb)
2561{
2562	int i;
2563	void __iomem *musb_base = musb->mregs;
2564	void __iomem *epio;
2565	u8 power;
2566
2567	musb_writew(musb_base, MUSB_FRAME, musb->context.frame);
2568	musb_writeb(musb_base, MUSB_TESTMODE, musb->context.testmode);
2569	musb_writeb(musb_base, MUSB_ULPI_BUSCONTROL, musb->context.busctl);
2570
2571	/* Don't affect SUSPENDM/RESUME bits in POWER reg */
2572	power = musb_readb(musb_base, MUSB_POWER);
2573	power &= MUSB_POWER_SUSPENDM | MUSB_POWER_RESUME;
2574	musb->context.power &= ~(MUSB_POWER_SUSPENDM | MUSB_POWER_RESUME);
2575	power |= musb->context.power;
2576	musb_writeb(musb_base, MUSB_POWER, power);
2577
2578	musb_writew(musb_base, MUSB_INTRTXE, musb->intrtxe);
2579	musb_writew(musb_base, MUSB_INTRRXE, musb->intrrxe);
2580	musb_writeb(musb_base, MUSB_INTRUSBE, musb->context.intrusbe);
2581	if (musb->context.devctl & MUSB_DEVCTL_SESSION)
2582		musb_writeb(musb_base, MUSB_DEVCTL, musb->context.devctl);
2583
2584	for (i = 0; i < musb->config->num_eps; ++i) {
2585		struct musb_hw_ep	*hw_ep;
2586
2587		hw_ep = &musb->endpoints[i];
2588		if (!hw_ep)
2589			continue;
2590
2591		epio = hw_ep->regs;
2592		if (!epio)
2593			continue;
2594
2595		musb_writeb(musb_base, MUSB_INDEX, i);
2596		musb_writew(epio, MUSB_TXMAXP,
2597			musb->context.index_regs[i].txmaxp);
2598		musb_writew(epio, MUSB_TXCSR,
2599			musb->context.index_regs[i].txcsr);
2600		musb_writew(epio, MUSB_RXMAXP,
2601			musb->context.index_regs[i].rxmaxp);
2602		musb_writew(epio, MUSB_RXCSR,
2603			musb->context.index_regs[i].rxcsr);
2604
2605		if (musb->dyn_fifo) {
2606			musb_writeb(musb_base, MUSB_TXFIFOSZ,
2607				musb->context.index_regs[i].txfifosz);
2608			musb_writeb(musb_base, MUSB_RXFIFOSZ,
2609				musb->context.index_regs[i].rxfifosz);
2610			musb_writew(musb_base, MUSB_TXFIFOADD,
2611				musb->context.index_regs[i].txfifoadd);
2612			musb_writew(musb_base, MUSB_RXFIFOADD,
2613				musb->context.index_regs[i].rxfifoadd);
2614		}
2615
2616		musb_writeb(epio, MUSB_TXTYPE,
2617				musb->context.index_regs[i].txtype);
2618		musb_writeb(epio, MUSB_TXINTERVAL,
2619				musb->context.index_regs[i].txinterval);
2620		musb_writeb(epio, MUSB_RXTYPE,
2621				musb->context.index_regs[i].rxtype);
2622		musb_writeb(epio, MUSB_RXINTERVAL,
2623
2624				musb->context.index_regs[i].rxinterval);
2625		musb_write_txfunaddr(musb, i,
2626				musb->context.index_regs[i].txfunaddr);
2627		musb_write_txhubaddr(musb, i,
2628				musb->context.index_regs[i].txhubaddr);
2629		musb_write_txhubport(musb, i,
2630				musb->context.index_regs[i].txhubport);
2631
2632		musb_write_rxfunaddr(musb, i,
2633				musb->context.index_regs[i].rxfunaddr);
2634		musb_write_rxhubaddr(musb, i,
2635				musb->context.index_regs[i].rxhubaddr);
2636		musb_write_rxhubport(musb, i,
2637				musb->context.index_regs[i].rxhubport);
2638	}
2639	musb_writeb(musb_base, MUSB_INDEX, musb->context.index);
2640}
2641
2642static int musb_suspend(struct device *dev)
2643{
2644	struct musb	*musb = dev_to_musb(dev);
2645	unsigned long	flags;
2646	int ret;
2647
2648	ret = pm_runtime_get_sync(dev);
2649	if (ret < 0) {
2650		pm_runtime_put_noidle(dev);
2651		return ret;
2652	}
2653
2654	musb_platform_disable(musb);
2655	musb_disable_interrupts(musb);
2656
2657	musb->flush_irq_work = true;
2658	while (flush_delayed_work(&musb->irq_work))
2659		;
2660	musb->flush_irq_work = false;
2661
2662	if (!(musb->ops->quirks & MUSB_PRESERVE_SESSION))
2663		musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
2664
2665	WARN_ON(!list_empty(&musb->pending_list));
2666
2667	spin_lock_irqsave(&musb->lock, flags);
2668
2669	if (is_peripheral_active(musb)) {
2670		/* FIXME force disconnect unless we know USB will wake
2671		 * the system up quickly enough to respond ...
2672		 */
2673	} else if (is_host_active(musb)) {
2674		/* we know all the children are suspended; sometimes
2675		 * they will even be wakeup-enabled.
2676		 */
2677	}
2678
2679	musb_save_context(musb);
2680
2681	spin_unlock_irqrestore(&musb->lock, flags);
2682	return 0;
2683}
2684
2685static int musb_resume(struct device *dev)
2686{
2687	struct musb *musb = dev_to_musb(dev);
2688	unsigned long flags;
2689	int error;
2690	u8 devctl;
2691	u8 mask;
2692
2693	/*
2694	 * For static cmos like DaVinci, register values were preserved
2695	 * unless for some reason the whole soc powered down or the USB
2696	 * module got reset through the PSC (vs just being disabled).
2697	 *
2698	 * For the DSPS glue layer though, a full register restore has to
2699	 * be done. As it shouldn't harm other platforms, we do it
2700	 * unconditionally.
2701	 */
2702
2703	musb_restore_context(musb);
2704
2705	devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
2706	mask = MUSB_DEVCTL_BDEVICE | MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV;
2707	if ((devctl & mask) != (musb->context.devctl & mask))
2708		musb->port1_status = 0;
2709
2710	musb_enable_interrupts(musb);
2711	musb_platform_enable(musb);
2712
 
 
 
 
 
 
 
2713	spin_lock_irqsave(&musb->lock, flags);
2714	error = musb_run_resume_work(musb);
2715	if (error)
2716		dev_err(musb->controller, "resume work failed with %i\n",
2717			error);
2718	spin_unlock_irqrestore(&musb->lock, flags);
2719
2720	pm_runtime_mark_last_busy(dev);
2721	pm_runtime_put_autosuspend(dev);
2722
2723	return 0;
2724}
2725
2726static int musb_runtime_suspend(struct device *dev)
2727{
2728	struct musb	*musb = dev_to_musb(dev);
2729
2730	musb_save_context(musb);
2731	musb->is_runtime_suspended = 1;
2732
2733	return 0;
2734}
2735
2736static int musb_runtime_resume(struct device *dev)
2737{
2738	struct musb *musb = dev_to_musb(dev);
2739	unsigned long flags;
2740	int error;
2741
2742	/*
2743	 * When pm_runtime_get_sync called for the first time in driver
2744	 * init,  some of the structure is still not initialized which is
2745	 * used in restore function. But clock needs to be
2746	 * enabled before any register access, so
2747	 * pm_runtime_get_sync has to be called.
2748	 * Also context restore without save does not make
2749	 * any sense
2750	 */
2751	if (!musb->is_initialized)
2752		return 0;
2753
2754	musb_restore_context(musb);
2755
2756	spin_lock_irqsave(&musb->lock, flags);
2757	error = musb_run_resume_work(musb);
2758	if (error)
2759		dev_err(musb->controller, "resume work failed with %i\n",
2760			error);
2761	musb->is_runtime_suspended = 0;
2762	spin_unlock_irqrestore(&musb->lock, flags);
2763
2764	return 0;
2765}
2766
2767static const struct dev_pm_ops musb_dev_pm_ops = {
2768	.suspend	= musb_suspend,
2769	.resume		= musb_resume,
2770	.runtime_suspend = musb_runtime_suspend,
2771	.runtime_resume = musb_runtime_resume,
2772};
2773
2774#define MUSB_DEV_PM_OPS (&musb_dev_pm_ops)
2775#else
2776#define	MUSB_DEV_PM_OPS	NULL
2777#endif
2778
2779static struct platform_driver musb_driver = {
2780	.driver = {
2781		.name		= (char *)musb_driver_name,
2782		.bus		= &platform_bus_type,
2783		.pm		= MUSB_DEV_PM_OPS,
2784		.dev_groups	= musb_groups,
2785	},
2786	.probe		= musb_probe,
2787	.remove		= musb_remove,
2788};
2789
2790module_platform_driver(musb_driver);