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

/*
 * Industrial I/O in kernel consumer interface
 *
 * Copyright (c) 2011 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 _IIO_INKERN_CONSUMER_H_
#define _IIO_INKERN_CONSUMER_H
#include <linux/iio/types.h>

struct iio_dev;
struct iio_chan_spec;

/**
 * struct iio_channel - everything needed for a consumer to use a channel
 * @indio_dev:		Device on which the channel exists.
 * @channel:		Full description of the channel.
 */
struct iio_channel {
	struct iio_dev *indio_dev;
	const struct iio_chan_spec *channel;
};

/**
 * iio_channel_get() - get description of all that is needed to access channel.
 * @name:		Unique name of the device as provided in the iio_map
 *			with which the desired provider to consumer mapping
 *			was registered.
 * @consumer_channel:	Unique name to identify the channel on the consumer
 *			side. This typically describes the channels use within
 *			the consumer. E.g. 'battery_voltage'
 */
struct iio_channel *iio_channel_get(const char *name,
				    const char *consumer_channel);

/**
 * iio_channel_release() - release channels obtained via iio_channel_get
 * @chan:		The channel to be released.
 */
void iio_channel_release(struct iio_channel *chan);

/**
 * iio_channel_get_all() - get all channels associated with a client
 * @name:		name of consumer device.
 *
 * Returns an array of iio_channel structures terminated with one with
 * null iio_dev pointer.
 * This function is used by fairly generic consumers to get all the
 * channels registered as having this consumer.
 */
struct iio_channel *iio_channel_get_all(const char *name);

/**
 * iio_channel_release_all() - reverse iio_channel_get_all
 * @chan:		Array of channels to be released.
 */
void iio_channel_release_all(struct iio_channel *chan);

/**
 * iio_read_channel_raw() - read from a given channel
 * @channel:		The channel being queried.
 * @val:		Value read back.
 *
 * Note raw reads from iio channels are in adc counts and hence
 * scale will need to be applied if standard units required.
 */
int iio_read_channel_raw(struct iio_channel *chan,
			 int *val);

/**
 * iio_get_channel_type() - get the type of a channel
 * @channel:		The channel being queried.
 * @type:		The type of the channel.
 *
 * returns the enum iio_chan_type of the channel
 */
int iio_get_channel_type(struct iio_channel *channel,
			 enum iio_chan_type *type);

/**
 * iio_read_channel_scale() - read the scale value for a channel
 * @channel:		The channel being queried.
 * @val:		First part of value read back.
 * @val2:		Second part of value read back.
 *
 * Note returns a description of what is in val and val2, such
 * as IIO_VAL_INT_PLUS_MICRO telling us we have a value of val
 * + val2/1e6
 */
int iio_read_channel_scale(struct iio_channel *chan, int *val,
			   int *val2);

#endif
Commit	Line	Data
e27d75d7 JC	1	/*
	2	* Industrial I/O in kernel consumer interface
	3	*
	4	* Copyright (c) 2011 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	*/
	10	#ifndef _IIO_INKERN_CONSUMER_H_
	11	#define _IIO_INKERN_CONSUMER_H
06458e27	12	#include <linux/iio/types.h>
e27d75d7 JC	13
	14	struct iio_dev;
	15	struct iio_chan_spec;
	16
	17	/**
	18	* struct iio_channel - everything needed for a consumer to use a channel
	19	* @indio_dev: Device on which the channel exists.
	20	* @channel: Full description of the channel.
	21	*/
	22	struct iio_channel {
	23	struct iio_dev *indio_dev;
	24	const struct iio_chan_spec *channel;
	25	};
	26
	27	/**
	28	* iio_channel_get() - get description of all that is needed to access channel.
	29	* @name: Unique name of the device as provided in the iio_map
	30	* with which the desired provider to consumer mapping
	31	* was registered.
	32	* @consumer_channel: Unique name to identify the channel on the consumer
	33	* side. This typically describes the channels use within
	34	* the consumer. E.g. 'battery_voltage'
	35	*/
314be14b JC	36	struct iio_channel iio_channel_get(const char name,
314be14b JC	37	const char *consumer_channel);
e27d75d7 JC	38
e27d75d7 JC	39	/**
314be14b	40	* iio_channel_release() - release channels obtained via iio_channel_get
e27d75d7 JC	41	* @chan: The channel to be released.
e27d75d7 JC	42	*/
314be14b	43	void iio_channel_release(struct iio_channel *chan);
e27d75d7 JC	44
e27d75d7 JC	45	/**
314be14b	46	* iio_channel_get_all() - get all channels associated with a client
e27d75d7 JC	47	* @name: name of consumer device.
	48	*
	49	* Returns an array of iio_channel structures terminated with one with
	50	* null iio_dev pointer.
	51	* This function is used by fairly generic consumers to get all the
	52	* channels registered as having this consumer.
	53	*/
314be14b	54	struct iio_channel iio_channel_get_all(const char name);
e27d75d7 JC	55
e27d75d7 JC	56	/**
314be14b	57	* iio_channel_release_all() - reverse iio_channel_get_all
e27d75d7 JC	58	* @chan: Array of channels to be released.
e27d75d7 JC	59	*/
314be14b	60	void iio_channel_release_all(struct iio_channel *chan);
e27d75d7 JC	61
e27d75d7 JC	62	/**
314be14b	63	* iio_read_channel_raw() - read from a given channel
e27d75d7 JC	64	* @channel: The channel being queried.
	65	* @val: Value read back.
	66	*
	67	* Note raw reads from iio channels are in adc counts and hence
	68	* scale will need to be applied if standard units required.
	69	*/
314be14b JC	70	int iio_read_channel_raw(struct iio_channel *chan,
314be14b JC	71	int *val);
e27d75d7 JC	72
e27d75d7 JC	73	/**
314be14b	74	* iio_get_channel_type() - get the type of a channel
e27d75d7 JC	75	* @channel: The channel being queried.
	76	* @type: The type of the channel.
	77	*
	78	* returns the enum iio_chan_type of the channel
	79	*/
314be14b JC	80	int iio_get_channel_type(struct iio_channel *channel,
314be14b JC	81	enum iio_chan_type *type);
e27d75d7 JC	82
e27d75d7 JC	83	/**
314be14b	84	* iio_read_channel_scale() - read the scale value for a channel
e27d75d7 JC	85	* @channel: The channel being queried.
	86	* @val: First part of value read back.
	87	* @val2: Second part of value read back.
	88	*
	89	* Note returns a description of what is in val and val2, such
	90	* as IIO_VAL_INT_PLUS_MICRO telling us we have a value of val
	91	* + val2/1e6
	92	*/
314be14b JC	93	int iio_read_channel_scale(struct iio_channel chan, int val,
314be14b JC	94	int *val2);
e27d75d7 JC	95
e27d75d7 JC	96	#endif