xref: /OK3568_Linux_fs/kernel/drivers/usb/misc/usb4604.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0+
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Driver for SMSC USB4604 USB HSIC 4-port 2.0 hub controller driver
4*4882a593Smuzhiyun  * Based on usb3503 driver
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Copyright (c) 2012-2013 Dongjin Kim (tobetter@gmail.com)
7*4882a593Smuzhiyun  * Copyright (c) 2016 Linaro Ltd.
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <linux/i2c.h>
11*4882a593Smuzhiyun #include <linux/delay.h>
12*4882a593Smuzhiyun #include <linux/slab.h>
13*4882a593Smuzhiyun #include <linux/module.h>
14*4882a593Smuzhiyun #include <linux/gpio/consumer.h>
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun enum usb4604_mode {
17*4882a593Smuzhiyun 	USB4604_MODE_UNKNOWN,
18*4882a593Smuzhiyun 	USB4604_MODE_HUB,
19*4882a593Smuzhiyun 	USB4604_MODE_STANDBY,
20*4882a593Smuzhiyun };
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun struct usb4604 {
23*4882a593Smuzhiyun 	enum usb4604_mode	mode;
24*4882a593Smuzhiyun 	struct device		*dev;
25*4882a593Smuzhiyun 	struct gpio_desc	*gpio_reset;
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun 
usb4604_reset(struct usb4604 * hub,int state)28*4882a593Smuzhiyun static void usb4604_reset(struct usb4604 *hub, int state)
29*4882a593Smuzhiyun {
30*4882a593Smuzhiyun 	gpiod_set_value_cansleep(hub->gpio_reset, state);
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun 	/* Wait for i2c logic to come up */
33*4882a593Smuzhiyun 	if (state)
34*4882a593Smuzhiyun 		msleep(250);
35*4882a593Smuzhiyun }
36*4882a593Smuzhiyun 
usb4604_connect(struct usb4604 * hub)37*4882a593Smuzhiyun static int usb4604_connect(struct usb4604 *hub)
38*4882a593Smuzhiyun {
39*4882a593Smuzhiyun 	struct device *dev = hub->dev;
40*4882a593Smuzhiyun 	struct i2c_client *client = to_i2c_client(dev);
41*4882a593Smuzhiyun 	int err;
42*4882a593Smuzhiyun 	u8 connect_cmd[] = { 0xaa, 0x55, 0x00 };
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun 	usb4604_reset(hub, 1);
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	err = i2c_master_send(client, connect_cmd, ARRAY_SIZE(connect_cmd));
47*4882a593Smuzhiyun 	if (err < 0) {
48*4882a593Smuzhiyun 		usb4604_reset(hub, 0);
49*4882a593Smuzhiyun 		return err;
50*4882a593Smuzhiyun 	}
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 	hub->mode = USB4604_MODE_HUB;
53*4882a593Smuzhiyun 	dev_dbg(dev, "switched to HUB mode\n");
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	return 0;
56*4882a593Smuzhiyun }
57*4882a593Smuzhiyun 
usb4604_switch_mode(struct usb4604 * hub,enum usb4604_mode mode)58*4882a593Smuzhiyun static int usb4604_switch_mode(struct usb4604 *hub, enum usb4604_mode mode)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	struct device *dev = hub->dev;
61*4882a593Smuzhiyun 	int err = 0;
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun 	switch (mode) {
64*4882a593Smuzhiyun 	case USB4604_MODE_HUB:
65*4882a593Smuzhiyun 		err = usb4604_connect(hub);
66*4882a593Smuzhiyun 		break;
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	case USB4604_MODE_STANDBY:
69*4882a593Smuzhiyun 		usb4604_reset(hub, 0);
70*4882a593Smuzhiyun 		dev_dbg(dev, "switched to STANDBY mode\n");
71*4882a593Smuzhiyun 		break;
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun 	default:
74*4882a593Smuzhiyun 		dev_err(dev, "unknown mode is requested\n");
75*4882a593Smuzhiyun 		err = -EINVAL;
76*4882a593Smuzhiyun 		break;
77*4882a593Smuzhiyun 	}
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun 	return err;
80*4882a593Smuzhiyun }
81*4882a593Smuzhiyun 
usb4604_probe(struct usb4604 * hub)82*4882a593Smuzhiyun static int usb4604_probe(struct usb4604 *hub)
83*4882a593Smuzhiyun {
84*4882a593Smuzhiyun 	struct device *dev = hub->dev;
85*4882a593Smuzhiyun 	struct device_node *np = dev->of_node;
86*4882a593Smuzhiyun 	struct gpio_desc *gpio;
87*4882a593Smuzhiyun 	u32 mode = USB4604_MODE_HUB;
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun 	gpio = devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_LOW);
90*4882a593Smuzhiyun 	if (IS_ERR(gpio))
91*4882a593Smuzhiyun 		return PTR_ERR(gpio);
92*4882a593Smuzhiyun 	hub->gpio_reset = gpio;
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	if (of_property_read_u32(np, "initial-mode", &hub->mode))
95*4882a593Smuzhiyun 		hub->mode = mode;
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun 	return usb4604_switch_mode(hub, hub->mode);
98*4882a593Smuzhiyun }
99*4882a593Smuzhiyun 
usb4604_i2c_probe(struct i2c_client * i2c,const struct i2c_device_id * id)100*4882a593Smuzhiyun static int usb4604_i2c_probe(struct i2c_client *i2c,
101*4882a593Smuzhiyun 			     const struct i2c_device_id *id)
102*4882a593Smuzhiyun {
103*4882a593Smuzhiyun 	struct usb4604 *hub;
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun 	hub = devm_kzalloc(&i2c->dev, sizeof(*hub), GFP_KERNEL);
106*4882a593Smuzhiyun 	if (!hub)
107*4882a593Smuzhiyun 		return -ENOMEM;
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun 	i2c_set_clientdata(i2c, hub);
110*4882a593Smuzhiyun 	hub->dev = &i2c->dev;
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 	return usb4604_probe(hub);
113*4882a593Smuzhiyun }
114*4882a593Smuzhiyun 
usb4604_i2c_suspend(struct device * dev)115*4882a593Smuzhiyun static int __maybe_unused usb4604_i2c_suspend(struct device *dev)
116*4882a593Smuzhiyun {
117*4882a593Smuzhiyun 	struct i2c_client *client = to_i2c_client(dev);
118*4882a593Smuzhiyun 	struct usb4604 *hub = i2c_get_clientdata(client);
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun 	usb4604_switch_mode(hub, USB4604_MODE_STANDBY);
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun 	return 0;
123*4882a593Smuzhiyun }
124*4882a593Smuzhiyun 
usb4604_i2c_resume(struct device * dev)125*4882a593Smuzhiyun static int __maybe_unused usb4604_i2c_resume(struct device *dev)
126*4882a593Smuzhiyun {
127*4882a593Smuzhiyun 	struct i2c_client *client = to_i2c_client(dev);
128*4882a593Smuzhiyun 	struct usb4604 *hub = i2c_get_clientdata(client);
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	usb4604_switch_mode(hub, hub->mode);
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun 	return 0;
133*4882a593Smuzhiyun }
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun static SIMPLE_DEV_PM_OPS(usb4604_i2c_pm_ops, usb4604_i2c_suspend,
136*4882a593Smuzhiyun 		usb4604_i2c_resume);
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun static const struct i2c_device_id usb4604_id[] = {
139*4882a593Smuzhiyun 	{ "usb4604", 0 },
140*4882a593Smuzhiyun 	{ }
141*4882a593Smuzhiyun };
142*4882a593Smuzhiyun MODULE_DEVICE_TABLE(i2c, usb4604_id);
143*4882a593Smuzhiyun 
144*4882a593Smuzhiyun #ifdef CONFIG_OF
145*4882a593Smuzhiyun static const struct of_device_id usb4604_of_match[] = {
146*4882a593Smuzhiyun 	{ .compatible = "smsc,usb4604" },
147*4882a593Smuzhiyun 	{}
148*4882a593Smuzhiyun };
149*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, usb4604_of_match);
150*4882a593Smuzhiyun #endif
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun static struct i2c_driver usb4604_i2c_driver = {
153*4882a593Smuzhiyun 	.driver = {
154*4882a593Smuzhiyun 		.name = "usb4604",
155*4882a593Smuzhiyun 		.pm = pm_ptr(&usb4604_i2c_pm_ops),
156*4882a593Smuzhiyun 		.of_match_table = of_match_ptr(usb4604_of_match),
157*4882a593Smuzhiyun 	},
158*4882a593Smuzhiyun 	.probe		= usb4604_i2c_probe,
159*4882a593Smuzhiyun 	.id_table	= usb4604_id,
160*4882a593Smuzhiyun };
161*4882a593Smuzhiyun module_i2c_driver(usb4604_i2c_driver);
162*4882a593Smuzhiyun 
163*4882a593Smuzhiyun MODULE_DESCRIPTION("USB4604 USB HUB driver");
164*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
165