gpio-pca953x.c 25 KB
Newer Older
1
/*
2
 *  PCA953x 4/8/16/24/40 bit I/O ports
3 4 5 6 7 8 9 10 11 12 13
 *
 *  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.
 */

14
#include <linux/acpi.h>
15
#include <linux/gpio.h>
16
#include <linux/gpio/consumer.h>
17
#include <linux/i2c.h>
18 19 20 21
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/module.h>
#include <linux/of_platform.h>
22
#include <linux/platform_data/pca953x.h>
23
#include <linux/regulator/consumer.h>
24
#include <linux/slab.h>
25

26
#include <asm/unaligned.h>
27

28 29 30 31 32
#define PCA953X_INPUT		0
#define PCA953X_OUTPUT		1
#define PCA953X_INVERT		2
#define PCA953X_DIRECTION	3

33 34
#define REG_ADDR_AI		0x80

35 36 37 38 39 40 41 42 43
#define PCA957X_IN		0
#define PCA957X_INVRT		1
#define PCA957X_BKEN		2
#define PCA957X_PUPD		3
#define PCA957X_CFG		4
#define PCA957X_OUT		5
#define PCA957X_MSK		6
#define PCA957X_INTS		7

44 45 46 47
#define PCAL953X_IN_LATCH	34
#define PCAL953X_INT_MASK	37
#define PCAL953X_INT_STAT	38

48 49
#define PCA_GPIO_MASK		0x00FF
#define PCA_INT			0x0100
50
#define PCA_PCAL		0x0200
51 52
#define PCA953X_TYPE		0x1000
#define PCA957X_TYPE		0x2000
53 54 55
#define PCA_TYPE_MASK		0xF000

#define PCA_CHIP_TYPE(x)	((x) & PCA_TYPE_MASK)
56

57
static const struct i2c_device_id pca953x_id[] = {
58
	{ "pca9505", 40 | PCA953X_TYPE | PCA_INT, },
59 60 61 62 63 64 65 66 67 68 69 70
	{ "pca9534", 8  | PCA953X_TYPE | PCA_INT, },
	{ "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
	{ "pca9536", 4  | PCA953X_TYPE, },
	{ "pca9537", 4  | PCA953X_TYPE | PCA_INT, },
	{ "pca9538", 8  | PCA953X_TYPE | PCA_INT, },
	{ "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
	{ "pca9554", 8  | PCA953X_TYPE | PCA_INT, },
	{ "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
	{ "pca9556", 8  | PCA953X_TYPE, },
	{ "pca9557", 8  | PCA953X_TYPE, },
	{ "pca9574", 8  | PCA957X_TYPE | PCA_INT, },
	{ "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
71
	{ "pca9698", 40 | PCA953X_TYPE, },
72

73 74
	{ "pcal9555a", 16 | PCA953X_TYPE | PCA_INT | PCA_PCAL, },

75 76 77 78
	{ "max7310", 8  | PCA953X_TYPE, },
	{ "max7312", 16 | PCA953X_TYPE | PCA_INT, },
	{ "max7313", 16 | PCA953X_TYPE | PCA_INT, },
	{ "max7315", 8  | PCA953X_TYPE | PCA_INT, },
79
	{ "max7318", 16 | PCA953X_TYPE | PCA_INT, },
80 81 82
	{ "pca6107", 8  | PCA953X_TYPE | PCA_INT, },
	{ "tca6408", 8  | PCA953X_TYPE | PCA_INT, },
	{ "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
83
	{ "tca6424", 24 | PCA953X_TYPE | PCA_INT, },
84
	{ "tca9539", 16 | PCA953X_TYPE | PCA_INT, },
85
	{ "tca9554", 8  | PCA953X_TYPE | PCA_INT, },
86
	{ "xra1202", 8  | PCA953X_TYPE },
87
	{ }
88
};
89
MODULE_DEVICE_TABLE(i2c, pca953x_id);
90

91
static const struct acpi_device_id pca953x_acpi_ids[] = {
92
	{ "INT3491", 16 | PCA953X_TYPE | PCA_INT | PCA_PCAL, },
93 94 95 96
	{ }
};
MODULE_DEVICE_TABLE(acpi, pca953x_acpi_ids);

97 98 99
#define MAX_BANK 5
#define BANK_SZ 8

100
#define NBANK(chip) DIV_ROUND_UP(chip->gpio_chip.ngpio, BANK_SZ)
101

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
struct pca953x_reg_config {
	int direction;
	int output;
	int input;
};

static const struct pca953x_reg_config pca953x_regs = {
	.direction = PCA953X_DIRECTION,
	.output = PCA953X_OUTPUT,
	.input = PCA953X_INPUT,
};

static const struct pca953x_reg_config pca957x_regs = {
	.direction = PCA957X_CFG,
	.output = PCA957X_OUT,
	.input = PCA957X_IN,
};

120
struct pca953x_chip {
121
	unsigned gpio_start;
122 123
	u8 reg_output[MAX_BANK];
	u8 reg_direction[MAX_BANK];
124
	struct mutex i2c_lock;
125

126 127
#ifdef CONFIG_GPIO_PCA953X_IRQ
	struct mutex irq_lock;
128 129 130 131
	u8 irq_mask[MAX_BANK];
	u8 irq_stat[MAX_BANK];
	u8 irq_trig_raise[MAX_BANK];
	u8 irq_trig_fall[MAX_BANK];
132 133
#endif

134 135
	struct i2c_client *client;
	struct gpio_chip gpio_chip;
136
	const char *const *names;
137
	unsigned long driver_data;
138
	struct regulator *regulator;
139 140

	const struct pca953x_reg_config *regs;
141 142

	int (*write_regs)(struct pca953x_chip *, int, u8 *);
143
	int (*read_regs)(struct pca953x_chip *, int, u8 *);
144 145
};

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
static int pca953x_read_single(struct pca953x_chip *chip, int reg, u32 *val,
				int off)
{
	int ret;
	int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
	int offset = off / BANK_SZ;

	ret = i2c_smbus_read_byte_data(chip->client,
				(reg << bank_shift) + offset);
	*val = ret;

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

	return 0;
}

static int pca953x_write_single(struct pca953x_chip *chip, int reg, u32 val,
				int off)
{
168
	int ret;
169 170 171 172 173 174 175 176 177 178 179 180 181 182
	int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
	int offset = off / BANK_SZ;

	ret = i2c_smbus_write_byte_data(chip->client,
					(reg << bank_shift) + offset, val);

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

	return 0;
}

183
static int pca953x_write_regs_8(struct pca953x_chip *chip, int reg, u8 *val)
184
{
185 186
	return i2c_smbus_write_byte_data(chip->client, reg, *val);
}
187

188 189
static int pca953x_write_regs_16(struct pca953x_chip *chip, int reg, u8 *val)
{
190
	u16 word = get_unaligned((u16 *)val);
191

192
	return i2c_smbus_write_word_data(chip->client, reg << 1, word);
193 194 195 196 197 198 199 200 201 202 203 204
}

static int pca957x_write_regs_16(struct pca953x_chip *chip, int reg, u8 *val)
{
	int ret;

	ret = i2c_smbus_write_byte_data(chip->client, reg << 1, val[0]);
	if (ret < 0)
		return ret;

	return i2c_smbus_write_byte_data(chip->client, (reg << 1) + 1, val[1]);
}
205

206 207 208 209 210 211 212 213 214 215 216 217 218 219
static int pca953x_write_regs_24(struct pca953x_chip *chip, int reg, u8 *val)
{
	int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);

	return i2c_smbus_write_i2c_block_data(chip->client,
					      (reg << bank_shift) | REG_ADDR_AI,
					      NBANK(chip), val);
}

static int pca953x_write_regs(struct pca953x_chip *chip, int reg, u8 *val)
{
	int ret = 0;

	ret = chip->write_regs(chip, reg, val);
220 221
	if (ret < 0) {
		dev_err(&chip->client->dev, "failed writing register\n");
222
		return ret;
223 224 225
	}

	return 0;
226 227
}

228
static int pca953x_read_regs_8(struct pca953x_chip *chip, int reg, u8 *val)
229 230 231
{
	int ret;

232 233
	ret = i2c_smbus_read_byte_data(chip->client, reg);
	*val = ret;
234

235 236 237 238 239 240 241 242
	return ret;
}

static int pca953x_read_regs_16(struct pca953x_chip *chip, int reg, u8 *val)
{
	int ret;

	ret = i2c_smbus_read_word_data(chip->client, reg << 1);
243
	put_unaligned(ret, (u16 *)val);
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261

	return ret;
}

static int pca953x_read_regs_24(struct pca953x_chip *chip, int reg, u8 *val)
{
	int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);

	return i2c_smbus_read_i2c_block_data(chip->client,
					     (reg << bank_shift) | REG_ADDR_AI,
					     NBANK(chip), val);
}

static int pca953x_read_regs(struct pca953x_chip *chip, int reg, u8 *val)
{
	int ret;

	ret = chip->read_regs(chip, reg, val);
262 263
	if (ret < 0) {
		dev_err(&chip->client->dev, "failed reading register\n");
264
		return ret;
265 266 267 268 269
	}

	return 0;
}

270
static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
271
{
272
	struct pca953x_chip *chip = gpiochip_get_data(gc);
273
	u8 reg_val;
274
	int ret;
275

276
	mutex_lock(&chip->i2c_lock);
277
	reg_val = chip->reg_direction[off / BANK_SZ] | (1u << (off % BANK_SZ));
278

279
	ret = pca953x_write_single(chip, chip->regs->direction, reg_val, off);
280
	if (ret)
281
		goto exit;
282

283
	chip->reg_direction[off / BANK_SZ] = reg_val;
284 285 286
exit:
	mutex_unlock(&chip->i2c_lock);
	return ret;
287 288
}

289
static int pca953x_gpio_direction_output(struct gpio_chip *gc,
290 291
		unsigned off, int val)
{
292
	struct pca953x_chip *chip = gpiochip_get_data(gc);
293
	u8 reg_val;
294
	int ret;
295

296
	mutex_lock(&chip->i2c_lock);
297 298
	/* set output level */
	if (val)
299 300
		reg_val = chip->reg_output[off / BANK_SZ]
			| (1u << (off % BANK_SZ));
301
	else
302 303
		reg_val = chip->reg_output[off / BANK_SZ]
			& ~(1u << (off % BANK_SZ));
304

305
	ret = pca953x_write_single(chip, chip->regs->output, reg_val, off);
306
	if (ret)
307
		goto exit;
308

309
	chip->reg_output[off / BANK_SZ] = reg_val;
310 311

	/* then direction */
312
	reg_val = chip->reg_direction[off / BANK_SZ] & ~(1u << (off % BANK_SZ));
313
	ret = pca953x_write_single(chip, chip->regs->direction, reg_val, off);
314
	if (ret)
315
		goto exit;
316

317
	chip->reg_direction[off / BANK_SZ] = reg_val;
318 319 320
exit:
	mutex_unlock(&chip->i2c_lock);
	return ret;
321 322
}

323
static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
324
{
325
	struct pca953x_chip *chip = gpiochip_get_data(gc);
326
	u32 reg_val;
327
	int ret;
328

329
	mutex_lock(&chip->i2c_lock);
330
	ret = pca953x_read_single(chip, chip->regs->input, &reg_val, off);
331
	mutex_unlock(&chip->i2c_lock);
332 333 334 335 336 337 338 339
	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;
	}

340
	return (reg_val & (1u << (off % BANK_SZ))) ? 1 : 0;
341 342
}

343
static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
344
{
345
	struct pca953x_chip *chip = gpiochip_get_data(gc);
346
	u8 reg_val;
347
	int ret;
348

349
	mutex_lock(&chip->i2c_lock);
350
	if (val)
351 352
		reg_val = chip->reg_output[off / BANK_SZ]
			| (1u << (off % BANK_SZ));
353
	else
354 355
		reg_val = chip->reg_output[off / BANK_SZ]
			& ~(1u << (off % BANK_SZ));
356

357
	ret = pca953x_write_single(chip, chip->regs->output, reg_val, off);
358
	if (ret)
359
		goto exit;
360

361
	chip->reg_output[off / BANK_SZ] = reg_val;
362 363
exit:
	mutex_unlock(&chip->i2c_lock);
364 365
}

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
static int pca953x_gpio_get_direction(struct gpio_chip *gc, unsigned off)
{
	struct pca953x_chip *chip = gpiochip_get_data(gc);
	u32 reg_val;
	int ret;

	mutex_lock(&chip->i2c_lock);
	ret = pca953x_read_single(chip, chip->regs->direction, &reg_val, off);
	mutex_unlock(&chip->i2c_lock);
	if (ret < 0)
		return ret;

	return !!(reg_val & (1u << (off % BANK_SZ)));
}

381
static void pca953x_gpio_set_multiple(struct gpio_chip *gc,
382
				      unsigned long *mask, unsigned long *bits)
383
{
384
	struct pca953x_chip *chip = gpiochip_get_data(gc);
385 386
	unsigned int bank_mask, bank_val;
	int bank_shift, bank;
387
	u8 reg_val[MAX_BANK];
388
	int ret;
389 390

	bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
391 392

	mutex_lock(&chip->i2c_lock);
393
	memcpy(reg_val, chip->reg_output, NBANK(chip));
394 395 396 397 398 399
	for (bank = 0; bank < NBANK(chip); bank++) {
		bank_mask = mask[bank / sizeof(*mask)] >>
			   ((bank % sizeof(*mask)) * 8);
		if (bank_mask) {
			bank_val = bits[bank / sizeof(*bits)] >>
				  ((bank % sizeof(*bits)) * 8);
400
			bank_val &= bank_mask;
401
			reg_val[bank] = (reg_val[bank] & ~bank_mask) | bank_val;
402 403
		}
	}
404

405 406 407
	ret = i2c_smbus_write_i2c_block_data(chip->client,
					     chip->regs->output << bank_shift,
					     NBANK(chip), reg_val);
408 409 410 411 412 413 414 415
	if (ret)
		goto exit;

	memcpy(chip->reg_output, reg_val, NBANK(chip));
exit:
	mutex_unlock(&chip->i2c_lock);
}

416
static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
417 418 419 420 421
{
	struct gpio_chip *gc;

	gc = &chip->gpio_chip;

422 423 424 425
	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;
426
	gc->get_direction = pca953x_gpio_get_direction;
427
	gc->set_multiple = pca953x_gpio_set_multiple;
428
	gc->can_sleep = true;
429 430

	gc->base = chip->gpio_start;
431 432
	gc->ngpio = gpios;
	gc->label = chip->client->name;
433
	gc->parent = &chip->client->dev;
434
	gc->owner = THIS_MODULE;
435
	gc->names = chip->names;
436 437
}

438
#ifdef CONFIG_GPIO_PCA953X_IRQ
439
static void pca953x_irq_mask(struct irq_data *d)
440
{
441
	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
442
	struct pca953x_chip *chip = gpiochip_get_data(gc);
443

444
	chip->irq_mask[d->hwirq / BANK_SZ] &= ~(1 << (d->hwirq % BANK_SZ));
445 446
}

447
static void pca953x_irq_unmask(struct irq_data *d)
448
{
449
	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
450
	struct pca953x_chip *chip = gpiochip_get_data(gc);
451

452
	chip->irq_mask[d->hwirq / BANK_SZ] |= 1 << (d->hwirq % BANK_SZ);
453 454
}

455
static void pca953x_irq_bus_lock(struct irq_data *d)
456
{
457
	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
458
	struct pca953x_chip *chip = gpiochip_get_data(gc);
459 460 461 462

	mutex_lock(&chip->irq_lock);
}

463
static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
464
{
465
	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
466
	struct pca953x_chip *chip = gpiochip_get_data(gc);
467 468
	u8 new_irqs;
	int level, i;
469 470 471 472 473 474 475 476 477 478 479 480
	u8 invert_irq_mask[MAX_BANK];

	if (chip->driver_data & PCA_PCAL) {
		/* Enable latch on interrupt-enabled inputs */
		pca953x_write_regs(chip, PCAL953X_IN_LATCH, chip->irq_mask);

		for (i = 0; i < NBANK(chip); i++)
			invert_irq_mask[i] = ~chip->irq_mask[i];

		/* Unmask enabled interrupts */
		pca953x_write_regs(chip, PCAL953X_INT_MASK, invert_irq_mask);
	}
481 482

	/* Look for any newly setup interrupt */
483 484 485 486 487 488 489 490 491 492
	for (i = 0; i < NBANK(chip); i++) {
		new_irqs = chip->irq_trig_fall[i] | chip->irq_trig_raise[i];
		new_irqs &= ~chip->reg_direction[i];

		while (new_irqs) {
			level = __ffs(new_irqs);
			pca953x_gpio_direction_input(&chip->gpio_chip,
							level + (BANK_SZ * i));
			new_irqs &= ~(1 << level);
		}
493
	}
494 495 496 497

	mutex_unlock(&chip->irq_lock);
}

498
static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
499
{
500
	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
501
	struct pca953x_chip *chip = gpiochip_get_data(gc);
502 503
	int bank_nb = d->hwirq / BANK_SZ;
	u8 mask = 1 << (d->hwirq % BANK_SZ);
504 505 506

	if (!(type & IRQ_TYPE_EDGE_BOTH)) {
		dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
507
			d->irq, type);
508 509 510 511
		return -EINVAL;
	}

	if (type & IRQ_TYPE_EDGE_FALLING)
512
		chip->irq_trig_fall[bank_nb] |= mask;
513
	else
514
		chip->irq_trig_fall[bank_nb] &= ~mask;
515 516

	if (type & IRQ_TYPE_EDGE_RISING)
517
		chip->irq_trig_raise[bank_nb] |= mask;
518
	else
519
		chip->irq_trig_raise[bank_nb] &= ~mask;
520

521
	return 0;
522 523 524 525
}

static struct irq_chip pca953x_irq_chip = {
	.name			= "pca953x",
526 527 528 529 530
	.irq_mask		= pca953x_irq_mask,
	.irq_unmask		= pca953x_irq_unmask,
	.irq_bus_lock		= pca953x_irq_bus_lock,
	.irq_bus_sync_unlock	= pca953x_irq_bus_sync_unlock,
	.irq_set_type		= pca953x_irq_set_type,
531 532
};

533
static bool pca953x_irq_pending(struct pca953x_chip *chip, u8 *pending)
534
{
535 536
	u8 cur_stat[MAX_BANK];
	u8 old_stat[MAX_BANK];
537 538 539
	bool pending_seen = false;
	bool trigger_seen = false;
	u8 trigger[MAX_BANK];
540
	int ret, i;
541

542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
	if (chip->driver_data & PCA_PCAL) {
		/* Read the current interrupt status from the device */
		ret = pca953x_read_regs(chip, PCAL953X_INT_STAT, trigger);
		if (ret)
			return false;

		/* Check latched inputs and clear interrupt status */
		ret = pca953x_read_regs(chip, PCA953X_INPUT, cur_stat);
		if (ret)
			return false;

		for (i = 0; i < NBANK(chip); i++) {
			/* Apply filter for rising/falling edge selection */
			pending[i] = (~cur_stat[i] & chip->irq_trig_fall[i]) |
				(cur_stat[i] & chip->irq_trig_raise[i]);
			pending[i] &= trigger[i];
			if (pending[i])
				pending_seen = true;
		}

		return pending_seen;
	}

565
	ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
566
	if (ret)
567
		return false;
568 569

	/* Remove output pins from the equation */
570 571
	for (i = 0; i < NBANK(chip); i++)
		cur_stat[i] &= chip->reg_direction[i];
572

573
	memcpy(old_stat, chip->irq_stat, NBANK(chip));
574

575 576
	for (i = 0; i < NBANK(chip); i++) {
		trigger[i] = (cur_stat[i] ^ old_stat[i]) & chip->irq_mask[i];
577 578
		if (trigger[i])
			trigger_seen = true;
579 580
	}

581 582
	if (!trigger_seen)
		return false;
583

584
	memcpy(chip->irq_stat, cur_stat, NBANK(chip));
585

586 587 588 589
	for (i = 0; i < NBANK(chip); i++) {
		pending[i] = (old_stat[i] & chip->irq_trig_fall[i]) |
			(cur_stat[i] & chip->irq_trig_raise[i]);
		pending[i] &= trigger[i];
590 591
		if (pending[i])
			pending_seen = true;
592
	}
593

594
	return pending_seen;
595 596 597 598 599
}

static irqreturn_t pca953x_irq_handler(int irq, void *devid)
{
	struct pca953x_chip *chip = devid;
600 601
	u8 pending[MAX_BANK];
	u8 level;
602
	unsigned nhandled = 0;
603
	int i;
604

605
	if (!pca953x_irq_pending(chip, pending))
606
		return IRQ_NONE;
607

608 609 610
	for (i = 0; i < NBANK(chip); i++) {
		while (pending[i]) {
			level = __ffs(pending[i]);
611
			handle_nested_irq(irq_find_mapping(chip->gpio_chip.irq.domain,
612 613
							level + (BANK_SZ * i)));
			pending[i] &= ~(1 << level);
614
			nhandled++;
615 616
		}
	}
617

618
	return (nhandled > 0) ? IRQ_HANDLED : IRQ_NONE;
619 620 621
}

static int pca953x_irq_setup(struct pca953x_chip *chip,
622
			     int irq_base)
623 624
{
	struct i2c_client *client = chip->client;
625
	int ret, i;
626

627
	if (client->irq && irq_base != -1
628
			&& (chip->driver_data & PCA_INT)) {
629 630
		ret = pca953x_read_regs(chip,
					chip->regs->input, chip->irq_stat);
631
		if (ret)
632
			return ret;
633 634 635 636 637 638

		/*
		 * There is no way to know which GPIO line generated the
		 * interrupt.  We have to rely on the previous read for
		 * this purpose.
		 */
639 640
		for (i = 0; i < NBANK(chip); i++)
			chip->irq_stat[i] &= chip->reg_direction[i];
641 642
		mutex_init(&chip->irq_lock);

643 644
		ret = devm_request_threaded_irq(&client->dev,
					client->irq,
645 646
					   NULL,
					   pca953x_irq_handler,
647 648
					   IRQF_TRIGGER_LOW | IRQF_ONESHOT |
						   IRQF_SHARED,
649 650 651 652
					   dev_name(&client->dev), chip);
		if (ret) {
			dev_err(&client->dev, "failed to request irq %d\n",
				client->irq);
653
			return ret;
654 655
		}

656 657 658 659 660
		ret =  gpiochip_irqchip_add_nested(&chip->gpio_chip,
						   &pca953x_irq_chip,
						   irq_base,
						   handle_simple_irq,
						   IRQ_TYPE_NONE);
661 662 663 664 665
		if (ret) {
			dev_err(&client->dev,
				"could not connect irqchip to gpiochip\n");
			return ret;
		}
666

667 668 669
		gpiochip_set_nested_irqchip(&chip->gpio_chip,
					    &pca953x_irq_chip,
					    client->irq);
670 671 672 673 674 675 676
	}

	return 0;
}

#else /* CONFIG_GPIO_PCA953X_IRQ */
static int pca953x_irq_setup(struct pca953x_chip *chip,
677
			     int irq_base)
678 679 680
{
	struct i2c_client *client = chip->client;

681
	if (irq_base != -1 && (chip->driver_data & PCA_INT))
682 683 684 685 686 687
		dev_warn(&client->dev, "interrupt support not compiled in\n");

	return 0;
}
#endif

688
static int device_pca953x_init(struct pca953x_chip *chip, u32 invert)
689 690
{
	int ret;
691
	u8 val[MAX_BANK];
692

693 694 695
	chip->regs = &pca953x_regs;

	ret = pca953x_read_regs(chip, chip->regs->output, chip->reg_output);
696 697 698
	if (ret)
		goto out;

699 700
	ret = pca953x_read_regs(chip, chip->regs->direction,
				chip->reg_direction);
701 702 703 704
	if (ret)
		goto out;

	/* set platform specific polarity inversion */
705 706 707 708 709 710
	if (invert)
		memset(val, 0xFF, NBANK(chip));
	else
		memset(val, 0, NBANK(chip));

	ret = pca953x_write_regs(chip, PCA953X_INVERT, val);
711 712 713 714
out:
	return ret;
}

715
static int device_pca957x_init(struct pca953x_chip *chip, u32 invert)
716 717
{
	int ret;
718
	u8 val[MAX_BANK];
719

720 721 722
	chip->regs = &pca957x_regs;

	ret = pca953x_read_regs(chip, chip->regs->output, chip->reg_output);
723 724
	if (ret)
		goto out;
725 726
	ret = pca953x_read_regs(chip, chip->regs->direction,
				chip->reg_direction);
727 728 729 730
	if (ret)
		goto out;

	/* set platform specific polarity inversion */
731 732 733 734
	if (invert)
		memset(val, 0xFF, NBANK(chip));
	else
		memset(val, 0, NBANK(chip));
735 736 737
	ret = pca953x_write_regs(chip, PCA957X_INVRT, val);
	if (ret)
		goto out;
738

739
	/* To enable register 6, 7 to control pull up and pull down */
740
	memset(val, 0x02, NBANK(chip));
741 742 743
	ret = pca953x_write_regs(chip, PCA957X_BKEN, val);
	if (ret)
		goto out;
744 745 746 747 748 749

	return 0;
out:
	return ret;
}

750 751
static const struct of_device_id pca953x_dt_ids[];

752
static int pca953x_probe(struct i2c_client *client,
753
				   const struct i2c_device_id *i2c_id)
754
{
755 756
	struct pca953x_platform_data *pdata;
	struct pca953x_chip *chip;
757
	int irq_base = 0;
758
	int ret;
759
	u32 invert = 0;
760
	struct regulator *reg;
761

762 763
	chip = devm_kzalloc(&client->dev,
			sizeof(struct pca953x_chip), GFP_KERNEL);
764 765 766
	if (chip == NULL)
		return -ENOMEM;

767
	pdata = dev_get_platdata(&client->dev);
768 769 770 771 772 773
	if (pdata) {
		irq_base = pdata->irq_base;
		chip->gpio_start = pdata->gpio_base;
		invert = pdata->invert;
		chip->names = pdata->names;
	} else {
774 775
		struct gpio_desc *reset_gpio;

776 777
		chip->gpio_start = -1;
		irq_base = 0;
778

779 780 781 782 783 784 785
		/*
		 * See if we need to de-assert a reset pin.
		 *
		 * There is no known ACPI-enabled platforms that are
		 * using "reset" GPIO. Otherwise any of those platform
		 * must use _DSD method with corresponding property.
		 */
786 787 788 789
		reset_gpio = devm_gpiod_get_optional(&client->dev, "reset",
						     GPIOD_OUT_LOW);
		if (IS_ERR(reset_gpio))
			return PTR_ERR(reset_gpio);
790
	}
791 792 793

	chip->client = client;

794 795 796 797 798 799 800 801 802 803 804 805 806 807
	reg = devm_regulator_get(&client->dev, "vcc");
	if (IS_ERR(reg)) {
		ret = PTR_ERR(reg);
		if (ret != -EPROBE_DEFER)
			dev_err(&client->dev, "reg get err: %d\n", ret);
		return ret;
	}
	ret = regulator_enable(reg);
	if (ret) {
		dev_err(&client->dev, "reg en err: %d\n", ret);
		return ret;
	}
	chip->regulator = reg;

808 809
	if (i2c_id) {
		chip->driver_data = i2c_id->driver_data;
810
	} else {
811
		const struct acpi_device_id *acpi_id;
812
		const struct of_device_id *match;
813

814 815 816 817
		match = of_match_device(pca953x_dt_ids, &client->dev);
		if (match) {
			chip->driver_data = (int)(uintptr_t)match->data;
		} else {
818
			acpi_id = acpi_match_device(pca953x_acpi_ids, &client->dev);
819
			if (!acpi_id) {
820 821 822
				ret = -ENODEV;
				goto err_exit;
			}
823

824
			chip->driver_data = acpi_id->driver_data;
825
		}
826 827
	}

828
	mutex_init(&chip->i2c_lock);
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
	/*
	 * In case we have an i2c-mux controlled by a GPIO provided by an
	 * expander using the same driver higher on the device tree, read the
	 * i2c adapter nesting depth and use the retrieved value as lockdep
	 * subclass for chip->i2c_lock.
	 *
	 * REVISIT: This solution is not complete. It protects us from lockdep
	 * false positives when the expander controlling the i2c-mux is on
	 * a different level on the device tree, but not when it's on the same
	 * level on a different branch (in which case the subclass number
	 * would be the same).
	 *
	 * TODO: Once a correct solution is developed, a similar fix should be
	 * applied to all other i2c-controlled GPIO expanders (and potentially
	 * regmap-i2c).
	 */
845 846
	lockdep_set_subclass(&chip->i2c_lock,
			     i2c_adapter_depth(client->adapter));
847

848 849 850
	/* initialize cached registers from their original values.
	 * we can't share this chip with another i2c master.
	 */
851
	pca953x_setup_gpio(chip, chip->driver_data & PCA_GPIO_MASK);
852

853 854
	if (chip->gpio_chip.ngpio <= 8) {
		chip->write_regs = pca953x_write_regs_8;
855
		chip->read_regs = pca953x_read_regs_8;
856 857
	} else if (chip->gpio_chip.ngpio >= 24) {
		chip->write_regs = pca953x_write_regs_24;
858
		chip->read_regs = pca953x_read_regs_24;
859 860 861 862 863
	} else {
		if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE)
			chip->write_regs = pca953x_write_regs_16;
		else
			chip->write_regs = pca957x_write_regs_16;
864
		chip->read_regs = pca953x_read_regs_16;
865 866
	}

867
	if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE)
868
		ret = device_pca953x_init(chip, invert);
869
	else
870 871
		ret = device_pca957x_init(chip, invert);
	if (ret)
872
		goto err_exit;
873

874
	ret = devm_gpiochip_add_data(&client->dev, &chip->gpio_chip, chip);
875
	if (ret)
876
		goto err_exit;
877

878
	ret = pca953x_irq_setup(chip, irq_base);
879
	if (ret)
880
		goto err_exit;
881

882
	if (pdata && pdata->setup) {
883 884 885 886 887 888 889 890
		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;
891 892 893 894

err_exit:
	regulator_disable(chip->regulator);
	return ret;
895 896
}

897
static int pca953x_remove(struct i2c_client *client)
898
{
899
	struct pca953x_platform_data *pdata = dev_get_platdata(&client->dev);
900
	struct pca953x_chip *chip = i2c_get_clientdata(client);
901
	int ret;
902

903
	if (pdata && pdata->teardown) {
904 905
		ret = pdata->teardown(client, chip->gpio_chip.base,
				chip->gpio_chip.ngpio, pdata->context);
906
		if (ret < 0)
907 908
			dev_err(&client->dev, "%s failed, %d\n",
					"teardown", ret);
909 910
	} else {
		ret = 0;
911 912
	}

913 914 915
	regulator_disable(chip->regulator);

	return ret;
916 917
}

918 919 920 921
/* convenience to stop overlong match-table lines */
#define OF_953X(__nrgpio, __int) (void *)(__nrgpio | PCA953X_TYPE | __int)
#define OF_957X(__nrgpio, __int) (void *)(__nrgpio | PCA957X_TYPE | __int)

922
static const struct of_device_id pca953x_dt_ids[] = {
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
	{ .compatible = "nxp,pca9505", .data = OF_953X(40, PCA_INT), },
	{ .compatible = "nxp,pca9534", .data = OF_953X( 8, PCA_INT), },
	{ .compatible = "nxp,pca9535", .data = OF_953X(16, PCA_INT), },
	{ .compatible = "nxp,pca9536", .data = OF_953X( 4, 0), },
	{ .compatible = "nxp,pca9537", .data = OF_953X( 4, PCA_INT), },
	{ .compatible = "nxp,pca9538", .data = OF_953X( 8, PCA_INT), },
	{ .compatible = "nxp,pca9539", .data = OF_953X(16, PCA_INT), },
	{ .compatible = "nxp,pca9554", .data = OF_953X( 8, PCA_INT), },
	{ .compatible = "nxp,pca9555", .data = OF_953X(16, PCA_INT), },
	{ .compatible = "nxp,pca9556", .data = OF_953X( 8, 0), },
	{ .compatible = "nxp,pca9557", .data = OF_953X( 8, 0), },
	{ .compatible = "nxp,pca9574", .data = OF_957X( 8, PCA_INT), },
	{ .compatible = "nxp,pca9575", .data = OF_957X(16, PCA_INT), },
	{ .compatible = "nxp,pca9698", .data = OF_953X(40, 0), },

	{ .compatible = "maxim,max7310", .data = OF_953X( 8, 0), },
	{ .compatible = "maxim,max7312", .data = OF_953X(16, PCA_INT), },
	{ .compatible = "maxim,max7313", .data = OF_953X(16, PCA_INT), },
	{ .compatible = "maxim,max7315", .data = OF_953X( 8, PCA_INT), },
942
	{ .compatible = "maxim,max7318", .data = OF_953X(16, PCA_INT), },
943 944

	{ .compatible = "ti,pca6107", .data = OF_953X( 8, PCA_INT), },
945
	{ .compatible = "ti,pca9536", .data = OF_953X( 4, 0), },
946 947 948 949 950 951 952
	{ .compatible = "ti,tca6408", .data = OF_953X( 8, PCA_INT), },
	{ .compatible = "ti,tca6416", .data = OF_953X(16, PCA_INT), },
	{ .compatible = "ti,tca6424", .data = OF_953X(24, PCA_INT), },

	{ .compatible = "onsemi,pca9654", .data = OF_953X( 8, PCA_INT), },

	{ .compatible = "exar,xra1202", .data = OF_953X( 8, 0), },
953 954 955 956 957
	{ }
};

MODULE_DEVICE_TABLE(of, pca953x_dt_ids);

958
static struct i2c_driver pca953x_driver = {
959
	.driver = {
960
		.name	= "pca953x",
961
		.of_match_table = pca953x_dt_ids,
962
		.acpi_match_table = ACPI_PTR(pca953x_acpi_ids),
963
	},
964 965
	.probe		= pca953x_probe,
	.remove		= pca953x_remove,
966
	.id_table	= pca953x_id,
967 968
};

969
static int __init pca953x_init(void)
970
{
971
	return i2c_add_driver(&pca953x_driver);
972
}
973 974 975 976
/* register after i2c postcore initcall and before
 * subsys initcalls that may rely on these GPIOs
 */
subsys_initcall(pca953x_init);
977

978
static void __exit pca953x_exit(void)
979
{
980
	i2c_del_driver(&pca953x_driver);
981
}
982
module_exit(pca953x_exit);
983 984

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