2 * Allwinner sun4i USB PHY driver
4 * Copyright (C) 2017 Jagan Teki <jagan@amarulasolutions.com>
5 * Copyright (C) 2015 Hans de Goede <hdegoede@redhat.com>
6 * Copyright (C) 2014 Roman Byshko <rbyshko@gmail.com>
8 * Modelled arch/arm/mach-sunxi/usb_phy.c to compatible with generic-phy.
10 * SPDX-License-Identifier: GPL-2.0+
17 #include <dm/device.h>
18 #include <generic-phy.h>
19 #include <phy-sun4i-usb.h>
23 #include <dm/device_compat.h>
24 #include <linux/bitops.h>
25 #include <linux/delay.h>
26 #include <linux/err.h>
27 #include <power/regulator.h>
30 #define REG_PHYCTL_A10 0x04
31 #define REG_PHYBIST 0x08
32 #define REG_PHYTUNE 0x0c
33 #define REG_PHYCTL_A33 0x10
34 #define REG_PHY_OTGCTL 0x20
36 #define REG_HCI_PHY_CTL 0x10
38 /* Common Control Bits for Both PHYs */
39 #define PHY_PLL_BW 0x03
40 #define PHY_RES45_CAL_EN 0x0c
42 /* Private Control Bits for Each PHY */
43 #define PHY_TX_AMPLITUDE_TUNE 0x20
44 #define PHY_TX_SLEWRATE_TUNE 0x22
45 #define PHY_DISCON_TH_SEL 0x2a
46 #define PHY_SQUELCH_DETECT 0x3c
48 #define PHYCTL_DATA BIT(7)
49 #define OTGCTL_ROUTE_MUSB BIT(0)
51 #define PHY_TX_RATE BIT(4)
52 #define PHY_TX_MAGNITUDE BIT(2)
53 #define PHY_TX_AMPLITUDE_LEN 5
55 #define PHY_RES45_CAL_DATA BIT(0)
56 #define PHY_RES45_CAL_LEN 1
57 #define PHY_DISCON_TH_LEN 2
59 #define SUNXI_AHB_ICHR8_EN BIT(10)
60 #define SUNXI_AHB_INCR4_BURST_EN BIT(9)
61 #define SUNXI_AHB_INCRX_ALIGN_EN BIT(8)
62 #define SUNXI_ULPI_BYPASS_EN BIT(0)
64 /* A83T specific control bits for PHY0 */
65 #define PHY_CTL_VBUSVLDEXT BIT(5)
66 #define PHY_CTL_SIDDQ BIT(3)
67 #define PHY_CTL_H3_SIDDQ BIT(1)
69 /* A83T specific control bits for PHY2 HSIC */
70 #define SUNXI_EHCI_HS_FORCE BIT(20)
71 #define SUNXI_HSIC_CONNECT_INT BIT(16)
72 #define SUNXI_HSIC BIT(1)
76 enum sun4i_usb_phy_type {
88 struct sun4i_usb_phy_cfg {
90 enum sun4i_usb_phy_type type;
92 u32 hci_phy_ctl_clear;
94 bool dedicated_clocks;
99 struct sun4i_usb_phy_info {
100 const char *gpio_vbus;
101 const char *gpio_vbus_det;
102 const char *gpio_id_det;
105 .gpio_vbus = CONFIG_USB0_VBUS_PIN,
106 .gpio_vbus_det = CONFIG_USB0_VBUS_DET,
107 .gpio_id_det = CONFIG_USB0_ID_DET,
110 .gpio_vbus = CONFIG_USB1_VBUS_PIN,
111 .gpio_vbus_det = NULL,
115 .gpio_vbus = CONFIG_USB2_VBUS_PIN,
116 .gpio_vbus_det = NULL,
120 .gpio_vbus = CONFIG_USB3_VBUS_PIN,
121 .gpio_vbus_det = NULL,
126 struct sun4i_usb_phy_plat {
128 struct gpio_desc gpio_vbus;
129 struct gpio_desc gpio_vbus_det;
130 struct gpio_desc gpio_id_det;
132 struct reset_ctl resets;
136 struct sun4i_usb_phy_data {
138 const struct sun4i_usb_phy_cfg *cfg;
139 struct sun4i_usb_phy_plat *usb_phy;
140 struct udevice *vbus_power_supply;
143 static int initial_usb_scan_delay = CONFIG_INITIAL_USB_SCAN_DELAY;
145 static void sun4i_usb_phy_write(struct phy *phy, u32 addr, u32 data, int len)
147 struct sun4i_usb_phy_data *phy_data = dev_get_priv(phy->dev);
148 struct sun4i_usb_phy_plat *usb_phy = &phy_data->usb_phy[phy->id];
149 u32 temp, usbc_bit = BIT(usb_phy->id * 2);
150 void __iomem *phyctl = phy_data->base + phy_data->cfg->phyctl_offset;
153 if (phy_data->cfg->phyctl_offset == REG_PHYCTL_A33) {
154 /* SoCs newer than A33 need us to set phyctl to 0 explicitly */
158 for (i = 0; i < len; i++) {
159 temp = readl(phyctl);
161 /* clear the address portion */
162 temp &= ~(0xff << 8);
164 /* set the address */
165 temp |= ((addr + i) << 8);
166 writel(temp, phyctl);
168 /* set the data bit and clear usbc bit*/
169 temp = readb(phyctl);
173 temp &= ~PHYCTL_DATA;
175 writeb(temp, phyctl);
178 temp = readb(phyctl);
180 writeb(temp, phyctl);
182 temp = readb(phyctl);
184 writeb(temp, phyctl);
190 static void sun4i_usb_phy_passby(struct phy *phy, bool enable)
192 struct sun4i_usb_phy_data *data = dev_get_priv(phy->dev);
193 struct sun4i_usb_phy_plat *usb_phy = &data->usb_phy[phy->id];
199 bits = SUNXI_AHB_ICHR8_EN | SUNXI_AHB_INCR4_BURST_EN |
200 SUNXI_AHB_INCRX_ALIGN_EN | SUNXI_ULPI_BYPASS_EN;
202 /* A83T USB2 is HSIC */
203 if (data->cfg->type == sun8i_a83t_phy && usb_phy->id == 2)
204 bits |= SUNXI_EHCI_HS_FORCE | SUNXI_HSIC_CONNECT_INT |
207 reg_value = readl(usb_phy->pmu);
214 writel(reg_value, usb_phy->pmu);
217 static int sun4i_usb_phy_power_on(struct phy *phy)
219 struct sun4i_usb_phy_data *data = dev_get_priv(phy->dev);
220 struct sun4i_usb_phy_plat *usb_phy = &data->usb_phy[phy->id];
222 if (initial_usb_scan_delay) {
223 mdelay(initial_usb_scan_delay);
224 initial_usb_scan_delay = 0;
227 /* For phy0 only turn on Vbus if we don't have an ext. Vbus */
228 if (phy->id == 0 && sun4i_usb_phy_vbus_detect(phy)) {
229 dev_warn(phy->dev, "External vbus detected, not enabling our own vbus\n");
233 if (dm_gpio_is_valid(&usb_phy->gpio_vbus))
234 dm_gpio_set_value(&usb_phy->gpio_vbus, 1);
239 static int sun4i_usb_phy_power_off(struct phy *phy)
241 struct sun4i_usb_phy_data *data = dev_get_priv(phy->dev);
242 struct sun4i_usb_phy_plat *usb_phy = &data->usb_phy[phy->id];
244 if (dm_gpio_is_valid(&usb_phy->gpio_vbus))
245 dm_gpio_set_value(&usb_phy->gpio_vbus, 0);
250 static void sun4i_usb_phy0_reroute(struct sun4i_usb_phy_data *data, bool id_det)
254 regval = readl(data->base + REG_PHY_OTGCTL);
256 /* Host mode. Route phy0 to EHCI/OHCI */
257 regval &= ~OTGCTL_ROUTE_MUSB;
259 /* Peripheral mode. Route phy0 to MUSB */
260 regval |= OTGCTL_ROUTE_MUSB;
262 writel(regval, data->base + REG_PHY_OTGCTL);
265 static int sun4i_usb_phy_init(struct phy *phy)
267 struct sun4i_usb_phy_data *data = dev_get_priv(phy->dev);
268 struct sun4i_usb_phy_plat *usb_phy = &data->usb_phy[phy->id];
272 ret = clk_enable(&usb_phy->clocks);
274 dev_err(phy->dev, "failed to enable usb_%ldphy clock\n",
279 ret = reset_deassert(&usb_phy->resets);
281 dev_err(phy->dev, "failed to deassert usb_%ldreset reset\n",
286 if (usb_phy->pmu && data->cfg->hci_phy_ctl_clear) {
287 val = readl(usb_phy->pmu + REG_HCI_PHY_CTL);
288 val &= ~data->cfg->hci_phy_ctl_clear;
289 writel(val, usb_phy->pmu + REG_HCI_PHY_CTL);
292 if (data->cfg->type == sun8i_a83t_phy ||
293 data->cfg->type == sun50i_h6_phy) {
295 val = readl(data->base + data->cfg->phyctl_offset);
296 val |= PHY_CTL_VBUSVLDEXT;
297 val &= ~PHY_CTL_SIDDQ;
298 writel(val, data->base + data->cfg->phyctl_offset);
301 if (usb_phy->id == 0)
302 sun4i_usb_phy_write(phy, PHY_RES45_CAL_EN,
306 /* Adjust PHY's magnitude and rate */
307 sun4i_usb_phy_write(phy, PHY_TX_AMPLITUDE_TUNE,
308 PHY_TX_MAGNITUDE | PHY_TX_RATE,
309 PHY_TX_AMPLITUDE_LEN);
311 /* Disconnect threshold adjustment */
312 sun4i_usb_phy_write(phy, PHY_DISCON_TH_SEL,
313 data->cfg->disc_thresh, PHY_DISCON_TH_LEN);
316 #ifdef CONFIG_USB_MUSB_SUNXI
317 /* Needed for HCI and conflicts with MUSB, keep PHY0 on MUSB */
318 if (usb_phy->id != 0)
319 sun4i_usb_phy_passby(phy, true);
321 /* Route PHY0 to MUSB to allow USB gadget */
322 if (data->cfg->phy0_dual_route)
323 sun4i_usb_phy0_reroute(data, true);
325 sun4i_usb_phy_passby(phy, true);
327 /* Route PHY0 to HCI to allow USB host */
328 if (data->cfg->phy0_dual_route)
329 sun4i_usb_phy0_reroute(data, false);
335 static int sun4i_usb_phy_exit(struct phy *phy)
337 struct sun4i_usb_phy_data *data = dev_get_priv(phy->dev);
338 struct sun4i_usb_phy_plat *usb_phy = &data->usb_phy[phy->id];
342 if (data->cfg->type == sun8i_a83t_phy ||
343 data->cfg->type == sun50i_h6_phy) {
344 void __iomem *phyctl = data->base +
345 data->cfg->phyctl_offset;
347 writel(readl(phyctl) | PHY_CTL_SIDDQ, phyctl);
351 sun4i_usb_phy_passby(phy, false);
353 ret = clk_disable(&usb_phy->clocks);
355 dev_err(phy->dev, "failed to disable usb_%ldphy clock\n",
360 ret = reset_assert(&usb_phy->resets);
362 dev_err(phy->dev, "failed to assert usb_%ldreset reset\n",
370 static int sun4i_usb_phy_xlate(struct phy *phy,
371 struct ofnode_phandle_args *args)
373 struct sun4i_usb_phy_data *data = dev_get_priv(phy->dev);
375 if (args->args_count >= data->cfg->num_phys)
378 if (data->cfg->missing_phys & BIT(args->args[0]))
381 if (args->args_count)
382 phy->id = args->args[0];
386 debug("%s: phy_id = %ld\n", __func__, phy->id);
390 int sun4i_usb_phy_vbus_detect(struct phy *phy)
392 struct sun4i_usb_phy_data *data = dev_get_priv(phy->dev);
393 struct sun4i_usb_phy_plat *usb_phy = &data->usb_phy[phy->id];
394 int err = 1, retries = 3;
396 if (dm_gpio_is_valid(&usb_phy->gpio_vbus_det)) {
397 err = dm_gpio_get_value(&usb_phy->gpio_vbus_det);
399 * Vbus may have been provided by the board and just turned off
400 * some milliseconds ago on reset. What we're measuring then is
401 * a residual charge on Vbus. Sleep a bit and try again.
403 while (err > 0 && retries--) {
405 err = dm_gpio_get_value(&usb_phy->gpio_vbus_det);
407 } else if (data->vbus_power_supply) {
408 err = regulator_get_enable(data->vbus_power_supply);
414 int sun4i_usb_phy_id_detect(struct phy *phy)
416 struct sun4i_usb_phy_data *data = dev_get_priv(phy->dev);
417 struct sun4i_usb_phy_plat *usb_phy = &data->usb_phy[phy->id];
419 if (!dm_gpio_is_valid(&usb_phy->gpio_id_det))
422 return dm_gpio_get_value(&usb_phy->gpio_id_det);
425 void sun4i_usb_phy_set_squelch_detect(struct phy *phy, bool enabled)
427 sun4i_usb_phy_write(phy, PHY_SQUELCH_DETECT, enabled ? 0 : 2, 2);
430 static struct phy_ops sun4i_usb_phy_ops = {
431 .of_xlate = sun4i_usb_phy_xlate,
432 .init = sun4i_usb_phy_init,
433 .power_on = sun4i_usb_phy_power_on,
434 .power_off = sun4i_usb_phy_power_off,
435 .exit = sun4i_usb_phy_exit,
438 static int sun4i_usb_phy_probe(struct udevice *dev)
440 struct sun4i_usb_phy_plat *plat = dev_get_plat(dev);
441 struct sun4i_usb_phy_data *data = dev_get_priv(dev);
444 data->cfg = (const struct sun4i_usb_phy_cfg *)dev_get_driver_data(dev);
448 data->base = (void __iomem *)devfdt_get_addr_name(dev, "phy_ctrl");
449 if (IS_ERR(data->base))
450 return PTR_ERR(data->base);
452 device_get_supply_regulator(dev, "usb0_vbus_power-supply",
453 &data->vbus_power_supply);
455 data->usb_phy = plat;
456 for (i = 0; i < data->cfg->num_phys; i++) {
457 struct sun4i_usb_phy_plat *phy = &plat[i];
458 struct sun4i_usb_phy_info *info = &phy_info[i];
461 if (data->cfg->missing_phys & BIT(i))
464 ret = dm_gpio_lookup_name(info->gpio_vbus, &phy->gpio_vbus);
466 ret = dm_gpio_request(&phy->gpio_vbus, "usb_vbus");
469 ret = dm_gpio_set_dir_flags(&phy->gpio_vbus,
473 ret = dm_gpio_set_value(&phy->gpio_vbus, 0);
478 ret = dm_gpio_lookup_name(info->gpio_vbus_det,
479 &phy->gpio_vbus_det);
481 ret = dm_gpio_request(&phy->gpio_vbus_det,
485 ret = dm_gpio_set_dir_flags(&phy->gpio_vbus_det,
491 ret = dm_gpio_lookup_name(info->gpio_id_det, &phy->gpio_id_det);
493 ret = dm_gpio_request(&phy->gpio_id_det, "usb_id_det");
496 ret = dm_gpio_set_dir_flags(&phy->gpio_id_det,
497 GPIOD_IS_IN | GPIOD_PULL_UP);
502 if (data->cfg->dedicated_clocks)
503 snprintf(name, sizeof(name), "usb%d_phy", i);
505 strlcpy(name, "usb_phy", sizeof(name));
507 ret = clk_get_by_name(dev, name, &phy->clocks);
509 dev_err(dev, "failed to get usb%d_phy clock phandle\n", i);
513 snprintf(name, sizeof(name), "usb%d_reset", i);
514 ret = reset_get_by_name(dev, name, &phy->resets);
516 dev_err(dev, "failed to get usb%d_reset reset phandle\n", i);
520 if (i || data->cfg->phy0_dual_route) {
521 snprintf(name, sizeof(name), "pmu%d", i);
522 phy->pmu = (void __iomem *)devfdt_get_addr_name(dev, name);
523 if (IS_ERR(phy->pmu))
524 return PTR_ERR(phy->pmu);
530 debug("Allwinner Sun4I USB PHY driver loaded\n");
534 static const struct sun4i_usb_phy_cfg sun4i_a10_cfg = {
536 .type = sun4i_a10_phy,
538 .phyctl_offset = REG_PHYCTL_A10,
539 .dedicated_clocks = false,
542 static const struct sun4i_usb_phy_cfg sun5i_a13_cfg = {
544 .type = sun4i_a10_phy,
546 .phyctl_offset = REG_PHYCTL_A10,
547 .dedicated_clocks = false,
550 static const struct sun4i_usb_phy_cfg sun6i_a31_cfg = {
552 .type = sun6i_a31_phy,
554 .phyctl_offset = REG_PHYCTL_A10,
555 .dedicated_clocks = true,
558 static const struct sun4i_usb_phy_cfg sun7i_a20_cfg = {
560 .type = sun4i_a10_phy,
562 .phyctl_offset = REG_PHYCTL_A10,
563 .dedicated_clocks = false,
566 static const struct sun4i_usb_phy_cfg sun8i_a23_cfg = {
568 .type = sun4i_a10_phy,
570 .phyctl_offset = REG_PHYCTL_A10,
571 .dedicated_clocks = true,
574 static const struct sun4i_usb_phy_cfg sun8i_a33_cfg = {
576 .type = sun8i_a33_phy,
578 .phyctl_offset = REG_PHYCTL_A33,
579 .dedicated_clocks = true,
582 static const struct sun4i_usb_phy_cfg sun8i_a83t_cfg = {
584 .type = sun8i_a83t_phy,
585 .phyctl_offset = REG_PHYCTL_A33,
586 .dedicated_clocks = true,
589 static const struct sun4i_usb_phy_cfg sun8i_h3_cfg = {
591 .type = sun8i_h3_phy,
593 .phyctl_offset = REG_PHYCTL_A33,
594 .dedicated_clocks = true,
595 .hci_phy_ctl_clear = PHY_CTL_H3_SIDDQ,
596 .phy0_dual_route = true,
599 static const struct sun4i_usb_phy_cfg sun8i_r40_cfg = {
601 .type = sun8i_r40_phy,
603 .phyctl_offset = REG_PHYCTL_A33,
604 .dedicated_clocks = true,
605 .hci_phy_ctl_clear = PHY_CTL_H3_SIDDQ,
606 .phy0_dual_route = true,
609 static const struct sun4i_usb_phy_cfg sun8i_v3s_cfg = {
611 .type = sun8i_v3s_phy,
613 .phyctl_offset = REG_PHYCTL_A33,
614 .dedicated_clocks = true,
615 .hci_phy_ctl_clear = PHY_CTL_H3_SIDDQ,
616 .phy0_dual_route = true,
619 static const struct sun4i_usb_phy_cfg sun20i_d1_cfg = {
621 .type = sun50i_h6_phy,
622 .phyctl_offset = REG_PHYCTL_A33,
623 .dedicated_clocks = true,
624 .hci_phy_ctl_clear = PHY_CTL_SIDDQ,
625 .phy0_dual_route = true,
628 static const struct sun4i_usb_phy_cfg sun50i_a64_cfg = {
630 .type = sun50i_a64_phy,
632 .phyctl_offset = REG_PHYCTL_A33,
633 .dedicated_clocks = true,
634 .hci_phy_ctl_clear = PHY_CTL_H3_SIDDQ,
635 .phy0_dual_route = true,
638 static const struct sun4i_usb_phy_cfg sun50i_h6_cfg = {
640 .type = sun50i_h6_phy,
642 .phyctl_offset = REG_PHYCTL_A33,
643 .dedicated_clocks = true,
644 .phy0_dual_route = true,
645 .missing_phys = BIT(1) | BIT(2),
648 static const struct udevice_id sun4i_usb_phy_ids[] = {
649 { .compatible = "allwinner,sun4i-a10-usb-phy", .data = (ulong)&sun4i_a10_cfg },
650 { .compatible = "allwinner,sun5i-a13-usb-phy", .data = (ulong)&sun5i_a13_cfg },
651 { .compatible = "allwinner,sun6i-a31-usb-phy", .data = (ulong)&sun6i_a31_cfg },
652 { .compatible = "allwinner,sun7i-a20-usb-phy", .data = (ulong)&sun7i_a20_cfg },
653 { .compatible = "allwinner,sun8i-a23-usb-phy", .data = (ulong)&sun8i_a23_cfg },
654 { .compatible = "allwinner,sun8i-a33-usb-phy", .data = (ulong)&sun8i_a33_cfg },
655 { .compatible = "allwinner,sun8i-a83t-usb-phy", .data = (ulong)&sun8i_a83t_cfg },
656 { .compatible = "allwinner,sun8i-h3-usb-phy", .data = (ulong)&sun8i_h3_cfg },
657 { .compatible = "allwinner,sun8i-r40-usb-phy", .data = (ulong)&sun8i_r40_cfg },
658 { .compatible = "allwinner,sun8i-v3s-usb-phy", .data = (ulong)&sun8i_v3s_cfg },
659 { .compatible = "allwinner,sun20i-d1-usb-phy", .data = (ulong)&sun20i_d1_cfg },
660 { .compatible = "allwinner,sun50i-a64-usb-phy", .data = (ulong)&sun50i_a64_cfg},
661 { .compatible = "allwinner,sun50i-h6-usb-phy", .data = (ulong)&sun50i_h6_cfg},
665 U_BOOT_DRIVER(sun4i_usb_phy) = {
666 .name = "sun4i_usb_phy",
668 .of_match = sun4i_usb_phy_ids,
669 .ops = &sun4i_usb_phy_ops,
670 .probe = sun4i_usb_phy_probe,
671 .plat_auto = sizeof(struct sun4i_usb_phy_plat[MAX_PHYS]),
672 .priv_auto = sizeof(struct sun4i_usb_phy_data),