2 * Copyright (c) 2014-2015, NVIDIA CORPORATION. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 #include <linux/delay.h>
16 #include <linux/mailbox_client.h>
17 #include <linux/module.h>
19 #include <linux/of_device.h>
20 #include <linux/phy/phy.h>
21 #include <linux/phy/tegra/xusb.h>
22 #include <linux/platform_device.h>
23 #include <linux/regulator/consumer.h>
24 #include <linux/reset.h>
25 #include <linux/slab.h>
26 #include <linux/workqueue.h>
28 #include <soc/tegra/fuse.h>
32 static struct phy *tegra_xusb_pad_of_xlate(struct device *dev,
33 struct of_phandle_args *args)
35 struct tegra_xusb_pad *pad = dev_get_drvdata(dev);
36 struct phy *phy = NULL;
39 if (args->args_count != 0)
40 return ERR_PTR(-EINVAL);
42 for (i = 0; i < pad->soc->num_lanes; i++) {
46 if (pad->lanes[i]->dev.of_node == args->np) {
53 phy = ERR_PTR(-ENODEV);
58 static const struct of_device_id tegra_xusb_padctl_of_match[] = {
59 #if defined(CONFIG_ARCH_TEGRA_124_SOC) || defined(CONFIG_ARCH_TEGRA_132_SOC)
61 .compatible = "nvidia,tegra124-xusb-padctl",
62 .data = &tegra124_xusb_padctl_soc,
65 #if defined(CONFIG_ARCH_TEGRA_210_SOC)
67 .compatible = "nvidia,tegra210-xusb-padctl",
68 .data = &tegra210_xusb_padctl_soc,
73 MODULE_DEVICE_TABLE(of, tegra_xusb_padctl_of_match);
75 static struct device_node *
76 tegra_xusb_find_pad_node(struct tegra_xusb_padctl *padctl, const char *name)
78 struct device_node *pads, *np;
80 pads = of_get_child_by_name(padctl->dev->of_node, "pads");
84 np = of_get_child_by_name(pads, name);
90 static struct device_node *
91 tegra_xusb_pad_find_phy_node(struct tegra_xusb_pad *pad, unsigned int index)
93 struct device_node *np, *lanes;
95 lanes = of_get_child_by_name(pad->dev.of_node, "lanes");
99 np = of_get_child_by_name(lanes, pad->soc->lanes[index].name);
106 tegra_xusb_lane_lookup_function(struct tegra_xusb_lane *lane,
107 const char *function)
111 for (i = 0; i < lane->soc->num_funcs; i++)
112 if (strcmp(function, lane->soc->funcs[i]) == 0)
118 int tegra_xusb_lane_parse_dt(struct tegra_xusb_lane *lane,
119 struct device_node *np)
121 struct device *dev = &lane->pad->dev;
122 const char *function;
125 err = of_property_read_string(np, "nvidia,function", &function);
129 err = tegra_xusb_lane_lookup_function(lane, function);
131 dev_err(dev, "invalid function \"%s\" for lane \"%s\"\n",
136 lane->function = err;
141 static void tegra_xusb_lane_destroy(struct phy *phy)
144 struct tegra_xusb_lane *lane = phy_get_drvdata(phy);
146 lane->pad->ops->remove(lane);
151 static void tegra_xusb_pad_release(struct device *dev)
153 struct tegra_xusb_pad *pad = to_tegra_xusb_pad(dev);
155 pad->soc->ops->remove(pad);
158 static struct device_type tegra_xusb_pad_type = {
159 .release = tegra_xusb_pad_release,
162 int tegra_xusb_pad_init(struct tegra_xusb_pad *pad,
163 struct tegra_xusb_padctl *padctl,
164 struct device_node *np)
168 device_initialize(&pad->dev);
169 INIT_LIST_HEAD(&pad->list);
170 pad->dev.parent = padctl->dev;
171 pad->dev.type = &tegra_xusb_pad_type;
172 pad->dev.of_node = np;
173 pad->padctl = padctl;
175 err = dev_set_name(&pad->dev, "%s", pad->soc->name);
179 err = device_add(&pad->dev);
186 device_unregister(&pad->dev);
190 int tegra_xusb_pad_register(struct tegra_xusb_pad *pad,
191 const struct phy_ops *ops)
193 struct device_node *children;
198 children = of_get_child_by_name(pad->dev.of_node, "lanes");
202 pad->lanes = devm_kcalloc(&pad->dev, pad->soc->num_lanes, sizeof(lane),
205 of_node_put(children);
209 for (i = 0; i < pad->soc->num_lanes; i++) {
210 struct device_node *np = tegra_xusb_pad_find_phy_node(pad, i);
211 struct tegra_xusb_lane *lane;
213 /* skip disabled lanes */
214 if (!np || !of_device_is_available(np)) {
219 pad->lanes[i] = phy_create(&pad->dev, np, ops);
220 if (IS_ERR(pad->lanes[i])) {
221 err = PTR_ERR(pad->lanes[i]);
226 lane = pad->ops->probe(pad, np, i);
228 phy_destroy(pad->lanes[i]);
233 list_add_tail(&lane->list, &pad->padctl->lanes);
234 phy_set_drvdata(pad->lanes[i], lane);
237 pad->provider = of_phy_provider_register_full(&pad->dev, children,
238 tegra_xusb_pad_of_xlate);
239 if (IS_ERR(pad->provider)) {
240 err = PTR_ERR(pad->provider);
248 tegra_xusb_lane_destroy(pad->lanes[i]);
250 of_node_put(children);
255 void tegra_xusb_pad_unregister(struct tegra_xusb_pad *pad)
257 unsigned int i = pad->soc->num_lanes;
259 of_phy_provider_unregister(pad->provider);
262 tegra_xusb_lane_destroy(pad->lanes[i]);
264 device_unregister(&pad->dev);
267 static struct tegra_xusb_pad *
268 tegra_xusb_pad_create(struct tegra_xusb_padctl *padctl,
269 const struct tegra_xusb_pad_soc *soc)
271 struct tegra_xusb_pad *pad;
272 struct device_node *np;
275 np = tegra_xusb_find_pad_node(padctl, soc->name);
276 if (!np || !of_device_is_available(np))
279 pad = soc->ops->probe(padctl, soc, np);
282 dev_err(padctl->dev, "failed to create pad %s: %d\n",
287 /* XXX move this into ->probe() to avoid string comparison */
288 if (strcmp(soc->name, "pcie") == 0)
291 if (strcmp(soc->name, "sata") == 0)
294 if (strcmp(soc->name, "usb2") == 0)
297 if (strcmp(soc->name, "ulpi") == 0)
300 if (strcmp(soc->name, "hsic") == 0)
306 static void __tegra_xusb_remove_pads(struct tegra_xusb_padctl *padctl)
308 struct tegra_xusb_pad *pad, *tmp;
310 list_for_each_entry_safe_reverse(pad, tmp, &padctl->pads, list) {
311 list_del(&pad->list);
312 tegra_xusb_pad_unregister(pad);
316 static void tegra_xusb_remove_pads(struct tegra_xusb_padctl *padctl)
318 mutex_lock(&padctl->lock);
319 __tegra_xusb_remove_pads(padctl);
320 mutex_unlock(&padctl->lock);
323 static void tegra_xusb_lane_program(struct tegra_xusb_lane *lane)
325 struct tegra_xusb_padctl *padctl = lane->pad->padctl;
326 const struct tegra_xusb_lane_soc *soc = lane->soc;
329 /* choose function */
330 value = padctl_readl(padctl, soc->offset);
331 value &= ~(soc->mask << soc->shift);
332 value |= lane->function << soc->shift;
333 padctl_writel(padctl, value, soc->offset);
336 static void tegra_xusb_pad_program(struct tegra_xusb_pad *pad)
340 for (i = 0; i < pad->soc->num_lanes; i++) {
341 struct tegra_xusb_lane *lane;
344 lane = phy_get_drvdata(pad->lanes[i]);
345 tegra_xusb_lane_program(lane);
350 static int tegra_xusb_setup_pads(struct tegra_xusb_padctl *padctl)
352 struct tegra_xusb_pad *pad;
355 mutex_lock(&padctl->lock);
357 for (i = 0; i < padctl->soc->num_pads; i++) {
358 const struct tegra_xusb_pad_soc *soc = padctl->soc->pads[i];
361 pad = tegra_xusb_pad_create(padctl, soc);
364 dev_err(padctl->dev, "failed to create pad %s: %d\n",
366 __tegra_xusb_remove_pads(padctl);
367 mutex_unlock(&padctl->lock);
374 list_add_tail(&pad->list, &padctl->pads);
377 list_for_each_entry(pad, &padctl->pads, list)
378 tegra_xusb_pad_program(pad);
380 mutex_unlock(&padctl->lock);
384 static bool tegra_xusb_lane_check(struct tegra_xusb_lane *lane,
385 const char *function)
387 const char *func = lane->soc->funcs[lane->function];
389 return strcmp(function, func) == 0;
392 struct tegra_xusb_lane *tegra_xusb_find_lane(struct tegra_xusb_padctl *padctl,
396 struct tegra_xusb_lane *lane, *hit = ERR_PTR(-ENODEV);
399 name = kasprintf(GFP_KERNEL, "%s-%u", type, index);
401 return ERR_PTR(-ENOMEM);
403 list_for_each_entry(lane, &padctl->lanes, list) {
404 if (strcmp(lane->soc->name, name) == 0) {
414 struct tegra_xusb_lane *
415 tegra_xusb_port_find_lane(struct tegra_xusb_port *port,
416 const struct tegra_xusb_lane_map *map,
417 const char *function)
419 struct tegra_xusb_lane *lane, *match = ERR_PTR(-ENODEV);
421 for (; map->type; map++) {
422 if (port->index != map->port)
425 lane = tegra_xusb_find_lane(port->padctl, map->type,
430 if (!tegra_xusb_lane_check(lane, function))
434 dev_err(&port->dev, "conflicting match: %s-%u / %s\n",
435 map->type, map->index, match->soc->name);
443 static struct device_node *
444 tegra_xusb_find_port_node(struct tegra_xusb_padctl *padctl, const char *type,
447 struct device_node *ports, *np;
450 ports = of_get_child_by_name(padctl->dev->of_node, "ports");
454 name = kasprintf(GFP_KERNEL, "%s-%u", type, index);
457 return ERR_PTR(-ENOMEM);
459 np = of_get_child_by_name(ports, name);
466 struct tegra_xusb_port *
467 tegra_xusb_find_port(struct tegra_xusb_padctl *padctl, const char *type,
470 struct tegra_xusb_port *port;
471 struct device_node *np;
473 np = tegra_xusb_find_port_node(padctl, type, index);
477 list_for_each_entry(port, &padctl->ports, list) {
478 if (np == port->dev.of_node) {
489 struct tegra_xusb_usb2_port *
490 tegra_xusb_find_usb2_port(struct tegra_xusb_padctl *padctl, unsigned int index)
492 struct tegra_xusb_port *port;
494 port = tegra_xusb_find_port(padctl, "usb2", index);
496 return to_usb2_port(port);
501 struct tegra_xusb_usb3_port *
502 tegra_xusb_find_usb3_port(struct tegra_xusb_padctl *padctl, unsigned int index)
504 struct tegra_xusb_port *port;
506 port = tegra_xusb_find_port(padctl, "usb3", index);
508 return to_usb3_port(port);
513 static void tegra_xusb_port_release(struct device *dev)
517 static struct device_type tegra_xusb_port_type = {
518 .release = tegra_xusb_port_release,
521 static int tegra_xusb_port_init(struct tegra_xusb_port *port,
522 struct tegra_xusb_padctl *padctl,
523 struct device_node *np,
529 INIT_LIST_HEAD(&port->list);
530 port->padctl = padctl;
533 device_initialize(&port->dev);
534 port->dev.type = &tegra_xusb_port_type;
535 port->dev.of_node = of_node_get(np);
536 port->dev.parent = padctl->dev;
538 err = dev_set_name(&port->dev, "%s-%u", name, index);
542 err = device_add(&port->dev);
549 device_unregister(&port->dev);
553 static void tegra_xusb_port_unregister(struct tegra_xusb_port *port)
555 device_unregister(&port->dev);
558 static int tegra_xusb_usb2_port_parse_dt(struct tegra_xusb_usb2_port *usb2)
560 struct tegra_xusb_port *port = &usb2->base;
561 struct device_node *np = port->dev.of_node;
563 usb2->internal = of_property_read_bool(np, "nvidia,internal");
565 usb2->supply = devm_regulator_get(&port->dev, "vbus");
566 return PTR_ERR_OR_ZERO(usb2->supply);
569 static int tegra_xusb_add_usb2_port(struct tegra_xusb_padctl *padctl,
572 struct tegra_xusb_usb2_port *usb2;
573 struct device_node *np;
577 * USB2 ports don't require additional properties, but if the port is
578 * marked as disabled there is no reason to register it.
580 np = tegra_xusb_find_port_node(padctl, "usb2", index);
581 if (!np || !of_device_is_available(np))
584 usb2 = devm_kzalloc(padctl->dev, sizeof(*usb2), GFP_KERNEL);
590 err = tegra_xusb_port_init(&usb2->base, padctl, np, "usb2", index);
594 usb2->base.ops = padctl->soc->ports.usb2.ops;
596 usb2->base.lane = usb2->base.ops->map(&usb2->base);
597 if (IS_ERR(usb2->base.lane)) {
598 err = PTR_ERR(usb2->base.lane);
599 tegra_xusb_port_unregister(&usb2->base);
603 err = tegra_xusb_usb2_port_parse_dt(usb2);
605 tegra_xusb_port_unregister(&usb2->base);
609 list_add_tail(&usb2->base.list, &padctl->ports);
616 static int tegra_xusb_ulpi_port_parse_dt(struct tegra_xusb_ulpi_port *ulpi)
618 struct tegra_xusb_port *port = &ulpi->base;
619 struct device_node *np = port->dev.of_node;
621 ulpi->internal = of_property_read_bool(np, "nvidia,internal");
626 static int tegra_xusb_add_ulpi_port(struct tegra_xusb_padctl *padctl,
629 struct tegra_xusb_ulpi_port *ulpi;
630 struct device_node *np;
633 np = tegra_xusb_find_port_node(padctl, "ulpi", index);
634 if (!np || !of_device_is_available(np))
637 ulpi = devm_kzalloc(padctl->dev, sizeof(*ulpi), GFP_KERNEL);
643 err = tegra_xusb_port_init(&ulpi->base, padctl, np, "ulpi", index);
647 ulpi->base.ops = padctl->soc->ports.ulpi.ops;
649 ulpi->base.lane = ulpi->base.ops->map(&ulpi->base);
650 if (IS_ERR(ulpi->base.lane)) {
651 err = PTR_ERR(ulpi->base.lane);
652 tegra_xusb_port_unregister(&ulpi->base);
656 err = tegra_xusb_ulpi_port_parse_dt(ulpi);
658 tegra_xusb_port_unregister(&ulpi->base);
662 list_add_tail(&ulpi->base.list, &padctl->ports);
669 static int tegra_xusb_hsic_port_parse_dt(struct tegra_xusb_hsic_port *hsic)
675 static int tegra_xusb_add_hsic_port(struct tegra_xusb_padctl *padctl,
678 struct tegra_xusb_hsic_port *hsic;
679 struct device_node *np;
682 np = tegra_xusb_find_port_node(padctl, "hsic", index);
683 if (!np || !of_device_is_available(np))
686 hsic = devm_kzalloc(padctl->dev, sizeof(*hsic), GFP_KERNEL);
692 err = tegra_xusb_port_init(&hsic->base, padctl, np, "hsic", index);
696 hsic->base.ops = padctl->soc->ports.hsic.ops;
698 hsic->base.lane = hsic->base.ops->map(&hsic->base);
699 if (IS_ERR(hsic->base.lane)) {
700 err = PTR_ERR(hsic->base.lane);
704 err = tegra_xusb_hsic_port_parse_dt(hsic);
706 tegra_xusb_port_unregister(&hsic->base);
710 list_add_tail(&hsic->base.list, &padctl->ports);
717 static int tegra_xusb_usb3_port_parse_dt(struct tegra_xusb_usb3_port *usb3)
719 struct tegra_xusb_port *port = &usb3->base;
720 struct device_node *np = port->dev.of_node;
724 err = of_property_read_u32(np, "nvidia,usb2-companion", &value);
726 dev_err(&port->dev, "failed to read port: %d\n", err);
732 usb3->internal = of_property_read_bool(np, "nvidia,internal");
734 usb3->supply = devm_regulator_get(&port->dev, "vbus");
735 return PTR_ERR_OR_ZERO(usb3->supply);
738 static int tegra_xusb_add_usb3_port(struct tegra_xusb_padctl *padctl,
741 struct tegra_xusb_usb3_port *usb3;
742 struct device_node *np;
746 * If there is no supplemental configuration in the device tree the
747 * port is unusable. But it is valid to configure only a single port,
748 * hence return 0 instead of an error to allow ports to be optional.
750 np = tegra_xusb_find_port_node(padctl, "usb3", index);
751 if (!np || !of_device_is_available(np))
754 usb3 = devm_kzalloc(padctl->dev, sizeof(*usb3), GFP_KERNEL);
760 err = tegra_xusb_port_init(&usb3->base, padctl, np, "usb3", index);
764 usb3->base.ops = padctl->soc->ports.usb3.ops;
766 usb3->base.lane = usb3->base.ops->map(&usb3->base);
767 if (IS_ERR(usb3->base.lane)) {
768 err = PTR_ERR(usb3->base.lane);
772 err = tegra_xusb_usb3_port_parse_dt(usb3);
774 tegra_xusb_port_unregister(&usb3->base);
778 list_add_tail(&usb3->base.list, &padctl->ports);
785 static void __tegra_xusb_remove_ports(struct tegra_xusb_padctl *padctl)
787 struct tegra_xusb_port *port, *tmp;
789 list_for_each_entry_safe_reverse(port, tmp, &padctl->ports, list) {
790 list_del(&port->list);
791 tegra_xusb_port_unregister(port);
795 static int tegra_xusb_setup_ports(struct tegra_xusb_padctl *padctl)
797 struct tegra_xusb_port *port;
801 mutex_lock(&padctl->lock);
803 for (i = 0; i < padctl->soc->ports.usb2.count; i++) {
804 err = tegra_xusb_add_usb2_port(padctl, i);
809 for (i = 0; i < padctl->soc->ports.ulpi.count; i++) {
810 err = tegra_xusb_add_ulpi_port(padctl, i);
815 for (i = 0; i < padctl->soc->ports.hsic.count; i++) {
816 err = tegra_xusb_add_hsic_port(padctl, i);
821 for (i = 0; i < padctl->soc->ports.usb3.count; i++) {
822 err = tegra_xusb_add_usb3_port(padctl, i);
827 list_for_each_entry(port, &padctl->ports, list) {
828 err = port->ops->enable(port);
830 dev_err(padctl->dev, "failed to enable port %s: %d\n",
831 dev_name(&port->dev), err);
837 __tegra_xusb_remove_ports(padctl);
839 mutex_unlock(&padctl->lock);
843 static void tegra_xusb_remove_ports(struct tegra_xusb_padctl *padctl)
845 mutex_lock(&padctl->lock);
846 __tegra_xusb_remove_ports(padctl);
847 mutex_unlock(&padctl->lock);
850 static int tegra_xusb_padctl_probe(struct platform_device *pdev)
852 struct device_node *np = pdev->dev.of_node;
853 const struct tegra_xusb_padctl_soc *soc;
854 struct tegra_xusb_padctl *padctl;
855 const struct of_device_id *match;
856 struct resource *res;
859 /* for backwards compatibility with old device trees */
860 np = of_get_child_by_name(np, "pads");
862 dev_warn(&pdev->dev, "deprecated DT, using legacy driver\n");
863 return tegra_xusb_padctl_legacy_probe(pdev);
868 match = of_match_node(tegra_xusb_padctl_of_match, pdev->dev.of_node);
871 padctl = soc->ops->probe(&pdev->dev, soc);
873 return PTR_ERR(padctl);
875 platform_set_drvdata(pdev, padctl);
876 INIT_LIST_HEAD(&padctl->ports);
877 INIT_LIST_HEAD(&padctl->lanes);
878 INIT_LIST_HEAD(&padctl->pads);
879 mutex_init(&padctl->lock);
881 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
882 padctl->regs = devm_ioremap_resource(&pdev->dev, res);
883 if (IS_ERR(padctl->regs)) {
884 err = PTR_ERR(padctl->regs);
888 padctl->rst = devm_reset_control_get(&pdev->dev, NULL);
889 if (IS_ERR(padctl->rst)) {
890 err = PTR_ERR(padctl->rst);
894 err = reset_control_deassert(padctl->rst);
898 err = tegra_xusb_setup_pads(padctl);
900 dev_err(&pdev->dev, "failed to setup pads: %d\n", err);
904 err = tegra_xusb_setup_ports(padctl);
906 dev_err(&pdev->dev, "failed to setup XUSB ports: %d\n", err);
913 tegra_xusb_remove_pads(padctl);
915 reset_control_assert(padctl->rst);
917 platform_set_drvdata(pdev, NULL);
918 soc->ops->remove(padctl);
922 static int tegra_xusb_padctl_remove(struct platform_device *pdev)
924 struct tegra_xusb_padctl *padctl = platform_get_drvdata(pdev);
927 tegra_xusb_remove_ports(padctl);
928 tegra_xusb_remove_pads(padctl);
930 err = reset_control_assert(padctl->rst);
932 dev_err(&pdev->dev, "failed to assert reset: %d\n", err);
934 padctl->soc->ops->remove(padctl);
939 static struct platform_driver tegra_xusb_padctl_driver = {
941 .name = "tegra-xusb-padctl",
942 .of_match_table = tegra_xusb_padctl_of_match,
944 .probe = tegra_xusb_padctl_probe,
945 .remove = tegra_xusb_padctl_remove,
947 module_platform_driver(tegra_xusb_padctl_driver);
949 struct tegra_xusb_padctl *tegra_xusb_padctl_get(struct device *dev)
951 struct tegra_xusb_padctl *padctl;
952 struct platform_device *pdev;
953 struct device_node *np;
955 np = of_parse_phandle(dev->of_node, "nvidia,xusb-padctl", 0);
957 return ERR_PTR(-EINVAL);
960 * This is slightly ugly. A better implementation would be to keep a
961 * registry of pad controllers, but since there will almost certainly
962 * only ever be one per SoC that would be a little overkill.
964 pdev = of_find_device_by_node(np);
967 return ERR_PTR(-ENODEV);
972 padctl = platform_get_drvdata(pdev);
974 put_device(&pdev->dev);
975 return ERR_PTR(-EPROBE_DEFER);
980 EXPORT_SYMBOL_GPL(tegra_xusb_padctl_get);
982 void tegra_xusb_padctl_put(struct tegra_xusb_padctl *padctl)
985 put_device(padctl->dev);
987 EXPORT_SYMBOL_GPL(tegra_xusb_padctl_put);
989 int tegra_xusb_padctl_usb3_save_context(struct tegra_xusb_padctl *padctl,
992 if (padctl->soc->ops->usb3_save_context)
993 return padctl->soc->ops->usb3_save_context(padctl, port);
997 EXPORT_SYMBOL_GPL(tegra_xusb_padctl_usb3_save_context);
999 int tegra_xusb_padctl_hsic_set_idle(struct tegra_xusb_padctl *padctl,
1000 unsigned int port, bool idle)
1002 if (padctl->soc->ops->hsic_set_idle)
1003 return padctl->soc->ops->hsic_set_idle(padctl, port, idle);
1007 EXPORT_SYMBOL_GPL(tegra_xusb_padctl_hsic_set_idle);
1009 int tegra_xusb_padctl_usb3_set_lfps_detect(struct tegra_xusb_padctl *padctl,
1010 unsigned int port, bool enable)
1012 if (padctl->soc->ops->usb3_set_lfps_detect)
1013 return padctl->soc->ops->usb3_set_lfps_detect(padctl, port,
1018 EXPORT_SYMBOL_GPL(tegra_xusb_padctl_usb3_set_lfps_detect);
1020 MODULE_AUTHOR("Thierry Reding <treding@nvidia.com>");
1021 MODULE_DESCRIPTION("Tegra XUSB Pad Controller driver");
1022 MODULE_LICENSE("GPL v2");