xref: /openbmc/linux/drivers/usb/host/fsl-mph-dr-of.c (revision cc604ddd)
1126512e3SAnatolij Gustschin /*
2126512e3SAnatolij Gustschin  * Setup platform devices needed by the Freescale multi-port host
3126512e3SAnatolij Gustschin  * and/or dual-role USB controller modules based on the description
4126512e3SAnatolij Gustschin  * in flat device tree.
5126512e3SAnatolij Gustschin  *
6126512e3SAnatolij Gustschin  * This program is free software; you can redistribute  it and/or modify it
7126512e3SAnatolij Gustschin  * under  the terms of  the GNU General  Public License as published by the
8126512e3SAnatolij Gustschin  * Free Software Foundation;  either version 2 of the  License, or (at your
9126512e3SAnatolij Gustschin  * option) any later version.
10126512e3SAnatolij Gustschin  */
11126512e3SAnatolij Gustschin 
12126512e3SAnatolij Gustschin #include <linux/kernel.h>
13126512e3SAnatolij Gustschin #include <linux/platform_device.h>
14126512e3SAnatolij Gustschin #include <linux/fsl_devices.h>
15126512e3SAnatolij Gustschin #include <linux/err.h>
16126512e3SAnatolij Gustschin #include <linux/io.h>
17126512e3SAnatolij Gustschin #include <linux/of_platform.h>
18230f7edeSAnatolij Gustschin #include <linux/clk.h>
19126512e3SAnatolij Gustschin 
20126512e3SAnatolij Gustschin struct fsl_usb2_dev_data {
21126512e3SAnatolij Gustschin 	char *dr_mode;		/* controller mode */
22126512e3SAnatolij Gustschin 	char *drivers[3];	/* drivers to instantiate for this mode */
23126512e3SAnatolij Gustschin 	enum fsl_usb2_operating_modes op_mode;	/* operating mode */
24126512e3SAnatolij Gustschin };
25126512e3SAnatolij Gustschin 
26126512e3SAnatolij Gustschin struct fsl_usb2_dev_data dr_mode_data[] __devinitdata = {
27126512e3SAnatolij Gustschin 	{
28126512e3SAnatolij Gustschin 		.dr_mode = "host",
29126512e3SAnatolij Gustschin 		.drivers = { "fsl-ehci", NULL, NULL, },
30126512e3SAnatolij Gustschin 		.op_mode = FSL_USB2_DR_HOST,
31126512e3SAnatolij Gustschin 	},
32126512e3SAnatolij Gustschin 	{
33126512e3SAnatolij Gustschin 		.dr_mode = "otg",
34126512e3SAnatolij Gustschin 		.drivers = { "fsl-usb2-otg", "fsl-ehci", "fsl-usb2-udc", },
35126512e3SAnatolij Gustschin 		.op_mode = FSL_USB2_DR_OTG,
36126512e3SAnatolij Gustschin 	},
37126512e3SAnatolij Gustschin 	{
38126512e3SAnatolij Gustschin 		.dr_mode = "peripheral",
39126512e3SAnatolij Gustschin 		.drivers = { "fsl-usb2-udc", NULL, NULL, },
40126512e3SAnatolij Gustschin 		.op_mode = FSL_USB2_DR_DEVICE,
41126512e3SAnatolij Gustschin 	},
42126512e3SAnatolij Gustschin };
43126512e3SAnatolij Gustschin 
44126512e3SAnatolij Gustschin struct fsl_usb2_dev_data * __devinit get_dr_mode_data(struct device_node *np)
45126512e3SAnatolij Gustschin {
46126512e3SAnatolij Gustschin 	const unsigned char *prop;
47126512e3SAnatolij Gustschin 	int i;
48126512e3SAnatolij Gustschin 
49126512e3SAnatolij Gustschin 	prop = of_get_property(np, "dr_mode", NULL);
50126512e3SAnatolij Gustschin 	if (prop) {
51126512e3SAnatolij Gustschin 		for (i = 0; i < ARRAY_SIZE(dr_mode_data); i++) {
52126512e3SAnatolij Gustschin 			if (!strcmp(prop, dr_mode_data[i].dr_mode))
53126512e3SAnatolij Gustschin 				return &dr_mode_data[i];
54126512e3SAnatolij Gustschin 		}
55126512e3SAnatolij Gustschin 	}
56126512e3SAnatolij Gustschin 	pr_warn("%s: Invalid 'dr_mode' property, fallback to host mode\n",
57126512e3SAnatolij Gustschin 		np->full_name);
58126512e3SAnatolij Gustschin 	return &dr_mode_data[0]; /* mode not specified, use host */
59126512e3SAnatolij Gustschin }
60126512e3SAnatolij Gustschin 
61126512e3SAnatolij Gustschin static enum fsl_usb2_phy_modes __devinit determine_usb_phy(const char *phy_type)
62126512e3SAnatolij Gustschin {
63126512e3SAnatolij Gustschin 	if (!phy_type)
64126512e3SAnatolij Gustschin 		return FSL_USB2_PHY_NONE;
65126512e3SAnatolij Gustschin 	if (!strcasecmp(phy_type, "ulpi"))
66126512e3SAnatolij Gustschin 		return FSL_USB2_PHY_ULPI;
67126512e3SAnatolij Gustschin 	if (!strcasecmp(phy_type, "utmi"))
68126512e3SAnatolij Gustschin 		return FSL_USB2_PHY_UTMI;
69126512e3SAnatolij Gustschin 	if (!strcasecmp(phy_type, "utmi_wide"))
70126512e3SAnatolij Gustschin 		return FSL_USB2_PHY_UTMI_WIDE;
71126512e3SAnatolij Gustschin 	if (!strcasecmp(phy_type, "serial"))
72126512e3SAnatolij Gustschin 		return FSL_USB2_PHY_SERIAL;
73126512e3SAnatolij Gustschin 
74126512e3SAnatolij Gustschin 	return FSL_USB2_PHY_NONE;
75126512e3SAnatolij Gustschin }
76126512e3SAnatolij Gustschin 
77126512e3SAnatolij Gustschin struct platform_device * __devinit fsl_usb2_device_register(
78126512e3SAnatolij Gustschin 					struct platform_device *ofdev,
79126512e3SAnatolij Gustschin 					struct fsl_usb2_platform_data *pdata,
80126512e3SAnatolij Gustschin 					const char *name, int id)
81126512e3SAnatolij Gustschin {
82126512e3SAnatolij Gustschin 	struct platform_device *pdev;
83126512e3SAnatolij Gustschin 	const struct resource *res = ofdev->resource;
84126512e3SAnatolij Gustschin 	unsigned int num = ofdev->num_resources;
85126512e3SAnatolij Gustschin 	int retval;
86126512e3SAnatolij Gustschin 
87126512e3SAnatolij Gustschin 	pdev = platform_device_alloc(name, id);
88126512e3SAnatolij Gustschin 	if (!pdev) {
89126512e3SAnatolij Gustschin 		retval = -ENOMEM;
90126512e3SAnatolij Gustschin 		goto error;
91126512e3SAnatolij Gustschin 	}
92126512e3SAnatolij Gustschin 
93126512e3SAnatolij Gustschin 	pdev->dev.parent = &ofdev->dev;
94126512e3SAnatolij Gustschin 
95126512e3SAnatolij Gustschin 	pdev->dev.coherent_dma_mask = ofdev->dev.coherent_dma_mask;
96126512e3SAnatolij Gustschin 	pdev->dev.dma_mask = &pdev->archdata.dma_mask;
97126512e3SAnatolij Gustschin 	*pdev->dev.dma_mask = *ofdev->dev.dma_mask;
98126512e3SAnatolij Gustschin 
99126512e3SAnatolij Gustschin 	retval = platform_device_add_data(pdev, pdata, sizeof(*pdata));
100126512e3SAnatolij Gustschin 	if (retval)
101126512e3SAnatolij Gustschin 		goto error;
102126512e3SAnatolij Gustschin 
103126512e3SAnatolij Gustschin 	if (num) {
104126512e3SAnatolij Gustschin 		retval = platform_device_add_resources(pdev, res, num);
105126512e3SAnatolij Gustschin 		if (retval)
106126512e3SAnatolij Gustschin 			goto error;
107126512e3SAnatolij Gustschin 	}
108126512e3SAnatolij Gustschin 
109126512e3SAnatolij Gustschin 	retval = platform_device_add(pdev);
110126512e3SAnatolij Gustschin 	if (retval)
111126512e3SAnatolij Gustschin 		goto error;
112126512e3SAnatolij Gustschin 
113126512e3SAnatolij Gustschin 	return pdev;
114126512e3SAnatolij Gustschin 
115126512e3SAnatolij Gustschin error:
116126512e3SAnatolij Gustschin 	platform_device_put(pdev);
117126512e3SAnatolij Gustschin 	return ERR_PTR(retval);
118126512e3SAnatolij Gustschin }
119126512e3SAnatolij Gustschin 
120126512e3SAnatolij Gustschin static const struct of_device_id fsl_usb2_mph_dr_of_match[];
121126512e3SAnatolij Gustschin 
122126512e3SAnatolij Gustschin static int __devinit fsl_usb2_mph_dr_of_probe(struct platform_device *ofdev)
123126512e3SAnatolij Gustschin {
124126512e3SAnatolij Gustschin 	struct device_node *np = ofdev->dev.of_node;
125126512e3SAnatolij Gustschin 	struct platform_device *usb_dev;
126126512e3SAnatolij Gustschin 	struct fsl_usb2_platform_data data, *pdata;
127126512e3SAnatolij Gustschin 	struct fsl_usb2_dev_data *dev_data;
128126512e3SAnatolij Gustschin 	const struct of_device_id *match;
129126512e3SAnatolij Gustschin 	const unsigned char *prop;
130126512e3SAnatolij Gustschin 	static unsigned int idx;
131126512e3SAnatolij Gustschin 	int i;
132126512e3SAnatolij Gustschin 
133126512e3SAnatolij Gustschin 	if (!of_device_is_available(np))
134126512e3SAnatolij Gustschin 		return -ENODEV;
135126512e3SAnatolij Gustschin 
136126512e3SAnatolij Gustschin 	match = of_match_device(fsl_usb2_mph_dr_of_match, &ofdev->dev);
137126512e3SAnatolij Gustschin 	if (!match)
138126512e3SAnatolij Gustschin 		return -ENODEV;
139126512e3SAnatolij Gustschin 
140126512e3SAnatolij Gustschin 	pdata = &data;
141126512e3SAnatolij Gustschin 	if (match->data)
142126512e3SAnatolij Gustschin 		memcpy(pdata, match->data, sizeof(data));
143126512e3SAnatolij Gustschin 	else
144126512e3SAnatolij Gustschin 		memset(pdata, 0, sizeof(data));
145126512e3SAnatolij Gustschin 
146126512e3SAnatolij Gustschin 	dev_data = get_dr_mode_data(np);
147126512e3SAnatolij Gustschin 
148126512e3SAnatolij Gustschin 	if (of_device_is_compatible(np, "fsl-usb2-mph")) {
149126512e3SAnatolij Gustschin 		if (of_get_property(np, "port0", NULL))
150126512e3SAnatolij Gustschin 			pdata->port_enables |= FSL_USB2_PORT0_ENABLED;
151126512e3SAnatolij Gustschin 
152126512e3SAnatolij Gustschin 		if (of_get_property(np, "port1", NULL))
153126512e3SAnatolij Gustschin 			pdata->port_enables |= FSL_USB2_PORT1_ENABLED;
154126512e3SAnatolij Gustschin 
155126512e3SAnatolij Gustschin 		pdata->operating_mode = FSL_USB2_MPH_HOST;
156126512e3SAnatolij Gustschin 	} else {
157230f7edeSAnatolij Gustschin 		if (of_get_property(np, "fsl,invert-drvvbus", NULL))
158230f7edeSAnatolij Gustschin 			pdata->invert_drvvbus = 1;
159230f7edeSAnatolij Gustschin 
160230f7edeSAnatolij Gustschin 		if (of_get_property(np, "fsl,invert-pwr-fault", NULL))
161230f7edeSAnatolij Gustschin 			pdata->invert_pwr_fault = 1;
162230f7edeSAnatolij Gustschin 
163126512e3SAnatolij Gustschin 		/* setup mode selected in the device tree */
164126512e3SAnatolij Gustschin 		pdata->operating_mode = dev_data->op_mode;
165126512e3SAnatolij Gustschin 	}
166126512e3SAnatolij Gustschin 
167126512e3SAnatolij Gustschin 	prop = of_get_property(np, "phy_type", NULL);
168126512e3SAnatolij Gustschin 	pdata->phy_mode = determine_usb_phy(prop);
169126512e3SAnatolij Gustschin 
170126512e3SAnatolij Gustschin 	for (i = 0; i < ARRAY_SIZE(dev_data->drivers); i++) {
171126512e3SAnatolij Gustschin 		if (!dev_data->drivers[i])
172126512e3SAnatolij Gustschin 			continue;
173126512e3SAnatolij Gustschin 		usb_dev = fsl_usb2_device_register(ofdev, pdata,
174126512e3SAnatolij Gustschin 					dev_data->drivers[i], idx);
175126512e3SAnatolij Gustschin 		if (IS_ERR(usb_dev)) {
176126512e3SAnatolij Gustschin 			dev_err(&ofdev->dev, "Can't register usb device\n");
177126512e3SAnatolij Gustschin 			return PTR_ERR(usb_dev);
178126512e3SAnatolij Gustschin 		}
179126512e3SAnatolij Gustschin 	}
180126512e3SAnatolij Gustschin 	idx++;
181126512e3SAnatolij Gustschin 	return 0;
182126512e3SAnatolij Gustschin }
183126512e3SAnatolij Gustschin 
184126512e3SAnatolij Gustschin static int __devexit __unregister_subdev(struct device *dev, void *d)
185126512e3SAnatolij Gustschin {
186126512e3SAnatolij Gustschin 	platform_device_unregister(to_platform_device(dev));
187126512e3SAnatolij Gustschin 	return 0;
188126512e3SAnatolij Gustschin }
189126512e3SAnatolij Gustschin 
190126512e3SAnatolij Gustschin static int __devexit fsl_usb2_mph_dr_of_remove(struct platform_device *ofdev)
191126512e3SAnatolij Gustschin {
192126512e3SAnatolij Gustschin 	device_for_each_child(&ofdev->dev, NULL, __unregister_subdev);
193126512e3SAnatolij Gustschin 	return 0;
194126512e3SAnatolij Gustschin }
195126512e3SAnatolij Gustschin 
196230f7edeSAnatolij Gustschin #ifdef CONFIG_PPC_MPC512x
197230f7edeSAnatolij Gustschin 
198230f7edeSAnatolij Gustschin #define USBGENCTRL		0x200		/* NOTE: big endian */
199230f7edeSAnatolij Gustschin #define GC_WU_INT_CLR		(1 << 5)	/* Wakeup int clear */
200230f7edeSAnatolij Gustschin #define GC_ULPI_SEL		(1 << 4)	/* ULPI i/f select (usb0 only)*/
201230f7edeSAnatolij Gustschin #define GC_PPP			(1 << 3)	/* Inv. Port Power Polarity */
202230f7edeSAnatolij Gustschin #define GC_PFP			(1 << 2)	/* Inv. Power Fault Polarity */
203230f7edeSAnatolij Gustschin #define GC_WU_ULPI_EN		(1 << 1)	/* Wakeup on ULPI event */
204230f7edeSAnatolij Gustschin #define GC_WU_IE		(1 << 1)	/* Wakeup interrupt enable */
205230f7edeSAnatolij Gustschin 
206230f7edeSAnatolij Gustschin #define ISIPHYCTRL		0x204		/* NOTE: big endian */
207230f7edeSAnatolij Gustschin #define PHYCTRL_PHYE		(1 << 4)	/* On-chip UTMI PHY enable */
208230f7edeSAnatolij Gustschin #define PHYCTRL_BSENH		(1 << 3)	/* Bit Stuff Enable High */
209230f7edeSAnatolij Gustschin #define PHYCTRL_BSEN		(1 << 2)	/* Bit Stuff Enable */
210230f7edeSAnatolij Gustschin #define PHYCTRL_LSFE		(1 << 1)	/* Line State Filter Enable */
211230f7edeSAnatolij Gustschin #define PHYCTRL_PXE		(1 << 0)	/* PHY oscillator enable */
212230f7edeSAnatolij Gustschin 
213230f7edeSAnatolij Gustschin int fsl_usb2_mpc5121_init(struct platform_device *pdev)
214230f7edeSAnatolij Gustschin {
215230f7edeSAnatolij Gustschin 	struct fsl_usb2_platform_data *pdata = pdev->dev.platform_data;
216230f7edeSAnatolij Gustschin 	struct clk *clk;
217230f7edeSAnatolij Gustschin 	char clk_name[10];
218230f7edeSAnatolij Gustschin 	int base, clk_num;
219230f7edeSAnatolij Gustschin 
220230f7edeSAnatolij Gustschin 	base = pdev->resource->start & 0xf000;
221230f7edeSAnatolij Gustschin 	if (base == 0x3000)
222230f7edeSAnatolij Gustschin 		clk_num = 1;
223230f7edeSAnatolij Gustschin 	else if (base == 0x4000)
224230f7edeSAnatolij Gustschin 		clk_num = 2;
225230f7edeSAnatolij Gustschin 	else
226230f7edeSAnatolij Gustschin 		return -ENODEV;
227230f7edeSAnatolij Gustschin 
228230f7edeSAnatolij Gustschin 	snprintf(clk_name, sizeof(clk_name), "usb%d_clk", clk_num);
229230f7edeSAnatolij Gustschin 	clk = clk_get(&pdev->dev, clk_name);
230230f7edeSAnatolij Gustschin 	if (IS_ERR(clk)) {
231230f7edeSAnatolij Gustschin 		dev_err(&pdev->dev, "failed to get clk\n");
232230f7edeSAnatolij Gustschin 		return PTR_ERR(clk);
233230f7edeSAnatolij Gustschin 	}
234230f7edeSAnatolij Gustschin 
235230f7edeSAnatolij Gustschin 	clk_enable(clk);
236230f7edeSAnatolij Gustschin 	pdata->clk = clk;
237230f7edeSAnatolij Gustschin 
238230f7edeSAnatolij Gustschin 	if (pdata->phy_mode == FSL_USB2_PHY_UTMI_WIDE) {
239230f7edeSAnatolij Gustschin 		u32 reg = 0;
240230f7edeSAnatolij Gustschin 
241230f7edeSAnatolij Gustschin 		if (pdata->invert_drvvbus)
242230f7edeSAnatolij Gustschin 			reg |= GC_PPP;
243230f7edeSAnatolij Gustschin 
244230f7edeSAnatolij Gustschin 		if (pdata->invert_pwr_fault)
245230f7edeSAnatolij Gustschin 			reg |= GC_PFP;
246230f7edeSAnatolij Gustschin 
247230f7edeSAnatolij Gustschin 		out_be32(pdata->regs + ISIPHYCTRL, PHYCTRL_PHYE | PHYCTRL_PXE);
248230f7edeSAnatolij Gustschin 		out_be32(pdata->regs + USBGENCTRL, reg);
249230f7edeSAnatolij Gustschin 	}
250230f7edeSAnatolij Gustschin 	return 0;
251230f7edeSAnatolij Gustschin }
252230f7edeSAnatolij Gustschin 
253230f7edeSAnatolij Gustschin static void fsl_usb2_mpc5121_exit(struct platform_device *pdev)
254230f7edeSAnatolij Gustschin {
255230f7edeSAnatolij Gustschin 	struct fsl_usb2_platform_data *pdata = pdev->dev.platform_data;
256230f7edeSAnatolij Gustschin 
257230f7edeSAnatolij Gustschin 	pdata->regs = NULL;
258230f7edeSAnatolij Gustschin 
259230f7edeSAnatolij Gustschin 	if (pdata->clk) {
260230f7edeSAnatolij Gustschin 		clk_disable(pdata->clk);
261230f7edeSAnatolij Gustschin 		clk_put(pdata->clk);
262230f7edeSAnatolij Gustschin 	}
263230f7edeSAnatolij Gustschin }
264230f7edeSAnatolij Gustschin 
265cc604dddSPeter Tyser static struct fsl_usb2_platform_data fsl_usb2_mpc5121_pd = {
266230f7edeSAnatolij Gustschin 	.big_endian_desc = 1,
267230f7edeSAnatolij Gustschin 	.big_endian_mmio = 1,
268230f7edeSAnatolij Gustschin 	.es = 1,
269cc604dddSPeter Tyser 	.have_sysif_regs = 0,
270230f7edeSAnatolij Gustschin 	.le_setup_buf = 1,
271230f7edeSAnatolij Gustschin 	.init = fsl_usb2_mpc5121_init,
272230f7edeSAnatolij Gustschin 	.exit = fsl_usb2_mpc5121_exit,
273230f7edeSAnatolij Gustschin };
274230f7edeSAnatolij Gustschin #endif /* CONFIG_PPC_MPC512x */
275230f7edeSAnatolij Gustschin 
276cc604dddSPeter Tyser static struct fsl_usb2_platform_data fsl_usb2_mpc8xxx_pd = {
277cc604dddSPeter Tyser 	.have_sysif_regs = 1,
278cc604dddSPeter Tyser };
279cc604dddSPeter Tyser 
280126512e3SAnatolij Gustschin static const struct of_device_id fsl_usb2_mph_dr_of_match[] = {
281cc604dddSPeter Tyser 	{ .compatible = "fsl-usb2-mph", .data = &fsl_usb2_mpc8xxx_pd, },
282cc604dddSPeter Tyser 	{ .compatible = "fsl-usb2-dr", .data = &fsl_usb2_mpc8xxx_pd, },
283230f7edeSAnatolij Gustschin #ifdef CONFIG_PPC_MPC512x
284230f7edeSAnatolij Gustschin 	{ .compatible = "fsl,mpc5121-usb2-dr", .data = &fsl_usb2_mpc5121_pd, },
285230f7edeSAnatolij Gustschin #endif
286126512e3SAnatolij Gustschin 	{},
287126512e3SAnatolij Gustschin };
288126512e3SAnatolij Gustschin 
289126512e3SAnatolij Gustschin static struct platform_driver fsl_usb2_mph_dr_driver = {
290126512e3SAnatolij Gustschin 	.driver = {
291126512e3SAnatolij Gustschin 		.name = "fsl-usb2-mph-dr",
292126512e3SAnatolij Gustschin 		.owner = THIS_MODULE,
293126512e3SAnatolij Gustschin 		.of_match_table = fsl_usb2_mph_dr_of_match,
294126512e3SAnatolij Gustschin 	},
295126512e3SAnatolij Gustschin 	.probe	= fsl_usb2_mph_dr_of_probe,
296126512e3SAnatolij Gustschin 	.remove	= __devexit_p(fsl_usb2_mph_dr_of_remove),
297126512e3SAnatolij Gustschin };
298126512e3SAnatolij Gustschin 
299126512e3SAnatolij Gustschin static int __init fsl_usb2_mph_dr_init(void)
300126512e3SAnatolij Gustschin {
301126512e3SAnatolij Gustschin 	return platform_driver_register(&fsl_usb2_mph_dr_driver);
302126512e3SAnatolij Gustschin }
303126512e3SAnatolij Gustschin module_init(fsl_usb2_mph_dr_init);
304126512e3SAnatolij Gustschin 
305126512e3SAnatolij Gustschin static void __exit fsl_usb2_mph_dr_exit(void)
306126512e3SAnatolij Gustschin {
307126512e3SAnatolij Gustschin 	platform_driver_unregister(&fsl_usb2_mph_dr_driver);
308126512e3SAnatolij Gustschin }
309126512e3SAnatolij Gustschin module_exit(fsl_usb2_mph_dr_exit);
310126512e3SAnatolij Gustschin 
311126512e3SAnatolij Gustschin MODULE_DESCRIPTION("FSL MPH DR OF devices driver");
312126512e3SAnatolij Gustschin MODULE_AUTHOR("Anatolij Gustschin <agust@denx.de>");
313126512e3SAnatolij Gustschin MODULE_LICENSE("GPL");
314