[deliverable/linux.git] / drivers / mfd / omap-usb-tll.c

/**
 * omap-usb-tll.c - The USB TLL driver for OMAP EHCI & OHCI
 *
 * Copyright (C) 2012-2013 Texas Instruments Incorporated - http://www.ti.com
 * Author: Keshava Munegowda <keshava_mgowda@ti.com>
 * Author: Roger Quadros <rogerq@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>
#include <linux/of.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_DRVVBUS			(1 << 16)
#define OMAP_TLL_CHANNEL_CONF_CHRGVBUS			(1 << 15)
#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_MODE_TRANSPARENT_UTMI	(2 << 1)
#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 OMAP_USBTLL_REV4		0x00000006	/* OMAP5 */

#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 clk				**ch_clk;
	void __iomem				*base;
};

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

static const char usbtll_driver_name[] = USBTLL_DRIVER_NAME;
static struct device	*tll_dev;
static DEFINE_SPINLOCK(tll_lock);	/* serialize access to tll_dev */

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

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

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

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

static inline u8 usbtll_readb(void __iomem *base, u8 reg)
{
	return readb_relaxed(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 resource				*res;
	struct usbtll_omap			*tll;
	int					ret = 0;
	int					i, ver;

	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;
	}

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	tll->base = devm_ioremap_resource(dev, res);
	if (IS_ERR(tll->base))
		return PTR_ERR(tll->base);

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

	ver =  usbtll_read(tll->base, OMAP_USBTLL_REVISION);
	switch (ver) {
	case OMAP_USBTLL_REV1:
	case OMAP_USBTLL_REV4:
		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;
	}

	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);
		else
			clk_prepare(tll->ch_clk[i]);
	}

	pm_runtime_put_sync(dev);
	/* only after this can omap_tll_enable/disable work */
	spin_lock(&tll_lock);
	tll_dev = dev;
	spin_unlock(&tll_lock);

	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;

	spin_lock(&tll_lock);
	tll_dev = NULL;
	spin_unlock(&tll_lock);

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

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

static const struct of_device_id usbtll_omap_dt_ids[] = {
	{ .compatible = "ti,usbhs-tll" },
	{ }
};

MODULE_DEVICE_TABLE(of, usbtll_omap_dt_ids);

static struct platform_driver usbtll_omap_driver = {
	.driver = {
		.name		= (char *)usbtll_driver_name,
		.of_match_table = usbtll_omap_dt_ids,
	},
	.probe		= usbtll_omap_probe,
	.remove		= usbtll_omap_remove,
};

int omap_tll_init(struct usbhs_omap_platform_data *pdata)
{
	int i;
	bool needs_tll;
	unsigned reg;
	struct usbtll_omap *tll;

	if (!tll_dev)
		return -ENODEV;

	pm_runtime_get_sync(tll_dev);

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

	if (needs_tll) {
		void __iomem *base = tll->base;

		/* 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 if (pdata->port_mode[i] ==
					OMAP_EHCI_PORT_MODE_HSIC) {
				/*
				 * HSIC Mode requires UTMI port configurations
				 */
				reg |= OMAP_TLL_CHANNEL_CONF_DRVVBUS
				 | OMAP_TLL_CHANNEL_CONF_CHRGVBUS
				 | OMAP_TLL_CHANNEL_CONF_MODE_TRANSPARENT_UTMI
				 | OMAP_TLL_CHANNEL_CONF_ULPINOBITSTUFF;
			} 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(&tll_lock);
	pm_runtime_put_sync(tll_dev);

	return 0;
}
EXPORT_SYMBOL_GPL(omap_tll_init);

int omap_tll_enable(struct usbhs_omap_platform_data *pdata)
{
	int i;
	struct usbtll_omap *tll;

	if (!tll_dev)
		return -ENODEV;

	pm_runtime_get_sync(tll_dev);

	spin_lock(&tll_lock);
	tll = dev_get_drvdata(tll_dev);

	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(tll_dev,
				 "Error enabling ch %d clock: %d\n", i, r);
			}
		}
	}

	spin_unlock(&tll_lock);

	return 0;
}
EXPORT_SYMBOL_GPL(omap_tll_enable);

int omap_tll_disable(struct usbhs_omap_platform_data *pdata)
{
	int i;
	struct usbtll_omap *tll;

	if (!tll_dev)
		return -ENODEV;

	spin_lock(&tll_lock);
	tll = dev_get_drvdata(tll_dev);

	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(&tll_lock);
	pm_runtime_put_sync(tll_dev);

	return 0;
}
EXPORT_SYMBOL_GPL(omap_tll_disable);

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