[mirror_ubuntu-eoan-kernel.git] / include / linux / iio / common / st_sensors.h

/*
 * STMicroelectronics sensors library driver
 *
 * Copyright 2012-2013 STMicroelectronics Inc.
 *
 * Denis Ciocca <denis.ciocca@st.com>
 *
 * Licensed under the GPL-2.
 */

#ifndef ST_SENSORS_H
#define ST_SENSORS_H

#include <linux/i2c.h>
#include <linux/spi/spi.h>
#include <linux/irqreturn.h>
#include <linux/iio/trigger.h>
#include <linux/bitops.h>
#include <linux/regulator/consumer.h>

#include <linux/platform_data/st_sensors_pdata.h>

#define ST_SENSORS_TX_MAX_LENGTH		2
#define ST_SENSORS_RX_MAX_LENGTH		6

#define ST_SENSORS_ODR_LIST_MAX			10
#define ST_SENSORS_FULLSCALE_AVL_MAX		10

#define ST_SENSORS_NUMBER_ALL_CHANNELS		4
#define ST_SENSORS_ENABLE_ALL_AXIS		0x07
#define ST_SENSORS_SCAN_X			0
#define ST_SENSORS_SCAN_Y			1
#define ST_SENSORS_SCAN_Z			2
#define ST_SENSORS_DEFAULT_POWER_ON_VALUE	0x01
#define ST_SENSORS_DEFAULT_POWER_OFF_VALUE	0x00
#define ST_SENSORS_DEFAULT_WAI_ADDRESS		0x0f
#define ST_SENSORS_DEFAULT_AXIS_ADDR		0x20
#define ST_SENSORS_DEFAULT_AXIS_MASK		0x07
#define ST_SENSORS_DEFAULT_AXIS_N_BIT		3

#define ST_SENSORS_MAX_NAME			17
#define ST_SENSORS_MAX_4WAI			7

#define ST_SENSORS_LSM_CHANNELS(device_type, mask, index, mod, \
					ch2, s, endian, rbits, sbits, addr) \
{ \
	.type = device_type, \
	.modified = mod, \
	.info_mask_separate = mask, \
	.scan_index = index, \
	.channel2 = ch2, \
	.address = addr, \
	.scan_type = { \
		.sign = s, \
		.realbits = rbits, \
		.shift = sbits - rbits, \
		.storagebits = sbits, \
		.endianness = endian, \
	}, \
}

#define ST_SENSOR_DEV_ATTR_SAMP_FREQ() \
		IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO, \
			st_sensors_sysfs_get_sampling_frequency, \
			st_sensors_sysfs_set_sampling_frequency)

#define ST_SENSORS_DEV_ATTR_SAMP_FREQ_AVAIL() \
		IIO_DEV_ATTR_SAMP_FREQ_AVAIL( \
			st_sensors_sysfs_sampling_frequency_avail)

#define ST_SENSORS_DEV_ATTR_SCALE_AVAIL(name) \
		IIO_DEVICE_ATTR(name, S_IRUGO, \
			st_sensors_sysfs_scale_avail, NULL , 0);

struct st_sensor_odr_avl {
	unsigned int hz;
	u8 value;
};

struct st_sensor_odr {
	u8 addr;
	u8 mask;
	struct st_sensor_odr_avl odr_avl[ST_SENSORS_ODR_LIST_MAX];
};

struct st_sensor_power {
	u8 addr;
	u8 mask;
	u8 value_off;
	u8 value_on;
};

struct st_sensor_axis {
	u8 addr;
	u8 mask;
};

struct st_sensor_fullscale_avl {
	unsigned int num;
	u8 value;
	unsigned int gain;
	unsigned int gain2;
};

struct st_sensor_fullscale {
	u8 addr;
	u8 mask;
	struct st_sensor_fullscale_avl fs_avl[ST_SENSORS_FULLSCALE_AVL_MAX];
};

/**
 * struct st_sensor_bdu - ST sensor device block data update
 * @addr: address of the register.
 * @mask: mask to write the block data update flag.
 */
struct st_sensor_bdu {
	u8 addr;
	u8 mask;
};

/**
 * struct st_sensor_data_ready_irq - ST sensor device data-ready interrupt
 * @addr: address of the register.
 * @mask_int1: mask to enable/disable IRQ on INT1 pin.
 * @mask_int2: mask to enable/disable IRQ on INT2 pin.
 * struct ig1 - represents the Interrupt Generator 1 of sensors.
 * @en_addr: address of the enable ig1 register.
 * @en_mask: mask to write the on/off value for enable.
 */
struct st_sensor_data_ready_irq {
	u8 addr;
	u8 mask_int1;
	u8 mask_int2;
	struct {
		u8 en_addr;
		u8 en_mask;
	} ig1;
};

/**
 * struct st_sensor_transfer_buffer - ST sensor device I/O buffer
 * @buf_lock: Mutex to protect rx and tx buffers.
 * @tx_buf: Buffer used by SPI transfer function to send data to the sensors.
 *	This buffer is used to avoid DMA not-aligned issue.
 * @rx_buf: Buffer used by SPI transfer to receive data from sensors.
 *	This buffer is used to avoid DMA not-aligned issue.
 */
struct st_sensor_transfer_buffer {
	struct mutex buf_lock;
	u8 rx_buf[ST_SENSORS_RX_MAX_LENGTH];
	u8 tx_buf[ST_SENSORS_TX_MAX_LENGTH] ____cacheline_aligned;
};

/**
 * struct st_sensor_transfer_function - ST sensor device I/O function
 * @read_byte: Function used to read one byte.
 * @write_byte: Function used to write one byte.
 * @read_multiple_byte: Function used to read multiple byte.
 */
struct st_sensor_transfer_function {
	int (*read_byte) (struct st_sensor_transfer_buffer *tb,
				struct device *dev, u8 reg_addr, u8 *res_byte);
	int (*write_byte) (struct st_sensor_transfer_buffer *tb,
				struct device *dev, u8 reg_addr, u8 data);
	int (*read_multiple_byte) (struct st_sensor_transfer_buffer *tb,
		struct device *dev, u8 reg_addr, int len, u8 *data,
							bool multiread_bit);
};

/**
 * struct st_sensors - ST sensors list
 * @wai: Contents of WhoAmI register.
 * @sensors_supported: List of supported sensors by struct itself.
 * @ch: IIO channels for the sensor.
 * @odr: Output data rate register and ODR list available.
 * @pw: Power register of the sensor.
 * @enable_axis: Enable one or more axis of the sensor.
 * @fs: Full scale register and full scale list available.
 * @bdu: Block data update register.
 * @drdy_irq: Data ready register of the sensor.
 * @multi_read_bit: Use or not particular bit for [I2C/SPI] multi-read.
 * @bootime: samples to discard when sensor passing from power-down to power-up.
 */
struct st_sensors {
	u8 wai;
	char sensors_supported[ST_SENSORS_MAX_4WAI][ST_SENSORS_MAX_NAME];
	struct iio_chan_spec *ch;
	int num_ch;
	struct st_sensor_odr odr;
	struct st_sensor_power pw;
	struct st_sensor_axis enable_axis;
	struct st_sensor_fullscale fs;
	struct st_sensor_bdu bdu;
	struct st_sensor_data_ready_irq drdy_irq;
	bool multi_read_bit;
	unsigned int bootime;
};

/**
 * struct st_sensor_data - ST sensor device status
 * @dev: Pointer to instance of struct device (I2C or SPI).
 * @trig: The trigger in use by the core driver.
 * @sensor: Pointer to the current sensor struct in use.
 * @current_fullscale: Maximum range of measure by the sensor.
 * @vdd: Pointer to sensor's Vdd power supply
 * @vdd_io: Pointer to sensor's Vdd-IO power supply
 * @enabled: Status of the sensor (false->off, true->on).
 * @multiread_bit: Use or not particular bit for [I2C/SPI] multiread.
 * @buffer_data: Data used by buffer part.
 * @odr: Output data rate of the sensor [Hz].
 * num_data_channels: Number of data channels used in buffer.
 * @drdy_int_pin: Redirect DRDY on pin 1 (1) or pin 2 (2).
 * @get_irq_data_ready: Function to get the IRQ used for data ready signal.
 * @tf: Transfer function structure used by I/O operations.
 * @tb: Transfer buffers and mutex used by I/O operations.
 */
struct st_sensor_data {
	struct device *dev;
	struct iio_trigger *trig;
	struct st_sensors *sensor;
	struct st_sensor_fullscale_avl *current_fullscale;
	struct regulator *vdd;
	struct regulator *vdd_io;

	bool enabled;
	bool multiread_bit;

	char *buffer_data;

	unsigned int odr;
	unsigned int num_data_channels;

	u8 drdy_int_pin;

	unsigned int (*get_irq_data_ready) (struct iio_dev *indio_dev);

	const struct st_sensor_transfer_function *tf;
	struct st_sensor_transfer_buffer tb;
};

#ifdef CONFIG_IIO_BUFFER
irqreturn_t st_sensors_trigger_handler(int irq, void *p);

int st_sensors_get_buffer_element(struct iio_dev *indio_dev, u8 *buf);
#endif

#ifdef CONFIG_IIO_TRIGGER
int st_sensors_allocate_trigger(struct iio_dev *indio_dev,
				const struct iio_trigger_ops *trigger_ops);

void st_sensors_deallocate_trigger(struct iio_dev *indio_dev);

#else
static inline int st_sensors_allocate_trigger(struct iio_dev *indio_dev,
				const struct iio_trigger_ops *trigger_ops)
{
	return 0;
}
static inline void st_sensors_deallocate_trigger(struct iio_dev *indio_dev)
{
	return;
}
#endif

int st_sensors_init_sensor(struct iio_dev *indio_dev,
					struct st_sensors_platform_data *pdata);

int st_sensors_set_enable(struct iio_dev *indio_dev, bool enable);

int st_sensors_set_axis_enable(struct iio_dev *indio_dev, u8 axis_enable);

void st_sensors_power_enable(struct iio_dev *indio_dev);

void st_sensors_power_disable(struct iio_dev *indio_dev);

int st_sensors_set_odr(struct iio_dev *indio_dev, unsigned int odr);

int st_sensors_set_dataready_irq(struct iio_dev *indio_dev, bool enable);

int st_sensors_set_fullscale_by_gain(struct iio_dev *indio_dev, int scale);

int st_sensors_read_info_raw(struct iio_dev *indio_dev,
				struct iio_chan_spec const *ch, int *val);

int st_sensors_check_device_support(struct iio_dev *indio_dev,
			int num_sensors_list, const struct st_sensors *sensors);

ssize_t st_sensors_sysfs_get_sampling_frequency(struct device *dev,
				struct device_attribute *attr, char *buf);

ssize_t st_sensors_sysfs_set_sampling_frequency(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t size);

ssize_t st_sensors_sysfs_sampling_frequency_avail(struct device *dev,
				struct device_attribute *attr, char *buf);

ssize_t st_sensors_sysfs_scale_avail(struct device *dev,
				struct device_attribute *attr, char *buf);

#endif /* ST_SENSORS_H */
Commit	Line	Data
23491b51 DC	1	/*
	2	* STMicroelectronics sensors library driver
	3	*
	4	* Copyright 2012-2013 STMicroelectronics Inc.
	5	*
	6	* Denis Ciocca <denis.ciocca@st.com>
	7	*
	8	* Licensed under the GPL-2.
	9	*/
	10
	11	#ifndef ST_SENSORS_H
	12	#define ST_SENSORS_H
	13
	14	#include <linux/i2c.h>
	15	#include <linux/spi/spi.h>
	16	#include <linux/irqreturn.h>
	17	#include <linux/iio/trigger.h>
5ea86494	18	#include <linux/bitops.h>
77448761	19	#include <linux/regulator/consumer.h>
23491b51	20
23cde4d6 DC	21	#include <linux/platform_data/st_sensors_pdata.h>
23cde4d6 DC	22
23491b51 DC	23	#define ST_SENSORS_TX_MAX_LENGTH 2
	24	#define ST_SENSORS_RX_MAX_LENGTH 6
	25
	26	#define ST_SENSORS_ODR_LIST_MAX 10
	27	#define ST_SENSORS_FULLSCALE_AVL_MAX 10
	28
	29	#define ST_SENSORS_NUMBER_ALL_CHANNELS 4
23491b51	30	#define ST_SENSORS_ENABLE_ALL_AXIS 0x07
23491b51 DC	31	#define ST_SENSORS_SCAN_X 0
	32	#define ST_SENSORS_SCAN_Y 1
	33	#define ST_SENSORS_SCAN_Z 2
23491b51 DC	34	#define ST_SENSORS_DEFAULT_POWER_ON_VALUE 0x01
	35	#define ST_SENSORS_DEFAULT_POWER_OFF_VALUE 0x00
	36	#define ST_SENSORS_DEFAULT_WAI_ADDRESS 0x0f
	37	#define ST_SENSORS_DEFAULT_AXIS_ADDR 0x20
	38	#define ST_SENSORS_DEFAULT_AXIS_MASK 0x07
	39	#define ST_SENSORS_DEFAULT_AXIS_N_BIT 3
	40
	41	#define ST_SENSORS_MAX_NAME 17
	42	#define ST_SENSORS_MAX_4WAI 7
	43
762011d6 DC	44	#define ST_SENSORS_LSM_CHANNELS(device_type, mask, index, mod, \
762011d6 DC	45	ch2, s, endian, rbits, sbits, addr) \
23491b51 DC	46	{ \
23491b51 DC	47	.type = device_type, \
762011d6 DC	48	.modified = mod, \
762011d6 DC	49	.info_mask_separate = mask, \
23491b51	50	.scan_index = index, \
762011d6	51	.channel2 = ch2, \
23491b51 DC	52	.address = addr, \
23491b51 DC	53	.scan_type = { \
762011d6 DC	54	.sign = s, \
	55	.realbits = rbits, \
	56	.shift = sbits - rbits, \
	57	.storagebits = sbits, \
23491b51 DC	58	.endianness = endian, \
	59	}, \
	60	}
	61
	62	#define ST_SENSOR_DEV_ATTR_SAMP_FREQ() \
	63	IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR \| S_IRUGO, \
	64	st_sensors_sysfs_get_sampling_frequency, \
	65	st_sensors_sysfs_set_sampling_frequency)
	66
	67	#define ST_SENSORS_DEV_ATTR_SAMP_FREQ_AVAIL() \
	68	IIO_DEV_ATTR_SAMP_FREQ_AVAIL( \
	69	st_sensors_sysfs_sampling_frequency_avail)
	70
	71	#define ST_SENSORS_DEV_ATTR_SCALE_AVAIL(name) \
	72	IIO_DEVICE_ATTR(name, S_IRUGO, \
	73	st_sensors_sysfs_scale_avail, NULL , 0);
	74
	75	struct st_sensor_odr_avl {
	76	unsigned int hz;
	77	u8 value;
	78	};
	79
	80	struct st_sensor_odr {
	81	u8 addr;
	82	u8 mask;
	83	struct st_sensor_odr_avl odr_avl[ST_SENSORS_ODR_LIST_MAX];
	84	};
	85
	86	struct st_sensor_power {
	87	u8 addr;
	88	u8 mask;
	89	u8 value_off;
	90	u8 value_on;
	91	};
	92
	93	struct st_sensor_axis {
	94	u8 addr;
	95	u8 mask;
	96	};
	97
	98	struct st_sensor_fullscale_avl {
	99	unsigned int num;
	100	u8 value;
	101	unsigned int gain;
	102	unsigned int gain2;
	103	};
	104
	105	struct st_sensor_fullscale {
	106	u8 addr;
	107	u8 mask;
	108	struct st_sensor_fullscale_avl fs_avl[ST_SENSORS_FULLSCALE_AVL_MAX];
	109	};
	110
	111	/**
	112	* struct st_sensor_bdu - ST sensor device block data update
	113	* @addr: address of the register.
	114	* @mask: mask to write the block data update flag.
	115	*/
	116	struct st_sensor_bdu {
	117	u8 addr;
	118	u8 mask;
	119	};
	120
	121	/**
122	* struct st_sensor_data_ready_irq - ST sensor device data-ready interrupt
123	* @addr: address of the register.
23cde4d6 DC	124	* @mask_int1: mask to enable/disable IRQ on INT1 pin.
23cde4d6 DC	125	* @mask_int2: mask to enable/disable IRQ on INT2 pin.
23491b51 DC	126	* struct ig1 - represents the Interrupt Generator 1 of sensors.
	127	* @en_addr: address of the enable ig1 register.
	128	* @en_mask: mask to write the on/off value for enable.
	129	*/
	130	struct st_sensor_data_ready_irq {
	131	u8 addr;
23cde4d6 DC	132	u8 mask_int1;
23cde4d6 DC	133	u8 mask_int2;
23491b51 DC	134	struct {
	135	u8 en_addr;
	136	u8 en_mask;
	137	} ig1;
	138	};
	139
	140	/**
	141	* struct st_sensor_transfer_buffer - ST sensor device I/O buffer
	142	* @buf_lock: Mutex to protect rx and tx buffers.
	143	* @tx_buf: Buffer used by SPI transfer function to send data to the sensors.
	144	* This buffer is used to avoid DMA not-aligned issue.
	145	* @rx_buf: Buffer used by SPI transfer to receive data from sensors.
	146	* This buffer is used to avoid DMA not-aligned issue.
	147	*/
	148	struct st_sensor_transfer_buffer {
	149	struct mutex buf_lock;
	150	u8 rx_buf[ST_SENSORS_RX_MAX_LENGTH];
	151	u8 tx_buf[ST_SENSORS_TX_MAX_LENGTH] ____cacheline_aligned;
	152	};
	153
	154	/**
	155	* struct st_sensor_transfer_function - ST sensor device I/O function
	156	* @read_byte: Function used to read one byte.
	157	* @write_byte: Function used to write one byte.
	158	* @read_multiple_byte: Function used to read multiple byte.
	159	*/
	160	struct st_sensor_transfer_function {
	161	int (read_byte) (struct st_sensor_transfer_buffer tb,
	162	struct device dev, u8 reg_addr, u8 res_byte);
	163	int (write_byte) (struct st_sensor_transfer_buffer tb,
	164	struct device *dev, u8 reg_addr, u8 data);
	165	int (read_multiple_byte) (struct st_sensor_transfer_buffer tb,
	166	struct device dev, u8 reg_addr, int len, u8 data,
	167	bool multiread_bit);
	168	};
	169
	170	/**
	171	* struct st_sensors - ST sensors list
	172	* @wai: Contents of WhoAmI register.
	173	* @sensors_supported: List of supported sensors by struct itself.
	174	* @ch: IIO channels for the sensor.
	175	* @odr: Output data rate register and ODR list available.
	176	* @pw: Power register of the sensor.
	177	* @enable_axis: Enable one or more axis of the sensor.
	178	* @fs: Full scale register and full scale list available.
	179	* @bdu: Block data update register.
	180	* @drdy_irq: Data ready register of the sensor.
	181	* @multi_read_bit: Use or not particular bit for [I2C/SPI] multi-read.
	182	* @bootime: samples to discard when sensor passing from power-down to power-up.
	183	*/
	184	struct st_sensors {
	185	u8 wai;
	186	char sensors_supported[ST_SENSORS_MAX_4WAI][ST_SENSORS_MAX_NAME];
	187	struct iio_chan_spec *ch;
ea01f2c1	188	int num_ch;
23491b51 DC	189	struct st_sensor_odr odr;
	190	struct st_sensor_power pw;
	191	struct st_sensor_axis enable_axis;
	192	struct st_sensor_fullscale fs;
	193	struct st_sensor_bdu bdu;
	194	struct st_sensor_data_ready_irq drdy_irq;
	195	bool multi_read_bit;
	196	unsigned int bootime;
	197	};
	198
	199	/**
	200	* struct st_sensor_data - ST sensor device status
	201	* @dev: Pointer to instance of struct device (I2C or SPI).
	202	* @trig: The trigger in use by the core driver.
	203	* @sensor: Pointer to the current sensor struct in use.
	204	* @current_fullscale: Maximum range of measure by the sensor.
77448761	205	* @vdd: Pointer to sensor's Vdd power supply
71e1980c	206	* @vdd_io: Pointer to sensor's Vdd-IO power supply
23491b51 DC	207	* @enabled: Status of the sensor (false->off, true->on).
	208	* @multiread_bit: Use or not particular bit for [I2C/SPI] multiread.
	209	* @buffer_data: Data used by buffer part.
	210	* @odr: Output data rate of the sensor [Hz].
607a568a	211	* num_data_channels: Number of data channels used in buffer.
23cde4d6	212	* @drdy_int_pin: Redirect DRDY on pin 1 (1) or pin 2 (2).
23491b51 DC	213	* @get_irq_data_ready: Function to get the IRQ used for data ready signal.
	214	* @tf: Transfer function structure used by I/O operations.
	215	* @tb: Transfer buffers and mutex used by I/O operations.
	216	*/
	217	struct st_sensor_data {
	218	struct device *dev;
	219	struct iio_trigger *trig;
	220	struct st_sensors *sensor;
	221	struct st_sensor_fullscale_avl *current_fullscale;
77448761	222	struct regulator *vdd;
71e1980c	223	struct regulator *vdd_io;
23491b51 DC	224
	225	bool enabled;
	226	bool multiread_bit;
	227
	228	char *buffer_data;
	229
	230	unsigned int odr;
607a568a	231	unsigned int num_data_channels;
23491b51	232
23cde4d6 DC	233	u8 drdy_int_pin;
23cde4d6 DC	234
23491b51 DC	235	unsigned int (get_irq_data_ready) (struct iio_dev indio_dev);
	236
	237	const struct st_sensor_transfer_function *tf;
	238	struct st_sensor_transfer_buffer tb;
	239	};
	240
	241	#ifdef CONFIG_IIO_BUFFER
5a4d7291 GR	242	irqreturn_t st_sensors_trigger_handler(int irq, void *p);
	243
	244	int st_sensors_get_buffer_element(struct iio_dev indio_dev, u8 buf);
	245	#endif
	246
	247	#ifdef CONFIG_IIO_TRIGGER
23491b51 DC	248	int st_sensors_allocate_trigger(struct iio_dev *indio_dev,
	249	const struct iio_trigger_ops *trigger_ops);
	250
	251	void st_sensors_deallocate_trigger(struct iio_dev *indio_dev);
	252
91ffbabf DC	253	#else
	254	static inline int st_sensors_allocate_trigger(struct iio_dev *indio_dev,
	255	const struct iio_trigger_ops *trigger_ops)
	256	{
	257	return 0;
	258	}
	259	static inline void st_sensors_deallocate_trigger(struct iio_dev *indio_dev)
	260	{
	261	return;
	262	}
23491b51 DC	263	#endif
23491b51 DC	264
23cde4d6 DC	265	int st_sensors_init_sensor(struct iio_dev *indio_dev,
23cde4d6 DC	266	struct st_sensors_platform_data *pdata);
23491b51 DC	267
	268	int st_sensors_set_enable(struct iio_dev *indio_dev, bool enable);
	269
	270	int st_sensors_set_axis_enable(struct iio_dev *indio_dev, u8 axis_enable);
	271
ea7e586b LW	272	void st_sensors_power_enable(struct iio_dev *indio_dev);
	273
	274	void st_sensors_power_disable(struct iio_dev *indio_dev);
	275
23491b51 DC	276	int st_sensors_set_odr(struct iio_dev *indio_dev, unsigned int odr);
	277
	278	int st_sensors_set_dataready_irq(struct iio_dev *indio_dev, bool enable);
	279
	280	int st_sensors_set_fullscale_by_gain(struct iio_dev *indio_dev, int scale);
	281
	282	int st_sensors_read_info_raw(struct iio_dev *indio_dev,
	283	struct iio_chan_spec const ch, int val);
	284
	285	int st_sensors_check_device_support(struct iio_dev *indio_dev,
	286	int num_sensors_list, const struct st_sensors *sensors);
	287
	288	ssize_t st_sensors_sysfs_get_sampling_frequency(struct device *dev,
	289	struct device_attribute attr, char buf);
	290
	291	ssize_t st_sensors_sysfs_set_sampling_frequency(struct device *dev,
	292	struct device_attribute attr, const char buf, size_t size);
	293
	294	ssize_t st_sensors_sysfs_sampling_frequency_avail(struct device *dev,
	295	struct device_attribute attr, char buf);
	296
	297	ssize_t st_sensors_sysfs_scale_avail(struct device *dev,
	298	struct device_attribute attr, char buf);
	299
	300	#endif /* ST_SENSORS_H */