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>
21 #include "phy-brcm-usb-init.h"
23 static DEFINE_MUTEX(sysfs_lock
);
25 enum brcm_usb_phy_id
{
31 struct value_to_name_map
{
36 struct match_chip_info
{
38 u8 required_regs
[BRCM_REGS_MAX
+ 1];
42 static const struct value_to_name_map brcm_dr_mode_to_name
[] = {
43 { USB_CTLR_MODE_HOST
, "host" },
44 { USB_CTLR_MODE_DEVICE
, "peripheral" },
45 { USB_CTLR_MODE_DRD
, "drd" },
46 { USB_CTLR_MODE_TYPEC_PD
, "typec-pd" }
49 static const struct value_to_name_map brcm_dual_mode_to_name
[] = {
61 struct brcm_usb_phy_data
{
62 struct brcm_usb_init_params ini
;
65 struct clk
*usb_20_clk
;
66 struct clk
*usb_30_clk
;
67 struct clk
*suspend_clk
;
68 struct mutex mutex
; /* serialize phy init */
71 struct brcm_usb_phy phys
[BRCM_USB_PHY_ID_MAX
];
74 static s8
*node_reg_names
[BRCM_REGS_MAX
] = {
75 "crtl", "xhci_ec", "xhci_gbl", "usb_phy", "usb_mdio", "bdc_ec"
78 static irqreturn_t
brcm_usb_phy_wake_isr(int irq
, void *dev_id
)
80 struct phy
*gphy
= dev_id
;
82 pm_wakeup_event(&gphy
->dev
, 0);
87 static int brcm_usb_phy_init(struct phy
*gphy
)
89 struct brcm_usb_phy
*phy
= phy_get_drvdata(gphy
);
90 struct brcm_usb_phy_data
*priv
=
91 container_of(phy
, struct brcm_usb_phy_data
, phys
[phy
->id
]);
94 * Use a lock to make sure a second caller waits until
95 * the base phy is inited before using it.
97 mutex_lock(&priv
->mutex
);
98 if (priv
->init_count
++ == 0) {
99 clk_prepare_enable(priv
->usb_20_clk
);
100 clk_prepare_enable(priv
->usb_30_clk
);
101 clk_prepare_enable(priv
->suspend_clk
);
102 brcm_usb_init_common(&priv
->ini
);
104 mutex_unlock(&priv
->mutex
);
105 if (phy
->id
== BRCM_USB_PHY_2_0
)
106 brcm_usb_init_eohci(&priv
->ini
);
107 else if (phy
->id
== BRCM_USB_PHY_3_0
)
108 brcm_usb_init_xhci(&priv
->ini
);
110 dev_dbg(&gphy
->dev
, "INIT, id: %d, total: %d\n", phy
->id
,
116 static int brcm_usb_phy_exit(struct phy
*gphy
)
118 struct brcm_usb_phy
*phy
= phy_get_drvdata(gphy
);
119 struct brcm_usb_phy_data
*priv
=
120 container_of(phy
, struct brcm_usb_phy_data
, phys
[phy
->id
]);
122 dev_dbg(&gphy
->dev
, "EXIT\n");
123 if (phy
->id
== BRCM_USB_PHY_2_0
)
124 brcm_usb_uninit_eohci(&priv
->ini
);
125 if (phy
->id
== BRCM_USB_PHY_3_0
)
126 brcm_usb_uninit_xhci(&priv
->ini
);
128 /* If both xhci and eohci are gone, reset everything else */
129 mutex_lock(&priv
->mutex
);
130 if (--priv
->init_count
== 0) {
131 brcm_usb_uninit_common(&priv
->ini
);
132 clk_disable_unprepare(priv
->usb_20_clk
);
133 clk_disable_unprepare(priv
->usb_30_clk
);
134 clk_disable_unprepare(priv
->suspend_clk
);
136 mutex_unlock(&priv
->mutex
);
141 static const struct phy_ops brcm_usb_phy_ops
= {
142 .init
= brcm_usb_phy_init
,
143 .exit
= brcm_usb_phy_exit
,
144 .owner
= THIS_MODULE
,
147 static struct phy
*brcm_usb_phy_xlate(struct device
*dev
,
148 struct of_phandle_args
*args
)
150 struct brcm_usb_phy_data
*data
= dev_get_drvdata(dev
);
153 * values 0 and 1 are for backward compatibility with
154 * device tree nodes from older bootloaders.
156 switch (args
->args
[0]) {
159 if (data
->phys
[BRCM_USB_PHY_2_0
].phy
)
160 return data
->phys
[BRCM_USB_PHY_2_0
].phy
;
161 dev_warn(dev
, "Error, 2.0 Phy not found\n");
165 if (data
->phys
[BRCM_USB_PHY_3_0
].phy
)
166 return data
->phys
[BRCM_USB_PHY_3_0
].phy
;
167 dev_warn(dev
, "Error, 3.0 Phy not found\n");
170 return ERR_PTR(-ENODEV
);
173 static int name_to_value(const struct value_to_name_map
*table
, int count
,
174 const char *name
, int *value
)
179 for (x
= 0; x
< count
; x
++) {
180 if (sysfs_streq(name
, table
[x
].name
)) {
188 static const char *value_to_name(const struct value_to_name_map
*table
, int count
,
193 return table
[value
].name
;
196 static ssize_t
dr_mode_show(struct device
*dev
,
197 struct device_attribute
*attr
,
200 struct brcm_usb_phy_data
*priv
= dev_get_drvdata(dev
);
202 return sprintf(buf
, "%s\n",
203 value_to_name(&brcm_dr_mode_to_name
[0],
204 ARRAY_SIZE(brcm_dr_mode_to_name
),
207 static DEVICE_ATTR_RO(dr_mode
);
209 static ssize_t
dual_select_store(struct device
*dev
,
210 struct device_attribute
*attr
,
211 const char *buf
, size_t len
)
213 struct brcm_usb_phy_data
*priv
= dev_get_drvdata(dev
);
217 mutex_lock(&sysfs_lock
);
218 res
= name_to_value(&brcm_dual_mode_to_name
[0],
219 ARRAY_SIZE(brcm_dual_mode_to_name
), buf
, &value
);
221 brcm_usb_set_dual_select(&priv
->ini
, value
);
224 mutex_unlock(&sysfs_lock
);
228 static ssize_t
dual_select_show(struct device
*dev
,
229 struct device_attribute
*attr
,
232 struct brcm_usb_phy_data
*priv
= dev_get_drvdata(dev
);
235 mutex_lock(&sysfs_lock
);
236 value
= brcm_usb_get_dual_select(&priv
->ini
);
237 mutex_unlock(&sysfs_lock
);
238 return sprintf(buf
, "%s\n",
239 value_to_name(&brcm_dual_mode_to_name
[0],
240 ARRAY_SIZE(brcm_dual_mode_to_name
),
243 static DEVICE_ATTR_RW(dual_select
);
245 static struct attribute
*brcm_usb_phy_attrs
[] = {
246 &dev_attr_dr_mode
.attr
,
247 &dev_attr_dual_select
.attr
,
251 static const struct attribute_group brcm_usb_phy_group
= {
252 .attrs
= brcm_usb_phy_attrs
,
255 static const struct match_chip_info chip_info_7216
= {
256 .init_func
= &brcm_usb_dvr_init_7216
,
265 static const struct match_chip_info chip_info_7211b0
= {
266 .init_func
= &brcm_usb_dvr_init_7211b0
,
275 .optional_reg
= BRCM_REGS_BDC_EC
,
278 static const struct match_chip_info chip_info_7445
= {
279 .init_func
= &brcm_usb_dvr_init_7445
,
287 static const struct of_device_id brcm_usb_dt_ids
[] = {
289 .compatible
= "brcm,bcm7216-usb-phy",
290 .data
= &chip_info_7216
,
293 .compatible
= "brcm,bcm7211-usb-phy",
294 .data
= &chip_info_7211b0
,
297 .compatible
= "brcm,brcmstb-usb-phy",
298 .data
= &chip_info_7445
,
303 static int brcm_usb_get_regs(struct platform_device
*pdev
,
304 enum brcmusb_reg_sel regs
,
305 struct brcm_usb_init_params
*ini
,
308 struct resource
*res
;
310 /* Older DT nodes have ctrl and optional xhci_ec by index only */
311 res
= platform_get_resource_byname(pdev
, IORESOURCE_MEM
,
312 node_reg_names
[regs
]);
314 if (regs
== BRCM_REGS_CTRL
) {
315 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
316 } else if (regs
== BRCM_REGS_XHCI_EC
) {
317 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 1);
318 /* XHCI_EC registers are optional */
325 "Optional reg %s not found\n",
326 node_reg_names
[regs
]);
329 dev_err(&pdev
->dev
, "can't get %s base addr\n",
330 node_reg_names
[regs
]);
334 ini
->regs
[regs
] = devm_ioremap_resource(&pdev
->dev
, res
);
335 if (IS_ERR(ini
->regs
[regs
])) {
336 dev_err(&pdev
->dev
, "can't map %s register space\n",
337 node_reg_names
[regs
]);
343 static int brcm_usb_phy_dvr_init(struct platform_device
*pdev
,
344 struct brcm_usb_phy_data
*priv
,
345 struct device_node
*dn
)
347 struct device
*dev
= &pdev
->dev
;
348 struct phy
*gphy
= NULL
;
351 priv
->usb_20_clk
= of_clk_get_by_name(dn
, "sw_usb");
352 if (IS_ERR(priv
->usb_20_clk
)) {
353 if (PTR_ERR(priv
->usb_20_clk
) == -EPROBE_DEFER
)
354 return -EPROBE_DEFER
;
355 dev_info(dev
, "Clock not found in Device Tree\n");
356 priv
->usb_20_clk
= NULL
;
358 err
= clk_prepare_enable(priv
->usb_20_clk
);
362 if (priv
->has_eohci
) {
363 gphy
= devm_phy_create(dev
, NULL
, &brcm_usb_phy_ops
);
365 dev_err(dev
, "failed to create EHCI/OHCI PHY\n");
366 return PTR_ERR(gphy
);
368 priv
->phys
[BRCM_USB_PHY_2_0
].phy
= gphy
;
369 priv
->phys
[BRCM_USB_PHY_2_0
].id
= BRCM_USB_PHY_2_0
;
370 phy_set_drvdata(gphy
, &priv
->phys
[BRCM_USB_PHY_2_0
]);
373 if (priv
->has_xhci
) {
374 gphy
= devm_phy_create(dev
, NULL
, &brcm_usb_phy_ops
);
376 dev_err(dev
, "failed to create XHCI PHY\n");
377 return PTR_ERR(gphy
);
379 priv
->phys
[BRCM_USB_PHY_3_0
].phy
= gphy
;
380 priv
->phys
[BRCM_USB_PHY_3_0
].id
= BRCM_USB_PHY_3_0
;
381 phy_set_drvdata(gphy
, &priv
->phys
[BRCM_USB_PHY_3_0
]);
383 priv
->usb_30_clk
= of_clk_get_by_name(dn
, "sw_usb3");
384 if (IS_ERR(priv
->usb_30_clk
)) {
385 if (PTR_ERR(priv
->usb_30_clk
) == -EPROBE_DEFER
)
386 return -EPROBE_DEFER
;
388 "USB3.0 clock not found in Device Tree\n");
389 priv
->usb_30_clk
= NULL
;
391 err
= clk_prepare_enable(priv
->usb_30_clk
);
396 priv
->suspend_clk
= clk_get(dev
, "usb0_freerun");
397 if (IS_ERR(priv
->suspend_clk
)) {
398 if (PTR_ERR(priv
->suspend_clk
) == -EPROBE_DEFER
)
399 return -EPROBE_DEFER
;
400 dev_err(dev
, "Suspend Clock not found in Device Tree\n");
401 priv
->suspend_clk
= NULL
;
404 priv
->wake_irq
= platform_get_irq_byname(pdev
, "wake");
405 if (priv
->wake_irq
< 0)
406 priv
->wake_irq
= platform_get_irq_byname(pdev
, "wakeup");
407 if (priv
->wake_irq
>= 0) {
408 err
= devm_request_irq(dev
, priv
->wake_irq
,
409 brcm_usb_phy_wake_isr
, 0,
410 dev_name(dev
), gphy
);
413 device_set_wakeup_capable(dev
, 1);
416 "Wake interrupt missing, system wake not supported\n");
422 static int brcm_usb_phy_probe(struct platform_device
*pdev
)
424 struct device
*dev
= &pdev
->dev
;
425 struct brcm_usb_phy_data
*priv
;
426 struct phy_provider
*phy_provider
;
427 struct device_node
*dn
= pdev
->dev
.of_node
;
430 const struct of_device_id
*match
;
431 void (*dvr_init
)(struct brcm_usb_init_params
*params
);
432 const struct match_chip_info
*info
;
436 priv
= devm_kzalloc(dev
, sizeof(*priv
), GFP_KERNEL
);
439 platform_set_drvdata(pdev
, priv
);
441 priv
->ini
.family_id
= brcmstb_get_family_id();
442 priv
->ini
.product_id
= brcmstb_get_product_id();
444 match
= of_match_node(brcm_usb_dt_ids
, dev
->of_node
);
446 dvr_init
= info
->init_func
;
447 (*dvr_init
)(&priv
->ini
);
449 dev_dbg(dev
, "Best mapping table is for %s\n",
450 priv
->ini
.family_name
);
452 of_property_read_u32(dn
, "brcm,ipp", &priv
->ini
.ipp
);
453 of_property_read_u32(dn
, "brcm,ioc", &priv
->ini
.ioc
);
455 priv
->ini
.mode
= USB_CTLR_MODE_HOST
;
456 err
= of_property_read_string(dn
, "dr_mode", &mode
);
458 name_to_value(&brcm_dr_mode_to_name
[0],
459 ARRAY_SIZE(brcm_dr_mode_to_name
),
460 mode
, &priv
->ini
.mode
);
462 if (of_property_read_bool(dn
, "brcm,has-xhci"))
463 priv
->has_xhci
= true;
464 if (of_property_read_bool(dn
, "brcm,has-eohci"))
465 priv
->has_eohci
= true;
467 for (x
= 0; x
< BRCM_REGS_MAX
; x
++) {
468 if (info
->required_regs
[x
] >= BRCM_REGS_MAX
)
471 err
= brcm_usb_get_regs(pdev
, info
->required_regs
[x
],
476 if (info
->optional_reg
) {
477 err
= brcm_usb_get_regs(pdev
, info
->optional_reg
,
483 err
= brcm_usb_phy_dvr_init(pdev
, priv
, dn
);
487 mutex_init(&priv
->mutex
);
489 /* make sure invert settings are correct */
490 brcm_usb_init_ipp(&priv
->ini
);
493 * Create sysfs entries for mode.
494 * Remove "dual_select" attribute if not in dual mode
496 if (priv
->ini
.mode
!= USB_CTLR_MODE_DRD
)
497 brcm_usb_phy_attrs
[1] = NULL
;
498 err
= sysfs_create_group(&dev
->kobj
, &brcm_usb_phy_group
);
500 dev_warn(dev
, "Error creating sysfs attributes\n");
502 /* Get piarbctl syscon if it exists */
503 rmap
= syscon_regmap_lookup_by_phandle(dev
->of_node
,
506 rmap
= syscon_regmap_lookup_by_phandle(dev
->of_node
,
507 "brcm,syscon-piarbctl");
509 priv
->ini
.syscon_piarbctl
= rmap
;
511 /* start with everything off */
513 brcm_usb_uninit_xhci(&priv
->ini
);
515 brcm_usb_uninit_eohci(&priv
->ini
);
516 brcm_usb_uninit_common(&priv
->ini
);
517 clk_disable_unprepare(priv
->usb_20_clk
);
518 clk_disable_unprepare(priv
->usb_30_clk
);
520 phy_provider
= devm_of_phy_provider_register(dev
, brcm_usb_phy_xlate
);
522 return PTR_ERR_OR_ZERO(phy_provider
);
525 static int brcm_usb_phy_remove(struct platform_device
*pdev
)
527 sysfs_remove_group(&pdev
->dev
.kobj
, &brcm_usb_phy_group
);
532 #ifdef CONFIG_PM_SLEEP
533 static int brcm_usb_phy_suspend(struct device
*dev
)
535 struct brcm_usb_phy_data
*priv
= dev_get_drvdata(dev
);
537 if (priv
->init_count
) {
538 priv
->ini
.wake_enabled
= device_may_wakeup(dev
);
539 if (priv
->phys
[BRCM_USB_PHY_3_0
].inited
)
540 brcm_usb_uninit_xhci(&priv
->ini
);
541 if (priv
->phys
[BRCM_USB_PHY_2_0
].inited
)
542 brcm_usb_uninit_eohci(&priv
->ini
);
543 brcm_usb_uninit_common(&priv
->ini
);
546 * Handle the clocks unless needed for wake. This has
547 * to work for both older XHCI->3.0-clks, EOHCI->2.0-clks
548 * and newer XHCI->2.0-clks/3.0-clks.
551 if (!priv
->ini
.suspend_with_clocks
) {
552 if (priv
->phys
[BRCM_USB_PHY_3_0
].inited
)
553 clk_disable_unprepare(priv
->usb_30_clk
);
554 if (priv
->phys
[BRCM_USB_PHY_2_0
].inited
||
556 clk_disable_unprepare(priv
->usb_20_clk
);
558 if (priv
->wake_irq
>= 0)
559 enable_irq_wake(priv
->wake_irq
);
564 static int brcm_usb_phy_resume(struct device
*dev
)
566 struct brcm_usb_phy_data
*priv
= dev_get_drvdata(dev
);
568 clk_prepare_enable(priv
->usb_20_clk
);
569 clk_prepare_enable(priv
->usb_30_clk
);
570 brcm_usb_init_ipp(&priv
->ini
);
573 * Initialize anything that was previously initialized.
574 * Uninitialize anything that wasn't previously initialized.
576 if (priv
->init_count
) {
577 if (priv
->wake_irq
>= 0)
578 disable_irq_wake(priv
->wake_irq
);
579 brcm_usb_init_common(&priv
->ini
);
580 if (priv
->phys
[BRCM_USB_PHY_2_0
].inited
) {
581 brcm_usb_init_eohci(&priv
->ini
);
582 } else if (priv
->has_eohci
) {
583 brcm_usb_uninit_eohci(&priv
->ini
);
584 clk_disable_unprepare(priv
->usb_20_clk
);
586 if (priv
->phys
[BRCM_USB_PHY_3_0
].inited
) {
587 brcm_usb_init_xhci(&priv
->ini
);
588 } else if (priv
->has_xhci
) {
589 brcm_usb_uninit_xhci(&priv
->ini
);
590 clk_disable_unprepare(priv
->usb_30_clk
);
591 if (!priv
->has_eohci
)
592 clk_disable_unprepare(priv
->usb_20_clk
);
596 brcm_usb_uninit_xhci(&priv
->ini
);
598 brcm_usb_uninit_eohci(&priv
->ini
);
599 brcm_usb_uninit_common(&priv
->ini
);
600 clk_disable_unprepare(priv
->usb_20_clk
);
601 clk_disable_unprepare(priv
->usb_30_clk
);
603 priv
->ini
.wake_enabled
= false;
606 #endif /* CONFIG_PM_SLEEP */
608 static const struct dev_pm_ops brcm_usb_phy_pm_ops
= {
609 SET_LATE_SYSTEM_SLEEP_PM_OPS(brcm_usb_phy_suspend
, brcm_usb_phy_resume
)
612 MODULE_DEVICE_TABLE(of
, brcm_usb_dt_ids
);
614 static struct platform_driver brcm_usb_driver
= {
615 .probe
= brcm_usb_phy_probe
,
616 .remove
= brcm_usb_phy_remove
,
618 .name
= "brcmstb-usb-phy",
619 .pm
= &brcm_usb_phy_pm_ops
,
620 .of_match_table
= brcm_usb_dt_ids
,
624 module_platform_driver(brcm_usb_driver
);
626 MODULE_ALIAS("platform:brcmstb-usb-phy");
627 MODULE_AUTHOR("Al Cooper <acooper@broadcom.com>");
628 MODULE_DESCRIPTION("BRCM USB PHY driver");
629 MODULE_LICENSE("GPL v2");