Linux Audio

Check our new training course

Embedded Linux training

Mar 10-20, 2025, special US time zones
Register
Loading...
v3.1
 
  1/*
  2 *  PCA953x 4/8/16 bit I/O ports
  3 *
  4 *  Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
  5 *  Copyright (C) 2007 Marvell International Ltd.
  6 *
  7 *  Derived from drivers/i2c/chips/pca9539.c
  8 *
  9 *  This program is free software; you can redistribute it and/or modify
 10 *  it under the terms of the GNU General Public License as published by
 11 *  the Free Software Foundation; version 2 of the License.
 12 */
 13
 14#include <linux/module.h>
 
 
 
 
 15#include <linux/init.h>
 16#include <linux/gpio.h>
 17#include <linux/interrupt.h>
 18#include <linux/irq.h>
 19#include <linux/i2c.h>
 20#include <linux/i2c/pca953x.h>
 21#include <linux/slab.h>
 22#ifdef CONFIG_OF_GPIO
 23#include <linux/of_platform.h>
 24#endif
 
 
 
 
 
 25
 26#define PCA953X_INPUT		0
 27#define PCA953X_OUTPUT		1
 28#define PCA953X_INVERT		2
 29#define PCA953X_DIRECTION	3
 30
 31#define PCA957X_IN		0
 32#define PCA957X_INVRT		1
 33#define PCA957X_BKEN		2
 34#define PCA957X_PUPD		3
 35#define PCA957X_CFG		4
 36#define PCA957X_OUT		5
 37#define PCA957X_MSK		6
 38#define PCA957X_INTS		7
 39
 40#define PCA_GPIO_MASK		0x00FF
 41#define PCA_INT			0x0100
 42#define PCA953X_TYPE		0x1000
 43#define PCA957X_TYPE		0x2000
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 44
 45static const struct i2c_device_id pca953x_id[] = {
 
 
 
 46	{ "pca9534", 8  | PCA953X_TYPE | PCA_INT, },
 47	{ "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
 48	{ "pca9536", 4  | PCA953X_TYPE, },
 49	{ "pca9537", 4  | PCA953X_TYPE | PCA_INT, },
 50	{ "pca9538", 8  | PCA953X_TYPE | PCA_INT, },
 51	{ "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
 52	{ "pca9554", 8  | PCA953X_TYPE | PCA_INT, },
 53	{ "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
 54	{ "pca9556", 8  | PCA953X_TYPE, },
 55	{ "pca9557", 8  | PCA953X_TYPE, },
 56	{ "pca9574", 8  | PCA957X_TYPE | PCA_INT, },
 57	{ "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
 
 
 
 
 
 
 
 58
 59	{ "max7310", 8  | PCA953X_TYPE, },
 60	{ "max7312", 16 | PCA953X_TYPE | PCA_INT, },
 61	{ "max7313", 16 | PCA953X_TYPE | PCA_INT, },
 62	{ "max7315", 8  | PCA953X_TYPE | PCA_INT, },
 
 63	{ "pca6107", 8  | PCA953X_TYPE | PCA_INT, },
 64	{ "tca6408", 8  | PCA953X_TYPE | PCA_INT, },
 65	{ "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
 66	/* NYET:  { "tca6424", 24, }, */
 
 
 
 67	{ }
 68};
 69MODULE_DEVICE_TABLE(i2c, pca953x_id);
 70
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 71struct pca953x_chip {
 72	unsigned gpio_start;
 73	uint16_t reg_output;
 74	uint16_t reg_direction;
 75	struct mutex i2c_lock;
 
 76
 77#ifdef CONFIG_GPIO_PCA953X_IRQ
 78	struct mutex irq_lock;
 79	uint16_t irq_mask;
 80	uint16_t irq_stat;
 81	uint16_t irq_trig_raise;
 82	uint16_t irq_trig_fall;
 83	int	 irq_base;
 84#endif
 
 85
 86	struct i2c_client *client;
 87	struct gpio_chip gpio_chip;
 88	const char *const *names;
 89	int	chip_type;
 
 
 
 90};
 91
 92static int pca953x_write_reg(struct pca953x_chip *chip, int reg, uint16_t val)
 93{
 94	int ret = 0;
 
 95
 96	if (chip->gpio_chip.ngpio <= 8)
 97		ret = i2c_smbus_write_byte_data(chip->client, reg, val);
 98	else {
 99		switch (chip->chip_type) {
100		case PCA953X_TYPE:
101			ret = i2c_smbus_write_word_data(chip->client,
102							reg << 1, val);
103			break;
104		case PCA957X_TYPE:
105			ret = i2c_smbus_write_byte_data(chip->client, reg << 1,
106							val & 0xff);
107			if (ret < 0)
108				break;
109			ret = i2c_smbus_write_byte_data(chip->client,
110							(reg << 1) + 1,
111							(val & 0xff00) >> 8);
112			break;
113		}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
114	}
115
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
116	if (ret < 0) {
117		dev_err(&chip->client->dev, "failed writing register\n");
118		return ret;
119	}
120
121	return 0;
122}
123
124static int pca953x_read_reg(struct pca953x_chip *chip, int reg, uint16_t *val)
125{
126	int ret;
127
128	if (chip->gpio_chip.ngpio <= 8)
129		ret = i2c_smbus_read_byte_data(chip->client, reg);
130	else
131		ret = i2c_smbus_read_word_data(chip->client, reg << 1);
132
 
133	if (ret < 0) {
134		dev_err(&chip->client->dev, "failed reading register\n");
135		return ret;
136	}
137
138	*val = (uint16_t)ret;
 
 
139	return 0;
140}
141
142static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
143{
144	struct pca953x_chip *chip;
145	uint16_t reg_val;
146	int ret, offset = 0;
147
148	chip = container_of(gc, struct pca953x_chip, gpio_chip);
149
150	mutex_lock(&chip->i2c_lock);
151	reg_val = chip->reg_direction | (1u << off);
152
153	switch (chip->chip_type) {
154	case PCA953X_TYPE:
155		offset = PCA953X_DIRECTION;
156		break;
157	case PCA957X_TYPE:
158		offset = PCA957X_CFG;
159		break;
160	}
161	ret = pca953x_write_reg(chip, offset, reg_val);
162	if (ret)
163		goto exit;
164
165	chip->reg_direction = reg_val;
166	ret = 0;
167exit:
168	mutex_unlock(&chip->i2c_lock);
169	return ret;
170}
171
172static int pca953x_gpio_direction_output(struct gpio_chip *gc,
173		unsigned off, int val)
174{
175	struct pca953x_chip *chip;
176	uint16_t reg_val;
177	int ret, offset = 0;
178
179	chip = container_of(gc, struct pca953x_chip, gpio_chip);
180
181	mutex_lock(&chip->i2c_lock);
182	/* set output level */
183	if (val)
184		reg_val = chip->reg_output | (1u << off);
185	else
186		reg_val = chip->reg_output & ~(1u << off);
187
188	switch (chip->chip_type) {
189	case PCA953X_TYPE:
190		offset = PCA953X_OUTPUT;
191		break;
192	case PCA957X_TYPE:
193		offset = PCA957X_OUT;
194		break;
195	}
196	ret = pca953x_write_reg(chip, offset, reg_val);
197	if (ret)
198		goto exit;
199
200	chip->reg_output = reg_val;
201
202	/* then direction */
203	reg_val = chip->reg_direction & ~(1u << off);
204	switch (chip->chip_type) {
205	case PCA953X_TYPE:
206		offset = PCA953X_DIRECTION;
207		break;
208	case PCA957X_TYPE:
209		offset = PCA957X_CFG;
210		break;
211	}
212	ret = pca953x_write_reg(chip, offset, reg_val);
213	if (ret)
214		goto exit;
215
216	chip->reg_direction = reg_val;
217	ret = 0;
218exit:
219	mutex_unlock(&chip->i2c_lock);
220	return ret;
221}
222
223static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
224{
225	struct pca953x_chip *chip;
226	uint16_t reg_val;
227	int ret, offset = 0;
228
229	chip = container_of(gc, struct pca953x_chip, gpio_chip);
230
231	mutex_lock(&chip->i2c_lock);
232	switch (chip->chip_type) {
233	case PCA953X_TYPE:
234		offset = PCA953X_INPUT;
235		break;
236	case PCA957X_TYPE:
237		offset = PCA957X_IN;
238		break;
239	}
240	ret = pca953x_read_reg(chip, offset, &reg_val);
241	mutex_unlock(&chip->i2c_lock);
242	if (ret < 0) {
243		/* NOTE:  diagnostic already emitted; that's all we should
244		 * do unless gpio_*_value_cansleep() calls become different
245		 * from their nonsleeping siblings (and report faults).
246		 */
247		return 0;
248	}
249
250	return (reg_val & (1u << off)) ? 1 : 0;
251}
252
253static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
254{
255	struct pca953x_chip *chip;
256	uint16_t reg_val;
257	int ret, offset = 0;
258
259	chip = container_of(gc, struct pca953x_chip, gpio_chip);
 
 
 
 
 
 
 
 
 
 
 
260
261	mutex_lock(&chip->i2c_lock);
262	if (val)
263		reg_val = chip->reg_output | (1u << off);
264	else
265		reg_val = chip->reg_output & ~(1u << off);
266
267	switch (chip->chip_type) {
268	case PCA953X_TYPE:
269		offset = PCA953X_OUTPUT;
270		break;
271	case PCA957X_TYPE:
272		offset = PCA957X_OUT;
273		break;
274	}
275	ret = pca953x_write_reg(chip, offset, reg_val);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
276	if (ret)
277		goto exit;
278
279	chip->reg_output = reg_val;
 
 
 
 
 
280exit:
281	mutex_unlock(&chip->i2c_lock);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
282}
283
284static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
285{
286	struct gpio_chip *gc;
287
288	gc = &chip->gpio_chip;
289
290	gc->direction_input  = pca953x_gpio_direction_input;
291	gc->direction_output = pca953x_gpio_direction_output;
292	gc->get = pca953x_gpio_get_value;
293	gc->set = pca953x_gpio_set_value;
294	gc->can_sleep = 1;
 
 
 
 
295
296	gc->base = chip->gpio_start;
297	gc->ngpio = gpios;
298	gc->label = chip->client->name;
299	gc->dev = &chip->client->dev;
300	gc->owner = THIS_MODULE;
301	gc->names = chip->names;
302}
303
304#ifdef CONFIG_GPIO_PCA953X_IRQ
305static int pca953x_gpio_to_irq(struct gpio_chip *gc, unsigned off)
306{
307	struct pca953x_chip *chip;
 
 
308
309	chip = container_of(gc, struct pca953x_chip, gpio_chip);
310	return chip->irq_base + off;
311}
312
313static void pca953x_irq_mask(struct irq_data *d)
314{
315	struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
 
 
316
317	chip->irq_mask &= ~(1 << (d->irq - chip->irq_base));
318}
319
320static void pca953x_irq_unmask(struct irq_data *d)
321{
322	struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
 
 
 
 
 
 
323
324	chip->irq_mask |= 1 << (d->irq - chip->irq_base);
325}
326
327static void pca953x_irq_bus_lock(struct irq_data *d)
328{
329	struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
 
330
331	mutex_lock(&chip->irq_lock);
332}
333
334static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
335{
336	struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
337	uint16_t new_irqs;
338	uint16_t level;
 
 
 
 
 
 
339
340	/* Look for any newly setup interrupt */
341	new_irqs = chip->irq_trig_fall | chip->irq_trig_raise;
342	new_irqs &= ~chip->reg_direction;
343
344	while (new_irqs) {
345		level = __ffs(new_irqs);
346		pca953x_gpio_direction_input(&chip->gpio_chip, level);
347		new_irqs &= ~(1 << level);
348	}
349
 
 
 
 
 
 
 
 
 
 
 
350	mutex_unlock(&chip->irq_lock);
351}
352
353static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
354{
355	struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
356	uint16_t level = d->irq - chip->irq_base;
357	uint16_t mask = 1 << level;
358
359	if (!(type & IRQ_TYPE_EDGE_BOTH)) {
360		dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
361			d->irq, type);
362		return -EINVAL;
363	}
364
365	if (type & IRQ_TYPE_EDGE_FALLING)
366		chip->irq_trig_fall |= mask;
367	else
368		chip->irq_trig_fall &= ~mask;
369
370	if (type & IRQ_TYPE_EDGE_RISING)
371		chip->irq_trig_raise |= mask;
372	else
373		chip->irq_trig_raise &= ~mask;
374
375	return 0;
376}
377
378static struct irq_chip pca953x_irq_chip = {
379	.name			= "pca953x",
380	.irq_mask		= pca953x_irq_mask,
381	.irq_unmask		= pca953x_irq_unmask,
382	.irq_bus_lock		= pca953x_irq_bus_lock,
383	.irq_bus_sync_unlock	= pca953x_irq_bus_sync_unlock,
384	.irq_set_type		= pca953x_irq_set_type,
385};
 
386
387static uint16_t pca953x_irq_pending(struct pca953x_chip *chip)
388{
389	uint16_t cur_stat;
390	uint16_t old_stat;
391	uint16_t pending;
392	uint16_t trigger;
393	int ret, offset = 0;
 
 
394
395	switch (chip->chip_type) {
396	case PCA953X_TYPE:
397		offset = PCA953X_INPUT;
398		break;
399	case PCA957X_TYPE:
400		offset = PCA957X_IN;
401		break;
 
 
 
 
 
 
 
 
 
 
402	}
403	ret = pca953x_read_reg(chip, offset, &cur_stat);
 
404	if (ret)
405		return 0;
406
407	/* Remove output pins from the equation */
408	cur_stat &= chip->reg_direction;
409
410	old_stat = chip->irq_stat;
411	trigger = (cur_stat ^ old_stat) & chip->irq_mask;
412
413	if (!trigger)
414		return 0;
 
 
 
 
415
416	chip->irq_stat = cur_stat;
417
418	pending = (old_stat & chip->irq_trig_fall) |
419		  (cur_stat & chip->irq_trig_raise);
420	pending &= trigger;
 
421
422	return pending;
423}
424
425static irqreturn_t pca953x_irq_handler(int irq, void *devid)
426{
427	struct pca953x_chip *chip = devid;
428	uint16_t pending;
429	uint16_t level;
 
 
 
 
 
 
 
 
430
431	pending = pca953x_irq_pending(chip);
 
432
433	if (!pending)
434		return IRQ_HANDLED;
435
436	do {
437		level = __ffs(pending);
438		handle_nested_irq(level + chip->irq_base);
 
439
440		pending &= ~(1 << level);
441	} while (pending);
 
 
442
443	return IRQ_HANDLED;
444}
445
446static int pca953x_irq_setup(struct pca953x_chip *chip,
447			     const struct i2c_device_id *id,
448			     int irq_base)
449{
450	struct i2c_client *client = chip->client;
451	int ret, offset = 0;
 
 
 
 
452
453	if (irq_base != -1
454			&& (id->driver_data & PCA_INT)) {
455		int lvl;
456
457		switch (chip->chip_type) {
458		case PCA953X_TYPE:
459			offset = PCA953X_INPUT;
460			break;
461		case PCA957X_TYPE:
462			offset = PCA957X_IN;
463			break;
464		}
465		ret = pca953x_read_reg(chip, offset, &chip->irq_stat);
466		if (ret)
467			goto out_failed;
468
469		/*
470		 * There is no way to know which GPIO line generated the
471		 * interrupt.  We have to rely on the previous read for
472		 * this purpose.
473		 */
474		chip->irq_stat &= chip->reg_direction;
475		mutex_init(&chip->irq_lock);
476
477		chip->irq_base = irq_alloc_descs(-1, irq_base, chip->gpio_chip.ngpio, -1);
478		if (chip->irq_base < 0)
479			goto out_failed;
480
481		for (lvl = 0; lvl < chip->gpio_chip.ngpio; lvl++) {
482			int irq = lvl + chip->irq_base;
483
484			irq_clear_status_flags(irq, IRQ_NOREQUEST);
485			irq_set_chip_data(irq, chip);
486			irq_set_chip(irq, &pca953x_irq_chip);
487			irq_set_nested_thread(irq, true);
488#ifdef CONFIG_ARM
489			set_irq_flags(irq, IRQF_VALID);
490#else
491			irq_set_noprobe(irq);
492#endif
493		}
494
495		ret = request_threaded_irq(client->irq,
496					   NULL,
497					   pca953x_irq_handler,
498					   IRQF_TRIGGER_LOW | IRQF_ONESHOT,
499					   dev_name(&client->dev), chip);
500		if (ret) {
501			dev_err(&client->dev, "failed to request irq %d\n",
502				client->irq);
503			goto out_failed;
504		}
505
506		chip->gpio_chip.to_irq = pca953x_gpio_to_irq;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
507	}
508
509	return 0;
510
511out_failed:
512	chip->irq_base = -1;
513	return ret;
514}
515
516static void pca953x_irq_teardown(struct pca953x_chip *chip)
517{
518	if (chip->irq_base != -1) {
519		irq_free_descs(chip->irq_base, chip->gpio_chip.ngpio);
520		free_irq(chip->client->irq, chip);
521	}
522}
523#else /* CONFIG_GPIO_PCA953X_IRQ */
524static int pca953x_irq_setup(struct pca953x_chip *chip,
525			     const struct i2c_device_id *id,
526			     int irq_base)
527{
528	struct i2c_client *client = chip->client;
529
530	if (irq_base != -1 && (id->driver_data & PCA_INT))
531		dev_warn(&client->dev, "interrupt support not compiled in\n");
532
533	return 0;
534}
535
536static void pca953x_irq_teardown(struct pca953x_chip *chip)
537{
538}
539#endif
540
541/*
542 * Handlers for alternative sources of platform_data
543 */
544#ifdef CONFIG_OF_GPIO
545/*
546 * Translate OpenFirmware node properties into platform_data
547 * WARNING: This is DEPRECATED and will be removed eventually!
548 */
549void
550pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, int *invert)
551{
552	struct device_node *node;
553	const __be32 *val;
554	int size;
555
556	node = client->dev.of_node;
557	if (node == NULL)
558		return;
559
560	*gpio_base = -1;
561	val = of_get_property(node, "linux,gpio-base", &size);
562	WARN(val, "%s: device-tree property 'linux,gpio-base' is deprecated!", __func__);
563	if (val) {
564		if (size != sizeof(*val))
565			dev_warn(&client->dev, "%s: wrong linux,gpio-base\n",
566				 node->full_name);
567		else
568			*gpio_base = be32_to_cpup(val);
569	}
570
571	val = of_get_property(node, "polarity", NULL);
572	WARN(val, "%s: device-tree property 'polarity' is deprecated!", __func__);
573	if (val)
574		*invert = *val;
575}
576#else
577void
578pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, int *invert)
579{
580	*gpio_base = -1;
581}
582#endif
583
584static int __devinit device_pca953x_init(struct pca953x_chip *chip, int invert)
585{
 
586	int ret;
587
588	ret = pca953x_read_reg(chip, PCA953X_OUTPUT, &chip->reg_output);
 
589	if (ret)
590		goto out;
591
592	ret = pca953x_read_reg(chip, PCA953X_DIRECTION,
593			       &chip->reg_direction);
594	if (ret)
595		goto out;
596
597	/* set platform specific polarity inversion */
598	ret = pca953x_write_reg(chip, PCA953X_INVERT, invert);
599	if (ret)
600		goto out;
601	return 0;
 
 
602out:
603	return ret;
604}
605
606static int __devinit device_pca957x_init(struct pca953x_chip *chip, int invert)
607{
 
 
608	int ret;
609	uint16_t val = 0;
610
611	/* Let every port in proper state, that could save power */
612	pca953x_write_reg(chip, PCA957X_PUPD, 0x0);
613	pca953x_write_reg(chip, PCA957X_CFG, 0xffff);
614	pca953x_write_reg(chip, PCA957X_OUT, 0x0);
615
616	ret = pca953x_read_reg(chip, PCA957X_IN, &val);
617	if (ret)
618		goto out;
619	ret = pca953x_read_reg(chip, PCA957X_OUT, &chip->reg_output);
620	if (ret)
621		goto out;
622	ret = pca953x_read_reg(chip, PCA957X_CFG, &chip->reg_direction);
623	if (ret)
624		goto out;
625
626	/* set platform specific polarity inversion */
627	pca953x_write_reg(chip, PCA957X_INVRT, invert);
 
628
629	/* To enable register 6, 7 to controll pull up and pull down */
630	pca953x_write_reg(chip, PCA957X_BKEN, 0x202);
 
631
632	return 0;
633out:
634	return ret;
635}
636
637static int __devinit pca953x_probe(struct i2c_client *client,
638				   const struct i2c_device_id *id)
639{
640	struct pca953x_platform_data *pdata;
641	struct pca953x_chip *chip;
642	int irq_base=0, invert=0;
643	int ret = 0;
 
 
 
644
645	chip = kzalloc(sizeof(struct pca953x_chip), GFP_KERNEL);
646	if (chip == NULL)
647		return -ENOMEM;
648
649	pdata = client->dev.platform_data;
650	if (pdata) {
651		irq_base = pdata->irq_base;
652		chip->gpio_start = pdata->gpio_base;
653		invert = pdata->invert;
654		chip->names = pdata->names;
655	} else {
656		pca953x_get_alt_pdata(client, &chip->gpio_start, &invert);
657#ifdef CONFIG_OF_GPIO
658		/* If I2C node has no interrupts property, disable GPIO interrupts */
659		if (of_find_property(client->dev.of_node, "interrupts", NULL) == NULL)
660			irq_base = -1;
661#endif
 
 
 
 
 
 
 
 
 
 
662	}
663
664	chip->client = client;
665
666	chip->chip_type = id->driver_data & (PCA953X_TYPE | PCA957X_TYPE);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
667
668	mutex_init(&chip->i2c_lock);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
669
670	/* initialize cached registers from their original values.
671	 * we can't share this chip with another i2c master.
672	 */
673	pca953x_setup_gpio(chip, id->driver_data & PCA_GPIO_MASK);
674
675	if (chip->chip_type == PCA953X_TYPE)
676		device_pca953x_init(chip, invert);
677	else if (chip->chip_type == PCA957X_TYPE)
678		device_pca957x_init(chip, invert);
679	else
680		goto out_failed;
 
 
 
681
682	ret = pca953x_irq_setup(chip, id, irq_base);
683	if (ret)
684		goto out_failed;
685
686	ret = gpiochip_add(&chip->gpio_chip);
687	if (ret)
688		goto out_failed_irq;
689
690	if (pdata && pdata->setup) {
691		ret = pdata->setup(client, chip->gpio_chip.base,
692				chip->gpio_chip.ngpio, pdata->context);
693		if (ret < 0)
694			dev_warn(&client->dev, "setup failed, %d\n", ret);
695	}
696
697	i2c_set_clientdata(client, chip);
698	return 0;
699
700out_failed_irq:
701	pca953x_irq_teardown(chip);
702out_failed:
703	kfree(chip);
704	return ret;
705}
706
707static int pca953x_remove(struct i2c_client *client)
708{
709	struct pca953x_platform_data *pdata = client->dev.platform_data;
710	struct pca953x_chip *chip = i2c_get_clientdata(client);
711	int ret = 0;
712
713	if (pdata && pdata->teardown) {
714		ret = pdata->teardown(client, chip->gpio_chip.base,
715				chip->gpio_chip.ngpio, pdata->context);
716		if (ret < 0) {
717			dev_err(&client->dev, "%s failed, %d\n",
718					"teardown", ret);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
719			return ret;
720		}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
721	}
722
723	ret = gpiochip_remove(&chip->gpio_chip);
 
 
 
 
 
 
724	if (ret) {
725		dev_err(&client->dev, "%s failed, %d\n",
726				"gpiochip_remove()", ret);
727		return ret;
728	}
729
730	pca953x_irq_teardown(chip);
731	kfree(chip);
732	return 0;
733}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
734
735static struct i2c_driver pca953x_driver = {
736	.driver = {
737		.name	= "pca953x",
 
 
 
738	},
739	.probe		= pca953x_probe,
740	.remove		= pca953x_remove,
741	.id_table	= pca953x_id,
742};
743
744static int __init pca953x_init(void)
745{
746	return i2c_add_driver(&pca953x_driver);
747}
748/* register after i2c postcore initcall and before
749 * subsys initcalls that may rely on these GPIOs
750 */
751subsys_initcall(pca953x_init);
752
753static void __exit pca953x_exit(void)
754{
755	i2c_del_driver(&pca953x_driver);
756}
757module_exit(pca953x_exit);
758
759MODULE_AUTHOR("eric miao <eric.miao@marvell.com>");
760MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
761MODULE_LICENSE("GPL");
v5.14.15
   1// SPDX-License-Identifier: GPL-2.0-only
   2/*
   3 *  PCA953x 4/8/16/24/40 bit I/O ports
   4 *
   5 *  Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
   6 *  Copyright (C) 2007 Marvell International Ltd.
   7 *
   8 *  Derived from drivers/i2c/chips/pca9539.c
 
 
 
 
   9 */
  10
  11#include <linux/acpi.h>
  12#include <linux/bitmap.h>
  13#include <linux/gpio/driver.h>
  14#include <linux/gpio/consumer.h>
  15#include <linux/i2c.h>
  16#include <linux/init.h>
 
  17#include <linux/interrupt.h>
  18#include <linux/module.h>
 
 
 
 
  19#include <linux/of_platform.h>
  20#include <linux/platform_data/pca953x.h>
  21#include <linux/regmap.h>
  22#include <linux/regulator/consumer.h>
  23#include <linux/slab.h>
  24
  25#include <asm/unaligned.h>
  26
  27#define PCA953X_INPUT		0x00
  28#define PCA953X_OUTPUT		0x01
  29#define PCA953X_INVERT		0x02
  30#define PCA953X_DIRECTION	0x03
  31
  32#define REG_ADDR_MASK		GENMASK(5, 0)
  33#define REG_ADDR_EXT		BIT(6)
  34#define REG_ADDR_AI		BIT(7)
  35
  36#define PCA957X_IN		0x00
  37#define PCA957X_INVRT		0x01
  38#define PCA957X_BKEN		0x02
  39#define PCA957X_PUPD		0x03
  40#define PCA957X_CFG		0x04
  41#define PCA957X_OUT		0x05
  42#define PCA957X_MSK		0x06
  43#define PCA957X_INTS		0x07
  44
  45#define PCAL953X_OUT_STRENGTH	0x20
  46#define PCAL953X_IN_LATCH	0x22
  47#define PCAL953X_PULL_EN	0x23
  48#define PCAL953X_PULL_SEL	0x24
  49#define PCAL953X_INT_MASK	0x25
  50#define PCAL953X_INT_STAT	0x26
  51#define PCAL953X_OUT_CONF	0x27
  52
  53#define PCAL6524_INT_EDGE	0x28
  54#define PCAL6524_INT_CLR	0x2a
  55#define PCAL6524_IN_STATUS	0x2b
  56#define PCAL6524_OUT_INDCONF	0x2c
  57#define PCAL6524_DEBOUNCE	0x2d
  58
  59#define PCA_GPIO_MASK		GENMASK(7, 0)
  60
  61#define PCAL_GPIO_MASK		GENMASK(4, 0)
  62#define PCAL_PINCTRL_MASK	GENMASK(6, 5)
  63
  64#define PCA_INT			BIT(8)
  65#define PCA_PCAL		BIT(9)
  66#define PCA_LATCH_INT		(PCA_PCAL | PCA_INT)
  67#define PCA953X_TYPE		BIT(12)
  68#define PCA957X_TYPE		BIT(13)
  69#define PCA_TYPE_MASK		GENMASK(15, 12)
  70
  71#define PCA_CHIP_TYPE(x)	((x) & PCA_TYPE_MASK)
  72
  73static const struct i2c_device_id pca953x_id[] = {
  74	{ "pca6416", 16 | PCA953X_TYPE | PCA_INT, },
  75	{ "pca9505", 40 | PCA953X_TYPE | PCA_INT, },
  76	{ "pca9506", 40 | PCA953X_TYPE | PCA_INT, },
  77	{ "pca9534", 8  | PCA953X_TYPE | PCA_INT, },
  78	{ "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
  79	{ "pca9536", 4  | PCA953X_TYPE, },
  80	{ "pca9537", 4  | PCA953X_TYPE | PCA_INT, },
  81	{ "pca9538", 8  | PCA953X_TYPE | PCA_INT, },
  82	{ "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
  83	{ "pca9554", 8  | PCA953X_TYPE | PCA_INT, },
  84	{ "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
  85	{ "pca9556", 8  | PCA953X_TYPE, },
  86	{ "pca9557", 8  | PCA953X_TYPE, },
  87	{ "pca9574", 8  | PCA957X_TYPE | PCA_INT, },
  88	{ "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
  89	{ "pca9698", 40 | PCA953X_TYPE, },
  90
  91	{ "pcal6416", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
  92	{ "pcal6524", 24 | PCA953X_TYPE | PCA_LATCH_INT, },
  93	{ "pcal9535", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
  94	{ "pcal9554b", 8  | PCA953X_TYPE | PCA_LATCH_INT, },
  95	{ "pcal9555a", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
  96
  97	{ "max7310", 8  | PCA953X_TYPE, },
  98	{ "max7312", 16 | PCA953X_TYPE | PCA_INT, },
  99	{ "max7313", 16 | PCA953X_TYPE | PCA_INT, },
 100	{ "max7315", 8  | PCA953X_TYPE | PCA_INT, },
 101	{ "max7318", 16 | PCA953X_TYPE | PCA_INT, },
 102	{ "pca6107", 8  | PCA953X_TYPE | PCA_INT, },
 103	{ "tca6408", 8  | PCA953X_TYPE | PCA_INT, },
 104	{ "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
 105	{ "tca6424", 24 | PCA953X_TYPE | PCA_INT, },
 106	{ "tca9539", 16 | PCA953X_TYPE | PCA_INT, },
 107	{ "tca9554", 8  | PCA953X_TYPE | PCA_INT, },
 108	{ "xra1202", 8  | PCA953X_TYPE },
 109	{ }
 110};
 111MODULE_DEVICE_TABLE(i2c, pca953x_id);
 112
 113#ifdef CONFIG_GPIO_PCA953X_IRQ
 114
 115#include <linux/dmi.h>
 116
 117static const struct acpi_gpio_params pca953x_irq_gpios = { 0, 0, true };
 118
 119static const struct acpi_gpio_mapping pca953x_acpi_irq_gpios[] = {
 120	{ "irq-gpios", &pca953x_irq_gpios, 1, ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER },
 121	{ }
 122};
 123
 124static int pca953x_acpi_get_irq(struct device *dev)
 125{
 126	int ret;
 127
 128	ret = devm_acpi_dev_add_driver_gpios(dev, pca953x_acpi_irq_gpios);
 129	if (ret)
 130		dev_warn(dev, "can't add GPIO ACPI mapping\n");
 131
 132	ret = acpi_dev_gpio_irq_get_by(ACPI_COMPANION(dev), "irq-gpios", 0);
 133	if (ret < 0)
 134		return ret;
 135
 136	dev_info(dev, "ACPI interrupt quirk (IRQ %d)\n", ret);
 137	return ret;
 138}
 139
 140static const struct dmi_system_id pca953x_dmi_acpi_irq_info[] = {
 141	{
 142		/*
 143		 * On Intel Galileo Gen 2 board the IRQ pin of one of
 144		 * the I²C GPIO expanders, which has GpioInt() resource,
 145		 * is provided as an absolute number instead of being
 146		 * relative. Since first controller (gpio-sch.c) and
 147		 * second (gpio-dwapb.c) are at the fixed bases, we may
 148		 * safely refer to the number in the global space to get
 149		 * an IRQ out of it.
 150		 */
 151		.matches = {
 152			DMI_EXACT_MATCH(DMI_BOARD_NAME, "GalileoGen2"),
 153		},
 154	},
 155	{}
 156};
 157#endif
 158
 159static const struct acpi_device_id pca953x_acpi_ids[] = {
 160	{ "INT3491", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
 161	{ }
 162};
 163MODULE_DEVICE_TABLE(acpi, pca953x_acpi_ids);
 164
 165#define MAX_BANK 5
 166#define BANK_SZ 8
 167#define MAX_LINE	(MAX_BANK * BANK_SZ)
 168
 169#define NBANK(chip) DIV_ROUND_UP(chip->gpio_chip.ngpio, BANK_SZ)
 170
 171struct pca953x_reg_config {
 172	int direction;
 173	int output;
 174	int input;
 175	int invert;
 176};
 177
 178static const struct pca953x_reg_config pca953x_regs = {
 179	.direction = PCA953X_DIRECTION,
 180	.output = PCA953X_OUTPUT,
 181	.input = PCA953X_INPUT,
 182	.invert = PCA953X_INVERT,
 183};
 184
 185static const struct pca953x_reg_config pca957x_regs = {
 186	.direction = PCA957X_CFG,
 187	.output = PCA957X_OUT,
 188	.input = PCA957X_IN,
 189	.invert = PCA957X_INVRT,
 190};
 191
 192struct pca953x_chip {
 193	unsigned gpio_start;
 
 
 194	struct mutex i2c_lock;
 195	struct regmap *regmap;
 196
 197#ifdef CONFIG_GPIO_PCA953X_IRQ
 198	struct mutex irq_lock;
 199	DECLARE_BITMAP(irq_mask, MAX_LINE);
 200	DECLARE_BITMAP(irq_stat, MAX_LINE);
 201	DECLARE_BITMAP(irq_trig_raise, MAX_LINE);
 202	DECLARE_BITMAP(irq_trig_fall, MAX_LINE);
 203	struct irq_chip irq_chip;
 204#endif
 205	atomic_t wakeup_path;
 206
 207	struct i2c_client *client;
 208	struct gpio_chip gpio_chip;
 209	const char *const *names;
 210	unsigned long driver_data;
 211	struct regulator *regulator;
 212
 213	const struct pca953x_reg_config *regs;
 214};
 215
 216static int pca953x_bank_shift(struct pca953x_chip *chip)
 217{
 218	return fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
 219}
 220
 221#define PCA953x_BANK_INPUT	BIT(0)
 222#define PCA953x_BANK_OUTPUT	BIT(1)
 223#define PCA953x_BANK_POLARITY	BIT(2)
 224#define PCA953x_BANK_CONFIG	BIT(3)
 225
 226#define PCA957x_BANK_INPUT	BIT(0)
 227#define PCA957x_BANK_POLARITY	BIT(1)
 228#define PCA957x_BANK_BUSHOLD	BIT(2)
 229#define PCA957x_BANK_CONFIG	BIT(4)
 230#define PCA957x_BANK_OUTPUT	BIT(5)
 231
 232#define PCAL9xxx_BANK_IN_LATCH	BIT(8 + 2)
 233#define PCAL9xxx_BANK_PULL_EN	BIT(8 + 3)
 234#define PCAL9xxx_BANK_PULL_SEL	BIT(8 + 4)
 235#define PCAL9xxx_BANK_IRQ_MASK	BIT(8 + 5)
 236#define PCAL9xxx_BANK_IRQ_STAT	BIT(8 + 6)
 237
 238/*
 239 * We care about the following registers:
 240 * - Standard set, below 0x40, each port can be replicated up to 8 times
 241 *   - PCA953x standard
 242 *     Input port			0x00 + 0 * bank_size	R
 243 *     Output port			0x00 + 1 * bank_size	RW
 244 *     Polarity Inversion port		0x00 + 2 * bank_size	RW
 245 *     Configuration port		0x00 + 3 * bank_size	RW
 246 *   - PCA957x with mixed up registers
 247 *     Input port			0x00 + 0 * bank_size	R
 248 *     Polarity Inversion port		0x00 + 1 * bank_size	RW
 249 *     Bus hold port			0x00 + 2 * bank_size	RW
 250 *     Configuration port		0x00 + 4 * bank_size	RW
 251 *     Output port			0x00 + 5 * bank_size	RW
 252 *
 253 * - Extended set, above 0x40, often chip specific.
 254 *   - PCAL6524/PCAL9555A with custom PCAL IRQ handling:
 255 *     Input latch register		0x40 + 2 * bank_size	RW
 256 *     Pull-up/pull-down enable reg	0x40 + 3 * bank_size    RW
 257 *     Pull-up/pull-down select reg	0x40 + 4 * bank_size    RW
 258 *     Interrupt mask register		0x40 + 5 * bank_size	RW
 259 *     Interrupt status register	0x40 + 6 * bank_size	R
 260 *
 261 * - Registers with bit 0x80 set, the AI bit
 262 *   The bit is cleared and the registers fall into one of the
 263 *   categories above.
 264 */
 265
 266static bool pca953x_check_register(struct pca953x_chip *chip, unsigned int reg,
 267				   u32 checkbank)
 268{
 269	int bank_shift = pca953x_bank_shift(chip);
 270	int bank = (reg & REG_ADDR_MASK) >> bank_shift;
 271	int offset = reg & (BIT(bank_shift) - 1);
 272
 273	/* Special PCAL extended register check. */
 274	if (reg & REG_ADDR_EXT) {
 275		if (!(chip->driver_data & PCA_PCAL))
 276			return false;
 277		bank += 8;
 278	}
 279
 280	/* Register is not in the matching bank. */
 281	if (!(BIT(bank) & checkbank))
 282		return false;
 283
 284	/* Register is not within allowed range of bank. */
 285	if (offset >= NBANK(chip))
 286		return false;
 287
 288	return true;
 289}
 290
 291static bool pca953x_readable_register(struct device *dev, unsigned int reg)
 292{
 293	struct pca953x_chip *chip = dev_get_drvdata(dev);
 294	u32 bank;
 295
 296	if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE) {
 297		bank = PCA953x_BANK_INPUT | PCA953x_BANK_OUTPUT |
 298		       PCA953x_BANK_POLARITY | PCA953x_BANK_CONFIG;
 299	} else {
 300		bank = PCA957x_BANK_INPUT | PCA957x_BANK_OUTPUT |
 301		       PCA957x_BANK_POLARITY | PCA957x_BANK_CONFIG |
 302		       PCA957x_BANK_BUSHOLD;
 303	}
 304
 305	if (chip->driver_data & PCA_PCAL) {
 306		bank |= PCAL9xxx_BANK_IN_LATCH | PCAL9xxx_BANK_PULL_EN |
 307			PCAL9xxx_BANK_PULL_SEL | PCAL9xxx_BANK_IRQ_MASK |
 308			PCAL9xxx_BANK_IRQ_STAT;
 309	}
 310
 311	return pca953x_check_register(chip, reg, bank);
 312}
 313
 314static bool pca953x_writeable_register(struct device *dev, unsigned int reg)
 315{
 316	struct pca953x_chip *chip = dev_get_drvdata(dev);
 317	u32 bank;
 318
 319	if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE) {
 320		bank = PCA953x_BANK_OUTPUT | PCA953x_BANK_POLARITY |
 321			PCA953x_BANK_CONFIG;
 322	} else {
 323		bank = PCA957x_BANK_OUTPUT | PCA957x_BANK_POLARITY |
 324			PCA957x_BANK_CONFIG | PCA957x_BANK_BUSHOLD;
 325	}
 326
 327	if (chip->driver_data & PCA_PCAL)
 328		bank |= PCAL9xxx_BANK_IN_LATCH | PCAL9xxx_BANK_PULL_EN |
 329			PCAL9xxx_BANK_PULL_SEL | PCAL9xxx_BANK_IRQ_MASK;
 330
 331	return pca953x_check_register(chip, reg, bank);
 332}
 333
 334static bool pca953x_volatile_register(struct device *dev, unsigned int reg)
 335{
 336	struct pca953x_chip *chip = dev_get_drvdata(dev);
 337	u32 bank;
 338
 339	if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE)
 340		bank = PCA953x_BANK_INPUT;
 341	else
 342		bank = PCA957x_BANK_INPUT;
 343
 344	if (chip->driver_data & PCA_PCAL)
 345		bank |= PCAL9xxx_BANK_IRQ_STAT;
 346
 347	return pca953x_check_register(chip, reg, bank);
 348}
 349
 350static const struct regmap_config pca953x_i2c_regmap = {
 351	.reg_bits = 8,
 352	.val_bits = 8,
 353
 354	.readable_reg = pca953x_readable_register,
 355	.writeable_reg = pca953x_writeable_register,
 356	.volatile_reg = pca953x_volatile_register,
 357
 358	.disable_locking = true,
 359	.cache_type = REGCACHE_RBTREE,
 360	.max_register = 0x7f,
 361};
 362
 363static const struct regmap_config pca953x_ai_i2c_regmap = {
 364	.reg_bits = 8,
 365	.val_bits = 8,
 366
 367	.read_flag_mask = REG_ADDR_AI,
 368	.write_flag_mask = REG_ADDR_AI,
 369
 370	.readable_reg = pca953x_readable_register,
 371	.writeable_reg = pca953x_writeable_register,
 372	.volatile_reg = pca953x_volatile_register,
 373
 374	.disable_locking = true,
 375	.cache_type = REGCACHE_RBTREE,
 376	.max_register = 0x7f,
 377};
 378
 379static u8 pca953x_recalc_addr(struct pca953x_chip *chip, int reg, int off)
 380{
 381	int bank_shift = pca953x_bank_shift(chip);
 382	int addr = (reg & PCAL_GPIO_MASK) << bank_shift;
 383	int pinctrl = (reg & PCAL_PINCTRL_MASK) << 1;
 384	u8 regaddr = pinctrl | addr | (off / BANK_SZ);
 385
 386	return regaddr;
 387}
 388
 389static int pca953x_write_regs(struct pca953x_chip *chip, int reg, unsigned long *val)
 390{
 391	u8 regaddr = pca953x_recalc_addr(chip, reg, 0);
 392	u8 value[MAX_BANK];
 393	int i, ret;
 394
 395	for (i = 0; i < NBANK(chip); i++)
 396		value[i] = bitmap_get_value8(val, i * BANK_SZ);
 397
 398	ret = regmap_bulk_write(chip->regmap, regaddr, value, NBANK(chip));
 399	if (ret < 0) {
 400		dev_err(&chip->client->dev, "failed writing register\n");
 401		return ret;
 402	}
 403
 404	return 0;
 405}
 406
 407static int pca953x_read_regs(struct pca953x_chip *chip, int reg, unsigned long *val)
 408{
 409	u8 regaddr = pca953x_recalc_addr(chip, reg, 0);
 410	u8 value[MAX_BANK];
 411	int i, ret;
 
 
 
 412
 413	ret = regmap_bulk_read(chip->regmap, regaddr, value, NBANK(chip));
 414	if (ret < 0) {
 415		dev_err(&chip->client->dev, "failed reading register\n");
 416		return ret;
 417	}
 418
 419	for (i = 0; i < NBANK(chip); i++)
 420		bitmap_set_value8(val, value[i], i * BANK_SZ);
 421
 422	return 0;
 423}
 424
 425static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
 426{
 427	struct pca953x_chip *chip = gpiochip_get_data(gc);
 428	u8 dirreg = pca953x_recalc_addr(chip, chip->regs->direction, off);
 429	u8 bit = BIT(off % BANK_SZ);
 430	int ret;
 
 431
 432	mutex_lock(&chip->i2c_lock);
 433	ret = regmap_write_bits(chip->regmap, dirreg, bit, bit);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 434	mutex_unlock(&chip->i2c_lock);
 435	return ret;
 436}
 437
 438static int pca953x_gpio_direction_output(struct gpio_chip *gc,
 439		unsigned off, int val)
 440{
 441	struct pca953x_chip *chip = gpiochip_get_data(gc);
 442	u8 dirreg = pca953x_recalc_addr(chip, chip->regs->direction, off);
 443	u8 outreg = pca953x_recalc_addr(chip, chip->regs->output, off);
 444	u8 bit = BIT(off % BANK_SZ);
 445	int ret;
 446
 447	mutex_lock(&chip->i2c_lock);
 448	/* set output level */
 449	ret = regmap_write_bits(chip->regmap, outreg, bit, val ? bit : 0);
 
 
 
 
 
 
 
 
 
 
 
 
 
 450	if (ret)
 451		goto exit;
 452
 
 
 453	/* then direction */
 454	ret = regmap_write_bits(chip->regmap, dirreg, bit, 0);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 455exit:
 456	mutex_unlock(&chip->i2c_lock);
 457	return ret;
 458}
 459
 460static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
 461{
 462	struct pca953x_chip *chip = gpiochip_get_data(gc);
 463	u8 inreg = pca953x_recalc_addr(chip, chip->regs->input, off);
 464	u8 bit = BIT(off % BANK_SZ);
 465	u32 reg_val;
 466	int ret;
 467
 468	mutex_lock(&chip->i2c_lock);
 469	ret = regmap_read(chip->regmap, inreg, &reg_val);
 
 
 
 
 
 
 
 
 470	mutex_unlock(&chip->i2c_lock);
 471	if (ret < 0)
 472		return ret;
 
 
 
 
 
 473
 474	return !!(reg_val & bit);
 475}
 476
 477static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
 478{
 479	struct pca953x_chip *chip = gpiochip_get_data(gc);
 480	u8 outreg = pca953x_recalc_addr(chip, chip->regs->output, off);
 481	u8 bit = BIT(off % BANK_SZ);
 482
 483	mutex_lock(&chip->i2c_lock);
 484	regmap_write_bits(chip->regmap, outreg, bit, val ? bit : 0);
 485	mutex_unlock(&chip->i2c_lock);
 486}
 487
 488static int pca953x_gpio_get_direction(struct gpio_chip *gc, unsigned off)
 489{
 490	struct pca953x_chip *chip = gpiochip_get_data(gc);
 491	u8 dirreg = pca953x_recalc_addr(chip, chip->regs->direction, off);
 492	u8 bit = BIT(off % BANK_SZ);
 493	u32 reg_val;
 494	int ret;
 495
 496	mutex_lock(&chip->i2c_lock);
 497	ret = regmap_read(chip->regmap, dirreg, &reg_val);
 498	mutex_unlock(&chip->i2c_lock);
 499	if (ret < 0)
 500		return ret;
 501
 502	if (reg_val & bit)
 503		return GPIO_LINE_DIRECTION_IN;
 504
 505	return GPIO_LINE_DIRECTION_OUT;
 506}
 507
 508static int pca953x_gpio_get_multiple(struct gpio_chip *gc,
 509				     unsigned long *mask, unsigned long *bits)
 510{
 511	struct pca953x_chip *chip = gpiochip_get_data(gc);
 512	DECLARE_BITMAP(reg_val, MAX_LINE);
 513	int ret;
 514
 515	mutex_lock(&chip->i2c_lock);
 516	ret = pca953x_read_regs(chip, chip->regs->input, reg_val);
 517	mutex_unlock(&chip->i2c_lock);
 518	if (ret)
 519		return ret;
 520
 521	bitmap_replace(bits, bits, reg_val, mask, gc->ngpio);
 522	return 0;
 523}
 524
 525static void pca953x_gpio_set_multiple(struct gpio_chip *gc,
 526				      unsigned long *mask, unsigned long *bits)
 527{
 528	struct pca953x_chip *chip = gpiochip_get_data(gc);
 529	DECLARE_BITMAP(reg_val, MAX_LINE);
 530	int ret;
 531
 532	mutex_lock(&chip->i2c_lock);
 533	ret = pca953x_read_regs(chip, chip->regs->output, reg_val);
 534	if (ret)
 535		goto exit;
 536
 537	bitmap_replace(reg_val, reg_val, bits, mask, gc->ngpio);
 538
 539	pca953x_write_regs(chip, chip->regs->output, reg_val);
 540exit:
 541	mutex_unlock(&chip->i2c_lock);
 542}
 543
 544static int pca953x_gpio_set_pull_up_down(struct pca953x_chip *chip,
 545					 unsigned int offset,
 546					 unsigned long config)
 547{
 548	u8 pull_en_reg = pca953x_recalc_addr(chip, PCAL953X_PULL_EN, offset);
 549	u8 pull_sel_reg = pca953x_recalc_addr(chip, PCAL953X_PULL_SEL, offset);
 550	u8 bit = BIT(offset % BANK_SZ);
 551	int ret;
 552
 553	/*
 554	 * pull-up/pull-down configuration requires PCAL extended
 555	 * registers
 556	 */
 557	if (!(chip->driver_data & PCA_PCAL))
 558		return -ENOTSUPP;
 559
 560	mutex_lock(&chip->i2c_lock);
 561
 562	/* Configure pull-up/pull-down */
 563	if (config == PIN_CONFIG_BIAS_PULL_UP)
 564		ret = regmap_write_bits(chip->regmap, pull_sel_reg, bit, bit);
 565	else if (config == PIN_CONFIG_BIAS_PULL_DOWN)
 566		ret = regmap_write_bits(chip->regmap, pull_sel_reg, bit, 0);
 567	else
 568		ret = 0;
 569	if (ret)
 570		goto exit;
 571
 572	/* Disable/Enable pull-up/pull-down */
 573	if (config == PIN_CONFIG_BIAS_DISABLE)
 574		ret = regmap_write_bits(chip->regmap, pull_en_reg, bit, 0);
 575	else
 576		ret = regmap_write_bits(chip->regmap, pull_en_reg, bit, bit);
 577
 578exit:
 579	mutex_unlock(&chip->i2c_lock);
 580	return ret;
 581}
 582
 583static int pca953x_gpio_set_config(struct gpio_chip *gc, unsigned int offset,
 584				   unsigned long config)
 585{
 586	struct pca953x_chip *chip = gpiochip_get_data(gc);
 587
 588	switch (pinconf_to_config_param(config)) {
 589	case PIN_CONFIG_BIAS_PULL_UP:
 590	case PIN_CONFIG_BIAS_PULL_PIN_DEFAULT:
 591	case PIN_CONFIG_BIAS_PULL_DOWN:
 592	case PIN_CONFIG_BIAS_DISABLE:
 593		return pca953x_gpio_set_pull_up_down(chip, offset, config);
 594	default:
 595		return -ENOTSUPP;
 596	}
 597}
 598
 599static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
 600{
 601	struct gpio_chip *gc;
 602
 603	gc = &chip->gpio_chip;
 604
 605	gc->direction_input  = pca953x_gpio_direction_input;
 606	gc->direction_output = pca953x_gpio_direction_output;
 607	gc->get = pca953x_gpio_get_value;
 608	gc->set = pca953x_gpio_set_value;
 609	gc->get_direction = pca953x_gpio_get_direction;
 610	gc->get_multiple = pca953x_gpio_get_multiple;
 611	gc->set_multiple = pca953x_gpio_set_multiple;
 612	gc->set_config = pca953x_gpio_set_config;
 613	gc->can_sleep = true;
 614
 615	gc->base = chip->gpio_start;
 616	gc->ngpio = gpios;
 617	gc->label = dev_name(&chip->client->dev);
 618	gc->parent = &chip->client->dev;
 619	gc->owner = THIS_MODULE;
 620	gc->names = chip->names;
 621}
 622
 623#ifdef CONFIG_GPIO_PCA953X_IRQ
 624static void pca953x_irq_mask(struct irq_data *d)
 625{
 626	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 627	struct pca953x_chip *chip = gpiochip_get_data(gc);
 628	irq_hw_number_t hwirq = irqd_to_hwirq(d);
 629
 630	clear_bit(hwirq, chip->irq_mask);
 
 631}
 632
 633static void pca953x_irq_unmask(struct irq_data *d)
 634{
 635	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 636	struct pca953x_chip *chip = gpiochip_get_data(gc);
 637	irq_hw_number_t hwirq = irqd_to_hwirq(d);
 638
 639	set_bit(hwirq, chip->irq_mask);
 640}
 641
 642static int pca953x_irq_set_wake(struct irq_data *d, unsigned int on)
 643{
 644	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 645	struct pca953x_chip *chip = gpiochip_get_data(gc);
 646
 647	if (on)
 648		atomic_inc(&chip->wakeup_path);
 649	else
 650		atomic_dec(&chip->wakeup_path);
 651
 652	return irq_set_irq_wake(chip->client->irq, on);
 653}
 654
 655static void pca953x_irq_bus_lock(struct irq_data *d)
 656{
 657	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 658	struct pca953x_chip *chip = gpiochip_get_data(gc);
 659
 660	mutex_lock(&chip->irq_lock);
 661}
 662
 663static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
 664{
 665	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 666	struct pca953x_chip *chip = gpiochip_get_data(gc);
 667	DECLARE_BITMAP(irq_mask, MAX_LINE);
 668	DECLARE_BITMAP(reg_direction, MAX_LINE);
 669	int level;
 670
 671	if (chip->driver_data & PCA_PCAL) {
 672		/* Enable latch on interrupt-enabled inputs */
 673		pca953x_write_regs(chip, PCAL953X_IN_LATCH, chip->irq_mask);
 674
 675		bitmap_complement(irq_mask, chip->irq_mask, gc->ngpio);
 
 
 676
 677		/* Unmask enabled interrupts */
 678		pca953x_write_regs(chip, PCAL953X_INT_MASK, irq_mask);
 
 
 679	}
 680
 681	/* Switch direction to input if needed */
 682	pca953x_read_regs(chip, chip->regs->direction, reg_direction);
 683
 684	bitmap_or(irq_mask, chip->irq_trig_fall, chip->irq_trig_raise, gc->ngpio);
 685	bitmap_complement(reg_direction, reg_direction, gc->ngpio);
 686	bitmap_and(irq_mask, irq_mask, reg_direction, gc->ngpio);
 687
 688	/* Look for any newly setup interrupt */
 689	for_each_set_bit(level, irq_mask, gc->ngpio)
 690		pca953x_gpio_direction_input(&chip->gpio_chip, level);
 691
 692	mutex_unlock(&chip->irq_lock);
 693}
 694
 695static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
 696{
 697	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 698	struct pca953x_chip *chip = gpiochip_get_data(gc);
 699	irq_hw_number_t hwirq = irqd_to_hwirq(d);
 700
 701	if (!(type & IRQ_TYPE_EDGE_BOTH)) {
 702		dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
 703			d->irq, type);
 704		return -EINVAL;
 705	}
 706
 707	assign_bit(hwirq, chip->irq_trig_fall, type & IRQ_TYPE_EDGE_FALLING);
 708	assign_bit(hwirq, chip->irq_trig_raise, type & IRQ_TYPE_EDGE_RISING);
 
 
 
 
 
 
 
 709
 710	return 0;
 711}
 712
 713static void pca953x_irq_shutdown(struct irq_data *d)
 714{
 715	struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 716	struct pca953x_chip *chip = gpiochip_get_data(gc);
 717	irq_hw_number_t hwirq = irqd_to_hwirq(d);
 718
 719	clear_bit(hwirq, chip->irq_trig_raise);
 720	clear_bit(hwirq, chip->irq_trig_fall);
 721}
 722
 723static bool pca953x_irq_pending(struct pca953x_chip *chip, unsigned long *pending)
 724{
 725	struct gpio_chip *gc = &chip->gpio_chip;
 726	DECLARE_BITMAP(reg_direction, MAX_LINE);
 727	DECLARE_BITMAP(old_stat, MAX_LINE);
 728	DECLARE_BITMAP(cur_stat, MAX_LINE);
 729	DECLARE_BITMAP(new_stat, MAX_LINE);
 730	DECLARE_BITMAP(trigger, MAX_LINE);
 731	int ret;
 732
 733	if (chip->driver_data & PCA_PCAL) {
 734		/* Read the current interrupt status from the device */
 735		ret = pca953x_read_regs(chip, PCAL953X_INT_STAT, trigger);
 736		if (ret)
 737			return false;
 738
 739		/* Check latched inputs and clear interrupt status */
 740		ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
 741		if (ret)
 742			return false;
 743
 744		/* Apply filter for rising/falling edge selection */
 745		bitmap_replace(new_stat, chip->irq_trig_fall, chip->irq_trig_raise, cur_stat, gc->ngpio);
 746
 747		bitmap_and(pending, new_stat, trigger, gc->ngpio);
 748
 749		return !bitmap_empty(pending, gc->ngpio);
 750	}
 751
 752	ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
 753	if (ret)
 754		return false;
 755
 756	/* Remove output pins from the equation */
 757	pca953x_read_regs(chip, chip->regs->direction, reg_direction);
 758
 759	bitmap_copy(old_stat, chip->irq_stat, gc->ngpio);
 
 760
 761	bitmap_and(new_stat, cur_stat, reg_direction, gc->ngpio);
 762	bitmap_xor(cur_stat, new_stat, old_stat, gc->ngpio);
 763	bitmap_and(trigger, cur_stat, chip->irq_mask, gc->ngpio);
 764
 765	if (bitmap_empty(trigger, gc->ngpio))
 766		return false;
 767
 768	bitmap_copy(chip->irq_stat, new_stat, gc->ngpio);
 769
 770	bitmap_and(cur_stat, chip->irq_trig_fall, old_stat, gc->ngpio);
 771	bitmap_and(old_stat, chip->irq_trig_raise, new_stat, gc->ngpio);
 772	bitmap_or(new_stat, old_stat, cur_stat, gc->ngpio);
 773	bitmap_and(pending, new_stat, trigger, gc->ngpio);
 774
 775	return !bitmap_empty(pending, gc->ngpio);
 776}
 777
 778static irqreturn_t pca953x_irq_handler(int irq, void *devid)
 779{
 780	struct pca953x_chip *chip = devid;
 781	struct gpio_chip *gc = &chip->gpio_chip;
 782	DECLARE_BITMAP(pending, MAX_LINE);
 783	int level;
 784	bool ret;
 785
 786	bitmap_zero(pending, MAX_LINE);
 787
 788	mutex_lock(&chip->i2c_lock);
 789	ret = pca953x_irq_pending(chip, pending);
 790	mutex_unlock(&chip->i2c_lock);
 791
 792	if (ret) {
 793		ret = 0;
 794
 795		for_each_set_bit(level, pending, gc->ngpio) {
 796			int nested_irq = irq_find_mapping(gc->irq.domain, level);
 797
 798			if (unlikely(nested_irq <= 0)) {
 799				dev_warn_ratelimited(gc->parent, "unmapped interrupt %d\n", level);
 800				continue;
 801			}
 802
 803			handle_nested_irq(nested_irq);
 804			ret = 1;
 805		}
 806	}
 807
 808	return IRQ_RETVAL(ret);
 809}
 810
 811static int pca953x_irq_setup(struct pca953x_chip *chip, int irq_base)
 
 
 812{
 813	struct i2c_client *client = chip->client;
 814	struct irq_chip *irq_chip = &chip->irq_chip;
 815	DECLARE_BITMAP(reg_direction, MAX_LINE);
 816	DECLARE_BITMAP(irq_stat, MAX_LINE);
 817	struct gpio_irq_chip *girq;
 818	int ret;
 819
 820	if (dmi_first_match(pca953x_dmi_acpi_irq_info)) {
 821		ret = pca953x_acpi_get_irq(&client->dev);
 822		if (ret > 0)
 823			client->irq = ret;
 824	}
 
 
 
 
 
 
 
 
 
 
 825
 826	if (!client->irq)
 827		return 0;
 
 
 
 
 
 828
 829	if (irq_base == -1)
 830		return 0;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 831
 832	if (!(chip->driver_data & PCA_INT))
 833		return 0;
 834
 835	ret = pca953x_read_regs(chip, chip->regs->input, irq_stat);
 836	if (ret)
 837		return ret;
 
 
 
 
 838
 839	/*
 840	 * There is no way to know which GPIO line generated the
 841	 * interrupt.  We have to rely on the previous read for
 842	 * this purpose.
 843	 */
 844	pca953x_read_regs(chip, chip->regs->direction, reg_direction);
 845	bitmap_and(chip->irq_stat, irq_stat, reg_direction, chip->gpio_chip.ngpio);
 846	mutex_init(&chip->irq_lock);
 847
 848	irq_chip->name = dev_name(&client->dev);
 849	irq_chip->irq_mask = pca953x_irq_mask;
 850	irq_chip->irq_unmask = pca953x_irq_unmask;
 851	irq_chip->irq_set_wake = pca953x_irq_set_wake;
 852	irq_chip->irq_bus_lock = pca953x_irq_bus_lock;
 853	irq_chip->irq_bus_sync_unlock = pca953x_irq_bus_sync_unlock;
 854	irq_chip->irq_set_type = pca953x_irq_set_type;
 855	irq_chip->irq_shutdown = pca953x_irq_shutdown;
 856
 857	girq = &chip->gpio_chip.irq;
 858	girq->chip = irq_chip;
 859	/* This will let us handle the parent IRQ in the driver */
 860	girq->parent_handler = NULL;
 861	girq->num_parents = 0;
 862	girq->parents = NULL;
 863	girq->default_type = IRQ_TYPE_NONE;
 864	girq->handler = handle_simple_irq;
 865	girq->threaded = true;
 866	girq->first = irq_base; /* FIXME: get rid of this */
 867
 868	ret = devm_request_threaded_irq(&client->dev, client->irq,
 869					NULL, pca953x_irq_handler,
 870					IRQF_ONESHOT | IRQF_SHARED,
 871					dev_name(&client->dev), chip);
 872	if (ret) {
 873		dev_err(&client->dev, "failed to request irq %d\n",
 874			client->irq);
 875		return ret;
 876	}
 877
 878	return 0;
 
 
 
 
 879}
 880
 
 
 
 
 
 
 
 881#else /* CONFIG_GPIO_PCA953X_IRQ */
 882static int pca953x_irq_setup(struct pca953x_chip *chip,
 
 883			     int irq_base)
 884{
 885	struct i2c_client *client = chip->client;
 886
 887	if (client->irq && irq_base != -1 && (chip->driver_data & PCA_INT))
 888		dev_warn(&client->dev, "interrupt support not compiled in\n");
 889
 890	return 0;
 891}
 
 
 
 
 892#endif
 893
 894static int device_pca95xx_init(struct pca953x_chip *chip, u32 invert)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 895{
 896	DECLARE_BITMAP(val, MAX_LINE);
 897	int ret;
 898
 899	ret = regcache_sync_region(chip->regmap, chip->regs->output,
 900				   chip->regs->output + NBANK(chip));
 901	if (ret)
 902		goto out;
 903
 904	ret = regcache_sync_region(chip->regmap, chip->regs->direction,
 905				   chip->regs->direction + NBANK(chip));
 906	if (ret)
 907		goto out;
 908
 909	/* set platform specific polarity inversion */
 910	if (invert)
 911		bitmap_fill(val, MAX_LINE);
 912	else
 913		bitmap_zero(val, MAX_LINE);
 914
 915	ret = pca953x_write_regs(chip, chip->regs->invert, val);
 916out:
 917	return ret;
 918}
 919
 920static int device_pca957x_init(struct pca953x_chip *chip, u32 invert)
 921{
 922	DECLARE_BITMAP(val, MAX_LINE);
 923	unsigned int i;
 924	int ret;
 
 
 
 
 
 
 925
 926	ret = device_pca95xx_init(chip, invert);
 
 
 
 
 
 
 927	if (ret)
 928		goto out;
 929
 930	/* To enable register 6, 7 to control pull up and pull down */
 931	for (i = 0; i < NBANK(chip); i++)
 932		bitmap_set_value8(val, 0x02, i * BANK_SZ);
 933
 934	ret = pca953x_write_regs(chip, PCA957X_BKEN, val);
 935	if (ret)
 936		goto out;
 937
 938	return 0;
 939out:
 940	return ret;
 941}
 942
 943static int pca953x_probe(struct i2c_client *client,
 944			 const struct i2c_device_id *i2c_id)
 945{
 946	struct pca953x_platform_data *pdata;
 947	struct pca953x_chip *chip;
 948	int irq_base = 0;
 949	int ret;
 950	u32 invert = 0;
 951	struct regulator *reg;
 952	const struct regmap_config *regmap_config;
 953
 954	chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
 955	if (chip == NULL)
 956		return -ENOMEM;
 957
 958	pdata = dev_get_platdata(&client->dev);
 959	if (pdata) {
 960		irq_base = pdata->irq_base;
 961		chip->gpio_start = pdata->gpio_base;
 962		invert = pdata->invert;
 963		chip->names = pdata->names;
 964	} else {
 965		struct gpio_desc *reset_gpio;
 966
 967		chip->gpio_start = -1;
 968		irq_base = 0;
 969
 970		/*
 971		 * See if we need to de-assert a reset pin.
 972		 *
 973		 * There is no known ACPI-enabled platforms that are
 974		 * using "reset" GPIO. Otherwise any of those platform
 975		 * must use _DSD method with corresponding property.
 976		 */
 977		reset_gpio = devm_gpiod_get_optional(&client->dev, "reset",
 978						     GPIOD_OUT_LOW);
 979		if (IS_ERR(reset_gpio))
 980			return PTR_ERR(reset_gpio);
 981	}
 982
 983	chip->client = client;
 984
 985	reg = devm_regulator_get(&client->dev, "vcc");
 986	if (IS_ERR(reg))
 987		return dev_err_probe(&client->dev, PTR_ERR(reg), "reg get err\n");
 988
 989	ret = regulator_enable(reg);
 990	if (ret) {
 991		dev_err(&client->dev, "reg en err: %d\n", ret);
 992		return ret;
 993	}
 994	chip->regulator = reg;
 995
 996	if (i2c_id) {
 997		chip->driver_data = i2c_id->driver_data;
 998	} else {
 999		const void *match;
1000
1001		match = device_get_match_data(&client->dev);
1002		if (!match) {
1003			ret = -ENODEV;
1004			goto err_exit;
1005		}
1006
1007		chip->driver_data = (uintptr_t)match;
1008	}
1009
1010	i2c_set_clientdata(client, chip);
1011
1012	pca953x_setup_gpio(chip, chip->driver_data & PCA_GPIO_MASK);
1013
1014	if (NBANK(chip) > 2 || PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
1015		dev_info(&client->dev, "using AI\n");
1016		regmap_config = &pca953x_ai_i2c_regmap;
1017	} else {
1018		dev_info(&client->dev, "using no AI\n");
1019		regmap_config = &pca953x_i2c_regmap;
1020	}
1021
1022	chip->regmap = devm_regmap_init_i2c(client, regmap_config);
1023	if (IS_ERR(chip->regmap)) {
1024		ret = PTR_ERR(chip->regmap);
1025		goto err_exit;
1026	}
1027
1028	regcache_mark_dirty(chip->regmap);
1029
1030	mutex_init(&chip->i2c_lock);
1031	/*
1032	 * In case we have an i2c-mux controlled by a GPIO provided by an
1033	 * expander using the same driver higher on the device tree, read the
1034	 * i2c adapter nesting depth and use the retrieved value as lockdep
1035	 * subclass for chip->i2c_lock.
1036	 *
1037	 * REVISIT: This solution is not complete. It protects us from lockdep
1038	 * false positives when the expander controlling the i2c-mux is on
1039	 * a different level on the device tree, but not when it's on the same
1040	 * level on a different branch (in which case the subclass number
1041	 * would be the same).
1042	 *
1043	 * TODO: Once a correct solution is developed, a similar fix should be
1044	 * applied to all other i2c-controlled GPIO expanders (and potentially
1045	 * regmap-i2c).
1046	 */
1047	lockdep_set_subclass(&chip->i2c_lock,
1048			     i2c_adapter_depth(client->adapter));
1049
1050	/* initialize cached registers from their original values.
1051	 * we can't share this chip with another i2c master.
1052	 */
 
1053
1054	if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE) {
1055		chip->regs = &pca953x_regs;
1056		ret = device_pca95xx_init(chip, invert);
1057	} else {
1058		chip->regs = &pca957x_regs;
1059		ret = device_pca957x_init(chip, invert);
1060	}
1061	if (ret)
1062		goto err_exit;
1063
1064	ret = pca953x_irq_setup(chip, irq_base);
1065	if (ret)
1066		goto err_exit;
1067
1068	ret = devm_gpiochip_add_data(&client->dev, &chip->gpio_chip, chip);
1069	if (ret)
1070		goto err_exit;
1071
1072	if (pdata && pdata->setup) {
1073		ret = pdata->setup(client, chip->gpio_chip.base,
1074				   chip->gpio_chip.ngpio, pdata->context);
1075		if (ret < 0)
1076			dev_warn(&client->dev, "setup failed, %d\n", ret);
1077	}
1078
 
1079	return 0;
1080
1081err_exit:
1082	regulator_disable(chip->regulator);
 
 
1083	return ret;
1084}
1085
1086static int pca953x_remove(struct i2c_client *client)
1087{
1088	struct pca953x_platform_data *pdata = dev_get_platdata(&client->dev);
1089	struct pca953x_chip *chip = i2c_get_clientdata(client);
1090	int ret;
1091
1092	if (pdata && pdata->teardown) {
1093		ret = pdata->teardown(client, chip->gpio_chip.base,
1094				      chip->gpio_chip.ngpio, pdata->context);
1095		if (ret < 0)
1096			dev_err(&client->dev, "teardown failed, %d\n", ret);
1097	} else {
1098		ret = 0;
1099	}
1100
1101	regulator_disable(chip->regulator);
1102
1103	return ret;
1104}
1105
1106#ifdef CONFIG_PM_SLEEP
1107static int pca953x_regcache_sync(struct device *dev)
1108{
1109	struct pca953x_chip *chip = dev_get_drvdata(dev);
1110	int ret;
1111
1112	/*
1113	 * The ordering between direction and output is important,
1114	 * sync these registers first and only then sync the rest.
1115	 */
1116	ret = regcache_sync_region(chip->regmap, chip->regs->direction,
1117				   chip->regs->direction + NBANK(chip));
1118	if (ret) {
1119		dev_err(dev, "Failed to sync GPIO dir registers: %d\n", ret);
1120		return ret;
1121	}
1122
1123	ret = regcache_sync_region(chip->regmap, chip->regs->output,
1124				   chip->regs->output + NBANK(chip));
1125	if (ret) {
1126		dev_err(dev, "Failed to sync GPIO out registers: %d\n", ret);
1127		return ret;
1128	}
1129
1130#ifdef CONFIG_GPIO_PCA953X_IRQ
1131	if (chip->driver_data & PCA_PCAL) {
1132		ret = regcache_sync_region(chip->regmap, PCAL953X_IN_LATCH,
1133					   PCAL953X_IN_LATCH + NBANK(chip));
1134		if (ret) {
1135			dev_err(dev, "Failed to sync INT latch registers: %d\n",
1136				ret);
1137			return ret;
1138		}
1139
1140		ret = regcache_sync_region(chip->regmap, PCAL953X_INT_MASK,
1141					   PCAL953X_INT_MASK + NBANK(chip));
1142		if (ret) {
1143			dev_err(dev, "Failed to sync INT mask registers: %d\n",
1144				ret);
1145			return ret;
1146		}
1147	}
1148#endif
1149
1150	return 0;
1151}
1152
1153static int pca953x_suspend(struct device *dev)
1154{
1155	struct pca953x_chip *chip = dev_get_drvdata(dev);
1156
1157	regcache_cache_only(chip->regmap, true);
1158
1159	if (atomic_read(&chip->wakeup_path))
1160		device_set_wakeup_path(dev);
1161	else
1162		regulator_disable(chip->regulator);
1163
1164	return 0;
1165}
1166
1167static int pca953x_resume(struct device *dev)
1168{
1169	struct pca953x_chip *chip = dev_get_drvdata(dev);
1170	int ret;
1171
1172	if (!atomic_read(&chip->wakeup_path)) {
1173		ret = regulator_enable(chip->regulator);
1174		if (ret) {
1175			dev_err(dev, "Failed to enable regulator: %d\n", ret);
1176			return 0;
1177		}
1178	}
1179
1180	regcache_cache_only(chip->regmap, false);
1181	regcache_mark_dirty(chip->regmap);
1182	ret = pca953x_regcache_sync(dev);
1183	if (ret)
1184		return ret;
1185
1186	ret = regcache_sync(chip->regmap);
1187	if (ret) {
1188		dev_err(dev, "Failed to restore register map: %d\n", ret);
 
1189		return ret;
1190	}
1191
 
 
1192	return 0;
1193}
1194#endif
1195
1196/* convenience to stop overlong match-table lines */
1197#define OF_953X(__nrgpio, __int) (void *)(__nrgpio | PCA953X_TYPE | __int)
1198#define OF_957X(__nrgpio, __int) (void *)(__nrgpio | PCA957X_TYPE | __int)
1199
1200static const struct of_device_id pca953x_dt_ids[] = {
1201	{ .compatible = "nxp,pca6416", .data = OF_953X(16, PCA_INT), },
1202	{ .compatible = "nxp,pca9505", .data = OF_953X(40, PCA_INT), },
1203	{ .compatible = "nxp,pca9506", .data = OF_953X(40, PCA_INT), },
1204	{ .compatible = "nxp,pca9534", .data = OF_953X( 8, PCA_INT), },
1205	{ .compatible = "nxp,pca9535", .data = OF_953X(16, PCA_INT), },
1206	{ .compatible = "nxp,pca9536", .data = OF_953X( 4, 0), },
1207	{ .compatible = "nxp,pca9537", .data = OF_953X( 4, PCA_INT), },
1208	{ .compatible = "nxp,pca9538", .data = OF_953X( 8, PCA_INT), },
1209	{ .compatible = "nxp,pca9539", .data = OF_953X(16, PCA_INT), },
1210	{ .compatible = "nxp,pca9554", .data = OF_953X( 8, PCA_INT), },
1211	{ .compatible = "nxp,pca9555", .data = OF_953X(16, PCA_INT), },
1212	{ .compatible = "nxp,pca9556", .data = OF_953X( 8, 0), },
1213	{ .compatible = "nxp,pca9557", .data = OF_953X( 8, 0), },
1214	{ .compatible = "nxp,pca9574", .data = OF_957X( 8, PCA_INT), },
1215	{ .compatible = "nxp,pca9575", .data = OF_957X(16, PCA_INT), },
1216	{ .compatible = "nxp,pca9698", .data = OF_953X(40, 0), },
1217
1218	{ .compatible = "nxp,pcal6416", .data = OF_953X(16, PCA_LATCH_INT), },
1219	{ .compatible = "nxp,pcal6524", .data = OF_953X(24, PCA_LATCH_INT), },
1220	{ .compatible = "nxp,pcal9535", .data = OF_953X(16, PCA_LATCH_INT), },
1221	{ .compatible = "nxp,pcal9554b", .data = OF_953X( 8, PCA_LATCH_INT), },
1222	{ .compatible = "nxp,pcal9555a", .data = OF_953X(16, PCA_LATCH_INT), },
1223
1224	{ .compatible = "maxim,max7310", .data = OF_953X( 8, 0), },
1225	{ .compatible = "maxim,max7312", .data = OF_953X(16, PCA_INT), },
1226	{ .compatible = "maxim,max7313", .data = OF_953X(16, PCA_INT), },
1227	{ .compatible = "maxim,max7315", .data = OF_953X( 8, PCA_INT), },
1228	{ .compatible = "maxim,max7318", .data = OF_953X(16, PCA_INT), },
1229
1230	{ .compatible = "ti,pca6107", .data = OF_953X( 8, PCA_INT), },
1231	{ .compatible = "ti,pca9536", .data = OF_953X( 4, 0), },
1232	{ .compatible = "ti,tca6408", .data = OF_953X( 8, PCA_INT), },
1233	{ .compatible = "ti,tca6416", .data = OF_953X(16, PCA_INT), },
1234	{ .compatible = "ti,tca6424", .data = OF_953X(24, PCA_INT), },
1235	{ .compatible = "ti,tca9539", .data = OF_953X(16, PCA_INT), },
1236
1237	{ .compatible = "onnn,cat9554", .data = OF_953X( 8, PCA_INT), },
1238	{ .compatible = "onnn,pca9654", .data = OF_953X( 8, PCA_INT), },
1239	{ .compatible = "onnn,pca9655", .data = OF_953X(16, PCA_INT), },
1240
1241	{ .compatible = "exar,xra1202", .data = OF_953X( 8, 0), },
1242	{ }
1243};
1244
1245MODULE_DEVICE_TABLE(of, pca953x_dt_ids);
1246
1247static SIMPLE_DEV_PM_OPS(pca953x_pm_ops, pca953x_suspend, pca953x_resume);
1248
1249static struct i2c_driver pca953x_driver = {
1250	.driver = {
1251		.name	= "pca953x",
1252		.pm	= &pca953x_pm_ops,
1253		.of_match_table = pca953x_dt_ids,
1254		.acpi_match_table = pca953x_acpi_ids,
1255	},
1256	.probe		= pca953x_probe,
1257	.remove		= pca953x_remove,
1258	.id_table	= pca953x_id,
1259};
1260
1261static int __init pca953x_init(void)
1262{
1263	return i2c_add_driver(&pca953x_driver);
1264}
1265/* register after i2c postcore initcall and before
1266 * subsys initcalls that may rely on these GPIOs
1267 */
1268subsys_initcall(pca953x_init);
1269
1270static void __exit pca953x_exit(void)
1271{
1272	i2c_del_driver(&pca953x_driver);
1273}
1274module_exit(pca953x_exit);
1275
1276MODULE_AUTHOR("eric miao <eric.miao@marvell.com>");
1277MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
1278MODULE_LICENSE("GPL");