[mirror_ubuntu-bionic-kernel.git] / drivers / usb / misc / usb3503.c

/*
 * Driver for SMSC USB3503 USB 2.0 hub controller driver
 *
 * Copyright (c) 2012-2013 Dongjin Kim (tobetter@gmail.com)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <linux/i2c.h>
#include <linux/gpio.h>
#include <linux/delay.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/of_gpio.h>
#include <linux/platform_device.h>
#include <linux/platform_data/usb3503.h>
#include <linux/regmap.h>

#define USB3503_VIDL		0x00
#define USB3503_VIDM		0x01
#define USB3503_PIDL		0x02
#define USB3503_PIDM		0x03
#define USB3503_DIDL		0x04
#define USB3503_DIDM		0x05

#define USB3503_CFG1		0x06
#define USB3503_SELF_BUS_PWR	(1 << 7)

#define USB3503_CFG2		0x07
#define USB3503_CFG3		0x08
#define USB3503_NRD		0x09

#define USB3503_PDS		0x0a

#define USB3503_SP_ILOCK	0xe7
#define USB3503_SPILOCK_CONNECT	(1 << 1)
#define USB3503_SPILOCK_CONFIG	(1 << 0)

#define USB3503_CFGP		0xee
#define USB3503_CLKSUSP		(1 << 7)

#define USB3503_RESET		0xff

struct usb3503 {
	enum usb3503_mode	mode;
	struct regmap		*regmap;
	struct device		*dev;
	u8	port_off_mask;
	int	gpio_intn;
	int	gpio_reset;
	int	gpio_connect;
};

static int usb3503_reset(struct usb3503 *hub, int state)
{
	if (!state && gpio_is_valid(hub->gpio_connect))
		gpio_set_value_cansleep(hub->gpio_connect, 0);

	if (gpio_is_valid(hub->gpio_reset))
		gpio_set_value_cansleep(hub->gpio_reset, state);

	/* Wait T_HUBINIT == 4ms for hub logic to stabilize */
	if (state)
		usleep_range(4000, 10000);

	return 0;
}

static int usb3503_switch_mode(struct usb3503 *hub, enum usb3503_mode mode)
{
	struct device *dev = hub->dev;
	int err = 0;

	switch (mode) {
	case USB3503_MODE_HUB:
		usb3503_reset(hub, 1);

		/* SP_ILOCK: set connect_n, config_n for config */
		err = regmap_write(hub->regmap, USB3503_SP_ILOCK,
				(USB3503_SPILOCK_CONNECT
				 | USB3503_SPILOCK_CONFIG));
		if (err < 0) {
			dev_err(dev, "SP_ILOCK failed (%d)\n", err);
			goto err_hubmode;
		}

		/* PDS : Disable For Self Powered Operation */
		if (hub->port_off_mask) {
			err = regmap_update_bits(hub->regmap, USB3503_PDS,
					hub->port_off_mask,
					hub->port_off_mask);
			if (err < 0) {
				dev_err(dev, "PDS failed (%d)\n", err);
				goto err_hubmode;
			}
		}

		/* CFG1 : SELF_BUS_PWR -> Self-Powerd operation */
		err = regmap_update_bits(hub->regmap, USB3503_CFG1,
					 USB3503_SELF_BUS_PWR,
					 USB3503_SELF_BUS_PWR);
		if (err < 0) {
			dev_err(dev, "CFG1 failed (%d)\n", err);
			goto err_hubmode;
		}

		/* SP_LOCK: clear connect_n, config_n for hub connect */
		err = regmap_update_bits(hub->regmap, USB3503_SP_ILOCK,
					 (USB3503_SPILOCK_CONNECT
					  | USB3503_SPILOCK_CONFIG), 0);
		if (err < 0) {
			dev_err(dev, "SP_ILOCK failed (%d)\n", err);
			goto err_hubmode;
		}

		if (gpio_is_valid(hub->gpio_connect))
			gpio_set_value_cansleep(hub->gpio_connect, 1);

		hub->mode = mode;
		dev_info(dev, "switched to HUB mode\n");
		break;

	case USB3503_MODE_STANDBY:
		usb3503_reset(hub, 0);

		hub->mode = mode;
		dev_info(dev, "switched to STANDBY mode\n");
		break;

	default:
		dev_err(dev, "unknown mode is request\n");
		err = -EINVAL;
		break;
	}

err_hubmode:
	return err;
}

static const struct regmap_config usb3503_regmap_config = {
	.reg_bits = 8,
	.val_bits = 8,

	.max_register = USB3503_RESET,
};

static int usb3503_probe(struct usb3503 *hub)
{
	struct device *dev = hub->dev;
	struct usb3503_platform_data *pdata = dev_get_platdata(dev);
	struct device_node *np = dev->of_node;
	int err;
	u32 mode = USB3503_MODE_UNKNOWN;
	const u32 *property;
	int len;

	if (pdata) {
		hub->port_off_mask	= pdata->port_off_mask;
		hub->gpio_intn		= pdata->gpio_intn;
		hub->gpio_connect	= pdata->gpio_connect;
		hub->gpio_reset		= pdata->gpio_reset;
		hub->mode		= pdata->initial_mode;
	} else if (np) {
		hub->port_off_mask = 0;

		property = of_get_property(np, "disabled-ports", &len);
		if (property && (len / sizeof(u32)) > 0) {
			int i;
			for (i = 0; i < len / sizeof(u32); i++) {
				u32 port = be32_to_cpu(property[i]);
				if ((1 <= port) && (port <= 3))
					hub->port_off_mask |= (1 << port);
			}
		}

		hub->gpio_intn	= of_get_named_gpio(np, "intn-gpios", 0);
		if (hub->gpio_intn == -EPROBE_DEFER)
			return -EPROBE_DEFER;
		hub->gpio_connect = of_get_named_gpio(np, "connect-gpios", 0);
		if (hub->gpio_connect == -EPROBE_DEFER)
			return -EPROBE_DEFER;
		hub->gpio_reset = of_get_named_gpio(np, "reset-gpios", 0);
		if (hub->gpio_reset == -EPROBE_DEFER)
			return -EPROBE_DEFER;
		of_property_read_u32(np, "initial-mode", &mode);
		hub->mode = mode;
	}

	if (gpio_is_valid(hub->gpio_intn)) {
		err = devm_gpio_request_one(dev, hub->gpio_intn,
				GPIOF_OUT_INIT_HIGH, "usb3503 intn");
		if (err) {
			dev_err(dev,
				"unable to request GPIO %d as connect pin (%d)\n",
				hub->gpio_intn, err);
			return err;
		}
	}

	if (gpio_is_valid(hub->gpio_connect)) {
		err = devm_gpio_request_one(dev, hub->gpio_connect,
				GPIOF_OUT_INIT_LOW, "usb3503 connect");
		if (err) {
			dev_err(dev,
				"unable to request GPIO %d as connect pin (%d)\n",
				hub->gpio_connect, err);
			return err;
		}
	}

	if (gpio_is_valid(hub->gpio_reset)) {
		err = devm_gpio_request_one(dev, hub->gpio_reset,
				GPIOF_OUT_INIT_LOW, "usb3503 reset");
		if (err) {
			dev_err(dev,
				"unable to request GPIO %d as reset pin (%d)\n",
				hub->gpio_reset, err);
			return err;
		}
	}

	usb3503_switch_mode(hub, hub->mode);

	dev_info(dev, "%s: probed on  %s mode\n", __func__,
			(hub->mode == USB3503_MODE_HUB) ? "hub" : "standby");

	return 0;
}

static int usb3503_i2c_probe(struct i2c_client *i2c,
			     const struct i2c_device_id *id)
{
	struct usb3503 *hub;
	int err;

	hub = devm_kzalloc(&i2c->dev, sizeof(struct usb3503), GFP_KERNEL);
	if (!hub) {
		dev_err(&i2c->dev, "private data alloc fail\n");
		return -ENOMEM;
	}

	i2c_set_clientdata(i2c, hub);
	hub->regmap = devm_regmap_init_i2c(i2c, &usb3503_regmap_config);
	if (IS_ERR(hub->regmap)) {
		err = PTR_ERR(hub->regmap);
		dev_err(&i2c->dev, "Failed to initialise regmap: %d\n", err);
		return err;
	}
	hub->dev = &i2c->dev;

	return usb3503_probe(hub);
}

static const struct i2c_device_id usb3503_id[] = {
	{ USB3503_I2C_NAME, 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, usb3503_id);

#ifdef CONFIG_OF
static const struct of_device_id usb3503_of_match[] = {
	{ .compatible = "smsc,usb3503", },
	{},
};
MODULE_DEVICE_TABLE(of, usb3503_of_match);
#endif

static struct i2c_driver usb3503_driver = {
	.driver = {
		.name = USB3503_I2C_NAME,
		.of_match_table = of_match_ptr(usb3503_of_match),
	},
	.probe		= usb3503_i2c_probe,
	.id_table	= usb3503_id,
};

module_i2c_driver(usb3503_driver);

MODULE_AUTHOR("Dongjin Kim <tobetter@gmail.com>");
MODULE_DESCRIPTION("USB3503 USB HUB driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
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
	21	#include <linux/i2c.h>
	22	#include <linux/gpio.h>
	23	#include <linux/delay.h>
	24	#include <linux/slab.h>
	25	#include <linux/module.h>
eab8050c	26	#include <linux/of_gpio.h>
6a099c63 DK	27	#include <linux/platform_device.h>
6a099c63 DK	28	#include <linux/platform_data/usb3503.h>
68b14134	29	#include <linux/regmap.h>
6a099c63 DK	30
	31	#define USB3503_VIDL 0x00
	32	#define USB3503_VIDM 0x01
	33	#define USB3503_PIDL 0x02
	34	#define USB3503_PIDM 0x03
	35	#define USB3503_DIDL 0x04
	36	#define USB3503_DIDM 0x05
	37
	38	#define USB3503_CFG1 0x06
	39	#define USB3503_SELF_BUS_PWR (1 << 7)
	40
	41	#define USB3503_CFG2 0x07
	42	#define USB3503_CFG3 0x08
	43	#define USB3503_NRD 0x09
	44
	45	#define USB3503_PDS 0x0a
6a099c63 DK	46
	47	#define USB3503_SP_ILOCK 0xe7
	48	#define USB3503_SPILOCK_CONNECT (1 << 1)
	49	#define USB3503_SPILOCK_CONFIG (1 << 0)
	50
	51	#define USB3503_CFGP 0xee
	52	#define USB3503_CLKSUSP (1 << 7)
	53
68b14134 MB	54	#define USB3503_RESET 0xff
68b14134 MB	55
6a099c63 DK	56	struct usb3503 {
6a099c63 DK	57	enum usb3503_mode mode;
68b14134 MB	58	struct regmap *regmap;
68b14134 MB	59	struct device *dev;
e8e44a48	60	u8 port_off_mask;
6a099c63 DK	61	int gpio_intn;
	62	int gpio_reset;
	63	int gpio_connect;
	64	};
	65
8e7245b8	66	static int usb3503_reset(struct usb3503 *hub, int state)
6a099c63	67	{
8e7245b8 MB	68	if (!state && gpio_is_valid(hub->gpio_connect))
	69	gpio_set_value_cansleep(hub->gpio_connect, 0);
	70
	71	if (gpio_is_valid(hub->gpio_reset))
	72	gpio_set_value_cansleep(hub->gpio_reset, state);
6a099c63	73
06a962fa	74	/* Wait T_HUBINIT == 4ms for hub logic to stabilize */
6a099c63	75	if (state)
06a962fa	76	usleep_range(4000, 10000);
6a099c63 DK	77
	78	return 0;
	79	}
	80
	81	static int usb3503_switch_mode(struct usb3503 *hub, enum usb3503_mode mode)
	82	{
68b14134	83	struct device *dev = hub->dev;
6a099c63 DK	84	int err = 0;
	85
	86	switch (mode) {
	87	case USB3503_MODE_HUB:
8e7245b8	88	usb3503_reset(hub, 1);
6a099c63 DK	89
6a099c63 DK	90	/* SP_ILOCK: set connect_n, config_n for config */
68b14134	91	err = regmap_write(hub->regmap, USB3503_SP_ILOCK,
6a099c63 DK	92	(USB3503_SPILOCK_CONNECT
	93	\| USB3503_SPILOCK_CONFIG));
	94	if (err < 0) {
68b14134	95	dev_err(dev, "SP_ILOCK failed (%d)\n", err);
6a099c63 DK	96	goto err_hubmode;
	97	}
	98
e8e44a48 DK	99	/* PDS : Disable For Self Powered Operation */
e8e44a48 DK	100	if (hub->port_off_mask) {
68b14134 MB	101	err = regmap_update_bits(hub->regmap, USB3503_PDS,
68b14134 MB	102	hub->port_off_mask,
e8e44a48 DK	103	hub->port_off_mask);
e8e44a48 DK	104	if (err < 0) {
68b14134	105	dev_err(dev, "PDS failed (%d)\n", err);
e8e44a48 DK	106	goto err_hubmode;
e8e44a48 DK	107	}
6a099c63 DK	108	}
	109
	110	/* CFG1 : SELF_BUS_PWR -> Self-Powerd operation */
68b14134 MB	111	err = regmap_update_bits(hub->regmap, USB3503_CFG1,
	112	USB3503_SELF_BUS_PWR,
	113	USB3503_SELF_BUS_PWR);
6a099c63	114	if (err < 0) {
68b14134	115	dev_err(dev, "CFG1 failed (%d)\n", err);
6a099c63 DK	116	goto err_hubmode;
	117	}
	118
	119	/* SP_LOCK: clear connect_n, config_n for hub connect */
68b14134 MB	120	err = regmap_update_bits(hub->regmap, USB3503_SP_ILOCK,
	121	(USB3503_SPILOCK_CONNECT
	122	\| USB3503_SPILOCK_CONFIG), 0);
6a099c63	123	if (err < 0) {
68b14134	124	dev_err(dev, "SP_ILOCK failed (%d)\n", err);
6a099c63 DK	125	goto err_hubmode;
	126	}
	127
8e7245b8 MB	128	if (gpio_is_valid(hub->gpio_connect))
	129	gpio_set_value_cansleep(hub->gpio_connect, 1);
	130
6a099c63	131	hub->mode = mode;
68b14134	132	dev_info(dev, "switched to HUB mode\n");
6a099c63 DK	133	break;
	134
	135	case USB3503_MODE_STANDBY:
8e7245b8	136	usb3503_reset(hub, 0);
6a099c63 DK	137
6a099c63 DK	138	hub->mode = mode;
68b14134	139	dev_info(dev, "switched to STANDBY mode\n");
6a099c63 DK	140	break;
	141
	142	default:
68b14134	143	dev_err(dev, "unknown mode is request\n");
6a099c63 DK	144	err = -EINVAL;
	145	break;
	146	}
	147
	148	err_hubmode:
	149	return err;
	150	}
	151
68b14134 MB	152	static const struct regmap_config usb3503_regmap_config = {
	153	.reg_bits = 8,
	154	.val_bits = 8,
	155
	156	.max_register = USB3503_RESET,
	157	};
	158
2487e3ee	159	static int usb3503_probe(struct usb3503 *hub)
6a099c63	160	{
2487e3ee MB	161	struct device *dev = hub->dev;
	162	struct usb3503_platform_data *pdata = dev_get_platdata(dev);
	163	struct device_node *np = dev->of_node;
	164	int err;
8ab03dd4	165	u32 mode = USB3503_MODE_UNKNOWN;
e8b58b49 DK	166	const u32 *property;
e8b58b49 DK	167	int len;
6a099c63	168
eab8050c	169	if (pdata) {
e8e44a48	170	hub->port_off_mask = pdata->port_off_mask;
6a099c63 DK	171	hub->gpio_intn = pdata->gpio_intn;
	172	hub->gpio_connect = pdata->gpio_connect;
	173	hub->gpio_reset = pdata->gpio_reset;
	174	hub->mode = pdata->initial_mode;
eab8050c	175	} else if (np) {
e8b58b49 DK	176	hub->port_off_mask = 0;
	177
	178	property = of_get_property(np, "disabled-ports", &len);
	179	if (property && (len / sizeof(u32)) > 0) {
	180	int i;
	181	for (i = 0; i < len / sizeof(u32); i++) {
	182	u32 port = be32_to_cpu(property[i]);
	183	if ((1 <= port) && (port <= 3))
	184	hub->port_off_mask \|= (1 << port);
	185	}
	186	}
	187
42416cc8	188	hub->gpio_intn = of_get_named_gpio(np, "intn-gpios", 0);
eab8050c DK	189	if (hub->gpio_intn == -EPROBE_DEFER)
eab8050c DK	190	return -EPROBE_DEFER;
42416cc8	191	hub->gpio_connect = of_get_named_gpio(np, "connect-gpios", 0);
eab8050c DK	192	if (hub->gpio_connect == -EPROBE_DEFER)
eab8050c DK	193	return -EPROBE_DEFER;
ccf92c94	194	hub->gpio_reset = of_get_named_gpio(np, "reset-gpios", 0);
eab8050c DK	195	if (hub->gpio_reset == -EPROBE_DEFER)
	196	return -EPROBE_DEFER;
	197	of_property_read_u32(np, "initial-mode", &mode);
	198	hub->mode = mode;
6a099c63 DK	199	}
	200
	201	if (gpio_is_valid(hub->gpio_intn)) {
2487e3ee	202	err = devm_gpio_request_one(dev, hub->gpio_intn,
6a099c63 DK	203	GPIOF_OUT_INIT_HIGH, "usb3503 intn");
6a099c63 DK	204	if (err) {
2487e3ee MB	205	dev_err(dev,
	206	"unable to request GPIO %d as connect pin (%d)\n",
	207	hub->gpio_intn, err);
cffedd67	208	return err;
6a099c63 DK	209	}
	210	}
	211
	212	if (gpio_is_valid(hub->gpio_connect)) {
2487e3ee	213	err = devm_gpio_request_one(dev, hub->gpio_connect,
8e7245b8	214	GPIOF_OUT_INIT_LOW, "usb3503 connect");
6a099c63	215	if (err) {
2487e3ee MB	216	dev_err(dev,
	217	"unable to request GPIO %d as connect pin (%d)\n",
	218	hub->gpio_connect, err);
cffedd67	219	return err;
6a099c63 DK	220	}
	221	}
	222
	223	if (gpio_is_valid(hub->gpio_reset)) {
2487e3ee	224	err = devm_gpio_request_one(dev, hub->gpio_reset,
6a099c63 DK	225	GPIOF_OUT_INIT_LOW, "usb3503 reset");
6a099c63 DK	226	if (err) {
2487e3ee MB	227	dev_err(dev,
	228	"unable to request GPIO %d as reset pin (%d)\n",
	229	hub->gpio_reset, err);
cffedd67	230	return err;
6a099c63 DK	231	}
	232	}
	233
eab8050c	234	usb3503_switch_mode(hub, hub->mode);
6a099c63	235
2487e3ee	236	dev_info(dev, "%s: probed on %s mode\n", __func__,
6a099c63 DK	237	(hub->mode == USB3503_MODE_HUB) ? "hub" : "standby");
	238
	239	return 0;
6a099c63 DK	240	}
6a099c63 DK	241
2487e3ee MB	242	static int usb3503_i2c_probe(struct i2c_client *i2c,
	243	const struct i2c_device_id *id)
	244	{
	245	struct usb3503 *hub;
	246	int err;
	247
	248	hub = devm_kzalloc(&i2c->dev, sizeof(struct usb3503), GFP_KERNEL);
	249	if (!hub) {
	250	dev_err(&i2c->dev, "private data alloc fail\n");
	251	return -ENOMEM;
	252	}
	253
	254	i2c_set_clientdata(i2c, hub);
	255	hub->regmap = devm_regmap_init_i2c(i2c, &usb3503_regmap_config);
	256	if (IS_ERR(hub->regmap)) {
	257	err = PTR_ERR(hub->regmap);
	258	dev_err(&i2c->dev, "Failed to initialise regmap: %d\n", err);
	259	return err;
	260	}
	261	hub->dev = &i2c->dev;
	262
	263	return usb3503_probe(hub);
	264	}
	265
6a099c63 DK	266	static const struct i2c_device_id usb3503_id[] = {
	267	{ USB3503_I2C_NAME, 0 },
	268	{ }
	269	};
	270	MODULE_DEVICE_TABLE(i2c, usb3503_id);
	271
eab8050c DK	272	#ifdef CONFIG_OF
	273	static const struct of_device_id usb3503_of_match[] = {
	274	{ .compatible = "smsc,usb3503", },
	275	{},
	276	};
	277	MODULE_DEVICE_TABLE(of, usb3503_of_match);
	278	#endif
	279
6a099c63 DK	280	static struct i2c_driver usb3503_driver = {
	281	.driver = {
	282	.name = USB3503_I2C_NAME,
eab8050c	283	.of_match_table = of_match_ptr(usb3503_of_match),
6a099c63	284	},
2487e3ee	285	.probe = usb3503_i2c_probe,
6a099c63 DK	286	.id_table = usb3503_id,
	287	};
	288
8244ac04	289	module_i2c_driver(usb3503_driver);
6a099c63 DK	290
	291	MODULE_AUTHOR("Dongjin Kim <tobetter@gmail.com>");
	292	MODULE_DESCRIPTION("USB3503 USB HUB driver");
	293	MODULE_LICENSE("GPL");