1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Meson8, Meson8b and GXBB USB2 PHY driver
4 *
5 * Copyright (C) 2016 Martin Blumenstingl <martin.blumenstingl@googlemail.com>
6 */
7
8#include <linux/clk.h>
9#include <linux/delay.h>
10#include <linux/io.h>
11#include <linux/mod_devicetable.h>
12#include <linux/module.h>
13#include <linux/property.h>
14#include <linux/regmap.h>
15#include <linux/reset.h>
16#include <linux/phy/phy.h>
17#include <linux/platform_device.h>
18#include <linux/usb/of.h>
19
20#define REG_CONFIG 0x00
21 #define REG_CONFIG_CLK_EN BIT(0)
22 #define REG_CONFIG_CLK_SEL_MASK GENMASK(3, 1)
23 #define REG_CONFIG_CLK_DIV_MASK GENMASK(10, 4)
24 #define REG_CONFIG_CLK_32k_ALTSEL BIT(15)
25 #define REG_CONFIG_TEST_TRIG BIT(31)
26
27#define REG_CTRL 0x04
28 #define REG_CTRL_SOFT_PRST BIT(0)
29 #define REG_CTRL_SOFT_HRESET BIT(1)
30 #define REG_CTRL_SS_SCALEDOWN_MODE_MASK GENMASK(3, 2)
31 #define REG_CTRL_CLK_DET_RST BIT(4)
32 #define REG_CTRL_INTR_SEL BIT(5)
33 #define REG_CTRL_CLK_DETECTED BIT(8)
34 #define REG_CTRL_SOF_SENT_RCVD_TGL BIT(9)
35 #define REG_CTRL_SOF_TOGGLE_OUT BIT(10)
36 #define REG_CTRL_POWER_ON_RESET BIT(15)
37 #define REG_CTRL_SLEEPM BIT(16)
38 #define REG_CTRL_TX_BITSTUFF_ENN_H BIT(17)
39 #define REG_CTRL_TX_BITSTUFF_ENN BIT(18)
40 #define REG_CTRL_COMMON_ON BIT(19)
41 #define REG_CTRL_REF_CLK_SEL_MASK GENMASK(21, 20)
42 #define REG_CTRL_REF_CLK_SEL_SHIFT 20
43 #define REG_CTRL_FSEL_MASK GENMASK(24, 22)
44 #define REG_CTRL_FSEL_SHIFT 22
45 #define REG_CTRL_PORT_RESET BIT(25)
46 #define REG_CTRL_THREAD_ID_MASK GENMASK(31, 26)
47
48#define REG_ENDP_INTR 0x08
49
50/* bits [31:26], [24:21] and [15:3] seem to be read-only */
51#define REG_ADP_BC 0x0c
52 #define REG_ADP_BC_VBUS_VLD_EXT_SEL BIT(0)
53 #define REG_ADP_BC_VBUS_VLD_EXT BIT(1)
54 #define REG_ADP_BC_OTG_DISABLE BIT(2)
55 #define REG_ADP_BC_ID_PULLUP BIT(3)
56 #define REG_ADP_BC_DRV_VBUS BIT(4)
57 #define REG_ADP_BC_ADP_PRB_EN BIT(5)
58 #define REG_ADP_BC_ADP_DISCHARGE BIT(6)
59 #define REG_ADP_BC_ADP_CHARGE BIT(7)
60 #define REG_ADP_BC_SESS_END BIT(8)
61 #define REG_ADP_BC_DEVICE_SESS_VLD BIT(9)
62 #define REG_ADP_BC_B_VALID BIT(10)
63 #define REG_ADP_BC_A_VALID BIT(11)
64 #define REG_ADP_BC_ID_DIG BIT(12)
65 #define REG_ADP_BC_VBUS_VALID BIT(13)
66 #define REG_ADP_BC_ADP_PROBE BIT(14)
67 #define REG_ADP_BC_ADP_SENSE BIT(15)
68 #define REG_ADP_BC_ACA_ENABLE BIT(16)
69 #define REG_ADP_BC_DCD_ENABLE BIT(17)
70 #define REG_ADP_BC_VDAT_DET_EN_B BIT(18)
71 #define REG_ADP_BC_VDAT_SRC_EN_B BIT(19)
72 #define REG_ADP_BC_CHARGE_SEL BIT(20)
73 #define REG_ADP_BC_CHARGE_DETECT BIT(21)
74 #define REG_ADP_BC_ACA_PIN_RANGE_C BIT(22)
75 #define REG_ADP_BC_ACA_PIN_RANGE_B BIT(23)
76 #define REG_ADP_BC_ACA_PIN_RANGE_A BIT(24)
77 #define REG_ADP_BC_ACA_PIN_GND BIT(25)
78 #define REG_ADP_BC_ACA_PIN_FLOAT BIT(26)
79
80#define REG_DBG_UART 0x10
81 #define REG_DBG_UART_BYPASS_SEL BIT(0)
82 #define REG_DBG_UART_BYPASS_DM_EN BIT(1)
83 #define REG_DBG_UART_BYPASS_DP_EN BIT(2)
84 #define REG_DBG_UART_BYPASS_DM_DATA BIT(3)
85 #define REG_DBG_UART_BYPASS_DP_DATA BIT(4)
86 #define REG_DBG_UART_FSV_MINUS BIT(5)
87 #define REG_DBG_UART_FSV_PLUS BIT(6)
88 #define REG_DBG_UART_FSV_BURN_IN_TEST BIT(7)
89 #define REG_DBG_UART_LOOPBACK_EN_B BIT(8)
90 #define REG_DBG_UART_SET_IDDQ BIT(9)
91 #define REG_DBG_UART_ATE_RESET BIT(10)
92
93#define REG_TEST 0x14
94 #define REG_TEST_DATA_IN_MASK GENMASK(3, 0)
95 #define REG_TEST_EN_MASK GENMASK(7, 4)
96 #define REG_TEST_ADDR_MASK GENMASK(11, 8)
97 #define REG_TEST_DATA_OUT_SEL BIT(12)
98 #define REG_TEST_CLK BIT(13)
99 #define REG_TEST_VA_TEST_EN_B_MASK GENMASK(15, 14)
100 #define REG_TEST_DATA_OUT_MASK GENMASK(19, 16)
101 #define REG_TEST_DISABLE_ID_PULLUP BIT(20)
102
103#define REG_TUNE 0x18
104 #define REG_TUNE_TX_RES_TUNE_MASK GENMASK(1, 0)
105 #define REG_TUNE_TX_HSXV_TUNE_MASK GENMASK(3, 2)
106 #define REG_TUNE_TX_VREF_TUNE_MASK GENMASK(7, 4)
107 #define REG_TUNE_TX_RISE_TUNE_MASK GENMASK(9, 8)
108 #define REG_TUNE_TX_PREEMP_PULSE_TUNE BIT(10)
109 #define REG_TUNE_TX_PREEMP_AMP_TUNE_MASK GENMASK(12, 11)
110 #define REG_TUNE_TX_FSLS_TUNE_MASK GENMASK(16, 13)
111 #define REG_TUNE_SQRX_TUNE_MASK GENMASK(19, 17)
112 #define REG_TUNE_OTG_TUNE GENMASK(22, 20)
113 #define REG_TUNE_COMP_DIS_TUNE GENMASK(25, 23)
114 #define REG_TUNE_HOST_DM_PULLDOWN BIT(26)
115 #define REG_TUNE_HOST_DP_PULLDOWN BIT(27)
116
117#define RESET_COMPLETE_TIME 500
118#define ACA_ENABLE_COMPLETE_TIME 50
119
120struct phy_meson8b_usb2_match_data {
121 bool host_enable_aca;
122};
123
124struct phy_meson8b_usb2_priv {
125 struct regmap *regmap;
126 enum usb_dr_mode dr_mode;
127 struct clk *clk_usb_general;
128 struct clk *clk_usb;
129 struct reset_control *reset;
130 const struct phy_meson8b_usb2_match_data *match;
131};
132
133static const struct regmap_config phy_meson8b_usb2_regmap_conf = {
134 .reg_bits = 8,
135 .val_bits = 32,
136 .reg_stride = 4,
137 .max_register = REG_TUNE,
138};
139
140static int phy_meson8b_usb2_power_on(struct phy *phy)
141{
142 struct phy_meson8b_usb2_priv *priv = phy_get_drvdata(phy);
143 u32 reg;
144 int ret;
145
146 if (!IS_ERR_OR_NULL(ptr: priv->reset)) {
147 ret = reset_control_reset(rstc: priv->reset);
148 if (ret) {
149 dev_err(&phy->dev, "Failed to trigger USB reset\n");
150 return ret;
151 }
152 }
153
154 ret = clk_prepare_enable(clk: priv->clk_usb_general);
155 if (ret) {
156 dev_err(&phy->dev, "Failed to enable USB general clock\n");
157 reset_control_rearm(rstc: priv->reset);
158 return ret;
159 }
160
161 ret = clk_prepare_enable(clk: priv->clk_usb);
162 if (ret) {
163 dev_err(&phy->dev, "Failed to enable USB DDR clock\n");
164 clk_disable_unprepare(clk: priv->clk_usb_general);
165 reset_control_rearm(rstc: priv->reset);
166 return ret;
167 }
168
169 regmap_update_bits(map: priv->regmap, REG_CONFIG, REG_CONFIG_CLK_32k_ALTSEL,
170 REG_CONFIG_CLK_32k_ALTSEL);
171
172 regmap_update_bits(map: priv->regmap, REG_CTRL, REG_CTRL_REF_CLK_SEL_MASK,
173 val: 0x2 << REG_CTRL_REF_CLK_SEL_SHIFT);
174
175 regmap_update_bits(map: priv->regmap, REG_CTRL, REG_CTRL_FSEL_MASK,
176 val: 0x5 << REG_CTRL_FSEL_SHIFT);
177
178 /* reset the PHY */
179 regmap_update_bits(map: priv->regmap, REG_CTRL, REG_CTRL_POWER_ON_RESET,
180 REG_CTRL_POWER_ON_RESET);
181 udelay(RESET_COMPLETE_TIME);
182 regmap_update_bits(map: priv->regmap, REG_CTRL, REG_CTRL_POWER_ON_RESET, val: 0);
183 udelay(RESET_COMPLETE_TIME);
184
185 regmap_update_bits(map: priv->regmap, REG_CTRL, REG_CTRL_SOF_TOGGLE_OUT,
186 REG_CTRL_SOF_TOGGLE_OUT);
187
188 if (priv->dr_mode == USB_DR_MODE_HOST) {
189 regmap_update_bits(map: priv->regmap, REG_DBG_UART,
190 REG_DBG_UART_SET_IDDQ, val: 0);
191
192 if (priv->match->host_enable_aca) {
193 regmap_update_bits(map: priv->regmap, REG_ADP_BC,
194 REG_ADP_BC_ACA_ENABLE,
195 REG_ADP_BC_ACA_ENABLE);
196
197 udelay(ACA_ENABLE_COMPLETE_TIME);
198
199 regmap_read(map: priv->regmap, REG_ADP_BC, val: &reg);
200 if (reg & REG_ADP_BC_ACA_PIN_FLOAT) {
201 dev_warn(&phy->dev, "USB ID detect failed!\n");
202 clk_disable_unprepare(clk: priv->clk_usb);
203 clk_disable_unprepare(clk: priv->clk_usb_general);
204 reset_control_rearm(rstc: priv->reset);
205 return -EINVAL;
206 }
207 }
208 }
209
210 return 0;
211}
212
213static int phy_meson8b_usb2_power_off(struct phy *phy)
214{
215 struct phy_meson8b_usb2_priv *priv = phy_get_drvdata(phy);
216
217 if (priv->dr_mode == USB_DR_MODE_HOST)
218 regmap_update_bits(map: priv->regmap, REG_DBG_UART,
219 REG_DBG_UART_SET_IDDQ,
220 REG_DBG_UART_SET_IDDQ);
221
222 clk_disable_unprepare(clk: priv->clk_usb);
223 clk_disable_unprepare(clk: priv->clk_usb_general);
224 reset_control_rearm(rstc: priv->reset);
225
226 /* power off the PHY by putting it into reset mode */
227 regmap_update_bits(map: priv->regmap, REG_CTRL, REG_CTRL_POWER_ON_RESET,
228 REG_CTRL_POWER_ON_RESET);
229
230 return 0;
231}
232
233static const struct phy_ops phy_meson8b_usb2_ops = {
234 .power_on = phy_meson8b_usb2_power_on,
235 .power_off = phy_meson8b_usb2_power_off,
236 .owner = THIS_MODULE,
237};
238
239static int phy_meson8b_usb2_probe(struct platform_device *pdev)
240{
241 struct phy_meson8b_usb2_priv *priv;
242 struct phy *phy;
243 struct phy_provider *phy_provider;
244 void __iomem *base;
245
246 priv = devm_kzalloc(dev: &pdev->dev, size: sizeof(*priv), GFP_KERNEL);
247 if (!priv)
248 return -ENOMEM;
249
250 base = devm_platform_ioremap_resource(pdev, index: 0);
251 if (IS_ERR(ptr: base))
252 return PTR_ERR(ptr: base);
253
254 priv->match = device_get_match_data(dev: &pdev->dev);
255 if (!priv->match)
256 return -ENODEV;
257
258 priv->regmap = devm_regmap_init_mmio(&pdev->dev, base,
259 &phy_meson8b_usb2_regmap_conf);
260 if (IS_ERR(ptr: priv->regmap))
261 return PTR_ERR(ptr: priv->regmap);
262
263 priv->clk_usb_general = devm_clk_get(dev: &pdev->dev, id: "usb_general");
264 if (IS_ERR(ptr: priv->clk_usb_general))
265 return PTR_ERR(ptr: priv->clk_usb_general);
266
267 priv->clk_usb = devm_clk_get(dev: &pdev->dev, id: "usb");
268 if (IS_ERR(ptr: priv->clk_usb))
269 return PTR_ERR(ptr: priv->clk_usb);
270
271 priv->reset = devm_reset_control_get_optional_shared(dev: &pdev->dev, NULL);
272 if (IS_ERR(ptr: priv->reset))
273 return dev_err_probe(dev: &pdev->dev, err: PTR_ERR(ptr: priv->reset),
274 fmt: "Failed to get the reset line");
275
276 priv->dr_mode = of_usb_get_dr_mode_by_phy(np: pdev->dev.of_node, arg0: -1);
277 if (priv->dr_mode == USB_DR_MODE_UNKNOWN) {
278 dev_err(&pdev->dev,
279 "missing dual role configuration of the controller\n");
280 return -EINVAL;
281 }
282
283 phy = devm_phy_create(dev: &pdev->dev, NULL, ops: &phy_meson8b_usb2_ops);
284 if (IS_ERR(ptr: phy)) {
285 return dev_err_probe(dev: &pdev->dev, err: PTR_ERR(ptr: phy),
286 fmt: "failed to create PHY\n");
287 }
288
289 phy_set_drvdata(phy, data: priv);
290
291 phy_provider =
292 devm_of_phy_provider_register(&pdev->dev, of_phy_simple_xlate);
293
294 return PTR_ERR_OR_ZERO(ptr: phy_provider);
295}
296
297static const struct phy_meson8b_usb2_match_data phy_meson8_usb2_match_data = {
298 .host_enable_aca = false,
299};
300
301static const struct phy_meson8b_usb2_match_data phy_meson8b_usb2_match_data = {
302 .host_enable_aca = true,
303};
304
305static const struct of_device_id phy_meson8b_usb2_of_match[] = {
306 {
307 .compatible = "amlogic,meson8-usb2-phy",
308 .data = &phy_meson8_usb2_match_data
309 },
310 {
311 .compatible = "amlogic,meson8b-usb2-phy",
312 .data = &phy_meson8b_usb2_match_data
313 },
314 {
315 .compatible = "amlogic,meson8m2-usb2-phy",
316 .data = &phy_meson8b_usb2_match_data
317 },
318 {
319 .compatible = "amlogic,meson-gxbb-usb2-phy",
320 .data = &phy_meson8b_usb2_match_data
321 },
322 { /* sentinel */ }
323};
324MODULE_DEVICE_TABLE(of, phy_meson8b_usb2_of_match);
325
326static struct platform_driver phy_meson8b_usb2_driver = {
327 .probe = phy_meson8b_usb2_probe,
328 .driver = {
329 .name = "phy-meson-usb2",
330 .of_match_table = phy_meson8b_usb2_of_match,
331 },
332};
333module_platform_driver(phy_meson8b_usb2_driver);
334
335MODULE_AUTHOR("Martin Blumenstingl <martin.blumenstingl@googlemail.com>");
336MODULE_DESCRIPTION("Meson8, Meson8b, Meson8m2 and GXBB USB2 PHY driver");
337MODULE_LICENSE("GPL");
338

source code of linux/drivers/phy/amlogic/phy-meson8b-usb2.c