2 * Allwinner sun4i USB phy driver
4 * Copyright (C) 2014-2015 Hans de Goede <hdegoede@redhat.com>
7 * Allwinner Technology Co., Ltd. <www.allwinnertech.com>
9 * Modelled after: Samsung S5P/EXYNOS SoC series MIPI CSIS/DSIM DPHY driver
10 * Copyright (C) 2013 Samsung Electronics Co., Ltd.
11 * Author: Sylwester Nawrocki <s.nawrocki@samsung.com>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
24 #include <linux/clk.h>
25 #include <linux/delay.h>
26 #include <linux/err.h>
27 #include <linux/extcon.h>
29 #include <linux/interrupt.h>
30 #include <linux/kernel.h>
31 #include <linux/module.h>
32 #include <linux/mutex.h>
34 #include <linux/of_address.h>
35 #include <linux/of_gpio.h>
36 #include <linux/phy/phy.h>
37 #include <linux/phy/phy-sun4i-usb.h>
38 #include <linux/platform_device.h>
39 #include <linux/power_supply.h>
40 #include <linux/regulator/consumer.h>
41 #include <linux/reset.h>
42 #include <linux/workqueue.h>
45 #define REG_PHYCTL_A10 0x04
46 #define REG_PHYBIST 0x08
47 #define REG_PHYTUNE 0x0c
48 #define REG_PHYCTL_A33 0x10
50 #define PHYCTL_DATA BIT(7)
52 #define SUNXI_AHB_ICHR8_EN BIT(10)
53 #define SUNXI_AHB_INCR4_BURST_EN BIT(9)
54 #define SUNXI_AHB_INCRX_ALIGN_EN BIT(8)
55 #define SUNXI_ULPI_BYPASS_EN BIT(0)
57 /* ISCR, Interface Status and Control bits */
58 #define ISCR_ID_PULLUP_EN (1 << 17)
59 #define ISCR_DPDM_PULLUP_EN (1 << 16)
60 /* sunxi has the phy id/vbus pins not connected, so we use the force bits */
61 #define ISCR_FORCE_ID_MASK (3 << 14)
62 #define ISCR_FORCE_ID_LOW (2 << 14)
63 #define ISCR_FORCE_ID_HIGH (3 << 14)
64 #define ISCR_FORCE_VBUS_MASK (3 << 12)
65 #define ISCR_FORCE_VBUS_LOW (2 << 12)
66 #define ISCR_FORCE_VBUS_HIGH (3 << 12)
68 /* Common Control Bits for Both PHYs */
69 #define PHY_PLL_BW 0x03
70 #define PHY_RES45_CAL_EN 0x0c
72 /* Private Control Bits for Each PHY */
73 #define PHY_TX_AMPLITUDE_TUNE 0x20
74 #define PHY_TX_SLEWRATE_TUNE 0x22
75 #define PHY_VBUSVALID_TH_SEL 0x25
76 #define PHY_PULLUP_RES_SEL 0x27
77 #define PHY_OTG_FUNC_EN 0x28
78 #define PHY_VBUS_DET_EN 0x29
79 #define PHY_DISCON_TH_SEL 0x2a
80 #define PHY_SQUELCH_DETECT 0x3c
85 * Note do not raise the debounce time, we must report Vusb high within 100ms
86 * otherwise we get Vbus errors
88 #define DEBOUNCE_TIME msecs_to_jiffies(50)
89 #define POLL_TIME msecs_to_jiffies(250)
91 struct sun4i_usb_phy_data {
97 struct sun4i_usb_phy {
100 struct regulator *vbus;
101 struct reset_control *reset;
106 /* phy0 / otg related variables */
107 struct extcon_dev *extcon;
110 struct gpio_desc *id_det_gpio;
111 struct gpio_desc *vbus_det_gpio;
112 struct power_supply *vbus_power_supply;
113 struct notifier_block vbus_power_nb;
114 bool vbus_power_nb_registered;
119 struct delayed_work detect;
122 #define to_sun4i_usb_phy_data(phy) \
123 container_of((phy), struct sun4i_usb_phy_data, phys[(phy)->index])
125 static void sun4i_usb_phy0_update_iscr(struct phy *_phy, u32 clr, u32 set)
127 struct sun4i_usb_phy *phy = phy_get_drvdata(_phy);
128 struct sun4i_usb_phy_data *data = to_sun4i_usb_phy_data(phy);
131 iscr = readl(data->base + REG_ISCR);
134 writel(iscr, data->base + REG_ISCR);
137 static void sun4i_usb_phy0_set_id_detect(struct phy *phy, u32 val)
140 val = ISCR_FORCE_ID_HIGH;
142 val = ISCR_FORCE_ID_LOW;
144 sun4i_usb_phy0_update_iscr(phy, ISCR_FORCE_ID_MASK, val);
147 static void sun4i_usb_phy0_set_vbus_detect(struct phy *phy, u32 val)
150 val = ISCR_FORCE_VBUS_HIGH;
152 val = ISCR_FORCE_VBUS_LOW;
154 sun4i_usb_phy0_update_iscr(phy, ISCR_FORCE_VBUS_MASK, val);
157 static void sun4i_usb_phy_write(struct sun4i_usb_phy *phy, u32 addr, u32 data,
160 struct sun4i_usb_phy_data *phy_data = to_sun4i_usb_phy_data(phy);
161 u32 temp, usbc_bit = BIT(phy->index * 2);
165 mutex_lock(&phy_data->mutex);
167 if (phy_data->has_a33_phyctl) {
168 phyctl = phy_data->base + REG_PHYCTL_A33;
169 /* A33 needs us to set phyctl to 0 explicitly */
172 phyctl = phy_data->base + REG_PHYCTL_A10;
175 for (i = 0; i < len; i++) {
176 temp = readl(phyctl);
178 /* clear the address portion */
179 temp &= ~(0xff << 8);
181 /* set the address */
182 temp |= ((addr + i) << 8);
183 writel(temp, phyctl);
185 /* set the data bit and clear usbc bit*/
186 temp = readb(phyctl);
190 temp &= ~PHYCTL_DATA;
192 writeb(temp, phyctl);
195 temp = readb(phyctl);
197 writeb(temp, phyctl);
199 temp = readb(phyctl);
201 writeb(temp, phyctl);
205 mutex_unlock(&phy_data->mutex);
208 static void sun4i_usb_phy_passby(struct sun4i_usb_phy *phy, int enable)
215 bits = SUNXI_AHB_ICHR8_EN | SUNXI_AHB_INCR4_BURST_EN |
216 SUNXI_AHB_INCRX_ALIGN_EN | SUNXI_ULPI_BYPASS_EN;
218 reg_value = readl(phy->pmu);
225 writel(reg_value, phy->pmu);
228 static int sun4i_usb_phy_init(struct phy *_phy)
230 struct sun4i_usb_phy *phy = phy_get_drvdata(_phy);
231 struct sun4i_usb_phy_data *data = to_sun4i_usb_phy_data(phy);
234 ret = clk_prepare_enable(phy->clk);
238 ret = reset_control_deassert(phy->reset);
240 clk_disable_unprepare(phy->clk);
244 /* Enable USB 45 Ohm resistor calibration */
246 sun4i_usb_phy_write(phy, PHY_RES45_CAL_EN, 0x01, 1);
248 /* Adjust PHY's magnitude and rate */
249 sun4i_usb_phy_write(phy, PHY_TX_AMPLITUDE_TUNE, 0x14, 5);
251 /* Disconnect threshold adjustment */
252 sun4i_usb_phy_write(phy, PHY_DISCON_TH_SEL, data->disc_thresh, 2);
254 sun4i_usb_phy_passby(phy, 1);
256 if (phy->index == 0) {
257 data->phy0_init = true;
259 /* Enable pull-ups */
260 sun4i_usb_phy0_update_iscr(_phy, 0, ISCR_DPDM_PULLUP_EN);
261 sun4i_usb_phy0_update_iscr(_phy, 0, ISCR_ID_PULLUP_EN);
263 if (data->id_det_gpio) {
264 /* OTG mode, force ISCR and cable state updates */
267 queue_delayed_work(system_wq, &data->detect, 0);
270 sun4i_usb_phy0_set_id_detect(_phy, 0);
271 sun4i_usb_phy0_set_vbus_detect(_phy, 1);
278 static int sun4i_usb_phy_exit(struct phy *_phy)
280 struct sun4i_usb_phy *phy = phy_get_drvdata(_phy);
281 struct sun4i_usb_phy_data *data = to_sun4i_usb_phy_data(phy);
283 if (phy->index == 0) {
284 /* Disable pull-ups */
285 sun4i_usb_phy0_update_iscr(_phy, ISCR_DPDM_PULLUP_EN, 0);
286 sun4i_usb_phy0_update_iscr(_phy, ISCR_ID_PULLUP_EN, 0);
287 data->phy0_init = false;
290 sun4i_usb_phy_passby(phy, 0);
291 reset_control_assert(phy->reset);
292 clk_disable_unprepare(phy->clk);
297 static int sun4i_usb_phy0_get_vbus_det(struct sun4i_usb_phy_data *data)
299 if (data->vbus_det_gpio)
300 return gpiod_get_value_cansleep(data->vbus_det_gpio);
302 if (data->vbus_power_supply) {
303 union power_supply_propval val;
306 r = power_supply_get_property(data->vbus_power_supply,
307 POWER_SUPPLY_PROP_PRESENT, &val);
312 /* Fallback: report vbus as high */
316 static bool sun4i_usb_phy0_have_vbus_det(struct sun4i_usb_phy_data *data)
318 return data->vbus_det_gpio || data->vbus_power_supply;
321 static int sun4i_usb_phy_power_on(struct phy *_phy)
323 struct sun4i_usb_phy *phy = phy_get_drvdata(_phy);
324 struct sun4i_usb_phy_data *data = to_sun4i_usb_phy_data(phy);
327 if (!phy->vbus || phy->regulator_on)
330 /* For phy0 only turn on Vbus if we don't have an ext. Vbus */
331 if (phy->index == 0 && sun4i_usb_phy0_have_vbus_det(data) &&
335 ret = regulator_enable(phy->vbus);
339 phy->regulator_on = true;
341 /* We must report Vbus high within OTG_TIME_A_WAIT_VRISE msec. */
342 if (phy->index == 0 && data->vbus_det_gpio && data->phy0_poll)
343 mod_delayed_work(system_wq, &data->detect, DEBOUNCE_TIME);
348 static int sun4i_usb_phy_power_off(struct phy *_phy)
350 struct sun4i_usb_phy *phy = phy_get_drvdata(_phy);
351 struct sun4i_usb_phy_data *data = to_sun4i_usb_phy_data(phy);
353 if (!phy->vbus || !phy->regulator_on)
356 regulator_disable(phy->vbus);
357 phy->regulator_on = false;
360 * phy0 vbus typically slowly discharges, sometimes this causes the
361 * Vbus gpio to not trigger an edge irq on Vbus off, so force a rescan.
363 if (phy->index == 0 && data->vbus_det_gpio && !data->phy0_poll)
364 mod_delayed_work(system_wq, &data->detect, POLL_TIME);
369 void sun4i_usb_phy_set_squelch_detect(struct phy *_phy, bool enabled)
371 struct sun4i_usb_phy *phy = phy_get_drvdata(_phy);
373 sun4i_usb_phy_write(phy, PHY_SQUELCH_DETECT, enabled ? 0 : 2, 2);
375 EXPORT_SYMBOL_GPL(sun4i_usb_phy_set_squelch_detect);
377 static const struct phy_ops sun4i_usb_phy_ops = {
378 .init = sun4i_usb_phy_init,
379 .exit = sun4i_usb_phy_exit,
380 .power_on = sun4i_usb_phy_power_on,
381 .power_off = sun4i_usb_phy_power_off,
382 .owner = THIS_MODULE,
385 static void sun4i_usb_phy0_id_vbus_det_scan(struct work_struct *work)
387 struct sun4i_usb_phy_data *data =
388 container_of(work, struct sun4i_usb_phy_data, detect.work);
389 struct phy *phy0 = data->phys[0].phy;
390 int id_det, vbus_det, id_notify = 0, vbus_notify = 0;
392 id_det = gpiod_get_value_cansleep(data->id_det_gpio);
393 vbus_det = sun4i_usb_phy0_get_vbus_det(data);
395 mutex_lock(&phy0->mutex);
397 if (!data->phy0_init) {
398 mutex_unlock(&phy0->mutex);
402 if (id_det != data->id_det) {
404 * When a host cable (id == 0) gets plugged in on systems
405 * without vbus detection report vbus low for long enough for
406 * the musb-ip to end the current device session.
408 if (!sun4i_usb_phy0_have_vbus_det(data) && id_det == 0) {
409 sun4i_usb_phy0_set_vbus_detect(phy0, 0);
411 sun4i_usb_phy0_set_vbus_detect(phy0, 1);
413 sun4i_usb_phy0_set_id_detect(phy0, id_det);
414 data->id_det = id_det;
418 if (vbus_det != data->vbus_det) {
419 sun4i_usb_phy0_set_vbus_detect(phy0, vbus_det);
420 data->vbus_det = vbus_det;
424 mutex_unlock(&phy0->mutex);
427 extcon_set_cable_state_(data->extcon, EXTCON_USB_HOST,
430 * When a host cable gets unplugged (id == 1) on systems
431 * without vbus detection report vbus low for long enough to
432 * the musb-ip to end the current host session.
434 if (!sun4i_usb_phy0_have_vbus_det(data) && id_det == 1) {
435 mutex_lock(&phy0->mutex);
436 sun4i_usb_phy0_set_vbus_detect(phy0, 0);
438 sun4i_usb_phy0_set_vbus_detect(phy0, 1);
439 mutex_unlock(&phy0->mutex);
444 extcon_set_cable_state_(data->extcon, EXTCON_USB, vbus_det);
447 queue_delayed_work(system_wq, &data->detect, POLL_TIME);
450 static irqreturn_t sun4i_usb_phy0_id_vbus_det_irq(int irq, void *dev_id)
452 struct sun4i_usb_phy_data *data = dev_id;
454 /* vbus or id changed, let the pins settle and then scan them */
455 mod_delayed_work(system_wq, &data->detect, DEBOUNCE_TIME);
460 static int sun4i_usb_phy0_vbus_notify(struct notifier_block *nb,
461 unsigned long val, void *v)
463 struct sun4i_usb_phy_data *data =
464 container_of(nb, struct sun4i_usb_phy_data, vbus_power_nb);
465 struct power_supply *psy = v;
467 /* Properties on the vbus_power_supply changed, scan vbus_det */
468 if (val == PSY_EVENT_PROP_CHANGED && psy == data->vbus_power_supply)
469 mod_delayed_work(system_wq, &data->detect, DEBOUNCE_TIME);
474 static struct phy *sun4i_usb_phy_xlate(struct device *dev,
475 struct of_phandle_args *args)
477 struct sun4i_usb_phy_data *data = dev_get_drvdata(dev);
479 if (args->args[0] >= data->num_phys)
480 return ERR_PTR(-ENODEV);
482 return data->phys[args->args[0]].phy;
485 static int sun4i_usb_phy_remove(struct platform_device *pdev)
487 struct device *dev = &pdev->dev;
488 struct sun4i_usb_phy_data *data = dev_get_drvdata(dev);
490 if (data->vbus_power_nb_registered)
491 power_supply_unreg_notifier(&data->vbus_power_nb);
492 if (data->id_det_irq >= 0)
493 devm_free_irq(dev, data->id_det_irq, data);
494 if (data->vbus_det_irq >= 0)
495 devm_free_irq(dev, data->vbus_det_irq, data);
497 cancel_delayed_work_sync(&data->detect);
502 static const unsigned int sun4i_usb_phy0_cable[] = {
508 static int sun4i_usb_phy_probe(struct platform_device *pdev)
510 struct sun4i_usb_phy_data *data;
511 struct device *dev = &pdev->dev;
512 struct device_node *np = dev->of_node;
513 struct phy_provider *phy_provider;
514 bool dedicated_clocks;
515 struct resource *res;
518 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
522 mutex_init(&data->mutex);
523 INIT_DELAYED_WORK(&data->detect, sun4i_usb_phy0_id_vbus_det_scan);
524 dev_set_drvdata(dev, data);
526 if (of_device_is_compatible(np, "allwinner,sun5i-a13-usb-phy") ||
527 of_device_is_compatible(np, "allwinner,sun8i-a23-usb-phy") ||
528 of_device_is_compatible(np, "allwinner,sun8i-a33-usb-phy"))
533 if (of_device_is_compatible(np, "allwinner,sun5i-a13-usb-phy") ||
534 of_device_is_compatible(np, "allwinner,sun7i-a20-usb-phy"))
535 data->disc_thresh = 2;
537 data->disc_thresh = 3;
539 if (of_device_is_compatible(np, "allwinner,sun6i-a31-usb-phy") ||
540 of_device_is_compatible(np, "allwinner,sun8i-a23-usb-phy") ||
541 of_device_is_compatible(np, "allwinner,sun8i-a33-usb-phy"))
542 dedicated_clocks = true;
544 dedicated_clocks = false;
546 if (of_device_is_compatible(np, "allwinner,sun8i-a33-usb-phy"))
547 data->has_a33_phyctl = true;
549 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "phy_ctrl");
550 data->base = devm_ioremap_resource(dev, res);
551 if (IS_ERR(data->base))
552 return PTR_ERR(data->base);
554 data->id_det_gpio = devm_gpiod_get(dev, "usb0_id_det", GPIOD_IN);
555 if (IS_ERR(data->id_det_gpio)) {
556 if (PTR_ERR(data->id_det_gpio) == -EPROBE_DEFER)
557 return -EPROBE_DEFER;
558 data->id_det_gpio = NULL;
561 data->vbus_det_gpio = devm_gpiod_get(dev, "usb0_vbus_det", GPIOD_IN);
562 if (IS_ERR(data->vbus_det_gpio)) {
563 if (PTR_ERR(data->vbus_det_gpio) == -EPROBE_DEFER)
564 return -EPROBE_DEFER;
565 data->vbus_det_gpio = NULL;
568 if (of_find_property(np, "usb0_vbus_power-supply", NULL)) {
569 data->vbus_power_supply = devm_power_supply_get_by_phandle(dev,
570 "usb0_vbus_power-supply");
571 if (IS_ERR(data->vbus_power_supply))
572 return PTR_ERR(data->vbus_power_supply);
574 if (!data->vbus_power_supply)
575 return -EPROBE_DEFER;
578 /* vbus_det without id_det makes no sense, and is not supported */
579 if (sun4i_usb_phy0_have_vbus_det(data) && !data->id_det_gpio) {
580 dev_err(dev, "usb0_id_det missing or invalid\n");
584 if (data->id_det_gpio) {
585 data->extcon = devm_extcon_dev_allocate(dev,
586 sun4i_usb_phy0_cable);
587 if (IS_ERR(data->extcon))
588 return PTR_ERR(data->extcon);
590 ret = devm_extcon_dev_register(dev, data->extcon);
592 dev_err(dev, "failed to register extcon: %d\n", ret);
597 for (i = 0; i < data->num_phys; i++) {
598 struct sun4i_usb_phy *phy = data->phys + i;
601 snprintf(name, sizeof(name), "usb%d_vbus", i);
602 phy->vbus = devm_regulator_get_optional(dev, name);
603 if (IS_ERR(phy->vbus)) {
604 if (PTR_ERR(phy->vbus) == -EPROBE_DEFER)
605 return -EPROBE_DEFER;
609 if (dedicated_clocks)
610 snprintf(name, sizeof(name), "usb%d_phy", i);
612 strlcpy(name, "usb_phy", sizeof(name));
614 phy->clk = devm_clk_get(dev, name);
615 if (IS_ERR(phy->clk)) {
616 dev_err(dev, "failed to get clock %s\n", name);
617 return PTR_ERR(phy->clk);
620 snprintf(name, sizeof(name), "usb%d_reset", i);
621 phy->reset = devm_reset_control_get(dev, name);
622 if (IS_ERR(phy->reset)) {
623 dev_err(dev, "failed to get reset %s\n", name);
624 return PTR_ERR(phy->reset);
627 if (i) { /* No pmu for usbc0 */
628 snprintf(name, sizeof(name), "pmu%d", i);
629 res = platform_get_resource_byname(pdev,
630 IORESOURCE_MEM, name);
631 phy->pmu = devm_ioremap_resource(dev, res);
632 if (IS_ERR(phy->pmu))
633 return PTR_ERR(phy->pmu);
636 phy->phy = devm_phy_create(dev, NULL, &sun4i_usb_phy_ops);
637 if (IS_ERR(phy->phy)) {
638 dev_err(dev, "failed to create PHY %d\n", i);
639 return PTR_ERR(phy->phy);
643 phy_set_drvdata(phy->phy, &data->phys[i]);
646 data->id_det_irq = gpiod_to_irq(data->id_det_gpio);
647 data->vbus_det_irq = gpiod_to_irq(data->vbus_det_gpio);
648 if ((data->id_det_gpio && data->id_det_irq < 0) ||
649 (data->vbus_det_gpio && data->vbus_det_irq < 0))
650 data->phy0_poll = true;
652 if (data->id_det_irq >= 0) {
653 ret = devm_request_irq(dev, data->id_det_irq,
654 sun4i_usb_phy0_id_vbus_det_irq,
655 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
656 "usb0-id-det", data);
658 dev_err(dev, "Err requesting id-det-irq: %d\n", ret);
663 if (data->vbus_det_irq >= 0) {
664 ret = devm_request_irq(dev, data->vbus_det_irq,
665 sun4i_usb_phy0_id_vbus_det_irq,
666 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
667 "usb0-vbus-det", data);
669 dev_err(dev, "Err requesting vbus-det-irq: %d\n", ret);
670 data->vbus_det_irq = -1;
671 sun4i_usb_phy_remove(pdev); /* Stop detect work */
676 if (data->vbus_power_supply) {
677 data->vbus_power_nb.notifier_call = sun4i_usb_phy0_vbus_notify;
678 data->vbus_power_nb.priority = 0;
679 ret = power_supply_reg_notifier(&data->vbus_power_nb);
681 sun4i_usb_phy_remove(pdev); /* Stop detect work */
684 data->vbus_power_nb_registered = true;
687 phy_provider = devm_of_phy_provider_register(dev, sun4i_usb_phy_xlate);
688 if (IS_ERR(phy_provider)) {
689 sun4i_usb_phy_remove(pdev); /* Stop detect work */
690 return PTR_ERR(phy_provider);
696 static const struct of_device_id sun4i_usb_phy_of_match[] = {
697 { .compatible = "allwinner,sun4i-a10-usb-phy" },
698 { .compatible = "allwinner,sun5i-a13-usb-phy" },
699 { .compatible = "allwinner,sun6i-a31-usb-phy" },
700 { .compatible = "allwinner,sun7i-a20-usb-phy" },
701 { .compatible = "allwinner,sun8i-a23-usb-phy" },
702 { .compatible = "allwinner,sun8i-a33-usb-phy" },
705 MODULE_DEVICE_TABLE(of, sun4i_usb_phy_of_match);
707 static struct platform_driver sun4i_usb_phy_driver = {
708 .probe = sun4i_usb_phy_probe,
709 .remove = sun4i_usb_phy_remove,
711 .of_match_table = sun4i_usb_phy_of_match,
712 .name = "sun4i-usb-phy",
715 module_platform_driver(sun4i_usb_phy_driver);
717 MODULE_DESCRIPTION("Allwinner sun4i USB phy driver");
718 MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
719 MODULE_LICENSE("GPL v2");