1 // SPDX-License-Identifier: GPL-2.0-only
3 * MAX732x I2C Port Expander with 8/16 I/O
5 * Copyright (C) 2007 Marvell International Ltd.
6 * Copyright (C) 2008 Jack Ren <jack.ren@marvell.com>
7 * Copyright (C) 2008 Eric Miao <eric.miao@marvell.com>
8 * Copyright (C) 2015 Linus Walleij <linus.walleij@linaro.org>
10 * Derived from drivers/gpio/pca953x.c
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/slab.h>
16 #include <linux/string.h>
17 #include <linux/gpio/driver.h>
18 #include <linux/interrupt.h>
19 #include <linux/i2c.h>
20 #include <linux/platform_data/max732x.h>
23 * Each port of MAX732x (including MAX7319) falls into one of the
24 * following three types:
30 * designated by 'O', 'I' and 'P' individually according to MAXIM's
31 * datasheets. 'I' and 'P' ports are interrupt capables, some with
32 * a dedicated interrupt mask.
34 * There are two groups of I/O ports, each group usually includes
35 * up to 8 I/O ports, and is accessed by a specific I2C address:
37 * - Group A : by I2C address 0b'110xxxx
38 * - Group B : by I2C address 0b'101xxxx
40 * where 'xxxx' is decided by the connections of pin AD2/AD0. The
41 * address used also affects the initial state of output signals.
43 * Within each group of ports, there are five known combinations of
44 * I/O ports: 4I4O, 4P4O, 8I, 8P, 8O, see the definitions below for
45 * the detailed organization of these ports. Only Goup A is interrupt
48 * GPIO numbers start from 'gpio_base + 0' to 'gpio_base + 8/16',
49 * and GPIOs from GROUP_A are numbered before those from GROUP_B
50 * (if there are two groups).
52 * NOTE: MAX7328/MAX7329 are drop-in replacements for PCF8574/a, so
53 * they are not supported by this driver.
56 #define PORT_NONE 0x0 /* '/' No Port */
57 #define PORT_OUTPUT 0x1 /* 'O' Push-Pull, Output Only */
58 #define PORT_INPUT 0x2 /* 'I' Input Only */
59 #define PORT_OPENDRAIN 0x3 /* 'P' Open-Drain, I/O */
61 #define IO_4I4O 0x5AA5 /* O7 O6 I5 I4 I3 I2 O1 O0 */
62 #define IO_4P4O 0x5FF5 /* O7 O6 P5 P4 P3 P2 O1 O0 */
63 #define IO_8I 0xAAAA /* I7 I6 I5 I4 I3 I2 I1 I0 */
64 #define IO_8P 0xFFFF /* P7 P6 P5 P4 P3 P2 P1 P0 */
65 #define IO_8O 0x5555 /* O7 O6 O5 O4 O3 O2 O1 O0 */
67 #define GROUP_A(x) ((x) & 0xffff) /* I2C Addr: 0b'110xxxx */
68 #define GROUP_B(x) ((x) << 16) /* I2C Addr: 0b'101xxxx */
70 #define INT_NONE 0x0 /* No interrupt capability */
71 #define INT_NO_MASK 0x1 /* Has interrupts, no mask */
72 #define INT_INDEP_MASK 0x2 /* Has interrupts, independent mask */
73 #define INT_MERGED_MASK 0x3 /* Has interrupts, merged mask */
75 #define INT_CAPS(x) (((uint64_t)(x)) << 32)
89 static uint64_t max732x_features
[] = {
90 [MAX7319
] = GROUP_A(IO_8I
) | INT_CAPS(INT_MERGED_MASK
),
91 [MAX7320
] = GROUP_B(IO_8O
),
92 [MAX7321
] = GROUP_A(IO_8P
) | INT_CAPS(INT_NO_MASK
),
93 [MAX7322
] = GROUP_A(IO_4I4O
) | INT_CAPS(INT_MERGED_MASK
),
94 [MAX7323
] = GROUP_A(IO_4P4O
) | INT_CAPS(INT_INDEP_MASK
),
95 [MAX7324
] = GROUP_A(IO_8I
) | GROUP_B(IO_8O
) | INT_CAPS(INT_MERGED_MASK
),
96 [MAX7325
] = GROUP_A(IO_8P
) | GROUP_B(IO_8O
) | INT_CAPS(INT_NO_MASK
),
97 [MAX7326
] = GROUP_A(IO_4I4O
) | GROUP_B(IO_8O
) | INT_CAPS(INT_MERGED_MASK
),
98 [MAX7327
] = GROUP_A(IO_4P4O
) | GROUP_B(IO_8O
) | INT_CAPS(INT_NO_MASK
),
101 static const struct i2c_device_id max732x_id
[] = {
102 { "max7319", MAX7319
},
103 { "max7320", MAX7320
},
104 { "max7321", MAX7321
},
105 { "max7322", MAX7322
},
106 { "max7323", MAX7323
},
107 { "max7324", MAX7324
},
108 { "max7325", MAX7325
},
109 { "max7326", MAX7326
},
110 { "max7327", MAX7327
},
113 MODULE_DEVICE_TABLE(i2c
, max732x_id
);
115 static const struct of_device_id max732x_of_table
[] = {
116 { .compatible
= "maxim,max7319" },
117 { .compatible
= "maxim,max7320" },
118 { .compatible
= "maxim,max7321" },
119 { .compatible
= "maxim,max7322" },
120 { .compatible
= "maxim,max7323" },
121 { .compatible
= "maxim,max7324" },
122 { .compatible
= "maxim,max7325" },
123 { .compatible
= "maxim,max7326" },
124 { .compatible
= "maxim,max7327" },
127 MODULE_DEVICE_TABLE(of
, max732x_of_table
);
129 struct max732x_chip
{
130 struct gpio_chip gpio_chip
;
132 struct i2c_client
*client
; /* "main" client */
133 struct i2c_client
*client_dummy
;
134 struct i2c_client
*client_group_a
;
135 struct i2c_client
*client_group_b
;
137 unsigned int mask_group_a
;
138 unsigned int dir_input
;
139 unsigned int dir_output
;
144 #ifdef CONFIG_GPIO_MAX732X_IRQ
145 struct mutex irq_lock
;
147 uint8_t irq_mask_cur
;
148 uint8_t irq_trig_raise
;
149 uint8_t irq_trig_fall
;
150 uint8_t irq_features
;
154 static int max732x_writeb(struct max732x_chip
*chip
, int group_a
, uint8_t val
)
156 struct i2c_client
*client
;
159 client
= group_a
? chip
->client_group_a
: chip
->client_group_b
;
160 ret
= i2c_smbus_write_byte(client
, val
);
162 dev_err(&client
->dev
, "failed writing\n");
169 static int max732x_readb(struct max732x_chip
*chip
, int group_a
, uint8_t *val
)
171 struct i2c_client
*client
;
174 client
= group_a
? chip
->client_group_a
: chip
->client_group_b
;
175 ret
= i2c_smbus_read_byte(client
);
177 dev_err(&client
->dev
, "failed reading\n");
185 static inline int is_group_a(struct max732x_chip
*chip
, unsigned off
)
187 return (1u << off
) & chip
->mask_group_a
;
190 static int max732x_gpio_get_value(struct gpio_chip
*gc
, unsigned off
)
192 struct max732x_chip
*chip
= gpiochip_get_data(gc
);
196 ret
= max732x_readb(chip
, is_group_a(chip
, off
), ®_val
);
200 return !!(reg_val
& (1u << (off
& 0x7)));
203 static void max732x_gpio_set_mask(struct gpio_chip
*gc
, unsigned off
, int mask
,
206 struct max732x_chip
*chip
= gpiochip_get_data(gc
);
210 mutex_lock(&chip
->lock
);
212 reg_out
= (off
> 7) ? chip
->reg_out
[1] : chip
->reg_out
[0];
213 reg_out
= (reg_out
& ~mask
) | (val
& mask
);
215 ret
= max732x_writeb(chip
, is_group_a(chip
, off
), reg_out
);
219 /* update the shadow register then */
221 chip
->reg_out
[1] = reg_out
;
223 chip
->reg_out
[0] = reg_out
;
225 mutex_unlock(&chip
->lock
);
228 static void max732x_gpio_set_value(struct gpio_chip
*gc
, unsigned off
, int val
)
230 unsigned base
= off
& ~0x7;
231 uint8_t mask
= 1u << (off
& 0x7);
233 max732x_gpio_set_mask(gc
, base
, mask
, val
<< (off
& 0x7));
236 static void max732x_gpio_set_multiple(struct gpio_chip
*gc
,
237 unsigned long *mask
, unsigned long *bits
)
239 unsigned mask_lo
= mask
[0] & 0xff;
240 unsigned mask_hi
= (mask
[0] >> 8) & 0xff;
243 max732x_gpio_set_mask(gc
, 0, mask_lo
, bits
[0] & 0xff);
245 max732x_gpio_set_mask(gc
, 8, mask_hi
, (bits
[0] >> 8) & 0xff);
248 static int max732x_gpio_direction_input(struct gpio_chip
*gc
, unsigned off
)
250 struct max732x_chip
*chip
= gpiochip_get_data(gc
);
251 unsigned int mask
= 1u << off
;
253 if ((mask
& chip
->dir_input
) == 0) {
254 dev_dbg(&chip
->client
->dev
, "%s port %d is output only\n",
255 chip
->client
->name
, off
);
260 * Open-drain pins must be set to high impedance (which is
261 * equivalent to output-high) to be turned into an input.
263 if ((mask
& chip
->dir_output
))
264 max732x_gpio_set_value(gc
, off
, 1);
269 static int max732x_gpio_direction_output(struct gpio_chip
*gc
,
270 unsigned off
, int val
)
272 struct max732x_chip
*chip
= gpiochip_get_data(gc
);
273 unsigned int mask
= 1u << off
;
275 if ((mask
& chip
->dir_output
) == 0) {
276 dev_dbg(&chip
->client
->dev
, "%s port %d is input only\n",
277 chip
->client
->name
, off
);
281 max732x_gpio_set_value(gc
, off
, val
);
285 #ifdef CONFIG_GPIO_MAX732X_IRQ
286 static int max732x_writew(struct max732x_chip
*chip
, uint16_t val
)
290 val
= cpu_to_le16(val
);
292 ret
= i2c_master_send(chip
->client_group_a
, (char *)&val
, 2);
294 dev_err(&chip
->client_group_a
->dev
, "failed writing\n");
301 static int max732x_readw(struct max732x_chip
*chip
, uint16_t *val
)
305 ret
= i2c_master_recv(chip
->client_group_a
, (char *)val
, 2);
307 dev_err(&chip
->client_group_a
->dev
, "failed reading\n");
311 *val
= le16_to_cpu(*val
);
315 static void max732x_irq_update_mask(struct max732x_chip
*chip
)
319 if (chip
->irq_mask
== chip
->irq_mask_cur
)
322 chip
->irq_mask
= chip
->irq_mask_cur
;
324 if (chip
->irq_features
== INT_NO_MASK
)
327 mutex_lock(&chip
->lock
);
329 switch (chip
->irq_features
) {
331 msg
= (chip
->irq_mask
<< 8) | chip
->reg_out
[0];
332 max732x_writew(chip
, msg
);
335 case INT_MERGED_MASK
:
336 msg
= chip
->irq_mask
| chip
->reg_out
[0];
337 max732x_writeb(chip
, 1, (uint8_t)msg
);
341 mutex_unlock(&chip
->lock
);
344 static void max732x_irq_mask(struct irq_data
*d
)
346 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
347 struct max732x_chip
*chip
= gpiochip_get_data(gc
);
349 chip
->irq_mask_cur
&= ~(1 << d
->hwirq
);
350 gpiochip_disable_irq(gc
, irqd_to_hwirq(d
));
353 static void max732x_irq_unmask(struct irq_data
*d
)
355 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
356 struct max732x_chip
*chip
= gpiochip_get_data(gc
);
358 gpiochip_enable_irq(gc
, irqd_to_hwirq(d
));
359 chip
->irq_mask_cur
|= 1 << d
->hwirq
;
362 static void max732x_irq_bus_lock(struct irq_data
*d
)
364 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
365 struct max732x_chip
*chip
= gpiochip_get_data(gc
);
367 mutex_lock(&chip
->irq_lock
);
368 chip
->irq_mask_cur
= chip
->irq_mask
;
371 static void max732x_irq_bus_sync_unlock(struct irq_data
*d
)
373 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
374 struct max732x_chip
*chip
= gpiochip_get_data(gc
);
378 max732x_irq_update_mask(chip
);
380 new_irqs
= chip
->irq_trig_fall
| chip
->irq_trig_raise
;
382 level
= __ffs(new_irqs
);
383 max732x_gpio_direction_input(&chip
->gpio_chip
, level
);
384 new_irqs
&= ~(1 << level
);
387 mutex_unlock(&chip
->irq_lock
);
390 static int max732x_irq_set_type(struct irq_data
*d
, unsigned int type
)
392 struct gpio_chip
*gc
= irq_data_get_irq_chip_data(d
);
393 struct max732x_chip
*chip
= gpiochip_get_data(gc
);
394 uint16_t off
= d
->hwirq
;
395 uint16_t mask
= 1 << off
;
397 if (!(mask
& chip
->dir_input
)) {
398 dev_dbg(&chip
->client
->dev
, "%s port %d is output only\n",
399 chip
->client
->name
, off
);
403 if (!(type
& IRQ_TYPE_EDGE_BOTH
)) {
404 dev_err(&chip
->client
->dev
, "irq %d: unsupported type %d\n",
409 if (type
& IRQ_TYPE_EDGE_FALLING
)
410 chip
->irq_trig_fall
|= mask
;
412 chip
->irq_trig_fall
&= ~mask
;
414 if (type
& IRQ_TYPE_EDGE_RISING
)
415 chip
->irq_trig_raise
|= mask
;
417 chip
->irq_trig_raise
&= ~mask
;
422 static int max732x_irq_set_wake(struct irq_data
*data
, unsigned int on
)
424 struct max732x_chip
*chip
= irq_data_get_irq_chip_data(data
);
426 irq_set_irq_wake(chip
->client
->irq
, on
);
430 static const struct irq_chip max732x_irq_chip
= {
432 .irq_mask
= max732x_irq_mask
,
433 .irq_unmask
= max732x_irq_unmask
,
434 .irq_bus_lock
= max732x_irq_bus_lock
,
435 .irq_bus_sync_unlock
= max732x_irq_bus_sync_unlock
,
436 .irq_set_type
= max732x_irq_set_type
,
437 .irq_set_wake
= max732x_irq_set_wake
,
438 .flags
= IRQCHIP_IMMUTABLE
,
439 GPIOCHIP_IRQ_RESOURCE_HELPERS
,
442 static uint8_t max732x_irq_pending(struct max732x_chip
*chip
)
451 ret
= max732x_readw(chip
, &status
);
455 trigger
= status
>> 8;
456 trigger
&= chip
->irq_mask
;
461 cur_stat
= status
& 0xFF;
462 cur_stat
&= chip
->irq_mask
;
464 old_stat
= cur_stat
^ trigger
;
466 pending
= (old_stat
& chip
->irq_trig_fall
) |
467 (cur_stat
& chip
->irq_trig_raise
);
473 static irqreturn_t
max732x_irq_handler(int irq
, void *devid
)
475 struct max732x_chip
*chip
= devid
;
479 pending
= max732x_irq_pending(chip
);
485 level
= __ffs(pending
);
486 handle_nested_irq(irq_find_mapping(chip
->gpio_chip
.irq
.domain
,
489 pending
&= ~(1 << level
);
495 static int max732x_irq_setup(struct max732x_chip
*chip
,
496 const struct i2c_device_id
*id
)
498 struct i2c_client
*client
= chip
->client
;
499 int has_irq
= max732x_features
[id
->driver_data
] >> 32;
503 if (client
->irq
&& has_irq
!= INT_NONE
) {
504 struct gpio_irq_chip
*girq
;
506 chip
->irq_features
= has_irq
;
507 mutex_init(&chip
->irq_lock
);
509 ret
= devm_request_threaded_irq(&client
->dev
, client
->irq
,
510 NULL
, max732x_irq_handler
, IRQF_ONESHOT
|
511 IRQF_TRIGGER_FALLING
| IRQF_SHARED
,
512 dev_name(&client
->dev
), chip
);
514 dev_err(&client
->dev
, "failed to request irq %d\n",
519 girq
= &chip
->gpio_chip
.irq
;
520 gpio_irq_chip_set_chip(girq
, &max732x_irq_chip
);
521 /* This will let us handle the parent IRQ in the driver */
522 girq
->parent_handler
= NULL
;
523 girq
->num_parents
= 0;
524 girq
->parents
= NULL
;
525 girq
->default_type
= IRQ_TYPE_NONE
;
526 girq
->handler
= handle_simple_irq
;
527 girq
->threaded
= true;
528 girq
->first
= irq_base
; /* FIXME: get rid of this */
534 #else /* CONFIG_GPIO_MAX732X_IRQ */
535 static int max732x_irq_setup(struct max732x_chip
*chip
,
536 const struct i2c_device_id
*id
)
538 struct i2c_client
*client
= chip
->client
;
539 int has_irq
= max732x_features
[id
->driver_data
] >> 32;
541 if (client
->irq
&& has_irq
!= INT_NONE
)
542 dev_warn(&client
->dev
, "interrupt support not compiled in\n");
548 static int max732x_setup_gpio(struct max732x_chip
*chip
,
549 const struct i2c_device_id
*id
,
552 struct gpio_chip
*gc
= &chip
->gpio_chip
;
553 uint32_t id_data
= (uint32_t)max732x_features
[id
->driver_data
];
556 for (i
= 0; i
< 16; i
++, id_data
>>= 2) {
557 unsigned int mask
= 1 << port
;
559 switch (id_data
& 0x3) {
561 chip
->dir_output
|= mask
;
564 chip
->dir_input
|= mask
;
567 chip
->dir_output
|= mask
;
568 chip
->dir_input
|= mask
;
575 chip
->mask_group_a
|= mask
;
580 gc
->direction_input
= max732x_gpio_direction_input
;
581 if (chip
->dir_output
) {
582 gc
->direction_output
= max732x_gpio_direction_output
;
583 gc
->set
= max732x_gpio_set_value
;
584 gc
->set_multiple
= max732x_gpio_set_multiple
;
586 gc
->get
= max732x_gpio_get_value
;
587 gc
->can_sleep
= true;
589 gc
->base
= gpio_start
;
591 gc
->label
= chip
->client
->name
;
592 gc
->parent
= &chip
->client
->dev
;
593 gc
->owner
= THIS_MODULE
;
598 static struct max732x_platform_data
*of_gpio_max732x(struct device
*dev
)
600 struct max732x_platform_data
*pdata
;
602 pdata
= devm_kzalloc(dev
, sizeof(*pdata
), GFP_KERNEL
);
606 pdata
->gpio_base
= -1;
611 static int max732x_probe(struct i2c_client
*client
)
613 const struct i2c_device_id
*id
= i2c_client_get_device_id(client
);
614 struct max732x_platform_data
*pdata
;
615 struct device_node
*node
;
616 struct max732x_chip
*chip
;
617 struct i2c_client
*c
;
618 uint16_t addr_a
, addr_b
;
621 pdata
= dev_get_platdata(&client
->dev
);
622 node
= client
->dev
.of_node
;
625 pdata
= of_gpio_max732x(&client
->dev
);
628 dev_dbg(&client
->dev
, "no platform data\n");
632 chip
= devm_kzalloc(&client
->dev
, sizeof(*chip
), GFP_KERNEL
);
635 chip
->client
= client
;
637 nr_port
= max732x_setup_gpio(chip
, id
, pdata
->gpio_base
);
638 chip
->gpio_chip
.parent
= &client
->dev
;
640 addr_a
= (client
->addr
& 0x0f) | 0x60;
641 addr_b
= (client
->addr
& 0x0f) | 0x50;
643 switch (client
->addr
& 0x70) {
645 chip
->client_group_a
= client
;
647 c
= devm_i2c_new_dummy_device(&client
->dev
,
648 client
->adapter
, addr_b
);
650 dev_err(&client
->dev
,
651 "Failed to allocate I2C device\n");
654 chip
->client_group_b
= chip
->client_dummy
= c
;
658 chip
->client_group_b
= client
;
660 c
= devm_i2c_new_dummy_device(&client
->dev
,
661 client
->adapter
, addr_a
);
663 dev_err(&client
->dev
,
664 "Failed to allocate I2C device\n");
667 chip
->client_group_a
= chip
->client_dummy
= c
;
671 dev_err(&client
->dev
, "invalid I2C address specified %02x\n",
676 if (nr_port
> 8 && !chip
->client_dummy
) {
677 dev_err(&client
->dev
,
678 "Failed to allocate second group I2C device\n");
682 mutex_init(&chip
->lock
);
684 ret
= max732x_readb(chip
, is_group_a(chip
, 0), &chip
->reg_out
[0]);
688 ret
= max732x_readb(chip
, is_group_a(chip
, 8), &chip
->reg_out
[1]);
693 ret
= max732x_irq_setup(chip
, id
);
697 ret
= devm_gpiochip_add_data(&client
->dev
, &chip
->gpio_chip
, chip
);
701 i2c_set_clientdata(client
, chip
);
705 static struct i2c_driver max732x_driver
= {
708 .of_match_table
= max732x_of_table
,
710 .probe
= max732x_probe
,
711 .id_table
= max732x_id
,
714 static int __init
max732x_init(void)
716 return i2c_add_driver(&max732x_driver
);
718 /* register after i2c postcore initcall and before
719 * subsys initcalls that may rely on these GPIOs
721 subsys_initcall(max732x_init
);
723 static void __exit
max732x_exit(void)
725 i2c_del_driver(&max732x_driver
);
727 module_exit(max732x_exit
);
729 MODULE_AUTHOR("Eric Miao <eric.miao@marvell.com>");
730 MODULE_DESCRIPTION("GPIO expander driver for MAX732X");
731 MODULE_LICENSE("GPL");