[linux-block.git] / drivers / usb / host / ssb-hcd.c

/*
 * Sonics Silicon Backplane
 * Broadcom USB-core driver  (SSB bus glue)
 *
 * Copyright 2011-2012 Hauke Mehrtens <hauke@hauke-m.de>
 *
 * Based on ssb-ohci driver
 * Copyright 2007 Michael Buesch <m@bues.ch>
 *
 * Derived from the OHCI-PCI driver
 * Copyright 1999 Roman Weissgaerber
 * Copyright 2000-2002 David Brownell
 * Copyright 1999 Linus Torvalds
 * Copyright 1999 Gregory P. Smith
 *
 * Derived from the USBcore related parts of Broadcom-SB
 * Copyright 2005-2011 Broadcom Corporation
 *
 * Licensed under the GNU/GPL. See COPYING for details.
 */
#include <linux/ssb/ssb.h>
#include <linux/delay.h>
#include <linux/platform_device.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/usb/ehci_pdriver.h>
#include <linux/usb/ohci_pdriver.h>

MODULE_AUTHOR("Hauke Mehrtens");
MODULE_DESCRIPTION("Common USB driver for SSB Bus");
MODULE_LICENSE("GPL");

#define SSB_HCD_TMSLOW_HOSTMODE	(1 << 29)

struct ssb_hcd_device {
	struct platform_device *ehci_dev;
	struct platform_device *ohci_dev;

	u32 enable_flags;
};

static void __devinit ssb_hcd_5354wa(struct ssb_device *dev)
{
#ifdef CONFIG_SSB_DRIVER_MIPS
	/* Work around for 5354 failures */
	if (dev->id.revision == 2 && dev->bus->chip_id == 0x5354) {
		/* Change syn01 reg */
		ssb_write32(dev, 0x894, 0x00fe00fe);

		/* Change syn03 reg */
		ssb_write32(dev, 0x89c, ssb_read32(dev, 0x89c) | 0x1);
	}
#endif
}

static void __devinit ssb_hcd_usb20wa(struct ssb_device *dev)
{
	if (dev->id.coreid == SSB_DEV_USB20_HOST) {
		/*
		 * USB 2.0 special considerations:
		 *
		 * In addition to the standard SSB reset sequence, the Host
		 * Control Register must be programmed to bring the USB core
		 * and various phy components out of reset.
		 */
		ssb_write32(dev, 0x200, 0x7ff);

		/* Change Flush control reg */
		ssb_write32(dev, 0x400, ssb_read32(dev, 0x400) & ~8);
		ssb_read32(dev, 0x400);

		/* Change Shim control reg */
		ssb_write32(dev, 0x304, ssb_read32(dev, 0x304) & ~0x100);
		ssb_read32(dev, 0x304);

		udelay(1);

		ssb_hcd_5354wa(dev);
	}
}

/* based on arch/mips/brcm-boards/bcm947xx/pcibios.c */
static u32 __devinit ssb_hcd_init_chip(struct ssb_device *dev)
{
	u32 flags = 0;

	if (dev->id.coreid == SSB_DEV_USB11_HOSTDEV)
		/* Put the device into host-mode. */
		flags |= SSB_HCD_TMSLOW_HOSTMODE;

	ssb_device_enable(dev, flags);

	ssb_hcd_usb20wa(dev);

	return flags;
}

static const struct usb_ehci_pdata ehci_pdata = {
};

static const struct usb_ohci_pdata ohci_pdata = {
};

static struct platform_device * __devinit
ssb_hcd_create_pdev(struct ssb_device *dev, bool ohci, u32 addr, u32 len)
{
	struct platform_device *hci_dev;
	struct resource hci_res[2];
	int ret = -ENOMEM;

	memset(hci_res, 0, sizeof(hci_res));

	hci_res[0].start = addr;
	hci_res[0].end = hci_res[0].start + len - 1;
	hci_res[0].flags = IORESOURCE_MEM;

	hci_res[1].start = dev->irq;
	hci_res[1].flags = IORESOURCE_IRQ;

	hci_dev = platform_device_alloc(ohci ? "ohci-platform" :
					"ehci-platform" , 0);
	if (!hci_dev)
		return NULL;

	hci_dev->dev.parent = dev->dev;
	hci_dev->dev.dma_mask = &hci_dev->dev.coherent_dma_mask;

	ret = platform_device_add_resources(hci_dev, hci_res,
					    ARRAY_SIZE(hci_res));
	if (ret)
		goto err_alloc;
	if (ohci)
		ret = platform_device_add_data(hci_dev, &ohci_pdata,
					       sizeof(ohci_pdata));
	else
		ret = platform_device_add_data(hci_dev, &ehci_pdata,
					       sizeof(ehci_pdata));
	if (ret)
		goto err_alloc;
	ret = platform_device_add(hci_dev);
	if (ret)
		goto err_alloc;

	return hci_dev;

err_alloc:
	platform_device_put(hci_dev);
	return ERR_PTR(ret);
}

static int __devinit ssb_hcd_probe(struct ssb_device *dev,
				   const struct ssb_device_id *id)
{
	int err, tmp;
	int start, len;
	u16 chipid_top;
	u16 coreid = dev->id.coreid;
	struct ssb_hcd_device *usb_dev;

	/* USBcores are only connected on embedded devices. */
	chipid_top = (dev->bus->chip_id & 0xFF00);
	if (chipid_top != 0x4700 && chipid_top != 0x5300)
		return -ENODEV;

	/* TODO: Probably need checks here; is the core connected? */

	if (dma_set_mask(dev->dma_dev, DMA_BIT_MASK(32)) ||
	    dma_set_coherent_mask(dev->dma_dev, DMA_BIT_MASK(32)))
		return -EOPNOTSUPP;

	usb_dev = kzalloc(sizeof(struct ssb_hcd_device), GFP_KERNEL);
	if (!usb_dev)
		return -ENOMEM;

	/* We currently always attach SSB_DEV_USB11_HOSTDEV
	 * as HOST OHCI. If we want to attach it as Client device,
	 * we must branch here and call into the (yet to
	 * be written) Client mode driver. Same for remove(). */
	usb_dev->enable_flags = ssb_hcd_init_chip(dev);

	tmp = ssb_read32(dev, SSB_ADMATCH0);

	start = ssb_admatch_base(tmp);
	len = (coreid == SSB_DEV_USB20_HOST) ? 0x800 : ssb_admatch_size(tmp);
	usb_dev->ohci_dev = ssb_hcd_create_pdev(dev, true, start, len);
	if (IS_ERR(usb_dev->ohci_dev)) {
		err = PTR_ERR(usb_dev->ohci_dev);
		goto err_free_usb_dev;
	}

	if (coreid == SSB_DEV_USB20_HOST) {
		start = ssb_admatch_base(tmp) + 0x800; /* ehci core offset */
		usb_dev->ehci_dev = ssb_hcd_create_pdev(dev, false, start, len);
		if (IS_ERR(usb_dev->ehci_dev)) {
			err = PTR_ERR(usb_dev->ehci_dev);
			goto err_unregister_ohci_dev;
		}
	}

	ssb_set_drvdata(dev, usb_dev);
	return 0;

err_unregister_ohci_dev:
	platform_device_unregister(usb_dev->ohci_dev);
err_free_usb_dev:
	kfree(usb_dev);
	return err;
}

static void __devexit ssb_hcd_remove(struct ssb_device *dev)
{
	struct ssb_hcd_device *usb_dev = ssb_get_drvdata(dev);
	struct platform_device *ohci_dev = usb_dev->ohci_dev;
	struct platform_device *ehci_dev = usb_dev->ehci_dev;

	if (ohci_dev)
		platform_device_unregister(ohci_dev);
	if (ehci_dev)
		platform_device_unregister(ehci_dev);

	ssb_device_disable(dev, 0);
}

static void __devexit ssb_hcd_shutdown(struct ssb_device *dev)
{
	ssb_device_disable(dev, 0);
}

#ifdef CONFIG_PM

static int ssb_hcd_suspend(struct ssb_device *dev, pm_message_t state)
{
	ssb_device_disable(dev, 0);

	return 0;
}

static int ssb_hcd_resume(struct ssb_device *dev)
{
	struct ssb_hcd_device *usb_dev = ssb_get_drvdata(dev);

	ssb_device_enable(dev, usb_dev->enable_flags);

	return 0;
}

#else /* !CONFIG_PM */
#define ssb_hcd_suspend	NULL
#define ssb_hcd_resume	NULL
#endif /* CONFIG_PM */

static const struct ssb_device_id ssb_hcd_table[] __devinitconst = {
	SSB_DEVICE(SSB_VENDOR_BROADCOM, SSB_DEV_USB11_HOSTDEV, SSB_ANY_REV),
	SSB_DEVICE(SSB_VENDOR_BROADCOM, SSB_DEV_USB11_HOST, SSB_ANY_REV),
	SSB_DEVICE(SSB_VENDOR_BROADCOM, SSB_DEV_USB20_HOST, SSB_ANY_REV),
	SSB_DEVTABLE_END
};
MODULE_DEVICE_TABLE(ssb, ssb_hcd_table);

static struct ssb_driver ssb_hcd_driver = {
	.name		= KBUILD_MODNAME,
	.id_table	= ssb_hcd_table,
	.probe		= ssb_hcd_probe,
	.remove		= __devexit_p(ssb_hcd_remove),
	.shutdown	= ssb_hcd_shutdown,
	.suspend	= ssb_hcd_suspend,
	.resume		= ssb_hcd_resume,
};

static int __init ssb_hcd_init(void)
{
	return ssb_driver_register(&ssb_hcd_driver);
}
module_init(ssb_hcd_init);

static void __exit ssb_hcd_exit(void)
{
	ssb_driver_unregister(&ssb_hcd_driver);
}
module_exit(ssb_hcd_exit);
Commit	Line	Data
7043c2cc HM	1	/*
	2	* Sonics Silicon Backplane
	3	* Broadcom USB-core driver (SSB bus glue)
	4	*
	5	* Copyright 2011-2012 Hauke Mehrtens <hauke@hauke-m.de>
	6	*
	7	* Based on ssb-ohci driver
	8	* Copyright 2007 Michael Buesch <m@bues.ch>
	9	*
	10	* Derived from the OHCI-PCI driver
	11	* Copyright 1999 Roman Weissgaerber
	12	* Copyright 2000-2002 David Brownell
	13	* Copyright 1999 Linus Torvalds
	14	* Copyright 1999 Gregory P. Smith
	15	*
	16	* Derived from the USBcore related parts of Broadcom-SB
	17	* Copyright 2005-2011 Broadcom Corporation
	18	*
	19	* Licensed under the GNU/GPL. See COPYING for details.
	20	*/
	21	#include <linux/ssb/ssb.h>
	22	#include <linux/delay.h>
	23	#include <linux/platform_device.h>
	24	#include <linux/module.h>
4627b1ea	25	#include <linux/slab.h>
7043c2cc HM	26	#include <linux/usb/ehci_pdriver.h>
	27	#include <linux/usb/ohci_pdriver.h>
	28
	29	MODULE_AUTHOR("Hauke Mehrtens");
	30	MODULE_DESCRIPTION("Common USB driver for SSB Bus");
	31	MODULE_LICENSE("GPL");
	32
	33	#define SSB_HCD_TMSLOW_HOSTMODE (1 << 29)
	34
	35	struct ssb_hcd_device {
	36	struct platform_device *ehci_dev;
	37	struct platform_device *ohci_dev;
	38
	39	u32 enable_flags;
	40	};
	41
	42	static void __devinit ssb_hcd_5354wa(struct ssb_device *dev)
	43	{
	44	#ifdef CONFIG_SSB_DRIVER_MIPS
	45	/* Work around for 5354 failures */
	46	if (dev->id.revision == 2 && dev->bus->chip_id == 0x5354) {
	47	/* Change syn01 reg */
	48	ssb_write32(dev, 0x894, 0x00fe00fe);
	49
	50	/* Change syn03 reg */
	51	ssb_write32(dev, 0x89c, ssb_read32(dev, 0x89c) \| 0x1);
	52	}
	53	#endif
	54	}
	55
	56	static void __devinit ssb_hcd_usb20wa(struct ssb_device *dev)
	57	{
	58	if (dev->id.coreid == SSB_DEV_USB20_HOST) {
	59	/*
	60	* USB 2.0 special considerations:
	61	*
	62	* In addition to the standard SSB reset sequence, the Host
	63	* Control Register must be programmed to bring the USB core
	64	* and various phy components out of reset.
	65	*/
	66	ssb_write32(dev, 0x200, 0x7ff);
	67
	68	/* Change Flush control reg */
	69	ssb_write32(dev, 0x400, ssb_read32(dev, 0x400) & ~8);
	70	ssb_read32(dev, 0x400);
	71
	72	/* Change Shim control reg */
	73	ssb_write32(dev, 0x304, ssb_read32(dev, 0x304) & ~0x100);
	74	ssb_read32(dev, 0x304);
	75
	76	udelay(1);
	77
	78	ssb_hcd_5354wa(dev);
	79	}
	80	}
	81
	82	/* based on arch/mips/brcm-boards/bcm947xx/pcibios.c */
	83	static u32 __devinit ssb_hcd_init_chip(struct ssb_device *dev)
	84	{
	85	u32 flags = 0;
	86
	87	if (dev->id.coreid == SSB_DEV_USB11_HOSTDEV)
	88	/* Put the device into host-mode. */
	89	flags \|= SSB_HCD_TMSLOW_HOSTMODE;
90
91	ssb_device_enable(dev, flags);
92
93	ssb_hcd_usb20wa(dev);
94
95	return flags;
96	}
97
98	static const struct usb_ehci_pdata ehci_pdata = {
99	};
100
101	static const struct usb_ohci_pdata ohci_pdata = {
102	};
103
104	static struct platform_device * __devinit
105	ssb_hcd_create_pdev(struct ssb_device *dev, bool ohci, u32 addr, u32 len)
106	{
107	struct platform_device *hci_dev;
108	struct resource hci_res[2];
109	int ret = -ENOMEM;
110
111	memset(hci_res, 0, sizeof(hci_res));
112
113	hci_res[0].start = addr;
114	hci_res[0].end = hci_res[0].start + len - 1;
115	hci_res[0].flags = IORESOURCE_MEM;
116
117	hci_res[1].start = dev->irq;
118	hci_res[1].flags = IORESOURCE_IRQ;
119
120	hci_dev = platform_device_alloc(ohci ? "ohci-platform" :
121	"ehci-platform" , 0);
122	if (!hci_dev)
123	return NULL;
124
125	hci_dev->dev.parent = dev->dev;
126	hci_dev->dev.dma_mask = &hci_dev->dev.coherent_dma_mask;
127
128	ret = platform_device_add_resources(hci_dev, hci_res,
129	ARRAY_SIZE(hci_res));
130	if (ret)
131	goto err_alloc;
132	if (ohci)
133	ret = platform_device_add_data(hci_dev, &ohci_pdata,
134	sizeof(ohci_pdata));
135	else
136	ret = platform_device_add_data(hci_dev, &ehci_pdata,
137	sizeof(ehci_pdata));
138	if (ret)
139	goto err_alloc;
140	ret = platform_device_add(hci_dev);
141	if (ret)
142	goto err_alloc;
143
144	return hci_dev;
145
146	err_alloc:
147	platform_device_put(hci_dev);
148	return ERR_PTR(ret);
149	}
150
151	static int __devinit ssb_hcd_probe(struct ssb_device *dev,
152	const struct ssb_device_id *id)
153	{
154	int err, tmp;
155	int start, len;
156	u16 chipid_top;
157	u16 coreid = dev->id.coreid;
158	struct ssb_hcd_device *usb_dev;
159
160	/* USBcores are only connected on embedded devices. */
161	chipid_top = (dev->bus->chip_id & 0xFF00);
162	if (chipid_top != 0x4700 && chipid_top != 0x5300)
163	return -ENODEV;
164
165	/* TODO: Probably need checks here; is the core connected? */
166
167	if (dma_set_mask(dev->dma_dev, DMA_BIT_MASK(32)) \|\|
168	dma_set_coherent_mask(dev->dma_dev, DMA_BIT_MASK(32)))
169	return -EOPNOTSUPP;
170
171	usb_dev = kzalloc(sizeof(struct ssb_hcd_device), GFP_KERNEL);
172	if (!usb_dev)
173	return -ENOMEM;
174
175	/* We currently always attach SSB_DEV_USB11_HOSTDEV
176	* as HOST OHCI. If we want to attach it as Client device,
177	* we must branch here and call into the (yet to
178	* be written) Client mode driver. Same for remove(). */
179	usb_dev->enable_flags = ssb_hcd_init_chip(dev);
180
181	tmp = ssb_read32(dev, SSB_ADMATCH0);
182
183	start = ssb_admatch_base(tmp);
184	len = (coreid == SSB_DEV_USB20_HOST) ? 0x800 : ssb_admatch_size(tmp);
185	usb_dev->ohci_dev = ssb_hcd_create_pdev(dev, true, start, len);
186	if (IS_ERR(usb_dev->ohci_dev)) {
187	err = PTR_ERR(usb_dev->ohci_dev);
188	goto err_free_usb_dev;
189	}
190
191	if (coreid == SSB_DEV_USB20_HOST) {
192	start = ssb_admatch_base(tmp) + 0x800; /* ehci core offset */
193	usb_dev->ehci_dev = ssb_hcd_create_pdev(dev, false, start, len);
194	if (IS_ERR(usb_dev->ehci_dev)) {
195	err = PTR_ERR(usb_dev->ehci_dev);
196	goto err_unregister_ohci_dev;
197	}
198	}
199
200	ssb_set_drvdata(dev, usb_dev);
201	return 0;
202
203	err_unregister_ohci_dev:
204	platform_device_unregister(usb_dev->ohci_dev);
205	err_free_usb_dev:
206	kfree(usb_dev);
207	return err;
208	}
209
210	static void __devexit ssb_hcd_remove(struct ssb_device *dev)
211	{
212	struct ssb_hcd_device *usb_dev = ssb_get_drvdata(dev);
213	struct platform_device *ohci_dev = usb_dev->ohci_dev;
214	struct platform_device *ehci_dev = usb_dev->ehci_dev;
215
216	if (ohci_dev)
217	platform_device_unregister(ohci_dev);
218	if (ehci_dev)
219	platform_device_unregister(ehci_dev);
220
221	ssb_device_disable(dev, 0);
222	}
223
224	static void __devexit ssb_hcd_shutdown(struct ssb_device *dev)
225	{
226	ssb_device_disable(dev, 0);
227	}
228
229	#ifdef CONFIG_PM
230
231	static int ssb_hcd_suspend(struct ssb_device *dev, pm_message_t state)
232	{
233	ssb_device_disable(dev, 0);
234
235	return 0;
236	}
237
238	static int ssb_hcd_resume(struct ssb_device *dev)
239	{
240	struct ssb_hcd_device *usb_dev = ssb_get_drvdata(dev);
241
242	ssb_device_enable(dev, usb_dev->enable_flags);
243
244	return 0;
245	}
246
247	#else /* !CONFIG_PM */
248	#define ssb_hcd_suspend NULL
249	#define ssb_hcd_resume NULL
250	#endif /* CONFIG_PM */
251
252	static const struct ssb_device_id ssb_hcd_table[] __devinitconst = {
253	SSB_DEVICE(SSB_VENDOR_BROADCOM, SSB_DEV_USB11_HOSTDEV, SSB_ANY_REV),
254	SSB_DEVICE(SSB_VENDOR_BROADCOM, SSB_DEV_USB11_HOST, SSB_ANY_REV),
255	SSB_DEVICE(SSB_VENDOR_BROADCOM, SSB_DEV_USB20_HOST, SSB_ANY_REV),
256	SSB_DEVTABLE_END
257	};
258	MODULE_DEVICE_TABLE(ssb, ssb_hcd_table);
259
260	static struct ssb_driver ssb_hcd_driver = {
261	.name = KBUILD_MODNAME,
262	.id_table = ssb_hcd_table,
263	.probe = ssb_hcd_probe,
264	.remove = __devexit_p(ssb_hcd_remove),
265	.shutdown = ssb_hcd_shutdown,
266	.suspend = ssb_hcd_suspend,
267	.resume = ssb_hcd_resume,
268	};
269
270	static int __init ssb_hcd_init(void)
271	{
272	return ssb_driver_register(&ssb_hcd_driver);
273	}
274	module_init(ssb_hcd_init);
275
276	static void __exit ssb_hcd_exit(void)
277	{
278	ssb_driver_unregister(&ssb_hcd_driver);
279	}
280	module_exit(ssb_hcd_exit);