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