[mirror_ubuntu-jammy-kernel.git] / include / linux / iio / iio.h


/* The industrial I/O core
 *
 * Copyright (c) 2008 Jonathan Cameron
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 */
#ifndef _INDUSTRIAL_IO_H_
#define _INDUSTRIAL_IO_H_

#include <linux/device.h>
#include <linux/cdev.h>
#include <linux/iio/types.h>
/* IIO TODO LIST */
/*
 * Provide means of adjusting timer accuracy.
 * Currently assumes nano seconds.
 */

enum iio_chan_info_enum {
	IIO_CHAN_INFO_RAW = 0,
	IIO_CHAN_INFO_PROCESSED,
	IIO_CHAN_INFO_SCALE,
	IIO_CHAN_INFO_OFFSET,
	IIO_CHAN_INFO_CALIBSCALE,
	IIO_CHAN_INFO_CALIBBIAS,
	IIO_CHAN_INFO_PEAK,
	IIO_CHAN_INFO_PEAK_SCALE,
	IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW,
	IIO_CHAN_INFO_AVERAGE_RAW,
	IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY,
	IIO_CHAN_INFO_SAMP_FREQ,
	IIO_CHAN_INFO_FREQUENCY,
	IIO_CHAN_INFO_PHASE,
};

#define IIO_CHAN_INFO_SHARED_BIT(type) BIT(type*2)
#define IIO_CHAN_INFO_SEPARATE_BIT(type) BIT(type*2 + 1)

#define IIO_CHAN_INFO_RAW_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_RAW)
#define IIO_CHAN_INFO_PROCESSED_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PROCESSED)
#define IIO_CHAN_INFO_SCALE_SEPARATE_BIT		\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SCALE)
#define IIO_CHAN_INFO_SCALE_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SCALE)
#define IIO_CHAN_INFO_OFFSET_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_OFFSET)
#define IIO_CHAN_INFO_OFFSET_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_OFFSET)
#define IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBSCALE)
#define IIO_CHAN_INFO_CALIBSCALE_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBSCALE)
#define IIO_CHAN_INFO_CALIBBIAS_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBBIAS)
#define IIO_CHAN_INFO_CALIBBIAS_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBBIAS)
#define IIO_CHAN_INFO_PEAK_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAK)
#define IIO_CHAN_INFO_PEAK_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAK)
#define IIO_CHAN_INFO_PEAKSCALE_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAKSCALE)
#define IIO_CHAN_INFO_PEAKSCALE_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAKSCALE)
#define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SEPARATE_BIT	\
	IIO_CHAN_INFO_SEPARATE_BIT(				\
		IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
#define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SHARED_BIT	\
	IIO_CHAN_INFO_SHARED_BIT(				\
		IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
#define IIO_CHAN_INFO_AVERAGE_RAW_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
#define IIO_CHAN_INFO_AVERAGE_RAW_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
#define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SHARED_BIT \
	IIO_CHAN_INFO_SHARED_BIT(			       \
		IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY)
#define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SEPARATE_BIT \
	IIO_CHAN_INFO_SEPARATE_BIT(			       \
		IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY)
#define IIO_CHAN_INFO_SAMP_FREQ_SEPARATE_BIT		\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SAMP_FREQ)
#define IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SAMP_FREQ)
#define IIO_CHAN_INFO_FREQUENCY_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_FREQUENCY)
#define IIO_CHAN_INFO_FREQUENCY_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_FREQUENCY)
#define IIO_CHAN_INFO_PHASE_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PHASE)
#define IIO_CHAN_INFO_PHASE_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PHASE)

enum iio_endian {
	IIO_CPU,
	IIO_BE,
	IIO_LE,
};

struct iio_chan_spec;
struct iio_dev;

/**
 * struct iio_chan_spec_ext_info - Extended channel info attribute
 * @name:	Info attribute name
 * @shared:	Whether this attribute is shared between all channels.
 * @read:	Read callback for this info attribute, may be NULL.
 * @write:	Write callback for this info attribute, may be NULL.
 * @private:	Data private to the driver.
 */
struct iio_chan_spec_ext_info {
	const char *name;
	bool shared;
	ssize_t (*read)(struct iio_dev *, uintptr_t private,
			struct iio_chan_spec const *, char *buf);
	ssize_t (*write)(struct iio_dev *, uintptr_t private,
			 struct iio_chan_spec const *, const char *buf,
			 size_t len);
	uintptr_t private;
};

/**
 * struct iio_chan_spec - specification of a single channel
 * @type:		What type of measurement is the channel making.
 * @channel:		What number or name do we wish to assign the channel.
 * @channel2:		If there is a second number for a differential
 *			channel then this is it. If modified is set then the
 *			value here specifies the modifier.
 * @address:		Driver specific identifier.
 * @scan_index:	Monotonic index to give ordering in scans when read
 *			from a buffer.
 * @scan_type:		Sign:		's' or 'u' to specify signed or unsigned
 *			realbits:	Number of valid bits of data
 *			storage_bits:	Realbits + padding
 *			shift:		Shift right by this before masking out
 *					realbits.
 *			endianness:	little or big endian
 * @info_mask:		What information is to be exported about this channel.
 *			This includes calibbias, scale etc.
 * @event_mask:	What events can this channel produce.
 * @ext_info:		Array of extended info attributes for this channel.
 *			The array is NULL terminated, the last element should
 *			have it's name field set to NULL.
 * @extend_name:	Allows labeling of channel attributes with an
 *			informative name. Note this has no effect codes etc,
 *			unlike modifiers.
 * @datasheet_name:	A name used in in kernel mapping of channels. It should
 *			correspond to the first name that the channel is referred
 *			to by in the datasheet (e.g. IND), or the nearest
 *			possible compound name (e.g. IND-INC).
 * @modified:		Does a modifier apply to this channel. What these are
 *			depends on the channel type.  Modifier is set in
 *			channel2. Examples are IIO_MOD_X for axial sensors about
 *			the 'x' axis.
 * @indexed:		Specify the channel has a numerical index. If not,
 *			the value in channel will be suppressed for attribute
 *			but not for event codes. Typically set it to 0 when
 *			the index is false.
 * @differential:	Channel is differential.
 */
struct iio_chan_spec {
	enum iio_chan_type	type;
	int			channel;
	int			channel2;
	unsigned long		address;
	int			scan_index;
	struct {
		char	sign;
		u8	realbits;
		u8	storagebits;
		u8	shift;
		enum iio_endian endianness;
	} scan_type;
	long			info_mask;
	long			event_mask;
	const struct iio_chan_spec_ext_info *ext_info;
	const char		*extend_name;
	const char		*datasheet_name;
	unsigned		modified:1;
	unsigned		indexed:1;
	unsigned		output:1;
	unsigned		differential:1;
};

#define IIO_ST(si, rb, sb, sh)						\
	{ .sign = si, .realbits = rb, .storagebits = sb, .shift = sh }

#define IIO_CHAN_SOFT_TIMESTAMP(_si)					\
	{ .type = IIO_TIMESTAMP, .channel = -1,				\
			.scan_index = _si, .scan_type = IIO_ST('s', 64, 64, 0) }

/**
 * iio_get_time_ns() - utility function to get a time stamp for events etc
 **/
static inline s64 iio_get_time_ns(void)
{
	struct timespec ts;
	/*
	 * calls getnstimeofday.
	 * If hrtimers then up to ns accurate, if not microsecond.
	 */
	ktime_get_real_ts(&ts);

	return timespec_to_ns(&ts);
}

/* Device operating modes */
#define INDIO_DIRECT_MODE		0x01
#define INDIO_BUFFER_TRIGGERED		0x02
#define INDIO_BUFFER_HARDWARE		0x08

#define INDIO_ALL_BUFFER_MODES					\
	(INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE)

struct iio_trigger; /* forward declaration */
struct iio_dev;

/**
 * struct iio_info - constant information about device
 * @driver_module:	module structure used to ensure correct
 *			ownership of chrdevs etc
 * @event_attrs:	event control attributes
 * @attrs:		general purpose device attributes
 * @read_raw:		function to request a value from the device.
 *			mask specifies which value. Note 0 means a reading of
 *			the channel in question.  Return value will specify the
 *			type of value returned by the device. val and val2 will
 *			contain the elements making up the returned value.
 * @write_raw:		function to write a value to the device.
 *			Parameters are the same as for read_raw.
 * @write_raw_get_fmt:	callback function to query the expected
 *			format/precision. If not set by the driver, write_raw
 *			returns IIO_VAL_INT_PLUS_MICRO.
 * @read_event_config:	find out if the event is enabled.
 * @write_event_config:	set if the event is enabled.
 * @read_event_value:	read a value associated with the event. Meaning
 *			is event dependant. event_code specifies which event.
 * @write_event_value:	write the value associated with the event.
 *			Meaning is event dependent.
 * @validate_trigger:	function to validate the trigger when the
 *			current trigger gets changed.
 **/
struct iio_info {
	struct module			*driver_module;
	struct attribute_group		*event_attrs;
	const struct attribute_group	*attrs;

	int (*read_raw)(struct iio_dev *indio_dev,
			struct iio_chan_spec const *chan,
			int *val,
			int *val2,
			long mask);

	int (*write_raw)(struct iio_dev *indio_dev,
			 struct iio_chan_spec const *chan,
			 int val,
			 int val2,
			 long mask);

	int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
			 struct iio_chan_spec const *chan,
			 long mask);

	int (*read_event_config)(struct iio_dev *indio_dev,
				 u64 event_code);

	int (*write_event_config)(struct iio_dev *indio_dev,
				  u64 event_code,
				  int state);

	int (*read_event_value)(struct iio_dev *indio_dev,
				u64 event_code,
				int *val);
	int (*write_event_value)(struct iio_dev *indio_dev,
				 u64 event_code,
				 int val);
	int (*validate_trigger)(struct iio_dev *indio_dev,
				struct iio_trigger *trig);
	int (*update_scan_mode)(struct iio_dev *indio_dev,
				const unsigned long *scan_mask);
	int (*debugfs_reg_access)(struct iio_dev *indio_dev,
				  unsigned reg, unsigned writeval,
				  unsigned *readval);
};

/**
 * struct iio_buffer_setup_ops - buffer setup related callbacks
 * @preenable:		[DRIVER] function to run prior to marking buffer enabled
 * @postenable:		[DRIVER] function to run after marking buffer enabled
 * @predisable:		[DRIVER] function to run prior to marking buffer
 *			disabled
 * @postdisable:	[DRIVER] function to run after marking buffer disabled
 */
struct iio_buffer_setup_ops {
	int				(*preenable)(struct iio_dev *);
	int				(*postenable)(struct iio_dev *);
	int				(*predisable)(struct iio_dev *);
	int				(*postdisable)(struct iio_dev *);
};

/**
 * struct iio_dev - industrial I/O device
 * @id:			[INTERN] used to identify device internally
 * @modes:		[DRIVER] operating modes supported by device
 * @currentmode:	[DRIVER] current operating mode
 * @dev:		[DRIVER] device structure, should be assigned a parent
 *			and owner
 * @event_interface:	[INTERN] event chrdevs associated with interrupt lines
 * @buffer:		[DRIVER] any buffer present
 * @scan_bytes:		[INTERN] num bytes captured to be fed to buffer demux
 * @mlock:		[INTERN] lock used to prevent simultaneous device state
 *			changes
 * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
 * @masklength:		[INTERN] the length of the mask established from
 *			channels
 * @active_scan_mask:	[INTERN] union of all scan masks requested by buffers
 * @scan_timestamp:	[INTERN] set if any buffers have requested timestamp
 * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
 * @trig:		[INTERN] current device trigger (buffer modes)
 * @pollfunc:		[DRIVER] function run on trigger being received
 * @channels:		[DRIVER] channel specification structure table
 * @num_channels:	[DRIVER] number of chanels specified in @channels.
 * @channel_attr_list:	[INTERN] keep track of automatically created channel
 *			attributes
 * @chan_attr_group:	[INTERN] group for all attrs in base directory
 * @name:		[DRIVER] name of the device.
 * @info:		[DRIVER] callbacks and constant info from driver
 * @info_exist_lock:	[INTERN] lock to prevent use during removal
 * @setup_ops:		[DRIVER] callbacks to call before and after buffer
 *			enable/disable
 * @chrdev:		[INTERN] associated character device
 * @groups:		[INTERN] attribute groups
 * @groupcounter:	[INTERN] index of next attribute group
 * @flags:		[INTERN] file ops related flags including busy flag.
 * @debugfs_dentry:	[INTERN] device specific debugfs dentry.
 * @cached_reg_addr:	[INTERN] cached register address for debugfs reads.
 */
struct iio_dev {
	int				id;

	int				modes;
	int				currentmode;
	struct device			dev;

	struct iio_event_interface	*event_interface;

	struct iio_buffer		*buffer;
	int				scan_bytes;
	struct mutex			mlock;

	const unsigned long		*available_scan_masks;
	unsigned			masklength;
	const unsigned long		*active_scan_mask;
	bool				scan_timestamp;
	unsigned			scan_index_timestamp;
	struct iio_trigger		*trig;
	struct iio_poll_func		*pollfunc;

	struct iio_chan_spec const	*channels;
	int				num_channels;

	struct list_head		channel_attr_list;
	struct attribute_group		chan_attr_group;
	const char			*name;
	const struct iio_info		*info;
	struct mutex			info_exist_lock;
	const struct iio_buffer_setup_ops	*setup_ops;
	struct cdev			chrdev;
#define IIO_MAX_GROUPS 6
	const struct attribute_group	*groups[IIO_MAX_GROUPS + 1];
	int				groupcounter;

	unsigned long			flags;
#if defined(CONFIG_DEBUG_FS)
	struct dentry			*debugfs_dentry;
	unsigned			cached_reg_addr;
#endif
};

/**
 * iio_find_channel_from_si() - get channel from its scan index
 * @indio_dev:		device
 * @si:			scan index to match
 */
const struct iio_chan_spec
*iio_find_channel_from_si(struct iio_dev *indio_dev, int si);

/**
 * iio_device_register() - register a device with the IIO subsystem
 * @indio_dev:		Device structure filled by the device driver
 **/
int iio_device_register(struct iio_dev *indio_dev);

/**
 * iio_device_unregister() - unregister a device from the IIO subsystem
 * @indio_dev:		Device structure representing the device.
 **/
void iio_device_unregister(struct iio_dev *indio_dev);

/**
 * iio_push_event() - try to add event to the list for userspace reading
 * @indio_dev:		IIO device structure
 * @ev_code:		What event
 * @timestamp:		When the event occurred
 **/
int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);

extern struct bus_type iio_bus_type;

/**
 * iio_device_put() - reference counted deallocation of struct device
 * @dev: the iio_device containing the device
 **/
static inline void iio_device_put(struct iio_dev *indio_dev)
{
	if (indio_dev)
		put_device(&indio_dev->dev);
};

/* Can we make this smaller? */
#define IIO_ALIGN L1_CACHE_BYTES
/**
 * iio_device_alloc() - allocate an iio_dev from a driver
 * @sizeof_priv: Space to allocate for private structure.
 **/
struct iio_dev *iio_device_alloc(int sizeof_priv);

static inline void *iio_priv(const struct iio_dev *indio_dev)
{
	return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
}

static inline struct iio_dev *iio_priv_to_dev(void *priv)
{
	return (struct iio_dev *)((char *)priv -
				  ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
}

/**
 * iio_device_free() - free an iio_dev from a driver
 * @dev: the iio_dev associated with the device
 **/
void iio_device_free(struct iio_dev *indio_dev);

/**
 * iio_buffer_enabled() - helper function to test if the buffer is enabled
 * @indio_dev:		IIO device info structure for device
 **/
static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
{
	return indio_dev->currentmode
		& (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE);
};

/**
 * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
 * @indio_dev:		IIO device info structure for device
 **/
#if defined(CONFIG_DEBUG_FS)
static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
{
	return indio_dev->debugfs_dentry;
};
#else
static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
{
	return NULL;
};
#endif

#endif /* _INDUSTRIAL_IO_H_ */
Commit	Line	Data
7d438178	1
847ec80b JC	2	/* The industrial I/O core
	3	*
	4	* Copyright (c) 2008 Jonathan Cameron
	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License version 2 as published by
	8	* the Free Software Foundation.
	9	*/
847ec80b JC	10	#ifndef _INDUSTRIAL_IO_H_
	11	#define _INDUSTRIAL_IO_H_
	12
	13	#include <linux/device.h>
	14	#include <linux/cdev.h>
06458e27	15	#include <linux/iio/types.h>
847ec80b	16	/* IIO TODO LIST */
751a3700	17	/*
847ec80b JC	18	* Provide means of adjusting timer accuracy.
	19	* Currently assumes nano seconds.
	20	*/
	21
1d892719	22	enum iio_chan_info_enum {
5ccb3adb JC	23	IIO_CHAN_INFO_RAW = 0,
	24	IIO_CHAN_INFO_PROCESSED,
	25	IIO_CHAN_INFO_SCALE,
c8a9f805 JC	26	IIO_CHAN_INFO_OFFSET,
	27	IIO_CHAN_INFO_CALIBSCALE,
	28	IIO_CHAN_INFO_CALIBBIAS,
	29	IIO_CHAN_INFO_PEAK,
	30	IIO_CHAN_INFO_PEAK_SCALE,
	31	IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW,
	32	IIO_CHAN_INFO_AVERAGE_RAW,
df94aba8	33	IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY,
ce85a1cb	34	IIO_CHAN_INFO_SAMP_FREQ,
a6b12855 MH	35	IIO_CHAN_INFO_FREQUENCY,
a6b12855 MH	36	IIO_CHAN_INFO_PHASE,
1d892719 JC	37	};
1d892719 JC	38
c8a9f805 JC	39	#define IIO_CHAN_INFO_SHARED_BIT(type) BIT(type*2)
	40	#define IIO_CHAN_INFO_SEPARATE_BIT(type) BIT(type*2 + 1)
	41
5ccb3adb JC	42	#define IIO_CHAN_INFO_RAW_SEPARATE_BIT \
	43	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_RAW)
	44	#define IIO_CHAN_INFO_PROCESSED_SEPARATE_BIT \
	45	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PROCESSED)
c8a9f805 JC	46	#define IIO_CHAN_INFO_SCALE_SEPARATE_BIT \
	47	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SCALE)
	48	#define IIO_CHAN_INFO_SCALE_SHARED_BIT \
	49	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SCALE)
	50	#define IIO_CHAN_INFO_OFFSET_SEPARATE_BIT \
	51	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_OFFSET)
	52	#define IIO_CHAN_INFO_OFFSET_SHARED_BIT \
	53	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_OFFSET)
	54	#define IIO_CHAN_INFO_CALIBSCALE_SEPARATE_BIT \
	55	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBSCALE)
	56	#define IIO_CHAN_INFO_CALIBSCALE_SHARED_BIT \
	57	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBSCALE)
	58	#define IIO_CHAN_INFO_CALIBBIAS_SEPARATE_BIT \
	59	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_CALIBBIAS)
	60	#define IIO_CHAN_INFO_CALIBBIAS_SHARED_BIT \
	61	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_CALIBBIAS)
	62	#define IIO_CHAN_INFO_PEAK_SEPARATE_BIT \
	63	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAK)
	64	#define IIO_CHAN_INFO_PEAK_SHARED_BIT \
	65	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAK)
	66	#define IIO_CHAN_INFO_PEAKSCALE_SEPARATE_BIT \
	67	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PEAKSCALE)
	68	#define IIO_CHAN_INFO_PEAKSCALE_SHARED_BIT \
	69	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PEAKSCALE)
	70	#define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SEPARATE_BIT \
	71	IIO_CHAN_INFO_SEPARATE_BIT( \
	72	IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
	73	#define IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW_SHARED_BIT \
	74	IIO_CHAN_INFO_SHARED_BIT( \
	75	IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW)
	76	#define IIO_CHAN_INFO_AVERAGE_RAW_SEPARATE_BIT \
	77	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
	78	#define IIO_CHAN_INFO_AVERAGE_RAW_SHARED_BIT \
	79	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_AVERAGE_RAW)
df94aba8 JC	80	#define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SHARED_BIT \
	81	IIO_CHAN_INFO_SHARED_BIT( \
	82	IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY)
	83	#define IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY_SEPARATE_BIT \
	84	IIO_CHAN_INFO_SEPARATE_BIT( \
	85	IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY)
ce85a1cb LD	86	#define IIO_CHAN_INFO_SAMP_FREQ_SEPARATE_BIT \
	87	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_SAMP_FREQ)
	88	#define IIO_CHAN_INFO_SAMP_FREQ_SHARED_BIT \
	89	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_SAMP_FREQ)
a6b12855 MH	90	#define IIO_CHAN_INFO_FREQUENCY_SEPARATE_BIT \
	91	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_FREQUENCY)
	92	#define IIO_CHAN_INFO_FREQUENCY_SHARED_BIT \
	93	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_FREQUENCY)
	94	#define IIO_CHAN_INFO_PHASE_SEPARATE_BIT \
	95	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_PHASE)
	96	#define IIO_CHAN_INFO_PHASE_SHARED_BIT \
	97	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_PHASE)
c8a9f805	98
8310b86c JC	99	enum iio_endian {
	100	IIO_CPU,
	101	IIO_BE,
	102	IIO_LE,
	103	};
	104
5f420b42 LPC	105	struct iio_chan_spec;
	106	struct iio_dev;
	107
	108	/**
	109	* struct iio_chan_spec_ext_info - Extended channel info attribute
	110	* @name: Info attribute name
	111	* @shared: Whether this attribute is shared between all channels.
	112	* @read: Read callback for this info attribute, may be NULL.
	113	* @write: Write callback for this info attribute, may be NULL.
fc6d1139	114	* @private: Data private to the driver.
5f420b42 LPC	115	*/
	116	struct iio_chan_spec_ext_info {
	117	const char *name;
	118	bool shared;
fc6d1139 MH	119	ssize_t (read)(struct iio_dev , uintptr_t private,
	120	struct iio_chan_spec const , char buf);
	121	ssize_t (write)(struct iio_dev , uintptr_t private,
	122	struct iio_chan_spec const , const char buf,
	123	size_t len);
	124	uintptr_t private;
5f420b42 LPC	125	};
5f420b42 LPC	126
1d892719 JC	127	/**
	128	* struct iio_chan_spec - specification of a single channel
	129	* @type: What type of measurement is the channel making.
4abf6f8b	130	* @channel: What number or name do we wish to assign the channel.
1d892719 JC	131	* @channel2: If there is a second number for a differential
	132	* channel then this is it. If modified is set then the
	133	* value here specifies the modifier.
	134	* @address: Driver specific identifier.
	135	* @scan_index: Monotonic index to give ordering in scans when read
	136	* from a buffer.
	137	* @scan_type: Sign: 's' or 'u' to specify signed or unsigned
	138	* realbits: Number of valid bits of data
	139	* storage_bits: Realbits + padding
	140	* shift: Shift right by this before masking out
	141	* realbits.
8310b86c	142	* endianness: little or big endian
1d892719 JC	143	* @info_mask: What information is to be exported about this channel.
	144	* This includes calibbias, scale etc.
	145	* @event_mask: What events can this channel produce.
5f420b42 LPC	146	* @ext_info: Array of extended info attributes for this channel.
	147	* The array is NULL terminated, the last element should
	148	* have it's name field set to NULL.
1d892719 JC	149	* @extend_name: Allows labeling of channel attributes with an
	150	* informative name. Note this has no effect codes etc,
	151	* unlike modifiers.
6c63dded	152	* @datasheet_name: A name used in in kernel mapping of channels. It should
4abf6f8b	153	* correspond to the first name that the channel is referred
6c63dded JC	154	* to by in the datasheet (e.g. IND), or the nearest
6c63dded JC	155	* possible compound name (e.g. IND-INC).
1d892719 JC	156	* @modified: Does a modifier apply to this channel. What these are
	157	* depends on the channel type. Modifier is set in
	158	* channel2. Examples are IIO_MOD_X for axial sensors about
	159	* the 'x' axis.
	160	* @indexed: Specify the channel has a numerical index. If not,
	161	* the value in channel will be suppressed for attribute
	162	* but not for event codes. Typically set it to 0 when
	163	* the index is false.
ade7ef7b	164	* @differential: Channel is differential.
1d892719 JC	165	*/
	166	struct iio_chan_spec {
	167	enum iio_chan_type type;
	168	int channel;
	169	int channel2;
	170	unsigned long address;
	171	int scan_index;
	172	struct {
	173	char sign;
	174	u8 realbits;
	175	u8 storagebits;
	176	u8 shift;
8310b86c	177	enum iio_endian endianness;
1d892719	178	} scan_type;
1c5e6a3f MH	179	long info_mask;
1c5e6a3f MH	180	long event_mask;
5f420b42	181	const struct iio_chan_spec_ext_info *ext_info;
344692b1	182	const char *extend_name;
6c63dded	183	const char *datasheet_name;
1d892719 JC	184	unsigned modified:1;
1d892719 JC	185	unsigned indexed:1;
c6fc8062	186	unsigned output:1;
ade7ef7b	187	unsigned differential:1;
1d892719	188	};
df9c1c42	189
1d892719 JC	190	#define IIO_ST(si, rb, sb, sh) \
	191	{ .sign = si, .realbits = rb, .storagebits = sb, .shift = sh }
	192
1d892719 JC	193	#define IIO_CHAN_SOFT_TIMESTAMP(_si) \
	194	{ .type = IIO_TIMESTAMP, .channel = -1, \
	195	.scan_index = _si, .scan_type = IIO_ST('s', 64, 64, 0) }
	196
847ec80b JC	197	/**
	198	* iio_get_time_ns() - utility function to get a time stamp for events etc
	199	**/
	200	static inline s64 iio_get_time_ns(void)
	201	{
	202	struct timespec ts;
	203	/*
	204	* calls getnstimeofday.
	205	* If hrtimers then up to ns accurate, if not microsecond.
	206	*/
	207	ktime_get_real_ts(&ts);
	208
	209	return timespec_to_ns(&ts);
	210	}
	211
847ec80b JC	212	/* Device operating modes */
847ec80b JC	213	#define INDIO_DIRECT_MODE 0x01
ec3afa40 JC	214	#define INDIO_BUFFER_TRIGGERED 0x02
ec3afa40 JC	215	#define INDIO_BUFFER_HARDWARE 0x08
847ec80b	216
ec3afa40 JC	217	#define INDIO_ALL_BUFFER_MODES \
ec3afa40 JC	218	(INDIO_BUFFER_TRIGGERED \| INDIO_BUFFER_HARDWARE)
847ec80b	219
43a4360e	220	struct iio_trigger; /* forward declaration */
7ae8cf62	221	struct iio_dev;
43a4360e	222
6fe8135f JC	223	/**
	224	* struct iio_info - constant information about device
	225	* @driver_module: module structure used to ensure correct
	226	* ownership of chrdevs etc
6fe8135f JC	227	* @event_attrs: event control attributes
	228	* @attrs: general purpose device attributes
	229	* @read_raw: function to request a value from the device.
	230	* mask specifies which value. Note 0 means a reading of
	231	* the channel in question. Return value will specify the
	232	* type of value returned by the device. val and val2 will
	233	* contain the elements making up the returned value.
	234	* @write_raw: function to write a value to the device.
	235	* Parameters are the same as for read_raw.
5c04af04 MH	236	* @write_raw_get_fmt: callback function to query the expected
	237	* format/precision. If not set by the driver, write_raw
	238	* returns IIO_VAL_INT_PLUS_MICRO.
6fe8135f JC	239	* @read_event_config: find out if the event is enabled.
	240	* @write_event_config: set if the event is enabled.
	241	* @read_event_value: read a value associated with the event. Meaning
	242	* is event dependant. event_code specifies which event.
4abf6f8b	243	* @write_event_value: write the value associated with the event.
6fe8135f	244	* Meaning is event dependent.
43a4360e MH	245	* @validate_trigger: function to validate the trigger when the
43a4360e MH	246	* current trigger gets changed.
6fe8135f JC	247	**/
	248	struct iio_info {
	249	struct module *driver_module;
6fe8135f JC	250	struct attribute_group *event_attrs;
	251	const struct attribute_group *attrs;
	252
	253	int (read_raw)(struct iio_dev indio_dev,
	254	struct iio_chan_spec const *chan,
	255	int *val,
	256	int *val2,
	257	long mask);
	258
	259	int (write_raw)(struct iio_dev indio_dev,
	260	struct iio_chan_spec const *chan,
	261	int val,
	262	int val2,
	263	long mask);
	264
5c04af04 MH	265	int (write_raw_get_fmt)(struct iio_dev indio_dev,
	266	struct iio_chan_spec const *chan,
	267	long mask);
	268
6fe8135f	269	int (read_event_config)(struct iio_dev indio_dev,
330c6c57	270	u64 event_code);
6fe8135f JC	271
6fe8135f JC	272	int (write_event_config)(struct iio_dev indio_dev,
330c6c57	273	u64 event_code,
6fe8135f JC	274	int state);
	275
	276	int (read_event_value)(struct iio_dev indio_dev,
330c6c57	277	u64 event_code,
6fe8135f JC	278	int *val);
6fe8135f JC	279	int (write_event_value)(struct iio_dev indio_dev,
330c6c57	280	u64 event_code,
6fe8135f	281	int val);
43a4360e MH	282	int (validate_trigger)(struct iio_dev indio_dev,
43a4360e MH	283	struct iio_trigger *trig);
4d5f8d3d JC	284	int (update_scan_mode)(struct iio_dev indio_dev,
4d5f8d3d JC	285	const unsigned long *scan_mask);
e553f182 MH	286	int (debugfs_reg_access)(struct iio_dev indio_dev,
	287	unsigned reg, unsigned writeval,
	288	unsigned *readval);
6fe8135f JC	289	};
6fe8135f JC	290
1612244f JC	291	/**
	292	* struct iio_buffer_setup_ops - buffer setup related callbacks
	293	* @preenable: [DRIVER] function to run prior to marking buffer enabled
	294	* @postenable: [DRIVER] function to run after marking buffer enabled
	295	* @predisable: [DRIVER] function to run prior to marking buffer
	296	* disabled
	297	* @postdisable: [DRIVER] function to run after marking buffer disabled
	298	*/
	299	struct iio_buffer_setup_ops {
	300	int (preenable)(struct iio_dev );
	301	int (postenable)(struct iio_dev );
	302	int (predisable)(struct iio_dev );
	303	int (postdisable)(struct iio_dev );
	304	};
	305
847ec80b JC	306	/**
	307	* struct iio_dev - industrial I/O device
	308	* @id: [INTERN] used to identify device internally
847ec80b JC	309	* @modes: [DRIVER] operating modes supported by device
	310	* @currentmode: [DRIVER] current operating mode
	311	* @dev: [DRIVER] device structure, should be assigned a parent
	312	* and owner
5aa96188	313	* @event_interface: [INTERN] event chrdevs associated with interrupt lines
14555b14	314	* @buffer: [DRIVER] any buffer present
420fe2e9	315	* @scan_bytes: [INTERN] num bytes captured to be fed to buffer demux
847ec80b JC	316	* @mlock: [INTERN] lock used to prevent simultaneous device state
847ec80b JC	317	* changes
e5c003ae	318	* @available_scan_masks: [DRIVER] optional array of allowed bitmasks
32b5eeca JC	319	* @masklength: [INTERN] the length of the mask established from
32b5eeca JC	320	* channels
959d2952	321	* @active_scan_mask: [INTERN] union of all scan masks requested by buffers
fd6487f8	322	* @scan_timestamp: [INTERN] set if any buffers have requested timestamp
f1264809	323	* @scan_index_timestamp:[INTERN] cache of the index to the timestamp
14555b14	324	* @trig: [INTERN] current device trigger (buffer modes)
25985edc	325	* @pollfunc: [DRIVER] function run on trigger being received
1d892719 JC	326	* @channels: [DRIVER] channel specification structure table
	327	* @num_channels: [DRIVER] number of chanels specified in @channels.
	328	* @channel_attr_list: [INTERN] keep track of automatically created channel
1a25e592	329	* attributes
26d25ae3	330	* @chan_attr_group: [INTERN] group for all attrs in base directory
1d892719	331	* @name: [DRIVER] name of the device.
1a25e592	332	* @info: [DRIVER] callbacks and constant info from driver
ac917a81	333	* @info_exist_lock: [INTERN] lock to prevent use during removal
ecbf20ca JC	334	* @setup_ops: [DRIVER] callbacks to call before and after buffer
ecbf20ca JC	335	* enable/disable
1a25e592	336	* @chrdev: [INTERN] associated character device
26d25ae3 JC	337	* @groups: [INTERN] attribute groups
26d25ae3 JC	338	* @groupcounter: [INTERN] index of next attribute group
bb01443e	339	* @flags: [INTERN] file ops related flags including busy flag.
e553f182 MH	340	* @debugfs_dentry: [INTERN] device specific debugfs dentry.
	341	* @cached_reg_addr: [INTERN] cached register address for debugfs reads.
	342	*/
847ec80b JC	343	struct iio_dev {
847ec80b JC	344	int id;
4024bc73	345
847ec80b JC	346	int modes;
	347	int currentmode;
	348	struct device dev;
847ec80b	349
5aa96188	350	struct iio_event_interface *event_interface;
847ec80b	351
14555b14	352	struct iio_buffer *buffer;
420fe2e9	353	int scan_bytes;
847ec80b JC	354	struct mutex mlock;
847ec80b JC	355
cd4361c7	356	const unsigned long *available_scan_masks;
32b5eeca	357	unsigned masklength;
cd4361c7	358	const unsigned long *active_scan_mask;
fd6487f8	359	bool scan_timestamp;
f1264809	360	unsigned scan_index_timestamp;
847ec80b JC	361	struct iio_trigger *trig;
847ec80b JC	362	struct iio_poll_func *pollfunc;
1d892719	363
1a25e592 JC	364	struct iio_chan_spec const *channels;
1a25e592 JC	365	int num_channels;
1d892719	366
1a25e592	367	struct list_head channel_attr_list;
26d25ae3	368	struct attribute_group chan_attr_group;
1a25e592 JC	369	const char *name;
1a25e592 JC	370	const struct iio_info *info;
ac917a81	371	struct mutex info_exist_lock;
1612244f	372	const struct iio_buffer_setup_ops *setup_ops;
1a25e592	373	struct cdev chrdev;
26d25ae3 JC	374	#define IIO_MAX_GROUPS 6
	375	const struct attribute_group *groups[IIO_MAX_GROUPS + 1];
	376	int groupcounter;
bb01443e LPC	377
bb01443e LPC	378	unsigned long flags;
e553f182 MH	379	#if defined(CONFIG_DEBUG_FS)
	380	struct dentry *debugfs_dentry;
	381	unsigned cached_reg_addr;
	382	#endif
847ec80b JC	383	};
847ec80b JC	384
5fb21c82 JC	385	/**
	386	* iio_find_channel_from_si() - get channel from its scan index
	387	* @indio_dev: device
	388	* @si: scan index to match
	389	*/
	390	const struct iio_chan_spec
	391	iio_find_channel_from_si(struct iio_dev indio_dev, int si);
	392
847ec80b JC	393	/**
847ec80b JC	394	* iio_device_register() - register a device with the IIO subsystem
f8c6f4e9	395	* @indio_dev: Device structure filled by the device driver
847ec80b	396	**/
f8c6f4e9	397	int iio_device_register(struct iio_dev *indio_dev);
847ec80b JC	398
	399	/**
	400	* iio_device_unregister() - unregister a device from the IIO subsystem
f8c6f4e9	401	* @indio_dev: Device structure representing the device.
847ec80b	402	**/
f8c6f4e9	403	void iio_device_unregister(struct iio_dev *indio_dev);
847ec80b	404
847ec80b JC	405	/**
847ec80b JC	406	* iio_push_event() - try to add event to the list for userspace reading
f8c6f4e9	407	* @indio_dev: IIO device structure
847ec80b	408	* @ev_code: What event
4c572605	409	* @timestamp: When the event occurred
847ec80b	410	**/
f8c6f4e9	411	int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
847ec80b	412
5aaaeba8	413	extern struct bus_type iio_bus_type;
847ec80b JC	414
847ec80b JC	415	/**
7cbb7537	416	* iio_device_put() - reference counted deallocation of struct device
847ec80b JC	417	* @dev: the iio_device containing the device
847ec80b JC	418	**/
7cbb7537	419	static inline void iio_device_put(struct iio_dev *indio_dev)
847ec80b	420	{
f8c6f4e9 JC	421	if (indio_dev)
f8c6f4e9 JC	422	put_device(&indio_dev->dev);
847ec80b JC	423	};
847ec80b JC	424
6f7c8ee5 JC	425	/* Can we make this smaller? */
6f7c8ee5 JC	426	#define IIO_ALIGN L1_CACHE_BYTES
847ec80b	427	/**
7cbb7537	428	* iio_device_alloc() - allocate an iio_dev from a driver
6f7c8ee5	429	* @sizeof_priv: Space to allocate for private structure.
847ec80b	430	**/
7cbb7537	431	struct iio_dev *iio_device_alloc(int sizeof_priv);
6f7c8ee5	432
f8c6f4e9	433	static inline void iio_priv(const struct iio_dev indio_dev)
6f7c8ee5	434	{
f8c6f4e9	435	return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
6f7c8ee5 JC	436	}
	437
	438	static inline struct iio_dev iio_priv_to_dev(void priv)
	439	{
	440	return (struct iio_dev )((char )priv -
	441	ALIGN(sizeof(struct iio_dev), IIO_ALIGN));
	442	}
847ec80b JC	443
847ec80b JC	444	/**
7cbb7537	445	* iio_device_free() - free an iio_dev from a driver
4c572605	446	* @dev: the iio_dev associated with the device
847ec80b	447	**/
7cbb7537	448	void iio_device_free(struct iio_dev *indio_dev);
847ec80b	449
847ec80b	450	/**
14555b14	451	* iio_buffer_enabled() - helper function to test if the buffer is enabled
f8c6f4e9	452	* @indio_dev: IIO device info structure for device
847ec80b	453	**/
f8c6f4e9	454	static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
847ec80b	455	{
f8c6f4e9	456	return indio_dev->currentmode
ec3afa40	457	& (INDIO_BUFFER_TRIGGERED \| INDIO_BUFFER_HARDWARE);
847ec80b JC	458	};
847ec80b JC	459
e553f182 MH	460	/**
	461	* iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
	462	* @indio_dev: IIO device info structure for device
	463	**/
	464	#if defined(CONFIG_DEBUG_FS)
	465	static inline struct dentry iio_get_debugfs_dentry(struct iio_dev indio_dev)
	466	{
	467	return indio_dev->debugfs_dentry;
	468	};
	469	#else
	470	static inline struct dentry iio_get_debugfs_dentry(struct iio_dev indio_dev)
	471	{
	472	return NULL;
	473	};
	474	#endif
	475
847ec80b	476	#endif /* _INDUSTRIAL_IO_H_ */