1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Setup platform devices needed by the Freescale multi-port host
4 * and/or dual-role USB controller modules based on the description
5 * in flat device tree.
6 */
7
8 #include <linux/kernel.h>
9 #include <linux/platform_device.h>
10 #include <linux/fsl_devices.h>
11 #include <linux/err.h>
12 #include <linux/io.h>
13 #include <linux/of_platform.h>
14 #include <linux/clk.h>
15 #include <linux/module.h>
16 #include <linux/dma-mapping.h>
17
18 struct fsl_usb2_dev_data {
19 char *dr_mode; /* controller mode */
20 char *drivers[3]; /* drivers to instantiate for this mode */
21 enum fsl_usb2_operating_modes op_mode; /* operating mode */
22 };
23
24 static struct fsl_usb2_dev_data dr_mode_data[] = {
25 {
26 .dr_mode = "host",
27 .drivers = { "fsl-ehci", NULL, NULL, },
28 .op_mode = FSL_USB2_DR_HOST,
29 },
30 {
31 .dr_mode = "otg",
32 .drivers = { "fsl-usb2-otg", "fsl-ehci", "fsl-usb2-udc", },
33 .op_mode = FSL_USB2_DR_OTG,
34 },
35 {
36 .dr_mode = "peripheral",
37 .drivers = { "fsl-usb2-udc", NULL, NULL, },
38 .op_mode = FSL_USB2_DR_DEVICE,
39 },
40 };
41
get_dr_mode_data(struct device_node * np)42 static struct fsl_usb2_dev_data *get_dr_mode_data(struct device_node *np)
43 {
44 const unsigned char *prop;
45 int i;
46
47 prop = of_get_property(np, "dr_mode", NULL);
48 if (prop) {
49 for (i = 0; i < ARRAY_SIZE(dr_mode_data); i++) {
50 if (!strcmp(prop, dr_mode_data[i].dr_mode))
51 return &dr_mode_data[i];
52 }
53 }
54 pr_warn("%pOF: Invalid 'dr_mode' property, fallback to host mode\n",
55 np);
56 return &dr_mode_data[0]; /* mode not specified, use host */
57 }
58
determine_usb_phy(const char * phy_type)59 static enum fsl_usb2_phy_modes determine_usb_phy(const char *phy_type)
60 {
61 if (!phy_type)
62 return FSL_USB2_PHY_NONE;
63 if (!strcasecmp(phy_type, "ulpi"))
64 return FSL_USB2_PHY_ULPI;
65 if (!strcasecmp(phy_type, "utmi"))
66 return FSL_USB2_PHY_UTMI;
67 if (!strcasecmp(phy_type, "utmi_wide"))
68 return FSL_USB2_PHY_UTMI_WIDE;
69 if (!strcasecmp(phy_type, "utmi_dual"))
70 return FSL_USB2_PHY_UTMI_DUAL;
71 if (!strcasecmp(phy_type, "serial"))
72 return FSL_USB2_PHY_SERIAL;
73
74 return FSL_USB2_PHY_NONE;
75 }
76
fsl_usb2_device_register(struct platform_device * ofdev,struct fsl_usb2_platform_data * pdata,const char * name,int id)77 static struct platform_device *fsl_usb2_device_register(
78 struct platform_device *ofdev,
79 struct fsl_usb2_platform_data *pdata,
80 const char *name, int id)
81 {
82 struct platform_device *pdev;
83 const struct resource *res = ofdev->resource;
84 unsigned int num = ofdev->num_resources;
85 int retval;
86
87 pdev = platform_device_alloc(name, id);
88 if (!pdev) {
89 retval = -ENOMEM;
90 goto error;
91 }
92
93 pdev->dev.parent = &ofdev->dev;
94
95 pdev->dev.coherent_dma_mask = ofdev->dev.coherent_dma_mask;
96
97 if (!pdev->dev.dma_mask) {
98 pdev->dev.dma_mask = &ofdev->dev.coherent_dma_mask;
99 } else {
100 retval = dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
101 if (retval)
102 goto error;
103 }
104
105 retval = platform_device_add_data(pdev, pdata, sizeof(*pdata));
106 if (retval)
107 goto error;
108
109 if (num) {
110 retval = platform_device_add_resources(pdev, res, num);
111 if (retval)
112 goto error;
113 }
114
115 device_set_of_node_from_dev(&pdev->dev, &ofdev->dev);
116
117 retval = platform_device_add(pdev);
118 if (retval)
119 goto error;
120
121 return pdev;
122
123 error:
124 platform_device_put(pdev);
125 return ERR_PTR(retval);
126 }
127
128 static const struct of_device_id fsl_usb2_mph_dr_of_match[];
129
usb_get_ver_info(struct device_node * np)130 static enum fsl_usb2_controller_ver usb_get_ver_info(struct device_node *np)
131 {
132 enum fsl_usb2_controller_ver ver = FSL_USB_VER_NONE;
133
134 /*
135 * returns 1 for usb controller version 1.6
136 * returns 2 for usb controller version 2.2
137 * returns 3 for usb controller version 2.4
138 * returns 4 for usb controller version 2.5
139 * returns 0 otherwise
140 */
141 if (of_device_is_compatible(np, "fsl-usb2-dr")) {
142 if (of_device_is_compatible(np, "fsl-usb2-dr-v1.6"))
143 ver = FSL_USB_VER_1_6;
144 else if (of_device_is_compatible(np, "fsl-usb2-dr-v2.2"))
145 ver = FSL_USB_VER_2_2;
146 else if (of_device_is_compatible(np, "fsl-usb2-dr-v2.4"))
147 ver = FSL_USB_VER_2_4;
148 else if (of_device_is_compatible(np, "fsl-usb2-dr-v2.5"))
149 ver = FSL_USB_VER_2_5;
150 else /* for previous controller versions */
151 ver = FSL_USB_VER_OLD;
152
153 if (ver > FSL_USB_VER_NONE)
154 return ver;
155 }
156
157 if (of_device_is_compatible(np, "fsl,mpc5121-usb2-dr"))
158 return FSL_USB_VER_OLD;
159
160 if (of_device_is_compatible(np, "fsl-usb2-mph")) {
161 if (of_device_is_compatible(np, "fsl-usb2-mph-v1.6"))
162 ver = FSL_USB_VER_1_6;
163 else if (of_device_is_compatible(np, "fsl-usb2-mph-v2.2"))
164 ver = FSL_USB_VER_2_2;
165 else if (of_device_is_compatible(np, "fsl-usb2-mph-v2.4"))
166 ver = FSL_USB_VER_2_4;
167 else if (of_device_is_compatible(np, "fsl-usb2-mph-v2.5"))
168 ver = FSL_USB_VER_2_5;
169 else /* for previous controller versions */
170 ver = FSL_USB_VER_OLD;
171 }
172
173 return ver;
174 }
175
fsl_usb2_mph_dr_of_probe(struct platform_device * ofdev)176 static int fsl_usb2_mph_dr_of_probe(struct platform_device *ofdev)
177 {
178 struct device_node *np = ofdev->dev.of_node;
179 struct platform_device *usb_dev;
180 struct fsl_usb2_platform_data data, *pdata;
181 struct fsl_usb2_dev_data *dev_data;
182 const struct of_device_id *match;
183 const unsigned char *prop;
184 static unsigned int idx;
185 int i;
186
187 if (!of_device_is_available(np))
188 return -ENODEV;
189
190 match = of_match_device(fsl_usb2_mph_dr_of_match, &ofdev->dev);
191 if (!match)
192 return -ENODEV;
193
194 pdata = &data;
195 if (match->data)
196 memcpy(pdata, match->data, sizeof(data));
197 else
198 memset(pdata, 0, sizeof(data));
199
200 dev_data = get_dr_mode_data(np);
201
202 if (of_device_is_compatible(np, "fsl-usb2-mph")) {
203 if (of_get_property(np, "port0", NULL))
204 pdata->port_enables |= FSL_USB2_PORT0_ENABLED;
205
206 if (of_get_property(np, "port1", NULL))
207 pdata->port_enables |= FSL_USB2_PORT1_ENABLED;
208
209 pdata->operating_mode = FSL_USB2_MPH_HOST;
210 } else {
211 if (of_get_property(np, "fsl,invert-drvvbus", NULL))
212 pdata->invert_drvvbus = 1;
213
214 if (of_get_property(np, "fsl,invert-pwr-fault", NULL))
215 pdata->invert_pwr_fault = 1;
216
217 /* setup mode selected in the device tree */
218 pdata->operating_mode = dev_data->op_mode;
219 }
220
221 prop = of_get_property(np, "phy_type", NULL);
222 pdata->phy_mode = determine_usb_phy(prop);
223 pdata->controller_ver = usb_get_ver_info(np);
224
225 /* Activate Erratum by reading property in device tree */
226 pdata->has_fsl_erratum_a007792 =
227 of_property_read_bool(np, "fsl,usb-erratum-a007792");
228 pdata->has_fsl_erratum_a005275 =
229 of_property_read_bool(np, "fsl,usb-erratum-a005275");
230 pdata->has_fsl_erratum_a005697 =
231 of_property_read_bool(np, "fsl,usb_erratum-a005697");
232 pdata->has_fsl_erratum_a006918 =
233 of_property_read_bool(np, "fsl,usb_erratum-a006918");
234 pdata->has_fsl_erratum_14 =
235 of_property_read_bool(np, "fsl,usb_erratum-14");
236
237 /*
238 * Determine whether phy_clk_valid needs to be checked
239 * by reading property in device tree
240 */
241 pdata->check_phy_clk_valid =
242 of_property_read_bool(np, "phy-clk-valid");
243
244 if (pdata->have_sysif_regs) {
245 if (pdata->controller_ver == FSL_USB_VER_NONE) {
246 dev_warn(&ofdev->dev, "Could not get controller version\n");
247 return -ENODEV;
248 }
249 }
250
251 for (i = 0; i < ARRAY_SIZE(dev_data->drivers); i++) {
252 if (!dev_data->drivers[i])
253 continue;
254 usb_dev = fsl_usb2_device_register(ofdev, pdata,
255 dev_data->drivers[i], idx);
256 if (IS_ERR(usb_dev)) {
257 dev_err(&ofdev->dev, "Can't register usb device\n");
258 return PTR_ERR(usb_dev);
259 }
260 }
261 idx++;
262 return 0;
263 }
264
__unregister_subdev(struct device * dev,void * d)265 static int __unregister_subdev(struct device *dev, void *d)
266 {
267 platform_device_unregister(to_platform_device(dev));
268 return 0;
269 }
270
fsl_usb2_mph_dr_of_remove(struct platform_device * ofdev)271 static int fsl_usb2_mph_dr_of_remove(struct platform_device *ofdev)
272 {
273 device_for_each_child(&ofdev->dev, NULL, __unregister_subdev);
274 return 0;
275 }
276
277 #ifdef CONFIG_PPC_MPC512x
278
279 #define USBGENCTRL 0x200 /* NOTE: big endian */
280 #define GC_WU_INT_CLR (1 << 5) /* Wakeup int clear */
281 #define GC_ULPI_SEL (1 << 4) /* ULPI i/f select (usb0 only)*/
282 #define GC_PPP (1 << 3) /* Inv. Port Power Polarity */
283 #define GC_PFP (1 << 2) /* Inv. Power Fault Polarity */
284 #define GC_WU_ULPI_EN (1 << 1) /* Wakeup on ULPI event */
285 #define GC_WU_IE (1 << 1) /* Wakeup interrupt enable */
286
287 #define ISIPHYCTRL 0x204 /* NOTE: big endian */
288 #define PHYCTRL_PHYE (1 << 4) /* On-chip UTMI PHY enable */
289 #define PHYCTRL_BSENH (1 << 3) /* Bit Stuff Enable High */
290 #define PHYCTRL_BSEN (1 << 2) /* Bit Stuff Enable */
291 #define PHYCTRL_LSFE (1 << 1) /* Line State Filter Enable */
292 #define PHYCTRL_PXE (1 << 0) /* PHY oscillator enable */
293
fsl_usb2_mpc5121_init(struct platform_device * pdev)294 int fsl_usb2_mpc5121_init(struct platform_device *pdev)
295 {
296 struct fsl_usb2_platform_data *pdata = dev_get_platdata(&pdev->dev);
297 struct clk *clk;
298 int err;
299
300 clk = devm_clk_get(pdev->dev.parent, "ipg");
301 if (IS_ERR(clk)) {
302 dev_err(&pdev->dev, "failed to get clk\n");
303 return PTR_ERR(clk);
304 }
305 err = clk_prepare_enable(clk);
306 if (err) {
307 dev_err(&pdev->dev, "failed to enable clk\n");
308 return err;
309 }
310 pdata->clk = clk;
311
312 if (pdata->phy_mode == FSL_USB2_PHY_UTMI_WIDE) {
313 u32 reg = 0;
314
315 if (pdata->invert_drvvbus)
316 reg |= GC_PPP;
317
318 if (pdata->invert_pwr_fault)
319 reg |= GC_PFP;
320
321 out_be32(pdata->regs + ISIPHYCTRL, PHYCTRL_PHYE | PHYCTRL_PXE);
322 out_be32(pdata->regs + USBGENCTRL, reg);
323 }
324 return 0;
325 }
326
fsl_usb2_mpc5121_exit(struct platform_device * pdev)327 static void fsl_usb2_mpc5121_exit(struct platform_device *pdev)
328 {
329 struct fsl_usb2_platform_data *pdata = dev_get_platdata(&pdev->dev);
330
331 pdata->regs = NULL;
332
333 if (pdata->clk)
334 clk_disable_unprepare(pdata->clk);
335 }
336
337 static struct fsl_usb2_platform_data fsl_usb2_mpc5121_pd = {
338 .big_endian_desc = 1,
339 .big_endian_mmio = 1,
340 .es = 1,
341 .have_sysif_regs = 0,
342 .le_setup_buf = 1,
343 .init = fsl_usb2_mpc5121_init,
344 .exit = fsl_usb2_mpc5121_exit,
345 };
346 #endif /* CONFIG_PPC_MPC512x */
347
348 static struct fsl_usb2_platform_data fsl_usb2_mpc8xxx_pd = {
349 .have_sysif_regs = 1,
350 };
351
352 static const struct of_device_id fsl_usb2_mph_dr_of_match[] = {
353 { .compatible = "fsl-usb2-mph", .data = &fsl_usb2_mpc8xxx_pd, },
354 { .compatible = "fsl-usb2-dr", .data = &fsl_usb2_mpc8xxx_pd, },
355 #ifdef CONFIG_PPC_MPC512x
356 { .compatible = "fsl,mpc5121-usb2-dr", .data = &fsl_usb2_mpc5121_pd, },
357 #endif
358 {},
359 };
360 MODULE_DEVICE_TABLE(of, fsl_usb2_mph_dr_of_match);
361
362 static struct platform_driver fsl_usb2_mph_dr_driver = {
363 .driver = {
364 .name = "fsl-usb2-mph-dr",
365 .of_match_table = fsl_usb2_mph_dr_of_match,
366 },
367 .probe = fsl_usb2_mph_dr_of_probe,
368 .remove = fsl_usb2_mph_dr_of_remove,
369 };
370
371 module_platform_driver(fsl_usb2_mph_dr_driver);
372
373 MODULE_DESCRIPTION("FSL MPH DR OF devices driver");
374 MODULE_AUTHOR("Anatolij Gustschin <agust@denx.de>");
375 MODULE_LICENSE("GPL");
376