/* SPDX-License-Identifier: GPL-2.0-only */

#ifndef _LINUX_GPIO_REGMAP_H
#define _LINUX_GPIO_REGMAP_H

struct device;
struct fwnode_handle;
struct gpio_regmap;
struct irq_domain;
struct regmap;

#define GPIO_REGMAP_ADDR_ZERO ((unsigned int)(-1))
#define GPIO_REGMAP_ADDR(addr) ((addr) ? : GPIO_REGMAP_ADDR_ZERO)

/**
 * struct gpio_regmap_config - Description of a generic regmap gpio_chip.
 * @parent:  The parent device
 * @regmap:  The regmap used to access the registers
 *   given, the name of the device is used
 * @fwnode:  (Optional) The firmware node.
 *   If not given, the fwnode of the parent is used.
 * @label:  (Optional) Descriptive name for GPIO controller.
 *   If not given, the name of the device is used.
 * @ngpio:  (Optional) Number of GPIOs
 * @names:  (Optional) Array of names for gpios
 * @reg_dat_base: (Optional) (in) register base address
 * @reg_set_base: (Optional) set register base address
 * @reg_clr_base: (Optional) clear register base address
 * @reg_dir_in_base: (Optional) in setting register base address
 * @reg_dir_out_base: (Optional) out setting register base address
 * @reg_stride:  (Optional) May be set if the registers (of the
 *   same type, dat, set, etc) are not consecutive.
 * @ngpio_per_reg: (Optional) Number of GPIOs per register
 * @irq_domain:  (Optional) IRQ domain if the controller is
 *   interrupt-capable
 * @reg_mask_xlate:     (Optional) Translates base address and GPIO
 *   offset to a register/bitmask pair. If not
 *   given the default gpio_regmap_simple_xlate()
 *   is used.
 * @fixed_direction_output:
 *   (Optional) Bitmap representing the fixed direction of
 *   the GPIO lines. Useful when there are GPIO lines with a
 *   fixed direction mixed together in the same register.
 * @drvdata:  (Optional) Pointer to driver specific data which is
 *   not used by gpio-remap but is provided "as is" to the
 *   driver callback(s).
 * @regmap_irq_chip: (Optional) Pointer on an regmap_irq_chip structure. If
 *   set, a regmap-irq device will be created and the IRQ
 *   domain will be set accordingly.
 * @regmap_irq_line (Optional) The IRQ the device uses to signal interrupts.
 * @regmap_irq_flags (Optional) The IRQF_ flags to use for the interrupt.
 *
 * The ->reg_mask_xlate translates a given base address and GPIO offset to
 * register and mask pair. The base address is one of the given register
 * base addresses in this structure.
 *
 * Although all register base addresses are marked as optional, there are
 * several rules:
 *     1. if you only have @reg_dat_base set, then it is input-only
 *     2. if you only have @reg_set_base set, then it is output-only
 *     3. if you have either @reg_dir_in_base or @reg_dir_out_base set, then
 *        you have to set both @reg_dat_base and @reg_set_base
 *     4. if you have @reg_set_base set, you may also set @reg_clr_base to have
 *        two different registers for setting and clearing the output. This is
 *        also valid for the output-only case.
 *     5. @reg_dir_in_base and @reg_dir_out_base are exclusive; is there really
 *        hardware which has redundant registers?
 *
 * Note: All base addresses may have the special value %GPIO_REGMAP_ADDR_ZERO
 * which forces the address to the value 0.
 */
struct gpio_regmap_config {
 struct device *parent;
 struct regmap *regmap;
 struct fwnode_handle *fwnode;

 const char *label;
 int ngpio;
 const char *const *names;

 unsigned int reg_dat_base;
 unsigned int reg_set_base;
 unsigned int reg_clr_base;
 unsigned int reg_dir_in_base;
 unsigned int reg_dir_out_base;
 int reg_stride;
 int ngpio_per_reg;
 struct irq_domain *irq_domain;
 unsigned long *fixed_direction_output;

#ifdef CONFIG_REGMAP_IRQ
 struct regmap_irq_chip *regmap_irq_chip;
 int regmap_irq_line;
 unsigned long regmap_irq_flags;
#endif

 int (*reg_mask_xlate)(struct gpio_regmap *gpio, unsigned int base,
         unsigned int offset, unsigned int *reg,
         unsigned int *mask);

 void *drvdata;
};

struct gpio_regmap *gpio_regmap_register(const struct gpio_regmap_config *config);
void gpio_regmap_unregister(struct gpio_regmap *gpio);
struct gpio_regmap *devm_gpio_regmap_register(struct device *dev,
           const struct gpio_regmap_config *config);
void *gpio_regmap_get_drvdata(struct gpio_regmap *gpio);

#endif /* _LINUX_GPIO_REGMAP_H */