[mirror_ubuntu-artful-kernel.git] / drivers / usb / renesas_usbhs / common.c

/*
 * Renesas USB driver
 *
 * Copyright (C) 2011 Renesas Solutions Corp.
 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
#include <linux/io.h>
#include <linux/module.h>
#include <linux/pm_runtime.h>
#include <linux/slab.h>
#include <linux/sysfs.h>
#include "./common.h"

/*
 *		image of renesas_usbhs
 *
 * ex) gadget case

 * mod.c
 * mod_gadget.c
 * mod_host.c		pipe.c		fifo.c
 *
 *			+-------+	+-----------+
 *			| pipe0 |------>| fifo pio  |
 * +------------+	+-------+	+-----------+
 * | mod_gadget |=====> | pipe1 |--+
 * +------------+	+-------+  |	+-----------+
 *			| pipe2 |  |  +-| fifo dma0 |
 * +------------+	+-------+  |  |	+-----------+
 * | mod_host   |	| pipe3 |<-|--+
 * +------------+	+-------+  |	+-----------+
 *			| ....  |  +--->| fifo dma1 |
 *			| ....  |	+-----------+
 */


#define USBHSF_RUNTIME_PWCTRL	(1 << 0)

/* status */
#define usbhsc_flags_init(p)   do {(p)->flags = 0; } while (0)
#define usbhsc_flags_set(p, b) ((p)->flags |=  (b))
#define usbhsc_flags_clr(p, b) ((p)->flags &= ~(b))
#define usbhsc_flags_has(p, b) ((p)->flags &   (b))

/*
 * platform call back
 *
 * renesas usb support platform callback function.
 * Below macro call it.
 * if platform doesn't have callback, it return 0 (no error)
 */
#define usbhs_platform_call(priv, func, args...)\
	(!(priv) ? -ENODEV :			\
	 !((priv)->pfunc->func) ? 0 :		\
	 (priv)->pfunc->func(args))

/*
 *		common functions
 */
u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
{
	return ioread16(priv->base + reg);
}

void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
{
	iowrite16(data, priv->base + reg);
}

void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
{
	u16 val = usbhs_read(priv, reg);

	val &= ~mask;
	val |= data & mask;

	usbhs_write(priv, reg, val);
}

struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev)
{
	return dev_get_drvdata(&pdev->dev);
}

/*
 *		syscfg functions
 */
void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
{
	usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
}

void usbhs_sys_hispeed_ctrl(struct usbhs_priv *priv, int enable)
{
	usbhs_bset(priv, SYSCFG, HSE, enable ? HSE : 0);
}

void usbhs_sys_usb_ctrl(struct usbhs_priv *priv, int enable)
{
	usbhs_bset(priv, SYSCFG, USBE, enable ? USBE : 0);
}

void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
{
	u16 mask = DCFM | DRPD | DPRPU;
	u16 val  = DCFM | DRPD;
	int has_otg = usbhs_get_dparam(priv, has_otg);

	if (has_otg)
		usbhs_bset(priv, DVSTCTR, (EXTLP | PWEN), (EXTLP | PWEN));

	/*
	 * if enable
	 *
	 * - select Host mode
	 * - D+ Line/D- Line Pull-down
	 */
	usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
}

void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
{
	u16 mask = DCFM | DRPD | DPRPU;
	u16 val  = DPRPU;

	/*
	 * if enable
	 *
	 * - select Function mode
	 * - D+ Line Pull-up
	 */
	usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
}

/*
 *		frame functions
 */
int usbhs_frame_get_num(struct usbhs_priv *priv)
{
	return usbhs_read(priv, FRMNUM) & FRNM_MASK;
}

/*
 *		usb request functions
 */
void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
{
	u16 val;

	val = usbhs_read(priv, USBREQ);
	req->bRequest		= (val >> 8) & 0xFF;
	req->bRequestType	= (val >> 0) & 0xFF;

	req->wValue	= usbhs_read(priv, USBVAL);
	req->wIndex	= usbhs_read(priv, USBINDX);
	req->wLength	= usbhs_read(priv, USBLENG);
}

void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req)
{
	usbhs_write(priv, USBREQ,  (req->bRequest << 8) | req->bRequestType);
	usbhs_write(priv, USBVAL,  req->wValue);
	usbhs_write(priv, USBINDX, req->wIndex);
	usbhs_write(priv, USBLENG, req->wLength);

	usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
}

/*
 *		bus/vbus functions
 */
void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
{
	u16 status = usbhs_read(priv, DVSTCTR) & (USBRST | UACT);

	if (status != USBRST) {
		struct device *dev = usbhs_priv_to_dev(priv);
		dev_err(dev, "usbhs should be reset\n");
	}

	usbhs_bset(priv, DVSTCTR, (USBRST | UACT), UACT);
}

void usbhs_bus_send_reset(struct usbhs_priv *priv)
{
	usbhs_bset(priv, DVSTCTR, (USBRST | UACT), USBRST);
}

int usbhs_bus_get_speed(struct usbhs_priv *priv)
{
	u16 dvstctr = usbhs_read(priv, DVSTCTR);

	switch (RHST & dvstctr) {
	case RHST_LOW_SPEED:
		return USB_SPEED_LOW;
	case RHST_FULL_SPEED:
		return USB_SPEED_FULL;
	case RHST_HIGH_SPEED:
		return USB_SPEED_HIGH;
	}

	return USB_SPEED_UNKNOWN;
}

int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
{
	struct platform_device *pdev = usbhs_priv_to_pdev(priv);

	return usbhs_platform_call(priv, set_vbus, pdev, enable);
}

static void usbhsc_bus_init(struct usbhs_priv *priv)
{
	usbhs_write(priv, DVSTCTR, 0);

	usbhs_vbus_ctrl(priv, 0);
}

/*
 *		device configuration
 */
int usbhs_set_device_speed(struct usbhs_priv *priv, int devnum,
			   u16 upphub, u16 hubport, u16 speed)
{
	struct device *dev = usbhs_priv_to_dev(priv);
	u16 usbspd = 0;
	u32 reg = DEVADD0 + (2 * devnum);

	if (devnum > 10) {
		dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
		return -EIO;
	}

	if (upphub > 0xA) {
		dev_err(dev, "unsupported hub number %d\n", upphub);
		return -EIO;
	}

	switch (speed) {
	case USB_SPEED_LOW:
		usbspd = USBSPD_SPEED_LOW;
		break;
	case USB_SPEED_FULL:
		usbspd = USBSPD_SPEED_FULL;
		break;
	case USB_SPEED_HIGH:
		usbspd = USBSPD_SPEED_HIGH;
		break;
	default:
		dev_err(dev, "unsupported speed %d\n", speed);
		return -EIO;
	}

	usbhs_write(priv, reg,	UPPHUB(upphub)	|
				HUBPORT(hubport)|
				USBSPD(usbspd));

	return 0;
}

/*
 *		local functions
 */
static void usbhsc_set_buswait(struct usbhs_priv *priv)
{
	int wait = usbhs_get_dparam(priv, buswait_bwait);

	/* set bus wait if platform have */
	if (wait)
		usbhs_bset(priv, BUSWAIT, 0x000F, wait);
}

/*
 *		platform default param
 */
static u32 usbhsc_default_pipe_type[] = {
		USB_ENDPOINT_XFER_CONTROL,
		USB_ENDPOINT_XFER_ISOC,
		USB_ENDPOINT_XFER_ISOC,
		USB_ENDPOINT_XFER_BULK,
		USB_ENDPOINT_XFER_BULK,
		USB_ENDPOINT_XFER_BULK,
		USB_ENDPOINT_XFER_INT,
		USB_ENDPOINT_XFER_INT,
		USB_ENDPOINT_XFER_INT,
		USB_ENDPOINT_XFER_INT,
};

/*
 *		power control
 */
static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
{
	struct device *dev = usbhs_priv_to_dev(priv);

	if (enable) {
		/* enable PM */
		pm_runtime_get_sync(dev);

		/* USB on */
		usbhs_sys_clock_ctrl(priv, enable);
	} else {
		/* USB off */
		usbhs_sys_clock_ctrl(priv, enable);

		/* disable PM */
		pm_runtime_put_sync(dev);
	}
}

/*
 *		hotplug
 */
static void usbhsc_hotplug(struct usbhs_priv *priv)
{
	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
	struct usbhs_mod *mod = usbhs_mod_get_current(priv);
	int id;
	int enable;
	int ret;

	/*
	 * get vbus status from platform
	 */
	enable = usbhs_platform_call(priv, get_vbus, pdev);

	/*
	 * get id from platform
	 */
	id = usbhs_platform_call(priv, get_id, pdev);

	if (enable && !mod) {
		ret = usbhs_mod_change(priv, id);
		if (ret < 0)
			return;

		dev_dbg(&pdev->dev, "%s enable\n", __func__);

		/* power on */
		if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
			usbhsc_power_ctrl(priv, enable);

		/* bus init */
		usbhsc_set_buswait(priv);
		usbhsc_bus_init(priv);

		/* module start */
		usbhs_mod_call(priv, start, priv);

	} else if (!enable && mod) {
		dev_dbg(&pdev->dev, "%s disable\n", __func__);

		/* module stop */
		usbhs_mod_call(priv, stop, priv);

		/* bus init */
		usbhsc_bus_init(priv);

		/* power off */
		if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
			usbhsc_power_ctrl(priv, enable);

		usbhs_mod_change(priv, -1);

		/* reset phy for next connection */
		usbhs_platform_call(priv, phy_reset, pdev);
	}
}

/*
 *		notify hotplug
 */
static void usbhsc_notify_hotplug(struct work_struct *work)
{
	struct usbhs_priv *priv = container_of(work,
					       struct usbhs_priv,
					       notify_hotplug_work.work);
	usbhsc_hotplug(priv);
}

int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
{
	struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
	int delay = usbhs_get_dparam(priv, detection_delay);

	/*
	 * This functions will be called in interrupt.
	 * To make sure safety context,
	 * use workqueue for usbhs_notify_hotplug
	 */
	schedule_delayed_work(&priv->notify_hotplug_work, delay);
	return 0;
}

/*
 *		platform functions
 */
static int __devinit usbhs_probe(struct platform_device *pdev)
{
	struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
	struct renesas_usbhs_driver_callback *dfunc;
	struct usbhs_priv *priv;
	struct resource *res;
	unsigned int irq;
	int ret;

	/* check platform information */
	if (!info ||
	    !info->platform_callback.get_id) {
		dev_err(&pdev->dev, "no platform information\n");
		return -EINVAL;
	}

	/* platform data */
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	irq = platform_get_irq(pdev, 0);
	if (!res || (int)irq <= 0) {
		dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
		return -ENODEV;
	}

	/* usb private data */
	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
	if (!priv) {
		dev_err(&pdev->dev, "Could not allocate priv\n");
		return -ENOMEM;
	}

	priv->base = ioremap_nocache(res->start, resource_size(res));
	if (!priv->base) {
		dev_err(&pdev->dev, "ioremap error.\n");
		ret = -ENOMEM;
		goto probe_end_kfree;
	}

	/*
	 * care platform info
	 */
	priv->pfunc	= &info->platform_callback;
	priv->dparam	= &info->driver_param;

	/* set driver callback functions for platform */
	dfunc			= &info->driver_callback;
	dfunc->notify_hotplug	= usbhsc_drvcllbck_notify_hotplug;

	/* set default param if platform doesn't have */
	if (!priv->dparam->pipe_type) {
		priv->dparam->pipe_type = usbhsc_default_pipe_type;
		priv->dparam->pipe_size = ARRAY_SIZE(usbhsc_default_pipe_type);
	}
	if (!priv->dparam->pio_dma_border)
		priv->dparam->pio_dma_border = 64; /* 64byte */

	/* FIXME */
	/* runtime power control ? */
	if (priv->pfunc->get_vbus)
		usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);

	/*
	 * priv settings
	 */
	priv->irq	= irq;
	priv->pdev	= pdev;
	INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
	spin_lock_init(usbhs_priv_to_lock(priv));

	/* call pipe and module init */
	ret = usbhs_pipe_probe(priv);
	if (ret < 0)
		goto probe_end_iounmap;

	ret = usbhs_fifo_probe(priv);
	if (ret < 0)
		goto probe_end_pipe_exit;

	ret = usbhs_mod_probe(priv);
	if (ret < 0)
		goto probe_end_fifo_exit;

	/* dev_set_drvdata should be called after usbhs_mod_init */
	dev_set_drvdata(&pdev->dev, priv);

	/*
	 * deviece reset here because
	 * USB device might be used in boot loader.
	 */
	usbhs_sys_clock_ctrl(priv, 0);

	/*
	 * platform call
	 *
	 * USB phy setup might depend on CPU/Board.
	 * If platform has its callback functions,
	 * call it here.
	 */
	ret = usbhs_platform_call(priv, hardware_init, pdev);
	if (ret < 0) {
		dev_err(&pdev->dev, "platform prove failed.\n");
		goto probe_end_mod_exit;
	}

	/* reset phy for connection */
	usbhs_platform_call(priv, phy_reset, pdev);

	/* power control */
	pm_runtime_enable(&pdev->dev);
	if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
		usbhsc_power_ctrl(priv, 1);
		usbhs_mod_autonomy_mode(priv);
	}

	/*
	 * manual call notify_hotplug for cold plug
	 */
	ret = usbhsc_drvcllbck_notify_hotplug(pdev);
	if (ret < 0)
		goto probe_end_call_remove;

	dev_info(&pdev->dev, "probed\n");

	return ret;

probe_end_call_remove:
	usbhs_platform_call(priv, hardware_exit, pdev);
probe_end_mod_exit:
	usbhs_mod_remove(priv);
probe_end_fifo_exit:
	usbhs_fifo_remove(priv);
probe_end_pipe_exit:
	usbhs_pipe_remove(priv);
probe_end_iounmap:
	iounmap(priv->base);
probe_end_kfree:
	kfree(priv);

	dev_info(&pdev->dev, "probe failed\n");

	return ret;
}

static int __devexit usbhs_remove(struct platform_device *pdev)
{
	struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
	struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
	struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;

	dev_dbg(&pdev->dev, "usb remove\n");

	dfunc->notify_hotplug = NULL;

	/* power off */
	if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
		usbhsc_power_ctrl(priv, 0);

	pm_runtime_disable(&pdev->dev);

	usbhs_platform_call(priv, hardware_exit, pdev);
	usbhs_mod_remove(priv);
	usbhs_fifo_remove(priv);
	usbhs_pipe_remove(priv);
	iounmap(priv->base);
	kfree(priv);

	return 0;
}

static int usbhsc_suspend(struct device *dev)
{
	struct usbhs_priv *priv = dev_get_drvdata(dev);
	struct usbhs_mod *mod = usbhs_mod_get_current(priv);

	if (mod) {
		usbhs_mod_call(priv, stop, priv);
		usbhs_mod_change(priv, -1);
	}

	if (mod || !usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
		usbhsc_power_ctrl(priv, 0);

	return 0;
}

static int usbhsc_resume(struct device *dev)
{
	struct usbhs_priv *priv = dev_get_drvdata(dev);
	struct platform_device *pdev = usbhs_priv_to_pdev(priv);

	usbhs_platform_call(priv, phy_reset, pdev);

	if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
		usbhsc_power_ctrl(priv, 1);

	usbhsc_hotplug(priv);

	return 0;
}

static int usbhsc_runtime_nop(struct device *dev)
{
	/* Runtime PM callback shared between ->runtime_suspend()
	 * and ->runtime_resume(). Simply returns success.
	 *
	 * This driver re-initializes all registers after
	 * pm_runtime_get_sync() anyway so there is no need
	 * to save and restore registers here.
	 */
	return 0;
}

static const struct dev_pm_ops usbhsc_pm_ops = {
	.suspend		= usbhsc_suspend,
	.resume			= usbhsc_resume,
	.runtime_suspend	= usbhsc_runtime_nop,
	.runtime_resume		= usbhsc_runtime_nop,
};

static struct platform_driver renesas_usbhs_driver = {
	.driver		= {
		.name	= "renesas_usbhs",
		.pm	= &usbhsc_pm_ops,
	},
	.probe		= usbhs_probe,
	.remove		= __devexit_p(usbhs_remove),
};

static int __init usbhs_init(void)
{
	return platform_driver_register(&renesas_usbhs_driver);
}

static void __exit usbhs_exit(void)
{
	platform_driver_unregister(&renesas_usbhs_driver);
}

module_init(usbhs_init);
module_exit(usbhs_exit);

MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("Renesas USB driver");
MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
Commit	Line	Data
f1407d5c KM	1	/*
	2	* Renesas USB driver
	3	*
	4	* Copyright (C) 2011 Renesas Solutions Corp.
	5	* Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
	6	*
	7	* This program is distributed in the hope that it will be useful,
	8	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	9	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	10	* GNU General Public License for more details.
	11	*
	12	* You should have received a copy of the GNU General Public License
	13	* along with this program; if not, write to the Free Software
	14	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	15	*
	16	*/
	17	#include <linux/io.h>
	18	#include <linux/module.h>
	19	#include <linux/pm_runtime.h>
	20	#include <linux/slab.h>
	21	#include <linux/sysfs.h>
	22	#include "./common.h"
	23
233f519d KM	24	/*
	25	* image of renesas_usbhs
	26	*
	27	* ex) gadget case
	28
	29	* mod.c
	30	* mod_gadget.c
	31	* mod_host.c pipe.c fifo.c
	32	*
	33	* +-------+ +-----------+
	34	* \| pipe0 \|------>\| fifo pio \|
	35	* +------------+ +-------+ +-----------+
	36	* \| mod_gadget \|=====> \| pipe1 \|--+
	37	* +------------+ +-------+ \| +-----------+
	38	* \| pipe2 \| \| +-\| fifo dma0 \|
	39	* +------------+ +-------+ \| \| +-----------+
	40	* \| mod_host \| \| pipe3 \|<-\|--+
	41	* +------------+ +-------+ \| +-----------+
	42	* \| .... \| +--->\| fifo dma1 \|
	43	* \| .... \| +-----------+
	44	*/
	45
	46
b002ff6e KM	47	#define USBHSF_RUNTIME_PWCTRL (1 << 0)
	48
	49	/* status */
	50	#define usbhsc_flags_init(p) do {(p)->flags = 0; } while (0)
	51	#define usbhsc_flags_set(p, b) ((p)->flags \|= (b))
	52	#define usbhsc_flags_clr(p, b) ((p)->flags &= ~(b))
	53	#define usbhsc_flags_has(p, b) ((p)->flags & (b))
	54
f1407d5c KM	55	/*
	56	* platform call back
	57	*
	58	* renesas usb support platform callback function.
	59	* Below macro call it.
	60	* if platform doesn't have callback, it return 0 (no error)
	61	*/
	62	#define usbhs_platform_call(priv, func, args...)\
	63	(!(priv) ? -ENODEV : \
	64	!((priv)->pfunc->func) ? 0 : \
	65	(priv)->pfunc->func(args))
	66
	67	/*
	68	* common functions
	69	*/
	70	u16 usbhs_read(struct usbhs_priv *priv, u32 reg)
	71	{
	72	return ioread16(priv->base + reg);
	73	}
	74
	75	void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data)
	76	{
	77	iowrite16(data, priv->base + reg);
	78	}
	79
	80	void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data)
	81	{
	82	u16 val = usbhs_read(priv, reg);
	83
	84	val &= ~mask;
	85	val \|= data & mask;
	86
	87	usbhs_write(priv, reg, val);
	88	}
	89
206dcc2c KM	90	struct usbhs_priv usbhs_pdev_to_priv(struct platform_device pdev)
	91	{
	92	return dev_get_drvdata(&pdev->dev);
	93	}
	94
f1407d5c KM	95	/*
	96	* syscfg functions
	97	*/
	98	void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
	99	{
	100	usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
	101	}
	102
	103	void usbhs_sys_hispeed_ctrl(struct usbhs_priv *priv, int enable)
	104	{
	105	usbhs_bset(priv, SYSCFG, HSE, enable ? HSE : 0);
	106	}
	107
	108	void usbhs_sys_usb_ctrl(struct usbhs_priv *priv, int enable)
	109	{
	110	usbhs_bset(priv, SYSCFG, USBE, enable ? USBE : 0);
	111	}
	112
	113	void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
	114	{
	115	u16 mask = DCFM \| DRPD \| DPRPU;
	116	u16 val = DCFM \| DRPD;
f427eb64 KM	117	int has_otg = usbhs_get_dparam(priv, has_otg);
	118
	119	if (has_otg)
	120	usbhs_bset(priv, DVSTCTR, (EXTLP \| PWEN), (EXTLP \| PWEN));
f1407d5c KM	121
	122	/*
	123	* if enable
	124	*
	125	* - select Host mode
	126	* - D+ Line/D- Line Pull-down
	127	*/
	128	usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
	129	}
	130
	131	void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable)
	132	{
	133	u16 mask = DCFM \| DRPD \| DPRPU;
	134	u16 val = DPRPU;
	135
	136	/*
	137	* if enable
	138	*
	139	* - select Function mode
	140	* - D+ Line Pull-up
	141	*/
	142	usbhs_bset(priv, SYSCFG, mask, enable ? val : 0);
	143	}
	144
	145	/*
	146	* frame functions
	147	*/
	148	int usbhs_frame_get_num(struct usbhs_priv *priv)
	149	{
	150	return usbhs_read(priv, FRMNUM) & FRNM_MASK;
	151	}
	152
ef8bedb9 KM	153	/*
	154	* usb request functions
	155	*/
	156	void usbhs_usbreq_get_val(struct usbhs_priv priv, struct usb_ctrlrequest req)
	157	{
	158	u16 val;
	159
	160	val = usbhs_read(priv, USBREQ);
	161	req->bRequest = (val >> 8) & 0xFF;
	162	req->bRequestType = (val >> 0) & 0xFF;
	163
	164	req->wValue = usbhs_read(priv, USBVAL);
	165	req->wIndex = usbhs_read(priv, USBINDX);
	166	req->wLength = usbhs_read(priv, USBLENG);
	167	}
	168
	169	void usbhs_usbreq_set_val(struct usbhs_priv priv, struct usb_ctrlrequest req)
	170	{
	171	usbhs_write(priv, USBREQ, (req->bRequest << 8) \| req->bRequestType);
	172	usbhs_write(priv, USBVAL, req->wValue);
	173	usbhs_write(priv, USBINDX, req->wIndex);
	174	usbhs_write(priv, USBLENG, req->wLength);
	175
	176	usbhs_bset(priv, DCPCTR, SUREQ, SUREQ);
	177	}
	178
258485d9 KM	179	/*
	180	* bus/vbus functions
	181	*/
	182	void usbhs_bus_send_sof_enable(struct usbhs_priv *priv)
	183	{
a9be4a45 KM	184	u16 status = usbhs_read(priv, DVSTCTR) & (USBRST \| UACT);
	185
	186	if (status != USBRST) {
	187	struct device *dev = usbhs_priv_to_dev(priv);
	188	dev_err(dev, "usbhs should be reset\n");
	189	}
	190
258485d9 KM	191	usbhs_bset(priv, DVSTCTR, (USBRST \| UACT), UACT);
	192	}
	193
	194	void usbhs_bus_send_reset(struct usbhs_priv *priv)
	195	{
	196	usbhs_bset(priv, DVSTCTR, (USBRST \| UACT), USBRST);
	197	}
	198
75587f52 KM	199	int usbhs_bus_get_speed(struct usbhs_priv *priv)
	200	{
	201	u16 dvstctr = usbhs_read(priv, DVSTCTR);
	202
	203	switch (RHST & dvstctr) {
	204	case RHST_LOW_SPEED:
	205	return USB_SPEED_LOW;
	206	case RHST_FULL_SPEED:
	207	return USB_SPEED_FULL;
	208	case RHST_HIGH_SPEED:
	209	return USB_SPEED_HIGH;
	210	}
	211
	212	return USB_SPEED_UNKNOWN;
	213	}
	214
258485d9 KM	215	int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable)
	216	{
	217	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
	218
	219	return usbhs_platform_call(priv, set_vbus, pdev, enable);
	220	}
	221
	222	static void usbhsc_bus_init(struct usbhs_priv *priv)
	223	{
	224	usbhs_write(priv, DVSTCTR, 0);
	225
	226	usbhs_vbus_ctrl(priv, 0);
	227	}
	228
eb05191f KM	229	/*
	230	* device configuration
	231	*/
	232	int usbhs_set_device_speed(struct usbhs_priv *priv, int devnum,
	233	u16 upphub, u16 hubport, u16 speed)
	234	{
	235	struct device *dev = usbhs_priv_to_dev(priv);
	236	u16 usbspd = 0;
	237	u32 reg = DEVADD0 + (2 * devnum);
	238
	239	if (devnum > 10) {
	240	dev_err(dev, "cannot set speed to unknown device %d\n", devnum);
	241	return -EIO;
	242	}
	243
	244	if (upphub > 0xA) {
	245	dev_err(dev, "unsupported hub number %d\n", upphub);
	246	return -EIO;
	247	}
	248
	249	switch (speed) {
	250	case USB_SPEED_LOW:
	251	usbspd = USBSPD_SPEED_LOW;
	252	break;
	253	case USB_SPEED_FULL:
	254	usbspd = USBSPD_SPEED_FULL;
	255	break;
	256	case USB_SPEED_HIGH:
	257	usbspd = USBSPD_SPEED_HIGH;
	258	break;
	259	default:
	260	dev_err(dev, "unsupported speed %d\n", speed);
	261	return -EIO;
	262	}
	263
	264	usbhs_write(priv, reg, UPPHUB(upphub) \|
	265	HUBPORT(hubport)\|
	266	USBSPD(usbspd));
	267
	268	return 0;
	269	}
	270
f1407d5c KM	271	/*
	272	* local functions
	273	*/
11935de5	274	static void usbhsc_set_buswait(struct usbhs_priv *priv)
f1407d5c KM	275	{
f1407d5c KM	276	int wait = usbhs_get_dparam(priv, buswait_bwait);
f1407d5c	277
11935de5 KM	278	/* set bus wait if platform have */
	279	if (wait)
	280	usbhs_bset(priv, BUSWAIT, 0x000F, wait);
f1407d5c KM	281	}
	282
	283	/*
	284	* platform default param
	285	*/
	286	static u32 usbhsc_default_pipe_type[] = {
	287	USB_ENDPOINT_XFER_CONTROL,
	288	USB_ENDPOINT_XFER_ISOC,
	289	USB_ENDPOINT_XFER_ISOC,
	290	USB_ENDPOINT_XFER_BULK,
	291	USB_ENDPOINT_XFER_BULK,
	292	USB_ENDPOINT_XFER_BULK,
	293	USB_ENDPOINT_XFER_INT,
	294	USB_ENDPOINT_XFER_INT,
	295	USB_ENDPOINT_XFER_INT,
	296	USB_ENDPOINT_XFER_INT,
	297	};
	298
	299	/*
6e267da8 KM	300	* power control
	301	*/
	302	static void usbhsc_power_ctrl(struct usbhs_priv *priv, int enable)
	303	{
	304	struct device *dev = usbhs_priv_to_dev(priv);
	305
	306	if (enable) {
	307	/* enable PM */
	308	pm_runtime_get_sync(dev);
	309
	310	/* USB on */
	311	usbhs_sys_clock_ctrl(priv, enable);
6e267da8 KM	312	} else {
6e267da8 KM	313	/* USB off */
6e267da8 KM	314	usbhs_sys_clock_ctrl(priv, enable);
	315
	316	/* disable PM */
	317	pm_runtime_put_sync(dev);
	318	}
	319	}
	320
	321	/*
ca8a282a	322	* hotplug
f1407d5c	323	*/
ca8a282a	324	static void usbhsc_hotplug(struct usbhs_priv *priv)
f1407d5c	325	{
f1407d5c KM	326	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
	327	struct usbhs_mod *mod = usbhs_mod_get_current(priv);
	328	int id;
	329	int enable;
	330	int ret;
	331
	332	/*
	333	* get vbus status from platform
	334	*/
	335	enable = usbhs_platform_call(priv, get_vbus, pdev);
	336
	337	/*
	338	* get id from platform
	339	*/
	340	id = usbhs_platform_call(priv, get_id, pdev);
	341
	342	if (enable && !mod) {
	343	ret = usbhs_mod_change(priv, id);
	344	if (ret < 0)
	345	return;
	346
	347	dev_dbg(&pdev->dev, "%s enable\n", __func__);
	348
6e267da8	349	/* power on */
b002ff6e KM	350	if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
b002ff6e KM	351	usbhsc_power_ctrl(priv, enable);
f1407d5c	352
258485d9 KM	353	/* bus init */
	354	usbhsc_set_buswait(priv);
	355	usbhsc_bus_init(priv);
	356
f1407d5c KM	357	/* module start */
	358	usbhs_mod_call(priv, start, priv);
	359
	360	} else if (!enable && mod) {
	361	dev_dbg(&pdev->dev, "%s disable\n", __func__);
	362
	363	/* module stop */
	364	usbhs_mod_call(priv, stop, priv);
	365
258485d9 KM	366	/* bus init */
	367	usbhsc_bus_init(priv);
	368
6e267da8	369	/* power off */
b002ff6e KM	370	if (usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
b002ff6e KM	371	usbhsc_power_ctrl(priv, enable);
f1407d5c KM	372
	373	usbhs_mod_change(priv, -1);
	374
	375	/* reset phy for next connection */
	376	usbhs_platform_call(priv, phy_reset, pdev);
	377	}
	378	}
	379
ca8a282a KM	380	/*
	381	* notify hotplug
	382	*/
	383	static void usbhsc_notify_hotplug(struct work_struct *work)
	384	{
	385	struct usbhs_priv *priv = container_of(work,
	386	struct usbhs_priv,
	387	notify_hotplug_work.work);
	388	usbhsc_hotplug(priv);
	389	}
	390
bc57381e	391	int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev)
f1407d5c	392	{
206dcc2c	393	struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
bc57381e	394	int delay = usbhs_get_dparam(priv, detection_delay);
f1407d5c KM	395
	396	/*
	397	* This functions will be called in interrupt.
	398	* To make sure safety context,
	399	* use workqueue for usbhs_notify_hotplug
	400	*/
bc57381e	401	schedule_delayed_work(&priv->notify_hotplug_work, delay);
f1407d5c KM	402	return 0;
	403	}
	404
	405	/*
	406	* platform functions
	407	*/
	408	static int __devinit usbhs_probe(struct platform_device *pdev)
	409	{
	410	struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
	411	struct renesas_usbhs_driver_callback *dfunc;
	412	struct usbhs_priv *priv;
	413	struct resource *res;
	414	unsigned int irq;
	415	int ret;
	416
	417	/* check platform information */
	418	if (!info \|\|
b002ff6e	419	!info->platform_callback.get_id) {
f1407d5c KM	420	dev_err(&pdev->dev, "no platform information\n");
	421	return -EINVAL;
	422	}
	423
	424	/* platform data */
	425	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	426	irq = platform_get_irq(pdev, 0);
	427	if (!res \|\| (int)irq <= 0) {
	428	dev_err(&pdev->dev, "Not enough Renesas USB platform resources.\n");
	429	return -ENODEV;
	430	}
	431
	432	/* usb private data */
	433	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
	434	if (!priv) {
	435	dev_err(&pdev->dev, "Could not allocate priv\n");
	436	return -ENOMEM;
	437	}
	438
	439	priv->base = ioremap_nocache(res->start, resource_size(res));
	440	if (!priv->base) {
	441	dev_err(&pdev->dev, "ioremap error.\n");
	442	ret = -ENOMEM;
	443	goto probe_end_kfree;
	444	}
	445
	446	/*
	447	* care platform info
	448	*/
	449	priv->pfunc = &info->platform_callback;
	450	priv->dparam = &info->driver_param;
	451
	452	/* set driver callback functions for platform */
	453	dfunc = &info->driver_callback;
	454	dfunc->notify_hotplug = usbhsc_drvcllbck_notify_hotplug;
	455
	456	/* set default param if platform doesn't have */
	457	if (!priv->dparam->pipe_type) {
	458	priv->dparam->pipe_type = usbhsc_default_pipe_type;
	459	priv->dparam->pipe_size = ARRAY_SIZE(usbhsc_default_pipe_type);
	460	}
e73a9891 KM	461	if (!priv->dparam->pio_dma_border)
e73a9891 KM	462	priv->dparam->pio_dma_border = 64; /* 64byte */
f1407d5c	463
b002ff6e KM	464	/* FIXME */
	465	/* runtime power control ? */
	466	if (priv->pfunc->get_vbus)
	467	usbhsc_flags_set(priv, USBHSF_RUNTIME_PWCTRL);
	468
f1407d5c KM	469	/*
	470	* priv settings
	471	*/
	472	priv->irq = irq;
	473	priv->pdev = pdev;
bc57381e	474	INIT_DELAYED_WORK(&priv->notify_hotplug_work, usbhsc_notify_hotplug);
f1407d5c KM	475	spin_lock_init(usbhs_priv_to_lock(priv));
	476
	477	/* call pipe and module init */
	478	ret = usbhs_pipe_probe(priv);
	479	if (ret < 0)
97f93227	480	goto probe_end_iounmap;
f1407d5c	481
d3af90a5	482	ret = usbhs_fifo_probe(priv);
f1407d5c	483	if (ret < 0)
97f93227	484	goto probe_end_pipe_exit;
f1407d5c	485
d3af90a5 KM	486	ret = usbhs_mod_probe(priv);
	487	if (ret < 0)
	488	goto probe_end_fifo_exit;
	489
f1407d5c KM	490	/* dev_set_drvdata should be called after usbhs_mod_init */
	491	dev_set_drvdata(&pdev->dev, priv);
	492
	493	/*
	494	* deviece reset here because
	495	* USB device might be used in boot loader.
	496	*/
	497	usbhs_sys_clock_ctrl(priv, 0);
	498
	499	/*
	500	* platform call
	501	*
	502	* USB phy setup might depend on CPU/Board.
	503	* If platform has its callback functions,
	504	* call it here.
	505	*/
	506	ret = usbhs_platform_call(priv, hardware_init, pdev);
	507	if (ret < 0) {
	508	dev_err(&pdev->dev, "platform prove failed.\n");
97f93227	509	goto probe_end_mod_exit;
f1407d5c KM	510	}
	511
	512	/* reset phy for connection */
	513	usbhs_platform_call(priv, phy_reset, pdev);
	514
b002ff6e KM	515	/* power control */
	516	pm_runtime_enable(&pdev->dev);
	517	if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL)) {
	518	usbhsc_power_ctrl(priv, 1);
	519	usbhs_mod_autonomy_mode(priv);
	520	}
	521
f1407d5c KM	522	/*
	523	* manual call notify_hotplug for cold plug
	524	*/
f1407d5c KM	525	ret = usbhsc_drvcllbck_notify_hotplug(pdev);
	526	if (ret < 0)
	527	goto probe_end_call_remove;
	528
	529	dev_info(&pdev->dev, "probed\n");
	530
	531	return ret;
	532
	533	probe_end_call_remove:
	534	usbhs_platform_call(priv, hardware_exit, pdev);
f1407d5c KM	535	probe_end_mod_exit:
f1407d5c KM	536	usbhs_mod_remove(priv);
d3af90a5 KM	537	probe_end_fifo_exit:
d3af90a5 KM	538	usbhs_fifo_remove(priv);
97f93227 KM	539	probe_end_pipe_exit:
97f93227 KM	540	usbhs_pipe_remove(priv);
f1407d5c KM	541	probe_end_iounmap:
	542	iounmap(priv->base);
	543	probe_end_kfree:
	544	kfree(priv);
	545
	546	dev_info(&pdev->dev, "probe failed\n");
	547
	548	return ret;
	549	}
	550
	551	static int __devexit usbhs_remove(struct platform_device *pdev)
	552	{
206dcc2c	553	struct usbhs_priv *priv = usbhs_pdev_to_priv(pdev);
af32fe51 KM	554	struct renesas_usbhs_platform_info *info = pdev->dev.platform_data;
af32fe51 KM	555	struct renesas_usbhs_driver_callback *dfunc = &info->driver_callback;
f1407d5c KM	556
	557	dev_dbg(&pdev->dev, "usb remove\n");
	558
af32fe51 KM	559	dfunc->notify_hotplug = NULL;
af32fe51 KM	560
b002ff6e KM	561	/* power off */
	562	if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
	563	usbhsc_power_ctrl(priv, 0);
f1407d5c	564
b002ff6e	565	pm_runtime_disable(&pdev->dev);
f1407d5c KM	566
f1407d5c KM	567	usbhs_platform_call(priv, hardware_exit, pdev);
f1407d5c	568	usbhs_mod_remove(priv);
d3af90a5	569	usbhs_fifo_remove(priv);
97f93227	570	usbhs_pipe_remove(priv);
f1407d5c KM	571	iounmap(priv->base);
	572	kfree(priv);
	573
	574	return 0;
	575	}
	576
ca8a282a KM	577	static int usbhsc_suspend(struct device *dev)
	578	{
	579	struct usbhs_priv *priv = dev_get_drvdata(dev);
	580	struct usbhs_mod *mod = usbhs_mod_get_current(priv);
	581
	582	if (mod) {
	583	usbhs_mod_call(priv, stop, priv);
	584	usbhs_mod_change(priv, -1);
	585	}
	586
	587	if (mod \|\| !usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
	588	usbhsc_power_ctrl(priv, 0);
	589
	590	return 0;
	591	}
	592
	593	static int usbhsc_resume(struct device *dev)
	594	{
	595	struct usbhs_priv *priv = dev_get_drvdata(dev);
	596	struct platform_device *pdev = usbhs_priv_to_pdev(priv);
	597
	598	usbhs_platform_call(priv, phy_reset, pdev);
	599
	600	if (!usbhsc_flags_has(priv, USBHSF_RUNTIME_PWCTRL))
	601	usbhsc_power_ctrl(priv, 1);
	602
	603	usbhsc_hotplug(priv);
	604
	605	return 0;
	606	}
	607
	608	static int usbhsc_runtime_nop(struct device *dev)
	609	{
	610	/* Runtime PM callback shared between ->runtime_suspend()
	611	* and ->runtime_resume(). Simply returns success.
	612	*
	613	* This driver re-initializes all registers after
	614	* pm_runtime_get_sync() anyway so there is no need
	615	* to save and restore registers here.
	616	*/
	617	return 0;
	618	}
	619
	620	static const struct dev_pm_ops usbhsc_pm_ops = {
	621	.suspend = usbhsc_suspend,
	622	.resume = usbhsc_resume,
	623	.runtime_suspend = usbhsc_runtime_nop,
	624	.runtime_resume = usbhsc_runtime_nop,
	625	};
	626
f1407d5c KM	627	static struct platform_driver renesas_usbhs_driver = {
	628	.driver = {
	629	.name = "renesas_usbhs",
ca8a282a	630	.pm = &usbhsc_pm_ops,
f1407d5c KM	631	},
	632	.probe = usbhs_probe,
	633	.remove = __devexit_p(usbhs_remove),
	634	};
	635
	636	static int __init usbhs_init(void)
	637	{
	638	return platform_driver_register(&renesas_usbhs_driver);
	639	}
	640
	641	static void __exit usbhs_exit(void)
	642	{
	643	platform_driver_unregister(&renesas_usbhs_driver);
	644	}
	645
	646	module_init(usbhs_init);
	647	module_exit(usbhs_exit);
	648
	649	MODULE_LICENSE("GPL");
	650	MODULE_DESCRIPTION("Renesas USB driver");
	651	MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");