[linux-2.6-block.git] / include / linux / iio / adc / ad_sigma_delta.h

/*
 * Support code for Analog Devices Sigma-Delta ADCs
 *
 * Copyright 2012 Analog Devices Inc.
 *  Author: Lars-Peter Clausen <lars@metafoo.de>
 *
 * Licensed under the GPL-2.
 */
#ifndef __AD_SIGMA_DELTA_H__
#define __AD_SIGMA_DELTA_H__

enum ad_sigma_delta_mode {
	AD_SD_MODE_CONTINUOUS = 0,
	AD_SD_MODE_SINGLE = 1,
	AD_SD_MODE_IDLE = 2,
	AD_SD_MODE_POWERDOWN = 3,
};

/**
 * struct ad_sigma_delta_calib_data - Calibration data for Sigma Delta devices
 * @mode: Calibration mode.
 * @channel: Calibration channel.
 */
struct ad_sd_calib_data {
	unsigned int mode;
	unsigned int channel;
};

struct ad_sigma_delta;
struct iio_dev;

/**
 * struct ad_sigma_delta_info - Sigma Delta driver specific callbacks and options
 * @set_channel: Will be called to select the current channel, may be NULL.
 * @set_mode: Will be called to select the current mode, may be NULL.
 * @postprocess_sample: Is called for each sampled data word, can be used to
 *		modify or drop the sample data, it, may be NULL.
 * @has_registers: true if the device has writable and readable registers, false
 *		if there is just one read-only sample data shift register.
 * @addr_shift: Shift of the register address in the communications register.
 * @read_mask: Mask for the communications register having the read bit set.
 * @data_reg: Address of the data register, if 0 the default address of 0x3 will
 *   be used.
 */
struct ad_sigma_delta_info {
	int (*set_channel)(struct ad_sigma_delta *, unsigned int channel);
	int (*set_mode)(struct ad_sigma_delta *, enum ad_sigma_delta_mode mode);
	int (*postprocess_sample)(struct ad_sigma_delta *, unsigned int raw_sample);
	bool has_registers;
	unsigned int addr_shift;
	unsigned int read_mask;
	unsigned int data_reg;
};

/**
 * struct ad_sigma_delta - Sigma Delta device struct
 * @spi: The spi device associated with the Sigma Delta device.
 * @trig: The IIO trigger associated with the Sigma Delta device.
 *
 * Most of the fields are private to the sigma delta library code and should not
 * be accessed by individual drivers.
 */
struct ad_sigma_delta {
	struct spi_device	*spi;
	struct iio_trigger	*trig;

/* private: */
	struct completion	completion;
	bool			irq_dis;

	bool			bus_locked;

	uint8_t			comm;

	const struct ad_sigma_delta_info *info;

	/*
	 * DMA (thus cache coherency maintenance) requires the
	 * transfer buffers to live in their own cache lines.
	 */
	uint8_t				data[4] ____cacheline_aligned;
};

static inline int ad_sigma_delta_set_channel(struct ad_sigma_delta *sd,
	unsigned int channel)
{
	if (sd->info->set_channel)
		return sd->info->set_channel(sd, channel);

	return 0;
}

static inline int ad_sigma_delta_set_mode(struct ad_sigma_delta *sd,
	unsigned int mode)
{
	if (sd->info->set_mode)
		return sd->info->set_mode(sd, mode);

	return 0;
}

static inline int ad_sigma_delta_postprocess_sample(struct ad_sigma_delta *sd,
	unsigned int raw_sample)
{
	if (sd->info->postprocess_sample)
		return sd->info->postprocess_sample(sd, raw_sample);

	return 0;
}

void ad_sd_set_comm(struct ad_sigma_delta *sigma_delta, uint8_t comm);
int ad_sd_write_reg(struct ad_sigma_delta *sigma_delta, unsigned int reg,
	unsigned int size, unsigned int val);
int ad_sd_read_reg(struct ad_sigma_delta *sigma_delta, unsigned int reg,
	unsigned int size, unsigned int *val);

int ad_sd_reset(struct ad_sigma_delta *sigma_delta,
	unsigned int reset_length);

int ad_sigma_delta_single_conversion(struct iio_dev *indio_dev,
	const struct iio_chan_spec *chan, int *val);
int ad_sd_calibrate_all(struct ad_sigma_delta *sigma_delta,
	const struct ad_sd_calib_data *cd, unsigned int n);
int ad_sd_init(struct ad_sigma_delta *sigma_delta, struct iio_dev *indio_dev,
	struct spi_device *spi, const struct ad_sigma_delta_info *info);

int ad_sd_setup_buffer_and_trigger(struct iio_dev *indio_dev);
void ad_sd_cleanup_buffer_and_trigger(struct iio_dev *indio_dev);

int ad_sd_validate_trigger(struct iio_dev *indio_dev, struct iio_trigger *trig);

#define __AD_SD_CHANNEL(_si, _channel1, _channel2, _address, _bits, \
	_storagebits, _shift, _extend_name, _type, _mask_all) \
	{ \
		.type = (_type), \
		.differential = (_channel2 == -1 ? 0 : 1), \
		.indexed = 1, \
		.channel = (_channel1), \
		.channel2 = (_channel2), \
		.address = (_address), \
		.extend_name = (_extend_name), \
		.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
			BIT(IIO_CHAN_INFO_OFFSET), \
		.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
		.info_mask_shared_by_all = _mask_all, \
		.scan_index = (_si), \
		.scan_type = { \
			.sign = 'u', \
			.realbits = (_bits), \
			.storagebits = (_storagebits), \
			.shift = (_shift), \
			.endianness = IIO_BE, \
		}, \
	}

#define AD_SD_DIFF_CHANNEL(_si, _channel1, _channel2, _address, _bits, \
	_storagebits, _shift) \
	__AD_SD_CHANNEL(_si, _channel1, _channel2, _address, _bits, \
		_storagebits, _shift, NULL, IIO_VOLTAGE, \
		BIT(IIO_CHAN_INFO_SAMP_FREQ))

#define AD_SD_SHORTED_CHANNEL(_si, _channel, _address, _bits, \
	_storagebits, _shift) \
	__AD_SD_CHANNEL(_si, _channel, _channel, _address, _bits, \
		_storagebits, _shift, "shorted", IIO_VOLTAGE, \
		BIT(IIO_CHAN_INFO_SAMP_FREQ))

#define AD_SD_CHANNEL(_si, _channel, _address, _bits, \
	_storagebits, _shift) \
	__AD_SD_CHANNEL(_si, _channel, -1, _address, _bits, \
		_storagebits, _shift, NULL, IIO_VOLTAGE, \
		 BIT(IIO_CHAN_INFO_SAMP_FREQ))

#define AD_SD_CHANNEL_NO_SAMP_FREQ(_si, _channel, _address, _bits, \
	_storagebits, _shift) \
	__AD_SD_CHANNEL(_si, _channel, -1, _address, _bits, \
		_storagebits, _shift, NULL, IIO_VOLTAGE, 0)

#define AD_SD_TEMP_CHANNEL(_si, _address, _bits, _storagebits, _shift) \
	__AD_SD_CHANNEL(_si, 0, -1, _address, _bits, \
		_storagebits, _shift, NULL, IIO_TEMP, \
		BIT(IIO_CHAN_INFO_SAMP_FREQ))

#define AD_SD_SUPPLY_CHANNEL(_si, _channel, _address, _bits, _storagebits, \
	_shift) \
	__AD_SD_CHANNEL(_si, _channel, -1, _address, _bits, \
		_storagebits, _shift, "supply", IIO_VOLTAGE, \
		BIT(IIO_CHAN_INFO_SAMP_FREQ))

#endif
Commit	Line	Data
af300848 LPC	1	/*
	2	* Support code for Analog Devices Sigma-Delta ADCs
	3	*
	4	* Copyright 2012 Analog Devices Inc.
	5	* Author: Lars-Peter Clausen <lars@metafoo.de>
	6	*
	7	* Licensed under the GPL-2.
	8	*/
	9	#ifndef __AD_SIGMA_DELTA_H__
	10	#define __AD_SIGMA_DELTA_H__
	11
	12	enum ad_sigma_delta_mode {
	13	AD_SD_MODE_CONTINUOUS = 0,
	14	AD_SD_MODE_SINGLE = 1,
	15	AD_SD_MODE_IDLE = 2,
	16	AD_SD_MODE_POWERDOWN = 3,
	17	};
	18
	19	/**
	20	* struct ad_sigma_delta_calib_data - Calibration data for Sigma Delta devices
	21	* @mode: Calibration mode.
	22	* @channel: Calibration channel.
	23	*/
	24	struct ad_sd_calib_data {
	25	unsigned int mode;
	26	unsigned int channel;
	27	};
	28
	29	struct ad_sigma_delta;
	30	struct iio_dev;
	31
	32	/**
	33	* struct ad_sigma_delta_info - Sigma Delta driver specific callbacks and options
	34	* @set_channel: Will be called to select the current channel, may be NULL.
	35	* @set_mode: Will be called to select the current mode, may be NULL.
	36	* @postprocess_sample: Is called for each sampled data word, can be used to
	37	* modify or drop the sample data, it, may be NULL.
	38	* @has_registers: true if the device has writable and readable registers, false
	39	* if there is just one read-only sample data shift register.
	40	* @addr_shift: Shift of the register address in the communications register.
	41	* @read_mask: Mask for the communications register having the read bit set.
f0aef2d0 LPC	42	* @data_reg: Address of the data register, if 0 the default address of 0x3 will
f0aef2d0 LPC	43	* be used.
af300848 LPC	44	*/
	45	struct ad_sigma_delta_info {
	46	int (set_channel)(struct ad_sigma_delta , unsigned int channel);
	47	int (set_mode)(struct ad_sigma_delta , enum ad_sigma_delta_mode mode);
	48	int (postprocess_sample)(struct ad_sigma_delta , unsigned int raw_sample);
	49	bool has_registers;
	50	unsigned int addr_shift;
	51	unsigned int read_mask;
f0aef2d0	52	unsigned int data_reg;
af300848 LPC	53	};
	54
	55	/**
	56	* struct ad_sigma_delta - Sigma Delta device struct
	57	* @spi: The spi device associated with the Sigma Delta device.
	58	* @trig: The IIO trigger associated with the Sigma Delta device.
	59	*
	60	* Most of the fields are private to the sigma delta library code and should not
	61	* be accessed by individual drivers.
	62	*/
	63	struct ad_sigma_delta {
	64	struct spi_device *spi;
	65	struct iio_trigger *trig;
	66
	67	/* private: */
	68	struct completion completion;
	69	bool irq_dis;
	70
	71	bool bus_locked;
	72
	73	uint8_t comm;
	74
	75	const struct ad_sigma_delta_info *info;
	76
	77	/*
	78	* DMA (thus cache coherency maintenance) requires the
	79	* transfer buffers to live in their own cache lines.
	80	*/
	81	uint8_t data[4] ____cacheline_aligned;
	82	};
	83
	84	static inline int ad_sigma_delta_set_channel(struct ad_sigma_delta *sd,
	85	unsigned int channel)
	86	{
	87	if (sd->info->set_channel)
	88	return sd->info->set_channel(sd, channel);
	89
	90	return 0;
	91	}
	92
	93	static inline int ad_sigma_delta_set_mode(struct ad_sigma_delta *sd,
	94	unsigned int mode)
	95	{
	96	if (sd->info->set_mode)
	97	return sd->info->set_mode(sd, mode);
	98
	99	return 0;
	100	}
	101
	102	static inline int ad_sigma_delta_postprocess_sample(struct ad_sigma_delta *sd,
	103	unsigned int raw_sample)
	104	{
	105	if (sd->info->postprocess_sample)
	106	return sd->info->postprocess_sample(sd, raw_sample);
	107
	108	return 0;
	109	}
	110
	111	void ad_sd_set_comm(struct ad_sigma_delta *sigma_delta, uint8_t comm);
	112	int ad_sd_write_reg(struct ad_sigma_delta *sigma_delta, unsigned int reg,
	113	unsigned int size, unsigned int val);
	114	int ad_sd_read_reg(struct ad_sigma_delta *sigma_delta, unsigned int reg,
	115	unsigned int size, unsigned int *val);
	116
7fc10de8 DB	117	int ad_sd_reset(struct ad_sigma_delta *sigma_delta,
	118	unsigned int reset_length);
	119
af300848 LPC	120	int ad_sigma_delta_single_conversion(struct iio_dev *indio_dev,
	121	const struct iio_chan_spec chan, int val);
	122	int ad_sd_calibrate_all(struct ad_sigma_delta *sigma_delta,
	123	const struct ad_sd_calib_data *cd, unsigned int n);
	124	int ad_sd_init(struct ad_sigma_delta sigma_delta, struct iio_dev indio_dev,
	125	struct spi_device spi, const struct ad_sigma_delta_info info);
	126
	127	int ad_sd_setup_buffer_and_trigger(struct iio_dev *indio_dev);
	128	void ad_sd_cleanup_buffer_and_trigger(struct iio_dev *indio_dev);
	129
	130	int ad_sd_validate_trigger(struct iio_dev indio_dev, struct iio_trigger trig);
	131
	132	#define __AD_SD_CHANNEL(_si, _channel1, _channel2, _address, _bits, \
192af06a	133	_storagebits, _shift, _extend_name, _type, _mask_all) \
af300848 LPC	134	{ \
	135	.type = (_type), \
	136	.differential = (_channel2 == -1 ? 0 : 1), \
	137	.indexed = 1, \
	138	.channel = (_channel1), \
	139	.channel2 = (_channel2), \
	140	.address = (_address), \
	141	.extend_name = (_extend_name), \
ea0c6800 JC	142	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) \| \
	143	BIT(IIO_CHAN_INFO_OFFSET), \
	144	.info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
192af06a	145	.info_mask_shared_by_all = _mask_all, \
af300848 LPC	146	.scan_index = (_si), \
	147	.scan_type = { \
	148	.sign = 'u', \
	149	.realbits = (_bits), \
	150	.storagebits = (_storagebits), \
	151	.shift = (_shift), \
	152	.endianness = IIO_BE, \
	153	}, \
	154	}
	155
	156	#define AD_SD_DIFF_CHANNEL(_si, _channel1, _channel2, _address, _bits, \
	157	_storagebits, _shift) \
	158	__AD_SD_CHANNEL(_si, _channel1, _channel2, _address, _bits, \
192af06a AA	159	_storagebits, _shift, NULL, IIO_VOLTAGE, \
192af06a AA	160	BIT(IIO_CHAN_INFO_SAMP_FREQ))
af300848 LPC	161
	162	#define AD_SD_SHORTED_CHANNEL(_si, _channel, _address, _bits, \
	163	_storagebits, _shift) \
	164	__AD_SD_CHANNEL(_si, _channel, _channel, _address, _bits, \
192af06a AA	165	_storagebits, _shift, "shorted", IIO_VOLTAGE, \
192af06a AA	166	BIT(IIO_CHAN_INFO_SAMP_FREQ))
af300848 LPC	167
	168	#define AD_SD_CHANNEL(_si, _channel, _address, _bits, \
	169	_storagebits, _shift) \
	170	__AD_SD_CHANNEL(_si, _channel, -1, _address, _bits, \
192af06a AA	171	_storagebits, _shift, NULL, IIO_VOLTAGE, \
	172	BIT(IIO_CHAN_INFO_SAMP_FREQ))
	173
	174	#define AD_SD_CHANNEL_NO_SAMP_FREQ(_si, _channel, _address, _bits, \
	175	_storagebits, _shift) \
	176	__AD_SD_CHANNEL(_si, _channel, -1, _address, _bits, \
	177	_storagebits, _shift, NULL, IIO_VOLTAGE, 0)
af300848 LPC	178
	179	#define AD_SD_TEMP_CHANNEL(_si, _address, _bits, _storagebits, _shift) \
	180	__AD_SD_CHANNEL(_si, 0, -1, _address, _bits, \
192af06a AA	181	_storagebits, _shift, NULL, IIO_TEMP, \
192af06a AA	182	BIT(IIO_CHAN_INFO_SAMP_FREQ))
af300848 LPC	183
	184	#define AD_SD_SUPPLY_CHANNEL(_si, _channel, _address, _bits, _storagebits, \
	185	_shift) \
	186	__AD_SD_CHANNEL(_si, _channel, -1, _address, _bits, \
192af06a AA	187	_storagebits, _shift, "supply", IIO_VOLTAGE, \
192af06a AA	188	BIT(IIO_CHAN_INFO_SAMP_FREQ))
af300848 LPC	189
af300848 LPC	190	#endif