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
298  *		   Use it only for "no-bus" cases.
299  * @max_register: Optional, specifies the maximum valid register address.
301  *                valid ranges for write access.
311  * @read_flag_mask: Mask to be set in the top bytes of the register when doing
313  * @write_flag_mask: Mask to be set in the top bytes of the register when doing
410  * struct regmap_range_cfg - Configuration for indirectly accessed or paged
419  * @selector_mask: Bit mask for selector value.
467 					 unsigned int mask, unsigned int val);
472  * struct regmap_bus - Description of a hardware bus for the register map
480  * @gather_write: Write operation with split register/value, return -ENOTSUPP
483  *               must serialise with respect to non-async I/O.
495  * @read_flag_mask: Mask to be set in the top byte of the register when doing
643  * for each call. No-op if CONFIG_LOCKDEP is not set.
656 			"(" name ")->lock");				\
664  * regmap_init() - Initialise register map
667  * @bus: Bus-specific callbacks to use with device
668  * @bus_context: Data passed to bus-specific callbacks
671  * The return value will be an ERR_PTR() on error or a valid pointer to
673  * directly, it should be called by bus-specific init functions.
682  * regmap_init_i2c() - Initialise register map
687  * The return value will be an ERR_PTR() on error or a valid pointer to
695  * regmap_init_sccb() - Initialise register map
700  * The return value will be an ERR_PTR() on error or a valid pointer to
708  * regmap_init_slimbus() - Initialise register map
713  * The return value will be an ERR_PTR() on error or a valid pointer to
721  * regmap_init_spi() - Initialise register map
726  * The return value will be an ERR_PTR() on error or a valid pointer to
734  * regmap_init_spmi_base() - Create regmap for the Base register space
739  * The return value will be an ERR_PTR() on error or a valid pointer to
747  * regmap_init_spmi_ext() - Create regmap for Ext register space
752  * The return value will be an ERR_PTR() on error or a valid pointer to
760  * regmap_init_w1() - Initialise register map
765  * The return value will be an ERR_PTR() on error or a valid pointer to
773  * regmap_init_mmio_clk() - Initialise register map with register clock
777  * @regs: Pointer to memory-mapped IO region
780  * The return value will be an ERR_PTR() on error or a valid pointer to
788  * regmap_init_mmio() - Initialise register map
791  * @regs: Pointer to memory-mapped IO region
794  * The return value will be an ERR_PTR() on error or a valid pointer to
801  * regmap_init_ac97() - Initialise AC'97 register map
806  * The return value will be an ERR_PTR() on error or a valid pointer to
815  * regmap_init_sdw() - Initialise register map
820  * The return value will be an ERR_PTR() on error or a valid pointer to
828  * regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
834  * The return value will be an ERR_PTR() on error or a valid pointer
842  * devm_regmap_init() - Initialise managed register map
845  * @bus: Bus-specific callbacks to use with device
846  * @bus_context: Data passed to bus-specific callbacks
849  * The return value will be an ERR_PTR() on error or a valid pointer
851  * directly, it should be called by bus-specific init functions.  The
859  * devm_regmap_init_i2c() - Initialise managed register map
864  * The return value will be an ERR_PTR() on error or a valid pointer
873  * devm_regmap_init_sccb() - Initialise managed register map
878  * The return value will be an ERR_PTR() on error or a valid pointer
887  * devm_regmap_init_spi() - Initialise register map
892  * The return value will be an ERR_PTR() on error or a valid pointer
901  * devm_regmap_init_spmi_base() - Create managed regmap for Base register space
906  * The return value will be an ERR_PTR() on error or a valid pointer
915  * devm_regmap_init_spmi_ext() - Create managed regmap for Ext register space
920  * The return value will be an ERR_PTR() on error or a valid pointer
929  * devm_regmap_init_w1() - Initialise managed register map
934  * The return value will be an ERR_PTR() on error or a valid pointer
942  * devm_regmap_init_mmio_clk() - Initialise managed register map with clock
946  * @regs: Pointer to memory-mapped IO region
949  * The return value will be an ERR_PTR() on error or a valid pointer
958  * devm_regmap_init_mmio() - Initialise managed register map
961  * @regs: Pointer to memory-mapped IO region
964  * The return value will be an ERR_PTR() on error or a valid pointer
972  * devm_regmap_init_ac97() - Initialise AC'97 register map
977  * The return value will be an ERR_PTR() on error or a valid pointer
986  * devm_regmap_init_sdw() - Initialise managed register map
991  * The return value will be an ERR_PTR() on error or a valid pointer
1000  * devm_regmap_init_slimbus() - Initialise managed register map
1005  * The return value will be an ERR_PTR() on error or a valid pointer
1014  * devm_regmap_init_i3c() - Initialise managed register map
1019  * The return value will be an ERR_PTR() on error or a valid pointer
1028  * devm_regmap_init_spi_avmm() - Initialize register map for Intel SPI Slave
1034  * The return value will be an ERR_PTR() on error or a valid pointer
1072 			    unsigned int mask, unsigned int val,
1076 				     unsigned int mask, unsigned int val)  in regmap_update_bits()  argument
1078 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, false);  in regmap_update_bits()
1082 					   unsigned int mask, unsigned int val)  in regmap_update_bits_async()  argument
1084 	return regmap_update_bits_base(map, reg, mask, val, NULL, true, false);  in regmap_update_bits_async()
1088 					   unsigned int mask, unsigned int val,  in regmap_update_bits_check()  argument
1091 	return regmap_update_bits_base(map, reg, mask, val,  in regmap_update_bits_check()
1097 			       unsigned int mask, unsigned int val,  in regmap_update_bits_check_async()  argument
1100 	return regmap_update_bits_base(map, reg, mask, val,  in regmap_update_bits_check_async()
1105 				    unsigned int mask, unsigned int val)  in regmap_write_bits()  argument
1107 	return regmap_update_bits_base(map, reg, mask, val, NULL, false, true);  in regmap_write_bits()
1138 	return reg >= range->range_min && reg <= range->range_max;  in regmap_reg_in_range()
1161  * struct reg_field - Description of an register field
1212 				  unsigned int mask, unsigned int val,
1217 				   unsigned int mask, unsigned int val,
1234 					   unsigned int mask, unsigned int val)  in regmap_field_update_bits()  argument
1236 	return regmap_field_update_bits_base(field, mask, val,  in regmap_field_update_bits()
1242 			       unsigned int mask, unsigned int val)  in regmap_field_force_update_bits()  argument
1244 	return regmap_field_update_bits_base(field, mask, val,  in regmap_field_force_update_bits()
1264 			  unsigned int mask, unsigned int val)  in regmap_fields_update_bits()  argument
1266 	return regmap_fields_update_bits_base(field, id, mask, val,  in regmap_fields_update_bits()
1272 				unsigned int mask, unsigned int val)  in regmap_fields_force_update_bits()  argument
1274 	return regmap_fields_update_bits_base(field, id, mask, val,  in regmap_fields_force_update_bits()
1279  * struct regmap_irq_type - IRQ type definitions.
1299  * struct regmap_irq - Description of an IRQ for the generic regmap irq_chip.
1301  * @reg_offset: Offset of the status/mask register within the bank
1302  * @mask:       Mask used to flag/control the register.
1307 	unsigned int mask;  member
1312 	[_irq] = { .reg_offset = (_off), .mask = (_mask) }
1316 		.mask = BIT((_id) % (_reg_bits)),	\
1329  * struct regmap_irq_chip - Description of a generic regmap irq_chip.
1334  *		 interrupts arranged in separate sub-irq blocks with own IRQ
1336  *		 sub-irq blocks with unhandled interrupts. For such chips fill
1337  *		 sub-irq register information in status_base, mask_base and
1347  *		     1.st bit to 1.st sub-reg, 2.nd bit to 2.nd sub-reg, ...
1352  * @mask_base:   Base mask register address.
1353  * @mask_writeonly: Base mask register is write only.
1355  *                separate mask and unmask registers
1362  * @mask_invert: Inverted mask register: cleared bits are masked out.
1365  * @clear_ack:  Use this to set 1 and 0 or vice-versa to clear interrupts.
1368  * @type_in_mask: Use the mask registers for controlling irq type. For
1476 	return -EINVAL;  in regmap_write()
1483 	return -EINVAL;  in regmap_write_async()
1490 	return -EINVAL;  in regmap_raw_write()
1497 	return -EINVAL;  in regmap_raw_write_async()
1504 	return -EINVAL;  in regmap_noinc_write()
1511 	return -EINVAL;  in regmap_bulk_write()
1518 	return -EINVAL;  in regmap_read()
1525 	return -EINVAL;  in regmap_raw_read()
1532 	return -EINVAL;  in regmap_noinc_read()
1539 	return -EINVAL;  in regmap_bulk_read()
1543 					  unsigned int mask, unsigned int val,  in regmap_update_bits_base()  argument
1547 	return -EINVAL;  in regmap_update_bits_base()
1554 	return -EINVAL;  in regmap_set_bits()
1561 	return -EINVAL;  in regmap_clear_bits()
1568 	return -EINVAL;  in regmap_test_bits()
1572 					unsigned int mask, unsigned int val,  in regmap_field_update_bits_base()  argument
1576 	return -EINVAL;  in regmap_field_update_bits_base()
1581 				   unsigned int mask, unsigned int val,  in regmap_fields_update_bits_base()  argument
1585 	return -EINVAL;  in regmap_fields_update_bits_base()
1589 				     unsigned int mask, unsigned int val)  in regmap_update_bits()  argument
1592 	return -EINVAL;  in regmap_update_bits()
1596 					   unsigned int mask, unsigned int val)  in regmap_update_bits_async()  argument
1599 	return -EINVAL;  in regmap_update_bits_async()
1603 					   unsigned int mask, unsigned int val,  in regmap_update_bits_check()  argument
1607 	return -EINVAL;  in regmap_update_bits_check()
1612 			       unsigned int mask, unsigned int val,  in regmap_update_bits_check_async()  argument
1616 	return -EINVAL;  in regmap_update_bits_check_async()
1620 				    unsigned int mask, unsigned int val)  in regmap_write_bits()  argument
1623 	return -EINVAL;  in regmap_write_bits()
1630 	return -EINVAL;  in regmap_field_write()
1637 	return -EINVAL;  in regmap_field_force_write()
1641 					   unsigned int mask, unsigned int val)  in regmap_field_update_bits()  argument
1644 	return -EINVAL;  in regmap_field_update_bits()
1649 			       unsigned int mask, unsigned int val)  in regmap_field_force_update_bits()  argument
1652 	return -EINVAL;  in regmap_field_force_update_bits()
1659 	return -EINVAL;  in regmap_fields_write()
1666 	return -EINVAL;  in regmap_fields_force_write()
1671 			  unsigned int mask, unsigned int val)  in regmap_fields_update_bits()  argument
1674 	return -EINVAL;  in regmap_fields_update_bits()
1679 				unsigned int mask, unsigned int val)  in regmap_fields_force_update_bits()  argument
1682 	return -EINVAL;  in regmap_fields_force_update_bits()
1688 	return -EINVAL;  in regmap_get_val_bytes()
1694 	return -EINVAL;  in regmap_get_max_register()
1700 	return -EINVAL;  in regmap_get_reg_stride()
1706 	return -EINVAL;  in regcache_sync()
1713 	return -EINVAL;  in regcache_sync_region()
1720 	return -EINVAL;  in regcache_drop_region()
1748 	return -EINVAL;  in regmap_register_patch()
1755 	return -EINVAL;  in regmap_parse_val()