[PATCH v2 02/17] regmap-irq: Add get_irq_reg to support unusual register layouts

Aidan MacDonald
2022-06-07T15:52:39Z

Add a new callback, get_irq_reg, for regmap IRQ chips, to support devices
with unusual register layouts. This is required in the rare cases where
the offset of an IRQ register is not constant with respect to the base
register. This is probably best illustrated with an example (taken from
the AXP192 PMIC):

mask status
IRQ0 0x40 0x44
IRQ1 0x41 0x45
IRQ2 0x42 0x46
IRQ3 0x43 0x47
IRQ4 0x4a 0x4d

If we set mask_base = 0x40 and status_base = 0x44, the offsets of each
register relative to the base are:

mask status
IRQ0 0 0
IRQ1 1 1
IRQ2 2 2
IRQ3 3 3
IRQ4 10 9

The existing mapping mechanisms can't include IRQ4 in the same irqchip
as IRQ0-3 because the offset of IRQ4's register depends on which type
of register we're asking for, ie. which base register is used.

The get_irq_reg callback allows drivers to specify an arbitrary mapping
of (base register, register index) pairs to register addresses, instead
of the default linear mapping "base_register + register_index". This
allows unusual layouts, like the one above, to be handled using a single
regmap IRQ chip.

The drawback is that when get_irq_reg is used, it's impossible to use
bulk reads for status registers even if some of them are contiguous,
because the mapping is opaque to regmap-irq. This should be acceptable
for the case of a few infrequently-polled status registers.

Signed-off-by: Aidan MacDonald <aidanmacdonald.0x0@gmail.com>
---
drivers/base/regmap/regmap-irq.c | 6 ++++--
include/linux/regmap.h | 5 +++++
2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/drivers/base/regmap/regmap-irq.c b/drivers/base/regmap/regmap-irq.c
index 4a2e1f6aa94d..e50437b18284 100644
--- a/drivers/base/regmap/regmap-irq.c
+++ b/drivers/base/regmap/regmap-irq.c
@@ -55,7 +55,9 @@ static int sub_irq_reg(struct regmap_irq_chip_data *data,
unsigned int offset;
int reg = 0;

- if (!chip->sub_reg_offsets || !chip->not_fixed_stride) {
+ if (chip->get_irq_reg) {
+ reg = chip->get_irq_reg(base_reg, i);
+ } else if (!chip->sub_reg_offsets || !chip->not_fixed_stride) {
/* Assume linear mapping */
reg = base_reg + (i * map->reg_stride * data->irq_reg_stride);
} else {
@@ -479,7 +481,7 @@ static irqreturn_t regmap_irq_thread(int irq, void *d)

}
} else if (!map->use_single_read && map->reg_stride == 1 &&
- data->irq_reg_stride == 1) {
+ data->irq_reg_stride == 1 && !chip->get_irq_reg) {

u8 *buf8 = data->status_reg_buf;
u16 *buf16 = data->status_reg_buf;
diff --git a/include/linux/regmap.h b/include/linux/regmap.h
index 8952fa3d0d59..4828021ab9e8 100644
--- a/include/linux/regmap.h
+++ b/include/linux/regmap.h
@@ -1495,6 +1495,10 @@ struct regmap_irq_sub_irq_map {
* after handling the interrupts in regmap_irq_handler().
* @set_type_virt: Driver specific callback to extend regmap_irq_set_type()
* and configure virt regs.
+ * @get_irq_reg: Callback to map a register index in range [0, num_regs[
+ * to a register, relative to a specific base register. This
+ * is mainly useful for devices where the register offsets
+ * change depending on the base register.
* @irq_drv_data: Driver specific IRQ data which is passed as parameter when
* driver specific pre/post interrupt handler is called.
*
@@ -1545,6 +1549,7 @@ struct regmap_irq_chip {
int (*handle_post_irq)(void *irq_drv_data);
int (*set_type_virt)(unsigned int **buf, unsigned int type,
unsigned long hwirq, int reg);
+ int (*get_irq_reg)(unsigned int base_reg, int i);
void *irq_drv_data;
};

--
2.35.1