pca953x.c 6.9 KB
Newer Older
1
/*
2
 *  pca953x.c - 4/8/16 bit I/O ports
3 4 5 6 7 8 9 10 11 12 13 14 15 16
 *
 *  Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
 *  Copyright (C) 2007 Marvell International Ltd.
 *
 *  Derived from drivers/i2c/chips/pca9539.c
 *
 *  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; version 2 of the License.
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/i2c.h>
17
#include <linux/i2c/pca953x.h>
18 19 20

#include <asm/gpio.h>

21 22 23 24
#define PCA953X_INPUT          0
#define PCA953X_OUTPUT         1
#define PCA953X_INVERT         2
#define PCA953X_DIRECTION      3
25

26 27 28 29 30
/* This is temporary - in 2.6.26 i2c_driver_data should replace it. */
struct pca953x_desc {
	char		name[I2C_NAME_SIZE];
	unsigned long	driver_data;
};
31

32 33 34 35 36 37 38 39 40
static const struct pca953x_desc pca953x_descs[] = {
	{ "pca9534", 8, },
	{ "pca9535", 16, },
	{ "pca9536", 4, },
	{ "pca9537", 4, },
	{ "pca9538", 8, },
	{ "pca9539", 16, },
	/* REVISIT several pca955x parts should work here too */
};
41

42
struct pca953x_chip {
43 44 45 46 47 48 49 50 51 52 53
	unsigned gpio_start;
	uint16_t reg_output;
	uint16_t reg_direction;

	struct i2c_client *client;
	struct gpio_chip gpio_chip;
};

/* NOTE:  we can't currently rely on fault codes to come from SMBus
 * calls, so we map all errors to EIO here and return zero otherwise.
 */
54
static int pca953x_write_reg(struct pca953x_chip *chip, int reg, uint16_t val)
55
{
56 57 58 59
	int ret;

	if (chip->gpio_chip.ngpio <= 8)
		ret = i2c_smbus_write_byte_data(chip->client, reg, val);
60
	else
61 62 63 64 65 66 67 68
		ret = i2c_smbus_write_word_data(chip->client, reg << 1, val);

	if (ret < 0) {
		dev_err(&chip->client->dev, "failed writing register\n");
		return -EIO;
	}

	return 0;
69 70
}

71
static int pca953x_read_reg(struct pca953x_chip *chip, int reg, uint16_t *val)
72 73 74
{
	int ret;

75 76 77 78 79
	if (chip->gpio_chip.ngpio <= 8)
		ret = i2c_smbus_read_byte_data(chip->client, reg);
	else
		ret = i2c_smbus_read_word_data(chip->client, reg << 1);

80 81 82 83 84 85 86 87 88
	if (ret < 0) {
		dev_err(&chip->client->dev, "failed reading register\n");
		return -EIO;
	}

	*val = (uint16_t)ret;
	return 0;
}

89
static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
90
{
91
	struct pca953x_chip *chip;
92 93 94
	uint16_t reg_val;
	int ret;

95
	chip = container_of(gc, struct pca953x_chip, gpio_chip);
96 97

	reg_val = chip->reg_direction | (1u << off);
98
	ret = pca953x_write_reg(chip, PCA953X_DIRECTION, reg_val);
99 100 101 102 103 104 105
	if (ret)
		return ret;

	chip->reg_direction = reg_val;
	return 0;
}

106
static int pca953x_gpio_direction_output(struct gpio_chip *gc,
107 108
		unsigned off, int val)
{
109
	struct pca953x_chip *chip;
110 111 112
	uint16_t reg_val;
	int ret;

113
	chip = container_of(gc, struct pca953x_chip, gpio_chip);
114 115 116 117 118 119 120

	/* set output level */
	if (val)
		reg_val = chip->reg_output | (1u << off);
	else
		reg_val = chip->reg_output & ~(1u << off);

121
	ret = pca953x_write_reg(chip, PCA953X_OUTPUT, reg_val);
122 123 124 125 126 127 128
	if (ret)
		return ret;

	chip->reg_output = reg_val;

	/* then direction */
	reg_val = chip->reg_direction & ~(1u << off);
129
	ret = pca953x_write_reg(chip, PCA953X_DIRECTION, reg_val);
130 131 132 133 134 135 136
	if (ret)
		return ret;

	chip->reg_direction = reg_val;
	return 0;
}

137
static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
138
{
139
	struct pca953x_chip *chip;
140 141 142
	uint16_t reg_val;
	int ret;

143
	chip = container_of(gc, struct pca953x_chip, gpio_chip);
144

145
	ret = pca953x_read_reg(chip, PCA953X_INPUT, &reg_val);
146 147 148 149 150 151 152 153 154 155 156
	if (ret < 0) {
		/* NOTE:  diagnostic already emitted; that's all we should
		 * do unless gpio_*_value_cansleep() calls become different
		 * from their nonsleeping siblings (and report faults).
		 */
		return 0;
	}

	return (reg_val & (1u << off)) ? 1 : 0;
}

157
static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
158
{
159
	struct pca953x_chip *chip;
160 161 162
	uint16_t reg_val;
	int ret;

163
	chip = container_of(gc, struct pca953x_chip, gpio_chip);
164 165 166 167 168 169

	if (val)
		reg_val = chip->reg_output | (1u << off);
	else
		reg_val = chip->reg_output & ~(1u << off);

170
	ret = pca953x_write_reg(chip, PCA953X_OUTPUT, reg_val);
171 172 173 174 175 176
	if (ret)
		return;

	chip->reg_output = reg_val;
}

177
static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
178 179 180 181 182
{
	struct gpio_chip *gc;

	gc = &chip->gpio_chip;

183 184 185 186
	gc->direction_input  = pca953x_gpio_direction_input;
	gc->direction_output = pca953x_gpio_direction_output;
	gc->get = pca953x_gpio_get_value;
	gc->set = pca953x_gpio_set_value;
187
	gc->can_sleep = 1;
188 189

	gc->base = chip->gpio_start;
190 191
	gc->ngpio = gpios;
	gc->label = chip->client->name;
192
	gc->owner = THIS_MODULE;
193 194
}

195
static int __devinit pca953x_probe(struct i2c_client *client)
196
{
197 198
	struct pca953x_platform_data *pdata;
	struct pca953x_chip *chip;
199 200
	int ret, i;
	const struct pca953x_desc *id = NULL;
201 202 203 204 205

	pdata = client->dev.platform_data;
	if (pdata == NULL)
		return -ENODEV;

206 207 208 209 210 211 212 213 214
	/* this loop vanishes when we get i2c_device_id */
	for (i = 0; i < ARRAY_SIZE(pca953x_descs); i++)
		if (!strcmp(pca953x_descs[i].name, client->name)) {
			id = pca953x_descs + i;
			break;
		}
	if (!id)
		return -ENODEV;

215
	chip = kzalloc(sizeof(struct pca953x_chip), GFP_KERNEL);
216 217 218 219 220 221 222 223 224 225
	if (chip == NULL)
		return -ENOMEM;

	chip->client = client;

	chip->gpio_start = pdata->gpio_base;

	/* initialize cached registers from their original values.
	 * we can't share this chip with another i2c master.
	 */
226 227
	pca953x_setup_gpio(chip, id->driver_data);

228
	ret = pca953x_read_reg(chip, PCA953X_OUTPUT, &chip->reg_output);
229 230 231
	if (ret)
		goto out_failed;

232
	ret = pca953x_read_reg(chip, PCA953X_DIRECTION, &chip->reg_direction);
233 234 235 236
	if (ret)
		goto out_failed;

	/* set platform specific polarity inversion */
237
	ret = pca953x_write_reg(chip, PCA953X_INVERT, pdata->invert);
238 239 240
	if (ret)
		goto out_failed;

241 242

	ret = gpiochip_add(&chip->gpio_chip);
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
	if (ret)
		goto out_failed;

	if (pdata->setup) {
		ret = pdata->setup(client, chip->gpio_chip.base,
				chip->gpio_chip.ngpio, pdata->context);
		if (ret < 0)
			dev_warn(&client->dev, "setup failed, %d\n", ret);
	}

	i2c_set_clientdata(client, chip);
	return 0;

out_failed:
	kfree(chip);
	return ret;
}

261
static int pca953x_remove(struct i2c_client *client)
262
{
263 264
	struct pca953x_platform_data *pdata = client->dev.platform_data;
	struct pca953x_chip *chip = i2c_get_clientdata(client);
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
	int ret = 0;

	if (pdata->teardown) {
		ret = pdata->teardown(client, chip->gpio_chip.base,
				chip->gpio_chip.ngpio, pdata->context);
		if (ret < 0) {
			dev_err(&client->dev, "%s failed, %d\n",
					"teardown", ret);
			return ret;
		}
	}

	ret = gpiochip_remove(&chip->gpio_chip);
	if (ret) {
		dev_err(&client->dev, "%s failed, %d\n",
				"gpiochip_remove()", ret);
		return ret;
	}

	kfree(chip);
	return 0;
}

288
static struct i2c_driver pca953x_driver = {
289
	.driver = {
290
		.name	= "pca953x",
291
	},
292 293
	.probe		= pca953x_probe,
	.remove		= pca953x_remove,
294 295
};

296
static int __init pca953x_init(void)
297
{
298
	return i2c_add_driver(&pca953x_driver);
299
}
300
module_init(pca953x_init);
301

302
static void __exit pca953x_exit(void)
303
{
304
	i2c_del_driver(&pca953x_driver);
305
}
306
module_exit(pca953x_exit);
307 308

MODULE_AUTHOR("eric miao <eric.miao@marvell.com>");
309
MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
310
MODULE_LICENSE("GPL");