phy: samsung: Add support for the Exynos5420 variant of the USB2 PHY
[platform/kernel/linux-rpi.git] / drivers / phy / samsung / phy-samsung-usb2.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Samsung SoC USB 1.1/2.0 PHY driver
4  *
5  * Copyright (C) 2013 Samsung Electronics Co., Ltd.
6  * Author: Kamil Debski <k.debski@samsung.com>
7  */
8
9 #include <linux/clk.h>
10 #include <linux/mfd/syscon.h>
11 #include <linux/module.h>
12 #include <linux/of.h>
13 #include <linux/of_address.h>
14 #include <linux/of_device.h>
15 #include <linux/phy/phy.h>
16 #include <linux/platform_device.h>
17 #include <linux/spinlock.h>
18 #include "phy-samsung-usb2.h"
19
20 static int samsung_usb2_phy_power_on(struct phy *phy)
21 {
22         struct samsung_usb2_phy_instance *inst = phy_get_drvdata(phy);
23         struct samsung_usb2_phy_driver *drv = inst->drv;
24         int ret;
25
26         dev_dbg(drv->dev, "Request to power_on \"%s\" usb phy\n",
27                 inst->cfg->label);
28
29         if (drv->vbus) {
30                 ret = regulator_enable(drv->vbus);
31                 if (ret)
32                         goto err_regulator;
33         }
34
35         ret = clk_prepare_enable(drv->clk);
36         if (ret)
37                 goto err_main_clk;
38         ret = clk_prepare_enable(drv->ref_clk);
39         if (ret)
40                 goto err_instance_clk;
41         if (inst->cfg->power_on) {
42                 spin_lock(&drv->lock);
43                 ret = inst->cfg->power_on(inst);
44                 spin_unlock(&drv->lock);
45                 if (ret)
46                         goto err_power_on;
47         }
48
49         return 0;
50
51 err_power_on:
52         clk_disable_unprepare(drv->ref_clk);
53 err_instance_clk:
54         clk_disable_unprepare(drv->clk);
55 err_main_clk:
56         if (drv->vbus)
57                 regulator_disable(drv->vbus);
58 err_regulator:
59         return ret;
60 }
61
62 static int samsung_usb2_phy_power_off(struct phy *phy)
63 {
64         struct samsung_usb2_phy_instance *inst = phy_get_drvdata(phy);
65         struct samsung_usb2_phy_driver *drv = inst->drv;
66         int ret = 0;
67
68         dev_dbg(drv->dev, "Request to power_off \"%s\" usb phy\n",
69                 inst->cfg->label);
70         if (inst->cfg->power_off) {
71                 spin_lock(&drv->lock);
72                 ret = inst->cfg->power_off(inst);
73                 spin_unlock(&drv->lock);
74                 if (ret)
75                         return ret;
76         }
77         clk_disable_unprepare(drv->ref_clk);
78         clk_disable_unprepare(drv->clk);
79         if (drv->vbus)
80                 ret = regulator_disable(drv->vbus);
81
82         return ret;
83 }
84
85 static const struct phy_ops samsung_usb2_phy_ops = {
86         .power_on       = samsung_usb2_phy_power_on,
87         .power_off      = samsung_usb2_phy_power_off,
88         .owner          = THIS_MODULE,
89 };
90
91 static struct phy *samsung_usb2_phy_xlate(struct device *dev,
92                                         struct of_phandle_args *args)
93 {
94         struct samsung_usb2_phy_driver *drv;
95
96         drv = dev_get_drvdata(dev);
97         if (!drv)
98                 return ERR_PTR(-EINVAL);
99
100         if (WARN_ON(args->args[0] >= drv->cfg->num_phys))
101                 return ERR_PTR(-ENODEV);
102
103         return drv->instances[args->args[0]].phy;
104 }
105
106 static const struct of_device_id samsung_usb2_phy_of_match[] = {
107 #ifdef CONFIG_PHY_EXYNOS4X12_USB2
108         {
109                 .compatible = "samsung,exynos3250-usb2-phy",
110                 .data = &exynos3250_usb2_phy_config,
111         },
112 #endif
113 #ifdef CONFIG_PHY_EXYNOS4210_USB2
114         {
115                 .compatible = "samsung,exynos4210-usb2-phy",
116                 .data = &exynos4210_usb2_phy_config,
117         },
118 #endif
119 #ifdef CONFIG_PHY_EXYNOS4X12_USB2
120         {
121                 .compatible = "samsung,exynos4x12-usb2-phy",
122                 .data = &exynos4x12_usb2_phy_config,
123         },
124 #endif
125 #ifdef CONFIG_PHY_EXYNOS5250_USB2
126         {
127                 .compatible = "samsung,exynos5250-usb2-phy",
128                 .data = &exynos5250_usb2_phy_config,
129         },
130 #endif
131 #ifdef CONFIG_PHY_EXYNOS5420_USB2
132         {
133                 .compatible = "samsung,exynos5420-usb2-phy",
134                 .data = &exynos5420_usb2_phy_config,
135         },
136 #endif
137 #ifdef CONFIG_PHY_S5PV210_USB2
138         {
139                 .compatible = "samsung,s5pv210-usb2-phy",
140                 .data = &s5pv210_usb2_phy_config,
141         },
142 #endif
143         { },
144 };
145 MODULE_DEVICE_TABLE(of, samsung_usb2_phy_of_match);
146
147 static int samsung_usb2_phy_probe(struct platform_device *pdev)
148 {
149         const struct samsung_usb2_phy_config *cfg;
150         struct device *dev = &pdev->dev;
151         struct phy_provider *phy_provider;
152         struct samsung_usb2_phy_driver *drv;
153         int i, ret;
154
155         if (!pdev->dev.of_node) {
156                 dev_err(dev, "This driver is required to be instantiated from device tree\n");
157                 return -EINVAL;
158         }
159
160         cfg = of_device_get_match_data(dev);
161         if (!cfg)
162                 return -EINVAL;
163
164         drv = devm_kzalloc(dev, struct_size(drv, instances, cfg->num_phys),
165                            GFP_KERNEL);
166         if (!drv)
167                 return -ENOMEM;
168
169         dev_set_drvdata(dev, drv);
170         spin_lock_init(&drv->lock);
171
172         drv->cfg = cfg;
173         drv->dev = dev;
174
175         drv->reg_phy = devm_platform_ioremap_resource(pdev, 0);
176         if (IS_ERR(drv->reg_phy)) {
177                 dev_err(dev, "Failed to map register memory (phy)\n");
178                 return PTR_ERR(drv->reg_phy);
179         }
180
181         drv->reg_pmu = syscon_regmap_lookup_by_phandle(pdev->dev.of_node,
182                 "samsung,pmureg-phandle");
183         if (IS_ERR(drv->reg_pmu)) {
184                 dev_err(dev, "Failed to map PMU registers (via syscon)\n");
185                 return PTR_ERR(drv->reg_pmu);
186         }
187
188         if (drv->cfg->has_mode_switch) {
189                 drv->reg_sys = syscon_regmap_lookup_by_phandle(
190                                 pdev->dev.of_node, "samsung,sysreg-phandle");
191                 if (IS_ERR(drv->reg_sys)) {
192                         dev_err(dev, "Failed to map system registers (via syscon)\n");
193                         return PTR_ERR(drv->reg_sys);
194                 }
195         }
196
197         drv->clk = devm_clk_get(dev, "phy");
198         if (IS_ERR(drv->clk)) {
199                 dev_err(dev, "Failed to get clock of phy controller\n");
200                 return PTR_ERR(drv->clk);
201         }
202
203         drv->ref_clk = devm_clk_get(dev, "ref");
204         if (IS_ERR(drv->ref_clk)) {
205                 dev_err(dev, "Failed to get reference clock for the phy controller\n");
206                 return PTR_ERR(drv->ref_clk);
207         }
208
209         drv->ref_rate = clk_get_rate(drv->ref_clk);
210         if (drv->cfg->rate_to_clk) {
211                 ret = drv->cfg->rate_to_clk(drv->ref_rate, &drv->ref_reg_val);
212                 if (ret)
213                         return ret;
214         }
215
216         drv->vbus = devm_regulator_get(dev, "vbus");
217         if (IS_ERR(drv->vbus)) {
218                 ret = PTR_ERR(drv->vbus);
219                 if (ret == -EPROBE_DEFER)
220                         return ret;
221                 drv->vbus = NULL;
222         }
223
224         for (i = 0; i < drv->cfg->num_phys; i++) {
225                 char *label = drv->cfg->phys[i].label;
226                 struct samsung_usb2_phy_instance *p = &drv->instances[i];
227
228                 dev_dbg(dev, "Creating phy \"%s\"\n", label);
229                 p->phy = devm_phy_create(dev, NULL, &samsung_usb2_phy_ops);
230                 if (IS_ERR(p->phy)) {
231                         dev_err(drv->dev, "Failed to create usb2_phy \"%s\"\n",
232                                 label);
233                         return PTR_ERR(p->phy);
234                 }
235
236                 p->cfg = &drv->cfg->phys[i];
237                 p->drv = drv;
238                 phy_set_bus_width(p->phy, 8);
239                 phy_set_drvdata(p->phy, p);
240         }
241
242         phy_provider = devm_of_phy_provider_register(dev,
243                                                         samsung_usb2_phy_xlate);
244         if (IS_ERR(phy_provider)) {
245                 dev_err(drv->dev, "Failed to register phy provider\n");
246                 return PTR_ERR(phy_provider);
247         }
248
249         return 0;
250 }
251
252 static struct platform_driver samsung_usb2_phy_driver = {
253         .probe  = samsung_usb2_phy_probe,
254         .driver = {
255                 .of_match_table = samsung_usb2_phy_of_match,
256                 .name           = "samsung-usb2-phy",
257                 .suppress_bind_attrs = true,
258         }
259 };
260
261 module_platform_driver(samsung_usb2_phy_driver);
262 MODULE_DESCRIPTION("Samsung S5P/Exynos SoC USB PHY driver");
263 MODULE_AUTHOR("Kamil Debski <k.debski@samsung.com>");
264 MODULE_LICENSE("GPL v2");
265 MODULE_ALIAS("platform:samsung-usb2-phy");