[deliverable/linux.git] / drivers / usb / host / ehci-ps3.c

/*
 *  PS3 EHCI Host Controller driver
 *
 *  Copyright (C) 2006 Sony Computer Entertainment Inc.
 *  Copyright 2006 Sony Corp.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <asm/firmware.h>
#include <asm/ps3.h>

static void ps3_ehci_setup_insnreg(struct ehci_hcd *ehci)
{
	/* PS3 HC internal setup register offsets. */

	enum ps3_ehci_hc_insnreg {
		ps3_ehci_hc_insnreg01 = 0x084,
		ps3_ehci_hc_insnreg02 = 0x088,
		ps3_ehci_hc_insnreg03 = 0x08c,
	};

	/* PS3 EHCI HC errata fix 316 - The PS3 EHCI HC will reset its
	 * internal INSNREGXX setup regs back to the chip default values
	 * on Host Controller Reset (CMD_RESET) or Light Host Controller
	 * Reset (CMD_LRESET).  The work-around for this is for the HC
	 * driver to re-initialise these regs when ever the HC is reset.
	 */

	/* Set burst transfer counts to 256 out, 32 in. */

	writel_be(0x01000020, (void __iomem *)ehci->regs +
		ps3_ehci_hc_insnreg01);

	/* Enable burst transfer counts. */

	writel_be(0x00000001, (void __iomem *)ehci->regs +
		ps3_ehci_hc_insnreg03);
}

static int ps3_ehci_hc_reset(struct usb_hcd *hcd)
{
	int result;
	struct ehci_hcd *ehci = hcd_to_ehci(hcd);

	ehci->big_endian_mmio = 1;

	ehci->caps = hcd->regs;
	ehci->regs = hcd->regs + HC_LENGTH(ehci, ehci_readl(ehci,
		&ehci->caps->hc_capbase));

	dbg_hcs_params(ehci, "reset");
	dbg_hcc_params(ehci, "reset");

	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);

	result = ehci_halt(ehci);

	if (result)
		return result;

	result = ehci_init(hcd);

	if (result)
		return result;

	ehci_reset(ehci);

	ps3_ehci_setup_insnreg(ehci);

	return result;
}

static const struct hc_driver ps3_ehci_hc_driver = {
	.description		= hcd_name,
	.product_desc		= "PS3 EHCI Host Controller",
	.hcd_priv_size		= sizeof(struct ehci_hcd),
	.irq			= ehci_irq,
	.flags			= HCD_MEMORY | HCD_USB2,
	.reset			= ps3_ehci_hc_reset,
	.start			= ehci_run,
	.stop			= ehci_stop,
	.shutdown		= ehci_shutdown,
	.urb_enqueue		= ehci_urb_enqueue,
	.urb_dequeue		= ehci_urb_dequeue,
	.endpoint_disable	= ehci_endpoint_disable,
	.endpoint_reset		= ehci_endpoint_reset,
	.get_frame_number	= ehci_get_frame,
	.hub_status_data	= ehci_hub_status_data,
	.hub_control		= ehci_hub_control,
#if defined(CONFIG_PM)
	.bus_suspend		= ehci_bus_suspend,
	.bus_resume		= ehci_bus_resume,
#endif
	.relinquish_port	= ehci_relinquish_port,
	.port_handed_over	= ehci_port_handed_over,

	.clear_tt_buffer_complete	= ehci_clear_tt_buffer_complete,
};

static int __devinit ps3_ehci_probe(struct ps3_system_bus_device *dev)
{
	int result;
	struct usb_hcd *hcd;
	unsigned int virq;
	static u64 dummy_mask = DMA_BIT_MASK(32);

	if (usb_disabled()) {
		result = -ENODEV;
		goto fail_start;
	}

	result = ps3_open_hv_device(dev);

	if (result) {
		dev_dbg(&dev->core, "%s:%d: ps3_open_hv_device failed\n",
			__func__, __LINE__);
		goto fail_open;
	}

	result = ps3_dma_region_create(dev->d_region);

	if (result) {
		dev_dbg(&dev->core, "%s:%d: ps3_dma_region_create failed: "
			"(%d)\n", __func__, __LINE__, result);
		BUG_ON("check region type");
		goto fail_dma_region;
	}

	result = ps3_mmio_region_create(dev->m_region);

	if (result) {
		dev_dbg(&dev->core, "%s:%d: ps3_map_mmio_region failed\n",
			__func__, __LINE__);
		result = -EPERM;
		goto fail_mmio_region;
	}

	dev_dbg(&dev->core, "%s:%d: mmio mapped_addr %lxh\n", __func__,
		__LINE__, dev->m_region->lpar_addr);

	result = ps3_io_irq_setup(PS3_BINDING_CPU_ANY, dev->interrupt_id, &virq);

	if (result) {
		dev_dbg(&dev->core, "%s:%d: ps3_construct_io_irq(%d) failed.\n",
			__func__, __LINE__, virq);
		result = -EPERM;
		goto fail_irq;
	}

	dev->core.dma_mask = &dummy_mask; /* FIXME: for improper usb code */

	hcd = usb_create_hcd(&ps3_ehci_hc_driver, &dev->core, dev_name(&dev->core));

	if (!hcd) {
		dev_dbg(&dev->core, "%s:%d: usb_create_hcd failed\n", __func__,
			__LINE__);
		result = -ENOMEM;
		goto fail_create_hcd;
	}

	hcd->rsrc_start = dev->m_region->lpar_addr;
	hcd->rsrc_len = dev->m_region->len;

	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name))
		dev_dbg(&dev->core, "%s:%d: request_mem_region failed\n",
			__func__, __LINE__);

	hcd->regs = ioremap(dev->m_region->lpar_addr, dev->m_region->len);

	if (!hcd->regs) {
		dev_dbg(&dev->core, "%s:%d: ioremap failed\n", __func__,
			__LINE__);
		result = -EPERM;
		goto fail_ioremap;
	}

	dev_dbg(&dev->core, "%s:%d: hcd->rsrc_start %lxh\n", __func__, __LINE__,
		(unsigned long)hcd->rsrc_start);
	dev_dbg(&dev->core, "%s:%d: hcd->rsrc_len   %lxh\n", __func__, __LINE__,
		(unsigned long)hcd->rsrc_len);
	dev_dbg(&dev->core, "%s:%d: hcd->regs       %lxh\n", __func__, __LINE__,
		(unsigned long)hcd->regs);
	dev_dbg(&dev->core, "%s:%d: virq            %lu\n", __func__, __LINE__,
		(unsigned long)virq);

	ps3_system_bus_set_drvdata(dev, hcd);

	result = usb_add_hcd(hcd, virq, 0);

	if (result) {
		dev_dbg(&dev->core, "%s:%d: usb_add_hcd failed (%d)\n",
			__func__, __LINE__, result);
		goto fail_add_hcd;
	}

	return result;

fail_add_hcd:
	iounmap(hcd->regs);
fail_ioremap:
	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	usb_put_hcd(hcd);
fail_create_hcd:
	ps3_io_irq_destroy(virq);
fail_irq:
	ps3_free_mmio_region(dev->m_region);
fail_mmio_region:
	ps3_dma_region_free(dev->d_region);
fail_dma_region:
	ps3_close_hv_device(dev);
fail_open:
fail_start:
	return result;
}

static int ps3_ehci_remove(struct ps3_system_bus_device *dev)
{
	unsigned int tmp;
	struct usb_hcd *hcd = ps3_system_bus_get_drvdata(dev);

	BUG_ON(!hcd);

	dev_dbg(&dev->core, "%s:%d: regs %p\n", __func__, __LINE__, hcd->regs);
	dev_dbg(&dev->core, "%s:%d: irq %u\n", __func__, __LINE__, hcd->irq);

	tmp = hcd->irq;

	ehci_shutdown(hcd);
	usb_remove_hcd(hcd);

	ps3_system_bus_set_drvdata(dev, NULL);

	BUG_ON(!hcd->regs);
	iounmap(hcd->regs);

	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	usb_put_hcd(hcd);

	ps3_io_irq_destroy(tmp);
	ps3_free_mmio_region(dev->m_region);

	ps3_dma_region_free(dev->d_region);
	ps3_close_hv_device(dev);

	return 0;
}

static int __init ps3_ehci_driver_register(struct ps3_system_bus_driver *drv)
{
	return firmware_has_feature(FW_FEATURE_PS3_LV1)
		? ps3_system_bus_driver_register(drv)
		: 0;
}

static void ps3_ehci_driver_unregister(struct ps3_system_bus_driver *drv)
{
	if (firmware_has_feature(FW_FEATURE_PS3_LV1))
		ps3_system_bus_driver_unregister(drv);
}

MODULE_ALIAS(PS3_MODULE_ALIAS_EHCI);

static struct ps3_system_bus_driver ps3_ehci_driver = {
	.core.name = "ps3-ehci-driver",
	.core.owner = THIS_MODULE,
	.match_id = PS3_MATCH_ID_EHCI,
	.probe = ps3_ehci_probe,
	.remove = ps3_ehci_remove,
	.shutdown = ps3_ehci_remove,
};
Commit	Line	Data
ad75a410 GL	1	/*
	2	* PS3 EHCI Host Controller driver
	3	*
	4	* Copyright (C) 2006 Sony Computer Entertainment Inc.
	5	* Copyright 2006 Sony Corp.
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; version 2 of the License.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*/
	20
7a4eb7fd	21	#include <asm/firmware.h>
ad75a410 GL	22	#include <asm/ps3.h>
ad75a410 GL	23
9187bef2 GL	24	static void ps3_ehci_setup_insnreg(struct ehci_hcd *ehci)
	25	{
	26	/* PS3 HC internal setup register offsets. */
	27
	28	enum ps3_ehci_hc_insnreg {
	29	ps3_ehci_hc_insnreg01 = 0x084,
	30	ps3_ehci_hc_insnreg02 = 0x088,
	31	ps3_ehci_hc_insnreg03 = 0x08c,
	32	};
	33
	34	/* PS3 EHCI HC errata fix 316 - The PS3 EHCI HC will reset its
	35	* internal INSNREGXX setup regs back to the chip default values
	36	* on Host Controller Reset (CMD_RESET) or Light Host Controller
	37	* Reset (CMD_LRESET). The work-around for this is for the HC
	38	* driver to re-initialise these regs when ever the HC is reset.
	39	*/
	40
	41	/* Set burst transfer counts to 256 out, 32 in. */
	42
	43	writel_be(0x01000020, (void __iomem *)ehci->regs +
	44	ps3_ehci_hc_insnreg01);
	45
	46	/* Enable burst transfer counts. */
	47
	48	writel_be(0x00000001, (void __iomem *)ehci->regs +
	49	ps3_ehci_hc_insnreg03);
	50	}
	51
ad75a410 GL	52	static int ps3_ehci_hc_reset(struct usb_hcd *hcd)
	53	{
	54	int result;
	55	struct ehci_hcd *ehci = hcd_to_ehci(hcd);
	56
	57	ehci->big_endian_mmio = 1;
	58
	59	ehci->caps = hcd->regs;
c430131a	60	ehci->regs = hcd->regs + HC_LENGTH(ehci, ehci_readl(ehci,
ad75a410 GL	61	&ehci->caps->hc_capbase));
	62
	63	dbg_hcs_params(ehci, "reset");
	64	dbg_hcc_params(ehci, "reset");
	65
	66	ehci->hcs_params = ehci_readl(ehci, &ehci->caps->hcs_params);
	67
	68	result = ehci_halt(ehci);
	69
	70	if (result)
	71	return result;
	72
	73	result = ehci_init(hcd);
	74
	75	if (result)
	76	return result;
	77
af1c51fc	78	ehci_reset(ehci);
ad75a410	79
9187bef2 GL	80	ps3_ehci_setup_insnreg(ehci);
9187bef2 GL	81
ad75a410 GL	82	return result;
	83	}
	84
	85	static const struct hc_driver ps3_ehci_hc_driver = {
	86	.description = hcd_name,
	87	.product_desc = "PS3 EHCI Host Controller",
	88	.hcd_priv_size = sizeof(struct ehci_hcd),
	89	.irq = ehci_irq,
	90	.flags = HCD_MEMORY \| HCD_USB2,
	91	.reset = ps3_ehci_hc_reset,
	92	.start = ehci_run,
	93	.stop = ehci_stop,
	94	.shutdown = ehci_shutdown,
	95	.urb_enqueue = ehci_urb_enqueue,
	96	.urb_dequeue = ehci_urb_dequeue,
	97	.endpoint_disable = ehci_endpoint_disable,
b18ffd49	98	.endpoint_reset = ehci_endpoint_reset,
ad75a410 GL	99	.get_frame_number = ehci_get_frame,
	100	.hub_status_data = ehci_hub_status_data,
	101	.hub_control = ehci_hub_control,
	102	#if defined(CONFIG_PM)
	103	.bus_suspend = ehci_bus_suspend,
	104	.bus_resume = ehci_bus_resume,
	105	#endif
90da096e	106	.relinquish_port = ehci_relinquish_port,
3a31155c	107	.port_handed_over = ehci_port_handed_over,
914b7012 AS	108
914b7012 AS	109	.clear_tt_buffer_complete = ehci_clear_tt_buffer_complete,
ad75a410 GL	110	};
ad75a410 GL	111
31348517	112	static int __devinit ps3_ehci_probe(struct ps3_system_bus_device *dev)
ad75a410 GL	113	{
	114	int result;
	115	struct usb_hcd *hcd;
	116	unsigned int virq;
284901a9	117	static u64 dummy_mask = DMA_BIT_MASK(32);
ad75a410 GL	118
	119	if (usb_disabled()) {
	120	result = -ENODEV;
	121	goto fail_start;
	122	}
	123
7a4eb7fd GL	124	result = ps3_open_hv_device(dev);
	125
	126	if (result) {
	127	dev_dbg(&dev->core, "%s:%d: ps3_open_hv_device failed\n",
	128	__func__, __LINE__);
	129	goto fail_open;
	130	}
	131
	132	result = ps3_dma_region_create(dev->d_region);
	133
	134	if (result) {
	135	dev_dbg(&dev->core, "%s:%d: ps3_dma_region_create failed: "
	136	"(%d)\n", __func__, __LINE__, result);
	137	BUG_ON("check region type");
	138	goto fail_dma_region;
	139	}
	140
ad75a410 GL	141	result = ps3_mmio_region_create(dev->m_region);
	142
	143	if (result) {
	144	dev_dbg(&dev->core, "%s:%d: ps3_map_mmio_region failed\n",
	145	__func__, __LINE__);
	146	result = -EPERM;
7a4eb7fd	147	goto fail_mmio_region;
ad75a410 GL	148	}
	149
	150	dev_dbg(&dev->core, "%s:%d: mmio mapped_addr %lxh\n", __func__,
	151	__LINE__, dev->m_region->lpar_addr);
	152
dc4f60c2	153	result = ps3_io_irq_setup(PS3_BINDING_CPU_ANY, dev->interrupt_id, &virq);
ad75a410 GL	154
	155	if (result) {
	156	dev_dbg(&dev->core, "%s:%d: ps3_construct_io_irq(%d) failed.\n",
	157	__func__, __LINE__, virq);
	158	result = -EPERM;
	159	goto fail_irq;
	160	}
	161
ad75a410 GL	162	dev->core.dma_mask = &dummy_mask; /* FIXME: for improper usb code */
ad75a410 GL	163
7071a3ce	164	hcd = usb_create_hcd(&ps3_ehci_hc_driver, &dev->core, dev_name(&dev->core));
ad75a410 GL	165
	166	if (!hcd) {
	167	dev_dbg(&dev->core, "%s:%d: usb_create_hcd failed\n", __func__,
	168	__LINE__);
	169	result = -ENOMEM;
	170	goto fail_create_hcd;
	171	}
	172
	173	hcd->rsrc_start = dev->m_region->lpar_addr;
	174	hcd->rsrc_len = dev->m_region->len;
7a4eb7fd GL	175
	176	if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len, hcd_name))
	177	dev_dbg(&dev->core, "%s:%d: request_mem_region failed\n",
	178	__func__, __LINE__);
	179
ad75a410 GL	180	hcd->regs = ioremap(dev->m_region->lpar_addr, dev->m_region->len);
	181
	182	if (!hcd->regs) {
	183	dev_dbg(&dev->core, "%s:%d: ioremap failed\n", __func__,
	184	__LINE__);
	185	result = -EPERM;
	186	goto fail_ioremap;
	187	}
	188
	189	dev_dbg(&dev->core, "%s:%d: hcd->rsrc_start %lxh\n", __func__, __LINE__,
	190	(unsigned long)hcd->rsrc_start);
	191	dev_dbg(&dev->core, "%s:%d: hcd->rsrc_len %lxh\n", __func__, __LINE__,
	192	(unsigned long)hcd->rsrc_len);
	193	dev_dbg(&dev->core, "%s:%d: hcd->regs %lxh\n", __func__, __LINE__,
	194	(unsigned long)hcd->regs);
	195	dev_dbg(&dev->core, "%s:%d: virq %lu\n", __func__, __LINE__,
	196	(unsigned long)virq);
	197
03fa68c2	198	ps3_system_bus_set_drvdata(dev, hcd);
ad75a410	199
b5dd18d8	200	result = usb_add_hcd(hcd, virq, 0);
ad75a410 GL	201
	202	if (result) {
	203	dev_dbg(&dev->core, "%s:%d: usb_add_hcd failed (%d)\n",
	204	__func__, __LINE__, result);
	205	goto fail_add_hcd;
	206	}
	207
	208	return result;
	209
	210	fail_add_hcd:
	211	iounmap(hcd->regs);
	212	fail_ioremap:
7a4eb7fd	213	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
ad75a410 GL	214	usb_put_hcd(hcd);
ad75a410 GL	215	fail_create_hcd:
dc4f60c2	216	ps3_io_irq_destroy(virq);
ad75a410 GL	217	fail_irq:
ad75a410 GL	218	ps3_free_mmio_region(dev->m_region);
7a4eb7fd GL	219	fail_mmio_region:
	220	ps3_dma_region_free(dev->d_region);
	221	fail_dma_region:
	222	ps3_close_hv_device(dev);
	223	fail_open:
ad75a410 GL	224	fail_start:
	225	return result;
	226	}
	227
7a4eb7fd	228	static int ps3_ehci_remove(struct ps3_system_bus_device *dev)
ad75a410	229	{
7a4eb7fd	230	unsigned int tmp;
03fa68c2	231	struct usb_hcd *hcd = ps3_system_bus_get_drvdata(dev);
ad75a410	232
7a4eb7fd GL	233	BUG_ON(!hcd);
	234
	235	dev_dbg(&dev->core, "%s:%d: regs %p\n", __func__, __LINE__, hcd->regs);
	236	dev_dbg(&dev->core, "%s:%d: irq %u\n", __func__, __LINE__, hcd->irq);
	237
	238	tmp = hcd->irq;
	239
ddcb01ff	240	ehci_shutdown(hcd);
7a4eb7fd GL	241	usb_remove_hcd(hcd);
7a4eb7fd GL	242
03fa68c2	243	ps3_system_bus_set_drvdata(dev, NULL);
ad75a410	244
7a4eb7fd GL	245	BUG_ON(!hcd->regs);
	246	iounmap(hcd->regs);
	247
	248	release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
	249	usb_put_hcd(hcd);
	250
	251	ps3_io_irq_destroy(tmp);
	252	ps3_free_mmio_region(dev->m_region);
	253
	254	ps3_dma_region_free(dev->d_region);
	255	ps3_close_hv_device(dev);
	256
ad75a410 GL	257	return 0;
	258	}
	259
31348517	260	static int __init ps3_ehci_driver_register(struct ps3_system_bus_driver *drv)
7a4eb7fd GL	261	{
	262	return firmware_has_feature(FW_FEATURE_PS3_LV1)
	263	? ps3_system_bus_driver_register(drv)
	264	: 0;
	265	}
	266
	267	static void ps3_ehci_driver_unregister(struct ps3_system_bus_driver *drv)
	268	{
	269	if (firmware_has_feature(FW_FEATURE_PS3_LV1))
	270	ps3_system_bus_driver_unregister(drv);
	271	}
	272
	273	MODULE_ALIAS(PS3_MODULE_ALIAS_EHCI);
ad75a410	274
7a4eb7fd GL	275	static struct ps3_system_bus_driver ps3_ehci_driver = {
	276	.core.name = "ps3-ehci-driver",
	277	.core.owner = THIS_MODULE,
ad75a410	278	.match_id = PS3_MATCH_ID_EHCI,
7a4eb7fd GL	279	.probe = ps3_ehci_probe,
	280	.remove = ps3_ehci_remove,
	281	.shutdown = ps3_ehci_remove,
ad75a410	282	};