[deliverable/linux.git] / drivers / usb / host / ohci-sa1111.c

/*
 * OHCI HCD (Host Controller Driver) for USB.
 *
 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
 * (C) Copyright 2002 Hewlett-Packard Company
 *
 * SA1111 Bus Glue
 *
 * Written by Christopher Hoover <ch@hpl.hp.com>
 * Based on fragments of previous driver by Russell King et al.
 *
 * This file is licenced under the GPL.
 */

#include <mach/hardware.h>
#include <asm/mach-types.h>
#include <mach/assabet.h>
#include <asm/hardware/sa1111.h>

#ifndef CONFIG_SA1111
#error "This file is SA-1111 bus glue.  CONFIG_SA1111 must be defined."
#endif

#define USB_STATUS	0x0118
#define USB_RESET	0x011c
#define USB_IRQTEST	0x0120

#define USB_RESET_FORCEIFRESET	(1 << 0)
#define USB_RESET_FORCEHCRESET	(1 << 1)
#define USB_RESET_CLKGENRESET	(1 << 2)
#define USB_RESET_SIMSCALEDOWN	(1 << 3)
#define USB_RESET_USBINTTEST	(1 << 4)
#define USB_RESET_SLEEPSTBYEN	(1 << 5)
#define USB_RESET_PWRSENSELOW	(1 << 6)
#define USB_RESET_PWRCTRLLOW	(1 << 7)

#define USB_STATUS_IRQHCIRMTWKUP  (1 <<  7)
#define USB_STATUS_IRQHCIBUFFACC  (1 <<  8)
#define USB_STATUS_NIRQHCIM       (1 <<  9)
#define USB_STATUS_NHCIMFCLR      (1 << 10)
#define USB_STATUS_USBPWRSENSE    (1 << 11)

#if 0
static void dump_hci_status(struct usb_hcd *hcd, const char *label)
{
	unsigned long status = sa1111_readl(hcd->regs + USB_STATUS);

	printk(KERN_DEBUG "%s USB_STATUS = { %s%s%s%s%s}\n", label,
	     ((status & USB_STATUS_IRQHCIRMTWKUP) ? "IRQHCIRMTWKUP " : ""),
	     ((status & USB_STATUS_IRQHCIBUFFACC) ? "IRQHCIBUFFACC " : ""),
	     ((status & USB_STATUS_NIRQHCIM) ? "" : "IRQHCIM "),
	     ((status & USB_STATUS_NHCIMFCLR) ? "" : "HCIMFCLR "),
	     ((status & USB_STATUS_USBPWRSENSE) ? "USBPWRSENSE " : ""));
}
#endif

static int ohci_sa1111_reset(struct usb_hcd *hcd)
{
	struct ohci_hcd *ohci = hcd_to_ohci(hcd);

	ohci_hcd_init(ohci);
	return ohci_init(ohci);
}

static int ohci_sa1111_start(struct usb_hcd *hcd)
{
	struct ohci_hcd	*ohci = hcd_to_ohci(hcd);
	int ret;

	ret = ohci_run(ohci);
	if (ret < 0) {
		ohci_err(ohci, "can't start\n");
		ohci_stop(hcd);
	}
	return ret;
}

static const struct hc_driver ohci_sa1111_hc_driver = {
	.description =		hcd_name,
	.product_desc =		"SA-1111 OHCI",
	.hcd_priv_size =	sizeof(struct ohci_hcd),

	/*
	 * generic hardware linkage
	 */
	.irq =			ohci_irq,
	.flags =		HCD_USB11 | HCD_MEMORY,

	/*
	 * basic lifecycle operations
	 */
	.reset =		ohci_sa1111_reset,
	.start =		ohci_sa1111_start,
	.stop =			ohci_stop,
	.shutdown =		ohci_shutdown,

	/*
	 * managing i/o requests and associated device resources
	 */
	.urb_enqueue =		ohci_urb_enqueue,
	.urb_dequeue =		ohci_urb_dequeue,
	.endpoint_disable =	ohci_endpoint_disable,

	/*
	 * scheduling support
	 */
	.get_frame_number =	ohci_get_frame,

	/*
	 * root hub support
	 */
	.hub_status_data =	ohci_hub_status_data,
	.hub_control =		ohci_hub_control,
#ifdef	CONFIG_PM
	.bus_suspend =		ohci_bus_suspend,
	.bus_resume =		ohci_bus_resume,
#endif
	.start_port_reset =	ohci_start_port_reset,
};

static int sa1111_start_hc(struct sa1111_dev *dev)
{
	unsigned int usb_rst = 0;
	int ret;

	dev_dbg(&dev->dev, "starting SA-1111 OHCI USB Controller\n");

	if (machine_is_xp860() ||
	    machine_has_neponset() ||
	    machine_is_pfs168() ||
	    machine_is_badge4())
		usb_rst = USB_RESET_PWRSENSELOW | USB_RESET_PWRCTRLLOW;

	/*
	 * Configure the power sense and control lines.  Place the USB
	 * host controller in reset.
	 */
	sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
		      dev->mapbase + USB_RESET);

	/*
	 * Now, carefully enable the USB clock, and take
	 * the USB host controller out of reset.
	 */
	ret = sa1111_enable_device(dev);
	if (ret == 0) {
		udelay(11);
		sa1111_writel(usb_rst, dev->mapbase + USB_RESET);
	}

	return ret;
}

static void sa1111_stop_hc(struct sa1111_dev *dev)
{
	unsigned int usb_rst;

	dev_dbg(&dev->dev, "stopping SA-1111 OHCI USB Controller\n");

	/*
	 * Put the USB host controller into reset.
	 */
	usb_rst = sa1111_readl(dev->mapbase + USB_RESET);
	sa1111_writel(usb_rst | USB_RESET_FORCEIFRESET | USB_RESET_FORCEHCRESET,
		      dev->mapbase + USB_RESET);

	/*
	 * Stop the USB clock.
	 */
	sa1111_disable_device(dev);
}

/**
 * ohci_hcd_sa1111_probe - initialize SA-1111-based HCDs
 *
 * Allocates basic resources for this USB host controller, and
 * then invokes the start() method for the HCD associated with it.
 */
static int ohci_hcd_sa1111_probe(struct sa1111_dev *dev)
{
	struct usb_hcd *hcd;
	int ret;

	if (usb_disabled())
		return -ENODEV;

	/*
	 * We don't call dma_set_mask_and_coherent() here because the
	 * DMA mask has already been appropraitely setup by the core
	 * SA-1111 bus code (which includes bug workarounds.)
	 */

	hcd = usb_create_hcd(&ohci_sa1111_hc_driver, &dev->dev, "sa1111");
	if (!hcd)
		return -ENOMEM;

	hcd->rsrc_start = dev->res.start;
	hcd->rsrc_len = resource_size(&dev->res);

	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
		dev_dbg(&dev->dev, "request_mem_region failed\n");
		ret = -EBUSY;
		goto err1;
	}

	hcd->regs = dev->mapbase;

	ret = sa1111_start_hc(dev);
	if (ret)
		goto err2;

	ret = usb_add_hcd(hcd, dev->irq[1], 0);
	if (ret == 0) {
		device_wakeup_enable(hcd->self.controller);
		return ret;
	}

	sa1111_stop_hc(dev);
 err2:
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
 err1:
	usb_put_hcd(hcd);
	return ret;
}

/**
 * ohci_hcd_sa1111_remove - shutdown processing for SA-1111-based HCDs
 * @dev: USB Host Controller being removed
 *
 * Reverses the effect of ohci_hcd_sa1111_probe(), first invoking
 * the HCD's stop() method.
 */
static int ohci_hcd_sa1111_remove(struct sa1111_dev *dev)
{
	struct usb_hcd *hcd = sa1111_get_drvdata(dev);

	usb_remove_hcd(hcd);
	sa1111_stop_hc(dev);
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	usb_put_hcd(hcd);

	return 0;
}

static void ohci_hcd_sa1111_shutdown(struct sa1111_dev *dev)
{
	struct usb_hcd *hcd = sa1111_get_drvdata(dev);

	if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
		hcd->driver->shutdown(hcd);
		sa1111_stop_hc(dev);
	}
}

static struct sa1111_driver ohci_hcd_sa1111_driver = {
	.drv = {
		.name	= "sa1111-ohci",
		.owner	= THIS_MODULE,
	},
	.devid		= SA1111_DEVID_USB,
	.probe		= ohci_hcd_sa1111_probe,
	.remove		= ohci_hcd_sa1111_remove,
	.shutdown	= ohci_hcd_sa1111_shutdown,
};
Commit	Line	Data
1da177e4 LT	1	/*
	2	* OHCI HCD (Host Controller Driver) for USB.
	3	*
	4	* (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
	5	* (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
	6	* (C) Copyright 2002 Hewlett-Packard Company
dd9048af	7	*
1da177e4 LT	8	* SA1111 Bus Glue
	9	*
	10	* Written by Christopher Hoover <ch@hpl.hp.com>
ac310bb5	11	* Based on fragments of previous driver by Russell King et al.
1da177e4 LT	12	*
	13	* This file is licenced under the GPL.
	14	*/
dd9048af	15
a09e64fb	16	#include <mach/hardware.h>
1da177e4	17	#include <asm/mach-types.h>
a09e64fb	18	#include <mach/assabet.h>
1da177e4 LT	19	#include <asm/hardware/sa1111.h>
	20
	21	#ifndef CONFIG_SA1111
	22	#error "This file is SA-1111 bus glue. CONFIG_SA1111 must be defined."
	23	#endif
	24
2213536d RK	25	#define USB_STATUS 0x0118
	26	#define USB_RESET 0x011c
	27	#define USB_IRQTEST 0x0120
	28
	29	#define USB_RESET_FORCEIFRESET (1 << 0)
	30	#define USB_RESET_FORCEHCRESET (1 << 1)
	31	#define USB_RESET_CLKGENRESET (1 << 2)
	32	#define USB_RESET_SIMSCALEDOWN (1 << 3)
	33	#define USB_RESET_USBINTTEST (1 << 4)
	34	#define USB_RESET_SLEEPSTBYEN (1 << 5)
	35	#define USB_RESET_PWRSENSELOW (1 << 6)
	36	#define USB_RESET_PWRCTRLLOW (1 << 7)
	37
	38	#define USB_STATUS_IRQHCIRMTWKUP (1 << 7)
	39	#define USB_STATUS_IRQHCIBUFFACC (1 << 8)
	40	#define USB_STATUS_NIRQHCIM (1 << 9)
	41	#define USB_STATUS_NHCIMFCLR (1 << 10)
	42	#define USB_STATUS_USBPWRSENSE (1 << 11)
	43
132db99a RK	44	#if 0
	45	static void dump_hci_status(struct usb_hcd hcd, const char label)
	46	{
	47	unsigned long status = sa1111_readl(hcd->regs + USB_STATUS);
	48
3879e304	49	printk(KERN_DEBUG "%s USB_STATUS = { %s%s%s%s%s}\n", label,
132db99a RK	50	((status & USB_STATUS_IRQHCIRMTWKUP) ? "IRQHCIRMTWKUP " : ""),
	51	((status & USB_STATUS_IRQHCIBUFFACC) ? "IRQHCIBUFFACC " : ""),
	52	((status & USB_STATUS_NIRQHCIM) ? "" : "IRQHCIM "),
	53	((status & USB_STATUS_NHCIMFCLR) ? "" : "HCIMFCLR "),
	54	((status & USB_STATUS_USBPWRSENSE) ? "USBPWRSENSE " : ""));
	55	}
	56	#endif
	57
81e6ca3e RK	58	static int ohci_sa1111_reset(struct usb_hcd *hcd)
	59	{
	60	struct ohci_hcd *ohci = hcd_to_ohci(hcd);
	61
	62	ohci_hcd_init(ohci);
	63	return ohci_init(ohci);
	64	}
	65
41ac7b3a	66	static int ohci_sa1111_start(struct usb_hcd *hcd)
132db99a RK	67	{
	68	struct ohci_hcd *ohci = hcd_to_ohci(hcd);
	69	int ret;
	70
132db99a RK	71	ret = ohci_run(ohci);
132db99a RK	72	if (ret < 0) {
81e6ca3e	73	ohci_err(ohci, "can't start\n");
132db99a	74	ohci_stop(hcd);
132db99a	75	}
81e6ca3e	76	return ret;
132db99a RK	77	}
	78
	79	static const struct hc_driver ohci_sa1111_hc_driver = {
	80	.description = hcd_name,
	81	.product_desc = "SA-1111 OHCI",
	82	.hcd_priv_size = sizeof(struct ohci_hcd),
	83
	84	/*
	85	* generic hardware linkage
	86	*/
	87	.irq = ohci_irq,
	88	.flags = HCD_USB11 \| HCD_MEMORY,
	89
	90	/*
	91	* basic lifecycle operations
	92	*/
81e6ca3e	93	.reset = ohci_sa1111_reset,
132db99a RK	94	.start = ohci_sa1111_start,
132db99a RK	95	.stop = ohci_stop,
846a7048	96	.shutdown = ohci_shutdown,
132db99a RK	97
	98	/*
	99	* managing i/o requests and associated device resources
	100	*/
	101	.urb_enqueue = ohci_urb_enqueue,
	102	.urb_dequeue = ohci_urb_dequeue,
	103	.endpoint_disable = ohci_endpoint_disable,
	104
	105	/*
	106	* scheduling support
	107	*/
	108	.get_frame_number = ohci_get_frame,
	109
	110	/*
	111	* root hub support
	112	*/
	113	.hub_status_data = ohci_hub_status_data,
	114	.hub_control = ohci_hub_control,
	115	#ifdef CONFIG_PM
	116	.bus_suspend = ohci_bus_suspend,
	117	.bus_resume = ohci_bus_resume,
	118	#endif
	119	.start_port_reset = ohci_start_port_reset,
	120	};
1da177e4	121
ae99ddbc	122	static int sa1111_start_hc(struct sa1111_dev *dev)
1da177e4 LT	123	{
1da177e4 LT	124	unsigned int usb_rst = 0;
ae99ddbc	125	int ret;
1da177e4	126
3f878dbc	127	dev_dbg(&dev->dev, "starting SA-1111 OHCI USB Controller\n");
1da177e4	128
1da177e4 LT	129	if (machine_is_xp860() \|\|
	130	machine_has_neponset() \|\|
	131	machine_is_pfs168() \|\|
	132	machine_is_badge4())
	133	usb_rst = USB_RESET_PWRSENSELOW \| USB_RESET_PWRCTRLLOW;
	134
	135	/*
	136	* Configure the power sense and control lines. Place the USB
	137	* host controller in reset.
	138	*/
	139	sa1111_writel(usb_rst \| USB_RESET_FORCEIFRESET \| USB_RESET_FORCEHCRESET,
2213536d	140	dev->mapbase + USB_RESET);
1da177e4 LT	141
	142	/*
	143	* Now, carefully enable the USB clock, and take
	144	* the USB host controller out of reset.
	145	*/
ae99ddbc RK	146	ret = sa1111_enable_device(dev);
	147	if (ret == 0) {
	148	udelay(11);
2213536d	149	sa1111_writel(usb_rst, dev->mapbase + USB_RESET);
ae99ddbc RK	150	}
	151
	152	return ret;
1da177e4 LT	153	}
	154
	155	static void sa1111_stop_hc(struct sa1111_dev *dev)
	156	{
	157	unsigned int usb_rst;
9cb0f819	158
3f878dbc	159	dev_dbg(&dev->dev, "stopping SA-1111 OHCI USB Controller\n");
1da177e4 LT	160
	161	/*
	162	* Put the USB host controller into reset.
	163	*/
2213536d	164	usb_rst = sa1111_readl(dev->mapbase + USB_RESET);
1da177e4	165	sa1111_writel(usb_rst \| USB_RESET_FORCEIFRESET \| USB_RESET_FORCEHCRESET,
2213536d	166	dev->mapbase + USB_RESET);
1da177e4 LT	167
	168	/*
	169	* Stop the USB clock.
	170	*/
	171	sa1111_disable_device(dev);
1da177e4 LT	172	}
1da177e4 LT	173
1da177e4	174	/**
132db99a	175	* ohci_hcd_sa1111_probe - initialize SA-1111-based HCDs
1da177e4 LT	176	*
1da177e4 LT	177	* Allocates basic resources for this USB host controller, and
132db99a	178	* then invokes the start() method for the HCD associated with it.
1da177e4	179	*/
132db99a	180	static int ohci_hcd_sa1111_probe(struct sa1111_dev *dev)
1da177e4 LT	181	{
1da177e4 LT	182	struct usb_hcd *hcd;
132db99a RK	183	int ret;
	184
	185	if (usb_disabled())
	186	return -ENODEV;
1da177e4	187
4ffb4318 RK	188	/*
	189	* We don't call dma_set_mask_and_coherent() here because the
	190	* DMA mask has already been appropraitely setup by the core
	191	* SA-1111 bus code (which includes bug workarounds.)
	192	*/
	193
132db99a	194	hcd = usb_create_hcd(&ohci_sa1111_hc_driver, &dev->dev, "sa1111");
1da177e4 LT	195	if (!hcd)
1da177e4 LT	196	return -ENOMEM;
9cb0f819	197
1da177e4	198	hcd->rsrc_start = dev->res.start;
28f65c11	199	hcd->rsrc_len = resource_size(&dev->res);
1da177e4 LT	200
1da177e4 LT	201	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name)) {
3879e304	202	dev_dbg(&dev->dev, "request_mem_region failed\n");
132db99a	203	ret = -EBUSY;
1da177e4 LT	204	goto err1;
1da177e4 LT	205	}
9cb0f819	206
1da177e4 LT	207	hcd->regs = dev->mapbase;
1da177e4 LT	208
ae99ddbc RK	209	ret = sa1111_start_hc(dev);
	210	if (ret)
	211	goto err2;
	212
132db99a	213	ret = usb_add_hcd(hcd, dev->irq[1], 0);
3c9740a1 PC	214	if (ret == 0) {
3c9740a1 PC	215	device_wakeup_enable(hcd->self.controller);
132db99a	216	return ret;
3c9740a1	217	}
1da177e4 LT	218
1da177e4 LT	219	sa1111_stop_hc(dev);
ae99ddbc	220	err2:
1da177e4 LT	221	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	222	err1:
	223	usb_put_hcd(hcd);
132db99a	224	return ret;
1da177e4 LT	225	}
1da177e4 LT	226
1da177e4	227	/**
132db99a	228	* ohci_hcd_sa1111_remove - shutdown processing for SA-1111-based HCDs
1da177e4	229	* @dev: USB Host Controller being removed
1da177e4	230	*
132db99a RK	231	* Reverses the effect of ohci_hcd_sa1111_probe(), first invoking
132db99a RK	232	* the HCD's stop() method.
1da177e4	233	*/
132db99a	234	static int ohci_hcd_sa1111_remove(struct sa1111_dev *dev)
1da177e4	235	{
132db99a RK	236	struct usb_hcd *hcd = sa1111_get_drvdata(dev);
132db99a RK	237
1da177e4 LT	238	usb_remove_hcd(hcd);
	239	sa1111_stop_hc(dev);
	240	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	241	usb_put_hcd(hcd);
1da177e4	242
1da177e4 LT	243	return 0;
	244	}
	245
846a7048 RK	246	static void ohci_hcd_sa1111_shutdown(struct sa1111_dev *dev)
	247	{
	248	struct usb_hcd *hcd = sa1111_get_drvdata(dev);
	249
	250	if (test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
	251	hcd->driver->shutdown(hcd);
	252	sa1111_stop_hc(dev);
	253	}
	254	}
	255
1da177e4 LT	256	static struct sa1111_driver ohci_hcd_sa1111_driver = {
	257	.drv = {
	258	.name = "sa1111-ohci",
1ebcd765	259	.owner = THIS_MODULE,
1da177e4 LT	260	},
1da177e4 LT	261	.devid = SA1111_DEVID_USB,
132db99a RK	262	.probe = ohci_hcd_sa1111_probe,
132db99a RK	263	.remove = ohci_hcd_sa1111_remove,
846a7048	264	.shutdown = ohci_hcd_sa1111_shutdown,
1da177e4	265	};