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.
261  * @reg_stride: The register address stride. Valid register addresses are a
330  *		   Use it only for "no-bus" cases.
342  * @max_register: Optional, specifies the maximum valid register address.
348  *                valid ranges for write access.
358  * @read_flag_mask: Mask to be set in the top bytes of the register when doing
360  * @write_flag_mask: Mask to be set in the top bytes of the register when doing
419 			       unsigned int mask, unsigned int val);
473  * struct regmap_range_cfg - Configuration for indirectly accessed or paged
482  * @selector_mask: Bit mask for selector value.
510  * struct regmap_sdw_mbq_cfg - Configuration for Multi-Byte Quantities
558 					 unsigned int mask, unsigned int val);
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.
589  * @read_flag_mask: Mask to be set in the top byte of the register when doing
765  * for each call. No-op if CONFIG_LOCKDEP is not set.
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
793  * The return value will be an ERR_PTR() on error or a valid pointer to
795  * directly, it should be called by bus-specific init functions.
804  * regmap_init_i2c() - Initialise register map
809  * The return value will be an ERR_PTR() on error or a valid pointer to
817  * regmap_init_mdio() - Initialise register map
822  * The return value will be an ERR_PTR() on error or a valid pointer to
830  * regmap_init_sccb() - Initialise register map
835  * The return value will be an ERR_PTR() on error or a valid pointer to
843  * regmap_init_slimbus() - Initialise register map
848  * The return value will be an ERR_PTR() on error or a valid pointer to
856  * regmap_init_spi() - Initialise register map
861  * The return value will be an ERR_PTR() on error or a valid pointer to
869  * regmap_init_spmi_base() - Create regmap for the Base register space
874  * The return value will be an ERR_PTR() on error or a valid pointer to
882  * regmap_init_spmi_ext() - Create regmap for Ext register space
887  * The return value will be an ERR_PTR() on error or a valid pointer to
895  * regmap_init_w1() - Initialise register map
900  * The return value will be an ERR_PTR() on error or a valid pointer to
908  * regmap_init_mmio_clk() - Initialise register map with register clock
912  * @regs: Pointer to memory-mapped IO region
915  * The return value will be an ERR_PTR() on error or a valid pointer to
923  * regmap_init_mmio() - Initialise register map
926  * @regs: Pointer to memory-mapped IO region
929  * The return value will be an ERR_PTR() on error or a valid pointer to
936  * regmap_init_ac97() - Initialise AC'97 register map
941  * The return value will be an ERR_PTR() on error or a valid pointer to
950  * regmap_init_sdw() - Initialise register map
955  * The return value will be an ERR_PTR() on error or a valid pointer to
963  * regmap_init_sdw_mbq() - Initialise register map
968  * The return value will be an ERR_PTR() on error or a valid pointer to
976  * regmap_init_sdw_mbq_cfg() - Initialise MBQ SDW register map with config
982  * The return value will be an ERR_PTR() on error or a valid pointer
991  * regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
997  * The return value will be an ERR_PTR() on error or a valid pointer
1005  * regmap_init_fsi() - Initialise register map
1010  * The return value will be an ERR_PTR() on error or a valid pointer to
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
1025  * The return value will be an ERR_PTR() on error or a valid pointer
1027  * directly, it should be called by bus-specific init functions.  The
1035  * devm_regmap_init_i2c() - Initialise managed register map
1040  * The return value will be an ERR_PTR() on error or a valid pointer
1049  * devm_regmap_init_mdio() - Initialise managed register map
1054  * The return value will be an ERR_PTR() on error or a valid pointer
1063  * devm_regmap_init_sccb() - Initialise managed register map
1068  * The return value will be an ERR_PTR() on error or a valid pointer
1077  * devm_regmap_init_spi() - Initialise register map
1082  * The return value will be an ERR_PTR() on error or a valid pointer
1091  * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
1096  * The return value will be an ERR_PTR() on error or a valid pointer
1105  * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
1110  * The return value will be an ERR_PTR() on error or a valid pointer
1119  * devm_regmap_init_w1() - Initialise managed register map
1124  * The return value will be an ERR_PTR() on error or a valid pointer
1132  * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
1136  * @regs: Pointer to memory-mapped IO region
1139  * The return value will be an ERR_PTR() on error or a valid pointer
1148  * devm_regmap_init_mmio() - Initialise managed register map
1151  * @regs: Pointer to memory-mapped IO region
1154  * The return value will be an ERR_PTR() on error or a valid pointer
1162  * devm_regmap_init_ac97() - Initialise AC'97 register map
1167  * The return value will be an ERR_PTR() on error or a valid pointer
1176  * devm_regmap_init_sdw() - Initialise managed register map
1181  * The return value will be an ERR_PTR() on error or a valid pointer
1190  * devm_regmap_init_sdw_mbq() - Initialise managed register map
1195  * The return value will be an ERR_PTR() on error or a valid pointer
1204  * devm_regmap_init_sdw_mbq_cfg() - Initialise managed MBQ SDW register map with config
1210  * The return value will be an ERR_PTR() on error or a valid pointer
1219  * devm_regmap_init_slimbus() - Initialise managed register map
1224  * The return value will be an ERR_PTR() on error or a valid pointer
1233  * devm_regmap_init_i3c() - Initialise managed register map
1238  * The return value will be an ERR_PTR() on error or a valid pointer
1247  * devm_regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
1253  * The return value will be an ERR_PTR() on error or a valid pointer
1262  * devm_regmap_init_fsi() - Initialise managed register map
1267  * The return value will be an ERR_PTR() on error or a valid pointer
1308 			    unsigned int mask, unsigned int val,
1312 				     unsigned int mask, unsigned int val)  in regmap_update_bits()  argument
1314 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, false);  in regmap_update_bits()
1318 					   unsigned int mask, unsigned int val)  in regmap_update_bits_async()  argument
1320 	return regmap_update_bits_base(map, reg, mask, val, NULL, true, false);  in regmap_update_bits_async()
1324 					   unsigned int mask, unsigned int val,  in regmap_update_bits_check()  argument
1327 	return regmap_update_bits_base(map, reg, mask, val,  in regmap_update_bits_check()
1333 			       unsigned int mask, unsigned int val,  in regmap_update_bits_check_async()  argument
1336 	return regmap_update_bits_base(map, reg, mask, val,  in regmap_update_bits_check_async()
1341 				    unsigned int mask, unsigned int val)  in regmap_write_bits()  argument
1343 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, true);  in regmap_write_bits()
1376 	return reg >= range->range_min && reg <= range->range_max;  in regmap_reg_in_range()
1408  * struct reg_field - Description of an register field
1460 				  unsigned int mask, unsigned int val,
1465 				   unsigned int mask, unsigned int val,
1482 					   unsigned int mask, unsigned int val)  in regmap_field_update_bits()  argument
1484 	return regmap_field_update_bits_base(field, mask, val,  in regmap_field_update_bits()
1506 			       unsigned int mask, unsigned int val)  in regmap_field_force_update_bits()  argument
1508 	return regmap_field_update_bits_base(field, mask, val,  in regmap_field_force_update_bits()
1528 			  unsigned int mask, unsigned int val)  in regmap_fields_update_bits()  argument
1530 	return regmap_fields_update_bits_base(field, id, mask, val,  in regmap_fields_update_bits()
1536 				unsigned int mask, unsigned int val)  in regmap_fields_force_update_bits()  argument
1538 	return regmap_fields_update_bits_base(field, id, mask, val,  in regmap_fields_force_update_bits()
1543  * struct regmap_irq_type - IRQ type definitions.
1563  * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
1565  * @reg_offset: Offset of the status/mask register within the bank
1566  * @mask:       Mask used to flag/control the register.
1571 	unsigned int mask;  member
1576 	[_irq] = { .reg_offset = (_off), .mask = (_mask) }
1580 		.mask = BIT((_id) % (_reg_bits)),	\
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, ...
1621  * @mask_base:   Base mask register address. Mask bits are set to 1 when an
1631  * @mask_unmask_non_inverted: Controls mask bit inversion for chips that set
1632  *	both @mask_base and @unmask_base. If false, mask and unmask bits are
1641  * @clear_ack:  Use this to set 1 and 0 or vice-versa to clear interrupts.
1644  * @type_in_mask: Use the mask registers for controlling irq type. Use this if
1648  *		  to define the mask bit for each irq type.
1667  * @handle_mask_sync: Callback used to handle IRQ mask syncs. The index will be
1778 	return -EINVAL;  in regmap_write()
1785 	return -EINVAL;  in regmap_write_async()
1792 	return -EINVAL;  in regmap_raw_write()
1799 	return -EINVAL;  in regmap_raw_write_async()
1806 	return -EINVAL;  in regmap_noinc_write()
1813 	return -EINVAL;  in regmap_bulk_write()
1820 	return -EINVAL;  in regmap_read()
1827 	return -EINVAL;  in regmap_read_bypassed()
1834 	return -EINVAL;  in regmap_raw_read()
1841 	return -EINVAL;  in regmap_noinc_read()
1848 	return -EINVAL;  in regmap_bulk_read()
1852 					  unsigned int mask, unsigned int val,  in regmap_update_bits_base()  argument
1856 	return -EINVAL;  in regmap_update_bits_base()
1863 	return -EINVAL;  in regmap_set_bits()
1870 	return -EINVAL;  in regmap_clear_bits()
1877 	return -EINVAL;  in regmap_assign_bits()
1884 	return -EINVAL;  in regmap_test_bits()
1888 					unsigned int mask, unsigned int val,  in regmap_field_update_bits_base()  argument
1892 	return -EINVAL;  in regmap_field_update_bits_base()
1897 				   unsigned int mask, unsigned int val,  in regmap_fields_update_bits_base()  argument
1901 	return -EINVAL;  in regmap_fields_update_bits_base()
1905 				     unsigned int mask, unsigned int val)  in regmap_update_bits()  argument
1908 	return -EINVAL;  in regmap_update_bits()
1912 					   unsigned int mask, unsigned int val)  in regmap_update_bits_async()  argument
1915 	return -EINVAL;  in regmap_update_bits_async()
1919 					   unsigned int mask, unsigned int val,  in regmap_update_bits_check()  argument
1923 	return -EINVAL;  in regmap_update_bits_check()
1928 			       unsigned int mask, unsigned int val,  in regmap_update_bits_check_async()  argument
1932 	return -EINVAL;  in regmap_update_bits_check_async()
1936 				    unsigned int mask, unsigned int val)  in regmap_write_bits()  argument
1939 	return -EINVAL;  in regmap_write_bits()
1946 	return -EINVAL;  in regmap_field_write()
1953 	return -EINVAL;  in regmap_field_force_write()
1957 					   unsigned int mask, unsigned int val)  in regmap_field_update_bits()  argument
1960 	return -EINVAL;  in regmap_field_update_bits()
1965 			       unsigned int mask, unsigned int val)  in regmap_field_force_update_bits()  argument
1968 	return -EINVAL;  in regmap_field_force_update_bits()
1975 	return -EINVAL;  in regmap_field_set_bits()
1982 	return -EINVAL;  in regmap_field_clear_bits()
1989 	return -EINVAL;  in regmap_field_test_bits()
1996 	return -EINVAL;  in regmap_fields_write()
2003 	return -EINVAL;  in regmap_fields_force_write()
2008 			  unsigned int mask, unsigned int val)  in regmap_fields_update_bits()  argument
2011 	return -EINVAL;  in regmap_fields_update_bits()
2016 				unsigned int mask, unsigned int val)  in regmap_fields_force_update_bits()  argument
2019 	return -EINVAL;  in regmap_fields_force_update_bits()
2025 	return -EINVAL;  in regmap_get_val_bytes()
2031 	return -EINVAL;  in regmap_get_max_register()
2037 	return -EINVAL;  in regmap_get_reg_stride()
2049 	return -EINVAL;  in regcache_sync()
2056 	return -EINVAL;  in regcache_sync_region()
2063 	return -EINVAL;  in regcache_drop_region()
2091 	return -EINVAL;  in regmap_register_patch()
2098 	return -EINVAL;  in regmap_parse_val()