[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.
 */
struct iio_chan_spec_ext_info {
	const char *name;
	bool shared;
	ssize_t (*read)(struct iio_dev *, struct iio_chan_spec const *,
			char *buf);
	ssize_t (*write)(struct iio_dev *, struct iio_chan_spec const *,
			const char *buf, size_t len);
};

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