1 /* SPDX-License-Identifier: GPL-2.0-only */
49  * struct reg_default - Default value for a register.
63  * struct reg_sequence - An individual write from a sequence of writes.
86  * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs
93  *            tight-loops).  Should be less than ~20ms since usleep_range
94  *            is used (see Documentation/timers/timers-howto.rst).
97  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
113  * regmap_read_poll_timeout_atomic - Poll until a condition is met or a timeout occurs
119  * @delay_us: Time to udelay between reads in us (0 tight-loops).
121  *            (see Documentation/timers/timers-howto.rst).
124  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
154 	__ret ?: ((cond) ? 0 : -ETIMEDOUT); \
158  * regmap_field_read_poll_timeout - Poll until a condition is met or timeout
164  *            tight-loops).  Should be less than ~20ms since usleep_range
165  *            is used (see Documentation/timers/timers-howto.rst).
168  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read
186 	/* Unspecified -> 0 -> Backwards compatible default */
194  * struct regmap_range - A register range, used for access related checks
208  * struct regmap_access_table - A table of register ranges for access checks
231  * struct regmap_config - Configuration for the register map of a device.
237  * @reg_stride: The register address stride. Valid register addresses are a
313  *		   Use it only for "no-bus" cases.
316  * @max_register: Optional, specifies the maximum valid register address.
318  *                valid ranges for write access.
328  * @read_flag_mask: Mask to be set in the top bytes of the register when doing
330  * @write_flag_mask: Mask to be set in the top bytes of the register when doing
395 			       unsigned int mask, unsigned int val);
443  * struct regmap_range_cfg - Configuration for indirectly accessed or paged
452  * @selector_mask: Bit mask for selector value.
502 					 unsigned int mask, unsigned int val);
507  * struct regmap_bus - Description of a hardware bus for the register map
515  * @gather_write: Write operation with split register/value, return -ENOTSUPP
518  *               must serialise with respect to non-async I/O.
532  * @read_flag_mask: Mask to be set in the top byte of the register when doing
698  * for each call. No-op if CONFIG_LOCKDEP is not set.
711 			"(" name ")->lock");				\
719  * regmap_init() - Initialise register map
722  * @bus: Bus-specific callbacks to use with device
723  * @bus_context: Data passed to bus-specific callbacks
726  * The return value will be an ERR_PTR() on error or a valid pointer to
728  * directly, it should be called by bus-specific init functions.
737  * regmap_init_i2c() - Initialise register map
742  * The return value will be an ERR_PTR() on error or a valid pointer to
750  * regmap_init_mdio() - Initialise register map
755  * The return value will be an ERR_PTR() on error or a valid pointer to
763  * regmap_init_sccb() - Initialise register map
768  * The return value will be an ERR_PTR() on error or a valid pointer to
776  * regmap_init_slimbus() - Initialise register map
781  * The return value will be an ERR_PTR() on error or a valid pointer to
789  * regmap_init_spi() - Initialise register map
794  * The return value will be an ERR_PTR() on error or a valid pointer to
802  * regmap_init_spmi_base() - Create regmap for the Base register space
807  * The return value will be an ERR_PTR() on error or a valid pointer to
815  * regmap_init_spmi_ext() - Create regmap for Ext register space
820  * The return value will be an ERR_PTR() on error or a valid pointer to
828  * regmap_init_w1() - Initialise register map
833  * The return value will be an ERR_PTR() on error or a valid pointer to
841  * regmap_init_mmio_clk() - Initialise register map with register clock
845  * @regs: Pointer to memory-mapped IO region
848  * The return value will be an ERR_PTR() on error or a valid pointer to
856  * regmap_init_mmio() - Initialise register map
859  * @regs: Pointer to memory-mapped IO region
862  * The return value will be an ERR_PTR() on error or a valid pointer to
869  * regmap_init_ac97() - Initialise AC'97 register map
874  * The return value will be an ERR_PTR() on error or a valid pointer to
883  * regmap_init_sdw() - Initialise register map
888  * The return value will be an ERR_PTR() on error or a valid pointer to
896  * regmap_init_sdw_mbq() - Initialise register map
901  * The return value will be an ERR_PTR() on error or a valid pointer to
909  * regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
915  * The return value will be an ERR_PTR() on error or a valid pointer
923  * devm_regmap_init() - Initialise managed register map
926  * @bus: Bus-specific callbacks to use with device
927  * @bus_context: Data passed to bus-specific callbacks
930  * The return value will be an ERR_PTR() on error or a valid pointer
932  * directly, it should be called by bus-specific init functions.  The
940  * devm_regmap_init_i2c() - Initialise managed register map
945  * The return value will be an ERR_PTR() on error or a valid pointer
954  * devm_regmap_init_mdio() - Initialise managed register map
959  * The return value will be an ERR_PTR() on error or a valid pointer
968  * devm_regmap_init_sccb() - Initialise managed register map
973  * The return value will be an ERR_PTR() on error or a valid pointer
982  * devm_regmap_init_spi() - Initialise register map
987  * The return value will be an ERR_PTR() on error or a valid pointer
996  * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
1001  * The return value will be an ERR_PTR() on error or a valid pointer
1010  * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
1015  * The return value will be an ERR_PTR() on error or a valid pointer
1024  * devm_regmap_init_w1() - Initialise managed register map
1029  * The return value will be an ERR_PTR() on error or a valid pointer
1037  * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
1041  * @regs: Pointer to memory-mapped IO region
1044  * The return value will be an ERR_PTR() on error or a valid pointer
1053  * devm_regmap_init_mmio() - Initialise managed register map
1056  * @regs: Pointer to memory-mapped IO region
1059  * The return value will be an ERR_PTR() on error or a valid pointer
1067  * devm_regmap_init_ac97() - Initialise AC'97 register map
1072  * The return value will be an ERR_PTR() on error or a valid pointer
1081  * devm_regmap_init_sdw() - Initialise managed register map
1086  * The return value will be an ERR_PTR() on error or a valid pointer
1095  * devm_regmap_init_sdw_mbq() - Initialise managed register map
1100  * The return value will be an ERR_PTR() on error or a valid pointer
1109  * devm_regmap_init_slimbus() - Initialise managed register map
1114  * The return value will be an ERR_PTR() on error or a valid pointer
1123  * devm_regmap_init_i3c() - Initialise managed register map
1128  * The return value will be an ERR_PTR() on error or a valid pointer
1137  * devm_regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
1143  * The return value will be an ERR_PTR() on error or a valid pointer
1181 			    unsigned int mask, unsigned int val,
1185 				     unsigned int mask, unsigned int val)  in regmap_update_bits()  argument
1187 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, false);  in regmap_update_bits()
1191 					   unsigned int mask, unsigned int val)  in regmap_update_bits_async()  argument
1193 	return regmap_update_bits_base(map, reg, mask, val, NULL, true, false);  in regmap_update_bits_async()
1197 					   unsigned int mask, unsigned int val,  in regmap_update_bits_check()  argument
1200 	return regmap_update_bits_base(map, reg, mask, val,  in regmap_update_bits_check()
1206 			       unsigned int mask, unsigned int val,  in regmap_update_bits_check_async()  argument
1209 	return regmap_update_bits_base(map, reg, mask, val,  in regmap_update_bits_check_async()
1214 				    unsigned int mask, unsigned int val)  in regmap_write_bits()  argument
1216 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, true);  in regmap_write_bits()
1247 	return reg >= range->range_min && reg <= range->range_max;  in regmap_reg_in_range()
1270  * struct reg_field - Description of an register field
1322 				  unsigned int mask, unsigned int val,
1327 				   unsigned int mask, unsigned int val,
1344 					   unsigned int mask, unsigned int val)  in regmap_field_update_bits()  argument
1346 	return regmap_field_update_bits_base(field, mask, val,  in regmap_field_update_bits()
1368 			       unsigned int mask, unsigned int val)  in regmap_field_force_update_bits()  argument
1370 	return regmap_field_update_bits_base(field, mask, val,  in regmap_field_force_update_bits()
1390 			  unsigned int mask, unsigned int val)  in regmap_fields_update_bits()  argument
1392 	return regmap_fields_update_bits_base(field, id, mask, val,  in regmap_fields_update_bits()
1398 				unsigned int mask, unsigned int val)  in regmap_fields_force_update_bits()  argument
1400 	return regmap_fields_update_bits_base(field, id, mask, val,  in regmap_fields_force_update_bits()
1405  * struct regmap_irq_type - IRQ type definitions.
1425  * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
1427  * @reg_offset: Offset of the status/mask register within the bank
1428  * @mask:       Mask used to flag/control the register.
1433 	unsigned int mask;  member
1438 	[_irq] = { .reg_offset = (_off), .mask = (_mask) }
1442 		.mask = BIT((_id) % (_reg_bits)),	\
1457  * struct regmap_irq_chip - Description of a generic regmap irq_chip.
1462  *		 interrupts arranged in separate sub-irq blocks with own IRQ
1464  *		 sub-irq blocks with unhandled interrupts. For such chips fill
1465  *		 sub-irq register information in status_base, mask_base and
1475  *		     1.st bit to 1.st sub-reg, 2.nd bit to 2.nd sub-reg, ...
1476  *		     When used with not_fixed_stride, each one-element array
1483  * @mask_base:   Base mask register address. Mask bits are set to 1 when an
1497  * @mask_invert: Inverted mask register: cleared bits are masked out.
1498  *		 Deprecated; prefer describing an inverted mask register as
1500  * @mask_unmask_non_inverted: Controls mask bit inversion for chips that set
1501  *	both @mask_base and @unmask_base. If false, mask and unmask bits are
1510  * @clear_ack:  Use this to set 1 and 0 or vice-versa to clear interrupts.
1514  * @type_in_mask: Use the mask registers for controlling irq type. Use this if
1518  *		  to define the mask bit for each irq type.
1536  * @num_virt_regs:   Number of non-standard irq configuration registers.
1660 	return -EINVAL;  in regmap_write()
1667 	return -EINVAL;  in regmap_write_async()
1674 	return -EINVAL;  in regmap_raw_write()
1681 	return -EINVAL;  in regmap_raw_write_async()
1688 	return -EINVAL;  in regmap_noinc_write()
1695 	return -EINVAL;  in regmap_bulk_write()
1702 	return -EINVAL;  in regmap_read()
1709 	return -EINVAL;  in regmap_raw_read()
1716 	return -EINVAL;  in regmap_noinc_read()
1723 	return -EINVAL;  in regmap_bulk_read()
1727 					  unsigned int mask, unsigned int val,  in regmap_update_bits_base()  argument
1731 	return -EINVAL;  in regmap_update_bits_base()
1738 	return -EINVAL;  in regmap_set_bits()
1745 	return -EINVAL;  in regmap_clear_bits()
1752 	return -EINVAL;  in regmap_test_bits()
1756 					unsigned int mask, unsigned int val,  in regmap_field_update_bits_base()  argument
1760 	return -EINVAL;  in regmap_field_update_bits_base()
1765 				   unsigned int mask, unsigned int val,  in regmap_fields_update_bits_base()  argument
1769 	return -EINVAL;  in regmap_fields_update_bits_base()
1773 				     unsigned int mask, unsigned int val)  in regmap_update_bits()  argument
1776 	return -EINVAL;  in regmap_update_bits()
1780 					   unsigned int mask, unsigned int val)  in regmap_update_bits_async()  argument
1783 	return -EINVAL;  in regmap_update_bits_async()
1787 					   unsigned int mask, unsigned int val,  in regmap_update_bits_check()  argument
1791 	return -EINVAL;  in regmap_update_bits_check()
1796 			       unsigned int mask, unsigned int val,  in regmap_update_bits_check_async()  argument
1800 	return -EINVAL;  in regmap_update_bits_check_async()
1804 				    unsigned int mask, unsigned int val)  in regmap_write_bits()  argument
1807 	return -EINVAL;  in regmap_write_bits()
1814 	return -EINVAL;  in regmap_field_write()
1821 	return -EINVAL;  in regmap_field_force_write()
1825 					   unsigned int mask, unsigned int val)  in regmap_field_update_bits()  argument
1828 	return -EINVAL;  in regmap_field_update_bits()
1833 			       unsigned int mask, unsigned int val)  in regmap_field_force_update_bits()  argument
1836 	return -EINVAL;  in regmap_field_force_update_bits()
1843 	return -EINVAL;  in regmap_field_set_bits()
1850 	return -EINVAL;  in regmap_field_clear_bits()
1857 	return -EINVAL;  in regmap_field_test_bits()
1864 	return -EINVAL;  in regmap_fields_write()
1871 	return -EINVAL;  in regmap_fields_force_write()
1876 			  unsigned int mask, unsigned int val)  in regmap_fields_update_bits()  argument
1879 	return -EINVAL;  in regmap_fields_update_bits()
1884 				unsigned int mask, unsigned int val)  in regmap_fields_force_update_bits()  argument
1887 	return -EINVAL;  in regmap_fields_force_update_bits()
1893 	return -EINVAL;  in regmap_get_val_bytes()
1899 	return -EINVAL;  in regmap_get_max_register()
1905 	return -EINVAL;  in regmap_get_reg_stride()
1911 	return -EINVAL;  in regcache_sync()
1918 	return -EINVAL;  in regcache_sync_region()
1925 	return -EINVAL;  in regcache_drop_region()
1953 	return -EINVAL;  in regmap_register_patch()
1960 	return -EINVAL;  in regmap_parse_val()