[deliverable/linux.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
 */
static void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable)
{
	usbhs_bset(priv, SYSCFG, SCKE, enable ? SCKE : 0);
}

void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable)
{
	u16 mask = DCFM | DRPD | DPRPU | HSE | USBE;
	u16 val  = DCFM | DRPD | HSE | USBE;
	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 | HSE | USBE;
	u16 val  = DPRPU | HSE | USBE;

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

void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode)
{
	usbhs_write(priv, TESTMODE, mode);
}

/*
 *		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_config(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 platform_device *pdev = usbhs_priv_to_pdev(priv);
	struct device *dev = usbhs_priv_to_dev(priv);

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

		/* enable platform power */
		usbhs_platform_call(priv, power_ctrl, pdev, priv->base, enable);

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

		/* disable platform power */
		usbhs_platform_call(priv, power_ctrl, pdev, priv->base, 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);
}

static 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,
			      msecs_to_jiffies(delay));
	return 0;
}

/*
 *		platform functions
 */
static int 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
	 */
	memcpy(&priv->pfunc,
	       &info->platform_callback,
	       sizeof(struct renesas_usbhs_platform_callback));
	memcpy(&priv->dparam,
	       &info->driver_param,
	       sizeof(struct renesas_usbhs_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),
};

module_platform_driver(renesas_usbhs_driver);

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