include/linux/regmap.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 #ifndef __LINUX_REGMAP_H
   3 #define __LINUX_REGMAP_H
   4
   5 /*
   6  * Register map access API
   7  *
   8  * Copyright 2011 Wolfson Microelectronics plc
   9  *
  10  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
  11  */
  12
  13 #include <linux/list.h>
  14 #include <linux/rbtree.h>
  15 #include <linux/ktime.h>
  16 #include <linux/delay.h>
  17 #include <linux/err.h>
  18 #include <linux/bug.h>
  19 #include <linux/lockdep.h>
  20 #include <linux/iopoll.h>
  21 #include <linux/fwnode.h>
  22
  23 struct module;
  24 struct clk;
  25 struct device;
  26 struct device_node;
  27 struct i2c_client;
  28 struct i3c_device;
  29 struct irq_domain;
  30 struct slim_device;
  31 struct spi_device;
  32 struct spmi_device;
  33 struct regmap;
  34 struct regmap_range_cfg;
  35 struct regmap_field;
  36 struct snd_ac97;
  37 struct sdw_slave;
  38
  39 /* An enum of all the supported cache types */
  40 enum regcache_type {
  41         REGCACHE_NONE,
  42         REGCACHE_RBTREE,
  43         REGCACHE_COMPRESSED,
  44         REGCACHE_FLAT,
  45 };
  46
  47 /**
  48  * struct reg_default - Default value for a register.
  49  *
  50  * @reg: Register address.
  51  * @def: Register default value.
  52  *
  53  * We use an array of structs rather than a simple array as many modern devices
  54  * have very sparse register maps.
  55  */
  56 struct reg_default {
  57         unsigned int reg;
  58         unsigned int def;
  59 };
  60
  61 /**
  62  * struct reg_sequence - An individual write from a sequence of writes.
  63  *
  64  * @reg: Register address.
  65  * @def: Register value.
  66  * @delay_us: Delay to be applied after the register write in microseconds
  67  *
  68  * Register/value pairs for sequences of writes with an optional delay in
  69  * microseconds to be applied after each write.
  70  */
  71 struct reg_sequence {
  72         unsigned int reg;
  73         unsigned int def;
  74         unsigned int delay_us;
  75 };
  76
  77 #define REG_SEQ(_reg, _def, _delay_us) {                \
  78                                 .reg = _reg,            \
  79                                 .def = _def,            \
  80                                 .delay_us = _delay_us,  \
  81                                 }
  82 #define REG_SEQ0(_reg, _def)    REG_SEQ(_reg, _def, 0)
  83
  84 /**
  85  * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs
  86  *
  87  * @map: Regmap to read from
  88  * @addr: Address to poll
  89  * @val: Unsigned integer variable to read the value into
  90  * @cond: Break condition (usually involving @val)
  91  * @sleep_us: Maximum time to sleep between reads in us (0
  92  *            tight-loops).  Should be less than ~20ms since usleep_range
  93  *            is used (see Documentation/timers/timers-howto.rst).
  94  * @timeout_us: Timeout in us, 0 means never timeout
  95  *
  96  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
  97  * error return value in case of a error read. In the two former cases,
  98  * the last read value at @addr is stored in @val. Must not be called
  99  * from atomic context if sleep_us or timeout_us are used.
 100  *
 101  * This is modelled after the readx_poll_timeout macros in linux/iopoll.h.
 102  */
 103 #define regmap_read_poll_timeout(map, addr, val, cond, sleep_us, timeout_us) \
 104 ({ \
 105         int __ret, __tmp; \
 106         __tmp = read_poll_timeout(regmap_read, __ret, __ret || (cond), \
 107                         sleep_us, timeout_us, false, (map), (addr), &(val)); \
 108         __ret ?: __tmp; \
 109 })
 110
 111 /**
 112  * regmap_read_poll_timeout_atomic - Poll until a condition is met or a timeout occurs
 113  *
 114  * @map: Regmap to read from
 115  * @addr: Address to poll
 116  * @val: Unsigned integer variable to read the value into
 117  * @cond: Break condition (usually involving @val)
 118  * @delay_us: Time to udelay between reads in us (0 tight-loops).
 119  *            Should be less than ~10us since udelay is used
 120  *            (see Documentation/timers/timers-howto.rst).
 121  * @timeout_us: Timeout in us, 0 means never timeout
 122  *
 123  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
 124  * error return value in case of a error read. In the two former cases,
 125  * the last read value at @addr is stored in @val.
 126  *
 127  * This is modelled after the readx_poll_timeout_atomic macros in linux/iopoll.h.
 128  *
 129  * Note: In general regmap cannot be used in atomic context. If you want to use
 130  * this macro then first setup your regmap for atomic use (flat or no cache
 131  * and MMIO regmap).
 132  */
 133 #define regmap_read_poll_timeout_atomic(map, addr, val, cond, delay_us, timeout_us) \
 134 ({ \
 135         u64 __timeout_us = (timeout_us); \
 136         unsigned long __delay_us = (delay_us); \
 137         ktime_t __timeout = ktime_add_us(ktime_get(), __timeout_us); \
 138         int __ret; \
 139         for (;;) { \
 140                 __ret = regmap_read((map), (addr), &(val)); \
 141                 if (__ret) \
 142                         break; \
 143                 if (cond) \
 144                         break; \
 145                 if ((__timeout_us) && \
 146                     ktime_compare(ktime_get(), __timeout) > 0) { \
 147                         __ret = regmap_read((map), (addr), &(val)); \
 148                         break; \
 149                 } \
 150                 if (__delay_us) \
 151                         udelay(__delay_us); \
 152         } \
 153         __ret ?: ((cond) ? 0 : -ETIMEDOUT); \
 154 })
 155
 156 /**
 157  * regmap_field_read_poll_timeout - Poll until a condition is met or timeout
 158  *
 159  * @field: Regmap field to read from
 160  * @val: Unsigned integer variable to read the value into
 161  * @cond: Break condition (usually involving @val)
 162  * @sleep_us: Maximum time to sleep between reads in us (0
 163  *            tight-loops).  Should be less than ~20ms since usleep_range
 164  *            is used (see Documentation/timers/timers-howto.rst).
 165  * @timeout_us: Timeout in us, 0 means never timeout
 166  *
 167  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read
 168  * error return value in case of a error read. In the two former cases,
 169  * the last read value at @addr is stored in @val. Must not be called
 170  * from atomic context if sleep_us or timeout_us are used.
 171  *
 172  * This is modelled after the readx_poll_timeout macros in linux/iopoll.h.
 173  */
 174 #define regmap_field_read_poll_timeout(field, val, cond, sleep_us, timeout_us) \
 175 ({ \
 176         int __ret, __tmp; \
 177         __tmp = read_poll_timeout(regmap_field_read, __ret, __ret || (cond), \
 178                         sleep_us, timeout_us, false, (field), &(val)); \
 179         __ret ?: __tmp; \
 180 })
 181
 182 #ifdef CONFIG_REGMAP
 183
 184 enum regmap_endian {
 185         /* Unspecified -> 0 -> Backwards compatible default */
 186         REGMAP_ENDIAN_DEFAULT = 0,
 187         REGMAP_ENDIAN_BIG,
 188         REGMAP_ENDIAN_LITTLE,
 189         REGMAP_ENDIAN_NATIVE,
 190 };
 191
 192 /**
 193  * struct regmap_range - A register range, used for access related checks
 194  *                       (readable/writeable/volatile/precious checks)
 195  *
 196  * @range_min: address of first register
 197  * @range_max: address of last register
 198  */
 199 struct regmap_range {
 200         unsigned int range_min;
 201         unsigned int range_max;
 202 };
 203
 204 #define regmap_reg_range(low, high) { .range_min = low, .range_max = high, }
 205
 206 /**
 207  * struct regmap_access_table - A table of register ranges for access checks
 208  *
 209  * @yes_ranges : pointer to an array of regmap ranges used as "yes ranges"
 210  * @n_yes_ranges: size of the above array
 211  * @no_ranges: pointer to an array of regmap ranges used as "no ranges"
 212  * @n_no_ranges: size of the above array
 213  *
 214  * A table of ranges including some yes ranges and some no ranges.
 215  * If a register belongs to a no_range, the corresponding check function
 216  * will return false. If a register belongs to a yes range, the corresponding
 217  * check function will return true. "no_ranges" are searched first.
 218  */
 219 struct regmap_access_table {
 220         const struct regmap_range *yes_ranges;
 221         unsigned int n_yes_ranges;
 222         const struct regmap_range *no_ranges;
 223         unsigned int n_no_ranges;
 224 };
 225
 226 typedef void (*regmap_lock)(void *);
 227 typedef void (*regmap_unlock)(void *);
 228
 229 /**
 230  * struct regmap_config - Configuration for the register map of a device.
 231  *
 232  * @name: Optional name of the regmap. Useful when a device has multiple
 233  *        register regions.
 234  *
 235  * @reg_bits: Number of bits in a register address, mandatory.
 236  * @reg_stride: The register address stride. Valid register addresses are a
 237  *              multiple of this value. If set to 0, a value of 1 will be
 238  *              used.
 239  * @pad_bits: Number of bits of padding between register and value.
 240  * @val_bits: Number of bits in a register value, mandatory.
 241  *
 242  * @writeable_reg: Optional callback returning true if the register
 243  *                 can be written to. If this field is NULL but wr_table
 244  *                 (see below) is not, the check is performed on such table
 245  *                 (a register is writeable if it belongs to one of the ranges
 246  *                  specified by wr_table).
 247  * @readable_reg: Optional callback returning true if the register
 248  *                can be read from. If this field is NULL but rd_table
 249  *                 (see below) is not, the check is performed on such table
 250  *                 (a register is readable if it belongs to one of the ranges
 251  *                  specified by rd_table).
 252  * @volatile_reg: Optional callback returning true if the register
 253  *                value can't be cached. If this field is NULL but
 254  *                volatile_table (see below) is not, the check is performed on
 255  *                such table (a register is volatile if it belongs to one of
 256  *                the ranges specified by volatile_table).
 257  * @precious_reg: Optional callback returning true if the register
 258  *                should not be read outside of a call from the driver
 259  *                (e.g., a clear on read interrupt status register). If this
 260  *                field is NULL but precious_table (see below) is not, the
 261  *                check is performed on such table (a register is precious if
 262  *                it belongs to one of the ranges specified by precious_table).
 263  * @writeable_noinc_reg: Optional callback returning true if the register
 264  *                      supports multiple write operations without incrementing
 265  *                      the register number. If this field is NULL but
 266  *                      wr_noinc_table (see below) is not, the check is
 267  *                      performed on such table (a register is no increment
 268  *                      writeable if it belongs to one of the ranges specified
 269  *                      by wr_noinc_table).
 270  * @readable_noinc_reg: Optional callback returning true if the register
 271  *                      supports multiple read operations without incrementing
 272  *                      the register number. If this field is NULL but
 273  *                      rd_noinc_table (see below) is not, the check is
 274  *                      performed on such table (a register is no increment
 275  *                      readable if it belongs to one of the ranges specified
 276  *                      by rd_noinc_table).
 277  * @disable_locking: This regmap is either protected by external means or
 278  *                   is guaranteed not to be accessed from multiple threads.
 279  *                   Don't use any locking mechanisms.
 280  * @lock:         Optional lock callback (overrides regmap's default lock
 281  *                function, based on spinlock or mutex).
 282  * @unlock:       As above for unlocking.
 283  * @lock_arg:     this field is passed as the only argument of lock/unlock
 284  *                functions (ignored in case regular lock/unlock functions
 285  *                are not overridden).
 286  * @reg_read:     Optional callback that if filled will be used to perform
 287  *                all the reads from the registers. Should only be provided for
 288  *                devices whose read operation cannot be represented as a simple
 289  *                read operation on a bus such as SPI, I2C, etc. Most of the
 290  *                devices do not need this.
 291  * @reg_write:    Same as above for writing.
 292  * @fast_io:      Register IO is fast. Use a spinlock instead of a mutex
 293  *                to perform locking. This field is ignored if custom lock/unlock
 294  *                functions are used (see fields lock/unlock of struct regmap_config).
 295  *                This field is a duplicate of a similar file in
 296  *                'struct regmap_bus' and serves exact same purpose.
 297  *                 Use it only for "no-bus" cases.
 298  * @max_register: Optional, specifies the maximum valid register address.
 299  * @wr_table:     Optional, points to a struct regmap_access_table specifying
 300  *                valid ranges for write access.
 301  * @rd_table:     As above, for read access.
 302  * @volatile_table: As above, for volatile registers.
 303  * @precious_table: As above, for precious registers.
 304  * @wr_noinc_table: As above, for no increment writeable registers.
 305  * @rd_noinc_table: As above, for no increment readable registers.
 306  * @reg_defaults: Power on reset values for registers (for use with
 307  *                register cache support).
 308  * @num_reg_defaults: Number of elements in reg_defaults.
 309  *
 310  * @read_flag_mask: Mask to be set in the top bytes of the register when doing
 311  *                  a read.
 312  * @write_flag_mask: Mask to be set in the top bytes of the register when doing
 313  *                   a write. If both read_flag_mask and write_flag_mask are
 314  *                   empty and zero_flag_mask is not set the regmap_bus default
 315  *                   masks are used.
 316  * @zero_flag_mask: If set, read_flag_mask and write_flag_mask are used even
 317  *                   if they are both empty.
 318  * @use_single_read: If set, converts the bulk read operation into a series of
 319  *                   single read operations. This is useful for a device that
 320  *                   does not support  bulk read.
 321  * @use_single_write: If set, converts the bulk write operation into a series of
 322  *                    single write operations. This is useful for a device that
 323  *                    does not support bulk write.
 324  * @can_multi_write: If set, the device supports the multi write mode of bulk
 325  *                   write operations, if clear multi write requests will be
 326  *                   split into individual write operations
 327  *
 328  * @cache_type: The actual cache type.
 329  * @reg_defaults_raw: Power on reset values for registers (for use with
 330  *                    register cache support).
 331  * @num_reg_defaults_raw: Number of elements in reg_defaults_raw.
 332  * @reg_format_endian: Endianness for formatted register addresses. If this is
 333  *                     DEFAULT, the @reg_format_endian_default value from the
 334  *                     regmap bus is used.
 335  * @val_format_endian: Endianness for formatted register values. If this is
 336  *                     DEFAULT, the @reg_format_endian_default value from the
 337  *                     regmap bus is used.
 338  *
 339  * @ranges: Array of configuration entries for virtual address ranges.
 340  * @num_ranges: Number of range configuration entries.
 341  * @use_hwlock: Indicate if a hardware spinlock should be used.
 342  * @hwlock_id: Specify the hardware spinlock id.
 343  * @hwlock_mode: The hardware spinlock mode, should be HWLOCK_IRQSTATE,
 344  *               HWLOCK_IRQ or 0.
 345  * @can_sleep: Optional, specifies whether regmap operations can sleep.
 346  */
 347 struct regmap_config {
 348         const char *name;
 349
 350         int reg_bits;
 351         int reg_stride;
 352         int pad_bits;
 353         int val_bits;
 354
 355         bool (*writeable_reg)(struct device *dev, unsigned int reg);
 356         bool (*readable_reg)(struct device *dev, unsigned int reg);
 357         bool (*volatile_reg)(struct device *dev, unsigned int reg);
 358         bool (*precious_reg)(struct device *dev, unsigned int reg);
 359         bool (*writeable_noinc_reg)(struct device *dev, unsigned int reg);
 360         bool (*readable_noinc_reg)(struct device *dev, unsigned int reg);
 361
 362         bool disable_locking;
 363         regmap_lock lock;
 364         regmap_unlock unlock;
 365         void *lock_arg;
 366
 367         int (*reg_read)(void *context, unsigned int reg, unsigned int *val);
 368         int (*reg_write)(void *context, unsigned int reg, unsigned int val);
 369
 370         bool fast_io;
 371
 372         unsigned int max_register;
 373         const struct regmap_access_table *wr_table;
 374         const struct regmap_access_table *rd_table;
 375         const struct regmap_access_table *volatile_table;
 376         const struct regmap_access_table *precious_table;
 377         const struct regmap_access_table *wr_noinc_table;
 378         const struct regmap_access_table *rd_noinc_table;
 379         const struct reg_default *reg_defaults;
 380         unsigned int num_reg_defaults;
 381         enum regcache_type cache_type;
 382         const void *reg_defaults_raw;
 383         unsigned int num_reg_defaults_raw;
 384
 385         unsigned long read_flag_mask;
 386         unsigned long write_flag_mask;
 387         bool zero_flag_mask;
 388
 389         bool use_single_read;
 390         bool use_single_write;
 391         bool can_multi_write;
 392
 393         enum regmap_endian reg_format_endian;
 394         enum regmap_endian val_format_endian;
 395
 396         const struct regmap_range_cfg *ranges;
 397         unsigned int num_ranges;
 398
 399         bool use_hwlock;
 400         unsigned int hwlock_id;
 401         unsigned int hwlock_mode;
 402
 403         bool can_sleep;
 404 };
 405
 406 /**
 407  * struct regmap_range_cfg - Configuration for indirectly accessed or paged
 408  *                           registers.
 409  *
 410  * @name: Descriptive name for diagnostics
 411  *
 412  * @range_min: Address of the lowest register address in virtual range.
 413  * @range_max: Address of the highest register in virtual range.
 414  *
 415  * @selector_reg: Register with selector field.
 416  * @selector_mask: Bit mask for selector value.
 417  * @selector_shift: Bit shift for selector value.
 418  *
 419  * @window_start: Address of first (lowest) register in data window.
 420  * @window_len: Number of registers in data window.
 421  *
 422  * Registers, mapped to this virtual range, are accessed in two steps:
 423  *     1. page selector register update;
 424  *     2. access through data window registers.
 425  */
 426 struct regmap_range_cfg {
 427         const char *name;
 428
 429         /* Registers of virtual address range */
 430         unsigned int range_min;
 431         unsigned int range_max;
 432
 433         /* Page selector for indirect addressing */
 434         unsigned int selector_reg;
 435         unsigned int selector_mask;
 436         int selector_shift;
 437
 438         /* Data window (per each page) */
 439         unsigned int window_start;
 440         unsigned int window_len;
 441 };
 442
 443 struct regmap_async;
 444
 445 typedef int (*regmap_hw_write)(void *context, const void *data,
 446                                size_t count);
 447 typedef int (*regmap_hw_gather_write)(void *context,
 448                                       const void *reg, size_t reg_len,
 449                                       const void *val, size_t val_len);
 450 typedef int (*regmap_hw_async_write)(void *context,
 451                                      const void *reg, size_t reg_len,
 452                                      const void *val, size_t val_len,
 453                                      struct regmap_async *async);
 454 typedef int (*regmap_hw_read)(void *context,
 455                               const void *reg_buf, size_t reg_size,
 456                               void *val_buf, size_t val_size);
 457 typedef int (*regmap_hw_reg_read)(void *context, unsigned int reg,
 458                                   unsigned int *val);
 459 typedef int (*regmap_hw_reg_write)(void *context, unsigned int reg,
 460                                    unsigned int val);
 461 typedef int (*regmap_hw_reg_update_bits)(void *context, unsigned int reg,
 462                                          unsigned int mask, unsigned int val);
 463 typedef struct regmap_async *(*regmap_hw_async_alloc)(void);
 464 typedef void (*regmap_hw_free_context)(void *context);
 465
 466 /**
 467  * struct regmap_bus - Description of a hardware bus for the register map
 468  *                     infrastructure.
 469  *
 470  * @fast_io: Register IO is fast. Use a spinlock instead of a mutex
 471  *           to perform locking. This field is ignored if custom lock/unlock
 472  *           functions are used (see fields lock/unlock of
 473  *           struct regmap_config).
 474  * @write: Write operation.
 475  * @gather_write: Write operation with split register/value, return -ENOTSUPP
 476  *                if not implemented  on a given device.
 477  * @async_write: Write operation which completes asynchronously, optional and
 478  *               must serialise with respect to non-async I/O.
 479  * @reg_write: Write a single register value to the given register address. This
 480  *             write operation has to complete when returning from the function.
 481  * @reg_update_bits: Update bits operation to be used against volatile
 482  *                   registers, intended for devices supporting some mechanism
 483  *                   for setting clearing bits without having to
 484  *                   read/modify/write.
 485  * @read: Read operation.  Data is returned in the buffer used to transmit
 486  *         data.
 487  * @reg_read: Read a single register value from a given register address.
 488  * @free_context: Free context.
 489  * @async_alloc: Allocate a regmap_async() structure.
 490  * @read_flag_mask: Mask to be set in the top byte of the register when doing
 491  *                  a read.
 492  * @reg_format_endian_default: Default endianness for formatted register
 493  *     addresses. Used when the regmap_config specifies DEFAULT. If this is
 494  *     DEFAULT, BIG is assumed.
 495  * @val_format_endian_default: Default endianness for formatted register
 496  *     values. Used when the regmap_config specifies DEFAULT. If this is
 497  *     DEFAULT, BIG is assumed.
 498  * @max_raw_read: Max raw read size that can be used on the bus.
 499  * @max_raw_write: Max raw write size that can be used on the bus.
 500  */
 501 struct regmap_bus {
 502         bool fast_io;
 503         regmap_hw_write write;
 504         regmap_hw_gather_write gather_write;
 505         regmap_hw_async_write async_write;
 506         regmap_hw_reg_write reg_write;
 507         regmap_hw_reg_update_bits reg_update_bits;
 508         regmap_hw_read read;
 509         regmap_hw_reg_read reg_read;
 510         regmap_hw_free_context free_context;
 511         regmap_hw_async_alloc async_alloc;
 512         u8 read_flag_mask;
 513         enum regmap_endian reg_format_endian_default;
 514         enum regmap_endian val_format_endian_default;
 515         size_t max_raw_read;
 516         size_t max_raw_write;
 517 };
 518
 519 /*
 520  * __regmap_init functions.
 521  *
 522  * These functions take a lock key and name parameter, and should not be called
 523  * directly. Instead, use the regmap_init macros that generate a key and name
 524  * for each call.
 525  */
 526 struct regmap *__regmap_init(struct device *dev,
 527                              const struct regmap_bus *bus,
 528                              void *bus_context,
 529                              const struct regmap_config *config,
 530                              struct lock_class_key *lock_key,
 531                              const char *lock_name);
 532 struct regmap *__regmap_init_i2c(struct i2c_client *i2c,
 533                                  const struct regmap_config *config,
 534                                  struct lock_class_key *lock_key,
 535                                  const char *lock_name);
 536 struct regmap *__regmap_init_sccb(struct i2c_client *i2c,
 537                                   const struct regmap_config *config,
 538                                   struct lock_class_key *lock_key,
 539                                   const char *lock_name);
 540 struct regmap *__regmap_init_slimbus(struct slim_device *slimbus,
 541                                  const struct regmap_config *config,
 542                                  struct lock_class_key *lock_key,
 543                                  const char *lock_name);
 544 struct regmap *__regmap_init_spi(struct spi_device *dev,
 545                                  const struct regmap_config *config,
 546                                  struct lock_class_key *lock_key,
 547                                  const char *lock_name);
 548 struct regmap *__regmap_init_spmi_base(struct spmi_device *dev,
 549                                        const struct regmap_config *config,
 550                                        struct lock_class_key *lock_key,
 551                                        const char *lock_name);
 552 struct regmap *__regmap_init_spmi_ext(struct spmi_device *dev,
 553                                       const struct regmap_config *config,
 554                                       struct lock_class_key *lock_key,
 555                                       const char *lock_name);
 556 struct regmap *__regmap_init_w1(struct device *w1_dev,
 557                                  const struct regmap_config *config,
 558                                  struct lock_class_key *lock_key,
 559                                  const char *lock_name);
 560 struct regmap *__regmap_init_mmio_clk(struct device *dev, const char *clk_id,
 561                                       void __iomem *regs,
 562                                       const struct regmap_config *config,
 563                                       struct lock_class_key *lock_key,
 564                                       const char *lock_name);
 565 struct regmap *__regmap_init_ac97(struct snd_ac97 *ac97,
 566                                   const struct regmap_config *config,
 567                                   struct lock_class_key *lock_key,
 568                                   const char *lock_name);
 569 struct regmap *__regmap_init_sdw(struct sdw_slave *sdw,
 570                                  const struct regmap_config *config,
 571                                  struct lock_class_key *lock_key,
 572                                  const char *lock_name);
 573 struct regmap *__regmap_init_spi_avmm(struct spi_device *spi,
 574                                       const struct regmap_config *config,
 575                                       struct lock_class_key *lock_key,
 576                                       const char *lock_name);
 577
 578 struct regmap *__devm_regmap_init(struct device *dev,
 579                                   const struct regmap_bus *bus,
 580                                   void *bus_context,
 581                                   const struct regmap_config *config,
 582                                   struct lock_class_key *lock_key,
 583                                   const char *lock_name);
 584 struct regmap *__devm_regmap_init_i2c(struct i2c_client *i2c,
 585                                       const struct regmap_config *config,
 586                                       struct lock_class_key *lock_key,
 587                                       const char *lock_name);
 588 struct regmap *__devm_regmap_init_sccb(struct i2c_client *i2c,
 589                                        const struct regmap_config *config,
 590                                        struct lock_class_key *lock_key,
 591                                        const char *lock_name);
 592 struct regmap *__devm_regmap_init_spi(struct spi_device *dev,
 593                                       const struct regmap_config *config,
 594                                       struct lock_class_key *lock_key,
 595                                       const char *lock_name);
 596 struct regmap *__devm_regmap_init_spmi_base(struct spmi_device *dev,
 597                                             const struct regmap_config *config,
 598                                             struct lock_class_key *lock_key,
 599                                             const char *lock_name);
 600 struct regmap *__devm_regmap_init_spmi_ext(struct spmi_device *dev,
 601                                            const struct regmap_config *config,
 602                                            struct lock_class_key *lock_key,
 603                                            const char *lock_name);
 604 struct regmap *__devm_regmap_init_w1(struct device *w1_dev,
 605                                       const struct regmap_config *config,
 606                                       struct lock_class_key *lock_key,
 607                                       const char *lock_name);
 608 struct regmap *__devm_regmap_init_mmio_clk(struct device *dev,
 609                                            const char *clk_id,
 610                                            void __iomem *regs,
 611                                            const struct regmap_config *config,
 612                                            struct lock_class_key *lock_key,
 613                                            const char *lock_name);
 614 struct regmap *__devm_regmap_init_ac97(struct snd_ac97 *ac97,
 615                                        const struct regmap_config *config,
 616                                        struct lock_class_key *lock_key,
 617                                        const char *lock_name);
 618 struct regmap *__devm_regmap_init_sdw(struct sdw_slave *sdw,
 619                                  const struct regmap_config *config,
 620                                  struct lock_class_key *lock_key,
 621                                  const char *lock_name);
 622 struct regmap *__devm_regmap_init_slimbus(struct slim_device *slimbus,
 623                                  const struct regmap_config *config,
 624                                  struct lock_class_key *lock_key,
 625                                  const char *lock_name);
 626 struct regmap *__devm_regmap_init_i3c(struct i3c_device *i3c,
 627                                  const struct regmap_config *config,
 628                                  struct lock_class_key *lock_key,
 629                                  const char *lock_name);
 630 struct regmap *__devm_regmap_init_spi_avmm(struct spi_device *spi,
 631                                            const struct regmap_config *config,
 632                                            struct lock_class_key *lock_key,
 633                                            const char *lock_name);
 634 /*
 635  * Wrapper for regmap_init macros to include a unique lockdep key and name
 636  * for each call. No-op if CONFIG_LOCKDEP is not set.
 637  *
 638  * @fn: Real function to call (in the form __[*_]regmap_init[_*])
 639  * @name: Config variable name (#config in the calling macro)
 640  **/
 641 #ifdef CONFIG_LOCKDEP
 642 #define __regmap_lockdep_wrapper(fn, name, ...)                         \
 643 (                                                                       \
 644         ({                                                              \
 645                 static struct lock_class_key _key;                      \
 646                 fn(__VA_ARGS__, &_key,                                  \
 647                         KBUILD_BASENAME ":"                             \
 648                         __stringify(__LINE__) ":"                       \
 649                         "(" name ")->lock");                            \
 650         })                                                              \
 651 )
 652 #else
 653 #define __regmap_lockdep_wrapper(fn, name, ...) fn(__VA_ARGS__, NULL, NULL)
 654 #endif
 655
 656 /**
 657  * regmap_init() - Initialise register map
 658  *
 659  * @dev: Device that will be interacted with
 660  * @bus: Bus-specific callbacks to use with device
 661  * @bus_context: Data passed to bus-specific callbacks
 662  * @config: Configuration for register map
 663  *
 664  * The return value will be an ERR_PTR() on error or a valid pointer to
 665  * a struct regmap.  This function should generally not be called
 666  * directly, it should be called by bus-specific init functions.
 667  */
 668 #define regmap_init(dev, bus, bus_context, config)                      \
 669         __regmap_lockdep_wrapper(__regmap_init, #config,                \
 670                                 dev, bus, bus_context, config)
 671 int regmap_attach_dev(struct device *dev, struct regmap *map,
 672                       const struct regmap_config *config);
 673
 674 /**
 675  * regmap_init_i2c() - Initialise register map
 676  *
 677  * @i2c: Device that will be interacted with
 678  * @config: Configuration for register map
 679  *
 680  * The return value will be an ERR_PTR() on error or a valid pointer to
 681  * a struct regmap.
 682  */
 683 #define regmap_init_i2c(i2c, config)                                    \
 684         __regmap_lockdep_wrapper(__regmap_init_i2c, #config,            \
 685                                 i2c, config)
 686
 687 /**
 688  * regmap_init_sccb() - Initialise register map
 689  *
 690  * @i2c: Device that will be interacted with
 691  * @config: Configuration for register map
 692  *
 693  * The return value will be an ERR_PTR() on error or a valid pointer to
 694  * a struct regmap.
 695  */
 696 #define regmap_init_sccb(i2c, config)                                   \
 697         __regmap_lockdep_wrapper(__regmap_init_sccb, #config,           \
 698                                 i2c, config)
 699
 700 /**
 701  * regmap_init_slimbus() - Initialise register map
 702  *
 703  * @slimbus: Device that will be interacted with
 704  * @config: Configuration for register map
 705  *
 706  * The return value will be an ERR_PTR() on error or a valid pointer to
 707  * a struct regmap.
 708  */
 709 #define regmap_init_slimbus(slimbus, config)                            \
 710         __regmap_lockdep_wrapper(__regmap_init_slimbus, #config,        \
 711                                 slimbus, config)
 712
 713 /**
 714  * regmap_init_spi() - Initialise register map
 715  *
 716  * @dev: Device that will be interacted with
 717  * @config: Configuration for register map
 718  *
 719  * The return value will be an ERR_PTR() on error or a valid pointer to
 720  * a struct regmap.
 721  */
 722 #define regmap_init_spi(dev, config)                                    \
 723         __regmap_lockdep_wrapper(__regmap_init_spi, #config,            \
 724                                 dev, config)
 725
 726 /**
 727  * regmap_init_spmi_base() - Create regmap for the Base register space
 728  *
 729  * @dev:        SPMI device that will be interacted with
 730  * @config:     Configuration for register map
 731  *
 732  * The return value will be an ERR_PTR() on error or a valid pointer to
 733  * a struct regmap.
 734  */
 735 #define regmap_init_spmi_base(dev, config)                              \
 736         __regmap_lockdep_wrapper(__regmap_init_spmi_base, #config,      \
 737                                 dev, config)
 738
 739 /**
 740  * regmap_init_spmi_ext() - Create regmap for Ext register space
 741  *
 742  * @dev:        Device that will be interacted with
 743  * @config:     Configuration for register map
 744  *
 745  * The return value will be an ERR_PTR() on error or a valid pointer to
 746  * a struct regmap.
 747  */
 748 #define regmap_init_spmi_ext(dev, config)                               \
 749         __regmap_lockdep_wrapper(__regmap_init_spmi_ext, #config,       \
 750                                 dev, config)
 751
 752 /**
 753  * regmap_init_w1() - Initialise register map
 754  *
 755  * @w1_dev: Device that will be interacted with
 756  * @config: Configuration for register map
 757  *
 758  * The return value will be an ERR_PTR() on error or a valid pointer to
 759  * a struct regmap.
 760  */
 761 #define regmap_init_w1(w1_dev, config)                                  \
 762         __regmap_lockdep_wrapper(__regmap_init_w1, #config,             \
 763                                 w1_dev, config)
 764
 765 /**
 766  * regmap_init_mmio_clk() - Initialise register map with register clock
 767  *
 768  * @dev: Device that will be interacted with
 769  * @clk_id: register clock consumer ID
 770  * @regs: Pointer to memory-mapped IO region
 771  * @config: Configuration for register map
 772  *
 773  * The return value will be an ERR_PTR() on error or a valid pointer to
 774  * a struct regmap.
 775  */
 776 #define regmap_init_mmio_clk(dev, clk_id, regs, config)                 \
 777         __regmap_lockdep_wrapper(__regmap_init_mmio_clk, #config,       \
 778                                 dev, clk_id, regs, config)
 779
 780 /**
 781  * regmap_init_mmio() - Initialise register map
 782  *
 783  * @dev: Device that will be interacted with
 784  * @regs: Pointer to memory-mapped IO region
 785  * @config: Configuration for register map
 786  *
 787  * The return value will be an ERR_PTR() on error or a valid pointer to
 788  * a struct regmap.
 789  */
 790 #define regmap_init_mmio(dev, regs, config)             \
 791         regmap_init_mmio_clk(dev, NULL, regs, config)
 792
 793 /**
 794  * regmap_init_ac97() - Initialise AC'97 register map
 795  *
 796  * @ac97: Device that will be interacted with
 797  * @config: Configuration for register map
 798  *
 799  * The return value will be an ERR_PTR() on error or a valid pointer to
 800  * a struct regmap.
 801  */
 802 #define regmap_init_ac97(ac97, config)                                  \
 803         __regmap_lockdep_wrapper(__regmap_init_ac97, #config,           \
 804                                 ac97, config)
 805 bool regmap_ac97_default_volatile(struct device *dev, unsigned int reg);
 806
 807 /**
 808  * regmap_init_sdw() - Initialise register map
 809  *
 810  * @sdw: Device that will be interacted with
 811  * @config: Configuration for register map
 812  *
 813  * The return value will be an ERR_PTR() on error or a valid pointer to
 814  * a struct regmap.
 815  */
 816 #define regmap_init_sdw(sdw, config)                                    \
 817         __regmap_lockdep_wrapper(__regmap_init_sdw, #config,            \
 818                                 sdw, config)
 819
 820 /**
 821  * regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
 822  * to AVMM Bus Bridge
 823  *
 824  * @spi: Device that will be interacted with
 825  * @config: Configuration for register map
 826  *
 827  * The return value will be an ERR_PTR() on error or a valid pointer
 828  * to a struct regmap.
 829  */
 830 #define regmap_init_spi_avmm(spi, config)                                       \
 831         __regmap_lockdep_wrapper(__regmap_init_spi_avmm, #config,               \
 832                                  spi, config)
 833
 834 /**
 835  * devm_regmap_init() - Initialise managed register map
 836  *
 837  * @dev: Device that will be interacted with
 838  * @bus: Bus-specific callbacks to use with device
 839  * @bus_context: Data passed to bus-specific callbacks
 840  * @config: Configuration for register map
 841  *
 842  * The return value will be an ERR_PTR() on error or a valid pointer
 843  * to a struct regmap.  This function should generally not be called
 844  * directly, it should be called by bus-specific init functions.  The
 845  * map will be automatically freed by the device management code.
 846  */
 847 #define devm_regmap_init(dev, bus, bus_context, config)                 \
 848         __regmap_lockdep_wrapper(__devm_regmap_init, #config,           \
 849                                 dev, bus, bus_context, config)
 850
 851 /**
 852  * devm_regmap_init_i2c() - Initialise managed register map
 853  *
 854  * @i2c: Device that will be interacted with
 855  * @config: Configuration for register map
 856  *
 857  * The return value will be an ERR_PTR() on error or a valid pointer
 858  * to a struct regmap.  The regmap will be automatically freed by the
 859  * device management code.
 860  */
 861 #define devm_regmap_init_i2c(i2c, config)                               \
 862         __regmap_lockdep_wrapper(__devm_regmap_init_i2c, #config,       \
 863                                 i2c, config)
 864
 865 /**
 866  * devm_regmap_init_sccb() - Initialise managed register map
 867  *
 868  * @i2c: Device that will be interacted with
 869  * @config: Configuration for register map
 870  *
 871  * The return value will be an ERR_PTR() on error or a valid pointer
 872  * to a struct regmap.  The regmap will be automatically freed by the
 873  * device management code.
 874  */
 875 #define devm_regmap_init_sccb(i2c, config)                              \
 876         __regmap_lockdep_wrapper(__devm_regmap_init_sccb, #config,      \
 877                                 i2c, config)
 878
 879 /**
 880  * devm_regmap_init_spi() - Initialise register map
 881  *
 882  * @dev: Device that will be interacted with
 883  * @config: Configuration for register map
 884  *
 885  * The return value will be an ERR_PTR() on error or a valid pointer
 886  * to a struct regmap.  The map will be automatically freed by the
 887  * device management code.
 888  */
 889 #define devm_regmap_init_spi(dev, config)                               \
 890         __regmap_lockdep_wrapper(__devm_regmap_init_spi, #config,       \
 891                                 dev, config)
 892
 893 /**
 894  * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
 895  *
 896  * @dev:        SPMI device that will be interacted with
 897  * @config:     Configuration for register map
 898  *
 899  * The return value will be an ERR_PTR() on error or a valid pointer
 900  * to a struct regmap.  The regmap will be automatically freed by the
 901  * device management code.
 902  */
 903 #define devm_regmap_init_spmi_base(dev, config)                         \
 904         __regmap_lockdep_wrapper(__devm_regmap_init_spmi_base, #config, \
 905                                 dev, config)
 906
 907 /**
 908  * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
 909  *
 910  * @dev:        SPMI device that will be interacted with
 911  * @config:     Configuration for register map
 912  *
 913  * The return value will be an ERR_PTR() on error or a valid pointer
 914  * to a struct regmap.  The regmap will be automatically freed by the
 915  * device management code.
 916  */
 917 #define devm_regmap_init_spmi_ext(dev, config)                          \
 918         __regmap_lockdep_wrapper(__devm_regmap_init_spmi_ext, #config,  \
 919                                 dev, config)
 920
 921 /**
 922  * devm_regmap_init_w1() - Initialise managed register map
 923  *
 924  * @w1_dev: Device that will be interacted with
 925  * @config: Configuration for register map
 926  *
 927  * The return value will be an ERR_PTR() on error or a valid pointer
 928  * to a struct regmap.  The regmap will be automatically freed by the
 929  * device management code.
 930  */
 931 #define devm_regmap_init_w1(w1_dev, config)                             \
 932         __regmap_lockdep_wrapper(__devm_regmap_init_w1, #config,        \
 933                                 w1_dev, config)
 934 /**
 935  * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
 936  *
 937  * @dev: Device that will be interacted with
 938  * @clk_id: register clock consumer ID
 939  * @regs: Pointer to memory-mapped IO region
 940  * @config: Configuration for register map
 941  *
 942  * The return value will be an ERR_PTR() on error or a valid pointer
 943  * to a struct regmap.  The regmap will be automatically freed by the
 944  * device management code.
 945  */
 946 #define devm_regmap_init_mmio_clk(dev, clk_id, regs, config)            \
 947         __regmap_lockdep_wrapper(__devm_regmap_init_mmio_clk, #config,  \
 948                                 dev, clk_id, regs, config)
 949
 950 /**
 951  * devm_regmap_init_mmio() - Initialise managed register map
 952  *
 953  * @dev: Device that will be interacted with
 954  * @regs: Pointer to memory-mapped IO region
 955  * @config: Configuration for register map
 956  *
 957  * The return value will be an ERR_PTR() on error or a valid pointer
 958  * to a struct regmap.  The regmap will be automatically freed by the
 959  * device management code.
 960  */
 961 #define devm_regmap_init_mmio(dev, regs, config)                \
 962         devm_regmap_init_mmio_clk(dev, NULL, regs, config)
 963
 964 /**
 965  * devm_regmap_init_ac97() - Initialise AC'97 register map
 966  *
 967  * @ac97: Device that will be interacted with
 968  * @config: Configuration for register map
 969  *
 970  * The return value will be an ERR_PTR() on error or a valid pointer
 971  * to a struct regmap.  The regmap will be automatically freed by the
 972  * device management code.
 973  */
 974 #define devm_regmap_init_ac97(ac97, config)                             \
 975         __regmap_lockdep_wrapper(__devm_regmap_init_ac97, #config,      \
 976                                 ac97, config)
 977
 978 /**
 979  * devm_regmap_init_sdw() - Initialise managed register map
 980  *
 981  * @sdw: Device that will be interacted with
 982  * @config: Configuration for register map
 983  *
 984  * The return value will be an ERR_PTR() on error or a valid pointer
 985  * to a struct regmap. The regmap will be automatically freed by the
 986  * device management code.
 987  */
 988 #define devm_regmap_init_sdw(sdw, config)                               \
 989         __regmap_lockdep_wrapper(__devm_regmap_init_sdw, #config,       \
 990                                 sdw, config)
 991
 992 /**
 993  * devm_regmap_init_slimbus() - Initialise managed register map
 994  *
 995  * @slimbus: Device that will be interacted with
 996  * @config: Configuration for register map
 997  *
 998  * The return value will be an ERR_PTR() on error or a valid pointer
 999  * to a struct regmap. The regmap will be automatically freed by the
1000  * device management code.
1001  */
1002 #define devm_regmap_init_slimbus(slimbus, config)                       \
1003         __regmap_lockdep_wrapper(__devm_regmap_init_slimbus, #config,   \
1004                                 slimbus, config)
1005
1006 /**
1007  * devm_regmap_init_i3c() - Initialise managed register map
1008  *
1009  * @i3c: Device that will be interacted with
1010  * @config: Configuration for register map
1011  *
1012  * The return value will be an ERR_PTR() on error or a valid pointer
1013  * to a struct regmap.  The regmap will be automatically freed by the
1014  * device management code.
1015  */
1016 #define devm_regmap_init_i3c(i3c, config)                               \
1017         __regmap_lockdep_wrapper(__devm_regmap_init_i3c, #config,       \
1018                                 i3c, config)
1019
1020 /**
1021  * devm_regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
1022  * to AVMM Bus Bridge
1023  *
1024  * @spi: Device that will be interacted with
1025  * @config: Configuration for register map
1026  *
1027  * The return value will be an ERR_PTR() on error or a valid pointer
1028  * to a struct regmap.  The map will be automatically freed by the
1029  * device management code.
1030  */
1031 #define devm_regmap_init_spi_avmm(spi, config)                          \
1032         __regmap_lockdep_wrapper(__devm_regmap_init_spi_avmm, #config,  \
1033                                  spi, config)
1034
1035 int regmap_mmio_attach_clk(struct regmap *map, struct clk *clk);
1036 void regmap_mmio_detach_clk(struct regmap *map);
1037 void regmap_exit(struct regmap *map);
1038 int regmap_reinit_cache(struct regmap *map,
1039                         const struct regmap_config *config);
1040 struct regmap *dev_get_regmap(struct device *dev, const char *name);
1041 struct device *regmap_get_device(struct regmap *map);
1042 int regmap_write(struct regmap *map, unsigned int reg, unsigned int val);
1043 int regmap_write_async(struct regmap *map, unsigned int reg, unsigned int val);
1044 int regmap_raw_write(struct regmap *map, unsigned int reg,
1045                      const void *val, size_t val_len);
1046 int regmap_noinc_write(struct regmap *map, unsigned int reg,
1047                      const void *val, size_t val_len);
1048 int regmap_bulk_write(struct regmap *map, unsigned int reg, const void *val,
1049                         size_t val_count);
1050 int regmap_multi_reg_write(struct regmap *map, const struct reg_sequence *regs,
1051                         int num_regs);
1052 int regmap_multi_reg_write_bypassed(struct regmap *map,
1053                                     const struct reg_sequence *regs,
1054                                     int num_regs);
1055 int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1056                            const void *val, size_t val_len);
1057 int regmap_read(struct regmap *map, unsigned int reg, unsigned int *val);
1058 int regmap_raw_read(struct regmap *map, unsigned int reg,
1059                     void *val, size_t val_len);
1060 int regmap_noinc_read(struct regmap *map, unsigned int reg,
1061                       void *val, size_t val_len);
1062 int regmap_bulk_read(struct regmap *map, unsigned int reg, void *val,
1063                      size_t val_count);
1064 int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1065                             unsigned int mask, unsigned int val,
1066                             bool *change, bool async, bool force);
1067
1068 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
1069                                      unsigned int mask, unsigned int val)
1070 {
1071         return regmap_update_bits_base(map, reg, mask, val, NULL, false, false);
1072 }
1073
1074 static inline int regmap_update_bits_async(struct regmap *map, unsigned int reg,
1075                                            unsigned int mask, unsigned int val)
1076 {
1077         return regmap_update_bits_base(map, reg, mask, val, NULL, true, false);
1078 }
1079
1080 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1081                                            unsigned int mask, unsigned int val,
1082                                            bool *change)
1083 {
1084         return regmap_update_bits_base(map, reg, mask, val,
1085                                        change, false, false);
1086 }
1087
1088 static inline int
1089 regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
1090                                unsigned int mask, unsigned int val,
1091                                bool *change)
1092 {
1093         return regmap_update_bits_base(map, reg, mask, val,
1094                                        change, true, false);
1095 }
1096
1097 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
1098                                     unsigned int mask, unsigned int val)
1099 {
1100         return regmap_update_bits_base(map, reg, mask, val, NULL, false, true);
1101 }
1102
1103 int regmap_get_val_bytes(struct regmap *map);
1104 int regmap_get_max_register(struct regmap *map);
1105 int regmap_get_reg_stride(struct regmap *map);
1106 int regmap_async_complete(struct regmap *map);
1107 bool regmap_can_raw_write(struct regmap *map);
1108 size_t regmap_get_raw_read_max(struct regmap *map);
1109 size_t regmap_get_raw_write_max(struct regmap *map);
1110
1111 int regcache_sync(struct regmap *map);
1112 int regcache_sync_region(struct regmap *map, unsigned int min,
1113                          unsigned int max);
1114 int regcache_drop_region(struct regmap *map, unsigned int min,
1115                          unsigned int max);
1116 void regcache_cache_only(struct regmap *map, bool enable);
1117 void regcache_cache_bypass(struct regmap *map, bool enable);
1118 void regcache_mark_dirty(struct regmap *map);
1119
1120 bool regmap_check_range_table(struct regmap *map, unsigned int reg,
1121                               const struct regmap_access_table *table);
1122
1123 int regmap_register_patch(struct regmap *map, const struct reg_sequence *regs,
1124                           int num_regs);
1125 int regmap_parse_val(struct regmap *map, const void *buf,
1126                                 unsigned int *val);
1127
1128 static inline bool regmap_reg_in_range(unsigned int reg,
1129                                        const struct regmap_range *range)
1130 {
1131         return reg >= range->range_min && reg <= range->range_max;
1132 }
1133
1134 bool regmap_reg_in_ranges(unsigned int reg,
1135                           const struct regmap_range *ranges,
1136                           unsigned int nranges);
1137
1138 static inline int regmap_set_bits(struct regmap *map,
1139                                   unsigned int reg, unsigned int bits)
1140 {
1141         return regmap_update_bits_base(map, reg, bits, bits,
1142                                        NULL, false, false);
1143 }
1144
1145 static inline int regmap_clear_bits(struct regmap *map,
1146                                     unsigned int reg, unsigned int bits)
1147 {
1148         return regmap_update_bits_base(map, reg, bits, 0, NULL, false, false);
1149 }
1150
1151 int regmap_test_bits(struct regmap *map, unsigned int reg, unsigned int bits);
1152
1153 /**
1154  * struct reg_field - Description of an register field
1155  *
1156  * @reg: Offset of the register within the regmap bank
1157  * @lsb: lsb of the register field.
1158  * @msb: msb of the register field.
1159  * @id_size: port size if it has some ports
1160  * @id_offset: address offset for each ports
1161  */
1162 struct reg_field {
1163         unsigned int reg;
1164         unsigned int lsb;
1165         unsigned int msb;
1166         unsigned int id_size;
1167         unsigned int id_offset;
1168 };
1169
1170 #define REG_FIELD(_reg, _lsb, _msb) {           \
1171                                 .reg = _reg,    \
1172                                 .lsb = _lsb,    \
1173                                 .msb = _msb,    \
1174                                 }
1175
1176 #define REG_FIELD_ID(_reg, _lsb, _msb, _size, _offset) {        \
1177                                 .reg = _reg,                    \
1178                                 .lsb = _lsb,                    \
1179                                 .msb = _msb,                    \
1180                                 .id_size = _size,               \
1181                                 .id_offset = _offset,           \
1182                                 }
1183
1184 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
1185                 struct reg_field reg_field);
1186 void regmap_field_free(struct regmap_field *field);
1187
1188 struct regmap_field *devm_regmap_field_alloc(struct device *dev,
1189                 struct regmap *regmap, struct reg_field reg_field);
1190 void devm_regmap_field_free(struct device *dev, struct regmap_field *field);
1191
1192 int regmap_field_bulk_alloc(struct regmap *regmap,
1193                              struct regmap_field **rm_field,
1194                              struct reg_field *reg_field,
1195                              int num_fields);
1196 void regmap_field_bulk_free(struct regmap_field *field);
1197 int devm_regmap_field_bulk_alloc(struct device *dev, struct regmap *regmap,
1198                                  struct regmap_field **field,
1199                                  struct reg_field *reg_field, int num_fields);
1200 void devm_regmap_field_bulk_free(struct device *dev,
1201                                  struct regmap_field *field);
1202
1203 int regmap_field_read(struct regmap_field *field, unsigned int *val);
1204 int regmap_field_update_bits_base(struct regmap_field *field,
1205                                   unsigned int mask, unsigned int val,
1206                                   bool *change, bool async, bool force);
1207 int regmap_fields_read(struct regmap_field *field, unsigned int id,
1208                        unsigned int *val);
1209 int regmap_fields_update_bits_base(struct regmap_field *field,  unsigned int id,
1210                                    unsigned int mask, unsigned int val,
1211                                    bool *change, bool async, bool force);
1212
1213 static inline int regmap_field_write(struct regmap_field *field,
1214                                      unsigned int val)
1215 {
1216         return regmap_field_update_bits_base(field, ~0, val,
1217                                              NULL, false, false);
1218 }
1219
1220 static inline int regmap_field_force_write(struct regmap_field *field,
1221                                            unsigned int val)
1222 {
1223         return regmap_field_update_bits_base(field, ~0, val, NULL, false, true);
1224 }
1225
1226 static inline int regmap_field_update_bits(struct regmap_field *field,
1227                                            unsigned int mask, unsigned int val)
1228 {
1229         return regmap_field_update_bits_base(field, mask, val,
1230                                              NULL, false, false);
1231 }
1232
1233 static inline int
1234 regmap_field_force_update_bits(struct regmap_field *field,
1235                                unsigned int mask, unsigned int val)
1236 {
1237         return regmap_field_update_bits_base(field, mask, val,
1238                                              NULL, false, true);
1239 }
1240
1241 static inline int regmap_fields_write(struct regmap_field *field,
1242                                       unsigned int id, unsigned int val)
1243 {
1244         return regmap_fields_update_bits_base(field, id, ~0, val,
1245                                               NULL, false, false);
1246 }
1247
1248 static inline int regmap_fields_force_write(struct regmap_field *field,
1249                                             unsigned int id, unsigned int val)
1250 {
1251         return regmap_fields_update_bits_base(field, id, ~0, val,
1252                                               NULL, false, true);
1253 }
1254
1255 static inline int
1256 regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
1257                           unsigned int mask, unsigned int val)
1258 {
1259         return regmap_fields_update_bits_base(field, id, mask, val,
1260                                               NULL, false, false);
1261 }
1262
1263 static inline int
1264 regmap_fields_force_update_bits(struct regmap_field *field, unsigned int id,
1265                                 unsigned int mask, unsigned int val)
1266 {
1267         return regmap_fields_update_bits_base(field, id, mask, val,
1268                                               NULL, false, true);
1269 }
1270
1271 /**
1272  * struct regmap_irq_type - IRQ type definitions.
1273  *
1274  * @type_reg_offset: Offset register for the irq type setting.
1275  * @type_rising_val: Register value to configure RISING type irq.
1276  * @type_falling_val: Register value to configure FALLING type irq.
1277  * @type_level_low_val: Register value to configure LEVEL_LOW type irq.
1278  * @type_level_high_val: Register value to configure LEVEL_HIGH type irq.
1279  * @types_supported: logical OR of IRQ_TYPE_* flags indicating supported types.
1280  */
1281 struct regmap_irq_type {
1282         unsigned int type_reg_offset;
1283         unsigned int type_reg_mask;
1284         unsigned int type_rising_val;
1285         unsigned int type_falling_val;
1286         unsigned int type_level_low_val;
1287         unsigned int type_level_high_val;
1288         unsigned int types_supported;
1289 };
1290
1291 /**
1292  * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
1293  *
1294  * @reg_offset: Offset of the status/mask register within the bank
1295  * @mask:       Mask used to flag/control the register.
1296  * @type:       IRQ trigger type setting details if supported.
1297  */
1298 struct regmap_irq {
1299         unsigned int reg_offset;
1300         unsigned int mask;
1301         struct regmap_irq_type type;
1302 };
1303
1304 #define REGMAP_IRQ_REG(_irq, _off, _mask)               \
1305         [_irq] = { .reg_offset = (_off), .mask = (_mask) }
1306
1307 #define REGMAP_IRQ_REG_LINE(_id, _reg_bits) \
1308         [_id] = {                               \
1309                 .mask = BIT((_id) % (_reg_bits)),       \
1310                 .reg_offset = (_id) / (_reg_bits),      \
1311         }
1312
1313 #define REGMAP_IRQ_MAIN_REG_OFFSET(arr)                         \
1314         { .num_regs = ARRAY_SIZE((arr)), .offset = &(arr)[0] }
1315
1316 struct regmap_irq_sub_irq_map {
1317         unsigned int num_regs;
1318         unsigned int *offset;
1319 };
1320
1321 /**
1322  * struct regmap_irq_chip - Description of a generic regmap irq_chip.
1323  *
1324  * @name:        Descriptive name for IRQ controller.
1325  *
1326  * @main_status: Base main status register address. For chips which have
1327  *               interrupts arranged in separate sub-irq blocks with own IRQ
1328  *               registers and which have a main IRQ registers indicating
1329  *               sub-irq blocks with unhandled interrupts. For such chips fill
1330  *               sub-irq register information in status_base, mask_base and
1331  *               ack_base.
1332  * @num_main_status_bits: Should be given to chips where number of meaningfull
1333  *                        main status bits differs from num_regs.
1334  * @sub_reg_offsets: arrays of mappings from main register bits to sub irq
1335  *                   registers. First item in array describes the registers
1336  *                   for first main status bit. Second array for second bit etc.
1337  *                   Offset is given as sub register status offset to
1338  *                   status_base. Should contain num_regs arrays.
1339  *                   Can be provided for chips with more complex mapping than
1340  *                   1.st bit to 1.st sub-reg, 2.nd bit to 2.nd sub-reg, ...
1341  * @num_main_regs: Number of 'main status' irq registers for chips which have
1342  *                 main_status set.
1343  *
1344  * @status_base: Base status register address.
1345  * @mask_base:   Base mask register address.
1346  * @mask_writeonly: Base mask register is write only.
1347  * @unmask_base:  Base unmask register address. for chips who have
1348  *                separate mask and unmask registers
1349  * @ack_base:    Base ack address. If zero then the chip is clear on read.
1350  *               Using zero value is possible with @use_ack bit.
1351  * @wake_base:   Base address for wake enables.  If zero unsupported.
1352  * @type_base:   Base address for irq type.  If zero unsupported.
1353  * @irq_reg_stride:  Stride to use for chips where registers are not contiguous.
1354  * @init_ack_masked: Ack all masked interrupts once during initalization.
1355  * @mask_invert: Inverted mask register: cleared bits are masked out.
1356  * @use_ack:     Use @ack register even if it is zero.
1357  * @ack_invert:  Inverted ack register: cleared bits for ack.
1358  * @clear_ack:  Use this to set 1 and 0 or vice-versa to clear interrupts.
1359  * @wake_invert: Inverted wake register: cleared bits are wake enabled.
1360  * @type_invert: Invert the type flags.
1361  * @type_in_mask: Use the mask registers for controlling irq type. For
1362  *                interrupts defining type_rising/falling_mask use mask_base
1363  *                for edge configuration and never update bits in type_base.
1364  * @clear_on_unmask: For chips with interrupts cleared on read: read the status
1365  *                   registers before unmasking interrupts to clear any bits
1366  *                   set when they were masked.
1367  * @runtime_pm:  Hold a runtime PM lock on the device when accessing it.
1368  *
1369  * @num_regs:    Number of registers in each control bank.
1370  * @irqs:        Descriptors for individual IRQs.  Interrupt numbers are
1371  *               assigned based on the index in the array of the interrupt.
1372  * @num_irqs:    Number of descriptors.
1373  * @num_type_reg:    Number of type registers.
1374  * @type_reg_stride: Stride to use for chips where type registers are not
1375  *                      contiguous.
1376  * @handle_pre_irq:  Driver specific callback to handle interrupt from device
1377  *                   before regmap_irq_handler process the interrupts.
1378  * @handle_post_irq: Driver specific callback to handle interrupt from device
1379  *                   after handling the interrupts in regmap_irq_handler().
1380  * @irq_drv_data:    Driver specific IRQ data which is passed as parameter when
1381  *                   driver specific pre/post interrupt handler is called.
1382  *
1383  * This is not intended to handle every possible interrupt controller, but
1384  * it should handle a substantial proportion of those that are found in the
1385  * wild.
1386  */
1387 struct regmap_irq_chip {
1388         const char *name;
1389
1390         unsigned int main_status;
1391         unsigned int num_main_status_bits;
1392         struct regmap_irq_sub_irq_map *sub_reg_offsets;
1393         int num_main_regs;
1394
1395         unsigned int status_base;
1396         unsigned int mask_base;
1397         unsigned int unmask_base;
1398         unsigned int ack_base;
1399         unsigned int wake_base;
1400         unsigned int type_base;
1401         unsigned int irq_reg_stride;
1402         bool mask_writeonly:1;
1403         bool init_ack_masked:1;
1404         bool mask_invert:1;
1405         bool use_ack:1;
1406         bool ack_invert:1;
1407         bool clear_ack:1;
1408         bool wake_invert:1;
1409         bool runtime_pm:1;
1410         bool type_invert:1;
1411         bool type_in_mask:1;
1412         bool clear_on_unmask:1;
1413
1414         int num_regs;
1415
1416         const struct regmap_irq *irqs;
1417         int num_irqs;
1418
1419         int num_type_reg;
1420         unsigned int type_reg_stride;
1421
1422         int (*handle_pre_irq)(void *irq_drv_data);
1423         int (*handle_post_irq)(void *irq_drv_data);
1424         void *irq_drv_data;
1425 };
1426
1427 struct regmap_irq_chip_data;
1428
1429 int regmap_add_irq_chip(struct regmap *map, int irq, int irq_flags,
1430                         int irq_base, const struct regmap_irq_chip *chip,
1431                         struct regmap_irq_chip_data **data);
1432 int regmap_add_irq_chip_fwnode(struct fwnode_handle *fwnode,
1433                                struct regmap *map, int irq,
1434                                int irq_flags, int irq_base,
1435                                const struct regmap_irq_chip *chip,
1436                                struct regmap_irq_chip_data **data);
1437 void regmap_del_irq_chip(int irq, struct regmap_irq_chip_data *data);
1438
1439 int devm_regmap_add_irq_chip(struct device *dev, struct regmap *map, int irq,
1440                              int irq_flags, int irq_base,
1441                              const struct regmap_irq_chip *chip,
1442                              struct regmap_irq_chip_data **data);
1443 int devm_regmap_add_irq_chip_fwnode(struct device *dev,
1444                                     struct fwnode_handle *fwnode,
1445                                     struct regmap *map, int irq,
1446                                     int irq_flags, int irq_base,
1447                                     const struct regmap_irq_chip *chip,
1448                                     struct regmap_irq_chip_data **data);
1449 void devm_regmap_del_irq_chip(struct device *dev, int irq,
1450                               struct regmap_irq_chip_data *data);
1451
1452 int regmap_irq_chip_get_base(struct regmap_irq_chip_data *data);
1453 int regmap_irq_get_virq(struct regmap_irq_chip_data *data, int irq);
1454 struct irq_domain *regmap_irq_get_domain(struct regmap_irq_chip_data *data);
1455
1456 #else
1457
1458 /*
1459  * These stubs should only ever be called by generic code which has
1460  * regmap based facilities, if they ever get called at runtime
1461  * something is going wrong and something probably needs to select
1462  * REGMAP.
1463  */
1464
1465 static inline int regmap_write(struct regmap *map, unsigned int reg,
1466                                unsigned int val)
1467 {
1468         WARN_ONCE(1, "regmap API is disabled");
1469         return -EINVAL;
1470 }
1471
1472 static inline int regmap_write_async(struct regmap *map, unsigned int reg,
1473                                      unsigned int val)
1474 {
1475         WARN_ONCE(1, "regmap API is disabled");
1476         return -EINVAL;
1477 }
1478
1479 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,
1480                                    const void *val, size_t val_len)
1481 {
1482         WARN_ONCE(1, "regmap API is disabled");
1483         return -EINVAL;
1484 }
1485
1486 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,
1487                                          const void *val, size_t val_len)
1488 {
1489         WARN_ONCE(1, "regmap API is disabled");
1490         return -EINVAL;
1491 }
1492
1493 static inline int regmap_noinc_write(struct regmap *map, unsigned int reg,
1494                                     const void *val, size_t val_len)
1495 {
1496         WARN_ONCE(1, "regmap API is disabled");
1497         return -EINVAL;
1498 }
1499
1500 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,
1501                                     const void *val, size_t val_count)
1502 {
1503         WARN_ONCE(1, "regmap API is disabled");
1504         return -EINVAL;
1505 }
1506
1507 static inline int regmap_read(struct regmap *map, unsigned int reg,
1508                               unsigned int *val)
1509 {
1510         WARN_ONCE(1, "regmap API is disabled");
1511         return -EINVAL;
1512 }
1513
1514 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,
1515                                   void *val, size_t val_len)
1516 {
1517         WARN_ONCE(1, "regmap API is disabled");
1518         return -EINVAL;
1519 }
1520
1521 static inline int regmap_noinc_read(struct regmap *map, unsigned int reg,
1522                                     void *val, size_t val_len)
1523 {
1524         WARN_ONCE(1, "regmap API is disabled");
1525         return -EINVAL;
1526 }
1527
1528 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,
1529                                    void *val, size_t val_count)
1530 {
1531         WARN_ONCE(1, "regmap API is disabled");
1532         return -EINVAL;
1533 }
1534
1535 static inline int regmap_update_bits_base(struct regmap *map, unsigned int reg,
1536                                           unsigned int mask, unsigned int val,
1537                                           bool *change, bool async, bool force)
1538 {
1539         WARN_ONCE(1, "regmap API is disabled");
1540         return -EINVAL;
1541 }
1542
1543 static inline int regmap_set_bits(struct regmap *map,
1544                                   unsigned int reg, unsigned int bits)
1545 {
1546         WARN_ONCE(1, "regmap API is disabled");
1547         return -EINVAL;
1548 }
1549
1550 static inline int regmap_clear_bits(struct regmap *map,
1551                                     unsigned int reg, unsigned int bits)
1552 {
1553         WARN_ONCE(1, "regmap API is disabled");
1554         return -EINVAL;
1555 }
1556
1557 static inline int regmap_test_bits(struct regmap *map,
1558                                    unsigned int reg, unsigned int bits)
1559 {
1560         WARN_ONCE(1, "regmap API is disabled");
1561         return -EINVAL;
1562 }
1563
1564 static inline int regmap_field_update_bits_base(struct regmap_field *field,
1565                                         unsigned int mask, unsigned int val,
1566                                         bool *change, bool async, bool force)
1567 {
1568         WARN_ONCE(1, "regmap API is disabled");
1569         return -EINVAL;
1570 }
1571
1572 static inline int regmap_fields_update_bits_base(struct regmap_field *field,
1573                                    unsigned int id,
1574                                    unsigned int mask, unsigned int val,
1575                                    bool *change, bool async, bool force)
1576 {
1577         WARN_ONCE(1, "regmap API is disabled");
1578         return -EINVAL;
1579 }
1580
1581 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,
1582                                      unsigned int mask, unsigned int val)
1583 {
1584         WARN_ONCE(1, "regmap API is disabled");
1585         return -EINVAL;
1586 }
1587
1588 static inline int regmap_update_bits_async(struct regmap *map, unsigned int reg,
1589                                            unsigned int mask, unsigned int val)
1590 {
1591         WARN_ONCE(1, "regmap API is disabled");
1592         return -EINVAL;
1593 }
1594
1595 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,
1596                                            unsigned int mask, unsigned int val,
1597                                            bool *change)
1598 {
1599         WARN_ONCE(1, "regmap API is disabled");
1600         return -EINVAL;
1601 }
1602
1603 static inline int
1604 regmap_update_bits_check_async(struct regmap *map, unsigned int reg,
1605                                unsigned int mask, unsigned int val,
1606                                bool *change)
1607 {
1608         WARN_ONCE(1, "regmap API is disabled");
1609         return -EINVAL;
1610 }
1611
1612 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,
1613                                     unsigned int mask, unsigned int val)
1614 {
1615         WARN_ONCE(1, "regmap API is disabled");
1616         return -EINVAL;
1617 }
1618
1619 static inline int regmap_field_write(struct regmap_field *field,
1620                                      unsigned int val)
1621 {
1622         WARN_ONCE(1, "regmap API is disabled");
1623         return -EINVAL;
1624 }
1625
1626 static inline int regmap_field_force_write(struct regmap_field *field,
1627                                            unsigned int val)
1628 {
1629         WARN_ONCE(1, "regmap API is disabled");
1630         return -EINVAL;
1631 }
1632
1633 static inline int regmap_field_update_bits(struct regmap_field *field,
1634                                            unsigned int mask, unsigned int val)
1635 {
1636         WARN_ONCE(1, "regmap API is disabled");
1637         return -EINVAL;
1638 }
1639
1640 static inline int
1641 regmap_field_force_update_bits(struct regmap_field *field,
1642                                unsigned int mask, unsigned int val)
1643 {
1644         WARN_ONCE(1, "regmap API is disabled");
1645         return -EINVAL;
1646 }
1647
1648 static inline int regmap_fields_write(struct regmap_field *field,
1649                                       unsigned int id, unsigned int val)
1650 {
1651         WARN_ONCE(1, "regmap API is disabled");
1652         return -EINVAL;
1653 }
1654
1655 static inline int regmap_fields_force_write(struct regmap_field *field,
1656                                             unsigned int id, unsigned int val)
1657 {
1658         WARN_ONCE(1, "regmap API is disabled");
1659         return -EINVAL;
1660 }
1661
1662 static inline int
1663 regmap_fields_update_bits(struct regmap_field *field, unsigned int id,
1664                           unsigned int mask, unsigned int val)
1665 {
1666         WARN_ONCE(1, "regmap API is disabled");
1667         return -EINVAL;
1668 }
1669
1670 static inline int
1671 regmap_fields_force_update_bits(struct regmap_field *field, unsigned int id,
1672                                 unsigned int mask, unsigned int val)
1673 {
1674         WARN_ONCE(1, "regmap API is disabled");
1675         return -EINVAL;
1676 }
1677
1678 static inline int regmap_get_val_bytes(struct regmap *map)
1679 {
1680         WARN_ONCE(1, "regmap API is disabled");
1681         return -EINVAL;
1682 }
1683
1684 static inline int regmap_get_max_register(struct regmap *map)
1685 {
1686         WARN_ONCE(1, "regmap API is disabled");
1687         return -EINVAL;
1688 }
1689
1690 static inline int regmap_get_reg_stride(struct regmap *map)
1691 {
1692         WARN_ONCE(1, "regmap API is disabled");
1693         return -EINVAL;
1694 }
1695
1696 static inline int regcache_sync(struct regmap *map)
1697 {
1698         WARN_ONCE(1, "regmap API is disabled");
1699         return -EINVAL;
1700 }
1701
1702 static inline int regcache_sync_region(struct regmap *map, unsigned int min,
1703                                        unsigned int max)
1704 {
1705         WARN_ONCE(1, "regmap API is disabled");
1706         return -EINVAL;
1707 }
1708
1709 static inline int regcache_drop_region(struct regmap *map, unsigned int min,
1710                                        unsigned int max)
1711 {
1712         WARN_ONCE(1, "regmap API is disabled");
1713         return -EINVAL;
1714 }
1715
1716 static inline void regcache_cache_only(struct regmap *map, bool enable)
1717 {
1718         WARN_ONCE(1, "regmap API is disabled");
1719 }
1720
1721 static inline void regcache_cache_bypass(struct regmap *map, bool enable)
1722 {
1723         WARN_ONCE(1, "regmap API is disabled");
1724 }
1725
1726 static inline void regcache_mark_dirty(struct regmap *map)
1727 {
1728         WARN_ONCE(1, "regmap API is disabled");
1729 }
1730
1731 static inline void regmap_async_complete(struct regmap *map)
1732 {
1733         WARN_ONCE(1, "regmap API is disabled");
1734 }
1735
1736 static inline int regmap_register_patch(struct regmap *map,
1737                                         const struct reg_sequence *regs,
1738                                         int num_regs)
1739 {
1740         WARN_ONCE(1, "regmap API is disabled");
1741         return -EINVAL;
1742 }
1743
1744 static inline int regmap_parse_val(struct regmap *map, const void *buf,
1745                                 unsigned int *val)
1746 {
1747         WARN_ONCE(1, "regmap API is disabled");
1748         return -EINVAL;
1749 }
1750
1751 static inline struct regmap *dev_get_regmap(struct device *dev,
1752                                             const char *name)
1753 {
1754         return NULL;
1755 }
1756
1757 static inline struct device *regmap_get_device(struct regmap *map)
1758 {
1759         WARN_ONCE(1, "regmap API is disabled");
1760         return NULL;
1761 }
1762
1763 #endif
1764
1765 #endif