]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/usb/misc/usb3503.c
Merge tag 'usb-4.15-rc8' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb
[mirror_ubuntu-bionic-kernel.git] / drivers / usb / misc / usb3503.c
CommitLineData
5fd54ace 1// SPDX-License-Identifier: GPL-2.0+
6a099c63
DK
2/*
3 * Driver for SMSC USB3503 USB 2.0 hub controller driver
4 *
5 * Copyright (c) 2012-2013 Dongjin Kim (tobetter@gmail.com)
6a099c63
DK
6 */
7
657d898a 8#include <linux/clk.h>
6a099c63
DK
9#include <linux/i2c.h>
10#include <linux/gpio.h>
11#include <linux/delay.h>
12#include <linux/slab.h>
13#include <linux/module.h>
eab8050c 14#include <linux/of_gpio.h>
6a099c63
DK
15#include <linux/platform_device.h>
16#include <linux/platform_data/usb3503.h>
68b14134 17#include <linux/regmap.h>
6a099c63
DK
18
19#define USB3503_VIDL 0x00
20#define USB3503_VIDM 0x01
21#define USB3503_PIDL 0x02
22#define USB3503_PIDM 0x03
23#define USB3503_DIDL 0x04
24#define USB3503_DIDM 0x05
25
26#define USB3503_CFG1 0x06
27#define USB3503_SELF_BUS_PWR (1 << 7)
28
29#define USB3503_CFG2 0x07
30#define USB3503_CFG3 0x08
31#define USB3503_NRD 0x09
32
33#define USB3503_PDS 0x0a
6a099c63
DK
34
35#define USB3503_SP_ILOCK 0xe7
36#define USB3503_SPILOCK_CONNECT (1 << 1)
37#define USB3503_SPILOCK_CONFIG (1 << 0)
38
39#define USB3503_CFGP 0xee
40#define USB3503_CLKSUSP (1 << 7)
41
68b14134
MB
42#define USB3503_RESET 0xff
43
6a099c63
DK
44struct usb3503 {
45 enum usb3503_mode mode;
68b14134
MB
46 struct regmap *regmap;
47 struct device *dev;
657d898a 48 struct clk *clk;
e8e44a48 49 u8 port_off_mask;
6a099c63
DK
50 int gpio_intn;
51 int gpio_reset;
52 int gpio_connect;
657d898a 53 bool secondary_ref_clk;
6a099c63
DK
54};
55
8e7245b8 56static int usb3503_reset(struct usb3503 *hub, int state)
6a099c63 57{
8e7245b8
MB
58 if (!state && gpio_is_valid(hub->gpio_connect))
59 gpio_set_value_cansleep(hub->gpio_connect, 0);
60
61 if (gpio_is_valid(hub->gpio_reset))
62 gpio_set_value_cansleep(hub->gpio_reset, state);
6a099c63 63
06a962fa 64 /* Wait T_HUBINIT == 4ms for hub logic to stabilize */
6a099c63 65 if (state)
06a962fa 66 usleep_range(4000, 10000);
6a099c63
DK
67
68 return 0;
69}
70
3f0d1c67 71static int usb3503_connect(struct usb3503 *hub)
6a099c63 72{
68b14134 73 struct device *dev = hub->dev;
3f0d1c67 74 int err;
6a099c63 75
3f0d1c67 76 usb3503_reset(hub, 1);
6a099c63 77
3f0d1c67 78 if (hub->regmap) {
6a099c63 79 /* SP_ILOCK: set connect_n, config_n for config */
68b14134 80 err = regmap_write(hub->regmap, USB3503_SP_ILOCK,
3f0d1c67 81 (USB3503_SPILOCK_CONNECT
6a099c63
DK
82 | USB3503_SPILOCK_CONFIG));
83 if (err < 0) {
68b14134 84 dev_err(dev, "SP_ILOCK failed (%d)\n", err);
3f0d1c67 85 return err;
6a099c63
DK
86 }
87
4463e152 88 /* PDS : Set the ports which are disabled in self-powered mode. */
e8e44a48 89 if (hub->port_off_mask) {
68b14134
MB
90 err = regmap_update_bits(hub->regmap, USB3503_PDS,
91 hub->port_off_mask,
e8e44a48
DK
92 hub->port_off_mask);
93 if (err < 0) {
68b14134 94 dev_err(dev, "PDS failed (%d)\n", err);
3f0d1c67 95 return err;
e8e44a48 96 }
6a099c63
DK
97 }
98
4463e152 99 /* CFG1 : Set SELF_BUS_PWR, this enables self-powered operation. */
68b14134
MB
100 err = regmap_update_bits(hub->regmap, USB3503_CFG1,
101 USB3503_SELF_BUS_PWR,
102 USB3503_SELF_BUS_PWR);
6a099c63 103 if (err < 0) {
68b14134 104 dev_err(dev, "CFG1 failed (%d)\n", err);
3f0d1c67 105 return err;
6a099c63
DK
106 }
107
108 /* SP_LOCK: clear connect_n, config_n for hub connect */
68b14134
MB
109 err = regmap_update_bits(hub->regmap, USB3503_SP_ILOCK,
110 (USB3503_SPILOCK_CONNECT
111 | USB3503_SPILOCK_CONFIG), 0);
6a099c63 112 if (err < 0) {
68b14134 113 dev_err(dev, "SP_ILOCK failed (%d)\n", err);
3f0d1c67 114 return err;
6a099c63 115 }
3f0d1c67 116 }
6a099c63 117
3f0d1c67
MB
118 if (gpio_is_valid(hub->gpio_connect))
119 gpio_set_value_cansleep(hub->gpio_connect, 1);
8e7245b8 120
3f0d1c67
MB
121 hub->mode = USB3503_MODE_HUB;
122 dev_info(dev, "switched to HUB mode\n");
123
124 return 0;
125}
126
127static int usb3503_switch_mode(struct usb3503 *hub, enum usb3503_mode mode)
128{
129 struct device *dev = hub->dev;
130 int err = 0;
131
132 switch (mode) {
133 case USB3503_MODE_HUB:
134 err = usb3503_connect(hub);
6a099c63
DK
135 break;
136
137 case USB3503_MODE_STANDBY:
8e7245b8 138 usb3503_reset(hub, 0);
68b14134 139 dev_info(dev, "switched to STANDBY mode\n");
6a099c63
DK
140 break;
141
142 default:
dd8e670d 143 dev_err(dev, "unknown mode is requested\n");
6a099c63
DK
144 err = -EINVAL;
145 break;
146 }
147
6a099c63
DK
148 return err;
149}
150
68b14134
MB
151static const struct regmap_config usb3503_regmap_config = {
152 .reg_bits = 8,
153 .val_bits = 8,
154
155 .max_register = USB3503_RESET,
156};
157
2487e3ee 158static int usb3503_probe(struct usb3503 *hub)
6a099c63 159{
2487e3ee
MB
160 struct device *dev = hub->dev;
161 struct usb3503_platform_data *pdata = dev_get_platdata(dev);
162 struct device_node *np = dev->of_node;
163 int err;
e5a0c874 164 u32 mode = USB3503_MODE_HUB;
e8b58b49
DK
165 const u32 *property;
166 int len;
6a099c63 167
eab8050c 168 if (pdata) {
e8e44a48 169 hub->port_off_mask = pdata->port_off_mask;
6a099c63
DK
170 hub->gpio_intn = pdata->gpio_intn;
171 hub->gpio_connect = pdata->gpio_connect;
172 hub->gpio_reset = pdata->gpio_reset;
173 hub->mode = pdata->initial_mode;
eab8050c 174 } else if (np) {
657d898a 175 struct clk *clk;
c0ab6bb0 176 u32 rate = 0;
e8b58b49
DK
177 hub->port_off_mask = 0;
178
c0ab6bb0
BG
179 if (!of_property_read_u32(np, "refclk-frequency", &rate)) {
180 switch (rate) {
181 case 38400000:
182 case 26000000:
183 case 19200000:
184 case 12000000:
185 hub->secondary_ref_clk = 0;
186 break;
187 case 24000000:
188 case 27000000:
189 case 25000000:
190 case 50000000:
191 hub->secondary_ref_clk = 1;
192 break;
193 default:
194 dev_err(dev,
195 "unsupported reference clock rate (%d)\n",
196 (int) rate);
197 return -EINVAL;
198 }
199 }
200
657d898a
MS
201 clk = devm_clk_get(dev, "refclk");
202 if (IS_ERR(clk) && PTR_ERR(clk) != -ENOENT) {
ec5734c4
TB
203 dev_err(dev, "unable to request refclk (%ld)\n",
204 PTR_ERR(clk));
657d898a
MS
205 return PTR_ERR(clk);
206 }
207
208 if (!IS_ERR(clk)) {
657d898a
MS
209 hub->clk = clk;
210
c0ab6bb0 211 if (rate != 0) {
657d898a
MS
212 err = clk_set_rate(hub->clk, rate);
213 if (err) {
214 dev_err(dev,
215 "unable to set reference clock rate to %d\n",
216 (int) rate);
217 return err;
218 }
219 }
220
221 err = clk_prepare_enable(hub->clk);
222 if (err) {
223 dev_err(dev,
224 "unable to enable reference clock\n");
225 return err;
226 }
227 }
228
e8b58b49
DK
229 property = of_get_property(np, "disabled-ports", &len);
230 if (property && (len / sizeof(u32)) > 0) {
231 int i;
232 for (i = 0; i < len / sizeof(u32); i++) {
233 u32 port = be32_to_cpu(property[i]);
234 if ((1 <= port) && (port <= 3))
235 hub->port_off_mask |= (1 << port);
236 }
237 }
238
42416cc8 239 hub->gpio_intn = of_get_named_gpio(np, "intn-gpios", 0);
eab8050c
DK
240 if (hub->gpio_intn == -EPROBE_DEFER)
241 return -EPROBE_DEFER;
42416cc8 242 hub->gpio_connect = of_get_named_gpio(np, "connect-gpios", 0);
eab8050c
DK
243 if (hub->gpio_connect == -EPROBE_DEFER)
244 return -EPROBE_DEFER;
ccf92c94 245 hub->gpio_reset = of_get_named_gpio(np, "reset-gpios", 0);
eab8050c
DK
246 if (hub->gpio_reset == -EPROBE_DEFER)
247 return -EPROBE_DEFER;
248 of_property_read_u32(np, "initial-mode", &mode);
249 hub->mode = mode;
6a099c63
DK
250 }
251
3f0d1c67
MB
252 if (hub->port_off_mask && !hub->regmap)
253 dev_err(dev, "Ports disabled with no control interface\n");
254
6a099c63 255 if (gpio_is_valid(hub->gpio_intn)) {
657d898a
MS
256 int val = hub->secondary_ref_clk ? GPIOF_OUT_INIT_LOW :
257 GPIOF_OUT_INIT_HIGH;
258 err = devm_gpio_request_one(dev, hub->gpio_intn, val,
259 "usb3503 intn");
6a099c63 260 if (err) {
2487e3ee 261 dev_err(dev,
6b084421 262 "unable to request GPIO %d as interrupt pin (%d)\n",
2487e3ee 263 hub->gpio_intn, err);
cffedd67 264 return err;
6a099c63
DK
265 }
266 }
267
268 if (gpio_is_valid(hub->gpio_connect)) {
2487e3ee 269 err = devm_gpio_request_one(dev, hub->gpio_connect,
8e7245b8 270 GPIOF_OUT_INIT_LOW, "usb3503 connect");
6a099c63 271 if (err) {
2487e3ee
MB
272 dev_err(dev,
273 "unable to request GPIO %d as connect pin (%d)\n",
274 hub->gpio_connect, err);
cffedd67 275 return err;
6a099c63
DK
276 }
277 }
278
279 if (gpio_is_valid(hub->gpio_reset)) {
2487e3ee 280 err = devm_gpio_request_one(dev, hub->gpio_reset,
6a099c63 281 GPIOF_OUT_INIT_LOW, "usb3503 reset");
b8626f1d
SA
282 /* Datasheet defines a hardware reset to be at least 100us */
283 usleep_range(100, 10000);
6a099c63 284 if (err) {
2487e3ee
MB
285 dev_err(dev,
286 "unable to request GPIO %d as reset pin (%d)\n",
287 hub->gpio_reset, err);
cffedd67 288 return err;
6a099c63
DK
289 }
290 }
291
eab8050c 292 usb3503_switch_mode(hub, hub->mode);
6a099c63 293
dd8e670d 294 dev_info(dev, "%s: probed in %s mode\n", __func__,
6a099c63
DK
295 (hub->mode == USB3503_MODE_HUB) ? "hub" : "standby");
296
297 return 0;
6a099c63
DK
298}
299
2487e3ee
MB
300static int usb3503_i2c_probe(struct i2c_client *i2c,
301 const struct i2c_device_id *id)
302{
303 struct usb3503 *hub;
304 int err;
305
306 hub = devm_kzalloc(&i2c->dev, sizeof(struct usb3503), GFP_KERNEL);
39d98bdc 307 if (!hub)
2487e3ee 308 return -ENOMEM;
2487e3ee
MB
309
310 i2c_set_clientdata(i2c, hub);
311 hub->regmap = devm_regmap_init_i2c(i2c, &usb3503_regmap_config);
312 if (IS_ERR(hub->regmap)) {
313 err = PTR_ERR(hub->regmap);
314 dev_err(&i2c->dev, "Failed to initialise regmap: %d\n", err);
315 return err;
316 }
317 hub->dev = &i2c->dev;
318
319 return usb3503_probe(hub);
320}
321
62c32e46
KK
322static int usb3503_i2c_remove(struct i2c_client *i2c)
323{
324 struct usb3503 *hub;
325
326 hub = i2c_get_clientdata(i2c);
327 if (hub->clk)
328 clk_disable_unprepare(hub->clk);
329
330 return 0;
331}
332
3f0d1c67
MB
333static int usb3503_platform_probe(struct platform_device *pdev)
334{
335 struct usb3503 *hub;
336
337 hub = devm_kzalloc(&pdev->dev, sizeof(struct usb3503), GFP_KERNEL);
39d98bdc 338 if (!hub)
3f0d1c67 339 return -ENOMEM;
3f0d1c67 340 hub->dev = &pdev->dev;
495660cb 341 platform_set_drvdata(pdev, hub);
3f0d1c67
MB
342
343 return usb3503_probe(hub);
344}
345
62c32e46
KK
346static int usb3503_platform_remove(struct platform_device *pdev)
347{
348 struct usb3503 *hub;
349
350 hub = platform_get_drvdata(pdev);
351 if (hub->clk)
352 clk_disable_unprepare(hub->clk);
353
354 return 0;
355}
356
ecdc071d
JS
357#ifdef CONFIG_PM_SLEEP
358static int usb3503_i2c_suspend(struct device *dev)
359{
360 struct i2c_client *client = to_i2c_client(dev);
361 struct usb3503 *hub = i2c_get_clientdata(client);
362
363 usb3503_switch_mode(hub, USB3503_MODE_STANDBY);
364
365 if (hub->clk)
366 clk_disable_unprepare(hub->clk);
367
368 return 0;
369}
370
371static int usb3503_i2c_resume(struct device *dev)
372{
373 struct i2c_client *client = to_i2c_client(dev);
374 struct usb3503 *hub = i2c_get_clientdata(client);
375
376 if (hub->clk)
377 clk_prepare_enable(hub->clk);
378
379 usb3503_switch_mode(hub, hub->mode);
380
381 return 0;
382}
383#endif
384
385static SIMPLE_DEV_PM_OPS(usb3503_i2c_pm_ops, usb3503_i2c_suspend,
386 usb3503_i2c_resume);
387
6a099c63
DK
388static const struct i2c_device_id usb3503_id[] = {
389 { USB3503_I2C_NAME, 0 },
390 { }
391};
392MODULE_DEVICE_TABLE(i2c, usb3503_id);
393
eab8050c
DK
394#ifdef CONFIG_OF
395static const struct of_device_id usb3503_of_match[] = {
396 { .compatible = "smsc,usb3503", },
5bdd1f4a 397 { .compatible = "smsc,usb3503a", },
eab8050c
DK
398 {},
399};
400MODULE_DEVICE_TABLE(of, usb3503_of_match);
401#endif
402
3f0d1c67 403static struct i2c_driver usb3503_i2c_driver = {
6a099c63
DK
404 .driver = {
405 .name = USB3503_I2C_NAME,
ecdc071d 406 .pm = &usb3503_i2c_pm_ops,
eab8050c 407 .of_match_table = of_match_ptr(usb3503_of_match),
6a099c63 408 },
2487e3ee 409 .probe = usb3503_i2c_probe,
62c32e46 410 .remove = usb3503_i2c_remove,
6a099c63
DK
411 .id_table = usb3503_id,
412};
413
3f0d1c67
MB
414static struct platform_driver usb3503_platform_driver = {
415 .driver = {
416 .name = USB3503_I2C_NAME,
417 .of_match_table = of_match_ptr(usb3503_of_match),
3f0d1c67
MB
418 },
419 .probe = usb3503_platform_probe,
62c32e46 420 .remove = usb3503_platform_remove,
3f0d1c67
MB
421};
422
423static int __init usb3503_init(void)
424{
425 int err;
426
aa5b477d 427 err = i2c_add_driver(&usb3503_i2c_driver);
3f0d1c67
MB
428 if (err != 0)
429 pr_err("usb3503: Failed to register I2C driver: %d\n", err);
430
431 err = platform_driver_register(&usb3503_platform_driver);
432 if (err != 0)
433 pr_err("usb3503: Failed to register platform driver: %d\n",
434 err);
435
436 return 0;
437}
438module_init(usb3503_init);
439
440static void __exit usb3503_exit(void)
441{
442 platform_driver_unregister(&usb3503_platform_driver);
443 i2c_del_driver(&usb3503_i2c_driver);
444}
445module_exit(usb3503_exit);
6a099c63
DK
446
447MODULE_AUTHOR("Dongjin Kim <tobetter@gmail.com>");
448MODULE_DESCRIPTION("USB3503 USB HUB driver");
449MODULE_LICENSE("GPL");