iio.h 22.5 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
#include <linux/of.h>
17
/* IIO TODO LIST */
J
Jonathan Cameron 已提交
18
/*
19 20 21 22
 * Provide means of adjusting timer accuracy.
 * Currently assumes nano seconds.
 */

23
enum iio_chan_info_enum {
24 25 26
	IIO_CHAN_INFO_RAW = 0,
	IIO_CHAN_INFO_PROCESSED,
	IIO_CHAN_INFO_SCALE,
27 28 29 30 31 32 33
	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,
34
	IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY,
35
	IIO_CHAN_INFO_HIGH_PASS_FILTER_3DB_FREQUENCY,
36
	IIO_CHAN_INFO_SAMP_FREQ,
37 38
	IIO_CHAN_INFO_FREQUENCY,
	IIO_CHAN_INFO_PHASE,
39
	IIO_CHAN_INFO_HARDWAREGAIN,
40
	IIO_CHAN_INFO_HYSTERESIS,
41
	IIO_CHAN_INFO_INT_TIME,
42
	IIO_CHAN_INFO_ENABLE,
43
	IIO_CHAN_INFO_CALIBHEIGHT,
44
	IIO_CHAN_INFO_CALIBWEIGHT,
45 46
	IIO_CHAN_INFO_DEBOUNCE_COUNT,
	IIO_CHAN_INFO_DEBOUNCE_TIME,
47
	IIO_CHAN_INFO_CALIBEMISSIVITY,
48
	IIO_CHAN_INFO_OVERSAMPLING_RATIO,
49 50
};

51 52
enum iio_shared_by {
	IIO_SEPARATE,
53 54 55
	IIO_SHARED_BY_TYPE,
	IIO_SHARED_BY_DIR,
	IIO_SHARED_BY_ALL
56 57
};

58 59 60 61 62 63
enum iio_endian {
	IIO_CPU,
	IIO_BE,
	IIO_LE,
};

64 65 66 67 68 69 70 71 72
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.
73
 * @private:	Data private to the driver.
74 75 76
 */
struct iio_chan_spec_ext_info {
	const char *name;
77
	enum iio_shared_by shared;
78 79 80 81 82 83
	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;
84 85
};

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

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
/**
 * 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;
};

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

255 256 257 258 259 260 261 262 263 264 265 266

/**
 * 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)
{
267
	return (chan->info_mask_separate & BIT(type)) |
268 269 270
		(chan->info_mask_shared_by_type & BIT(type)) |
		(chan->info_mask_shared_by_dir & BIT(type)) |
		(chan->info_mask_shared_by_all & BIT(type));
271 272
}

J
Jonathan Cameron 已提交
273 274 275 276 277 278 279 280 281 282
#define IIO_CHAN_SOFT_TIMESTAMP(_si) {					\
	.type = IIO_TIMESTAMP,						\
	.channel = -1,							\
	.scan_index = _si,						\
	.scan_type = {							\
		.sign = 's',						\
		.realbits = 64,					\
		.storagebits = 64,					\
		},							\
}
283

284 285 286 287 288
/**
 * iio_get_time_ns() - utility function to get a time stamp for events etc
 **/
static inline s64 iio_get_time_ns(void)
{
T
Thomas Gleixner 已提交
289
	return ktime_get_real_ns();
290 291 292 293
}

/* Device operating modes */
#define INDIO_DIRECT_MODE		0x01
294
#define INDIO_BUFFER_TRIGGERED		0x02
295
#define INDIO_BUFFER_SOFTWARE		0x04
296
#define INDIO_BUFFER_HARDWARE		0x08
V
Vladimir Barinov 已提交
297
#define INDIO_EVENT_TRIGGERED		0x10
298

299
#define INDIO_ALL_BUFFER_MODES					\
300
	(INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE | INDIO_BUFFER_SOFTWARE)
301

302 303
#define INDIO_MAX_RAW_ELEMENTS		4

304
struct iio_trigger; /* forward declaration */
305
struct iio_dev;
306

307 308 309 310 311 312 313 314 315 316 317
/**
 * 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.
318 319 320 321 322 323 324 325
 * @read_raw_multi:	function to return values 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. vals pointer
 *			contain the elements making up the returned value.
 *			max_len specifies maximum number of elements
 *			vals pointer can contain. val_len is used to return
 *			length of valid elements in vals.
326 327
 * @write_raw:		function to write a value to the device.
 *			Parameters are the same as for read_raw.
328 329 330
 * @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.
331 332
 * @read_event_config:	find out if the event is enabled.
 * @write_event_config:	set if the event is enabled.
333 334
 * @read_event_value:	read a configuration value associated with the event.
 * @write_event_value:	write a configuration value for the event.
335 336
 * @validate_trigger:	function to validate the trigger when the
 *			current trigger gets changed.
P
Peter Meerwald 已提交
337 338 339
 * @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
340 341 342 343 344
 * @of_xlate:		function pointer to obtain channel specifier index.
 *			When #iio-cells is greater than '0', the driver could
 *			provide a custom of_xlate function that reads the
 *			*args* and returns the appropriate index in registered
 *			IIO channels array.
345 346 347 348 349 350 351 352 353 354
 * @hwfifo_set_watermark: function pointer to set the current hardware
 *			fifo watermark level; see hwfifo_* entries in
 *			Documentation/ABI/testing/sysfs-bus-iio for details on
 *			how the hardware fifo operates
 * @hwfifo_flush_to_buffer: function pointer to flush the samples stored
 *			in the hardware fifo to the device buffer. The driver
 *			should not flush more than count samples. The function
 *			must return the number of samples flushed, 0 if no
 *			samples were flushed or a negative integer if no samples
 *			were flushed and there was an error.
355 356 357 358 359 360 361 362 363 364 365 366
 **/
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);

367 368 369 370 371 372 373
	int (*read_raw_multi)(struct iio_dev *indio_dev,
			struct iio_chan_spec const *chan,
			int max_len,
			int *vals,
			int *val_len,
			long mask);

374 375 376 377 378 379
	int (*write_raw)(struct iio_dev *indio_dev,
			 struct iio_chan_spec const *chan,
			 int val,
			 int val2,
			 long mask);

380 381 382 383
	int (*write_raw_get_fmt)(struct iio_dev *indio_dev,
			 struct iio_chan_spec const *chan,
			 long mask);

384
	int (*read_event_config)(struct iio_dev *indio_dev,
385 386 387 388
				 const struct iio_chan_spec *chan,
				 enum iio_event_type type,
				 enum iio_event_direction dir);

389
	int (*write_event_config)(struct iio_dev *indio_dev,
390 391 392 393 394
				  const struct iio_chan_spec *chan,
				  enum iio_event_type type,
				  enum iio_event_direction dir,
				  int state);

395
	int (*read_event_value)(struct iio_dev *indio_dev,
396 397 398 399 400
				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);

401
	int (*write_event_value)(struct iio_dev *indio_dev,
402 403 404 405 406
				 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);

407 408
	int (*validate_trigger)(struct iio_dev *indio_dev,
				struct iio_trigger *trig);
409 410
	int (*update_scan_mode)(struct iio_dev *indio_dev,
				const unsigned long *scan_mask);
411 412 413
	int (*debugfs_reg_access)(struct iio_dev *indio_dev,
				  unsigned reg, unsigned writeval,
				  unsigned *readval);
414 415
	int (*of_xlate)(struct iio_dev *indio_dev,
			const struct of_phandle_args *iiospec);
416 417 418
	int (*hwfifo_set_watermark)(struct iio_dev *indio_dev, unsigned val);
	int (*hwfifo_flush_to_buffer)(struct iio_dev *indio_dev,
				      unsigned count);
419 420
};

421 422 423 424 425 426 427
/**
 * 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
428 429
 * @validate_scan_mask: [DRIVER] function callback to check whether a given
 *			scan mask is valid for the device.
430 431
 */
struct iio_buffer_setup_ops {
432 433 434 435
	int (*preenable)(struct iio_dev *);
	int (*postenable)(struct iio_dev *);
	int (*predisable)(struct iio_dev *);
	int (*postdisable)(struct iio_dev *);
436 437
	bool (*validate_scan_mask)(struct iio_dev *indio_dev,
				   const unsigned long *scan_mask);
438 439
};

440 441 442 443 444 445 446
/**
 * 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
447
 * @event_interface:	[INTERN] event chrdevs associated with interrupt lines
448
 * @buffer:		[DRIVER] any buffer present
449
 * @buffer_list:	[INTERN] list of all buffers currently attached
450
 * @scan_bytes:		[INTERN] num bytes captured to be fed to buffer demux
451 452
 * @mlock:		[INTERN] lock used to prevent simultaneous device state
 *			changes
453
 * @available_scan_masks: [DRIVER] optional array of allowed bitmasks
454 455
 * @masklength:		[INTERN] the length of the mask established from
 *			channels
456
 * @active_scan_mask:	[INTERN] union of all scan masks requested by buffers
457
 * @scan_timestamp:	[INTERN] set if any buffers have requested timestamp
458
 * @scan_index_timestamp:[INTERN] cache of the index to the timestamp
459
 * @trig:		[INTERN] current device trigger (buffer modes)
L
Lucas De Marchi 已提交
460
 * @pollfunc:		[DRIVER] function run on trigger being received
V
Vladimir Barinov 已提交
461
 * @pollfunc_event:	[DRIVER] function run on events trigger being received
462
 * @channels:		[DRIVER] channel specification structure table
P
Peter Meerwald 已提交
463
 * @num_channels:	[DRIVER] number of channels specified in @channels.
464
 * @channel_attr_list:	[INTERN] keep track of automatically created channel
465
 *			attributes
466
 * @chan_attr_group:	[INTERN] group for all attrs in base directory
467
 * @name:		[DRIVER] name of the device.
468
 * @info:		[DRIVER] callbacks and constant info from driver
469
 * @info_exist_lock:	[INTERN] lock to prevent use during removal
470 471
 * @setup_ops:		[DRIVER] callbacks to call before and after buffer
 *			enable/disable
472
 * @chrdev:		[INTERN] associated character device
473 474
 * @groups:		[INTERN] attribute groups
 * @groupcounter:	[INTERN] index of next attribute group
475
 * @flags:		[INTERN] file ops related flags including busy flag.
476 477 478
 * @debugfs_dentry:	[INTERN] device specific debugfs dentry.
 * @cached_reg_addr:	[INTERN] cached register address for debugfs reads.
 */
479 480
struct iio_dev {
	int				id;
481

482 483 484 485
	int				modes;
	int				currentmode;
	struct device			dev;

486
	struct iio_event_interface	*event_interface;
487

488
	struct iio_buffer		*buffer;
489
	struct list_head		buffer_list;
490
	int				scan_bytes;
491 492
	struct mutex			mlock;

493
	const unsigned long		*available_scan_masks;
494
	unsigned			masklength;
495
	const unsigned long		*active_scan_mask;
496
	bool				scan_timestamp;
497
	unsigned			scan_index_timestamp;
498 499
	struct iio_trigger		*trig;
	struct iio_poll_func		*pollfunc;
V
Vladimir Barinov 已提交
500
	struct iio_poll_func		*pollfunc_event;
501

502 503
	struct iio_chan_spec const	*channels;
	int				num_channels;
504

505
	struct list_head		channel_attr_list;
506
	struct attribute_group		chan_attr_group;
507 508
	const char			*name;
	const struct iio_info		*info;
509
	struct mutex			info_exist_lock;
510
	const struct iio_buffer_setup_ops	*setup_ops;
511
	struct cdev			chrdev;
512 513 514
#define IIO_MAX_GROUPS 6
	const struct attribute_group	*groups[IIO_MAX_GROUPS + 1];
	int				groupcounter;
515 516

	unsigned long			flags;
517 518 519 520
#if defined(CONFIG_DEBUG_FS)
	struct dentry			*debugfs_dentry;
	unsigned			cached_reg_addr;
#endif
521 522
};

523 524
const struct iio_chan_spec
*iio_find_channel_from_si(struct iio_dev *indio_dev, int si);
525 526
int iio_device_register(struct iio_dev *indio_dev);
void iio_device_unregister(struct iio_dev *indio_dev);
527 528
int devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev);
void devm_iio_device_unregister(struct device *dev, struct iio_dev *indio_dev);
529
int iio_push_event(struct iio_dev *indio_dev, u64 ev_code, s64 timestamp);
530

531
extern struct bus_type iio_bus_type;
532 533

/**
534
 * iio_device_put() - reference counted deallocation of struct device
P
Peter Meerwald 已提交
535
 * @indio_dev: 		IIO device structure containing the device
536
 **/
537
static inline void iio_device_put(struct iio_dev *indio_dev)
538
{
539 540
	if (indio_dev)
		put_device(&indio_dev->dev);
541
}
542

543 544
/**
 * dev_to_iio_dev() - Get IIO device struct from a device struct
P
Peter Meerwald 已提交
545
 * @dev: 		The device embedded in the IIO device
546 547 548 549 550 551 552 553
 *
 * 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 已提交
554 555
/**
 * iio_device_get() - increment reference count for the device
P
Peter Meerwald 已提交
556
 * @indio_dev: 		IIO device structure
L
Lars-Peter Clausen 已提交
557 558 559 560 561 562 563 564
 *
 * 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;
}

565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589

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

590 591
/* Can we make this smaller? */
#define IIO_ALIGN L1_CACHE_BYTES
592
struct iio_dev *iio_device_alloc(int sizeof_priv);
593

594
static inline void *iio_priv(const struct iio_dev *indio_dev)
595
{
596
	return (char *)indio_dev + ALIGN(sizeof(struct iio_dev), IIO_ALIGN);
597 598 599 600 601 602 603
}

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

605
void iio_device_free(struct iio_dev *indio_dev);
606
struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv);
607
void devm_iio_device_free(struct device *dev, struct iio_dev *indio_dev);
608 609 610 611
struct iio_trigger *devm_iio_trigger_alloc(struct device *dev,
						const char *fmt, ...);
void devm_iio_trigger_free(struct device *dev, struct iio_trigger *iio_trig);

612
/**
613
 * iio_buffer_enabled() - helper function to test if the buffer is enabled
P
Peter Meerwald 已提交
614
 * @indio_dev:		IIO device structure for device
615
 **/
616
static inline bool iio_buffer_enabled(struct iio_dev *indio_dev)
617
{
618
	return indio_dev->currentmode
619 620
		& (INDIO_BUFFER_TRIGGERED | INDIO_BUFFER_HARDWARE |
		   INDIO_BUFFER_SOFTWARE);
621
}
622

623 624
/**
 * iio_get_debugfs_dentry() - helper function to get the debugfs_dentry
P
Peter Meerwald 已提交
625
 * @indio_dev:		IIO device structure for device
626 627 628 629 630
 **/
#if defined(CONFIG_DEBUG_FS)
static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
{
	return indio_dev->debugfs_dentry;
631
}
632 633 634 635
#else
static inline struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
{
	return NULL;
636
}
637 638
#endif

639 640
ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals);

641 642 643
int iio_str_to_fixpoint(const char *str, int fract_mult, int *integer,
	int *fract);

644 645 646 647 648 649 650 651
/**
 * 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)

652 653 654 655 656 657 658 659 660
/**
 * IIO_RAD_TO_DEGREE() - Convert rad to degree
 * @rad: A value in rad
 *
 * Returns the given value converted from rad to degree
 */
#define IIO_RAD_TO_DEGREE(rad) \
	(((rad) * 18000000ULL + 314159ULL / 2) / 314159ULL)

661 662 663 664 665 666 667 668
/**
 * 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)

669 670 671 672 673 674 675 676
/**
 * IIO_M_S_2_TO_G() - Convert meter / second**2 to g
 * @ms2: A value in meter / second**2
 *
 * Returns the given value converted from meter / second**2 to g
 */
#define IIO_M_S_2_TO_G(ms2) (((ms2) * 100000ULL + 980665ULL / 2) / 980665ULL)

677
#endif /* _INDUSTRIAL_IO_H_ */