1 files changed, 177 insertions, 15 deletions

diff --git a/include/linux/regmap.h b/include/linux/regmap.h
index e3bcc3f4dcb8..bf77dfdabef9 100644
--- a/include/linux/regmap.h
+++ b/include/linux/regmap.h
@@ -19,6 +19,7 @@
 struct module;
 struct device;
 struct i2c_client;
+struct irq_domain;
 struct spi_device;
 struct regmap;
 struct regmap_range_cfg;
@@ -27,7 +28,8 @@ struct regmap_range_cfg;
 enum regcache_type {
         REGCACHE_NONE,
         REGCACHE_RBTREE,
-        REGCACHE_COMPRESSED
+        REGCACHE_COMPRESSED,
+        REGCACHE_FLAT,
 };
 
 /**
@@ -54,6 +56,39 @@ enum regmap_endian {
 };
 
 /**
+ * A register range, used for access related checks
+ * (readable/writeable/volatile/precious checks)
+ *
+ * @range_min: address of first register
+ * @range_max: address of last register
+ */
+struct regmap_range {
+        unsigned int range_min;
+        unsigned int range_max;
+};
+
+/*
+ * A table of ranges including some yes ranges and some no ranges.
+ * If a register belongs to a no_range, the corresponding check function
+ * will return false. If a register belongs to a yes range, the corresponding
+ * check function will return true. "no_ranges" are searched first.
+ *
+ * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
+ * @n_yes_ranges: size of the above array
+ * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
+ * @n_no_ranges: size of the above array
+ */
+struct regmap_access_table {
+        const struct regmap_range *yes_ranges;
+        unsigned int n_yes_ranges;
+        const struct regmap_range *no_ranges;
+        unsigned int n_no_ranges;
+};
+
+typedef void (*regmap_lock)(void *);
+typedef void (*regmap_unlock)(void *);
+
+/**
  * Configuration for the register map of a device.
  *
  * @name: Optional name of the regmap. Useful when a device has multiple
@@ -67,16 +102,50 @@ enum regmap_endian {
  * @val_bits: Number of bits in a register value, mandatory.
  *
  * @writeable_reg: Optional callback returning true if the register
- *                 can be written to.
+ *                 can be written to. If this field is NULL but wr_table
+ *                 (see below) is not, the check is performed on such table
+ *                 (a register is writeable if it belongs to one of the ranges
+ *                  specified by wr_table).
  * @readable_reg: Optional callback returning true if the register
- *                can be read from.
+ *                can be read from. If this field is NULL but rd_table
+ *                 (see below) is not, the check is performed on such table
+ *                 (a register is readable if it belongs to one of the ranges
+ *                  specified by rd_table).
  * @volatile_reg: Optional callback returning true if the register
- *                value can't be cached.
+ *                value can't be cached. If this field is NULL but
+ *                volatile_table (see below) is not, the check is performed on
+ *                such table (a register is volatile if it belongs to one of
+ *                the ranges specified by volatile_table).
  * @precious_reg: Optional callback returning true if the rgister
- *                should not be read outside of a call from the driver
- *                (eg, a clear on read interrupt status register).
- *
+ *                should not be read outside of a call from the driver
+ *                (eg, a clear on read interrupt status register). If this
+ *                field is NULL but precious_table (see below) is not, the
+ *                check is performed on such table (a register is precious if
+ *                it belongs to one of the ranges specified by precious_table).
+ * @lock:         Optional lock callback (overrides regmap's default lock
+ *                function, based on spinlock or mutex).
+ * @unlock:       As above for unlocking.
+ * @lock_arg:     this field is passed as the only argument of lock/unlock
+ *                functions (ignored in case regular lock/unlock functions
+ *                are not overridden).
+ * @reg_read:     Optional callback that if filled will be used to perform
+ *                all the reads from the registers. Should only be provided for
+ *                devices whos read operation cannot be represented as a simple read
+ *                operation on a bus such as SPI, I2C, etc. Most of the devices do
+ *                not need this.
+ * @reg_write:    Same as above for writing.
+ * @fast_io:      Register IO is fast. Use a spinlock instead of a mutex
+ *                to perform locking. This field is ignored if custom lock/unlock
+ *                functions are used (see fields lock/unlock of struct regmap_config).
+ *                This field is a duplicate of a similar file in
+ *                'struct regmap_bus' and serves exact same purpose.
+ *                 Use it only for "no-bus" cases.
  * @max_register: Optional, specifies the maximum valid register index.
+ * @wr_table:     Optional, points to a struct regmap_access_table specifying
+ *                valid ranges for write access.
+ * @rd_table:     As above, for read access.
+ * @volatile_table: As above, for volatile registers.
+ * @precious_table: As above, for precious registers.
  * @reg_defaults: Power on reset values for registers (for use with
  *                register cache support).
  * @num_reg_defaults: Number of elements in reg_defaults.
@@ -116,8 +185,20 @@ struct regmap_config {
         bool (*readable_reg)(struct device *dev, unsigned int reg);
         bool (*volatile_reg)(struct device *dev, unsigned int reg);
         bool (*precious_reg)(struct device *dev, unsigned int reg);
+        regmap_lock lock;
+        regmap_unlock unlock;
+        void *lock_arg;
+
+        int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
+        int (*reg_write)(void *context, unsigned int reg, unsigned int val);
+
+        bool fast_io;
 
         unsigned int max_register;
+        const struct regmap_access_table *wr_table;
+        const struct regmap_access_table *rd_table;
+        const struct regmap_access_table *volatile_table;
+        const struct regmap_access_table *precious_table;
         const struct reg_default *reg_defaults;
         unsigned int num_reg_defaults;
         enum regcache_type cache_type;
@@ -133,7 +214,7 @@ struct regmap_config {
         enum regmap_endian val_format_endian;
 
         const struct regmap_range_cfg *ranges;
-        unsigned int n_ranges;
+        unsigned int num_ranges;
 };
 
 /**
@@ -142,6 +223,8 @@ struct regmap_config {
  *     1. page selector register update;
  *     2. access through data window registers.
  *
+ * @name: Descriptive name for diagnostics
+ *
  * @range_min: Address of the lowest register address in virtual range.
  * @range_max: Address of the highest register in virtual range.
  *
@@ -153,6 +236,8 @@ struct regmap_config {
  * @window_len: Number of registers in data window.
  */
 struct regmap_range_cfg {
+        const char *name;
+
         /* Registers of virtual address range */
         unsigned int range_min;
         unsigned int range_max;
@@ -167,26 +252,38 @@ struct regmap_range_cfg {
         unsigned int window_len;
 };
 
+struct regmap_async;
+
 typedef int (*regmap_hw_write)(void *context, const void *data,
                                size_t count);
 typedef int (*regmap_hw_gather_write)(void *context,
                                       const void *reg, size_t reg_len,
                                       const void *val, size_t val_len);
+typedef int (*regmap_hw_async_write)(void *context,
+                                     const void *reg, size_t reg_len,
+                                     const void *val, size_t val_len,
+                                     struct regmap_async *async);
 typedef int (*regmap_hw_read)(void *context,
                               const void *reg_buf, size_t reg_size,
                               void *val_buf, size_t val_size);
+typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
 typedef void (*regmap_hw_free_context)(void *context);
 
 /**
  * Description of a hardware bus for the register map infrastructure.
  *
  * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
- *           to perform locking.
+ *           to perform locking. This field is ignored if custom lock/unlock
+ *           functions are used (see fields lock/unlock of
+ *           struct regmap_config).
  * @write: Write operation.
  * @gather_write: Write operation with split register/value, return -ENOTSUPP
  *                if not implemented  on a given device.
+ * @async_write: Write operation which completes asynchronously, optional and
+ *               must serialise with respect to non-async I/O.
  * @read: Read operation.  Data is returned in the buffer used to transmit
  *         data.
+ * @async_alloc: Allocate a regmap_async() structure.
  * @read_flag_mask: Mask to be set in the top byte of the register when doing
  *                  a read.
  * @reg_format_endian_default: Default endianness for formatted register
@@ -195,13 +292,16 @@ typedef void (*regmap_hw_free_context)(void *context);
  * @val_format_endian_default: Default endianness for formatted register
  *     values. Used when the regmap_config specifies DEFAULT. If this is
  *     DEFAULT, BIG is assumed.
+ * @async_size: Size of struct used for async work.
  */
 struct regmap_bus {
         bool fast_io;
         regmap_hw_write write;
         regmap_hw_gather_write gather_write;
+        regmap_hw_async_write async_write;
         regmap_hw_read read;
         regmap_hw_free_context free_context;
+        regmap_hw_async_alloc async_alloc;
         u8 read_flag_mask;
         enum regmap_endian reg_format_endian_default;
         enum regmap_endian val_format_endian_default;
@@ -215,9 +315,9 @@ struct regmap *regmap_init_i2c(struct i2c_client *i2c,
                                const struct regmap_config *config);
 struct regmap *regmap_init_spi(struct spi_device *dev,
                                const struct regmap_config *config);
-struct regmap *regmap_init_mmio(struct device *dev,
-                                void __iomem *regs,
-                                const struct regmap_config *config);
+struct regmap *regmap_init_mmio_clk(struct device *dev, const char *clk_id,
+                                    void __iomem *regs,
+                                    const struct regmap_config *config);
 
 struct regmap *devm_regmap_init(struct device *dev,
                                 const struct regmap_bus *bus,
@@ -227,9 +327,44 @@ struct regmap *devm_regmap_init_i2c(struct i2c_client *i2c,
                                     const struct regmap_config *config);
 struct regmap *devm_regmap_init_spi(struct spi_device *dev,
                                     const struct regmap_config *config);
-struct regmap *devm_regmap_init_mmio(struct device *dev,
-                                     void __iomem *regs,
-                                     const struct regmap_config *config);
+struct regmap *devm_regmap_init_mmio_clk(struct device *dev, const char *clk_id,
+                                         void __iomem *regs,
+                                         const struct regmap_config *config);
+
+/**
+ * regmap_init_mmio(): Initialise register map
+ *
+ * @dev: Device that will be interacted with
+ * @regs: Pointer to memory-mapped IO region
+ * @config: Configuration for register map
+ *
+ * The return value will be an ERR_PTR() on error or a valid pointer to
+ * a struct regmap.
+ */
+static inline struct regmap *regmap_init_mmio(struct device *dev,
+                                        void __iomem *regs,
+                                        const struct regmap_config *config)
+{
+        return regmap_init_mmio_clk(dev, NULL, regs, config);
+}
+
+/**
+ * devm_regmap_init_mmio(): Initialise managed register map
+ *
+ * @dev: Device that will be interacted with
+ * @regs: Pointer to memory-mapped IO region
+ * @config: Configuration for register map
+ *
+ * The return value will be an ERR_PTR() on error or a valid pointer
+ * to a struct regmap.  The regmap will be automatically freed by the
+ * device management code.
+ */
+static inline struct regmap *devm_regmap_init_mmio(struct device *dev,
+                                        void __iomem *regs,
+                                        const struct regmap_config *config)
+{
+        return devm_regmap_init_mmio_clk(dev, NULL, regs, config);
+}
 
 void regmap_exit(struct regmap *map);
 int regmap_reinit_cache(struct regmap *map,
@@ -240,6 +375,8 @@ int regmap_raw_write(struct regmap *map, unsigned int reg,
                      const void *val, size_t val_len);
 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
                         size_t val_count);
+int regmap_raw_write_async(struct regmap *map, unsigned int reg,
+                           const void *val, size_t val_len);
 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
 int regmap_raw_read(struct regmap *map, unsigned int reg,
                     void *val, size_t val_len);
@@ -251,6 +388,7 @@ int regmap_update_bits_check(struct regmap *map, unsigned int reg,
                              unsigned int mask, unsigned int val,
                              bool *change);
 int regmap_get_val_bytes(struct regmap *map);
+int regmap_async_complete(struct regmap *map);
 
 int regcache_sync(struct regmap *map);
 int regcache_sync_region(struct regmap *map, unsigned int min,
@@ -262,6 +400,16 @@ void regcache_mark_dirty(struct regmap *map);
 int regmap_register_patch(struct regmap *map, const struct reg_default *regs,
                           int num_regs);
 
+static inline bool regmap_reg_in_range(unsigned int reg,
+                                       const struct regmap_range *range)
+{
+        return reg >= range->range_min && reg <= range->range_max;
+}
+
+bool regmap_reg_in_ranges(unsigned int reg,
+                          const struct regmap_range *ranges,
+                          unsigned int nranges);
+
 /**
  * Description of an IRQ for the generic regmap irq_chip.
  *
@@ -301,6 +449,7 @@ struct regmap_irq_chip {
         unsigned int wake_base;
         unsigned int irq_reg_stride;
         unsigned int mask_invert;
+        unsigned int wake_invert;
         bool runtime_pm;
 
         int num_regs;
@@ -317,6 +466,7 @@ int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
+struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
 
 #else
 
@@ -341,6 +491,13 @@ static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
         return -EINVAL;
 }
 
+static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
+                                         const void *val, size_t val_len)
+{
+        WARN_ONCE(1, "regmap API is disabled");
+        return -EINVAL;
+}
+
 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
                                     const void *val, size_t val_count)
 {
@@ -419,6 +576,11 @@ static inline void regcache_mark_dirty(struct regmap *map)
         WARN_ONCE(1, "regmap API is disabled");
 }
 
+static inline void regmap_async_complete(struct regmap *map)
+{
+        WARN_ONCE(1, "regmap API is disabled");
+}
+
 static inline int regmap_register_patch(struct regmap *map,
                                         const struct reg_default *regs,
                                         int num_regs)