dm thin metadata: fix __udivdi3 undefined on 32-bit
[linux/fpc-iii.git] / drivers / usb / misc / usb3503.c
blob9e8789877763f1ee306878fef186777566c6b3c2
1 /*
2 * Driver for SMSC USB3503 USB 2.0 hub controller driver
4 * Copyright (c) 2012-2013 Dongjin Kim (tobetter@gmail.com)
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.
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.
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
21 #include <linux/clk.h>
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>
27 #include <linux/of_gpio.h>
28 #include <linux/platform_device.h>
29 #include <linux/platform_data/usb3503.h>
30 #include <linux/regmap.h>
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
39 #define USB3503_CFG1 0x06
40 #define USB3503_SELF_BUS_PWR (1 << 7)
42 #define USB3503_CFG2 0x07
43 #define USB3503_CFG3 0x08
44 #define USB3503_NRD 0x09
46 #define USB3503_PDS 0x0a
48 #define USB3503_SP_ILOCK 0xe7
49 #define USB3503_SPILOCK_CONNECT (1 << 1)
50 #define USB3503_SPILOCK_CONFIG (1 << 0)
52 #define USB3503_CFGP 0xee
53 #define USB3503_CLKSUSP (1 << 7)
55 #define USB3503_RESET 0xff
57 struct usb3503 {
58 enum usb3503_mode mode;
59 struct regmap *regmap;
60 struct device *dev;
61 struct clk *clk;
62 u8 port_off_mask;
63 int gpio_intn;
64 int gpio_reset;
65 int gpio_connect;
66 bool secondary_ref_clk;
69 static int usb3503_reset(struct usb3503 *hub, int state)
71 if (!state && gpio_is_valid(hub->gpio_connect))
72 gpio_set_value_cansleep(hub->gpio_connect, 0);
74 if (gpio_is_valid(hub->gpio_reset))
75 gpio_set_value_cansleep(hub->gpio_reset, state);
77 /* Wait T_HUBINIT == 4ms for hub logic to stabilize */
78 if (state)
79 usleep_range(4000, 10000);
81 return 0;
84 static int usb3503_connect(struct usb3503 *hub)
86 struct device *dev = hub->dev;
87 int err;
89 usb3503_reset(hub, 1);
91 if (hub->regmap) {
92 /* SP_ILOCK: set connect_n, config_n for config */
93 err = regmap_write(hub->regmap, USB3503_SP_ILOCK,
94 (USB3503_SPILOCK_CONNECT
95 | USB3503_SPILOCK_CONFIG));
96 if (err < 0) {
97 dev_err(dev, "SP_ILOCK failed (%d)\n", err);
98 return err;
101 /* PDS : Set the ports which are disabled in self-powered mode. */
102 if (hub->port_off_mask) {
103 err = regmap_update_bits(hub->regmap, USB3503_PDS,
104 hub->port_off_mask,
105 hub->port_off_mask);
106 if (err < 0) {
107 dev_err(dev, "PDS failed (%d)\n", err);
108 return err;
112 /* CFG1 : Set SELF_BUS_PWR, this enables self-powered operation. */
113 err = regmap_update_bits(hub->regmap, USB3503_CFG1,
114 USB3503_SELF_BUS_PWR,
115 USB3503_SELF_BUS_PWR);
116 if (err < 0) {
117 dev_err(dev, "CFG1 failed (%d)\n", err);
118 return err;
121 /* SP_LOCK: clear connect_n, config_n for hub connect */
122 err = regmap_update_bits(hub->regmap, USB3503_SP_ILOCK,
123 (USB3503_SPILOCK_CONNECT
124 | USB3503_SPILOCK_CONFIG), 0);
125 if (err < 0) {
126 dev_err(dev, "SP_ILOCK failed (%d)\n", err);
127 return err;
131 if (gpio_is_valid(hub->gpio_connect))
132 gpio_set_value_cansleep(hub->gpio_connect, 1);
134 hub->mode = USB3503_MODE_HUB;
135 dev_info(dev, "switched to HUB mode\n");
137 return 0;
140 static int usb3503_switch_mode(struct usb3503 *hub, enum usb3503_mode mode)
142 struct device *dev = hub->dev;
143 int err = 0;
145 switch (mode) {
146 case USB3503_MODE_HUB:
147 err = usb3503_connect(hub);
148 break;
150 case USB3503_MODE_STANDBY:
151 usb3503_reset(hub, 0);
152 dev_info(dev, "switched to STANDBY mode\n");
153 break;
155 default:
156 dev_err(dev, "unknown mode is requested\n");
157 err = -EINVAL;
158 break;
161 return err;
164 static const struct regmap_config usb3503_regmap_config = {
165 .reg_bits = 8,
166 .val_bits = 8,
168 .max_register = USB3503_RESET,
171 static int usb3503_probe(struct usb3503 *hub)
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;
177 u32 mode = USB3503_MODE_HUB;
178 const u32 *property;
179 int len;
181 if (pdata) {
182 hub->port_off_mask = pdata->port_off_mask;
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;
187 } else if (np) {
188 struct clk *clk;
189 u32 rate = 0;
190 hub->port_off_mask = 0;
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;
214 clk = devm_clk_get(dev, "refclk");
215 if (IS_ERR(clk) && PTR_ERR(clk) != -ENOENT) {
216 dev_err(dev, "unable to request refclk (%ld)\n",
217 PTR_ERR(clk));
218 return PTR_ERR(clk);
221 if (!IS_ERR(clk)) {
222 hub->clk = clk;
224 if (rate != 0) {
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;
234 err = clk_prepare_enable(hub->clk);
235 if (err) {
236 dev_err(dev,
237 "unable to enable reference clock\n");
238 return err;
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);
252 hub->gpio_intn = of_get_named_gpio(np, "intn-gpios", 0);
253 if (hub->gpio_intn == -EPROBE_DEFER)
254 return -EPROBE_DEFER;
255 hub->gpio_connect = of_get_named_gpio(np, "connect-gpios", 0);
256 if (hub->gpio_connect == -EPROBE_DEFER)
257 return -EPROBE_DEFER;
258 hub->gpio_reset = of_get_named_gpio(np, "reset-gpios", 0);
259 if (hub->gpio_reset == -EPROBE_DEFER)
260 return -EPROBE_DEFER;
261 of_property_read_u32(np, "initial-mode", &mode);
262 hub->mode = mode;
265 if (hub->port_off_mask && !hub->regmap)
266 dev_err(dev, "Ports disabled with no control interface\n");
268 if (gpio_is_valid(hub->gpio_intn)) {
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");
273 if (err) {
274 dev_err(dev,
275 "unable to request GPIO %d as interrupt pin (%d)\n",
276 hub->gpio_intn, err);
277 return err;
281 if (gpio_is_valid(hub->gpio_connect)) {
282 err = devm_gpio_request_one(dev, hub->gpio_connect,
283 GPIOF_OUT_INIT_LOW, "usb3503 connect");
284 if (err) {
285 dev_err(dev,
286 "unable to request GPIO %d as connect pin (%d)\n",
287 hub->gpio_connect, err);
288 return err;
292 if (gpio_is_valid(hub->gpio_reset)) {
293 err = devm_gpio_request_one(dev, hub->gpio_reset,
294 GPIOF_OUT_INIT_LOW, "usb3503 reset");
295 /* Datasheet defines a hardware reset to be at least 100us */
296 usleep_range(100, 10000);
297 if (err) {
298 dev_err(dev,
299 "unable to request GPIO %d as reset pin (%d)\n",
300 hub->gpio_reset, err);
301 return err;
305 usb3503_switch_mode(hub, hub->mode);
307 dev_info(dev, "%s: probed in %s mode\n", __func__,
308 (hub->mode == USB3503_MODE_HUB) ? "hub" : "standby");
310 return 0;
313 static int usb3503_i2c_probe(struct i2c_client *i2c,
314 const struct i2c_device_id *id)
316 struct usb3503 *hub;
317 int err;
319 hub = devm_kzalloc(&i2c->dev, sizeof(struct usb3503), GFP_KERNEL);
320 if (!hub)
321 return -ENOMEM;
323 i2c_set_clientdata(i2c, hub);
324 hub->regmap = devm_regmap_init_i2c(i2c, &usb3503_regmap_config);
325 if (IS_ERR(hub->regmap)) {
326 err = PTR_ERR(hub->regmap);
327 dev_err(&i2c->dev, "Failed to initialise regmap: %d\n", err);
328 return err;
330 hub->dev = &i2c->dev;
332 return usb3503_probe(hub);
335 static int usb3503_platform_probe(struct platform_device *pdev)
337 struct usb3503 *hub;
339 hub = devm_kzalloc(&pdev->dev, sizeof(struct usb3503), GFP_KERNEL);
340 if (!hub)
341 return -ENOMEM;
342 hub->dev = &pdev->dev;
344 return usb3503_probe(hub);
347 #ifdef CONFIG_PM_SLEEP
348 static int usb3503_i2c_suspend(struct device *dev)
350 struct i2c_client *client = to_i2c_client(dev);
351 struct usb3503 *hub = i2c_get_clientdata(client);
353 usb3503_switch_mode(hub, USB3503_MODE_STANDBY);
355 if (hub->clk)
356 clk_disable_unprepare(hub->clk);
358 return 0;
361 static int usb3503_i2c_resume(struct device *dev)
363 struct i2c_client *client = to_i2c_client(dev);
364 struct usb3503 *hub = i2c_get_clientdata(client);
366 if (hub->clk)
367 clk_prepare_enable(hub->clk);
369 usb3503_switch_mode(hub, hub->mode);
371 return 0;
373 #endif
375 static SIMPLE_DEV_PM_OPS(usb3503_i2c_pm_ops, usb3503_i2c_suspend,
376 usb3503_i2c_resume);
378 static const struct i2c_device_id usb3503_id[] = {
379 { USB3503_I2C_NAME, 0 },
382 MODULE_DEVICE_TABLE(i2c, usb3503_id);
384 #ifdef CONFIG_OF
385 static const struct of_device_id usb3503_of_match[] = {
386 { .compatible = "smsc,usb3503", },
387 { .compatible = "smsc,usb3503a", },
390 MODULE_DEVICE_TABLE(of, usb3503_of_match);
391 #endif
393 static struct i2c_driver usb3503_i2c_driver = {
394 .driver = {
395 .name = USB3503_I2C_NAME,
396 .pm = &usb3503_i2c_pm_ops,
397 .of_match_table = of_match_ptr(usb3503_of_match),
399 .probe = usb3503_i2c_probe,
400 .id_table = usb3503_id,
403 static struct platform_driver usb3503_platform_driver = {
404 .driver = {
405 .name = USB3503_I2C_NAME,
406 .of_match_table = of_match_ptr(usb3503_of_match),
408 .probe = usb3503_platform_probe,
411 static int __init usb3503_init(void)
413 int err;
415 err = i2c_add_driver(&usb3503_i2c_driver);
416 if (err != 0)
417 pr_err("usb3503: Failed to register I2C driver: %d\n", err);
419 err = platform_driver_register(&usb3503_platform_driver);
420 if (err != 0)
421 pr_err("usb3503: Failed to register platform driver: %d\n",
422 err);
424 return 0;
426 module_init(usb3503_init);
428 static void __exit usb3503_exit(void)
430 platform_driver_unregister(&usb3503_platform_driver);
431 i2c_del_driver(&usb3503_i2c_driver);
433 module_exit(usb3503_exit);
435 MODULE_AUTHOR("Dongjin Kim <tobetter@gmail.com>");
436 MODULE_DESCRIPTION("USB3503 USB HUB driver");
437 MODULE_LICENSE("GPL");