iio.h 22.8 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
	IIO_CHAN_INFO_HYSTERESIS,
39
	IIO_CHAN_INFO_INT_TIME,
40 41
};

42 43
enum iio_shared_by {
	IIO_SEPARATE,
44 45 46
	IIO_SHARED_BY_TYPE,
	IIO_SHARED_BY_DIR,
	IIO_SHARED_BY_ALL
47 48
};

49 50 51 52 53 54
enum iio_endian {
	IIO_CPU,
	IIO_BE,
	IIO_LE,
};

55 56 57 58 59 60 61 62 63
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.
64
 * @private:	Data private to the driver.
65 66 67
 */
struct iio_chan_spec_ext_info {
	const char *name;
68
	enum iio_shared_by shared;
69 70 71 72 73 74
	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;
75 76
};

77 78
/**
 * struct iio_enum - Enum channel info attribute
P
Peter Meerwald 已提交
79 80 81 82
 * @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.
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
 *
 * 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 已提交
110 111
 * @_name:	Attribute name
 * @_shared:	Whether the attribute is shared between all channels
P
Peter Meerwald 已提交
112
 * @_e:		Pointer to an iio_enum struct
113 114 115 116 117 118 119 120 121 122 123 124 125 126
 *
 * 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 已提交
127
 * @_name:	Attribute name ("_available" will be appended to the name)
P
Peter Meerwald 已提交
128
 * @_e:		Pointer to an iio_enum struct
129
 *
P
Peter Meerwald 已提交
130
 * Creates a read only attribute which lists all the available enum items in a
131 132 133 134 135
 * space separated list. This should usually be used together with IIO_ENUM()
 */
#define IIO_ENUM_AVAILABLE(_name, _e) \
{ \
	.name = (_name "_available"), \
136
	.shared = IIO_SHARED_BY_TYPE, \
137 138 139 140
	.read = iio_enum_available_read, \
	.private = (uintptr_t)(_e), \
}

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
/**
 * struct iio_event_spec - specification for a channel event
 * @type:		    Type of the event
 * @dir:		    Direction of the event
 * @mask_separate:	    Bit mask of enum iio_event_info values. Attributes
 *			    set in this mask will be registered per channel.
 * @mask_shared_by_type:    Bit mask of enum iio_event_info values. Attributes
 *			    set in this mask will be shared by channel type.
 * @mask_shared_by_dir:	    Bit mask of enum iio_event_info values. Attributes
 *			    set in this mask will be shared by channel type and
 *			    direction.
 * @mask_shared_by_all:	    Bit mask of enum iio_event_info values. Attributes
 *			    set in this mask will be shared by all channels.
 */
struct iio_event_spec {
	enum iio_event_type type;
	enum iio_event_direction dir;
	unsigned long mask_separate;
	unsigned long mask_shared_by_type;
	unsigned long mask_shared_by_dir;
	unsigned long mask_shared_by_all;
};

164 165 166
/**
 * struct iio_chan_spec - specification of a single channel
 * @type:		What type of measurement is the channel making.
167
 * @channel:		What number do we wish to assign the channel.
168 169 170 171
 * @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 已提交
172
 * @scan_index:		Monotonic index to give ordering in scans when read
173 174 175 176 177 178
 *			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.
179
 *			endianness:	little or big endian
180 181 182
 * @info_mask_separate: What information is to be exported that is specific to
 *			this channel.
 * @info_mask_shared_by_type: What information is to be exported that is shared
183
 *			by all channels of the same type.
184 185 186 187
 * @info_mask_shared_by_dir: What information is to be exported that is shared
 *			by all channels of the same direction.
 * @info_mask_shared_by_all: What information is to be exported that is shared
 *			by all channels.
P
Peter Meerwald 已提交
188
 * @event_mask:		What events can this channel produce.
189 190 191
 * @event_spec:		Array of events which should be registered for this
 *			channel.
 * @num_event_specs:	Size of the event_spec array.
192 193
 * @ext_info:		Array of extended info attributes for this channel.
 *			The array is NULL terminated, the last element should
194
 *			have its name field set to NULL.
195 196 197
 * @extend_name:	Allows labeling of channel attributes with an
 *			informative name. Note this has no effect codes etc,
 *			unlike modifiers.
P
Peter Meerwald 已提交
198
 * @datasheet_name:	A name used in in-kernel mapping of channels. It should
199
 *			correspond to the first name that the channel is referred
200 201
 *			to by in the datasheet (e.g. IND), or the nearest
 *			possible compound name (e.g. IND-INC).
202 203 204 205 206
 * @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,
207 208
 *			the channel index number will be suppressed for sysfs
 *			attributes but not for event codes.
P
Peter Meerwald 已提交
209
 * @output:		Channel is output.
210
 * @differential:	Channel is differential.
211 212 213 214 215 216 217 218 219 220 221 222
 */
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;
223
		enum iio_endian endianness;
224
	} scan_type;
225 226
	long			info_mask_separate;
	long			info_mask_shared_by_type;
227 228
	long			info_mask_shared_by_dir;
	long			info_mask_shared_by_all;
229
	long			event_mask;
230 231
	const struct iio_event_spec *event_spec;
	unsigned int		num_event_specs;
232
	const struct iio_chan_spec_ext_info *ext_info;
233
	const char		*extend_name;
234
	const char		*datasheet_name;
235 236
	unsigned		modified:1;
	unsigned		indexed:1;
237
	unsigned		output:1;
238
	unsigned		differential:1;
239
};
240

241 242 243 244 245 246 247 248 249 250 251 252

/**
 * iio_channel_has_info() - Checks whether a channel supports a info attribute
 * @chan: The channel to be queried
 * @type: Type of the info attribute to be checked
 *
 * Returns true if the channels supports reporting values for the given info
 * attribute type, false otherwise.
 */
static inline bool iio_channel_has_info(const struct iio_chan_spec *chan,
	enum iio_chan_info_enum type)
{
253
	return (chan->info_mask_separate & BIT(type)) |
254 255 256
		(chan->info_mask_shared_by_type & BIT(type)) |
		(chan->info_mask_shared_by_dir & BIT(type)) |
		(chan->info_mask_shared_by_all & BIT(type));
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 316 317 318 319
 * @read_event_config_new: find out if the event is enabled. New style interface.
 * @write_event_config_new: set if the event is enabled. New style interface.
 * @read_event_value_new: read a configuration value associated with the event.
 *                         New style interface.
 * @write_event_value_new: write a configuration value for the event. New style
 *			   interface.
320 321
 * @validate_trigger:	function to validate the trigger when the
 *			current trigger gets changed.
P
Peter Meerwald 已提交
322 323 324
 * @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
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
 **/
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);

343 344 345 346
	int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
			 struct iio_chan_spec const *chan,
			 long mask);

347
	int (*read_event_config)(struct iio_dev *indio_dev,
348
				 u64 event_code);
349 350

	int (*write_event_config)(struct iio_dev *indio_dev,
351
				  u64 event_code,
352 353 354
				  int state);

	int (*read_event_value)(struct iio_dev *indio_dev,
355
				u64 event_code,
356 357
				int *val);
	int (*write_event_value)(struct iio_dev *indio_dev,
358
				 u64 event_code,
359
				 int val);
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383

	int (*read_event_config_new)(struct iio_dev *indio_dev,
				 const struct iio_chan_spec *chan,
				 enum iio_event_type type,
				 enum iio_event_direction dir);

	int (*write_event_config_new)(struct iio_dev *indio_dev,
				  const struct iio_chan_spec *chan,
				  enum iio_event_type type,
				  enum iio_event_direction dir,
				  int state);

	int (*read_event_value_new)(struct iio_dev *indio_dev,
				const struct iio_chan_spec *chan,
				enum iio_event_type type,
				enum iio_event_direction dir,
				enum iio_event_info info, int *val, int *val2);

	int (*write_event_value_new)(struct iio_dev *indio_dev,
				 const struct iio_chan_spec *chan,
				 enum iio_event_type type,
				 enum iio_event_direction dir,
				 enum iio_event_info info, int val, int val2);

384 385
	int (*validate_trigger)(struct iio_dev *indio_dev,
				struct iio_trigger *trig);
386 387
	int (*update_scan_mode)(struct iio_dev *indio_dev,
				const unsigned long *scan_mask);
388 389 390
	int (*debugfs_reg_access)(struct iio_dev *indio_dev,
				  unsigned reg, unsigned writeval,
				  unsigned *readval);
391 392
};

393 394 395 396 397 398 399
/**
 * 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
400 401
 * @validate_scan_mask: [DRIVER] function callback to check whether a given
 *			scan mask is valid for the device.
402 403
 */
struct iio_buffer_setup_ops {
404 405 406 407
	int (*preenable)(struct iio_dev *);
	int (*postenable)(struct iio_dev *);
	int (*predisable)(struct iio_dev *);
	int (*postdisable)(struct iio_dev *);
408 409
	bool (*validate_scan_mask)(struct iio_dev *indio_dev,
				   const unsigned long *scan_mask);
410 411
};

412 413 414 415 416 417 418
/**
 * 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
419
 * @event_interface:	[INTERN] event chrdevs associated with interrupt lines
420
 * @buffer:		[DRIVER] any buffer present
421
 * @buffer_list:	[INTERN] list of all buffers currently attached
422
 * @scan_bytes:		[INTERN] num bytes captured to be fed to buffer demux
423 424
 * @mlock:		[INTERN] lock used to prevent simultaneous device state
 *			changes
425
 * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
426 427
 * @masklength:		[INTERN] the length of the mask established from
 *			channels
428
 * @active_scan_mask:	[INTERN] union of all scan masks requested by buffers
429
 * @scan_timestamp:	[INTERN] set if any buffers have requested timestamp
430
 * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
431
 * @trig:		[INTERN] current device trigger (buffer modes)
L
Lucas De Marchi 已提交
432
 * @pollfunc:		[DRIVER] function run on trigger being received
433
 * @channels:		[DRIVER] channel specification structure table
P
Peter Meerwald 已提交
434
 * @num_channels:	[DRIVER] number of channels specified in @channels.
435
 * @channel_attr_list:	[INTERN] keep track of automatically created channel
436
 *			attributes
437
 * @chan_attr_group:	[INTERN] group for all attrs in base directory
438
 * @name:		[DRIVER] name of the device.
439
 * @info:		[DRIVER] callbacks and constant info from driver
440
 * @info_exist_lock:	[INTERN] lock to prevent use during removal
441 442
 * @setup_ops:		[DRIVER] callbacks to call before and after buffer
 *			enable/disable
443
 * @chrdev:		[INTERN] associated character device
444 445
 * @groups:		[INTERN] attribute groups
 * @groupcounter:	[INTERN] index of next attribute group
446
 * @flags:		[INTERN] file ops related flags including busy flag.
447 448 449
 * @debugfs_dentry:	[INTERN] device specific debugfs dentry.
 * @cached_reg_addr:	[INTERN] cached register address for debugfs reads.
 */
450 451
struct iio_dev {
	int				id;
452

453 454 455 456
	int				modes;
	int				currentmode;
	struct device			dev;

457
	struct iio_event_interface	*event_interface;
458

459
	struct iio_buffer		*buffer;
460
	struct list_head		buffer_list;
461
	int				scan_bytes;
462 463
	struct mutex			mlock;

464
	const unsigned long		*available_scan_masks;
465
	unsigned			masklength;
466
	const unsigned long		*active_scan_mask;
467
	bool				scan_timestamp;
468
	unsigned			scan_index_timestamp;
469 470
	struct iio_trigger		*trig;
	struct iio_poll_func		*pollfunc;
471

472 473
	struct iio_chan_spec const	*channels;
	int				num_channels;
474

475
	struct list_head		channel_attr_list;
476
	struct attribute_group		chan_attr_group;
477 478
	const char			*name;
	const struct iio_info		*info;
479
	struct mutex			info_exist_lock;
480
	const struct iio_buffer_setup_ops	*setup_ops;
481
	struct cdev			chrdev;
482 483 484
#define IIO_MAX_GROUPS 6
	const struct attribute_group	*groups[IIO_MAX_GROUPS + 1];
	int				groupcounter;
485 486

	unsigned long			flags;
487 488 489 490
#if defined(CONFIG_DEBUG_FS)
	struct dentry			*debugfs_dentry;
	unsigned			cached_reg_addr;
#endif
491 492
};

493 494 495 496 497 498 499 500
/**
 * 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);

501 502
/**
 * iio_device_register() - register a device with the IIO subsystem
503
 * @indio_dev:		Device structure filled by the device driver
504
 **/
505
int iio_device_register(struct iio_dev *indio_dev);
506 507 508

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

/**
 * iio_push_event() - try to add event to the list for userspace reading
515
 * @indio_dev:		IIO device structure
516
 * @ev_code:		What event
R
Randy Dunlap 已提交
517
 * @timestamp:		When the event occurred
518
 **/
519
int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
520

521
extern struct bus_type iio_bus_type;
522 523

/**
524
 * iio_device_put() - reference counted deallocation of struct device
P
Peter Meerwald 已提交
525
 * @indio_dev: 		IIO device structure containing the device
526
 **/
527
static inline void iio_device_put(struct iio_dev *indio_dev)
528
{
529 530
	if (indio_dev)
		put_device(&indio_dev->dev);
531
}
532

533 534
/**
 * dev_to_iio_dev() - Get IIO device struct from a device struct
P
Peter Meerwald 已提交
535
 * @dev: 		The device embedded in the IIO device
536 537 538 539 540 541 542 543
 *
 * 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 已提交
544 545
/**
 * iio_device_get() - increment reference count for the device
P
Peter Meerwald 已提交
546
 * @indio_dev: 		IIO device structure
L
Lars-Peter Clausen 已提交
547 548 549 550 551 552 553 554
 *
 * 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;
}

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579

/**
 * 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);
}

580 581
/* Can we make this smaller? */
#define IIO_ALIGN L1_CACHE_BYTES
582
/**
583
 * iio_device_alloc() - allocate an iio_dev from a driver
P
Peter Meerwald 已提交
584
 * @sizeof_priv: 	Space to allocate for private structure.
585
 **/
586
struct iio_dev *iio_device_alloc(int sizeof_priv);
587

588
static inline void *iio_priv(const struct iio_dev *indio_dev)
589
{
590
	return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
591 592 593 594 595 596 597
}

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

/**
600
 * iio_device_free() - free an iio_dev from a driver
P
Peter Meerwald 已提交
601
 * @indio_dev: 		the iio_dev associated with the device
602
 **/
603
void iio_device_free(struct iio_dev *indio_dev);
604

605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
/**
 * devm_iio_device_alloc - Resource-managed iio_device_alloc()
 * @dev: 		Device to allocate iio_dev for
 * @sizeof_priv: 	Space to allocate for private structure.
 *
 * Managed iio_device_alloc.  iio_dev allocated with this function is
 * automatically freed on driver detach.
 *
 * If an iio_dev allocated with this function needs to be freed separately,
 * devm_iio_device_free() must be used.
 *
 * RETURNS:
 * Pointer to allocated iio_dev on success, NULL on failure.
 */
struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv);

/**
 * devm_iio_device_free - Resource-managed iio_device_free()
 * @dev:		Device this iio_dev belongs to
 * @indio_dev: 		the iio_dev associated with the device
 *
626
 * Free iio_dev allocated with devm_iio_device_alloc().
627
 */
628
void devm_iio_device_free(struct device *dev, struct iio_dev *indio_dev);
629

630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
/**
 * devm_iio_trigger_alloc - Resource-managed iio_trigger_alloc()
 * @dev:		Device to allocate iio_trigger for
 * @fmt:		trigger name format. If it includes format
 *			specifiers, the additional arguments following
 *			format are formatted and inserted in the resulting
 *			string replacing their respective specifiers.
 *
 * Managed iio_trigger_alloc.  iio_trigger allocated with this function is
 * automatically freed on driver detach.
 *
 * If an iio_trigger allocated with this function needs to be freed separately,
 * devm_iio_trigger_free() must be used.
 *
 * RETURNS:
 * Pointer to allocated iio_trigger on success, NULL on failure.
 */
struct iio_trigger *devm_iio_trigger_alloc(struct device *dev,
						const char *fmt, ...);

/**
 * devm_iio_trigger_free - Resource-managed iio_trigger_free()
 * @dev:		Device this iio_dev belongs to
 * @iio_trig:		the iio_trigger associated with the device
 *
 * Free iio_trigger allocated with devm_iio_trigger_alloc().
 */
void devm_iio_trigger_free(struct device *dev, struct iio_trigger *iio_trig);

659
/**
660
 * iio_buffer_enabled() - helper function to test if the buffer is enabled
P
Peter Meerwald 已提交
661
 * @indio_dev:		IIO device structure for device
662
 **/
663
static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
664
{
665
	return indio_dev->currentmode
666
		& (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE);
667
}
668

669 670
/**
 * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
P
Peter Meerwald 已提交
671
 * @indio_dev:		IIO device structure for device
672 673 674 675 676
 **/
#if defined(CONFIG_DEBUG_FS)
static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
{
	return indio_dev->debugfs_dentry;
677
}
678 679 680 681
#else
static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
{
	return NULL;
682
}
683 684
#endif

685 686 687
int iio_str_to_fixpoint(const char *str, int fract_mult, int *integer,
	int *fract);

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
/**
 * IIO_DEGREE_TO_RAD() - Convert degree to rad
 * @deg: A value in degree
 *
 * Returns the given value converted from degree to rad
 */
#define IIO_DEGREE_TO_RAD(deg) (((deg) * 314159ULL + 9000000ULL) / 18000000ULL)

/**
 * IIO_G_TO_M_S_2() - Convert g to meter / second**2
 * @g: A value in g
 *
 * Returns the given value converted from g to meter / second**2
 */
#define IIO_G_TO_M_S_2(g) ((g) * 980665ULL / 100000ULL)

704
#endif /* _INDUSTRIAL_IO_H_ */