iio.h 19.9 KB
Newer Older
1

2 3 4 5 6 7 8 9 10 11 12 13 14
/* 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>
15
#include <linux/iio/types.h>
16
/* IIO TODO LIST */
J
Jonathan Cameron 已提交
17
/*
18 19 20 21
 * Provide means of adjusting timer accuracy.
 * Currently assumes nano seconds.
 */

22
enum iio_chan_info_enum {
23 24 25
	IIO_CHAN_INFO_RAW = 0,
	IIO_CHAN_INFO_PROCESSED,
	IIO_CHAN_INFO_SCALE,
26 27 28 29 30 31 32
	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,
33
	IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY,
34
	IIO_CHAN_INFO_SAMP_FREQ,
35 36
	IIO_CHAN_INFO_FREQUENCY,
	IIO_CHAN_INFO_PHASE,
37
	IIO_CHAN_INFO_HARDWAREGAIN,
38 39
};

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

43 44 45 46
#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)
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
#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)
81 82 83 84 85 86
#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)
87 88 89 90
#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)
91 92 93 94 95 96 97 98
#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)
99 100 101 102
#define IIO_CHAN_INFO_HARDWAREGAIN_SEPARATE_BIT			\
	IIO_CHAN_INFO_SEPARATE_BIT(IIO_CHAN_INFO_HARDWAREGAIN)
#define IIO_CHAN_INFO_HARDWAREGAIN_SHARED_BIT			\
	IIO_CHAN_INFO_SHARED_BIT(IIO_CHAN_INFO_HARDWAREGAIN)
103

104 105 106 107 108 109
enum iio_endian {
	IIO_CPU,
	IIO_BE,
	IIO_LE,
};

110 111 112 113 114 115 116 117 118
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.
119
 * @private:	Data private to the driver.
120 121 122 123
 */
struct iio_chan_spec_ext_info {
	const char *name;
	bool shared;
124 125 126 127 128 129
	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;
130 131
};

132 133
/**
 * struct iio_enum - Enum channel info attribute
P
Peter Meerwald 已提交
134 135 136 137
 * @items:	An array of strings.
 * @num_items:	Length of the item array.
 * @set:	Set callback function, may be NULL.
 * @get:	Get callback function, may be NULL.
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
 *
 * The iio_enum struct can be used to implement enum style channel attributes.
 * Enum style attributes are those which have a set of strings which map to
 * unsigned integer values. The IIO enum helper code takes care of mapping
 * between value and string as well as generating a "_available" file which
 * contains a list of all available items. The set callback will be called when
 * the attribute is updated. The last parameter is the index to the newly
 * activated item. The get callback will be used to query the currently active
 * item and is supposed to return the index for it.
 */
struct iio_enum {
	const char * const *items;
	unsigned int num_items;
	int (*set)(struct iio_dev *, const struct iio_chan_spec *, unsigned int);
	int (*get)(struct iio_dev *, const struct iio_chan_spec *);
};

ssize_t iio_enum_available_read(struct iio_dev *indio_dev,
	uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
ssize_t iio_enum_read(struct iio_dev *indio_dev,
	uintptr_t priv, const struct iio_chan_spec *chan, char *buf);
ssize_t iio_enum_write(struct iio_dev *indio_dev,
	uintptr_t priv, const struct iio_chan_spec *chan, const char *buf,
	size_t len);

/**
 * IIO_ENUM() - Initialize enum extended channel attribute
P
Peter Meerwald 已提交
165 166 167
 * @_name:	Attribute name
 * @_shared:	Whether the attribute is shared between all channels
 * @_e:		Pointer to a iio_enum struct
168 169 170 171 172 173 174 175 176 177 178 179 180 181
 *
 * This should usually be used together with IIO_ENUM_AVAILABLE()
 */
#define IIO_ENUM(_name, _shared, _e) \
{ \
	.name = (_name), \
	.shared = (_shared), \
	.read = iio_enum_read, \
	.write = iio_enum_write, \
	.private = (uintptr_t)(_e), \
}

/**
 * IIO_ENUM_AVAILABLE() - Initialize enum available extended channel attribute
P
Peter Meerwald 已提交
182 183
 * @_name:	Attribute name ("_available" will be appended to the name)
 * @_e:		Pointer to a iio_enum struct
184 185 186 187 188 189 190 191 192 193 194 195
 *
 * Creates a read only attribute which list all the available enum items in a
 * space separated list. This should usually be used together with IIO_ENUM()
 */
#define IIO_ENUM_AVAILABLE(_name, _e) \
{ \
	.name = (_name "_available"), \
	.shared = true, \
	.read = iio_enum_available_read, \
	.private = (uintptr_t)(_e), \
}

196 197 198
/**
 * struct iio_chan_spec - specification of a single channel
 * @type:		What type of measurement is the channel making.
199
 * @channel:		What number do we wish to assign the channel.
200 201 202 203
 * @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.
P
Peter Meerwald 已提交
204
 * @scan_index:		Monotonic index to give ordering in scans when read
205 206 207 208 209 210
 *			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.
211
 *			endianness:	little or big endian
212 213
 * @info_mask:		What information is to be exported about this channel.
 *			This includes calibbias, scale etc.
P
Peter Meerwald 已提交
214
 * @event_mask:		What events can this channel produce.
215 216
 * @ext_info:		Array of extended info attributes for this channel.
 *			The array is NULL terminated, the last element should
217
 *			have its name field set to NULL.
218 219 220
 * @extend_name:	Allows labeling of channel attributes with an
 *			informative name. Note this has no effect codes etc,
 *			unlike modifiers.
P
Peter Meerwald 已提交
221
 * @datasheet_name:	A name used in in-kernel mapping of channels. It should
222
 *			correspond to the first name that the channel is referred
223 224
 *			to by in the datasheet (e.g. IND), or the nearest
 *			possible compound name (e.g. IND-INC).
225 226 227 228 229
 * @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,
230 231
 *			the channel index number will be suppressed for sysfs
 *			attributes but not for event codes.
P
Peter Meerwald 已提交
232
 * @output:		Channel is output.
233
 * @differential:	Channel is differential.
234 235 236 237 238 239 240 241 242 243 244 245
 */
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;
246
		enum iio_endian endianness;
247
	} scan_type;
248 249
	long			info_mask;
	long			event_mask;
250
	const struct iio_chan_spec_ext_info *ext_info;
251
	const char		*extend_name;
252
	const char		*datasheet_name;
253 254
	unsigned		modified:1;
	unsigned		indexed:1;
255
	unsigned		output:1;
256
	unsigned		differential:1;
257
};
258

259 260 261 262 263 264 265
#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) }

266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
/**
 * 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
283 284
#define INDIO_BUFFER_TRIGGERED		0x02
#define INDIO_BUFFER_HARDWARE		0x08
285

286 287
#define INDIO_ALL_BUFFER_MODES					\
	(INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE)
288

289
struct iio_trigger; /* forward declaration */
290
struct iio_dev;
291

292 293 294 295 296 297 298 299 300 301 302 303 304
/**
 * 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.
305 306 307
 * @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.
308 309 310 311
 * @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.
312
 * @write_event_value:	write the value associated with the event.
313
 *			Meaning is event dependent.
314 315
 * @validate_trigger:	function to validate the trigger when the
 *			current trigger gets changed.
P
Peter Meerwald 已提交
316 317 318
 * @update_scan_mode:	function to configure device and scan buffer when
 *			channels have changed
 * @debugfs_reg_access:	function to read or write register value of device
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
 **/
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);

337 338 339 340
	int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
			 struct iio_chan_spec const *chan,
			 long mask);

341
	int (*read_event_config)(struct iio_dev *indio_dev,
342
				 u64 event_code);
343 344

	int (*write_event_config)(struct iio_dev *indio_dev,
345
				  u64 event_code,
346 347 348
				  int state);

	int (*read_event_value)(struct iio_dev *indio_dev,
349
				u64 event_code,
350 351
				int *val);
	int (*write_event_value)(struct iio_dev *indio_dev,
352
				 u64 event_code,
353
				 int val);
354 355
	int (*validate_trigger)(struct iio_dev *indio_dev,
				struct iio_trigger *trig);
356 357
	int (*update_scan_mode)(struct iio_dev *indio_dev,
				const unsigned long *scan_mask);
358 359 360
	int (*debugfs_reg_access)(struct iio_dev *indio_dev,
				  unsigned reg, unsigned writeval,
				  unsigned *readval);
361 362
};

363 364 365 366 367 368 369
/**
 * 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
370 371
 * @validate_scan_mask: [DRIVER] function callback to check whether a given
 *			scan mask is valid for the device.
372 373 374 375 376 377
 */
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 *);
378 379
	bool (*validate_scan_mask)(struct iio_dev *indio_dev,
				   const unsigned long *scan_mask);
380 381
};

382 383 384 385 386 387 388
/**
 * 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
389
 * @event_interface:	[INTERN] event chrdevs associated with interrupt lines
390
 * @buffer:		[DRIVER] any buffer present
391
 * @scan_bytes:		[INTERN] num bytes captured to be fed to buffer demux
392 393
 * @mlock:		[INTERN] lock used to prevent simultaneous device state
 *			changes
394
 * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
395 396
 * @masklength:		[INTERN] the length of the mask established from
 *			channels
397
 * @active_scan_mask:	[INTERN] union of all scan masks requested by buffers
398
 * @scan_timestamp:	[INTERN] set if any buffers have requested timestamp
399
 * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
400
 * @trig:		[INTERN] current device trigger (buffer modes)
L
Lucas De Marchi 已提交
401
 * @pollfunc:		[DRIVER] function run on trigger being received
402
 * @channels:		[DRIVER] channel specification structure table
P
Peter Meerwald 已提交
403
 * @num_channels:	[DRIVER] number of channels specified in @channels.
404
 * @channel_attr_list:	[INTERN] keep track of automatically created channel
405
 *			attributes
406
 * @chan_attr_group:	[INTERN] group for all attrs in base directory
407
 * @name:		[DRIVER] name of the device.
408
 * @info:		[DRIVER] callbacks and constant info from driver
409
 * @info_exist_lock:	[INTERN] lock to prevent use during removal
410 411
 * @setup_ops:		[DRIVER] callbacks to call before and after buffer
 *			enable/disable
412
 * @chrdev:		[INTERN] associated character device
413 414
 * @groups:		[INTERN] attribute groups
 * @groupcounter:	[INTERN] index of next attribute group
415
 * @flags:		[INTERN] file ops related flags including busy flag.
416 417 418
 * @debugfs_dentry:	[INTERN] device specific debugfs dentry.
 * @cached_reg_addr:	[INTERN] cached register address for debugfs reads.
 */
419 420
struct iio_dev {
	int				id;
421

422 423 424 425
	int				modes;
	int				currentmode;
	struct device			dev;

426
	struct iio_event_interface	*event_interface;
427

428
	struct iio_buffer		*buffer;
429
	int				scan_bytes;
430 431
	struct mutex			mlock;

432
	const unsigned long		*available_scan_masks;
433
	unsigned			masklength;
434
	const unsigned long		*active_scan_mask;
435
	bool				scan_timestamp;
436
	unsigned			scan_index_timestamp;
437 438
	struct iio_trigger		*trig;
	struct iio_poll_func		*pollfunc;
439

440 441
	struct iio_chan_spec const	*channels;
	int				num_channels;
442

443
	struct list_head		channel_attr_list;
444
	struct attribute_group		chan_attr_group;
445 446
	const char			*name;
	const struct iio_info		*info;
447
	struct mutex			info_exist_lock;
448
	const struct iio_buffer_setup_ops	*setup_ops;
449
	struct cdev			chrdev;
450 451 452
#define IIO_MAX_GROUPS 6
	const struct attribute_group	*groups[IIO_MAX_GROUPS + 1];
	int				groupcounter;
453 454

	unsigned long			flags;
455 456 457 458
#if defined(CONFIG_DEBUG_FS)
	struct dentry			*debugfs_dentry;
	unsigned			cached_reg_addr;
#endif
459 460
};

461 462 463 464 465 466 467 468
/**
 * 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);

469 470
/**
 * iio_device_register() - register a device with the IIO subsystem
471
 * @indio_dev:		Device structure filled by the device driver
472
 **/
473
int iio_device_register(struct iio_dev *indio_dev);
474 475 476

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

/**
 * iio_push_event() - try to add event to the list for userspace reading
483
 * @indio_dev:		IIO device structure
484
 * @ev_code:		What event
R
Randy Dunlap 已提交
485
 * @timestamp:		When the event occurred
486
 **/
487
int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
488

489
extern struct bus_type iio_bus_type;
490 491

/**
492
 * iio_device_put() - reference counted deallocation of struct device
P
Peter Meerwald 已提交
493
 * @indio_dev: 		IIO device structure containing the device
494
 **/
495
static inline void iio_device_put(struct iio_dev *indio_dev)
496
{
497 498
	if (indio_dev)
		put_device(&indio_dev->dev);
499 500
};

501 502
/**
 * dev_to_iio_dev() - Get IIO device struct from a device struct
P
Peter Meerwald 已提交
503
 * @dev: 		The device embedded in the IIO device
504 505 506 507 508 509 510 511
 *
 * Note: The device must be a IIO device, otherwise the result is undefined.
 */
static inline struct iio_dev *dev_to_iio_dev(struct device *dev)
{
	return container_of(dev, struct iio_dev, dev);
}

L
Lars-Peter Clausen 已提交
512 513
/**
 * iio_device_get() - increment reference count for the device
P
Peter Meerwald 已提交
514
 * @indio_dev: 		IIO device structure
L
Lars-Peter Clausen 已提交
515 516 517 518 519 520 521 522
 *
 * Returns: The passed IIO device
 **/
static inline struct iio_dev *iio_device_get(struct iio_dev *indio_dev)
{
	return indio_dev ? dev_to_iio_dev(get_device(&indio_dev->dev)) : NULL;
}

523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547

/**
 * iio_device_set_drvdata() - Set device driver data
 * @indio_dev: IIO device structure
 * @data: Driver specific data
 *
 * Allows to attach an arbitrary pointer to an IIO device, which can later be
 * retrieved by iio_device_get_drvdata().
 */
static inline void iio_device_set_drvdata(struct iio_dev *indio_dev, void *data)
{
	dev_set_drvdata(&indio_dev->dev, data);
}

/**
 * iio_device_get_drvdata() - Get device driver data
 * @indio_dev: IIO device structure
 *
 * Returns the data previously set with iio_device_set_drvdata()
 */
static inline void *iio_device_get_drvdata(struct iio_dev *indio_dev)
{
	return dev_get_drvdata(&indio_dev->dev);
}

548 549
/* Can we make this smaller? */
#define IIO_ALIGN L1_CACHE_BYTES
550
/**
551
 * iio_device_alloc() - allocate an iio_dev from a driver
P
Peter Meerwald 已提交
552
 * @sizeof_priv: 	Space to allocate for private structure.
553
 **/
554
struct iio_dev *iio_device_alloc(int sizeof_priv);
555

556
static inline void *iio_priv(const struct iio_dev *indio_dev)
557
{
558
	return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
559 560 561 562 563 564 565
}

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

/**
568
 * iio_device_free() - free an iio_dev from a driver
P
Peter Meerwald 已提交
569
 * @indio_dev: 		the iio_dev associated with the device
570
 **/
571
void iio_device_free(struct iio_dev *indio_dev);
572 573

/**
574
 * iio_buffer_enabled() - helper function to test if the buffer is enabled
P
Peter Meerwald 已提交
575
 * @indio_dev:		IIO device structure for device
576
 **/
577
static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
578
{
579
	return indio_dev->currentmode
580
		& (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE);
581 582
};

583 584
/**
 * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
P
Peter Meerwald 已提交
585
 * @indio_dev:		IIO device structure for device
586 587 588 589 590 591 592 593 594 595 596 597 598
 **/
#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

599
#endif /* _INDUSTRIAL_IO_H_ */