1 /* SPDX-License-Identifier: GPL-2.0-only */
54 #define REGMAP_UPSHIFT(s)	(-(s))
66  * struct reg_default - Default value for a register.
80  * struct reg_sequence - An individual write from a sequence of writes.
103  * regmap_read_poll_timeout - Poll until a condition is met or a timeout occurs
110  *            tight-loops).  Should be less than ~20ms since usleep_range
111  *            is used (see Documentation/timers/timers-howto.rst).
114  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
130  * regmap_read_poll_timeout_atomic - Poll until a condition is met or a timeout occurs
136  * @delay_us: Time to udelay between reads in us (0 tight-loops).
138  *            (see Documentation/timers/timers-howto.rst).
141  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_read
171 	__ret ?: ((cond) ? 0 : -ETIMEDOUT); \
175  * regmap_field_read_poll_timeout - Poll until a condition is met or timeout
181  *            tight-loops).  Should be less than ~20ms since usleep_range
182  *            is used (see Documentation/timers/timers-howto.rst).
185  * Returns 0 on success and -ETIMEDOUT upon a timeout or the regmap_field_read
203 	/* Unspecified -> 0 -> Backwards compatible default */
211  * struct regmap_range - A register range, used for access related checks
225  * struct regmap_access_table - A table of register ranges for access checks
248  * struct regmap_config - Configuration for the register map of a device.
254  * @reg_stride: The register address stride. Valid register addresses are a
331  *		   Use it only for "no-bus" cases.
334  * @max_register: Optional, specifies the maximum valid register address.
336  *                valid ranges for write access.
346  * @read_flag_mask: Mask to be set in the top bytes of the register when doing
348  * @write_flag_mask: Mask to be set in the top bytes of the register when doing
413 			       unsigned int mask, unsigned int val);
461  * struct regmap_range_cfg - Configuration for indirectly accessed or paged
470  * @selector_mask: Bit mask for selector value.
520 					 unsigned int mask, unsigned int val);
525  * struct regmap_bus - Description of a hardware bus for the register map
534  * @gather_write: Write operation with split register/value, return -ENOTSUPP
537  *               must serialise with respect to non-async I/O.
551  * @read_flag_mask: Mask to be set in the top byte of the register when doing
725  * for each call. No-op if CONFIG_LOCKDEP is not set.
738 			"(" name ")->lock");				\
746  * regmap_init() - Initialise register map
749  * @bus: Bus-specific callbacks to use with device
750  * @bus_context: Data passed to bus-specific callbacks
753  * The return value will be an ERR_PTR() on error or a valid pointer to
755  * directly, it should be called by bus-specific init functions.
764  * regmap_init_i2c() - Initialise register map
769  * The return value will be an ERR_PTR() on error or a valid pointer to
777  * regmap_init_mdio() - Initialise register map
782  * The return value will be an ERR_PTR() on error or a valid pointer to
790  * regmap_init_sccb() - Initialise register map
795  * The return value will be an ERR_PTR() on error or a valid pointer to
803  * regmap_init_slimbus() - Initialise register map
808  * The return value will be an ERR_PTR() on error or a valid pointer to
816  * regmap_init_spi() - Initialise register map
821  * The return value will be an ERR_PTR() on error or a valid pointer to
829  * regmap_init_spmi_base() - Create regmap for the Base register space
834  * The return value will be an ERR_PTR() on error or a valid pointer to
842  * regmap_init_spmi_ext() - Create regmap for Ext register space
847  * The return value will be an ERR_PTR() on error or a valid pointer to
855  * regmap_init_w1() - Initialise register map
860  * The return value will be an ERR_PTR() on error or a valid pointer to
868  * regmap_init_mmio_clk() - Initialise register map with register clock
872  * @regs: Pointer to memory-mapped IO region
875  * The return value will be an ERR_PTR() on error or a valid pointer to
883  * regmap_init_mmio() - Initialise register map
886  * @regs: Pointer to memory-mapped IO region
889  * The return value will be an ERR_PTR() on error or a valid pointer to
896  * regmap_init_ac97() - Initialise AC'97 register map
901  * The return value will be an ERR_PTR() on error or a valid pointer to
910  * regmap_init_sdw() - Initialise register map
915  * The return value will be an ERR_PTR() on error or a valid pointer to
923  * regmap_init_sdw_mbq() - Initialise register map
928  * The return value will be an ERR_PTR() on error or a valid pointer to
936  * regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
942  * The return value will be an ERR_PTR() on error or a valid pointer
950  * regmap_init_fsi() - Initialise register map
955  * The return value will be an ERR_PTR() on error or a valid pointer to
963  * devm_regmap_init() - Initialise managed register map
966  * @bus: Bus-specific callbacks to use with device
967  * @bus_context: Data passed to bus-specific callbacks
970  * The return value will be an ERR_PTR() on error or a valid pointer
972  * directly, it should be called by bus-specific init functions.  The
980  * devm_regmap_init_i2c() - Initialise managed register map
985  * The return value will be an ERR_PTR() on error or a valid pointer
994  * devm_regmap_init_mdio() - Initialise managed register map
999  * The return value will be an ERR_PTR() on error or a valid pointer
1008  * devm_regmap_init_sccb() - Initialise managed register map
1013  * The return value will be an ERR_PTR() on error or a valid pointer
1022  * devm_regmap_init_spi() - Initialise register map
1027  * The return value will be an ERR_PTR() on error or a valid pointer
1036  * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
1041  * The return value will be an ERR_PTR() on error or a valid pointer
1050  * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
1055  * The return value will be an ERR_PTR() on error or a valid pointer
1064  * devm_regmap_init_w1() - Initialise managed register map
1069  * The return value will be an ERR_PTR() on error or a valid pointer
1077  * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
1081  * @regs: Pointer to memory-mapped IO region
1084  * The return value will be an ERR_PTR() on error or a valid pointer
1093  * devm_regmap_init_mmio() - Initialise managed register map
1096  * @regs: Pointer to memory-mapped IO region
1099  * The return value will be an ERR_PTR() on error or a valid pointer
1107  * devm_regmap_init_ac97() - Initialise AC'97 register map
1112  * The return value will be an ERR_PTR() on error or a valid pointer
1121  * devm_regmap_init_sdw() - Initialise managed register map
1126  * The return value will be an ERR_PTR() on error or a valid pointer
1135  * devm_regmap_init_sdw_mbq() - Initialise managed register map
1140  * The return value will be an ERR_PTR() on error or a valid pointer
1149  * devm_regmap_init_slimbus() - Initialise managed register map
1154  * The return value will be an ERR_PTR() on error or a valid pointer
1163  * devm_regmap_init_i3c() - Initialise managed register map
1168  * The return value will be an ERR_PTR() on error or a valid pointer
1177  * devm_regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
1183  * The return value will be an ERR_PTR() on error or a valid pointer
1192  * devm_regmap_init_fsi() - Initialise managed register map
1197  * The return value will be an ERR_PTR() on error or a valid pointer
1235 			    unsigned int mask, unsigned int val,
1239 				     unsigned int mask, unsigned int val)  in regmap_update_bits()  argument
1241 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, false);  in regmap_update_bits()
1245 					   unsigned int mask, unsigned int val)  in regmap_update_bits_async()  argument
1247 	return regmap_update_bits_base(map, reg, mask, val, NULL, true, false);  in regmap_update_bits_async()
1251 					   unsigned int mask, unsigned int val,  in regmap_update_bits_check()  argument
1254 	return regmap_update_bits_base(map, reg, mask, val,  in regmap_update_bits_check()
1260 			       unsigned int mask, unsigned int val,  in regmap_update_bits_check_async()  argument
1263 	return regmap_update_bits_base(map, reg, mask, val,  in regmap_update_bits_check_async()
1268 				    unsigned int mask, unsigned int val)  in regmap_write_bits()  argument
1270 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, true);  in regmap_write_bits()
1303 	return reg >= range->range_min && reg <= range->range_max;  in regmap_reg_in_range()
1326  * struct reg_field - Description of an register field
1378 				  unsigned int mask, unsigned int val,
1383 				   unsigned int mask, unsigned int val,
1400 					   unsigned int mask, unsigned int val)  in regmap_field_update_bits()  argument
1402 	return regmap_field_update_bits_base(field, mask, val,  in regmap_field_update_bits()
1424 			       unsigned int mask, unsigned int val)  in regmap_field_force_update_bits()  argument
1426 	return regmap_field_update_bits_base(field, mask, val,  in regmap_field_force_update_bits()
1446 			  unsigned int mask, unsigned int val)  in regmap_fields_update_bits()  argument
1448 	return regmap_fields_update_bits_base(field, id, mask, val,  in regmap_fields_update_bits()
1454 				unsigned int mask, unsigned int val)  in regmap_fields_force_update_bits()  argument
1456 	return regmap_fields_update_bits_base(field, id, mask, val,  in regmap_fields_force_update_bits()
1461  * struct regmap_irq_type - IRQ type definitions.
1481  * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
1483  * @reg_offset: Offset of the status/mask register within the bank
1484  * @mask:       Mask used to flag/control the register.
1489 	unsigned int mask;  member
1494 	[_irq] = { .reg_offset = (_off), .mask = (_mask) }
1498 		.mask = BIT((_id) % (_reg_bits)),	\
1513  * struct regmap_irq_chip - Description of a generic regmap irq_chip.
1518  *		 interrupts arranged in separate sub-irq blocks with own IRQ
1520  *		 sub-irq blocks with unhandled interrupts. For such chips fill
1521  *		 sub-irq register information in status_base, mask_base and
1531  *		     1.st bit to 1.st sub-reg, 2.nd bit to 2.nd sub-reg, ...
1536  * @mask_base:   Base mask register address. Mask bits are set to 1 when an
1546  * @mask_unmask_non_inverted: Controls mask bit inversion for chips that set
1547  *	both @mask_base and @unmask_base. If false, mask and unmask bits are
1556  * @clear_ack:  Use this to set 1 and 0 or vice-versa to clear interrupts.
1559  * @type_in_mask: Use the mask registers for controlling irq type. Use this if
1563  *		  to define the mask bit for each irq type.
1582  * @handle_mask_sync: Callback used to handle IRQ mask syncs. The index will be
1692 	return -EINVAL;  in regmap_write()
1699 	return -EINVAL;  in regmap_write_async()
1706 	return -EINVAL;  in regmap_raw_write()
1713 	return -EINVAL;  in regmap_raw_write_async()
1720 	return -EINVAL;  in regmap_noinc_write()
1727 	return -EINVAL;  in regmap_bulk_write()
1734 	return -EINVAL;  in regmap_read()
1741 	return -EINVAL;  in regmap_raw_read()
1748 	return -EINVAL;  in regmap_noinc_read()
1755 	return -EINVAL;  in regmap_bulk_read()
1759 					  unsigned int mask, unsigned int val,  in regmap_update_bits_base()  argument
1763 	return -EINVAL;  in regmap_update_bits_base()
1770 	return -EINVAL;  in regmap_set_bits()
1777 	return -EINVAL;  in regmap_clear_bits()
1784 	return -EINVAL;  in regmap_test_bits()
1788 					unsigned int mask, unsigned int val,  in regmap_field_update_bits_base()  argument
1792 	return -EINVAL;  in regmap_field_update_bits_base()
1797 				   unsigned int mask, unsigned int val,  in regmap_fields_update_bits_base()  argument
1801 	return -EINVAL;  in regmap_fields_update_bits_base()
1805 				     unsigned int mask, unsigned int val)  in regmap_update_bits()  argument
1808 	return -EINVAL;  in regmap_update_bits()
1812 					   unsigned int mask, unsigned int val)  in regmap_update_bits_async()  argument
1815 	return -EINVAL;  in regmap_update_bits_async()
1819 					   unsigned int mask, unsigned int val,  in regmap_update_bits_check()  argument
1823 	return -EINVAL;  in regmap_update_bits_check()
1828 			       unsigned int mask, unsigned int val,  in regmap_update_bits_check_async()  argument
1832 	return -EINVAL;  in regmap_update_bits_check_async()
1836 				    unsigned int mask, unsigned int val)  in regmap_write_bits()  argument
1839 	return -EINVAL;  in regmap_write_bits()
1846 	return -EINVAL;  in regmap_field_write()
1853 	return -EINVAL;  in regmap_field_force_write()
1857 					   unsigned int mask, unsigned int val)  in regmap_field_update_bits()  argument
1860 	return -EINVAL;  in regmap_field_update_bits()
1865 			       unsigned int mask, unsigned int val)  in regmap_field_force_update_bits()  argument
1868 	return -EINVAL;  in regmap_field_force_update_bits()
1875 	return -EINVAL;  in regmap_field_set_bits()
1882 	return -EINVAL;  in regmap_field_clear_bits()
1889 	return -EINVAL;  in regmap_field_test_bits()
1896 	return -EINVAL;  in regmap_fields_write()
1903 	return -EINVAL;  in regmap_fields_force_write()
1908 			  unsigned int mask, unsigned int val)  in regmap_fields_update_bits()  argument
1911 	return -EINVAL;  in regmap_fields_update_bits()
1916 				unsigned int mask, unsigned int val)  in regmap_fields_force_update_bits()  argument
1919 	return -EINVAL;  in regmap_fields_force_update_bits()
1925 	return -EINVAL;  in regmap_get_val_bytes()
1931 	return -EINVAL;  in regmap_get_max_register()
1937 	return -EINVAL;  in regmap_get_reg_stride()
1949 	return -EINVAL;  in regcache_sync()
1956 	return -EINVAL;  in regcache_sync_region()
1963 	return -EINVAL;  in regcache_drop_region()
1991 	return -EINVAL;  in regmap_register_patch()
1998 	return -EINVAL;  in regmap_parse_val()