Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (c) 2014-2016, NVIDIA CORPORATION. All rights reserved.
4 */
5
6#include <linux/delay.h>
7#include <linux/io.h>
8#include <linux/mailbox_client.h>
9#include <linux/module.h>
10#include <linux/of.h>
11#include <linux/of_device.h>
12#include <linux/phy/phy.h>
13#include <linux/phy/tegra/xusb.h>
14#include <linux/platform_device.h>
15#include <linux/regulator/consumer.h>
16#include <linux/reset.h>
17#include <linux/slab.h>
18#include <linux/workqueue.h>
19
20#include <soc/tegra/fuse.h>
21
22#include "xusb.h"
23
24static struct phy *tegra_xusb_pad_of_xlate(struct device *dev,
25 struct of_phandle_args *args)
26{
27 struct tegra_xusb_pad *pad = dev_get_drvdata(dev);
28 struct phy *phy = NULL;
29 unsigned int i;
30
31 if (args->args_count != 0)
32 return ERR_PTR(-EINVAL);
33
34 for (i = 0; i < pad->soc->num_lanes; i++) {
35 if (!pad->lanes[i])
36 continue;
37
38 if (pad->lanes[i]->dev.of_node == args->np) {
39 phy = pad->lanes[i];
40 break;
41 }
42 }
43
44 if (phy == NULL)
45 phy = ERR_PTR(-ENODEV);
46
47 return phy;
48}
49
50static const struct of_device_id tegra_xusb_padctl_of_match[] = {
51#if defined(CONFIG_ARCH_TEGRA_124_SOC) || defined(CONFIG_ARCH_TEGRA_132_SOC)
52 {
53 .compatible = "nvidia,tegra124-xusb-padctl",
54 .data = &tegra124_xusb_padctl_soc,
55 },
56#endif
57#if defined(CONFIG_ARCH_TEGRA_210_SOC)
58 {
59 .compatible = "nvidia,tegra210-xusb-padctl",
60 .data = &tegra210_xusb_padctl_soc,
61 },
62#endif
63#if defined(CONFIG_ARCH_TEGRA_186_SOC)
64 {
65 .compatible = "nvidia,tegra186-xusb-padctl",
66 .data = &tegra186_xusb_padctl_soc,
67 },
68#endif
69#if defined(CONFIG_ARCH_TEGRA_194_SOC)
70 {
71 .compatible = "nvidia,tegra194-xusb-padctl",
72 .data = &tegra194_xusb_padctl_soc,
73 },
74#endif
75 { }
76};
77MODULE_DEVICE_TABLE(of, tegra_xusb_padctl_of_match);
78
79static struct device_node *
80tegra_xusb_find_pad_node(struct tegra_xusb_padctl *padctl, const char *name)
81{
82 struct device_node *pads, *np;
83
84 pads = of_get_child_by_name(padctl->dev->of_node, "pads");
85 if (!pads)
86 return NULL;
87
88 np = of_get_child_by_name(pads, name);
89 of_node_put(pads);
90
91 return np;
92}
93
94static struct device_node *
95tegra_xusb_pad_find_phy_node(struct tegra_xusb_pad *pad, unsigned int index)
96{
97 struct device_node *np, *lanes;
98
99 lanes = of_get_child_by_name(pad->dev.of_node, "lanes");
100 if (!lanes)
101 return NULL;
102
103 np = of_get_child_by_name(lanes, pad->soc->lanes[index].name);
104 of_node_put(lanes);
105
106 return np;
107}
108
109int tegra_xusb_lane_parse_dt(struct tegra_xusb_lane *lane,
110 struct device_node *np)
111{
112 struct device *dev = &lane->pad->dev;
113 const char *function;
114 int err;
115
116 err = of_property_read_string(np, "nvidia,function", &function);
117 if (err < 0)
118 return err;
119
120 err = match_string(lane->soc->funcs, lane->soc->num_funcs, function);
121 if (err < 0) {
122 dev_err(dev, "invalid function \"%s\" for lane \"%pOFn\"\n",
123 function, np);
124 return err;
125 }
126
127 lane->function = err;
128
129 return 0;
130}
131
132static void tegra_xusb_lane_destroy(struct phy *phy)
133{
134 if (phy) {
135 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
136
137 lane->pad->ops->remove(lane);
138 phy_destroy(phy);
139 }
140}
141
142static void tegra_xusb_pad_release(struct device *dev)
143{
144 struct tegra_xusb_pad *pad = to_tegra_xusb_pad(dev);
145
146 pad->soc->ops->remove(pad);
147}
148
149static struct device_type tegra_xusb_pad_type = {
150 .release = tegra_xusb_pad_release,
151};
152
153int tegra_xusb_pad_init(struct tegra_xusb_pad *pad,
154 struct tegra_xusb_padctl *padctl,
155 struct device_node *np)
156{
157 int err;
158
159 device_initialize(&pad->dev);
160 INIT_LIST_HEAD(&pad->list);
161 pad->dev.parent = padctl->dev;
162 pad->dev.type = &tegra_xusb_pad_type;
163 pad->dev.of_node = np;
164 pad->padctl = padctl;
165
166 err = dev_set_name(&pad->dev, "%s", pad->soc->name);
167 if (err < 0)
168 goto unregister;
169
170 err = device_add(&pad->dev);
171 if (err < 0)
172 goto unregister;
173
174 return 0;
175
176unregister:
177 device_unregister(&pad->dev);
178 return err;
179}
180
181int tegra_xusb_pad_register(struct tegra_xusb_pad *pad,
182 const struct phy_ops *ops)
183{
184 struct device_node *children;
185 struct phy *lane;
186 unsigned int i;
187 int err;
188
189 children = of_get_child_by_name(pad->dev.of_node, "lanes");
190 if (!children)
191 return -ENODEV;
192
193 pad->lanes = devm_kcalloc(&pad->dev, pad->soc->num_lanes, sizeof(lane),
194 GFP_KERNEL);
195 if (!pad->lanes) {
196 of_node_put(children);
197 return -ENOMEM;
198 }
199
200 for (i = 0; i < pad->soc->num_lanes; i++) {
201 struct device_node *np = tegra_xusb_pad_find_phy_node(pad, i);
202 struct tegra_xusb_lane *lane;
203
204 /* skip disabled lanes */
205 if (!np || !of_device_is_available(np)) {
206 of_node_put(np);
207 continue;
208 }
209
210 pad->lanes[i] = phy_create(&pad->dev, np, ops);
211 if (IS_ERR(pad->lanes[i])) {
212 err = PTR_ERR(pad->lanes[i]);
213 of_node_put(np);
214 goto remove;
215 }
216
217 lane = pad->ops->probe(pad, np, i);
218 if (IS_ERR(lane)) {
219 phy_destroy(pad->lanes[i]);
220 err = PTR_ERR(lane);
221 goto remove;
222 }
223
224 list_add_tail(&lane->list, &pad->padctl->lanes);
225 phy_set_drvdata(pad->lanes[i], lane);
226 }
227
228 pad->provider = of_phy_provider_register_full(&pad->dev, children,
229 tegra_xusb_pad_of_xlate);
230 if (IS_ERR(pad->provider)) {
231 err = PTR_ERR(pad->provider);
232 goto remove;
233 }
234
235 return 0;
236
237remove:
238 while (i--)
239 tegra_xusb_lane_destroy(pad->lanes[i]);
240
241 of_node_put(children);
242
243 return err;
244}
245
246void tegra_xusb_pad_unregister(struct tegra_xusb_pad *pad)
247{
248 unsigned int i = pad->soc->num_lanes;
249
250 of_phy_provider_unregister(pad->provider);
251
252 while (i--)
253 tegra_xusb_lane_destroy(pad->lanes[i]);
254
255 device_unregister(&pad->dev);
256}
257
258static struct tegra_xusb_pad *
259tegra_xusb_pad_create(struct tegra_xusb_padctl *padctl,
260 const struct tegra_xusb_pad_soc *soc)
261{
262 struct tegra_xusb_pad *pad;
263 struct device_node *np;
264 int err;
265
266 np = tegra_xusb_find_pad_node(padctl, soc->name);
267 if (!np || !of_device_is_available(np))
268 return NULL;
269
270 pad = soc->ops->probe(padctl, soc, np);
271 if (IS_ERR(pad)) {
272 err = PTR_ERR(pad);
273 dev_err(padctl->dev, "failed to create pad %s: %d\n",
274 soc->name, err);
275 return ERR_PTR(err);
276 }
277
278 /* XXX move this into ->probe() to avoid string comparison */
279 if (strcmp(soc->name, "pcie") == 0)
280 padctl->pcie = pad;
281
282 if (strcmp(soc->name, "sata") == 0)
283 padctl->sata = pad;
284
285 if (strcmp(soc->name, "usb2") == 0)
286 padctl->usb2 = pad;
287
288 if (strcmp(soc->name, "ulpi") == 0)
289 padctl->ulpi = pad;
290
291 if (strcmp(soc->name, "hsic") == 0)
292 padctl->hsic = pad;
293
294 return pad;
295}
296
297static void __tegra_xusb_remove_pads(struct tegra_xusb_padctl *padctl)
298{
299 struct tegra_xusb_pad *pad, *tmp;
300
301 list_for_each_entry_safe_reverse(pad, tmp, &padctl->pads, list) {
302 list_del(&pad->list);
303 tegra_xusb_pad_unregister(pad);
304 }
305}
306
307static void tegra_xusb_remove_pads(struct tegra_xusb_padctl *padctl)
308{
309 mutex_lock(&padctl->lock);
310 __tegra_xusb_remove_pads(padctl);
311 mutex_unlock(&padctl->lock);
312}
313
314static void tegra_xusb_lane_program(struct tegra_xusb_lane *lane)
315{
316 struct tegra_xusb_padctl *padctl = lane->pad->padctl;
317 const struct tegra_xusb_lane_soc *soc = lane->soc;
318 u32 value;
319
320 /* skip single function lanes */
321 if (soc->num_funcs < 2)
322 return;
323
324 /* choose function */
325 value = padctl_readl(padctl, soc->offset);
326 value &= ~(soc->mask << soc->shift);
327 value |= lane->function << soc->shift;
328 padctl_writel(padctl, value, soc->offset);
329}
330
331static void tegra_xusb_pad_program(struct tegra_xusb_pad *pad)
332{
333 unsigned int i;
334
335 for (i = 0; i < pad->soc->num_lanes; i++) {
336 struct tegra_xusb_lane *lane;
337
338 if (pad->lanes[i]) {
339 lane = phy_get_drvdata(pad->lanes[i]);
340 tegra_xusb_lane_program(lane);
341 }
342 }
343}
344
345static int tegra_xusb_setup_pads(struct tegra_xusb_padctl *padctl)
346{
347 struct tegra_xusb_pad *pad;
348 unsigned int i;
349
350 mutex_lock(&padctl->lock);
351
352 for (i = 0; i < padctl->soc->num_pads; i++) {
353 const struct tegra_xusb_pad_soc *soc = padctl->soc->pads[i];
354 int err;
355
356 pad = tegra_xusb_pad_create(padctl, soc);
357 if (IS_ERR(pad)) {
358 err = PTR_ERR(pad);
359 dev_err(padctl->dev, "failed to create pad %s: %d\n",
360 soc->name, err);
361 __tegra_xusb_remove_pads(padctl);
362 mutex_unlock(&padctl->lock);
363 return err;
364 }
365
366 if (!pad)
367 continue;
368
369 list_add_tail(&pad->list, &padctl->pads);
370 }
371
372 list_for_each_entry(pad, &padctl->pads, list)
373 tegra_xusb_pad_program(pad);
374
375 mutex_unlock(&padctl->lock);
376 return 0;
377}
378
379static bool tegra_xusb_lane_check(struct tegra_xusb_lane *lane,
380 const char *function)
381{
382 const char *func = lane->soc->funcs[lane->function];
383
384 return strcmp(function, func) == 0;
385}
386
387struct tegra_xusb_lane *tegra_xusb_find_lane(struct tegra_xusb_padctl *padctl,
388 const char *type,
389 unsigned int index)
390{
391 struct tegra_xusb_lane *lane, *hit = ERR_PTR(-ENODEV);
392 char *name;
393
394 name = kasprintf(GFP_KERNEL, "%s-%u", type, index);
395 if (!name)
396 return ERR_PTR(-ENOMEM);
397
398 list_for_each_entry(lane, &padctl->lanes, list) {
399 if (strcmp(lane->soc->name, name) == 0) {
400 hit = lane;
401 break;
402 }
403 }
404
405 kfree(name);
406 return hit;
407}
408
409struct tegra_xusb_lane *
410tegra_xusb_port_find_lane(struct tegra_xusb_port *port,
411 const struct tegra_xusb_lane_map *map,
412 const char *function)
413{
414 struct tegra_xusb_lane *lane, *match = ERR_PTR(-ENODEV);
415
416 for (; map->type; map++) {
417 if (port->index != map->port)
418 continue;
419
420 lane = tegra_xusb_find_lane(port->padctl, map->type,
421 map->index);
422 if (IS_ERR(lane))
423 continue;
424
425 if (!tegra_xusb_lane_check(lane, function))
426 continue;
427
428 if (!IS_ERR(match))
429 dev_err(&port->dev, "conflicting match: %s-%u / %s\n",
430 map->type, map->index, match->soc->name);
431 else
432 match = lane;
433 }
434
435 return match;
436}
437
438static struct device_node *
439tegra_xusb_find_port_node(struct tegra_xusb_padctl *padctl, const char *type,
440 unsigned int index)
441{
442 struct device_node *ports, *np;
443 char *name;
444
445 ports = of_get_child_by_name(padctl->dev->of_node, "ports");
446 if (!ports)
447 return NULL;
448
449 name = kasprintf(GFP_KERNEL, "%s-%u", type, index);
450 if (!name) {
451 of_node_put(ports);
452 return ERR_PTR(-ENOMEM);
453 }
454 np = of_get_child_by_name(ports, name);
455 kfree(name);
456 of_node_put(ports);
457
458 return np;
459}
460
461struct tegra_xusb_port *
462tegra_xusb_find_port(struct tegra_xusb_padctl *padctl, const char *type,
463 unsigned int index)
464{
465 struct tegra_xusb_port *port;
466 struct device_node *np;
467
468 np = tegra_xusb_find_port_node(padctl, type, index);
469 if (!np)
470 return NULL;
471
472 list_for_each_entry(port, &padctl->ports, list) {
473 if (np == port->dev.of_node) {
474 of_node_put(np);
475 return port;
476 }
477 }
478
479 of_node_put(np);
480
481 return NULL;
482}
483
484struct tegra_xusb_usb2_port *
485tegra_xusb_find_usb2_port(struct tegra_xusb_padctl *padctl, unsigned int index)
486{
487 struct tegra_xusb_port *port;
488
489 port = tegra_xusb_find_port(padctl, "usb2", index);
490 if (port)
491 return to_usb2_port(port);
492
493 return NULL;
494}
495
496struct tegra_xusb_usb3_port *
497tegra_xusb_find_usb3_port(struct tegra_xusb_padctl *padctl, unsigned int index)
498{
499 struct tegra_xusb_port *port;
500
501 port = tegra_xusb_find_port(padctl, "usb3", index);
502 if (port)
503 return to_usb3_port(port);
504
505 return NULL;
506}
507
508static void tegra_xusb_port_release(struct device *dev)
509{
510 struct tegra_xusb_port *port = to_tegra_xusb_port(dev);
511
512 if (port->ops->release)
513 port->ops->release(port);
514}
515
516static struct device_type tegra_xusb_port_type = {
517 .release = tegra_xusb_port_release,
518};
519
520static int tegra_xusb_port_init(struct tegra_xusb_port *port,
521 struct tegra_xusb_padctl *padctl,
522 struct device_node *np,
523 const char *name,
524 unsigned int index)
525{
526 int err;
527
528 INIT_LIST_HEAD(&port->list);
529 port->padctl = padctl;
530 port->index = index;
531
532 device_initialize(&port->dev);
533 port->dev.type = &tegra_xusb_port_type;
534 port->dev.of_node = of_node_get(np);
535 port->dev.parent = padctl->dev;
536
537 err = dev_set_name(&port->dev, "%s-%u", name, index);
538 if (err < 0)
539 goto unregister;
540
541 err = device_add(&port->dev);
542 if (err < 0)
543 goto unregister;
544
545 return 0;
546
547unregister:
548 device_unregister(&port->dev);
549 return err;
550}
551
552static void tegra_xusb_port_unregister(struct tegra_xusb_port *port)
553{
554 if (!IS_ERR_OR_NULL(port->usb_role_sw)) {
555 of_platform_depopulate(&port->dev);
556 usb_role_switch_unregister(port->usb_role_sw);
557 cancel_work_sync(&port->usb_phy_work);
558 usb_remove_phy(&port->usb_phy);
559 }
560
561 if (port->ops->remove)
562 port->ops->remove(port);
563
564 device_unregister(&port->dev);
565}
566
567static const char *const modes[] = {
568 [USB_DR_MODE_UNKNOWN] = "",
569 [USB_DR_MODE_HOST] = "host",
570 [USB_DR_MODE_PERIPHERAL] = "peripheral",
571 [USB_DR_MODE_OTG] = "otg",
572};
573
574static const char * const usb_roles[] = {
575 [USB_ROLE_NONE] = "none",
576 [USB_ROLE_HOST] = "host",
577 [USB_ROLE_DEVICE] = "device",
578};
579
580static enum usb_phy_events to_usb_phy_event(enum usb_role role)
581{
582 switch (role) {
583 case USB_ROLE_DEVICE:
584 return USB_EVENT_VBUS;
585
586 case USB_ROLE_HOST:
587 return USB_EVENT_ID;
588
589 default:
590 return USB_EVENT_NONE;
591 }
592}
593
594static void tegra_xusb_usb_phy_work(struct work_struct *work)
595{
596 struct tegra_xusb_port *port = container_of(work,
597 struct tegra_xusb_port,
598 usb_phy_work);
599 enum usb_role role = usb_role_switch_get_role(port->usb_role_sw);
600
601 usb_phy_set_event(&port->usb_phy, to_usb_phy_event(role));
602
603 dev_dbg(&port->dev, "%s(): calling notifier for role %s\n", __func__,
604 usb_roles[role]);
605
606 atomic_notifier_call_chain(&port->usb_phy.notifier, 0, &port->usb_phy);
607}
608
609static int tegra_xusb_role_sw_set(struct usb_role_switch *sw,
610 enum usb_role role)
611{
612 struct tegra_xusb_port *port = usb_role_switch_get_drvdata(sw);
613
614 dev_dbg(&port->dev, "%s(): role %s\n", __func__, usb_roles[role]);
615
616 schedule_work(&port->usb_phy_work);
617
618 return 0;
619}
620
621static int tegra_xusb_set_peripheral(struct usb_otg *otg,
622 struct usb_gadget *gadget)
623{
624 struct tegra_xusb_port *port = container_of(otg->usb_phy,
625 struct tegra_xusb_port,
626 usb_phy);
627
628 if (gadget != NULL)
629 schedule_work(&port->usb_phy_work);
630
631 return 0;
632}
633
634static int tegra_xusb_set_host(struct usb_otg *otg, struct usb_bus *host)
635{
636 struct tegra_xusb_port *port = container_of(otg->usb_phy,
637 struct tegra_xusb_port,
638 usb_phy);
639
640 if (host != NULL)
641 schedule_work(&port->usb_phy_work);
642
643 return 0;
644}
645
646
647static int tegra_xusb_setup_usb_role_switch(struct tegra_xusb_port *port)
648{
649 struct tegra_xusb_lane *lane;
650 struct usb_role_switch_desc role_sx_desc = {
651 .fwnode = dev_fwnode(&port->dev),
652 .set = tegra_xusb_role_sw_set,
653 };
654 int err = 0;
655
656 /*
657 * USB role switch driver needs parent driver owner info. This is a
658 * suboptimal solution. TODO: Need to revisit this in a follow-up patch
659 * where an optimal solution is possible with changes to USB role
660 * switch driver.
661 */
662 port->dev.driver = devm_kzalloc(&port->dev,
663 sizeof(struct device_driver),
664 GFP_KERNEL);
665 port->dev.driver->owner = THIS_MODULE;
666
667 port->usb_role_sw = usb_role_switch_register(&port->dev,
668 &role_sx_desc);
669 if (IS_ERR(port->usb_role_sw)) {
670 err = PTR_ERR(port->usb_role_sw);
671 dev_err(&port->dev, "failed to register USB role switch: %d",
672 err);
673 return err;
674 }
675
676 INIT_WORK(&port->usb_phy_work, tegra_xusb_usb_phy_work);
677 usb_role_switch_set_drvdata(port->usb_role_sw, port);
678
679 port->usb_phy.otg = devm_kzalloc(&port->dev, sizeof(struct usb_otg),
680 GFP_KERNEL);
681 if (!port->usb_phy.otg)
682 return -ENOMEM;
683
684 lane = tegra_xusb_find_lane(port->padctl, "usb2", port->index);
685
686 /*
687 * Assign phy dev to usb-phy dev. Host/device drivers can use phy
688 * reference to retrieve usb-phy details.
689 */
690 port->usb_phy.dev = &lane->pad->lanes[port->index]->dev;
691 port->usb_phy.dev->driver = port->padctl->dev->driver;
692 port->usb_phy.otg->usb_phy = &port->usb_phy;
693 port->usb_phy.otg->set_peripheral = tegra_xusb_set_peripheral;
694 port->usb_phy.otg->set_host = tegra_xusb_set_host;
695
696 err = usb_add_phy_dev(&port->usb_phy);
697 if (err < 0) {
698 dev_err(&port->dev, "Failed to add USB PHY: %d\n", err);
699 return err;
700 }
701
702 /* populate connector entry */
703 of_platform_populate(port->dev.of_node, NULL, NULL, &port->dev);
704
705 return err;
706}
707
708static int tegra_xusb_usb2_port_parse_dt(struct tegra_xusb_usb2_port *usb2)
709{
710 struct tegra_xusb_port *port = &usb2->base;
711 struct device_node *np = port->dev.of_node;
712 const char *mode;
713 int err;
714
715 usb2->internal = of_property_read_bool(np, "nvidia,internal");
716
717 if (!of_property_read_string(np, "mode", &mode)) {
718 int err = match_string(modes, ARRAY_SIZE(modes), mode);
719 if (err < 0) {
720 dev_err(&port->dev, "invalid value %s for \"mode\"\n",
721 mode);
722 usb2->mode = USB_DR_MODE_UNKNOWN;
723 } else {
724 usb2->mode = err;
725 }
726 } else {
727 usb2->mode = USB_DR_MODE_HOST;
728 }
729
730 /* usb-role-switch property is mandatory for OTG/Peripheral modes */
731 if (usb2->mode == USB_DR_MODE_PERIPHERAL ||
732 usb2->mode == USB_DR_MODE_OTG) {
733 if (of_property_read_bool(np, "usb-role-switch")) {
734 err = tegra_xusb_setup_usb_role_switch(port);
735 if (err < 0)
736 return err;
737 } else {
738 dev_err(&port->dev, "usb-role-switch not found for %s mode",
739 modes[usb2->mode]);
740 return -EINVAL;
741 }
742 }
743
744 usb2->supply = regulator_get(&port->dev, "vbus");
745 return PTR_ERR_OR_ZERO(usb2->supply);
746}
747
748static int tegra_xusb_add_usb2_port(struct tegra_xusb_padctl *padctl,
749 unsigned int index)
750{
751 struct tegra_xusb_usb2_port *usb2;
752 struct device_node *np;
753 int err = 0;
754
755 /*
756 * USB2 ports don't require additional properties, but if the port is
757 * marked as disabled there is no reason to register it.
758 */
759 np = tegra_xusb_find_port_node(padctl, "usb2", index);
760 if (!np || !of_device_is_available(np))
761 goto out;
762
763 usb2 = kzalloc(sizeof(*usb2), GFP_KERNEL);
764 if (!usb2) {
765 err = -ENOMEM;
766 goto out;
767 }
768
769 err = tegra_xusb_port_init(&usb2->base, padctl, np, "usb2", index);
770 if (err < 0)
771 goto out;
772
773 usb2->base.ops = padctl->soc->ports.usb2.ops;
774
775 usb2->base.lane = usb2->base.ops->map(&usb2->base);
776 if (IS_ERR(usb2->base.lane)) {
777 err = PTR_ERR(usb2->base.lane);
778 goto out;
779 }
780
781 err = tegra_xusb_usb2_port_parse_dt(usb2);
782 if (err < 0) {
783 tegra_xusb_port_unregister(&usb2->base);
784 goto out;
785 }
786
787 list_add_tail(&usb2->base.list, &padctl->ports);
788
789out:
790 of_node_put(np);
791 return err;
792}
793
794void tegra_xusb_usb2_port_release(struct tegra_xusb_port *port)
795{
796 struct tegra_xusb_usb2_port *usb2 = to_usb2_port(port);
797
798 kfree(usb2);
799}
800
801void tegra_xusb_usb2_port_remove(struct tegra_xusb_port *port)
802{
803 struct tegra_xusb_usb2_port *usb2 = to_usb2_port(port);
804
805 regulator_put(usb2->supply);
806}
807
808static int tegra_xusb_ulpi_port_parse_dt(struct tegra_xusb_ulpi_port *ulpi)
809{
810 struct tegra_xusb_port *port = &ulpi->base;
811 struct device_node *np = port->dev.of_node;
812
813 ulpi->internal = of_property_read_bool(np, "nvidia,internal");
814
815 return 0;
816}
817
818static int tegra_xusb_add_ulpi_port(struct tegra_xusb_padctl *padctl,
819 unsigned int index)
820{
821 struct tegra_xusb_ulpi_port *ulpi;
822 struct device_node *np;
823 int err = 0;
824
825 np = tegra_xusb_find_port_node(padctl, "ulpi", index);
826 if (!np || !of_device_is_available(np))
827 goto out;
828
829 ulpi = kzalloc(sizeof(*ulpi), GFP_KERNEL);
830 if (!ulpi) {
831 err = -ENOMEM;
832 goto out;
833 }
834
835 err = tegra_xusb_port_init(&ulpi->base, padctl, np, "ulpi", index);
836 if (err < 0)
837 goto out;
838
839 ulpi->base.ops = padctl->soc->ports.ulpi.ops;
840
841 ulpi->base.lane = ulpi->base.ops->map(&ulpi->base);
842 if (IS_ERR(ulpi->base.lane)) {
843 err = PTR_ERR(ulpi->base.lane);
844 goto out;
845 }
846
847 err = tegra_xusb_ulpi_port_parse_dt(ulpi);
848 if (err < 0) {
849 tegra_xusb_port_unregister(&ulpi->base);
850 goto out;
851 }
852
853 list_add_tail(&ulpi->base.list, &padctl->ports);
854
855out:
856 of_node_put(np);
857 return err;
858}
859
860void tegra_xusb_ulpi_port_release(struct tegra_xusb_port *port)
861{
862 struct tegra_xusb_ulpi_port *ulpi = to_ulpi_port(port);
863
864 kfree(ulpi);
865}
866
867static int tegra_xusb_hsic_port_parse_dt(struct tegra_xusb_hsic_port *hsic)
868{
869 /* XXX */
870 return 0;
871}
872
873static int tegra_xusb_add_hsic_port(struct tegra_xusb_padctl *padctl,
874 unsigned int index)
875{
876 struct tegra_xusb_hsic_port *hsic;
877 struct device_node *np;
878 int err = 0;
879
880 np = tegra_xusb_find_port_node(padctl, "hsic", index);
881 if (!np || !of_device_is_available(np))
882 goto out;
883
884 hsic = kzalloc(sizeof(*hsic), GFP_KERNEL);
885 if (!hsic) {
886 err = -ENOMEM;
887 goto out;
888 }
889
890 err = tegra_xusb_port_init(&hsic->base, padctl, np, "hsic", index);
891 if (err < 0)
892 goto out;
893
894 hsic->base.ops = padctl->soc->ports.hsic.ops;
895
896 hsic->base.lane = hsic->base.ops->map(&hsic->base);
897 if (IS_ERR(hsic->base.lane)) {
898 err = PTR_ERR(hsic->base.lane);
899 goto out;
900 }
901
902 err = tegra_xusb_hsic_port_parse_dt(hsic);
903 if (err < 0) {
904 tegra_xusb_port_unregister(&hsic->base);
905 goto out;
906 }
907
908 list_add_tail(&hsic->base.list, &padctl->ports);
909
910out:
911 of_node_put(np);
912 return err;
913}
914
915void tegra_xusb_hsic_port_release(struct tegra_xusb_port *port)
916{
917 struct tegra_xusb_hsic_port *hsic = to_hsic_port(port);
918
919 kfree(hsic);
920}
921
922static int tegra_xusb_usb3_port_parse_dt(struct tegra_xusb_usb3_port *usb3)
923{
924 struct tegra_xusb_port *port = &usb3->base;
925 struct device_node *np = port->dev.of_node;
926 enum usb_device_speed maximum_speed;
927 u32 value;
928 int err;
929
930 err = of_property_read_u32(np, "nvidia,usb2-companion", &value);
931 if (err < 0) {
932 dev_err(&port->dev, "failed to read port: %d\n", err);
933 return err;
934 }
935
936 usb3->port = value;
937
938 usb3->internal = of_property_read_bool(np, "nvidia,internal");
939
940 if (device_property_present(&port->dev, "maximum-speed")) {
941 maximum_speed = usb_get_maximum_speed(&port->dev);
942 if (maximum_speed == USB_SPEED_SUPER)
943 usb3->disable_gen2 = true;
944 else if (maximum_speed == USB_SPEED_SUPER_PLUS)
945 usb3->disable_gen2 = false;
946 else
947 return -EINVAL;
948 }
949
950 usb3->supply = regulator_get(&port->dev, "vbus");
951 return PTR_ERR_OR_ZERO(usb3->supply);
952}
953
954static int tegra_xusb_add_usb3_port(struct tegra_xusb_padctl *padctl,
955 unsigned int index)
956{
957 struct tegra_xusb_usb3_port *usb3;
958 struct device_node *np;
959 int err = 0;
960
961 /*
962 * If there is no supplemental configuration in the device tree the
963 * port is unusable. But it is valid to configure only a single port,
964 * hence return 0 instead of an error to allow ports to be optional.
965 */
966 np = tegra_xusb_find_port_node(padctl, "usb3", index);
967 if (!np || !of_device_is_available(np))
968 goto out;
969
970 usb3 = kzalloc(sizeof(*usb3), GFP_KERNEL);
971 if (!usb3) {
972 err = -ENOMEM;
973 goto out;
974 }
975
976 err = tegra_xusb_port_init(&usb3->base, padctl, np, "usb3", index);
977 if (err < 0)
978 goto out;
979
980 usb3->base.ops = padctl->soc->ports.usb3.ops;
981
982 usb3->base.lane = usb3->base.ops->map(&usb3->base);
983 if (IS_ERR(usb3->base.lane)) {
984 err = PTR_ERR(usb3->base.lane);
985 goto out;
986 }
987
988 err = tegra_xusb_usb3_port_parse_dt(usb3);
989 if (err < 0) {
990 tegra_xusb_port_unregister(&usb3->base);
991 goto out;
992 }
993
994 list_add_tail(&usb3->base.list, &padctl->ports);
995
996out:
997 of_node_put(np);
998 return err;
999}
1000
1001void tegra_xusb_usb3_port_release(struct tegra_xusb_port *port)
1002{
1003 struct tegra_xusb_usb3_port *usb3 = to_usb3_port(port);
1004
1005 kfree(usb3);
1006}
1007
1008void tegra_xusb_usb3_port_remove(struct tegra_xusb_port *port)
1009{
1010 struct tegra_xusb_usb3_port *usb3 = to_usb3_port(port);
1011
1012 regulator_put(usb3->supply);
1013}
1014
1015static void __tegra_xusb_remove_ports(struct tegra_xusb_padctl *padctl)
1016{
1017 struct tegra_xusb_port *port, *tmp;
1018
1019 list_for_each_entry_safe_reverse(port, tmp, &padctl->ports, list) {
1020 list_del(&port->list);
1021 tegra_xusb_port_unregister(port);
1022 }
1023}
1024
1025static int tegra_xusb_find_unused_usb3_port(struct tegra_xusb_padctl *padctl)
1026{
1027 struct device_node *np;
1028 unsigned int i;
1029
1030 for (i = 0; i < padctl->soc->ports.usb3.count; i++) {
1031 np = tegra_xusb_find_port_node(padctl, "usb3", i);
1032 if (!np || !of_device_is_available(np))
1033 return i;
1034 }
1035
1036 return -ENODEV;
1037}
1038
1039static bool tegra_xusb_port_is_companion(struct tegra_xusb_usb2_port *usb2)
1040{
1041 unsigned int i;
1042 struct tegra_xusb_usb3_port *usb3;
1043 struct tegra_xusb_padctl *padctl = usb2->base.padctl;
1044
1045 for (i = 0; i < padctl->soc->ports.usb3.count; i++) {
1046 usb3 = tegra_xusb_find_usb3_port(padctl, i);
1047 if (usb3 && usb3->port == usb2->base.index)
1048 return true;
1049 }
1050
1051 return false;
1052}
1053
1054static int tegra_xusb_update_usb3_fake_port(struct tegra_xusb_usb2_port *usb2)
1055{
1056 int fake;
1057
1058 /* Disable usb3_port_fake usage by default and assign if needed */
1059 usb2->usb3_port_fake = -1;
1060
1061 if ((usb2->mode == USB_DR_MODE_OTG ||
1062 usb2->mode == USB_DR_MODE_PERIPHERAL) &&
1063 !tegra_xusb_port_is_companion(usb2)) {
1064 fake = tegra_xusb_find_unused_usb3_port(usb2->base.padctl);
1065 if (fake < 0) {
1066 dev_err(&usb2->base.dev, "no unused USB3 ports available\n");
1067 return -ENODEV;
1068 }
1069
1070 dev_dbg(&usb2->base.dev, "Found unused usb3 port: %d\n", fake);
1071 usb2->usb3_port_fake = fake;
1072 }
1073
1074 return 0;
1075}
1076
1077static int tegra_xusb_setup_ports(struct tegra_xusb_padctl *padctl)
1078{
1079 struct tegra_xusb_port *port;
1080 struct tegra_xusb_usb2_port *usb2;
1081 unsigned int i;
1082 int err = 0;
1083
1084 mutex_lock(&padctl->lock);
1085
1086 for (i = 0; i < padctl->soc->ports.usb2.count; i++) {
1087 err = tegra_xusb_add_usb2_port(padctl, i);
1088 if (err < 0)
1089 goto remove_ports;
1090 }
1091
1092 for (i = 0; i < padctl->soc->ports.ulpi.count; i++) {
1093 err = tegra_xusb_add_ulpi_port(padctl, i);
1094 if (err < 0)
1095 goto remove_ports;
1096 }
1097
1098 for (i = 0; i < padctl->soc->ports.hsic.count; i++) {
1099 err = tegra_xusb_add_hsic_port(padctl, i);
1100 if (err < 0)
1101 goto remove_ports;
1102 }
1103
1104 for (i = 0; i < padctl->soc->ports.usb3.count; i++) {
1105 err = tegra_xusb_add_usb3_port(padctl, i);
1106 if (err < 0)
1107 goto remove_ports;
1108 }
1109
1110 if (padctl->soc->need_fake_usb3_port) {
1111 for (i = 0; i < padctl->soc->ports.usb2.count; i++) {
1112 usb2 = tegra_xusb_find_usb2_port(padctl, i);
1113 if (!usb2)
1114 continue;
1115
1116 err = tegra_xusb_update_usb3_fake_port(usb2);
1117 if (err < 0)
1118 goto remove_ports;
1119 }
1120 }
1121
1122 list_for_each_entry(port, &padctl->ports, list) {
1123 err = port->ops->enable(port);
1124 if (err < 0)
1125 dev_err(padctl->dev, "failed to enable port %s: %d\n",
1126 dev_name(&port->dev), err);
1127 }
1128
1129 goto unlock;
1130
1131remove_ports:
1132 __tegra_xusb_remove_ports(padctl);
1133unlock:
1134 mutex_unlock(&padctl->lock);
1135 return err;
1136}
1137
1138static void tegra_xusb_remove_ports(struct tegra_xusb_padctl *padctl)
1139{
1140 mutex_lock(&padctl->lock);
1141 __tegra_xusb_remove_ports(padctl);
1142 mutex_unlock(&padctl->lock);
1143}
1144
1145static int tegra_xusb_padctl_probe(struct platform_device *pdev)
1146{
1147 struct device_node *np = pdev->dev.of_node;
1148 const struct tegra_xusb_padctl_soc *soc;
1149 struct tegra_xusb_padctl *padctl;
1150 const struct of_device_id *match;
1151 struct resource *res;
1152 int err;
1153
1154 /* for backwards compatibility with old device trees */
1155 np = of_get_child_by_name(np, "pads");
1156 if (!np) {
1157 dev_warn(&pdev->dev, "deprecated DT, using legacy driver\n");
1158 return tegra_xusb_padctl_legacy_probe(pdev);
1159 }
1160
1161 of_node_put(np);
1162
1163 match = of_match_node(tegra_xusb_padctl_of_match, pdev->dev.of_node);
1164 soc = match->data;
1165
1166 padctl = soc->ops->probe(&pdev->dev, soc);
1167 if (IS_ERR(padctl))
1168 return PTR_ERR(padctl);
1169
1170 platform_set_drvdata(pdev, padctl);
1171 INIT_LIST_HEAD(&padctl->ports);
1172 INIT_LIST_HEAD(&padctl->lanes);
1173 INIT_LIST_HEAD(&padctl->pads);
1174 mutex_init(&padctl->lock);
1175
1176 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1177 padctl->regs = devm_ioremap_resource(&pdev->dev, res);
1178 if (IS_ERR(padctl->regs)) {
1179 err = PTR_ERR(padctl->regs);
1180 goto remove;
1181 }
1182
1183 padctl->rst = devm_reset_control_get(&pdev->dev, NULL);
1184 if (IS_ERR(padctl->rst)) {
1185 err = PTR_ERR(padctl->rst);
1186 goto remove;
1187 }
1188
1189 padctl->supplies = devm_kcalloc(&pdev->dev, padctl->soc->num_supplies,
1190 sizeof(*padctl->supplies), GFP_KERNEL);
1191 if (!padctl->supplies) {
1192 err = -ENOMEM;
1193 goto remove;
1194 }
1195
1196 regulator_bulk_set_supply_names(padctl->supplies,
1197 padctl->soc->supply_names,
1198 padctl->soc->num_supplies);
1199
1200 err = devm_regulator_bulk_get(&pdev->dev, padctl->soc->num_supplies,
1201 padctl->supplies);
1202 if (err < 0) {
1203 dev_err(&pdev->dev, "failed to get regulators: %d\n", err);
1204 goto remove;
1205 }
1206
1207 err = reset_control_deassert(padctl->rst);
1208 if (err < 0)
1209 goto remove;
1210
1211 err = regulator_bulk_enable(padctl->soc->num_supplies,
1212 padctl->supplies);
1213 if (err < 0) {
1214 dev_err(&pdev->dev, "failed to enable supplies: %d\n", err);
1215 goto reset;
1216 }
1217
1218 err = tegra_xusb_setup_pads(padctl);
1219 if (err < 0) {
1220 dev_err(&pdev->dev, "failed to setup pads: %d\n", err);
1221 goto power_down;
1222 }
1223
1224 err = tegra_xusb_setup_ports(padctl);
1225 if (err) {
1226 const char *level = KERN_ERR;
1227
1228 if (err == -EPROBE_DEFER)
1229 level = KERN_DEBUG;
1230
1231 dev_printk(level, &pdev->dev,
1232 dev_fmt("failed to setup XUSB ports: %d\n"), err);
1233 goto remove_pads;
1234 }
1235
1236 return 0;
1237
1238remove_pads:
1239 tegra_xusb_remove_pads(padctl);
1240power_down:
1241 regulator_bulk_disable(padctl->soc->num_supplies, padctl->supplies);
1242reset:
1243 reset_control_assert(padctl->rst);
1244remove:
1245 soc->ops->remove(padctl);
1246 return err;
1247}
1248
1249static int tegra_xusb_padctl_remove(struct platform_device *pdev)
1250{
1251 struct tegra_xusb_padctl *padctl = platform_get_drvdata(pdev);
1252 int err;
1253
1254 tegra_xusb_remove_ports(padctl);
1255 tegra_xusb_remove_pads(padctl);
1256
1257 err = regulator_bulk_disable(padctl->soc->num_supplies,
1258 padctl->supplies);
1259 if (err < 0)
1260 dev_err(&pdev->dev, "failed to disable supplies: %d\n", err);
1261
1262 err = reset_control_assert(padctl->rst);
1263 if (err < 0)
1264 dev_err(&pdev->dev, "failed to assert reset: %d\n", err);
1265
1266 padctl->soc->ops->remove(padctl);
1267
1268 return err;
1269}
1270
1271static struct platform_driver tegra_xusb_padctl_driver = {
1272 .driver = {
1273 .name = "tegra-xusb-padctl",
1274 .of_match_table = tegra_xusb_padctl_of_match,
1275 },
1276 .probe = tegra_xusb_padctl_probe,
1277 .remove = tegra_xusb_padctl_remove,
1278};
1279module_platform_driver(tegra_xusb_padctl_driver);
1280
1281struct tegra_xusb_padctl *tegra_xusb_padctl_get(struct device *dev)
1282{
1283 struct tegra_xusb_padctl *padctl;
1284 struct platform_device *pdev;
1285 struct device_node *np;
1286
1287 np = of_parse_phandle(dev->of_node, "nvidia,xusb-padctl", 0);
1288 if (!np)
1289 return ERR_PTR(-EINVAL);
1290
1291 /*
1292 * This is slightly ugly. A better implementation would be to keep a
1293 * registry of pad controllers, but since there will almost certainly
1294 * only ever be one per SoC that would be a little overkill.
1295 */
1296 pdev = of_find_device_by_node(np);
1297 if (!pdev) {
1298 of_node_put(np);
1299 return ERR_PTR(-ENODEV);
1300 }
1301
1302 of_node_put(np);
1303
1304 padctl = platform_get_drvdata(pdev);
1305 if (!padctl) {
1306 put_device(&pdev->dev);
1307 return ERR_PTR(-EPROBE_DEFER);
1308 }
1309
1310 return padctl;
1311}
1312EXPORT_SYMBOL_GPL(tegra_xusb_padctl_get);
1313
1314void tegra_xusb_padctl_put(struct tegra_xusb_padctl *padctl)
1315{
1316 if (padctl)
1317 put_device(padctl->dev);
1318}
1319EXPORT_SYMBOL_GPL(tegra_xusb_padctl_put);
1320
1321int tegra_xusb_padctl_usb3_save_context(struct tegra_xusb_padctl *padctl,
1322 unsigned int port)
1323{
1324 if (padctl->soc->ops->usb3_save_context)
1325 return padctl->soc->ops->usb3_save_context(padctl, port);
1326
1327 return -ENOSYS;
1328}
1329EXPORT_SYMBOL_GPL(tegra_xusb_padctl_usb3_save_context);
1330
1331int tegra_xusb_padctl_hsic_set_idle(struct tegra_xusb_padctl *padctl,
1332 unsigned int port, bool idle)
1333{
1334 if (padctl->soc->ops->hsic_set_idle)
1335 return padctl->soc->ops->hsic_set_idle(padctl, port, idle);
1336
1337 return -ENOSYS;
1338}
1339EXPORT_SYMBOL_GPL(tegra_xusb_padctl_hsic_set_idle);
1340
1341int tegra_xusb_padctl_usb3_set_lfps_detect(struct tegra_xusb_padctl *padctl,
1342 unsigned int port, bool enable)
1343{
1344 if (padctl->soc->ops->usb3_set_lfps_detect)
1345 return padctl->soc->ops->usb3_set_lfps_detect(padctl, port,
1346 enable);
1347
1348 return -ENOSYS;
1349}
1350EXPORT_SYMBOL_GPL(tegra_xusb_padctl_usb3_set_lfps_detect);
1351
1352int tegra_xusb_padctl_set_vbus_override(struct tegra_xusb_padctl *padctl,
1353 bool val)
1354{
1355 if (padctl->soc->ops->vbus_override)
1356 return padctl->soc->ops->vbus_override(padctl, val);
1357
1358 return -ENOTSUPP;
1359}
1360EXPORT_SYMBOL_GPL(tegra_xusb_padctl_set_vbus_override);
1361
1362int tegra_phy_xusb_utmi_port_reset(struct phy *phy)
1363{
1364 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
1365 struct tegra_xusb_padctl *padctl = lane->pad->padctl;
1366
1367 if (padctl->soc->ops->utmi_port_reset)
1368 return padctl->soc->ops->utmi_port_reset(phy);
1369
1370 return -ENOTSUPP;
1371}
1372EXPORT_SYMBOL_GPL(tegra_phy_xusb_utmi_port_reset);
1373
1374int tegra_xusb_padctl_get_usb3_companion(struct tegra_xusb_padctl *padctl,
1375 unsigned int port)
1376{
1377 struct tegra_xusb_usb2_port *usb2;
1378 struct tegra_xusb_usb3_port *usb3;
1379 int i;
1380
1381 usb2 = tegra_xusb_find_usb2_port(padctl, port);
1382 if (!usb2)
1383 return -EINVAL;
1384
1385 for (i = 0; i < padctl->soc->ports.usb3.count; i++) {
1386 usb3 = tegra_xusb_find_usb3_port(padctl, i);
1387 if (usb3 && usb3->port == usb2->base.index)
1388 return usb3->base.index;
1389 }
1390
1391 return -ENODEV;
1392}
1393EXPORT_SYMBOL_GPL(tegra_xusb_padctl_get_usb3_companion);
1394
1395MODULE_AUTHOR("Thierry Reding <treding@nvidia.com>");
1396MODULE_DESCRIPTION("Tegra XUSB Pad Controller driver");
1397MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (c) 2014-2022, NVIDIA CORPORATION. All rights reserved.
4 */
5
6#include <linux/delay.h>
7#include <linux/io.h>
8#include <linux/mailbox_client.h>
9#include <linux/module.h>
10#include <linux/of.h>
11#include <linux/of_platform.h>
12#include <linux/phy/phy.h>
13#include <linux/phy/tegra/xusb.h>
14#include <linux/platform_device.h>
15#include <linux/regulator/consumer.h>
16#include <linux/reset.h>
17#include <linux/slab.h>
18#include <linux/workqueue.h>
19
20#include <soc/tegra/fuse.h>
21
22#include "xusb.h"
23
24static struct phy *tegra_xusb_pad_of_xlate(struct device *dev,
25 const struct of_phandle_args *args)
26{
27 struct tegra_xusb_pad *pad = dev_get_drvdata(dev);
28 struct phy *phy = NULL;
29 unsigned int i;
30
31 if (args->args_count != 0)
32 return ERR_PTR(-EINVAL);
33
34 for (i = 0; i < pad->soc->num_lanes; i++) {
35 if (!pad->lanes[i])
36 continue;
37
38 if (pad->lanes[i]->dev.of_node == args->np) {
39 phy = pad->lanes[i];
40 break;
41 }
42 }
43
44 if (phy == NULL)
45 phy = ERR_PTR(-ENODEV);
46
47 return phy;
48}
49
50static const struct of_device_id tegra_xusb_padctl_of_match[] = {
51#if defined(CONFIG_ARCH_TEGRA_124_SOC) || defined(CONFIG_ARCH_TEGRA_132_SOC)
52 {
53 .compatible = "nvidia,tegra124-xusb-padctl",
54 .data = &tegra124_xusb_padctl_soc,
55 },
56#endif
57#if defined(CONFIG_ARCH_TEGRA_210_SOC)
58 {
59 .compatible = "nvidia,tegra210-xusb-padctl",
60 .data = &tegra210_xusb_padctl_soc,
61 },
62#endif
63#if defined(CONFIG_ARCH_TEGRA_186_SOC)
64 {
65 .compatible = "nvidia,tegra186-xusb-padctl",
66 .data = &tegra186_xusb_padctl_soc,
67 },
68#endif
69#if defined(CONFIG_ARCH_TEGRA_194_SOC)
70 {
71 .compatible = "nvidia,tegra194-xusb-padctl",
72 .data = &tegra194_xusb_padctl_soc,
73 },
74#endif
75#if defined(CONFIG_ARCH_TEGRA_234_SOC)
76 {
77 .compatible = "nvidia,tegra234-xusb-padctl",
78 .data = &tegra234_xusb_padctl_soc,
79 },
80#endif
81 { }
82};
83MODULE_DEVICE_TABLE(of, tegra_xusb_padctl_of_match);
84
85static struct device_node *
86tegra_xusb_find_pad_node(struct tegra_xusb_padctl *padctl, const char *name)
87{
88 struct device_node *pads, *np;
89
90 pads = of_get_child_by_name(padctl->dev->of_node, "pads");
91 if (!pads)
92 return NULL;
93
94 np = of_get_child_by_name(pads, name);
95 of_node_put(pads);
96
97 return np;
98}
99
100static struct device_node *
101tegra_xusb_pad_find_phy_node(struct tegra_xusb_pad *pad, unsigned int index)
102{
103 struct device_node *np, *lanes;
104
105 lanes = of_get_child_by_name(pad->dev.of_node, "lanes");
106 if (!lanes)
107 return NULL;
108
109 np = of_get_child_by_name(lanes, pad->soc->lanes[index].name);
110 of_node_put(lanes);
111
112 return np;
113}
114
115int tegra_xusb_lane_parse_dt(struct tegra_xusb_lane *lane,
116 struct device_node *np)
117{
118 struct device *dev = &lane->pad->dev;
119 const char *function;
120 int err;
121
122 err = of_property_read_string(np, "nvidia,function", &function);
123 if (err < 0)
124 return err;
125
126 err = match_string(lane->soc->funcs, lane->soc->num_funcs, function);
127 if (err < 0) {
128 dev_err(dev, "invalid function \"%s\" for lane \"%pOFn\"\n",
129 function, np);
130 return err;
131 }
132
133 lane->function = err;
134
135 return 0;
136}
137
138static void tegra_xusb_lane_destroy(struct phy *phy)
139{
140 if (phy) {
141 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
142
143 lane->pad->ops->remove(lane);
144 phy_destroy(phy);
145 }
146}
147
148static void tegra_xusb_pad_release(struct device *dev)
149{
150 struct tegra_xusb_pad *pad = to_tegra_xusb_pad(dev);
151
152 pad->soc->ops->remove(pad);
153}
154
155static const struct device_type tegra_xusb_pad_type = {
156 .release = tegra_xusb_pad_release,
157};
158
159int tegra_xusb_pad_init(struct tegra_xusb_pad *pad,
160 struct tegra_xusb_padctl *padctl,
161 struct device_node *np)
162{
163 int err;
164
165 device_initialize(&pad->dev);
166 INIT_LIST_HEAD(&pad->list);
167 pad->dev.parent = padctl->dev;
168 pad->dev.type = &tegra_xusb_pad_type;
169 pad->dev.of_node = np;
170 pad->padctl = padctl;
171
172 err = dev_set_name(&pad->dev, "%s", pad->soc->name);
173 if (err < 0)
174 goto unregister;
175
176 err = device_add(&pad->dev);
177 if (err < 0)
178 goto unregister;
179
180 return 0;
181
182unregister:
183 device_unregister(&pad->dev);
184 return err;
185}
186
187int tegra_xusb_pad_register(struct tegra_xusb_pad *pad,
188 const struct phy_ops *ops)
189{
190 struct device_node *children;
191 struct phy *lane;
192 unsigned int i;
193 int err;
194
195 children = of_get_child_by_name(pad->dev.of_node, "lanes");
196 if (!children)
197 return -ENODEV;
198
199 pad->lanes = devm_kcalloc(&pad->dev, pad->soc->num_lanes, sizeof(lane),
200 GFP_KERNEL);
201 if (!pad->lanes) {
202 of_node_put(children);
203 return -ENOMEM;
204 }
205
206 for (i = 0; i < pad->soc->num_lanes; i++) {
207 struct device_node *np = tegra_xusb_pad_find_phy_node(pad, i);
208 struct tegra_xusb_lane *lane;
209
210 /* skip disabled lanes */
211 if (!np || !of_device_is_available(np)) {
212 of_node_put(np);
213 continue;
214 }
215
216 pad->lanes[i] = phy_create(&pad->dev, np, ops);
217 if (IS_ERR(pad->lanes[i])) {
218 err = PTR_ERR(pad->lanes[i]);
219 of_node_put(np);
220 goto remove;
221 }
222
223 lane = pad->ops->probe(pad, np, i);
224 if (IS_ERR(lane)) {
225 phy_destroy(pad->lanes[i]);
226 err = PTR_ERR(lane);
227 goto remove;
228 }
229
230 list_add_tail(&lane->list, &pad->padctl->lanes);
231 phy_set_drvdata(pad->lanes[i], lane);
232 }
233
234 pad->provider = of_phy_provider_register_full(&pad->dev, children,
235 tegra_xusb_pad_of_xlate);
236 if (IS_ERR(pad->provider)) {
237 err = PTR_ERR(pad->provider);
238 goto remove;
239 }
240
241 return 0;
242
243remove:
244 while (i--)
245 tegra_xusb_lane_destroy(pad->lanes[i]);
246
247 of_node_put(children);
248
249 return err;
250}
251
252void tegra_xusb_pad_unregister(struct tegra_xusb_pad *pad)
253{
254 unsigned int i = pad->soc->num_lanes;
255
256 of_phy_provider_unregister(pad->provider);
257
258 while (i--)
259 tegra_xusb_lane_destroy(pad->lanes[i]);
260
261 device_unregister(&pad->dev);
262}
263
264static struct tegra_xusb_pad *
265tegra_xusb_pad_create(struct tegra_xusb_padctl *padctl,
266 const struct tegra_xusb_pad_soc *soc)
267{
268 struct tegra_xusb_pad *pad;
269 struct device_node *np;
270 int err;
271
272 np = tegra_xusb_find_pad_node(padctl, soc->name);
273 if (!np || !of_device_is_available(np))
274 return NULL;
275
276 pad = soc->ops->probe(padctl, soc, np);
277 if (IS_ERR(pad)) {
278 err = PTR_ERR(pad);
279 dev_err(padctl->dev, "failed to create pad %s: %d\n",
280 soc->name, err);
281 return ERR_PTR(err);
282 }
283
284 /* XXX move this into ->probe() to avoid string comparison */
285 if (strcmp(soc->name, "pcie") == 0)
286 padctl->pcie = pad;
287
288 if (strcmp(soc->name, "sata") == 0)
289 padctl->sata = pad;
290
291 if (strcmp(soc->name, "usb2") == 0)
292 padctl->usb2 = pad;
293
294 if (strcmp(soc->name, "ulpi") == 0)
295 padctl->ulpi = pad;
296
297 if (strcmp(soc->name, "hsic") == 0)
298 padctl->hsic = pad;
299
300 return pad;
301}
302
303static void __tegra_xusb_remove_pads(struct tegra_xusb_padctl *padctl)
304{
305 struct tegra_xusb_pad *pad, *tmp;
306
307 list_for_each_entry_safe_reverse(pad, tmp, &padctl->pads, list) {
308 list_del(&pad->list);
309 tegra_xusb_pad_unregister(pad);
310 }
311}
312
313static void tegra_xusb_remove_pads(struct tegra_xusb_padctl *padctl)
314{
315 mutex_lock(&padctl->lock);
316 __tegra_xusb_remove_pads(padctl);
317 mutex_unlock(&padctl->lock);
318}
319
320static void tegra_xusb_lane_program(struct tegra_xusb_lane *lane)
321{
322 struct tegra_xusb_padctl *padctl = lane->pad->padctl;
323 const struct tegra_xusb_lane_soc *soc = lane->soc;
324 u32 value;
325
326 /* skip single function lanes */
327 if (soc->num_funcs < 2)
328 return;
329
330 if (lane->pad->ops->iddq_enable)
331 lane->pad->ops->iddq_enable(lane);
332
333 /* choose function */
334 value = padctl_readl(padctl, soc->offset);
335 value &= ~(soc->mask << soc->shift);
336 value |= lane->function << soc->shift;
337 padctl_writel(padctl, value, soc->offset);
338
339 if (lane->pad->ops->iddq_disable)
340 lane->pad->ops->iddq_disable(lane);
341}
342
343static void tegra_xusb_pad_program(struct tegra_xusb_pad *pad)
344{
345 unsigned int i;
346
347 for (i = 0; i < pad->soc->num_lanes; i++) {
348 struct tegra_xusb_lane *lane;
349
350 if (pad->lanes[i]) {
351 lane = phy_get_drvdata(pad->lanes[i]);
352 tegra_xusb_lane_program(lane);
353 }
354 }
355}
356
357static int tegra_xusb_setup_pads(struct tegra_xusb_padctl *padctl)
358{
359 struct tegra_xusb_pad *pad;
360 unsigned int i;
361
362 mutex_lock(&padctl->lock);
363
364 for (i = 0; i < padctl->soc->num_pads; i++) {
365 const struct tegra_xusb_pad_soc *soc = padctl->soc->pads[i];
366 int err;
367
368 pad = tegra_xusb_pad_create(padctl, soc);
369 if (IS_ERR(pad)) {
370 err = PTR_ERR(pad);
371 dev_err(padctl->dev, "failed to create pad %s: %d\n",
372 soc->name, err);
373 __tegra_xusb_remove_pads(padctl);
374 mutex_unlock(&padctl->lock);
375 return err;
376 }
377
378 if (!pad)
379 continue;
380
381 list_add_tail(&pad->list, &padctl->pads);
382 }
383
384 list_for_each_entry(pad, &padctl->pads, list)
385 tegra_xusb_pad_program(pad);
386
387 mutex_unlock(&padctl->lock);
388 return 0;
389}
390
391bool tegra_xusb_lane_check(struct tegra_xusb_lane *lane,
392 const char *function)
393{
394 const char *func = lane->soc->funcs[lane->function];
395
396 return strcmp(function, func) == 0;
397}
398
399struct tegra_xusb_lane *tegra_xusb_find_lane(struct tegra_xusb_padctl *padctl,
400 const char *type,
401 unsigned int index)
402{
403 struct tegra_xusb_lane *lane, *hit = ERR_PTR(-ENODEV);
404 char *name;
405
406 name = kasprintf(GFP_KERNEL, "%s-%u", type, index);
407 if (!name)
408 return ERR_PTR(-ENOMEM);
409
410 list_for_each_entry(lane, &padctl->lanes, list) {
411 if (strcmp(lane->soc->name, name) == 0) {
412 hit = lane;
413 break;
414 }
415 }
416
417 kfree(name);
418 return hit;
419}
420
421struct tegra_xusb_lane *
422tegra_xusb_port_find_lane(struct tegra_xusb_port *port,
423 const struct tegra_xusb_lane_map *map,
424 const char *function)
425{
426 struct tegra_xusb_lane *lane, *match = ERR_PTR(-ENODEV);
427
428 for (; map->type; map++) {
429 if (port->index != map->port)
430 continue;
431
432 lane = tegra_xusb_find_lane(port->padctl, map->type,
433 map->index);
434 if (IS_ERR(lane))
435 continue;
436
437 if (!tegra_xusb_lane_check(lane, function))
438 continue;
439
440 if (!IS_ERR(match))
441 dev_err(&port->dev, "conflicting match: %s-%u / %s\n",
442 map->type, map->index, match->soc->name);
443 else
444 match = lane;
445 }
446
447 return match;
448}
449
450static struct device_node *
451tegra_xusb_find_port_node(struct tegra_xusb_padctl *padctl, const char *type,
452 unsigned int index)
453{
454 struct device_node *ports, *np;
455 char *name;
456
457 ports = of_get_child_by_name(padctl->dev->of_node, "ports");
458 if (!ports)
459 return NULL;
460
461 name = kasprintf(GFP_KERNEL, "%s-%u", type, index);
462 if (!name) {
463 of_node_put(ports);
464 return NULL;
465 }
466 np = of_get_child_by_name(ports, name);
467 kfree(name);
468 of_node_put(ports);
469
470 return np;
471}
472
473struct tegra_xusb_port *
474tegra_xusb_find_port(struct tegra_xusb_padctl *padctl, const char *type,
475 unsigned int index)
476{
477 struct tegra_xusb_port *port;
478 struct device_node *np;
479
480 np = tegra_xusb_find_port_node(padctl, type, index);
481 if (!np)
482 return NULL;
483
484 list_for_each_entry(port, &padctl->ports, list) {
485 if (np == port->dev.of_node) {
486 of_node_put(np);
487 return port;
488 }
489 }
490
491 of_node_put(np);
492
493 return NULL;
494}
495
496struct tegra_xusb_usb2_port *
497tegra_xusb_find_usb2_port(struct tegra_xusb_padctl *padctl, unsigned int index)
498{
499 struct tegra_xusb_port *port;
500
501 port = tegra_xusb_find_port(padctl, "usb2", index);
502 if (port)
503 return to_usb2_port(port);
504
505 return NULL;
506}
507
508struct tegra_xusb_usb3_port *
509tegra_xusb_find_usb3_port(struct tegra_xusb_padctl *padctl, unsigned int index)
510{
511 struct tegra_xusb_port *port;
512
513 port = tegra_xusb_find_port(padctl, "usb3", index);
514 if (port)
515 return to_usb3_port(port);
516
517 return NULL;
518}
519
520static void tegra_xusb_port_release(struct device *dev)
521{
522 struct tegra_xusb_port *port = to_tegra_xusb_port(dev);
523
524 if (port->ops->release)
525 port->ops->release(port);
526}
527
528static const struct device_type tegra_xusb_port_type = {
529 .release = tegra_xusb_port_release,
530};
531
532static int tegra_xusb_port_init(struct tegra_xusb_port *port,
533 struct tegra_xusb_padctl *padctl,
534 struct device_node *np,
535 const char *name,
536 unsigned int index)
537{
538 int err;
539
540 INIT_LIST_HEAD(&port->list);
541 port->padctl = padctl;
542 port->index = index;
543
544 device_initialize(&port->dev);
545 port->dev.type = &tegra_xusb_port_type;
546 device_set_node(&port->dev, of_fwnode_handle(of_node_get(np)));
547 port->dev.parent = padctl->dev;
548
549 err = dev_set_name(&port->dev, "%s-%u", name, index);
550 if (err < 0)
551 goto unregister;
552
553 err = device_add(&port->dev);
554 if (err < 0)
555 goto unregister;
556
557 return 0;
558
559unregister:
560 device_unregister(&port->dev);
561 return err;
562}
563
564static void tegra_xusb_port_unregister(struct tegra_xusb_port *port)
565{
566 if (!IS_ERR_OR_NULL(port->usb_role_sw)) {
567 of_platform_depopulate(&port->dev);
568 usb_role_switch_unregister(port->usb_role_sw);
569 cancel_work_sync(&port->usb_phy_work);
570 usb_remove_phy(&port->usb_phy);
571 port->usb_phy.dev->driver = NULL;
572 }
573
574 if (port->ops->remove)
575 port->ops->remove(port);
576
577 device_unregister(&port->dev);
578}
579
580static const char *const modes[] = {
581 [USB_DR_MODE_UNKNOWN] = "",
582 [USB_DR_MODE_HOST] = "host",
583 [USB_DR_MODE_PERIPHERAL] = "peripheral",
584 [USB_DR_MODE_OTG] = "otg",
585};
586
587static const char * const usb_roles[] = {
588 [USB_ROLE_NONE] = "none",
589 [USB_ROLE_HOST] = "host",
590 [USB_ROLE_DEVICE] = "device",
591};
592
593static enum usb_phy_events to_usb_phy_event(enum usb_role role)
594{
595 switch (role) {
596 case USB_ROLE_DEVICE:
597 return USB_EVENT_VBUS;
598
599 case USB_ROLE_HOST:
600 return USB_EVENT_ID;
601
602 default:
603 return USB_EVENT_NONE;
604 }
605}
606
607static void tegra_xusb_usb_phy_work(struct work_struct *work)
608{
609 struct tegra_xusb_port *port = container_of(work,
610 struct tegra_xusb_port,
611 usb_phy_work);
612 enum usb_role role = usb_role_switch_get_role(port->usb_role_sw);
613
614 usb_phy_set_event(&port->usb_phy, to_usb_phy_event(role));
615
616 dev_dbg(&port->dev, "%s(): calling notifier for role %s\n", __func__,
617 usb_roles[role]);
618
619 atomic_notifier_call_chain(&port->usb_phy.notifier, 0, &port->usb_phy);
620}
621
622static int tegra_xusb_role_sw_set(struct usb_role_switch *sw,
623 enum usb_role role)
624{
625 struct tegra_xusb_port *port = usb_role_switch_get_drvdata(sw);
626
627 dev_dbg(&port->dev, "%s(): role %s\n", __func__, usb_roles[role]);
628
629 schedule_work(&port->usb_phy_work);
630
631 return 0;
632}
633
634static int tegra_xusb_set_peripheral(struct usb_otg *otg,
635 struct usb_gadget *gadget)
636{
637 struct tegra_xusb_port *port = container_of(otg->usb_phy,
638 struct tegra_xusb_port,
639 usb_phy);
640
641 if (gadget != NULL)
642 schedule_work(&port->usb_phy_work);
643
644 return 0;
645}
646
647static int tegra_xusb_set_host(struct usb_otg *otg, struct usb_bus *host)
648{
649 struct tegra_xusb_port *port = container_of(otg->usb_phy,
650 struct tegra_xusb_port,
651 usb_phy);
652
653 if (host != NULL)
654 schedule_work(&port->usb_phy_work);
655
656 return 0;
657}
658
659
660static int tegra_xusb_setup_usb_role_switch(struct tegra_xusb_port *port)
661{
662 struct tegra_xusb_lane *lane;
663 struct usb_role_switch_desc role_sx_desc = {
664 .fwnode = dev_fwnode(&port->dev),
665 .set = tegra_xusb_role_sw_set,
666 .allow_userspace_control = true,
667 };
668 int err = 0;
669
670 /*
671 * USB role switch driver needs parent driver owner info. This is a
672 * suboptimal solution. TODO: Need to revisit this in a follow-up patch
673 * where an optimal solution is possible with changes to USB role
674 * switch driver.
675 */
676 port->dev.driver = devm_kzalloc(&port->dev,
677 sizeof(struct device_driver),
678 GFP_KERNEL);
679 if (!port->dev.driver)
680 return -ENOMEM;
681
682 port->dev.driver->owner = THIS_MODULE;
683
684 port->usb_role_sw = usb_role_switch_register(&port->dev,
685 &role_sx_desc);
686 if (IS_ERR(port->usb_role_sw)) {
687 err = PTR_ERR(port->usb_role_sw);
688 dev_err(&port->dev, "failed to register USB role switch: %d",
689 err);
690 return err;
691 }
692
693 INIT_WORK(&port->usb_phy_work, tegra_xusb_usb_phy_work);
694 usb_role_switch_set_drvdata(port->usb_role_sw, port);
695
696 port->usb_phy.otg = devm_kzalloc(&port->dev, sizeof(struct usb_otg),
697 GFP_KERNEL);
698 if (!port->usb_phy.otg)
699 return -ENOMEM;
700
701 lane = tegra_xusb_find_lane(port->padctl, "usb2", port->index);
702 if (IS_ERR(lane))
703 return PTR_ERR(lane);
704
705 /*
706 * Assign phy dev to usb-phy dev. Host/device drivers can use phy
707 * reference to retrieve usb-phy details.
708 */
709 port->usb_phy.dev = &lane->pad->lanes[port->index]->dev;
710 port->usb_phy.dev->driver = port->dev.driver;
711 port->usb_phy.otg->usb_phy = &port->usb_phy;
712 port->usb_phy.otg->set_peripheral = tegra_xusb_set_peripheral;
713 port->usb_phy.otg->set_host = tegra_xusb_set_host;
714
715 err = usb_add_phy_dev(&port->usb_phy);
716 if (err < 0) {
717 dev_err(&port->dev, "Failed to add USB PHY: %d\n", err);
718 return err;
719 }
720
721 /* populate connector entry */
722 of_platform_populate(port->dev.of_node, NULL, NULL, &port->dev);
723
724 return err;
725}
726
727static void tegra_xusb_parse_usb_role_default_mode(struct tegra_xusb_port *port)
728{
729 enum usb_role role = USB_ROLE_NONE;
730 enum usb_dr_mode mode = usb_get_role_switch_default_mode(&port->dev);
731
732 if (mode == USB_DR_MODE_HOST)
733 role = USB_ROLE_HOST;
734 else if (mode == USB_DR_MODE_PERIPHERAL)
735 role = USB_ROLE_DEVICE;
736
737 if (role != USB_ROLE_NONE) {
738 usb_role_switch_set_role(port->usb_role_sw, role);
739 dev_dbg(&port->dev, "usb role default mode is %s", modes[mode]);
740 }
741}
742
743static int tegra_xusb_usb2_port_parse_dt(struct tegra_xusb_usb2_port *usb2)
744{
745 struct tegra_xusb_port *port = &usb2->base;
746 struct device_node *np = port->dev.of_node;
747 const char *mode;
748 int err;
749
750 usb2->internal = of_property_read_bool(np, "nvidia,internal");
751
752 if (!of_property_read_string(np, "mode", &mode)) {
753 int err = match_string(modes, ARRAY_SIZE(modes), mode);
754 if (err < 0) {
755 dev_err(&port->dev, "invalid value %s for \"mode\"\n",
756 mode);
757 usb2->mode = USB_DR_MODE_UNKNOWN;
758 } else {
759 usb2->mode = err;
760 }
761 } else {
762 usb2->mode = USB_DR_MODE_HOST;
763 }
764
765 /* usb-role-switch property is mandatory for OTG/Peripheral modes */
766 if (usb2->mode == USB_DR_MODE_PERIPHERAL ||
767 usb2->mode == USB_DR_MODE_OTG) {
768 if (of_property_read_bool(np, "usb-role-switch")) {
769 err = tegra_xusb_setup_usb_role_switch(port);
770 if (err < 0)
771 return err;
772 tegra_xusb_parse_usb_role_default_mode(port);
773 } else {
774 dev_err(&port->dev, "usb-role-switch not found for %s mode",
775 modes[usb2->mode]);
776 return -EINVAL;
777 }
778 }
779
780 usb2->supply = regulator_get(&port->dev, "vbus");
781 return PTR_ERR_OR_ZERO(usb2->supply);
782}
783
784static int tegra_xusb_add_usb2_port(struct tegra_xusb_padctl *padctl,
785 unsigned int index)
786{
787 struct tegra_xusb_usb2_port *usb2;
788 struct device_node *np;
789 int err = 0;
790
791 /*
792 * USB2 ports don't require additional properties, but if the port is
793 * marked as disabled there is no reason to register it.
794 */
795 np = tegra_xusb_find_port_node(padctl, "usb2", index);
796 if (!np || !of_device_is_available(np))
797 goto out;
798
799 usb2 = kzalloc(sizeof(*usb2), GFP_KERNEL);
800 if (!usb2) {
801 err = -ENOMEM;
802 goto out;
803 }
804
805 err = tegra_xusb_port_init(&usb2->base, padctl, np, "usb2", index);
806 if (err < 0)
807 goto out;
808
809 usb2->base.ops = padctl->soc->ports.usb2.ops;
810
811 usb2->base.lane = usb2->base.ops->map(&usb2->base);
812 if (IS_ERR(usb2->base.lane)) {
813 err = PTR_ERR(usb2->base.lane);
814 tegra_xusb_port_unregister(&usb2->base);
815 goto out;
816 }
817
818 err = tegra_xusb_usb2_port_parse_dt(usb2);
819 if (err < 0) {
820 tegra_xusb_port_unregister(&usb2->base);
821 goto out;
822 }
823
824 list_add_tail(&usb2->base.list, &padctl->ports);
825
826out:
827 of_node_put(np);
828 return err;
829}
830
831void tegra_xusb_usb2_port_release(struct tegra_xusb_port *port)
832{
833 struct tegra_xusb_usb2_port *usb2 = to_usb2_port(port);
834
835 kfree(usb2);
836}
837
838void tegra_xusb_usb2_port_remove(struct tegra_xusb_port *port)
839{
840 struct tegra_xusb_usb2_port *usb2 = to_usb2_port(port);
841
842 regulator_put(usb2->supply);
843}
844
845static int tegra_xusb_ulpi_port_parse_dt(struct tegra_xusb_ulpi_port *ulpi)
846{
847 struct tegra_xusb_port *port = &ulpi->base;
848 struct device_node *np = port->dev.of_node;
849
850 ulpi->internal = of_property_read_bool(np, "nvidia,internal");
851
852 return 0;
853}
854
855static int tegra_xusb_add_ulpi_port(struct tegra_xusb_padctl *padctl,
856 unsigned int index)
857{
858 struct tegra_xusb_ulpi_port *ulpi;
859 struct device_node *np;
860 int err = 0;
861
862 np = tegra_xusb_find_port_node(padctl, "ulpi", index);
863 if (!np || !of_device_is_available(np))
864 goto out;
865
866 ulpi = kzalloc(sizeof(*ulpi), GFP_KERNEL);
867 if (!ulpi) {
868 err = -ENOMEM;
869 goto out;
870 }
871
872 err = tegra_xusb_port_init(&ulpi->base, padctl, np, "ulpi", index);
873 if (err < 0)
874 goto out;
875
876 ulpi->base.ops = padctl->soc->ports.ulpi.ops;
877
878 ulpi->base.lane = ulpi->base.ops->map(&ulpi->base);
879 if (IS_ERR(ulpi->base.lane)) {
880 err = PTR_ERR(ulpi->base.lane);
881 tegra_xusb_port_unregister(&ulpi->base);
882 goto out;
883 }
884
885 err = tegra_xusb_ulpi_port_parse_dt(ulpi);
886 if (err < 0) {
887 tegra_xusb_port_unregister(&ulpi->base);
888 goto out;
889 }
890
891 list_add_tail(&ulpi->base.list, &padctl->ports);
892
893out:
894 of_node_put(np);
895 return err;
896}
897
898void tegra_xusb_ulpi_port_release(struct tegra_xusb_port *port)
899{
900 struct tegra_xusb_ulpi_port *ulpi = to_ulpi_port(port);
901
902 kfree(ulpi);
903}
904
905static int tegra_xusb_hsic_port_parse_dt(struct tegra_xusb_hsic_port *hsic)
906{
907 /* XXX */
908 return 0;
909}
910
911static int tegra_xusb_add_hsic_port(struct tegra_xusb_padctl *padctl,
912 unsigned int index)
913{
914 struct tegra_xusb_hsic_port *hsic;
915 struct device_node *np;
916 int err = 0;
917
918 np = tegra_xusb_find_port_node(padctl, "hsic", index);
919 if (!np || !of_device_is_available(np))
920 goto out;
921
922 hsic = kzalloc(sizeof(*hsic), GFP_KERNEL);
923 if (!hsic) {
924 err = -ENOMEM;
925 goto out;
926 }
927
928 err = tegra_xusb_port_init(&hsic->base, padctl, np, "hsic", index);
929 if (err < 0)
930 goto out;
931
932 hsic->base.ops = padctl->soc->ports.hsic.ops;
933
934 hsic->base.lane = hsic->base.ops->map(&hsic->base);
935 if (IS_ERR(hsic->base.lane)) {
936 err = PTR_ERR(hsic->base.lane);
937 goto out;
938 }
939
940 err = tegra_xusb_hsic_port_parse_dt(hsic);
941 if (err < 0) {
942 tegra_xusb_port_unregister(&hsic->base);
943 goto out;
944 }
945
946 list_add_tail(&hsic->base.list, &padctl->ports);
947
948out:
949 of_node_put(np);
950 return err;
951}
952
953void tegra_xusb_hsic_port_release(struct tegra_xusb_port *port)
954{
955 struct tegra_xusb_hsic_port *hsic = to_hsic_port(port);
956
957 kfree(hsic);
958}
959
960static int tegra_xusb_usb3_port_parse_dt(struct tegra_xusb_usb3_port *usb3)
961{
962 struct tegra_xusb_port *port = &usb3->base;
963 struct device_node *np = port->dev.of_node;
964 enum usb_device_speed maximum_speed;
965 u32 value;
966 int err;
967
968 err = of_property_read_u32(np, "nvidia,usb2-companion", &value);
969 if (err < 0) {
970 dev_err(&port->dev, "failed to read port: %d\n", err);
971 return err;
972 }
973
974 usb3->port = value;
975
976 usb3->internal = of_property_read_bool(np, "nvidia,internal");
977
978 if (device_property_present(&port->dev, "maximum-speed")) {
979 maximum_speed = usb_get_maximum_speed(&port->dev);
980 if (maximum_speed == USB_SPEED_SUPER)
981 usb3->disable_gen2 = true;
982 else if (maximum_speed == USB_SPEED_SUPER_PLUS)
983 usb3->disable_gen2 = false;
984 else
985 return -EINVAL;
986 }
987
988 return 0;
989}
990
991static int tegra_xusb_add_usb3_port(struct tegra_xusb_padctl *padctl,
992 unsigned int index)
993{
994 struct tegra_xusb_usb3_port *usb3;
995 struct device_node *np;
996 int err = 0;
997
998 /*
999 * If there is no supplemental configuration in the device tree the
1000 * port is unusable. But it is valid to configure only a single port,
1001 * hence return 0 instead of an error to allow ports to be optional.
1002 */
1003 np = tegra_xusb_find_port_node(padctl, "usb3", index);
1004 if (!np || !of_device_is_available(np))
1005 goto out;
1006
1007 usb3 = kzalloc(sizeof(*usb3), GFP_KERNEL);
1008 if (!usb3) {
1009 err = -ENOMEM;
1010 goto out;
1011 }
1012
1013 err = tegra_xusb_port_init(&usb3->base, padctl, np, "usb3", index);
1014 if (err < 0)
1015 goto out;
1016
1017 usb3->base.ops = padctl->soc->ports.usb3.ops;
1018
1019 usb3->base.lane = usb3->base.ops->map(&usb3->base);
1020 if (IS_ERR(usb3->base.lane)) {
1021 err = PTR_ERR(usb3->base.lane);
1022 goto out;
1023 }
1024
1025 err = tegra_xusb_usb3_port_parse_dt(usb3);
1026 if (err < 0) {
1027 tegra_xusb_port_unregister(&usb3->base);
1028 goto out;
1029 }
1030
1031 list_add_tail(&usb3->base.list, &padctl->ports);
1032
1033out:
1034 of_node_put(np);
1035 return err;
1036}
1037
1038void tegra_xusb_usb3_port_release(struct tegra_xusb_port *port)
1039{
1040 struct tegra_xusb_usb3_port *usb3 = to_usb3_port(port);
1041
1042 kfree(usb3);
1043}
1044
1045static void __tegra_xusb_remove_ports(struct tegra_xusb_padctl *padctl)
1046{
1047 struct tegra_xusb_port *port, *tmp;
1048
1049 list_for_each_entry_safe_reverse(port, tmp, &padctl->ports, list) {
1050 list_del(&port->list);
1051 tegra_xusb_port_unregister(port);
1052 }
1053}
1054
1055static int tegra_xusb_find_unused_usb3_port(struct tegra_xusb_padctl *padctl)
1056{
1057 struct device_node *np;
1058 unsigned int i;
1059
1060 for (i = 0; i < padctl->soc->ports.usb3.count; i++) {
1061 np = tegra_xusb_find_port_node(padctl, "usb3", i);
1062 if (!np || !of_device_is_available(np))
1063 return i;
1064 }
1065
1066 return -ENODEV;
1067}
1068
1069static bool tegra_xusb_port_is_companion(struct tegra_xusb_usb2_port *usb2)
1070{
1071 unsigned int i;
1072 struct tegra_xusb_usb3_port *usb3;
1073 struct tegra_xusb_padctl *padctl = usb2->base.padctl;
1074
1075 for (i = 0; i < padctl->soc->ports.usb3.count; i++) {
1076 usb3 = tegra_xusb_find_usb3_port(padctl, i);
1077 if (usb3 && usb3->port == usb2->base.index)
1078 return true;
1079 }
1080
1081 return false;
1082}
1083
1084static int tegra_xusb_update_usb3_fake_port(struct tegra_xusb_usb2_port *usb2)
1085{
1086 int fake;
1087
1088 /* Disable usb3_port_fake usage by default and assign if needed */
1089 usb2->usb3_port_fake = -1;
1090
1091 if ((usb2->mode == USB_DR_MODE_OTG ||
1092 usb2->mode == USB_DR_MODE_PERIPHERAL) &&
1093 !tegra_xusb_port_is_companion(usb2)) {
1094 fake = tegra_xusb_find_unused_usb3_port(usb2->base.padctl);
1095 if (fake < 0) {
1096 dev_err(&usb2->base.dev, "no unused USB3 ports available\n");
1097 return -ENODEV;
1098 }
1099
1100 dev_dbg(&usb2->base.dev, "Found unused usb3 port: %d\n", fake);
1101 usb2->usb3_port_fake = fake;
1102 }
1103
1104 return 0;
1105}
1106
1107static int tegra_xusb_setup_ports(struct tegra_xusb_padctl *padctl)
1108{
1109 struct tegra_xusb_port *port;
1110 struct tegra_xusb_usb2_port *usb2;
1111 unsigned int i;
1112 int err = 0;
1113
1114 mutex_lock(&padctl->lock);
1115
1116 for (i = 0; i < padctl->soc->ports.usb2.count; i++) {
1117 err = tegra_xusb_add_usb2_port(padctl, i);
1118 if (err < 0)
1119 goto remove_ports;
1120 }
1121
1122 for (i = 0; i < padctl->soc->ports.ulpi.count; i++) {
1123 err = tegra_xusb_add_ulpi_port(padctl, i);
1124 if (err < 0)
1125 goto remove_ports;
1126 }
1127
1128 for (i = 0; i < padctl->soc->ports.hsic.count; i++) {
1129 err = tegra_xusb_add_hsic_port(padctl, i);
1130 if (err < 0)
1131 goto remove_ports;
1132 }
1133
1134 for (i = 0; i < padctl->soc->ports.usb3.count; i++) {
1135 err = tegra_xusb_add_usb3_port(padctl, i);
1136 if (err < 0)
1137 goto remove_ports;
1138 }
1139
1140 if (padctl->soc->need_fake_usb3_port) {
1141 for (i = 0; i < padctl->soc->ports.usb2.count; i++) {
1142 usb2 = tegra_xusb_find_usb2_port(padctl, i);
1143 if (!usb2)
1144 continue;
1145
1146 err = tegra_xusb_update_usb3_fake_port(usb2);
1147 if (err < 0)
1148 goto remove_ports;
1149 }
1150 }
1151
1152 list_for_each_entry(port, &padctl->ports, list) {
1153 err = port->ops->enable(port);
1154 if (err < 0)
1155 dev_err(padctl->dev, "failed to enable port %s: %d\n",
1156 dev_name(&port->dev), err);
1157 }
1158
1159 goto unlock;
1160
1161remove_ports:
1162 __tegra_xusb_remove_ports(padctl);
1163unlock:
1164 mutex_unlock(&padctl->lock);
1165 return err;
1166}
1167
1168static void tegra_xusb_remove_ports(struct tegra_xusb_padctl *padctl)
1169{
1170 mutex_lock(&padctl->lock);
1171 __tegra_xusb_remove_ports(padctl);
1172 mutex_unlock(&padctl->lock);
1173}
1174
1175static int tegra_xusb_padctl_probe(struct platform_device *pdev)
1176{
1177 struct device_node *np = pdev->dev.of_node;
1178 const struct tegra_xusb_padctl_soc *soc;
1179 struct tegra_xusb_padctl *padctl;
1180 const struct of_device_id *match;
1181 int err;
1182
1183 /* for backwards compatibility with old device trees */
1184 np = of_get_child_by_name(np, "pads");
1185 if (!np) {
1186 dev_warn(&pdev->dev, "deprecated DT, using legacy driver\n");
1187 return tegra_xusb_padctl_legacy_probe(pdev);
1188 }
1189
1190 of_node_put(np);
1191
1192 match = of_match_node(tegra_xusb_padctl_of_match, pdev->dev.of_node);
1193 soc = match->data;
1194
1195 padctl = soc->ops->probe(&pdev->dev, soc);
1196 if (IS_ERR(padctl))
1197 return PTR_ERR(padctl);
1198
1199 platform_set_drvdata(pdev, padctl);
1200 INIT_LIST_HEAD(&padctl->ports);
1201 INIT_LIST_HEAD(&padctl->lanes);
1202 INIT_LIST_HEAD(&padctl->pads);
1203 mutex_init(&padctl->lock);
1204
1205 padctl->regs = devm_platform_ioremap_resource(pdev, 0);
1206 if (IS_ERR(padctl->regs)) {
1207 err = PTR_ERR(padctl->regs);
1208 goto remove;
1209 }
1210
1211 padctl->rst = devm_reset_control_get(&pdev->dev, NULL);
1212 if (IS_ERR(padctl->rst)) {
1213 err = PTR_ERR(padctl->rst);
1214 goto remove;
1215 }
1216
1217 padctl->supplies = devm_kcalloc(&pdev->dev, padctl->soc->num_supplies,
1218 sizeof(*padctl->supplies), GFP_KERNEL);
1219 if (!padctl->supplies) {
1220 err = -ENOMEM;
1221 goto remove;
1222 }
1223
1224 regulator_bulk_set_supply_names(padctl->supplies,
1225 padctl->soc->supply_names,
1226 padctl->soc->num_supplies);
1227
1228 err = devm_regulator_bulk_get(&pdev->dev, padctl->soc->num_supplies,
1229 padctl->supplies);
1230 if (err < 0) {
1231 dev_err_probe(&pdev->dev, err, "failed to get regulators\n");
1232 goto remove;
1233 }
1234
1235 err = reset_control_deassert(padctl->rst);
1236 if (err < 0)
1237 goto remove;
1238
1239 err = regulator_bulk_enable(padctl->soc->num_supplies,
1240 padctl->supplies);
1241 if (err < 0) {
1242 dev_err(&pdev->dev, "failed to enable supplies: %d\n", err);
1243 goto reset;
1244 }
1245
1246 err = tegra_xusb_setup_pads(padctl);
1247 if (err < 0) {
1248 dev_err(&pdev->dev, "failed to setup pads: %d\n", err);
1249 goto power_down;
1250 }
1251
1252 err = tegra_xusb_setup_ports(padctl);
1253 if (err) {
1254 const char *level = KERN_ERR;
1255
1256 if (err == -EPROBE_DEFER)
1257 level = KERN_DEBUG;
1258
1259 dev_printk(level, &pdev->dev,
1260 dev_fmt("failed to setup XUSB ports: %d\n"), err);
1261 goto remove_pads;
1262 }
1263
1264 return 0;
1265
1266remove_pads:
1267 tegra_xusb_remove_pads(padctl);
1268power_down:
1269 regulator_bulk_disable(padctl->soc->num_supplies, padctl->supplies);
1270reset:
1271 reset_control_assert(padctl->rst);
1272remove:
1273 platform_set_drvdata(pdev, NULL);
1274 soc->ops->remove(padctl);
1275 return err;
1276}
1277
1278static void tegra_xusb_padctl_remove(struct platform_device *pdev)
1279{
1280 struct tegra_xusb_padctl *padctl = platform_get_drvdata(pdev);
1281 int err;
1282
1283 tegra_xusb_remove_ports(padctl);
1284 tegra_xusb_remove_pads(padctl);
1285
1286 err = regulator_bulk_disable(padctl->soc->num_supplies,
1287 padctl->supplies);
1288 if (err < 0)
1289 dev_err(&pdev->dev, "failed to disable supplies: %d\n", err);
1290
1291 err = reset_control_assert(padctl->rst);
1292 if (err < 0)
1293 dev_err(&pdev->dev, "failed to assert reset: %d\n", err);
1294
1295 padctl->soc->ops->remove(padctl);
1296}
1297
1298static __maybe_unused int tegra_xusb_padctl_suspend_noirq(struct device *dev)
1299{
1300 struct tegra_xusb_padctl *padctl = dev_get_drvdata(dev);
1301
1302 if (padctl->soc && padctl->soc->ops && padctl->soc->ops->suspend_noirq)
1303 return padctl->soc->ops->suspend_noirq(padctl);
1304
1305 return 0;
1306}
1307
1308static __maybe_unused int tegra_xusb_padctl_resume_noirq(struct device *dev)
1309{
1310 struct tegra_xusb_padctl *padctl = dev_get_drvdata(dev);
1311
1312 if (padctl->soc && padctl->soc->ops && padctl->soc->ops->resume_noirq)
1313 return padctl->soc->ops->resume_noirq(padctl);
1314
1315 return 0;
1316}
1317
1318static const struct dev_pm_ops tegra_xusb_padctl_pm_ops = {
1319 SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(tegra_xusb_padctl_suspend_noirq,
1320 tegra_xusb_padctl_resume_noirq)
1321};
1322
1323static struct platform_driver tegra_xusb_padctl_driver = {
1324 .driver = {
1325 .name = "tegra-xusb-padctl",
1326 .of_match_table = tegra_xusb_padctl_of_match,
1327 .pm = &tegra_xusb_padctl_pm_ops,
1328 },
1329 .probe = tegra_xusb_padctl_probe,
1330 .remove = tegra_xusb_padctl_remove,
1331};
1332module_platform_driver(tegra_xusb_padctl_driver);
1333
1334struct tegra_xusb_padctl *tegra_xusb_padctl_get(struct device *dev)
1335{
1336 struct tegra_xusb_padctl *padctl;
1337 struct platform_device *pdev;
1338 struct device_node *np;
1339
1340 np = of_parse_phandle(dev->of_node, "nvidia,xusb-padctl", 0);
1341 if (!np)
1342 return ERR_PTR(-EINVAL);
1343
1344 /*
1345 * This is slightly ugly. A better implementation would be to keep a
1346 * registry of pad controllers, but since there will almost certainly
1347 * only ever be one per SoC that would be a little overkill.
1348 */
1349 pdev = of_find_device_by_node(np);
1350 if (!pdev) {
1351 of_node_put(np);
1352 return ERR_PTR(-ENODEV);
1353 }
1354
1355 of_node_put(np);
1356
1357 padctl = platform_get_drvdata(pdev);
1358 if (!padctl) {
1359 put_device(&pdev->dev);
1360 return ERR_PTR(-EPROBE_DEFER);
1361 }
1362
1363 return padctl;
1364}
1365EXPORT_SYMBOL_GPL(tegra_xusb_padctl_get);
1366
1367void tegra_xusb_padctl_put(struct tegra_xusb_padctl *padctl)
1368{
1369 if (padctl)
1370 put_device(padctl->dev);
1371}
1372EXPORT_SYMBOL_GPL(tegra_xusb_padctl_put);
1373
1374int tegra_xusb_padctl_usb3_save_context(struct tegra_xusb_padctl *padctl,
1375 unsigned int port)
1376{
1377 if (padctl->soc->ops->usb3_save_context)
1378 return padctl->soc->ops->usb3_save_context(padctl, port);
1379
1380 return -ENOSYS;
1381}
1382EXPORT_SYMBOL_GPL(tegra_xusb_padctl_usb3_save_context);
1383
1384int tegra_xusb_padctl_hsic_set_idle(struct tegra_xusb_padctl *padctl,
1385 unsigned int port, bool idle)
1386{
1387 if (padctl->soc->ops->hsic_set_idle)
1388 return padctl->soc->ops->hsic_set_idle(padctl, port, idle);
1389
1390 return -ENOSYS;
1391}
1392EXPORT_SYMBOL_GPL(tegra_xusb_padctl_hsic_set_idle);
1393
1394int tegra_xusb_padctl_enable_phy_sleepwalk(struct tegra_xusb_padctl *padctl, struct phy *phy,
1395 enum usb_device_speed speed)
1396{
1397 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
1398
1399 if (lane->pad->ops->enable_phy_sleepwalk)
1400 return lane->pad->ops->enable_phy_sleepwalk(lane, speed);
1401
1402 return -EOPNOTSUPP;
1403}
1404EXPORT_SYMBOL_GPL(tegra_xusb_padctl_enable_phy_sleepwalk);
1405
1406int tegra_xusb_padctl_disable_phy_sleepwalk(struct tegra_xusb_padctl *padctl, struct phy *phy)
1407{
1408 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
1409
1410 if (lane->pad->ops->disable_phy_sleepwalk)
1411 return lane->pad->ops->disable_phy_sleepwalk(lane);
1412
1413 return -EOPNOTSUPP;
1414}
1415EXPORT_SYMBOL_GPL(tegra_xusb_padctl_disable_phy_sleepwalk);
1416
1417int tegra_xusb_padctl_enable_phy_wake(struct tegra_xusb_padctl *padctl, struct phy *phy)
1418{
1419 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
1420
1421 if (lane->pad->ops->enable_phy_wake)
1422 return lane->pad->ops->enable_phy_wake(lane);
1423
1424 return -EOPNOTSUPP;
1425}
1426EXPORT_SYMBOL_GPL(tegra_xusb_padctl_enable_phy_wake);
1427
1428int tegra_xusb_padctl_disable_phy_wake(struct tegra_xusb_padctl *padctl, struct phy *phy)
1429{
1430 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
1431
1432 if (lane->pad->ops->disable_phy_wake)
1433 return lane->pad->ops->disable_phy_wake(lane);
1434
1435 return -EOPNOTSUPP;
1436}
1437EXPORT_SYMBOL_GPL(tegra_xusb_padctl_disable_phy_wake);
1438
1439bool tegra_xusb_padctl_remote_wake_detected(struct tegra_xusb_padctl *padctl, struct phy *phy)
1440{
1441 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
1442
1443 if (lane->pad->ops->remote_wake_detected)
1444 return lane->pad->ops->remote_wake_detected(lane);
1445
1446 return false;
1447}
1448EXPORT_SYMBOL_GPL(tegra_xusb_padctl_remote_wake_detected);
1449
1450int tegra_xusb_padctl_usb3_set_lfps_detect(struct tegra_xusb_padctl *padctl,
1451 unsigned int port, bool enable)
1452{
1453 if (padctl->soc->ops->usb3_set_lfps_detect)
1454 return padctl->soc->ops->usb3_set_lfps_detect(padctl, port,
1455 enable);
1456
1457 return -ENOSYS;
1458}
1459EXPORT_SYMBOL_GPL(tegra_xusb_padctl_usb3_set_lfps_detect);
1460
1461int tegra_xusb_padctl_set_vbus_override(struct tegra_xusb_padctl *padctl,
1462 bool val)
1463{
1464 if (padctl->soc->ops->vbus_override)
1465 return padctl->soc->ops->vbus_override(padctl, val);
1466
1467 return -ENOTSUPP;
1468}
1469EXPORT_SYMBOL_GPL(tegra_xusb_padctl_set_vbus_override);
1470
1471int tegra_phy_xusb_utmi_port_reset(struct phy *phy)
1472{
1473 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
1474 struct tegra_xusb_padctl *padctl = lane->pad->padctl;
1475
1476 if (padctl->soc->ops->utmi_port_reset)
1477 return padctl->soc->ops->utmi_port_reset(phy);
1478
1479 return -ENOTSUPP;
1480}
1481EXPORT_SYMBOL_GPL(tegra_phy_xusb_utmi_port_reset);
1482
1483void tegra_phy_xusb_utmi_pad_power_on(struct phy *phy)
1484{
1485 struct tegra_xusb_lane *lane;
1486 struct tegra_xusb_padctl *padctl;
1487
1488 if (!phy)
1489 return;
1490
1491 lane = phy_get_drvdata(phy);
1492 padctl = lane->pad->padctl;
1493
1494 if (padctl->soc->ops->utmi_pad_power_on)
1495 padctl->soc->ops->utmi_pad_power_on(phy);
1496}
1497EXPORT_SYMBOL_GPL(tegra_phy_xusb_utmi_pad_power_on);
1498
1499void tegra_phy_xusb_utmi_pad_power_down(struct phy *phy)
1500{
1501 struct tegra_xusb_lane *lane;
1502 struct tegra_xusb_padctl *padctl;
1503
1504 if (!phy)
1505 return;
1506
1507 lane = phy_get_drvdata(phy);
1508 padctl = lane->pad->padctl;
1509
1510 if (padctl->soc->ops->utmi_pad_power_down)
1511 padctl->soc->ops->utmi_pad_power_down(phy);
1512}
1513EXPORT_SYMBOL_GPL(tegra_phy_xusb_utmi_pad_power_down);
1514
1515int tegra_xusb_padctl_get_usb3_companion(struct tegra_xusb_padctl *padctl,
1516 unsigned int port)
1517{
1518 struct tegra_xusb_usb2_port *usb2;
1519 struct tegra_xusb_usb3_port *usb3;
1520 int i;
1521
1522 usb2 = tegra_xusb_find_usb2_port(padctl, port);
1523 if (!usb2)
1524 return -EINVAL;
1525
1526 for (i = 0; i < padctl->soc->ports.usb3.count; i++) {
1527 usb3 = tegra_xusb_find_usb3_port(padctl, i);
1528 if (usb3 && usb3->port == usb2->base.index)
1529 return usb3->base.index;
1530 }
1531
1532 return -ENODEV;
1533}
1534EXPORT_SYMBOL_GPL(tegra_xusb_padctl_get_usb3_companion);
1535
1536int tegra_xusb_padctl_get_port_number(struct phy *phy)
1537{
1538 struct tegra_xusb_lane *lane;
1539
1540 if (!phy)
1541 return -ENODEV;
1542
1543 lane = phy_get_drvdata(phy);
1544
1545 return lane->index;
1546}
1547EXPORT_SYMBOL_GPL(tegra_xusb_padctl_get_port_number);
1548
1549MODULE_AUTHOR("Thierry Reding <treding@nvidia.com>");
1550MODULE_DESCRIPTION("Tegra XUSB Pad Controller driver");
1551MODULE_LICENSE("GPL v2");