iio/imu/adis.h

1 /* SPDX-License-Identifier: GPL-2.0-or-later */
6  *   Author: Lars-Peter Clausen <lars@metafoo.de>
28  * struct adis_timeouts - ADIS chip variant timeouts
29  * @reset_ms - Wait time after rst pin goes inactive
30  * @sw_reset_ms - Wait time after sw reset command
31  * @self_test_ms - Wait time after self test command
40  * struct adis_data - ADIS chip variant specific data
49  * @self_test_mask: Bitmask of supported self-test operations
51  * @self_test_no_autoclear: True if device's self-test needs clear of ctrl reg
58  * @burst_reg_cmd:	Register command that triggers burst
59  * @burst_len:		Burst size in the SPI RX buffer. If @burst_max_len is defined,
61  * @burst_max_len:	Holds the maximum burst size when the device supports
62  *			more than one burst mode with different sizes
63  * @burst_max_speed_hz:	Maximum spi speed that can be used in burst mode
98  * struct adis - ADIS device instance data
102  * @burst: ADIS burst transfer information
103  * @burst_extra_len: Burst extra length. Should only be used by devices that can
104  *		     dynamically change their burst mode length.
111  * @tx: DMA safe TX buffer for SPI transfers
138 	u8			tx[10] __aligned(IIO_DMA_MINALIGN);
147  * adis_reset() - Reset the device
154 	guard(mutex)(&adis->state_lock);  in adis_reset()
164  * __adis_write_reg_8() - Write single byte to a register (unlocked)
176  * __adis_write_reg_16() - Write 2 bytes to a pair of registers (unlocked)
188  * __adis_write_reg_32() - write 4 bytes to four registers (unlocked)
200  * __adis_read_reg_16() - read 2 bytes from a 16-bit register (unlocked)
219  * __adis_read_reg_32() - read 4 bytes from a 32-bit register (unlocked)
238  * adis_write_reg() - write N bytes to register
247 	guard(mutex)(&adis->state_lock);  in adis_write_reg()
252  * adis_read_reg() - read N bytes from register
261 	guard(mutex)(&adis->state_lock);  in adis_read_reg()
266  * adis_write_reg_8() - Write single byte to a register
278  * adis_write_reg_16() - Write 2 bytes to a pair of registers
290  * adis_write_reg_32() - write 4 bytes to four registers
302  * adis_read_reg_16() - read 2 bytes from a 16-bit register
321  * adis_read_reg_32() - read 4 bytes from a 32-bit register
342  * adis_update_bits_base() - ADIS Update bits function - Locked version
354 	guard(mutex)(&adis->state_lock);  in adis_update_bits_base()
359  * adis_update_bits() - Wrapper macro for adis_update_bits_base - Locked version
375  * adis_update_bits() - Wrapper macro for adis_update_bits_base
396 	guard(mutex)(&adis->state_lock);  in adis_enable_irq()
402 	guard(mutex)(&adis->state_lock);  in adis_check_status()
406 #define adis_dev_auto_lock(adis)	guard(mutex)(&(adis)->state_lock)
408 	scoped_guard(mutex, &(adis)->state_lock)