1 /* SPDX-License-Identifier: GPL-2.0-only */
54 #define REGMAP_UPSHIFT(s)	(-(s))
73  * struct reg_default - Default value for a register.
87  * struct reg_sequence - An individual write from a sequence of writes.
110  * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs
116  * @sleep_us: Maximum time to sleep between reads in us (0 tight-loops). Please
123  * Returns: 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
137  * regmap_read_poll_timeout_atomic - Poll until a condition is met or a timeout occurs
143  * @delay_us: Time to udelay between reads in us (0 tight-loops). Please
154  * Returns: 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
178 	__ret ?: ((cond) ? 0 : -ETIMEDOUT); \
182  * regmap_field_read_poll_timeout - Poll until a condition is met or timeout
187  * @sleep_us: Maximum time to sleep between reads in us (0 tight-loops). Please
194  * Returns: 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read
210 	/* Unspecified -> 0 -> Backwards compatible default */
218  * struct regmap_range - A register range, used for access related checks
232  * struct regmap_access_table - A table of register ranges for access checks
255  * struct regmap_config - Configuration for the register map of a device.
330  *		   Use it only for "no-bus" cases.
473  * struct regmap_range_cfg - Configuration for indirectly accessed or paged
510  * struct regmap_sdw_mbq_cfg - Configuration for Multi-Byte Quantities
563  * struct regmap_bus - Description of a hardware bus for the register map
572  * @gather_write: Write operation with split register/value, return -ENOTSUPP
575  *               must serialise with respect to non-async I/O.
631 			     const struct regmap_config *config,
635 				 const struct regmap_config *config,
639 				 const struct regmap_config *config,
643 				  const struct regmap_config *config,
647 				 const struct regmap_config *config,
651 				 const struct regmap_config *config,
655 				       const struct regmap_config *config,
659 				      const struct regmap_config *config,
663 				 const struct regmap_config *config,
668 				      const struct regmap_config *config,
672 				  const struct regmap_config *config,
676 				 const struct regmap_config *config,
680 				     const struct regmap_config *config,
685 				      const struct regmap_config *config,
689 				 const struct regmap_config *config,
696 				  const struct regmap_config *config,
700 				      const struct regmap_config *config,
704 				      const struct regmap_config *config,
708 				       const struct regmap_config *config,
712 				      const struct regmap_config *config,
716 					    const struct regmap_config *config,
720 					   const struct regmap_config *config,
724 				      const struct regmap_config *config,
730 					   const struct regmap_config *config,
734 				       const struct regmap_config *config,
738 				 const struct regmap_config *config,
742 					  const struct regmap_config *config,
747 				 const struct regmap_config *config,
751 				 const struct regmap_config *config,
755 					   const struct regmap_config *config,
759 				      const struct regmap_config *config,
765  * for each call. No-op if CONFIG_LOCKDEP is not set.
768  * @name: Config variable name (#config in the calling macro)
774 		static struct lock_class_key _key;			\
778 			"(" name ")->lock");				\
786  * regmap_init() - Initialise register map
789  * @bus: Bus-specific callbacks to use with device
790  * @bus_context: Data passed to bus-specific callbacks
791  * @config: Configuration for register map
795  * directly, it should be called by bus-specific init functions.
797 #define regmap_init(dev, bus, bus_context, config)			\  argument
798 	__regmap_lockdep_wrapper(__regmap_init, #config,		\
799 				dev, bus, bus_context, config)
801 		      const struct regmap_config *config);
804  * regmap_init_i2c() - Initialise register map
807  * @config: Configuration for register map
812 #define regmap_init_i2c(i2c, config)					\  argument
813 	__regmap_lockdep_wrapper(__regmap_init_i2c, #config,		\
814 				i2c, config)
817  * regmap_init_mdio() - Initialise register map
820  * @config: Configuration for register map
825 #define regmap_init_mdio(mdio_dev, config)				\  argument
826 	__regmap_lockdep_wrapper(__regmap_init_mdio, #config,		\
827 				mdio_dev, config)
830  * regmap_init_sccb() - Initialise register map
833  * @config: Configuration for register map
838 #define regmap_init_sccb(i2c, config)					\  argument
839 	__regmap_lockdep_wrapper(__regmap_init_sccb, #config,		\
840 				i2c, config)
843  * regmap_init_slimbus() - Initialise register map
846  * @config: Configuration for register map
851 #define regmap_init_slimbus(slimbus, config)				\  argument
852 	__regmap_lockdep_wrapper(__regmap_init_slimbus, #config,	\
853 				slimbus, config)
856  * regmap_init_spi() - Initialise register map
859  * @config: Configuration for register map
864 #define regmap_init_spi(dev, config)					\  argument
865 	__regmap_lockdep_wrapper(__regmap_init_spi, #config,		\
866 				dev, config)
869  * regmap_init_spmi_base() - Create regmap for the Base register space
872  * @config:	Configuration for register map
877 #define regmap_init_spmi_base(dev, config)				\  argument
878 	__regmap_lockdep_wrapper(__regmap_init_spmi_base, #config,	\
879 				dev, config)
882  * regmap_init_spmi_ext() - Create regmap for Ext register space
885  * @config:	Configuration for register map
890 #define regmap_init_spmi_ext(dev, config)				\  argument
891 	__regmap_lockdep_wrapper(__regmap_init_spmi_ext, #config,	\
892 				dev, config)
895  * regmap_init_w1() - Initialise register map
898  * @config: Configuration for register map
903 #define regmap_init_w1(w1_dev, config)					\  argument
904 	__regmap_lockdep_wrapper(__regmap_init_w1, #config,		\
905 				w1_dev, config)
908  * regmap_init_mmio_clk() - Initialise register map with register clock
912  * @regs: Pointer to memory-mapped IO region
913  * @config: Configuration for register map
918 #define regmap_init_mmio_clk(dev, clk_id, regs, config)			\  argument
919 	__regmap_lockdep_wrapper(__regmap_init_mmio_clk, #config,	\
920 				dev, clk_id, regs, config)
923  * regmap_init_mmio() - Initialise register map
926  * @regs: Pointer to memory-mapped IO region
927  * @config: Configuration for register map
932 #define regmap_init_mmio(dev, regs, config)		\  argument
933 	regmap_init_mmio_clk(dev, NULL, regs, config)
936  * regmap_init_ac97() - Initialise AC'97 register map
939  * @config: Configuration for register map
944 #define regmap_init_ac97(ac97, config)					\  argument
945 	__regmap_lockdep_wrapper(__regmap_init_ac97, #config,		\
946 				ac97, config)
950  * regmap_init_sdw() - Initialise register map
953  * @config: Configuration for register map
958 #define regmap_init_sdw(sdw, config)					\  argument
959 	__regmap_lockdep_wrapper(__regmap_init_sdw, #config,		\
960 				sdw, config)
963  * regmap_init_sdw_mbq() - Initialise register map
966  * @config: Configuration for register map
971 #define regmap_init_sdw_mbq(sdw, config)					\  argument
972 	__regmap_lockdep_wrapper(__regmap_init_sdw_mbq, #config,		\
973 				sdw, config, NULL)
976  * regmap_init_sdw_mbq_cfg() - Initialise MBQ SDW register map with config
979  * @config: Configuration for register map
986 #define regmap_init_sdw_mbq_cfg(sdw, config, mbq_config)		\  argument
987 	__regmap_lockdep_wrapper(__regmap_init_sdw_mbq, #config,	\
988 				sdw, config, mbq_config)
991  * regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
995  * @config: Configuration for register map
1000 #define regmap_init_spi_avmm(spi, config)					\  argument
1001 	__regmap_lockdep_wrapper(__regmap_init_spi_avmm, #config,		\
1002 				 spi, config)
1005  * regmap_init_fsi() - Initialise register map
1008  * @config: Configuration for register map
1013 #define regmap_init_fsi(fsi_dev, config)				\  argument
1014 	__regmap_lockdep_wrapper(__regmap_init_fsi, #config, fsi_dev,	\
1015 				 config)
1018  * devm_regmap_init() - Initialise managed register map
1021  * @bus: Bus-specific callbacks to use with device
1022  * @bus_context: Data passed to bus-specific callbacks
1023  * @config: Configuration for register map
1027  * directly, it should be called by bus-specific init functions.  The
1030 #define devm_regmap_init(dev, bus, bus_context, config)			\  argument
1031 	__regmap_lockdep_wrapper(__devm_regmap_init, #config,		\
1032 				dev, bus, bus_context, config)
1035  * devm_regmap_init_i2c() - Initialise managed register map
1038  * @config: Configuration for register map
1044 #define devm_regmap_init_i2c(i2c, config)				\  argument
1045 	__regmap_lockdep_wrapper(__devm_regmap_init_i2c, #config,	\
1046 				i2c, config)
1049  * devm_regmap_init_mdio() - Initialise managed register map
1052  * @config: Configuration for register map
1058 #define devm_regmap_init_mdio(mdio_dev, config)				\  argument
1059 	__regmap_lockdep_wrapper(__devm_regmap_init_mdio, #config,	\
1060 				mdio_dev, config)
1063  * devm_regmap_init_sccb() - Initialise managed register map
1066  * @config: Configuration for register map
1072 #define devm_regmap_init_sccb(i2c, config)				\  argument
1073 	__regmap_lockdep_wrapper(__devm_regmap_init_sccb, #config,	\
1074 				i2c, config)
1077  * devm_regmap_init_spi() - Initialise register map
1080  * @config: Configuration for register map
1086 #define devm_regmap_init_spi(dev, config)				\  argument
1087 	__regmap_lockdep_wrapper(__devm_regmap_init_spi, #config,	\
1088 				dev, config)
1091  * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
1094  * @config:	Configuration for register map
1100 #define devm_regmap_init_spmi_base(dev, config)				\  argument
1101 	__regmap_lockdep_wrapper(__devm_regmap_init_spmi_base, #config,	\
1102 				dev, config)
1105  * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
1108  * @config:	Configuration for register map
1114 #define devm_regmap_init_spmi_ext(dev, config)				\  argument
1115 	__regmap_lockdep_wrapper(__devm_regmap_init_spmi_ext, #config,	\
1116 				dev, config)
1119  * devm_regmap_init_w1() - Initialise managed register map
1122  * @config: Configuration for register map
1128 #define devm_regmap_init_w1(w1_dev, config)				\  argument
1129 	__regmap_lockdep_wrapper(__devm_regmap_init_w1, #config,	\
1130 				w1_dev, config)
1132  * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
1136  * @regs: Pointer to memory-mapped IO region
1137  * @config: Configuration for register map
1143 #define devm_regmap_init_mmio_clk(dev, clk_id, regs, config)		\  argument
1144 	__regmap_lockdep_wrapper(__devm_regmap_init_mmio_clk, #config,	\
1145 				dev, clk_id, regs, config)
1148  * devm_regmap_init_mmio() - Initialise managed register map
1151  * @regs: Pointer to memory-mapped IO region
1152  * @config: Configuration for register map
1158 #define devm_regmap_init_mmio(dev, regs, config)		\  argument
1159 	devm_regmap_init_mmio_clk(dev, NULL, regs, config)
1162  * devm_regmap_init_ac97() - Initialise AC'97 register map
1165  * @config: Configuration for register map
1171 #define devm_regmap_init_ac97(ac97, config)				\  argument
1172 	__regmap_lockdep_wrapper(__devm_regmap_init_ac97, #config,	\
1173 				ac97, config)
1176  * devm_regmap_init_sdw() - Initialise managed register map
1179  * @config: Configuration for register map
1185 #define devm_regmap_init_sdw(sdw, config)				\  argument
1186 	__regmap_lockdep_wrapper(__devm_regmap_init_sdw, #config,	\
1187 				sdw, config)
1190  * devm_regmap_init_sdw_mbq() - Initialise managed register map
1193  * @config: Configuration for register map
1199 #define devm_regmap_init_sdw_mbq(sdw, config)			\  argument
1200 	__regmap_lockdep_wrapper(__devm_regmap_init_sdw_mbq, #config,   \
1201 				sdw, config, NULL)
1204  * devm_regmap_init_sdw_mbq_cfg() - Initialise managed MBQ SDW register map with config
1207  * @config: Configuration for register map
1214 #define devm_regmap_init_sdw_mbq_cfg(sdw, config, mbq_config)	\  argument
1216 				#config, sdw, config, mbq_config)
1219  * devm_regmap_init_slimbus() - Initialise managed register map
1222  * @config: Configuration for register map
1228 #define devm_regmap_init_slimbus(slimbus, config)			\  argument
1229 	__regmap_lockdep_wrapper(__devm_regmap_init_slimbus, #config,	\
1230 				slimbus, config)
1233  * devm_regmap_init_i3c() - Initialise managed register map
1236  * @config: Configuration for register map
1242 #define devm_regmap_init_i3c(i3c, config)				\  argument
1243 	__regmap_lockdep_wrapper(__devm_regmap_init_i3c, #config,	\
1244 				i3c, config)
1247  * devm_regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
1251  * @config: Configuration for register map
1257 #define devm_regmap_init_spi_avmm(spi, config)				\  argument
1258 	__regmap_lockdep_wrapper(__devm_regmap_init_spi_avmm, #config,	\
1259 				 spi, config)
1262  * devm_regmap_init_fsi() - Initialise managed register map
1265  * @config: Configuration for register map
1271 #define devm_regmap_init_fsi(fsi_dev, config)				\  argument
1272 	__regmap_lockdep_wrapper(__devm_regmap_init_fsi, #config,	\
1273 				 fsi_dev, config)
1279 			const struct regmap_config *config);
1311 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,  in regmap_update_bits()
1317 static inline int regmap_update_bits_async(struct regmap *map, unsigned int reg,  in regmap_update_bits_async()
1323 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,  in regmap_update_bits_check()
1331 static inline int
1340 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,  in regmap_write_bits()
1373 static inline bool regmap_reg_in_range(unsigned int reg,  in regmap_reg_in_range()
1376 	return reg >= range->range_min && reg <= range->range_max;  in regmap_reg_in_range()
1383 static inline int regmap_set_bits(struct regmap *map,  in regmap_set_bits()
1390 static inline int regmap_clear_bits(struct regmap *map,  in regmap_clear_bits()
1396 static inline int regmap_assign_bits(struct regmap *map, unsigned int reg,  in regmap_assign_bits()
1408  * struct reg_field - Description of an register field
1468 static inline int regmap_field_write(struct regmap_field *field,  in regmap_field_write()
1475 static inline int regmap_field_force_write(struct regmap_field *field,  in regmap_field_force_write()
1481 static inline int regmap_field_update_bits(struct regmap_field *field,  in regmap_field_update_bits()
1488 static inline int regmap_field_set_bits(struct regmap_field *field,  in regmap_field_set_bits()
1495 static inline int regmap_field_clear_bits(struct regmap_field *field,  in regmap_field_clear_bits()
1504 static inline int
1512 static inline int regmap_fields_write(struct regmap_field *field,  in regmap_fields_write()
1519 static inline int regmap_fields_force_write(struct regmap_field *field,  in regmap_fields_force_write()
1526 static inline int
1534 static inline int
1543  * struct regmap_irq_type - IRQ type definitions.
1563  * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
1595  * struct regmap_irq_chip - Description of a generic regmap irq_chip.
1599  *		   when multiple regmap-IRQ controllers are created from same
1603  *		 interrupts arranged in separate sub-irq blocks with own IRQ
1605  *		 sub-irq blocks with unhandled interrupts. For such chips fill
1606  *		 sub-irq register information in status_base, mask_base and
1616  *		     1.st bit to 1.st sub-reg, 2.nd bit to 2.nd sub-reg, ...
1628  * @config_base: Base address for IRQ type config regs. If null unsupported.
1641  * @clear_ack:  Use this to set 1 and 0 or vice-versa to clear interrupts.
1660  * @num_config_bases:	Number of config base registers.
1661  * @num_config_regs:	Number of config registers for each config base register.
1674  *		 main status base, [0, num_config_regs[ for any config
1774 static inline int regmap_write(struct regmap *map, unsigned int reg,  in regmap_write()
1778 	return -EINVAL;  in regmap_write()
1781 static inline int regmap_write_async(struct regmap *map, unsigned int reg,  in regmap_write_async()
1785 	return -EINVAL;  in regmap_write_async()
1788 static inline int regmap_raw_write(struct regmap *map, unsigned int reg,  in regmap_raw_write()
1792 	return -EINVAL;  in regmap_raw_write()
1795 static inline int regmap_raw_write_async(struct regmap *map, unsigned int reg,  in regmap_raw_write_async()
1799 	return -EINVAL;  in regmap_raw_write_async()
1802 static inline int regmap_noinc_write(struct regmap *map, unsigned int reg,  in regmap_noinc_write()
1806 	return -EINVAL;  in regmap_noinc_write()
1809 static inline int regmap_bulk_write(struct regmap *map, unsigned int reg,  in regmap_bulk_write()
1813 	return -EINVAL;  in regmap_bulk_write()
1816 static inline int regmap_read(struct regmap *map, unsigned int reg,  in regmap_read()
1820 	return -EINVAL;  in regmap_read()
1823 static inline int regmap_read_bypassed(struct regmap *map, unsigned int reg,  in regmap_read_bypassed()
1827 	return -EINVAL;  in regmap_read_bypassed()
1830 static inline int regmap_raw_read(struct regmap *map, unsigned int reg,  in regmap_raw_read()
1834 	return -EINVAL;  in regmap_raw_read()
1837 static inline int regmap_noinc_read(struct regmap *map, unsigned int reg,  in regmap_noinc_read()
1841 	return -EINVAL;  in regmap_noinc_read()
1844 static inline int regmap_bulk_read(struct regmap *map, unsigned int reg,  in regmap_bulk_read()
1848 	return -EINVAL;  in regmap_bulk_read()
1851 static inline int regmap_update_bits_base(struct regmap *map, unsigned int reg,  in regmap_update_bits_base()
1856 	return -EINVAL;  in regmap_update_bits_base()
1859 static inline int regmap_set_bits(struct regmap *map,  in regmap_set_bits()
1863 	return -EINVAL;  in regmap_set_bits()
1866 static inline int regmap_clear_bits(struct regmap *map,  in regmap_clear_bits()
1870 	return -EINVAL;  in regmap_clear_bits()
1873 static inline int regmap_assign_bits(struct regmap *map, unsigned int reg,  in regmap_assign_bits()
1877 	return -EINVAL;  in regmap_assign_bits()
1880 static inline int regmap_test_bits(struct regmap *map,  in regmap_test_bits()
1884 	return -EINVAL;  in regmap_test_bits()
1887 static inline int regmap_field_update_bits_base(struct regmap_field *field,  in regmap_field_update_bits_base()
1892 	return -EINVAL;  in regmap_field_update_bits_base()
1895 static inline int regmap_fields_update_bits_base(struct regmap_field *field,  in regmap_fields_update_bits_base()
1901 	return -EINVAL;  in regmap_fields_update_bits_base()
1904 static inline int regmap_update_bits(struct regmap *map, unsigned int reg,  in regmap_update_bits()
1908 	return -EINVAL;  in regmap_update_bits()
1911 static inline int regmap_update_bits_async(struct regmap *map, unsigned int reg,  in regmap_update_bits_async()
1915 	return -EINVAL;  in regmap_update_bits_async()
1918 static inline int regmap_update_bits_check(struct regmap *map, unsigned int reg,  in regmap_update_bits_check()
1923 	return -EINVAL;  in regmap_update_bits_check()
1926 static inline int
1932 	return -EINVAL;  in regmap_update_bits_check_async()
1935 static inline int regmap_write_bits(struct regmap *map, unsigned int reg,  in regmap_write_bits()
1939 	return -EINVAL;  in regmap_write_bits()
1942 static inline int regmap_field_write(struct regmap_field *field,  in regmap_field_write()
1946 	return -EINVAL;  in regmap_field_write()
1949 static inline int regmap_field_force_write(struct regmap_field *field,  in regmap_field_force_write()
1953 	return -EINVAL;  in regmap_field_force_write()
1956 static inline int regmap_field_update_bits(struct regmap_field *field,  in regmap_field_update_bits()
1960 	return -EINVAL;  in regmap_field_update_bits()
1963 static inline int
1968 	return -EINVAL;  in regmap_field_force_update_bits()
1971 static inline int regmap_field_set_bits(struct regmap_field *field,  in regmap_field_set_bits()
1975 	return -EINVAL;  in regmap_field_set_bits()
1978 static inline int regmap_field_clear_bits(struct regmap_field *field,  in regmap_field_clear_bits()
1982 	return -EINVAL;  in regmap_field_clear_bits()
1985 static inline int regmap_field_test_bits(struct regmap_field *field,  in regmap_field_test_bits()
1989 	return -EINVAL;  in regmap_field_test_bits()
1992 static inline int regmap_fields_write(struct regmap_field *field,  in regmap_fields_write()
1996 	return -EINVAL;  in regmap_fields_write()
1999 static inline int regmap_fields_force_write(struct regmap_field *field,  in regmap_fields_force_write()
2003 	return -EINVAL;  in regmap_fields_force_write()
2006 static inline int
2011 	return -EINVAL;  in regmap_fields_update_bits()
2014 static inline int
2019 	return -EINVAL;  in regmap_fields_force_update_bits()
2022 static inline int regmap_get_val_bytes(struct regmap *map)  in regmap_get_val_bytes()
2025 	return -EINVAL;  in regmap_get_val_bytes()
2028 static inline int regmap_get_max_register(struct regmap *map)  in regmap_get_max_register()
2031 	return -EINVAL;  in regmap_get_max_register()
2034 static inline int regmap_get_reg_stride(struct regmap *map)  in regmap_get_reg_stride()
2037 	return -EINVAL;  in regmap_get_reg_stride()
2040 static inline bool regmap_might_sleep(struct regmap *map)  in regmap_might_sleep()
2046 static inline int regcache_sync(struct regmap *map)  in regcache_sync()
2049 	return -EINVAL;  in regcache_sync()
2052 static inline int regcache_sync_region(struct regmap *map, unsigned int min,  in regcache_sync_region()
2056 	return -EINVAL;  in regcache_sync_region()
2059 static inline int regcache_drop_region(struct regmap *map, unsigned int min,  in regcache_drop_region()
2063 	return -EINVAL;  in regcache_drop_region()
2066 static inline void regcache_cache_only(struct regmap *map, bool enable)  in regcache_cache_only()
2071 static inline void regcache_cache_bypass(struct regmap *map, bool enable)  in regcache_cache_bypass()
2076 static inline void regcache_mark_dirty(struct regmap *map)  in regcache_mark_dirty()
2081 static inline void regmap_async_complete(struct regmap *map)  in regmap_async_complete()
2086 static inline int regmap_register_patch(struct regmap *map,  in regmap_register_patch()
2091 	return -EINVAL;  in regmap_register_patch()
2094 static inline int regmap_parse_val(struct regmap *map, const void *buf,  in regmap_parse_val()
2098 	return -EINVAL;  in regmap_parse_val()
2101 static inline struct regmap *dev_get_regmap(struct device *dev,  in dev_get_regmap()
2107 static inline struct device *regmap_get_device(struct regmap *map)  in regmap_get_device()