[mirror_ubuntu-zesty-kernel.git] / drivers / mfd / omap-usb-tll.c

/**
 * omap-usb-tll.c - The USB TLL driver for OMAP EHCI & OHCI
 *
 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
 * Author: Keshava Munegowda <keshava_mgowda@ti.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2  of
 * the License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/types.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/platform_device.h>
#include <linux/clk.h>
#include <linux/io.h>
#include <linux/err.h>
#include <linux/pm_runtime.h>
#include <linux/platform_data/usb-omap.h>

#define USBTLL_DRIVER_NAME	"usbhs_tll"

/* TLL Register Set */
#define	OMAP_USBTLL_REVISION				(0x00)
#define	OMAP_USBTLL_SYSCONFIG				(0x10)
#define	OMAP_USBTLL_SYSCONFIG_CACTIVITY			(1 << 8)
#define	OMAP_USBTLL_SYSCONFIG_SIDLEMODE			(1 << 3)
#define	OMAP_USBTLL_SYSCONFIG_ENAWAKEUP			(1 << 2)
#define	OMAP_USBTLL_SYSCONFIG_SOFTRESET			(1 << 1)
#define	OMAP_USBTLL_SYSCONFIG_AUTOIDLE			(1 << 0)

#define	OMAP_USBTLL_SYSSTATUS				(0x14)
#define	OMAP_USBTLL_SYSSTATUS_RESETDONE			(1 << 0)

#define	OMAP_USBTLL_IRQSTATUS				(0x18)
#define	OMAP_USBTLL_IRQENABLE				(0x1C)

#define	OMAP_TLL_SHARED_CONF				(0x30)
#define	OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN		(1 << 6)
#define	OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN		(1 << 5)
#define	OMAP_TLL_SHARED_CONF_USB_DIVRATION		(1 << 2)
#define	OMAP_TLL_SHARED_CONF_FCLK_REQ			(1 << 1)
#define	OMAP_TLL_SHARED_CONF_FCLK_IS_ON			(1 << 0)

#define	OMAP_TLL_CHANNEL_CONF(num)			(0x040 + 0x004 * num)
#define OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT		24
#define	OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF		(1 << 11)
#define	OMAP_TLL_CHANNEL_CONF_ULPI_ULPIAUTOIDLE		(1 << 10)
#define	OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE		(1 << 9)
#define	OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE		(1 << 8)
#define OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS		(1 << 1)
#define	OMAP_TLL_CHANNEL_CONF_CHANEN			(1 << 0)

#define OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0		0x0
#define OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM		0x1
#define OMAP_TLL_FSLSMODE_3PIN_PHY			0x2
#define OMAP_TLL_FSLSMODE_4PIN_PHY			0x3
#define OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0		0x4
#define OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM		0x5
#define OMAP_TLL_FSLSMODE_3PIN_TLL			0x6
#define OMAP_TLL_FSLSMODE_4PIN_TLL			0x7
#define OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0		0xA
#define OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM		0xB

#define	OMAP_TLL_ULPI_FUNCTION_CTRL(num)		(0x804 + 0x100 * num)
#define	OMAP_TLL_ULPI_INTERFACE_CTRL(num)		(0x807 + 0x100 * num)
#define	OMAP_TLL_ULPI_OTG_CTRL(num)			(0x80A + 0x100 * num)
#define	OMAP_TLL_ULPI_INT_EN_RISE(num)			(0x80D + 0x100 * num)
#define	OMAP_TLL_ULPI_INT_EN_FALL(num)			(0x810 + 0x100 * num)
#define	OMAP_TLL_ULPI_INT_STATUS(num)			(0x813 + 0x100 * num)
#define	OMAP_TLL_ULPI_INT_LATCH(num)			(0x814 + 0x100 * num)
#define	OMAP_TLL_ULPI_DEBUG(num)			(0x815 + 0x100 * num)
#define	OMAP_TLL_ULPI_SCRATCH_REGISTER(num)		(0x816 + 0x100 * num)

#define OMAP_REV2_TLL_CHANNEL_COUNT			2
#define OMAP_TLL_CHANNEL_COUNT				3
#define OMAP_TLL_CHANNEL_1_EN_MASK			(1 << 0)
#define OMAP_TLL_CHANNEL_2_EN_MASK			(1 << 1)
#define OMAP_TLL_CHANNEL_3_EN_MASK			(1 << 2)

/* Values of USBTLL_REVISION - Note: these are not given in the TRM */
#define OMAP_USBTLL_REV1		0x00000015	/* OMAP3 */
#define OMAP_USBTLL_REV2		0x00000018	/* OMAP 3630 */
#define OMAP_USBTLL_REV3		0x00000004	/* OMAP4 */

#define is_ehci_tll_mode(x)	(x == OMAP_EHCI_PORT_MODE_TLL)

/* only PHY and UNUSED modes don't need TLL */
#define omap_usb_mode_needs_tll(x)	((x) != OMAP_USBHS_PORT_MODE_UNUSED &&\
					 (x) != OMAP_EHCI_PORT_MODE_PHY)

struct usbtll_omap {
	int					nch;	/* num. of channels */
	struct usbhs_omap_platform_data		*pdata;
	struct clk				**ch_clk;
	/* secure the register updates */
	spinlock_t				lock;
};

/*-------------------------------------------------------------------------*/

const char usbtll_driver_name[] = USBTLL_DRIVER_NAME;
struct platform_device	*tll_pdev;

/*-------------------------------------------------------------------------*/

static inline void usbtll_write(void __iomem *base, u32 reg, u32 val)
{
	__raw_writel(val, base + reg);
}

static inline u32 usbtll_read(void __iomem *base, u32 reg)
{
	return __raw_readl(base + reg);
}

static inline void usbtll_writeb(void __iomem *base, u8 reg, u8 val)
{
	__raw_writeb(val, base + reg);
}

static inline u8 usbtll_readb(void __iomem *base, u8 reg)
{
	return __raw_readb(base + reg);
}

/*-------------------------------------------------------------------------*/

static bool is_ohci_port(enum usbhs_omap_port_mode pmode)
{
	switch (pmode) {
	case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
	case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
	case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
	case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
	case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
	case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
	case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
	case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
	case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
	case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
		return true;

	default:
		return false;
	}
}

/*
 * convert the port-mode enum to a value we can use in the FSLSMODE
 * field of USBTLL_CHANNEL_CONF
 */
static unsigned ohci_omap3_fslsmode(enum usbhs_omap_port_mode mode)
{
	switch (mode) {
	case OMAP_USBHS_PORT_MODE_UNUSED:
	case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
		return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;

	case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
		return OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM;

	case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
		return OMAP_TLL_FSLSMODE_3PIN_PHY;

	case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
		return OMAP_TLL_FSLSMODE_4PIN_PHY;

	case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
		return OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0;

	case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
		return OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM;

	case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
		return OMAP_TLL_FSLSMODE_3PIN_TLL;

	case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
		return OMAP_TLL_FSLSMODE_4PIN_TLL;

	case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
		return OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0;

	case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
		return OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM;
	default:
		pr_warn("Invalid port mode, using default\n");
		return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
	}
}

/**
 * usbtll_omap_probe - initialize TI-based HCDs
 *
 * Allocates basic resources for this USB host controller.
 */
static int usbtll_omap_probe(struct platform_device *pdev)
{
	struct device				*dev =  &pdev->dev;
	struct usbhs_omap_platform_data		*pdata = dev->platform_data;
	void __iomem				*base;
	struct resource				*res;
	struct usbtll_omap			*tll;
	unsigned				reg;
	unsigned long				flags;
	int					ret = 0;
	int					i, ver;
	bool needs_tll;

	dev_dbg(dev, "starting TI HSUSB TLL Controller\n");

	tll = devm_kzalloc(dev, sizeof(struct usbtll_omap), GFP_KERNEL);
	if (!tll) {
		dev_err(dev, "Memory allocation failed\n");
		return -ENOMEM;
	}

	if (!pdata) {
		dev_err(dev, "Platform data missing\n");
		return -ENODEV;
	}

	spin_lock_init(&tll->lock);

	tll->pdata = pdata;

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	base = devm_request_and_ioremap(dev, res);
	if (!base) {
		ret = -EADDRNOTAVAIL;
		dev_err(dev, "Resource request/ioremap failed:%d\n", ret);
		return ret;
	}

	platform_set_drvdata(pdev, tll);
	pm_runtime_enable(dev);
	pm_runtime_get_sync(dev);

	spin_lock_irqsave(&tll->lock, flags);

	ver =  usbtll_read(base, OMAP_USBTLL_REVISION);
	switch (ver) {
	case OMAP_USBTLL_REV1:
		tll->nch = OMAP_TLL_CHANNEL_COUNT;
		break;
	case OMAP_USBTLL_REV2:
	case OMAP_USBTLL_REV3:
		tll->nch = OMAP_REV2_TLL_CHANNEL_COUNT;
		break;
	default:
		tll->nch = OMAP_TLL_CHANNEL_COUNT;
		dev_dbg(dev,
		 "USB TLL Rev : 0x%x not recognized, assuming %d channels\n",
			ver, tll->nch);
		break;
	}

	spin_unlock_irqrestore(&tll->lock, flags);

	tll->ch_clk = devm_kzalloc(dev, sizeof(struct clk * [tll->nch]),
						GFP_KERNEL);
	if (!tll->ch_clk) {
		ret = -ENOMEM;
		dev_err(dev, "Couldn't allocate memory for channel clocks\n");
		goto err_clk_alloc;
	}

	for (i = 0; i < tll->nch; i++) {
		char clkname[] = "usb_tll_hs_usb_chx_clk";

		snprintf(clkname, sizeof(clkname),
					"usb_tll_hs_usb_ch%d_clk", i);
		tll->ch_clk[i] = clk_get(dev, clkname);

		if (IS_ERR(tll->ch_clk[i]))
			dev_dbg(dev, "can't get clock : %s\n", clkname);
	}

	spin_lock_irqsave(&tll->lock, flags);

	needs_tll = false;
	for (i = 0; i < tll->nch; i++)
		needs_tll |= omap_usb_mode_needs_tll(pdata->port_mode[i]);

	if (needs_tll) {

		/* Program Common TLL register */
		reg = usbtll_read(base, OMAP_TLL_SHARED_CONF);
		reg |= (OMAP_TLL_SHARED_CONF_FCLK_IS_ON
			| OMAP_TLL_SHARED_CONF_USB_DIVRATION);
		reg &= ~OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN;
		reg &= ~OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN;

		usbtll_write(base, OMAP_TLL_SHARED_CONF, reg);

		/* Enable channels now */
		for (i = 0; i < tll->nch; i++) {
			reg = usbtll_read(base,	OMAP_TLL_CHANNEL_CONF(i));

			if (is_ohci_port(pdata->port_mode[i])) {
				reg |= ohci_omap3_fslsmode(pdata->port_mode[i])
				<< OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT;
				reg |= OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS;
			} else if (pdata->port_mode[i] ==
					OMAP_EHCI_PORT_MODE_TLL) {
				/*
				 * Disable AutoIdle, BitStuffing
				 * and use SDR Mode
				 */
				reg &= ~(OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE
					| OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF
					| OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE);
			} else {
				continue;
			}
			reg |= OMAP_TLL_CHANNEL_CONF_CHANEN;
			usbtll_write(base, OMAP_TLL_CHANNEL_CONF(i), reg);

			usbtll_writeb(base,
				      OMAP_TLL_ULPI_SCRATCH_REGISTER(i),
				      0xbe);
		}
	}

	spin_unlock_irqrestore(&tll->lock, flags);
	pm_runtime_put_sync(dev);
	tll_pdev = pdev;

	return 0;

err_clk_alloc:
	pm_runtime_put_sync(dev);
	pm_runtime_disable(dev);

	return ret;
}

/**
 * usbtll_omap_remove - shutdown processing for UHH & TLL HCDs
 * @pdev: USB Host Controller being removed
 *
 * Reverses the effect of usbtll_omap_probe().
 */
static int usbtll_omap_remove(struct platform_device *pdev)
{
	struct usbtll_omap *tll = platform_get_drvdata(pdev);
	int i;

	for (i = 0; i < tll->nch; i++)
		if (!IS_ERR(tll->ch_clk[i]))
			clk_put(tll->ch_clk[i]);

	pm_runtime_disable(&pdev->dev);
	return 0;
}

static int usbtll_runtime_resume(struct device *dev)
{
	struct usbtll_omap			*tll = dev_get_drvdata(dev);
	struct usbhs_omap_platform_data		*pdata = tll->pdata;
	unsigned long				flags;
	int i;

	dev_dbg(dev, "usbtll_runtime_resume\n");

	spin_lock_irqsave(&tll->lock, flags);

	for (i = 0; i < tll->nch; i++) {
		if (omap_usb_mode_needs_tll(pdata->port_mode[i])) {
			int r;

			if (IS_ERR(tll->ch_clk[i]))
				continue;

			r = clk_enable(tll->ch_clk[i]);
			if (r) {
				dev_err(dev,
				 "Error enabling ch %d clock: %d\n", i, r);
			}
		}
	}

	spin_unlock_irqrestore(&tll->lock, flags);

	return 0;
}

static int usbtll_runtime_suspend(struct device *dev)
{
	struct usbtll_omap			*tll = dev_get_drvdata(dev);
	struct usbhs_omap_platform_data		*pdata = tll->pdata;
	unsigned long				flags;
	int i;

	dev_dbg(dev, "usbtll_runtime_suspend\n");

	spin_lock_irqsave(&tll->lock, flags);

	for (i = 0; i < tll->nch; i++) {
		if (omap_usb_mode_needs_tll(pdata->port_mode[i])) {
			if (!IS_ERR(tll->ch_clk[i]))
				clk_disable(tll->ch_clk[i]);
		}
	}

	spin_unlock_irqrestore(&tll->lock, flags);

	return 0;
}

static const struct dev_pm_ops usbtllomap_dev_pm_ops = {
	SET_RUNTIME_PM_OPS(usbtll_runtime_suspend,
			   usbtll_runtime_resume,
			   NULL)
};

static struct platform_driver usbtll_omap_driver = {
	.driver = {
		.name		= (char *)usbtll_driver_name,
		.owner		= THIS_MODULE,
		.pm		= &usbtllomap_dev_pm_ops,
	},
	.probe		= usbtll_omap_probe,
	.remove		= usbtll_omap_remove,
};

int omap_tll_enable(void)
{
	if (!tll_pdev) {
		pr_err("missing omap usbhs tll platform_data\n");
		return  -ENODEV;
	}
	return pm_runtime_get_sync(&tll_pdev->dev);
}
EXPORT_SYMBOL_GPL(omap_tll_enable);

int omap_tll_disable(void)
{
	if (!tll_pdev) {
		pr_err("missing omap usbhs tll platform_data\n");
		return  -ENODEV;
	}
	return pm_runtime_put_sync(&tll_pdev->dev);
}
EXPORT_SYMBOL_GPL(omap_tll_disable);

MODULE_AUTHOR("Keshava Munegowda <keshava_mgowda@ti.com>");
MODULE_ALIAS("platform:" USBHS_DRIVER_NAME);
MODULE_LICENSE("GPL v2");
MODULE_DESCRIPTION("usb tll driver for TI OMAP EHCI and OHCI controllers");

static int __init omap_usbtll_drvinit(void)
{
	return platform_driver_register(&usbtll_omap_driver);
}

/*
 * init before usbhs core driver;
 * The usbtll driver should be initialized before
 * the usbhs core driver probe function is called.
 */
fs_initcall(omap_usbtll_drvinit);

static void __exit omap_usbtll_drvexit(void)
{
	platform_driver_unregister(&usbtll_omap_driver);
}
module_exit(omap_usbtll_drvexit);
Commit	Line	Data
16fa3dc7 KM	1	/**
	2	* omap-usb-tll.c - The USB TLL driver for OMAP EHCI & OHCI
	3	*
	4	* Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com
	5	* Author: Keshava Munegowda <keshava_mgowda@ti.com>
	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 of
	9	* the License as published by the Free Software Foundation.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19	#include <linux/kernel.h>
	20	#include <linux/module.h>
	21	#include <linux/types.h>
	22	#include <linux/slab.h>
	23	#include <linux/spinlock.h>
	24	#include <linux/platform_device.h>
	25	#include <linux/clk.h>
	26	#include <linux/io.h>
	27	#include <linux/err.h>
16fa3dc7	28	#include <linux/pm_runtime.h>
e8c4a7ac	29	#include <linux/platform_data/usb-omap.h>
16fa3dc7 KM	30
	31	#define USBTLL_DRIVER_NAME "usbhs_tll"
	32
	33	/* TLL Register Set */
	34	#define OMAP_USBTLL_REVISION (0x00)
	35	#define OMAP_USBTLL_SYSCONFIG (0x10)
	36	#define OMAP_USBTLL_SYSCONFIG_CACTIVITY (1 << 8)
	37	#define OMAP_USBTLL_SYSCONFIG_SIDLEMODE (1 << 3)
	38	#define OMAP_USBTLL_SYSCONFIG_ENAWAKEUP (1 << 2)
	39	#define OMAP_USBTLL_SYSCONFIG_SOFTRESET (1 << 1)
	40	#define OMAP_USBTLL_SYSCONFIG_AUTOIDLE (1 << 0)
	41
	42	#define OMAP_USBTLL_SYSSTATUS (0x14)
	43	#define OMAP_USBTLL_SYSSTATUS_RESETDONE (1 << 0)
	44
	45	#define OMAP_USBTLL_IRQSTATUS (0x18)
	46	#define OMAP_USBTLL_IRQENABLE (0x1C)
	47
	48	#define OMAP_TLL_SHARED_CONF (0x30)
	49	#define OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN (1 << 6)
	50	#define OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN (1 << 5)
	51	#define OMAP_TLL_SHARED_CONF_USB_DIVRATION (1 << 2)
	52	#define OMAP_TLL_SHARED_CONF_FCLK_REQ (1 << 1)
	53	#define OMAP_TLL_SHARED_CONF_FCLK_IS_ON (1 << 0)
	54
	55	#define OMAP_TLL_CHANNEL_CONF(num) (0x040 + 0x004 * num)
	56	#define OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT 24
	57	#define OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF (1 << 11)
	58	#define OMAP_TLL_CHANNEL_CONF_ULPI_ULPIAUTOIDLE (1 << 10)
	59	#define OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE (1 << 9)
	60	#define OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE (1 << 8)
	61	#define OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS (1 << 1)
	62	#define OMAP_TLL_CHANNEL_CONF_CHANEN (1 << 0)
	63
	64	#define OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0 0x0
	65	#define OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM 0x1
	66	#define OMAP_TLL_FSLSMODE_3PIN_PHY 0x2
	67	#define OMAP_TLL_FSLSMODE_4PIN_PHY 0x3
	68	#define OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0 0x4
	69	#define OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM 0x5
	70	#define OMAP_TLL_FSLSMODE_3PIN_TLL 0x6
	71	#define OMAP_TLL_FSLSMODE_4PIN_TLL 0x7
	72	#define OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0 0xA
	73	#define OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM 0xB
	74
	75	#define OMAP_TLL_ULPI_FUNCTION_CTRL(num) (0x804 + 0x100 * num)
	76	#define OMAP_TLL_ULPI_INTERFACE_CTRL(num) (0x807 + 0x100 * num)
	77	#define OMAP_TLL_ULPI_OTG_CTRL(num) (0x80A + 0x100 * num)
	78	#define OMAP_TLL_ULPI_INT_EN_RISE(num) (0x80D + 0x100 * num)
	79	#define OMAP_TLL_ULPI_INT_EN_FALL(num) (0x810 + 0x100 * num)
	80	#define OMAP_TLL_ULPI_INT_STATUS(num) (0x813 + 0x100 * num)
	81	#define OMAP_TLL_ULPI_INT_LATCH(num) (0x814 + 0x100 * num)
	82	#define OMAP_TLL_ULPI_DEBUG(num) (0x815 + 0x100 * num)
	83	#define OMAP_TLL_ULPI_SCRATCH_REGISTER(num) (0x816 + 0x100 * num)
	84
	85	#define OMAP_REV2_TLL_CHANNEL_COUNT 2
	86	#define OMAP_TLL_CHANNEL_COUNT 3
	87	#define OMAP_TLL_CHANNEL_1_EN_MASK (1 << 0)
	88	#define OMAP_TLL_CHANNEL_2_EN_MASK (1 << 1)
	89	#define OMAP_TLL_CHANNEL_3_EN_MASK (1 << 2)
	90
	91	/* Values of USBTLL_REVISION - Note: these are not given in the TRM */
	92	#define OMAP_USBTLL_REV1 0x00000015 /* OMAP3 */
	93	#define OMAP_USBTLL_REV2 0x00000018 /* OMAP 3630 */
94	#define OMAP_USBTLL_REV3 0x00000004 /* OMAP4 */
95
96	#define is_ehci_tll_mode(x) (x == OMAP_EHCI_PORT_MODE_TLL)
97
32a51f2a RQ	98	/* only PHY and UNUSED modes don't need TLL */
	99	#define omap_usb_mode_needs_tll(x) ((x) != OMAP_USBHS_PORT_MODE_UNUSED &&\
	100	(x) != OMAP_EHCI_PORT_MODE_PHY)
	101
16fa3dc7	102	struct usbtll_omap {
7e0ff103	103	int nch; /* num. of channels */
9d9c6ae7	104	struct usbhs_omap_platform_data *pdata;
0bde3e9f	105	struct clk **ch_clk;
16fa3dc7 KM	106	/* secure the register updates */
	107	spinlock_t lock;
	108	};
	109
	110	/-------------------------------------------------------------------------/
	111
	112	const char usbtll_driver_name[] = USBTLL_DRIVER_NAME;
	113	struct platform_device *tll_pdev;
	114
	115	/-------------------------------------------------------------------------/
	116
	117	static inline void usbtll_write(void __iomem *base, u32 reg, u32 val)
	118	{
	119	__raw_writel(val, base + reg);
	120	}
	121
	122	static inline u32 usbtll_read(void __iomem *base, u32 reg)
	123	{
	124	return __raw_readl(base + reg);
	125	}
	126
	127	static inline void usbtll_writeb(void __iomem *base, u8 reg, u8 val)
	128	{
	129	__raw_writeb(val, base + reg);
	130	}
	131
	132	static inline u8 usbtll_readb(void __iomem *base, u8 reg)
	133	{
	134	return __raw_readb(base + reg);
	135	}
	136
	137	/-------------------------------------------------------------------------/
	138
	139	static bool is_ohci_port(enum usbhs_omap_port_mode pmode)
	140	{
	141	switch (pmode) {
	142	case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
	143	case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
	144	case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
	145	case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
	146	case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
	147	case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
	148	case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
	149	case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
	150	case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
	151	case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
	152	return true;
	153
	154	default:
	155	return false;
	156	}
	157	}
	158
	159	/*
	160	* convert the port-mode enum to a value we can use in the FSLSMODE
	161	* field of USBTLL_CHANNEL_CONF
	162	*/
	163	static unsigned ohci_omap3_fslsmode(enum usbhs_omap_port_mode mode)
	164	{
	165	switch (mode) {
	166	case OMAP_USBHS_PORT_MODE_UNUSED:
	167	case OMAP_OHCI_PORT_MODE_PHY_6PIN_DATSE0:
	168	return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
	169
170	case OMAP_OHCI_PORT_MODE_PHY_6PIN_DPDM:
171	return OMAP_TLL_FSLSMODE_6PIN_PHY_DP_DM;
172
173	case OMAP_OHCI_PORT_MODE_PHY_3PIN_DATSE0:
174	return OMAP_TLL_FSLSMODE_3PIN_PHY;
175
176	case OMAP_OHCI_PORT_MODE_PHY_4PIN_DPDM:
177	return OMAP_TLL_FSLSMODE_4PIN_PHY;
178
179	case OMAP_OHCI_PORT_MODE_TLL_6PIN_DATSE0:
180	return OMAP_TLL_FSLSMODE_6PIN_TLL_DAT_SE0;
181
182	case OMAP_OHCI_PORT_MODE_TLL_6PIN_DPDM:
183	return OMAP_TLL_FSLSMODE_6PIN_TLL_DP_DM;
184
185	case OMAP_OHCI_PORT_MODE_TLL_3PIN_DATSE0:
186	return OMAP_TLL_FSLSMODE_3PIN_TLL;
187
188	case OMAP_OHCI_PORT_MODE_TLL_4PIN_DPDM:
189	return OMAP_TLL_FSLSMODE_4PIN_TLL;
190
191	case OMAP_OHCI_PORT_MODE_TLL_2PIN_DATSE0:
192	return OMAP_TLL_FSLSMODE_2PIN_TLL_DAT_SE0;
193
194	case OMAP_OHCI_PORT_MODE_TLL_2PIN_DPDM:
195	return OMAP_TLL_FSLSMODE_2PIN_DAT_DP_DM;
196	default:
197	pr_warn("Invalid port mode, using default\n");
198	return OMAP_TLL_FSLSMODE_6PIN_PHY_DAT_SE0;
199	}
200	}
201
202	/**
203	* usbtll_omap_probe - initialize TI-based HCDs
204	*
205	* Allocates basic resources for this USB host controller.
206	*/
f791be49	207	static int usbtll_omap_probe(struct platform_device *pdev)
16fa3dc7 KM	208	{
16fa3dc7 KM	209	struct device *dev = &pdev->dev;
9d9c6ae7	210	struct usbhs_omap_platform_data *pdata = dev->platform_data;
16fa3dc7 KM	211	void __iomem *base;
	212	struct resource *res;
	213	struct usbtll_omap *tll;
	214	unsigned reg;
	215	unsigned long flags;
	216	int ret = 0;
7e0ff103	217	int i, ver;
32a51f2a	218	bool needs_tll;
16fa3dc7 KM	219
	220	dev_dbg(dev, "starting TI HSUSB TLL Controller\n");
	221
1a7a8d70	222	tll = devm_kzalloc(dev, sizeof(struct usbtll_omap), GFP_KERNEL);
16fa3dc7 KM	223	if (!tll) {
16fa3dc7 KM	224	dev_err(dev, "Memory allocation failed\n");
1a7a8d70	225	return -ENOMEM;
16fa3dc7 KM	226	}
16fa3dc7 KM	227
8bdbd154 RQ	228	if (!pdata) {
	229	dev_err(dev, "Platform data missing\n");
	230	return -ENODEV;
	231	}
	232
16fa3dc7 KM	233	spin_lock_init(&tll->lock);
16fa3dc7 KM	234
9d9c6ae7	235	tll->pdata = pdata;
16fa3dc7	236
16fa3dc7	237	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1a7a8d70	238	base = devm_request_and_ioremap(dev, res);
16fa3dc7	239	if (!base) {
1a7a8d70 RQ	240	ret = -EADDRNOTAVAIL;
1a7a8d70 RQ	241	dev_err(dev, "Resource request/ioremap failed:%d\n", ret);
0bde3e9f	242	return ret;
16fa3dc7 KM	243	}
	244
	245	platform_set_drvdata(pdev, tll);
	246	pm_runtime_enable(dev);
	247	pm_runtime_get_sync(dev);
	248
	249	spin_lock_irqsave(&tll->lock, flags);
	250
	251	ver = usbtll_read(base, OMAP_USBTLL_REVISION);
	252	switch (ver) {
	253	case OMAP_USBTLL_REV1:
7e0ff103	254	tll->nch = OMAP_TLL_CHANNEL_COUNT;
16fa3dc7	255	break;
7e0ff103	256	case OMAP_USBTLL_REV2:
16fa3dc7	257	case OMAP_USBTLL_REV3:
7e0ff103	258	tll->nch = OMAP_REV2_TLL_CHANNEL_COUNT;
16fa3dc7 KM	259	break;
16fa3dc7 KM	260	default:
7e0ff103 RQ	261	tll->nch = OMAP_TLL_CHANNEL_COUNT;
	262	dev_dbg(dev,
	263	"USB TLL Rev : 0x%x not recognized, assuming %d channels\n",
	264	ver, tll->nch);
	265	break;
16fa3dc7 KM	266	}
16fa3dc7 KM	267
0bde3e9f RQ	268	spin_unlock_irqrestore(&tll->lock, flags);
	269
	270	tll->ch_clk = devm_kzalloc(dev, sizeof(struct clk * [tll->nch]),
	271	GFP_KERNEL);
	272	if (!tll->ch_clk) {
	273	ret = -ENOMEM;
	274	dev_err(dev, "Couldn't allocate memory for channel clocks\n");
	275	goto err_clk_alloc;
	276	}
	277
	278	for (i = 0; i < tll->nch; i++) {
	279	char clkname[] = "usb_tll_hs_usb_chx_clk";
	280
	281	snprintf(clkname, sizeof(clkname),
	282	"usb_tll_hs_usb_ch%d_clk", i);
	283	tll->ch_clk[i] = clk_get(dev, clkname);
	284
	285	if (IS_ERR(tll->ch_clk[i]))
	286	dev_dbg(dev, "can't get clock : %s\n", clkname);
	287	}
	288
	289	spin_lock_irqsave(&tll->lock, flags);
	290
32a51f2a RQ	291	needs_tll = false;
	292	for (i = 0; i < tll->nch; i++)
	293	needs_tll \|= omap_usb_mode_needs_tll(pdata->port_mode[i]);
	294
	295	if (needs_tll) {
16fa3dc7 KM	296
	297	/* Program Common TLL register */
	298	reg = usbtll_read(base, OMAP_TLL_SHARED_CONF);
	299	reg \|= (OMAP_TLL_SHARED_CONF_FCLK_IS_ON
	300	\| OMAP_TLL_SHARED_CONF_USB_DIVRATION);
	301	reg &= ~OMAP_TLL_SHARED_CONF_USB_90D_DDR_EN;
	302	reg &= ~OMAP_TLL_SHARED_CONF_USB_180D_SDR_EN;
	303
	304	usbtll_write(base, OMAP_TLL_SHARED_CONF, reg);
	305
	306	/* Enable channels now */
7e0ff103	307	for (i = 0; i < tll->nch; i++) {
16fa3dc7 KM	308	reg = usbtll_read(base, OMAP_TLL_CHANNEL_CONF(i));
	309
	310	if (is_ohci_port(pdata->port_mode[i])) {
	311	reg \|= ohci_omap3_fslsmode(pdata->port_mode[i])
	312	<< OMAP_TLL_CHANNEL_CONF_FSLSMODE_SHIFT;
	313	reg \|= OMAP_TLL_CHANNEL_CONF_CHANMODE_FSLS;
	314	} else if (pdata->port_mode[i] ==
	315	OMAP_EHCI_PORT_MODE_TLL) {
	316	/*
	317	* Disable AutoIdle, BitStuffing
	318	* and use SDR Mode
	319	*/
	320	reg &= ~(OMAP_TLL_CHANNEL_CONF_UTMIAUTOIDLE
	321	\| OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF
	322	\| OMAP_TLL_CHANNEL_CONF_ULPIDDRMODE);
	323	} else {
	324	continue;
	325	}
	326	reg \|= OMAP_TLL_CHANNEL_CONF_CHANEN;
	327	usbtll_write(base, OMAP_TLL_CHANNEL_CONF(i), reg);
	328
	329	usbtll_writeb(base,
	330	OMAP_TLL_ULPI_SCRATCH_REGISTER(i),
	331	0xbe);
	332	}
	333	}
	334
16fa3dc7	335	spin_unlock_irqrestore(&tll->lock, flags);
16fa3dc7 KM	336	pm_runtime_put_sync(dev);
16fa3dc7 KM	337	tll_pdev = pdev;
16fa3dc7	338
1a7a8d70 RQ	339	return 0;
1a7a8d70 RQ	340
0bde3e9f RQ	341	err_clk_alloc:
	342	pm_runtime_put_sync(dev);
	343	pm_runtime_disable(dev);
16fa3dc7	344
16fa3dc7 KM	345	return ret;
	346	}
	347
	348	/**
	349	* usbtll_omap_remove - shutdown processing for UHH & TLL HCDs
	350	* @pdev: USB Host Controller being removed
	351	*
	352	* Reverses the effect of usbtll_omap_probe().
	353	*/
4740f73f	354	static int usbtll_omap_remove(struct platform_device *pdev)
16fa3dc7 KM	355	{
16fa3dc7 KM	356	struct usbtll_omap *tll = platform_get_drvdata(pdev);
0bde3e9f RQ	357	int i;
	358
	359	for (i = 0; i < tll->nch; i++)
	360	if (!IS_ERR(tll->ch_clk[i]))
	361	clk_put(tll->ch_clk[i]);
16fa3dc7	362
16fa3dc7	363	pm_runtime_disable(&pdev->dev);
16fa3dc7 KM	364	return 0;
	365	}
	366
	367	static int usbtll_runtime_resume(struct device *dev)
	368	{
	369	struct usbtll_omap *tll = dev_get_drvdata(dev);
9d9c6ae7	370	struct usbhs_omap_platform_data *pdata = tll->pdata;
16fa3dc7	371	unsigned long flags;
0bde3e9f	372	int i;
16fa3dc7 KM	373
	374	dev_dbg(dev, "usbtll_runtime_resume\n");
	375
16fa3dc7 KM	376	spin_lock_irqsave(&tll->lock, flags);
16fa3dc7 KM	377
0bde3e9f	378	for (i = 0; i < tll->nch; i++) {
32a51f2a	379	if (omap_usb_mode_needs_tll(pdata->port_mode[i])) {
0bde3e9f	380	int r;
16fa3dc7	381
0bde3e9f RQ	382	if (IS_ERR(tll->ch_clk[i]))
	383	continue;
	384
	385	r = clk_enable(tll->ch_clk[i]);
	386	if (r) {
	387	dev_err(dev,
	388	"Error enabling ch %d clock: %d\n", i, r);
	389	}
	390	}
	391	}
16fa3dc7 KM	392
	393	spin_unlock_irqrestore(&tll->lock, flags);
	394
	395	return 0;
	396	}
	397
	398	static int usbtll_runtime_suspend(struct device *dev)
	399	{
	400	struct usbtll_omap *tll = dev_get_drvdata(dev);
9d9c6ae7	401	struct usbhs_omap_platform_data *pdata = tll->pdata;
16fa3dc7	402	unsigned long flags;
0bde3e9f	403	int i;
16fa3dc7 KM	404
	405	dev_dbg(dev, "usbtll_runtime_suspend\n");
	406
16fa3dc7 KM	407	spin_lock_irqsave(&tll->lock, flags);
16fa3dc7 KM	408
0bde3e9f	409	for (i = 0; i < tll->nch; i++) {
32a51f2a	410	if (omap_usb_mode_needs_tll(pdata->port_mode[i])) {
0bde3e9f RQ	411	if (!IS_ERR(tll->ch_clk[i]))
	412	clk_disable(tll->ch_clk[i]);
	413	}
	414	}
16fa3dc7 KM	415
	416	spin_unlock_irqrestore(&tll->lock, flags);
	417
	418	return 0;
	419	}
	420
	421	static const struct dev_pm_ops usbtllomap_dev_pm_ops = {
	422	SET_RUNTIME_PM_OPS(usbtll_runtime_suspend,
	423	usbtll_runtime_resume,
	424	NULL)
	425	};
	426
	427	static struct platform_driver usbtll_omap_driver = {
	428	.driver = {
	429	.name = (char *)usbtll_driver_name,
	430	.owner = THIS_MODULE,
	431	.pm = &usbtllomap_dev_pm_ops,
	432	},
	433	.probe = usbtll_omap_probe,
84449216	434	.remove = usbtll_omap_remove,
16fa3dc7 KM	435	};
	436
	437	int omap_tll_enable(void)
	438	{
	439	if (!tll_pdev) {
	440	pr_err("missing omap usbhs tll platform_data\n");
	441	return -ENODEV;
	442	}
	443	return pm_runtime_get_sync(&tll_pdev->dev);
	444	}
	445	EXPORT_SYMBOL_GPL(omap_tll_enable);
	446
	447	int omap_tll_disable(void)
	448	{
	449	if (!tll_pdev) {
	450	pr_err("missing omap usbhs tll platform_data\n");
	451	return -ENODEV;
	452	}
	453	return pm_runtime_put_sync(&tll_pdev->dev);
	454	}
	455	EXPORT_SYMBOL_GPL(omap_tll_disable);
	456
	457	MODULE_AUTHOR("Keshava Munegowda <keshava_mgowda@ti.com>");
	458	MODULE_ALIAS("platform:" USBHS_DRIVER_NAME);
	459	MODULE_LICENSE("GPL v2");
	460	MODULE_DESCRIPTION("usb tll driver for TI OMAP EHCI and OHCI controllers");
	461
	462	static int __init omap_usbtll_drvinit(void)
	463	{
	464	return platform_driver_register(&usbtll_omap_driver);
	465	}
	466
	467	/*
	468	* init before usbhs core driver;
	469	* The usbtll driver should be initialized before
	470	* the usbhs core driver probe function is called.
	471	*/
	472	fs_initcall(omap_usbtll_drvinit);
	473
	474	static void __exit omap_usbtll_drvexit(void)
	475	{
	476	platform_driver_unregister(&usbtll_omap_driver);
	477	}
	478	module_exit(omap_usbtll_drvexit);