1 // SPDX-License-Identifier: GPL-2.0-only
3 * phy-brcm-usb.c - Broadcom USB Phy Driver
5 * Copyright (C) 2015-2017 Broadcom
9 #include <linux/delay.h>
10 #include <linux/err.h>
12 #include <linux/module.h>
14 #include <linux/phy/phy.h>
15 #include <linux/platform_device.h>
16 #include <linux/interrupt.h>
17 #include <linux/soc/brcmstb/brcmstb.h>
18 #include <dt-bindings/phy/phy.h>
19 #include <linux/mfd/syscon.h>
20 #include <linux/suspend.h>
22 #include "phy-brcm-usb-init.h"
24 static DEFINE_MUTEX(sysfs_lock);
26 enum brcm_usb_phy_id {
32 struct value_to_name_map {
37 struct match_chip_info {
38 void (*init_func)(struct brcm_usb_init_params *params);
39 u8 required_regs[BRCM_REGS_MAX + 1];
43 static const struct value_to_name_map brcm_dr_mode_to_name[] = {
44 { USB_CTLR_MODE_HOST, "host" },
45 { USB_CTLR_MODE_DEVICE, "peripheral" },
46 { USB_CTLR_MODE_DRD, "drd" },
47 { USB_CTLR_MODE_TYPEC_PD, "typec-pd" }
50 static const struct value_to_name_map brcm_dual_mode_to_name[] = {
62 struct brcm_usb_phy_data {
63 struct brcm_usb_init_params ini;
66 struct clk *usb_20_clk;
67 struct clk *usb_30_clk;
68 struct clk *suspend_clk;
69 struct mutex mutex; /* serialize phy init */
72 struct brcm_usb_phy phys[BRCM_USB_PHY_ID_MAX];
73 struct notifier_block pm_notifier;
77 static s8 *node_reg_names[BRCM_REGS_MAX] = {
78 "crtl", "xhci_ec", "xhci_gbl", "usb_phy", "usb_mdio", "bdc_ec"
81 static int brcm_pm_notifier(struct notifier_block *notifier,
82 unsigned long pm_event,
85 struct brcm_usb_phy_data *priv =
86 container_of(notifier, struct brcm_usb_phy_data, pm_notifier);
89 case PM_HIBERNATION_PREPARE:
90 case PM_SUSPEND_PREPARE:
91 priv->pm_active = true;
94 case PM_POST_HIBERNATION:
96 priv->pm_active = false;
102 static irqreturn_t brcm_usb_phy_wake_isr(int irq, void *dev_id)
104 struct device *dev = dev_id;
106 pm_wakeup_event(dev, 0);
111 static int brcm_usb_phy_init(struct phy *gphy)
113 struct brcm_usb_phy *phy = phy_get_drvdata(gphy);
114 struct brcm_usb_phy_data *priv =
115 container_of(phy, struct brcm_usb_phy_data, phys[phy->id]);
121 * Use a lock to make sure a second caller waits until
122 * the base phy is inited before using it.
124 mutex_lock(&priv->mutex);
125 if (priv->init_count++ == 0) {
126 clk_prepare_enable(priv->usb_20_clk);
127 clk_prepare_enable(priv->usb_30_clk);
128 clk_prepare_enable(priv->suspend_clk);
129 brcm_usb_init_common(&priv->ini);
131 mutex_unlock(&priv->mutex);
132 if (phy->id == BRCM_USB_PHY_2_0)
133 brcm_usb_init_eohci(&priv->ini);
134 else if (phy->id == BRCM_USB_PHY_3_0)
135 brcm_usb_init_xhci(&priv->ini);
137 dev_dbg(&gphy->dev, "INIT, id: %d, total: %d\n", phy->id,
143 static int brcm_usb_phy_exit(struct phy *gphy)
145 struct brcm_usb_phy *phy = phy_get_drvdata(gphy);
146 struct brcm_usb_phy_data *priv =
147 container_of(phy, struct brcm_usb_phy_data, phys[phy->id]);
152 dev_dbg(&gphy->dev, "EXIT\n");
153 if (phy->id == BRCM_USB_PHY_2_0)
154 brcm_usb_uninit_eohci(&priv->ini);
155 if (phy->id == BRCM_USB_PHY_3_0)
156 brcm_usb_uninit_xhci(&priv->ini);
158 /* If both xhci and eohci are gone, reset everything else */
159 mutex_lock(&priv->mutex);
160 if (--priv->init_count == 0) {
161 brcm_usb_uninit_common(&priv->ini);
162 clk_disable_unprepare(priv->usb_20_clk);
163 clk_disable_unprepare(priv->usb_30_clk);
164 clk_disable_unprepare(priv->suspend_clk);
166 mutex_unlock(&priv->mutex);
171 static const struct phy_ops brcm_usb_phy_ops = {
172 .init = brcm_usb_phy_init,
173 .exit = brcm_usb_phy_exit,
174 .owner = THIS_MODULE,
177 static struct phy *brcm_usb_phy_xlate(struct device *dev,
178 struct of_phandle_args *args)
180 struct brcm_usb_phy_data *data = dev_get_drvdata(dev);
183 * values 0 and 1 are for backward compatibility with
184 * device tree nodes from older bootloaders.
186 switch (args->args[0]) {
189 if (data->phys[BRCM_USB_PHY_2_0].phy)
190 return data->phys[BRCM_USB_PHY_2_0].phy;
191 dev_warn(dev, "Error, 2.0 Phy not found\n");
195 if (data->phys[BRCM_USB_PHY_3_0].phy)
196 return data->phys[BRCM_USB_PHY_3_0].phy;
197 dev_warn(dev, "Error, 3.0 Phy not found\n");
200 return ERR_PTR(-ENODEV);
203 static int name_to_value(const struct value_to_name_map *table, int count,
204 const char *name, int *value)
209 for (x = 0; x < count; x++) {
210 if (sysfs_streq(name, table[x].name)) {
218 static const char *value_to_name(const struct value_to_name_map *table, int count,
223 return table[value].name;
226 static ssize_t dr_mode_show(struct device *dev,
227 struct device_attribute *attr,
230 struct brcm_usb_phy_data *priv = dev_get_drvdata(dev);
232 return sprintf(buf, "%s\n",
233 value_to_name(&brcm_dr_mode_to_name[0],
234 ARRAY_SIZE(brcm_dr_mode_to_name),
235 priv->ini.supported_port_modes));
237 static DEVICE_ATTR_RO(dr_mode);
239 static ssize_t dual_select_store(struct device *dev,
240 struct device_attribute *attr,
241 const char *buf, size_t len)
243 struct brcm_usb_phy_data *priv = dev_get_drvdata(dev);
247 mutex_lock(&sysfs_lock);
248 res = name_to_value(&brcm_dual_mode_to_name[0],
249 ARRAY_SIZE(brcm_dual_mode_to_name), buf, &value);
251 priv->ini.port_mode = value;
252 brcm_usb_set_dual_select(&priv->ini);
255 mutex_unlock(&sysfs_lock);
259 static ssize_t dual_select_show(struct device *dev,
260 struct device_attribute *attr,
263 struct brcm_usb_phy_data *priv = dev_get_drvdata(dev);
266 mutex_lock(&sysfs_lock);
267 value = brcm_usb_get_dual_select(&priv->ini);
268 mutex_unlock(&sysfs_lock);
269 return sprintf(buf, "%s\n",
270 value_to_name(&brcm_dual_mode_to_name[0],
271 ARRAY_SIZE(brcm_dual_mode_to_name),
274 static DEVICE_ATTR_RW(dual_select);
276 static struct attribute *brcm_usb_phy_attrs[] = {
277 &dev_attr_dr_mode.attr,
278 &dev_attr_dual_select.attr,
282 static const struct attribute_group brcm_usb_phy_group = {
283 .attrs = brcm_usb_phy_attrs,
286 static const struct match_chip_info chip_info_4908 = {
287 .init_func = &brcm_usb_dvr_init_4908,
295 static const struct match_chip_info chip_info_7216 = {
296 .init_func = &brcm_usb_dvr_init_7216,
305 static const struct match_chip_info chip_info_7211b0 = {
306 .init_func = &brcm_usb_dvr_init_7211b0,
315 .optional_reg = BRCM_REGS_BDC_EC,
318 static const struct match_chip_info chip_info_7445 = {
319 .init_func = &brcm_usb_dvr_init_7445,
327 static const struct of_device_id brcm_usb_dt_ids[] = {
329 .compatible = "brcm,bcm4908-usb-phy",
330 .data = &chip_info_4908,
333 .compatible = "brcm,bcm7216-usb-phy",
334 .data = &chip_info_7216,
337 .compatible = "brcm,bcm7211-usb-phy",
338 .data = &chip_info_7211b0,
341 .compatible = "brcm,brcmstb-usb-phy",
342 .data = &chip_info_7445,
347 static int brcm_usb_get_regs(struct platform_device *pdev,
348 enum brcmusb_reg_sel regs,
349 struct brcm_usb_init_params *ini,
352 struct resource *res;
354 /* Older DT nodes have ctrl and optional xhci_ec by index only */
355 res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
356 node_reg_names[regs]);
358 if (regs == BRCM_REGS_CTRL) {
359 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
360 } else if (regs == BRCM_REGS_XHCI_EC) {
361 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
362 /* XHCI_EC registers are optional */
369 "Optional reg %s not found\n",
370 node_reg_names[regs]);
373 dev_err(&pdev->dev, "can't get %s base addr\n",
374 node_reg_names[regs]);
378 ini->regs[regs] = devm_ioremap_resource(&pdev->dev, res);
379 if (IS_ERR(ini->regs[regs])) {
380 dev_err(&pdev->dev, "can't map %s register space\n",
381 node_reg_names[regs]);
387 static int brcm_usb_phy_dvr_init(struct platform_device *pdev,
388 struct brcm_usb_phy_data *priv,
389 struct device_node *dn)
391 struct device *dev = &pdev->dev;
392 struct phy *gphy = NULL;
395 priv->usb_20_clk = of_clk_get_by_name(dn, "sw_usb");
396 if (IS_ERR(priv->usb_20_clk)) {
397 if (PTR_ERR(priv->usb_20_clk) == -EPROBE_DEFER)
398 return -EPROBE_DEFER;
399 dev_info(dev, "Clock not found in Device Tree\n");
400 priv->usb_20_clk = NULL;
402 err = clk_prepare_enable(priv->usb_20_clk);
406 if (priv->has_eohci) {
407 gphy = devm_phy_create(dev, NULL, &brcm_usb_phy_ops);
409 dev_err(dev, "failed to create EHCI/OHCI PHY\n");
410 return PTR_ERR(gphy);
412 priv->phys[BRCM_USB_PHY_2_0].phy = gphy;
413 priv->phys[BRCM_USB_PHY_2_0].id = BRCM_USB_PHY_2_0;
414 phy_set_drvdata(gphy, &priv->phys[BRCM_USB_PHY_2_0]);
417 if (priv->has_xhci) {
418 gphy = devm_phy_create(dev, NULL, &brcm_usb_phy_ops);
420 dev_err(dev, "failed to create XHCI PHY\n");
421 return PTR_ERR(gphy);
423 priv->phys[BRCM_USB_PHY_3_0].phy = gphy;
424 priv->phys[BRCM_USB_PHY_3_0].id = BRCM_USB_PHY_3_0;
425 phy_set_drvdata(gphy, &priv->phys[BRCM_USB_PHY_3_0]);
427 priv->usb_30_clk = of_clk_get_by_name(dn, "sw_usb3");
428 if (IS_ERR(priv->usb_30_clk)) {
429 if (PTR_ERR(priv->usb_30_clk) == -EPROBE_DEFER)
430 return -EPROBE_DEFER;
432 "USB3.0 clock not found in Device Tree\n");
433 priv->usb_30_clk = NULL;
435 err = clk_prepare_enable(priv->usb_30_clk);
440 priv->suspend_clk = clk_get(dev, "usb0_freerun");
441 if (IS_ERR(priv->suspend_clk)) {
442 if (PTR_ERR(priv->suspend_clk) == -EPROBE_DEFER)
443 return -EPROBE_DEFER;
444 dev_err(dev, "Suspend Clock not found in Device Tree\n");
445 priv->suspend_clk = NULL;
448 priv->wake_irq = platform_get_irq_byname_optional(pdev, "wake");
449 if (priv->wake_irq < 0)
450 priv->wake_irq = platform_get_irq_byname_optional(pdev, "wakeup");
451 if (priv->wake_irq >= 0) {
452 err = devm_request_irq(dev, priv->wake_irq,
453 brcm_usb_phy_wake_isr, 0,
457 device_set_wakeup_capable(dev, 1);
460 "Wake interrupt missing, system wake not supported\n");
466 static int brcm_usb_phy_probe(struct platform_device *pdev)
468 struct device *dev = &pdev->dev;
469 struct brcm_usb_phy_data *priv;
470 struct phy_provider *phy_provider;
471 struct device_node *dn = pdev->dev.of_node;
474 const struct match_chip_info *info;
478 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
481 platform_set_drvdata(pdev, priv);
483 priv->ini.family_id = brcmstb_get_family_id();
484 priv->ini.product_id = brcmstb_get_product_id();
486 info = of_device_get_match_data(&pdev->dev);
490 info->init_func(&priv->ini);
492 dev_dbg(dev, "Best mapping table is for %s\n",
493 priv->ini.family_name);
495 of_property_read_u32(dn, "brcm,ipp", &priv->ini.ipp);
496 of_property_read_u32(dn, "brcm,ioc", &priv->ini.ioc);
498 priv->ini.supported_port_modes = USB_CTLR_MODE_HOST;
499 err = of_property_read_string(dn, "dr_mode", &mode);
501 name_to_value(&brcm_dr_mode_to_name[0],
502 ARRAY_SIZE(brcm_dr_mode_to_name),
503 mode, &priv->ini.supported_port_modes);
505 /* Default port_mode to supported port_modes */
506 priv->ini.port_mode = priv->ini.supported_port_modes;
508 if (of_property_read_bool(dn, "brcm,has-xhci"))
509 priv->has_xhci = true;
510 if (of_property_read_bool(dn, "brcm,has-eohci"))
511 priv->has_eohci = true;
513 for (x = 0; x < BRCM_REGS_MAX; x++) {
514 if (info->required_regs[x] >= BRCM_REGS_MAX)
517 err = brcm_usb_get_regs(pdev, info->required_regs[x],
522 if (info->optional_reg) {
523 err = brcm_usb_get_regs(pdev, info->optional_reg,
529 err = brcm_usb_phy_dvr_init(pdev, priv, dn);
533 priv->pm_notifier.notifier_call = brcm_pm_notifier;
534 register_pm_notifier(&priv->pm_notifier);
536 mutex_init(&priv->mutex);
538 /* make sure invert settings are correct */
539 brcm_usb_init_ipp(&priv->ini);
542 * Create sysfs entries for mode.
543 * Remove "dual_select" attribute if not in dual mode
545 if (priv->ini.supported_port_modes != USB_CTLR_MODE_DRD)
546 brcm_usb_phy_attrs[1] = NULL;
547 err = sysfs_create_group(&dev->kobj, &brcm_usb_phy_group);
549 dev_warn(dev, "Error creating sysfs attributes\n");
551 /* Get piarbctl syscon if it exists */
552 rmap = syscon_regmap_lookup_by_phandle(dev->of_node,
555 rmap = syscon_regmap_lookup_by_phandle(dev->of_node,
556 "brcm,syscon-piarbctl");
558 priv->ini.syscon_piarbctl = rmap;
560 /* start with everything off */
562 brcm_usb_uninit_xhci(&priv->ini);
564 brcm_usb_uninit_eohci(&priv->ini);
565 brcm_usb_uninit_common(&priv->ini);
566 clk_disable_unprepare(priv->usb_20_clk);
567 clk_disable_unprepare(priv->usb_30_clk);
569 phy_provider = devm_of_phy_provider_register(dev, brcm_usb_phy_xlate);
571 return PTR_ERR_OR_ZERO(phy_provider);
574 static void brcm_usb_phy_remove(struct platform_device *pdev)
576 struct brcm_usb_phy_data *priv = dev_get_drvdata(&pdev->dev);
578 sysfs_remove_group(&pdev->dev.kobj, &brcm_usb_phy_group);
579 unregister_pm_notifier(&priv->pm_notifier);
582 #ifdef CONFIG_PM_SLEEP
583 static int brcm_usb_phy_suspend(struct device *dev)
585 struct brcm_usb_phy_data *priv = dev_get_drvdata(dev);
587 if (priv->init_count) {
588 dev_dbg(dev, "SUSPEND\n");
589 priv->ini.wake_enabled = device_may_wakeup(dev);
590 if (priv->phys[BRCM_USB_PHY_3_0].inited)
591 brcm_usb_uninit_xhci(&priv->ini);
592 if (priv->phys[BRCM_USB_PHY_2_0].inited)
593 brcm_usb_uninit_eohci(&priv->ini);
594 brcm_usb_uninit_common(&priv->ini);
597 * Handle the clocks unless needed for wake. This has
598 * to work for both older XHCI->3.0-clks, EOHCI->2.0-clks
599 * and newer XHCI->2.0-clks/3.0-clks.
602 if (!priv->ini.wake_enabled) {
603 if (priv->phys[BRCM_USB_PHY_3_0].inited)
604 clk_disable_unprepare(priv->usb_30_clk);
605 if (priv->phys[BRCM_USB_PHY_2_0].inited ||
607 clk_disable_unprepare(priv->usb_20_clk);
609 if (priv->wake_irq >= 0)
610 enable_irq_wake(priv->wake_irq);
615 static int brcm_usb_phy_resume(struct device *dev)
617 struct brcm_usb_phy_data *priv = dev_get_drvdata(dev);
619 if (!priv->ini.wake_enabled) {
620 clk_prepare_enable(priv->usb_20_clk);
621 clk_prepare_enable(priv->usb_30_clk);
623 brcm_usb_init_ipp(&priv->ini);
626 * Initialize anything that was previously initialized.
627 * Uninitialize anything that wasn't previously initialized.
629 if (priv->init_count) {
630 dev_dbg(dev, "RESUME\n");
631 if (priv->wake_irq >= 0)
632 disable_irq_wake(priv->wake_irq);
633 brcm_usb_init_common(&priv->ini);
634 if (priv->phys[BRCM_USB_PHY_2_0].inited) {
635 brcm_usb_init_eohci(&priv->ini);
636 } else if (priv->has_eohci) {
637 brcm_usb_uninit_eohci(&priv->ini);
638 clk_disable_unprepare(priv->usb_20_clk);
640 if (priv->phys[BRCM_USB_PHY_3_0].inited) {
641 brcm_usb_init_xhci(&priv->ini);
642 } else if (priv->has_xhci) {
643 brcm_usb_uninit_xhci(&priv->ini);
644 clk_disable_unprepare(priv->usb_30_clk);
645 if (!priv->has_eohci)
646 clk_disable_unprepare(priv->usb_20_clk);
650 brcm_usb_uninit_xhci(&priv->ini);
652 brcm_usb_uninit_eohci(&priv->ini);
653 brcm_usb_uninit_common(&priv->ini);
654 clk_disable_unprepare(priv->usb_20_clk);
655 clk_disable_unprepare(priv->usb_30_clk);
657 priv->ini.wake_enabled = false;
660 #endif /* CONFIG_PM_SLEEP */
662 static const struct dev_pm_ops brcm_usb_phy_pm_ops = {
663 SET_LATE_SYSTEM_SLEEP_PM_OPS(brcm_usb_phy_suspend, brcm_usb_phy_resume)
666 MODULE_DEVICE_TABLE(of, brcm_usb_dt_ids);
668 static struct platform_driver brcm_usb_driver = {
669 .probe = brcm_usb_phy_probe,
670 .remove_new = brcm_usb_phy_remove,
672 .name = "brcmstb-usb-phy",
673 .pm = &brcm_usb_phy_pm_ops,
674 .of_match_table = brcm_usb_dt_ids,
678 module_platform_driver(brcm_usb_driver);
680 MODULE_ALIAS("platform:brcmstb-usb-phy");
682 MODULE_DESCRIPTION("BRCM USB PHY driver");
683 MODULE_LICENSE("GPL v2");