1 // SPDX-License-Identifier: GPL-2.0-only
3 * The industrial I/O core
5 * Copyright (c) 2008 Jonathan Cameron
7 * Based on elements of hwmon and input subsystems.
10 #define pr_fmt(fmt) "iio-core: " fmt
12 #include <linux/anon_inodes.h>
13 #include <linux/cdev.h>
14 #include <linux/debugfs.h>
15 #include <linux/device.h>
16 #include <linux/err.h>
18 #include <linux/idr.h>
19 #include <linux/kdev_t.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/mutex.h>
23 #include <linux/poll.h>
24 #include <linux/property.h>
25 #include <linux/sched.h>
26 #include <linux/slab.h>
27 #include <linux/wait.h>
29 #include <linux/iio/buffer.h>
30 #include <linux/iio/buffer_impl.h>
31 #include <linux/iio/events.h>
32 #include <linux/iio/iio-opaque.h>
33 #include <linux/iio/iio.h>
34 #include <linux/iio/sysfs.h>
37 #include "iio_core_trigger.h"
39 /* IDA to assign each registered device a unique id */
40 static DEFINE_IDA(iio_ida);
42 static dev_t iio_devt;
44 #define IIO_DEV_MAX 256
45 const struct bus_type iio_bus_type = {
48 EXPORT_SYMBOL(iio_bus_type);
50 static struct dentry *iio_debugfs_dentry;
52 static const char * const iio_direction[] = {
57 static const char * const iio_chan_type_name_spec[] = {
58 [IIO_VOLTAGE] = "voltage",
59 [IIO_CURRENT] = "current",
60 [IIO_POWER] = "power",
61 [IIO_ACCEL] = "accel",
62 [IIO_ANGL_VEL] = "anglvel",
64 [IIO_LIGHT] = "illuminance",
65 [IIO_INTENSITY] = "intensity",
66 [IIO_PROXIMITY] = "proximity",
68 [IIO_INCLI] = "incli",
71 [IIO_TIMESTAMP] = "timestamp",
72 [IIO_CAPACITANCE] = "capacitance",
73 [IIO_ALTVOLTAGE] = "altvoltage",
75 [IIO_PRESSURE] = "pressure",
76 [IIO_HUMIDITYRELATIVE] = "humidityrelative",
77 [IIO_ACTIVITY] = "activity",
78 [IIO_STEPS] = "steps",
79 [IIO_ENERGY] = "energy",
80 [IIO_DISTANCE] = "distance",
81 [IIO_VELOCITY] = "velocity",
82 [IIO_CONCENTRATION] = "concentration",
83 [IIO_RESISTANCE] = "resistance",
85 [IIO_UVINDEX] = "uvindex",
86 [IIO_ELECTRICALCONDUCTIVITY] = "electricalconductivity",
87 [IIO_COUNT] = "count",
88 [IIO_INDEX] = "index",
89 [IIO_GRAVITY] = "gravity",
90 [IIO_POSITIONRELATIVE] = "positionrelative",
91 [IIO_PHASE] = "phase",
92 [IIO_MASSCONCENTRATION] = "massconcentration",
93 [IIO_DELTA_ANGL] = "deltaangl",
94 [IIO_DELTA_VELOCITY] = "deltavelocity",
95 [IIO_COLORTEMP] = "colortemp",
96 [IIO_CHROMATICITY] = "chromaticity",
99 static const char * const iio_modifier_names[] = {
103 [IIO_MOD_X_AND_Y] = "x&y",
104 [IIO_MOD_X_AND_Z] = "x&z",
105 [IIO_MOD_Y_AND_Z] = "y&z",
106 [IIO_MOD_X_AND_Y_AND_Z] = "x&y&z",
107 [IIO_MOD_X_OR_Y] = "x|y",
108 [IIO_MOD_X_OR_Z] = "x|z",
109 [IIO_MOD_Y_OR_Z] = "y|z",
110 [IIO_MOD_X_OR_Y_OR_Z] = "x|y|z",
111 [IIO_MOD_ROOT_SUM_SQUARED_X_Y] = "sqrt(x^2+y^2)",
112 [IIO_MOD_SUM_SQUARED_X_Y_Z] = "x^2+y^2+z^2",
113 [IIO_MOD_LIGHT_BOTH] = "both",
114 [IIO_MOD_LIGHT_IR] = "ir",
115 [IIO_MOD_LIGHT_CLEAR] = "clear",
116 [IIO_MOD_LIGHT_RED] = "red",
117 [IIO_MOD_LIGHT_GREEN] = "green",
118 [IIO_MOD_LIGHT_BLUE] = "blue",
119 [IIO_MOD_LIGHT_UV] = "uv",
120 [IIO_MOD_LIGHT_UVA] = "uva",
121 [IIO_MOD_LIGHT_UVB] = "uvb",
122 [IIO_MOD_LIGHT_DUV] = "duv",
123 [IIO_MOD_QUATERNION] = "quaternion",
124 [IIO_MOD_TEMP_AMBIENT] = "ambient",
125 [IIO_MOD_TEMP_OBJECT] = "object",
126 [IIO_MOD_NORTH_MAGN] = "from_north_magnetic",
127 [IIO_MOD_NORTH_TRUE] = "from_north_true",
128 [IIO_MOD_NORTH_MAGN_TILT_COMP] = "from_north_magnetic_tilt_comp",
129 [IIO_MOD_NORTH_TRUE_TILT_COMP] = "from_north_true_tilt_comp",
130 [IIO_MOD_RUNNING] = "running",
131 [IIO_MOD_JOGGING] = "jogging",
132 [IIO_MOD_WALKING] = "walking",
133 [IIO_MOD_STILL] = "still",
134 [IIO_MOD_ROOT_SUM_SQUARED_X_Y_Z] = "sqrt(x^2+y^2+z^2)",
137 [IIO_MOD_CO2] = "co2",
138 [IIO_MOD_VOC] = "voc",
139 [IIO_MOD_PM1] = "pm1",
140 [IIO_MOD_PM2P5] = "pm2p5",
141 [IIO_MOD_PM4] = "pm4",
142 [IIO_MOD_PM10] = "pm10",
143 [IIO_MOD_ETHANOL] = "ethanol",
146 [IIO_MOD_LINEAR_X] = "linear_x",
147 [IIO_MOD_LINEAR_Y] = "linear_y",
148 [IIO_MOD_LINEAR_Z] = "linear_z",
149 [IIO_MOD_PITCH] = "pitch",
150 [IIO_MOD_YAW] = "yaw",
151 [IIO_MOD_ROLL] = "roll",
154 /* relies on pairs of these shared then separate */
155 static const char * const iio_chan_info_postfix[] = {
156 [IIO_CHAN_INFO_RAW] = "raw",
157 [IIO_CHAN_INFO_PROCESSED] = "input",
158 [IIO_CHAN_INFO_SCALE] = "scale",
159 [IIO_CHAN_INFO_OFFSET] = "offset",
160 [IIO_CHAN_INFO_CALIBSCALE] = "calibscale",
161 [IIO_CHAN_INFO_CALIBBIAS] = "calibbias",
162 [IIO_CHAN_INFO_PEAK] = "peak_raw",
163 [IIO_CHAN_INFO_PEAK_SCALE] = "peak_scale",
164 [IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW] = "quadrature_correction_raw",
165 [IIO_CHAN_INFO_AVERAGE_RAW] = "mean_raw",
166 [IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY]
167 = "filter_low_pass_3db_frequency",
168 [IIO_CHAN_INFO_HIGH_PASS_FILTER_3DB_FREQUENCY]
169 = "filter_high_pass_3db_frequency",
170 [IIO_CHAN_INFO_SAMP_FREQ] = "sampling_frequency",
171 [IIO_CHAN_INFO_FREQUENCY] = "frequency",
172 [IIO_CHAN_INFO_PHASE] = "phase",
173 [IIO_CHAN_INFO_HARDWAREGAIN] = "hardwaregain",
174 [IIO_CHAN_INFO_HYSTERESIS] = "hysteresis",
175 [IIO_CHAN_INFO_HYSTERESIS_RELATIVE] = "hysteresis_relative",
176 [IIO_CHAN_INFO_INT_TIME] = "integration_time",
177 [IIO_CHAN_INFO_ENABLE] = "en",
178 [IIO_CHAN_INFO_CALIBHEIGHT] = "calibheight",
179 [IIO_CHAN_INFO_CALIBWEIGHT] = "calibweight",
180 [IIO_CHAN_INFO_DEBOUNCE_COUNT] = "debounce_count",
181 [IIO_CHAN_INFO_DEBOUNCE_TIME] = "debounce_time",
182 [IIO_CHAN_INFO_CALIBEMISSIVITY] = "calibemissivity",
183 [IIO_CHAN_INFO_OVERSAMPLING_RATIO] = "oversampling_ratio",
184 [IIO_CHAN_INFO_THERMOCOUPLE_TYPE] = "thermocouple_type",
185 [IIO_CHAN_INFO_CALIBAMBIENT] = "calibambient",
186 [IIO_CHAN_INFO_ZEROPOINT] = "zeropoint",
187 [IIO_CHAN_INFO_TROUGH] = "trough_raw",
190 * iio_device_id() - query the unique ID for the device
191 * @indio_dev: Device structure whose ID is being queried
193 * The IIO device ID is a unique index used for example for the naming
194 * of the character device /dev/iio\:device[ID].
196 * Returns: Unique ID for the device.
198 int iio_device_id(struct iio_dev *indio_dev)
200 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
202 return iio_dev_opaque->id;
204 EXPORT_SYMBOL_GPL(iio_device_id);
207 * iio_buffer_enabled() - helper function to test if the buffer is enabled
208 * @indio_dev: IIO device structure for device
210 * Returns: True, if the buffer is enabled.
212 bool iio_buffer_enabled(struct iio_dev *indio_dev)
214 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
216 return iio_dev_opaque->currentmode & INDIO_ALL_BUFFER_MODES;
218 EXPORT_SYMBOL_GPL(iio_buffer_enabled);
220 #if defined(CONFIG_DEBUG_FS)
222 * There's also a CONFIG_DEBUG_FS guard in include/linux/iio/iio.h for
223 * iio_get_debugfs_dentry() to make it inline if CONFIG_DEBUG_FS is undefined
225 struct dentry *iio_get_debugfs_dentry(struct iio_dev *indio_dev)
227 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
229 return iio_dev_opaque->debugfs_dentry;
231 EXPORT_SYMBOL_GPL(iio_get_debugfs_dentry);
235 * iio_find_channel_from_si() - get channel from its scan index
237 * @si: scan index to match
240 * Constant pointer to iio_chan_spec, if scan index matches, NULL on failure.
242 const struct iio_chan_spec
243 *iio_find_channel_from_si(struct iio_dev *indio_dev, int si)
247 for (i = 0; i < indio_dev->num_channels; i++)
248 if (indio_dev->channels[i].scan_index == si)
249 return &indio_dev->channels[i];
253 /* This turns up an awful lot */
254 ssize_t iio_read_const_attr(struct device *dev,
255 struct device_attribute *attr,
258 return sysfs_emit(buf, "%s\n", to_iio_const_attr(attr)->string);
260 EXPORT_SYMBOL(iio_read_const_attr);
263 * iio_device_set_clock() - Set current timestamping clock for the device
264 * @indio_dev: IIO device structure containing the device
265 * @clock_id: timestamping clock POSIX identifier to set.
267 * Returns: 0 on success, or a negative error code.
269 int iio_device_set_clock(struct iio_dev *indio_dev, clockid_t clock_id)
272 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
273 const struct iio_event_interface *ev_int = iio_dev_opaque->event_interface;
275 ret = mutex_lock_interruptible(&iio_dev_opaque->mlock);
278 if ((ev_int && iio_event_enabled(ev_int)) ||
279 iio_buffer_enabled(indio_dev)) {
280 mutex_unlock(&iio_dev_opaque->mlock);
283 iio_dev_opaque->clock_id = clock_id;
284 mutex_unlock(&iio_dev_opaque->mlock);
288 EXPORT_SYMBOL(iio_device_set_clock);
291 * iio_device_get_clock() - Retrieve current timestamping clock for the device
292 * @indio_dev: IIO device structure containing the device
294 * Returns: Clock ID of the current timestamping clock for the device.
296 clockid_t iio_device_get_clock(const struct iio_dev *indio_dev)
298 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
300 return iio_dev_opaque->clock_id;
302 EXPORT_SYMBOL(iio_device_get_clock);
305 * iio_get_time_ns() - utility function to get a time stamp for events etc
308 * Returns: Timestamp of the event in nanoseconds.
310 s64 iio_get_time_ns(const struct iio_dev *indio_dev)
312 struct timespec64 tp;
314 switch (iio_device_get_clock(indio_dev)) {
316 return ktime_get_real_ns();
317 case CLOCK_MONOTONIC:
318 return ktime_get_ns();
319 case CLOCK_MONOTONIC_RAW:
320 return ktime_get_raw_ns();
321 case CLOCK_REALTIME_COARSE:
322 return ktime_to_ns(ktime_get_coarse_real());
323 case CLOCK_MONOTONIC_COARSE:
324 ktime_get_coarse_ts64(&tp);
325 return timespec64_to_ns(&tp);
327 return ktime_get_boottime_ns();
329 return ktime_get_clocktai_ns();
334 EXPORT_SYMBOL(iio_get_time_ns);
336 static int __init iio_init(void)
340 /* Register sysfs bus */
341 ret = bus_register(&iio_bus_type);
343 pr_err("could not register bus type\n");
347 ret = alloc_chrdev_region(&iio_devt, 0, IIO_DEV_MAX, "iio");
349 pr_err("failed to allocate char dev region\n");
350 goto error_unregister_bus_type;
353 iio_debugfs_dentry = debugfs_create_dir("iio", NULL);
357 error_unregister_bus_type:
358 bus_unregister(&iio_bus_type);
363 static void __exit iio_exit(void)
366 unregister_chrdev_region(iio_devt, IIO_DEV_MAX);
367 bus_unregister(&iio_bus_type);
368 debugfs_remove(iio_debugfs_dentry);
371 #if defined(CONFIG_DEBUG_FS)
372 static ssize_t iio_debugfs_read_reg(struct file *file, char __user *userbuf,
373 size_t count, loff_t *ppos)
375 struct iio_dev *indio_dev = file->private_data;
376 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
377 unsigned int val = 0;
381 return simple_read_from_buffer(userbuf, count, ppos,
382 iio_dev_opaque->read_buf,
383 iio_dev_opaque->read_buf_len);
385 ret = indio_dev->info->debugfs_reg_access(indio_dev,
386 iio_dev_opaque->cached_reg_addr,
389 dev_err(indio_dev->dev.parent, "%s: read failed\n", __func__);
393 iio_dev_opaque->read_buf_len = snprintf(iio_dev_opaque->read_buf,
394 sizeof(iio_dev_opaque->read_buf),
397 return simple_read_from_buffer(userbuf, count, ppos,
398 iio_dev_opaque->read_buf,
399 iio_dev_opaque->read_buf_len);
402 static ssize_t iio_debugfs_write_reg(struct file *file,
403 const char __user *userbuf, size_t count, loff_t *ppos)
405 struct iio_dev *indio_dev = file->private_data;
406 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
407 unsigned int reg, val;
411 count = min(count, sizeof(buf) - 1);
412 if (copy_from_user(buf, userbuf, count))
417 ret = sscanf(buf, "%i %i", ®, &val);
421 iio_dev_opaque->cached_reg_addr = reg;
424 iio_dev_opaque->cached_reg_addr = reg;
425 ret = indio_dev->info->debugfs_reg_access(indio_dev, reg,
428 dev_err(indio_dev->dev.parent, "%s: write failed\n",
440 static const struct file_operations iio_debugfs_reg_fops = {
442 .read = iio_debugfs_read_reg,
443 .write = iio_debugfs_write_reg,
446 static void iio_device_unregister_debugfs(struct iio_dev *indio_dev)
448 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
450 debugfs_remove_recursive(iio_dev_opaque->debugfs_dentry);
453 static void iio_device_register_debugfs(struct iio_dev *indio_dev)
455 struct iio_dev_opaque *iio_dev_opaque;
457 if (indio_dev->info->debugfs_reg_access == NULL)
460 if (!iio_debugfs_dentry)
463 iio_dev_opaque = to_iio_dev_opaque(indio_dev);
465 iio_dev_opaque->debugfs_dentry =
466 debugfs_create_dir(dev_name(&indio_dev->dev),
469 debugfs_create_file("direct_reg_access", 0644,
470 iio_dev_opaque->debugfs_dentry, indio_dev,
471 &iio_debugfs_reg_fops);
474 static void iio_device_register_debugfs(struct iio_dev *indio_dev)
478 static void iio_device_unregister_debugfs(struct iio_dev *indio_dev)
481 #endif /* CONFIG_DEBUG_FS */
483 static ssize_t iio_read_channel_ext_info(struct device *dev,
484 struct device_attribute *attr,
487 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
488 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
489 const struct iio_chan_spec_ext_info *ext_info;
491 ext_info = &this_attr->c->ext_info[this_attr->address];
493 return ext_info->read(indio_dev, ext_info->private, this_attr->c, buf);
496 static ssize_t iio_write_channel_ext_info(struct device *dev,
497 struct device_attribute *attr,
498 const char *buf, size_t len)
500 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
501 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
502 const struct iio_chan_spec_ext_info *ext_info;
504 ext_info = &this_attr->c->ext_info[this_attr->address];
506 return ext_info->write(indio_dev, ext_info->private,
507 this_attr->c, buf, len);
510 ssize_t iio_enum_available_read(struct iio_dev *indio_dev,
511 uintptr_t priv, const struct iio_chan_spec *chan, char *buf)
513 const struct iio_enum *e = (const struct iio_enum *)priv;
520 for (i = 0; i < e->num_items; ++i) {
523 len += sysfs_emit_at(buf, len, "%s ", e->items[i]);
526 /* replace last space with a newline */
531 EXPORT_SYMBOL_GPL(iio_enum_available_read);
533 ssize_t iio_enum_read(struct iio_dev *indio_dev,
534 uintptr_t priv, const struct iio_chan_spec *chan, char *buf)
536 const struct iio_enum *e = (const struct iio_enum *)priv;
542 i = e->get(indio_dev, chan);
545 if (i >= e->num_items || !e->items[i])
548 return sysfs_emit(buf, "%s\n", e->items[i]);
550 EXPORT_SYMBOL_GPL(iio_enum_read);
552 ssize_t iio_enum_write(struct iio_dev *indio_dev,
553 uintptr_t priv, const struct iio_chan_spec *chan, const char *buf,
556 const struct iio_enum *e = (const struct iio_enum *)priv;
562 ret = __sysfs_match_string(e->items, e->num_items, buf);
566 ret = e->set(indio_dev, chan, ret);
567 return ret ? ret : len;
569 EXPORT_SYMBOL_GPL(iio_enum_write);
571 static const struct iio_mount_matrix iio_mount_idmatrix = {
579 static int iio_setup_mount_idmatrix(const struct device *dev,
580 struct iio_mount_matrix *matrix)
582 *matrix = iio_mount_idmatrix;
583 dev_info(dev, "mounting matrix not found: using identity...\n");
587 ssize_t iio_show_mount_matrix(struct iio_dev *indio_dev, uintptr_t priv,
588 const struct iio_chan_spec *chan, char *buf)
590 const struct iio_mount_matrix *mtx;
592 mtx = ((iio_get_mount_matrix_t *)priv)(indio_dev, chan);
597 mtx = &iio_mount_idmatrix;
599 return sysfs_emit(buf, "%s, %s, %s; %s, %s, %s; %s, %s, %s\n",
600 mtx->rotation[0], mtx->rotation[1], mtx->rotation[2],
601 mtx->rotation[3], mtx->rotation[4], mtx->rotation[5],
602 mtx->rotation[6], mtx->rotation[7], mtx->rotation[8]);
604 EXPORT_SYMBOL_GPL(iio_show_mount_matrix);
607 * iio_read_mount_matrix() - retrieve iio device mounting matrix from
608 * device "mount-matrix" property
609 * @dev: device the mounting matrix property is assigned to
610 * @matrix: where to store retrieved matrix
612 * If device is assigned no mounting matrix property, a default 3x3 identity
613 * matrix will be filled in.
615 * Returns: 0 if success, or a negative error code on failure.
617 int iio_read_mount_matrix(struct device *dev, struct iio_mount_matrix *matrix)
619 size_t len = ARRAY_SIZE(iio_mount_idmatrix.rotation);
622 err = device_property_read_string_array(dev, "mount-matrix", matrix->rotation, len);
627 /* Invalid number of matrix entries. */
631 /* Invalid matrix declaration format. */
634 /* Matrix was not declared at all: fallback to identity. */
635 return iio_setup_mount_idmatrix(dev, matrix);
637 EXPORT_SYMBOL(iio_read_mount_matrix);
639 static ssize_t __iio_format_value(char *buf, size_t offset, unsigned int type,
640 int size, const int *vals)
644 bool scale_db = false;
648 return sysfs_emit_at(buf, offset, "%d", vals[0]);
649 case IIO_VAL_INT_PLUS_MICRO_DB:
652 case IIO_VAL_INT_PLUS_MICRO:
654 return sysfs_emit_at(buf, offset, "-%d.%06u%s",
655 abs(vals[0]), -vals[1],
656 scale_db ? " dB" : "");
658 return sysfs_emit_at(buf, offset, "%d.%06u%s", vals[0],
659 vals[1], scale_db ? " dB" : "");
660 case IIO_VAL_INT_PLUS_NANO:
662 return sysfs_emit_at(buf, offset, "-%d.%09u",
663 abs(vals[0]), -vals[1]);
665 return sysfs_emit_at(buf, offset, "%d.%09u", vals[0],
667 case IIO_VAL_FRACTIONAL:
668 tmp2 = div_s64((s64)vals[0] * 1000000000LL, vals[1]);
670 tmp0 = (int)div_s64_rem(tmp2, 1000000000, &tmp1);
671 if ((tmp2 < 0) && (tmp0 == 0))
672 return sysfs_emit_at(buf, offset, "-0.%09u", abs(tmp1));
674 return sysfs_emit_at(buf, offset, "%d.%09u", tmp0,
676 case IIO_VAL_FRACTIONAL_LOG2:
677 tmp2 = shift_right((s64)vals[0] * 1000000000LL, vals[1]);
678 tmp0 = (int)div_s64_rem(tmp2, 1000000000LL, &tmp1);
679 if (tmp0 == 0 && tmp2 < 0)
680 return sysfs_emit_at(buf, offset, "-0.%09u", abs(tmp1));
682 return sysfs_emit_at(buf, offset, "%d.%09u", tmp0,
684 case IIO_VAL_INT_MULTIPLE:
689 for (i = 0; i < size; ++i)
690 l += sysfs_emit_at(buf, offset + l, "%d ", vals[i]);
694 return sysfs_emit_at(buf, offset, "%c", (char)vals[0]);
696 tmp2 = (s64)((((u64)vals[1]) << 32) | (u32)vals[0]);
697 return sysfs_emit_at(buf, offset, "%lld", tmp2);
704 * iio_format_value() - Formats a IIO value into its string representation
705 * @buf: The buffer to which the formatted value gets written
706 * which is assumed to be big enough (i.e. PAGE_SIZE).
707 * @type: One of the IIO_VAL_* constants. This decides how the val
708 * and val2 parameters are formatted.
709 * @size: Number of IIO value entries contained in vals
710 * @vals: Pointer to the values, exact meaning depends on the
714 * 0 by default, a negative number on failure or the total number of characters
715 * written for a type that belongs to the IIO_VAL_* constant.
717 ssize_t iio_format_value(char *buf, unsigned int type, int size, int *vals)
721 len = __iio_format_value(buf, 0, type, size, vals);
722 if (len >= PAGE_SIZE - 1)
725 return len + sysfs_emit_at(buf, len, "\n");
727 EXPORT_SYMBOL_GPL(iio_format_value);
729 static ssize_t iio_read_channel_label(struct device *dev,
730 struct device_attribute *attr,
733 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
734 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
736 if (indio_dev->info->read_label)
737 return indio_dev->info->read_label(indio_dev, this_attr->c, buf);
739 if (this_attr->c->extend_name)
740 return sysfs_emit(buf, "%s\n", this_attr->c->extend_name);
745 static ssize_t iio_read_channel_info(struct device *dev,
746 struct device_attribute *attr,
749 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
750 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
751 int vals[INDIO_MAX_RAW_ELEMENTS];
755 if (indio_dev->info->read_raw_multi)
756 ret = indio_dev->info->read_raw_multi(indio_dev, this_attr->c,
757 INDIO_MAX_RAW_ELEMENTS,
761 ret = indio_dev->info->read_raw(indio_dev, this_attr->c,
762 &vals[0], &vals[1], this_attr->address);
767 return iio_format_value(buf, ret, val_len, vals);
770 static ssize_t iio_format_list(char *buf, const int *vals, int type, int length,
771 const char *prefix, const char *suffix)
786 len = sysfs_emit(buf, prefix);
788 for (i = 0; i <= length - stride; i += stride) {
790 len += sysfs_emit_at(buf, len, " ");
791 if (len >= PAGE_SIZE)
795 len += __iio_format_value(buf, len, type, stride, &vals[i]);
796 if (len >= PAGE_SIZE)
800 len += sysfs_emit_at(buf, len, "%s\n", suffix);
805 static ssize_t iio_format_avail_list(char *buf, const int *vals,
806 int type, int length)
809 return iio_format_list(buf, vals, type, length, "", "");
812 static ssize_t iio_format_avail_range(char *buf, const int *vals, int type)
817 * length refers to the array size , not the number of elements.
818 * The purpose is to print the range [min , step ,max] so length should
819 * be 3 in case of int, and 6 for other types.
830 return iio_format_list(buf, vals, type, length, "[", "]");
833 static ssize_t iio_read_channel_info_avail(struct device *dev,
834 struct device_attribute *attr,
837 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
838 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
844 ret = indio_dev->info->read_avail(indio_dev, this_attr->c,
845 &vals, &type, &length,
852 return iio_format_avail_list(buf, vals, type, length);
853 case IIO_AVAIL_RANGE:
854 return iio_format_avail_range(buf, vals, type);
861 * __iio_str_to_fixpoint() - Parse a fixed-point number from a string
862 * @str: The string to parse
863 * @fract_mult: Multiplier for the first decimal place, should be a power of 10
864 * @integer: The integer part of the number
865 * @fract: The fractional part of the number
866 * @scale_db: True if this should parse as dB
869 * 0 on success, or a negative error code if the string could not be parsed.
871 static int __iio_str_to_fixpoint(const char *str, int fract_mult,
872 int *integer, int *fract, bool scale_db)
875 bool integer_part = true, negative = false;
877 if (fract_mult == 0) {
880 return kstrtoint(str, 0, integer);
886 } else if (str[0] == '+') {
891 if ('0' <= *str && *str <= '9') {
893 i = i * 10 + *str - '0';
895 f += fract_mult * (*str - '0');
898 } else if (*str == '\n') {
899 if (*(str + 1) == '\0')
902 } else if (!strncmp(str, " dB", sizeof(" dB") - 1) && scale_db) {
903 /* Ignore the dB suffix */
904 str += sizeof(" dB") - 1;
906 } else if (!strncmp(str, "dB", sizeof("dB") - 1) && scale_db) {
907 /* Ignore the dB suffix */
908 str += sizeof("dB") - 1;
910 } else if (*str == '.' && integer_part) {
911 integer_part = false;
932 * iio_str_to_fixpoint() - Parse a fixed-point number from a string
933 * @str: The string to parse
934 * @fract_mult: Multiplier for the first decimal place, should be a power of 10
935 * @integer: The integer part of the number
936 * @fract: The fractional part of the number
939 * 0 on success, or a negative error code if the string could not be parsed.
941 int iio_str_to_fixpoint(const char *str, int fract_mult,
942 int *integer, int *fract)
944 return __iio_str_to_fixpoint(str, fract_mult, integer, fract, false);
946 EXPORT_SYMBOL_GPL(iio_str_to_fixpoint);
948 static ssize_t iio_write_channel_info(struct device *dev,
949 struct device_attribute *attr,
953 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
954 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
955 int ret, fract_mult = 100000;
956 int integer, fract = 0;
957 bool is_char = false;
958 bool scale_db = false;
960 /* Assumes decimal - precision based on number of digits */
961 if (!indio_dev->info->write_raw)
964 if (indio_dev->info->write_raw_get_fmt)
965 switch (indio_dev->info->write_raw_get_fmt(indio_dev,
966 this_attr->c, this_attr->address)) {
970 case IIO_VAL_INT_PLUS_MICRO_DB:
973 case IIO_VAL_INT_PLUS_MICRO:
976 case IIO_VAL_INT_PLUS_NANO:
977 fract_mult = 100000000;
989 if (sscanf(buf, "%c", &ch) != 1)
993 ret = __iio_str_to_fixpoint(buf, fract_mult, &integer, &fract,
999 ret = indio_dev->info->write_raw(indio_dev, this_attr->c,
1000 integer, fract, this_attr->address);
1008 int __iio_device_attr_init(struct device_attribute *dev_attr,
1009 const char *postfix,
1010 struct iio_chan_spec const *chan,
1011 ssize_t (*readfunc)(struct device *dev,
1012 struct device_attribute *attr,
1014 ssize_t (*writefunc)(struct device *dev,
1015 struct device_attribute *attr,
1018 enum iio_shared_by shared_by)
1024 sysfs_attr_init(&dev_attr->attr);
1026 /* Build up postfix of <extend_name>_<modifier>_postfix */
1027 if (chan->modified && (shared_by == IIO_SEPARATE)) {
1028 if (chan->extend_name)
1029 full_postfix = kasprintf(GFP_KERNEL, "%s_%s_%s",
1030 iio_modifier_names[chan->channel2],
1034 full_postfix = kasprintf(GFP_KERNEL, "%s_%s",
1035 iio_modifier_names[chan->channel2],
1038 if (chan->extend_name == NULL || shared_by != IIO_SEPARATE)
1039 full_postfix = kstrdup(postfix, GFP_KERNEL);
1041 full_postfix = kasprintf(GFP_KERNEL,
1046 if (full_postfix == NULL)
1049 if (chan->differential) { /* Differential can not have modifier */
1050 switch (shared_by) {
1051 case IIO_SHARED_BY_ALL:
1052 name = kasprintf(GFP_KERNEL, "%s", full_postfix);
1054 case IIO_SHARED_BY_DIR:
1055 name = kasprintf(GFP_KERNEL, "%s_%s",
1056 iio_direction[chan->output],
1059 case IIO_SHARED_BY_TYPE:
1060 name = kasprintf(GFP_KERNEL, "%s_%s-%s_%s",
1061 iio_direction[chan->output],
1062 iio_chan_type_name_spec[chan->type],
1063 iio_chan_type_name_spec[chan->type],
1067 if (!chan->indexed) {
1068 WARN(1, "Differential channels must be indexed\n");
1070 goto error_free_full_postfix;
1072 name = kasprintf(GFP_KERNEL,
1074 iio_direction[chan->output],
1075 iio_chan_type_name_spec[chan->type],
1077 iio_chan_type_name_spec[chan->type],
1082 } else { /* Single ended */
1083 switch (shared_by) {
1084 case IIO_SHARED_BY_ALL:
1085 name = kasprintf(GFP_KERNEL, "%s", full_postfix);
1087 case IIO_SHARED_BY_DIR:
1088 name = kasprintf(GFP_KERNEL, "%s_%s",
1089 iio_direction[chan->output],
1092 case IIO_SHARED_BY_TYPE:
1093 name = kasprintf(GFP_KERNEL, "%s_%s_%s",
1094 iio_direction[chan->output],
1095 iio_chan_type_name_spec[chan->type],
1101 name = kasprintf(GFP_KERNEL, "%s_%s%d_%s",
1102 iio_direction[chan->output],
1103 iio_chan_type_name_spec[chan->type],
1107 name = kasprintf(GFP_KERNEL, "%s_%s_%s",
1108 iio_direction[chan->output],
1109 iio_chan_type_name_spec[chan->type],
1116 goto error_free_full_postfix;
1118 dev_attr->attr.name = name;
1121 dev_attr->attr.mode |= 0444;
1122 dev_attr->show = readfunc;
1126 dev_attr->attr.mode |= 0200;
1127 dev_attr->store = writefunc;
1130 error_free_full_postfix:
1131 kfree(full_postfix);
1136 static void __iio_device_attr_deinit(struct device_attribute *dev_attr)
1138 kfree(dev_attr->attr.name);
1141 int __iio_add_chan_devattr(const char *postfix,
1142 struct iio_chan_spec const *chan,
1143 ssize_t (*readfunc)(struct device *dev,
1144 struct device_attribute *attr,
1146 ssize_t (*writefunc)(struct device *dev,
1147 struct device_attribute *attr,
1151 enum iio_shared_by shared_by,
1153 struct iio_buffer *buffer,
1154 struct list_head *attr_list)
1157 struct iio_dev_attr *iio_attr, *t;
1159 iio_attr = kzalloc(sizeof(*iio_attr), GFP_KERNEL);
1160 if (iio_attr == NULL)
1162 ret = __iio_device_attr_init(&iio_attr->dev_attr,
1164 readfunc, writefunc, shared_by);
1166 goto error_iio_dev_attr_free;
1168 iio_attr->address = mask;
1169 iio_attr->buffer = buffer;
1170 list_for_each_entry(t, attr_list, l)
1171 if (strcmp(t->dev_attr.attr.name,
1172 iio_attr->dev_attr.attr.name) == 0) {
1173 if (shared_by == IIO_SEPARATE)
1174 dev_err(dev, "tried to double register : %s\n",
1175 t->dev_attr.attr.name);
1177 goto error_device_attr_deinit;
1179 list_add(&iio_attr->l, attr_list);
1183 error_device_attr_deinit:
1184 __iio_device_attr_deinit(&iio_attr->dev_attr);
1185 error_iio_dev_attr_free:
1190 static int iio_device_add_channel_label(struct iio_dev *indio_dev,
1191 struct iio_chan_spec const *chan)
1193 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1196 if (!indio_dev->info->read_label && !chan->extend_name)
1199 ret = __iio_add_chan_devattr("label",
1201 &iio_read_channel_label,
1207 &iio_dev_opaque->channel_attr_list);
1214 static int iio_device_add_info_mask_type(struct iio_dev *indio_dev,
1215 struct iio_chan_spec const *chan,
1216 enum iio_shared_by shared_by,
1217 const long *infomask)
1219 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1220 int i, ret, attrcount = 0;
1222 for_each_set_bit(i, infomask, sizeof(*infomask)*8) {
1223 if (i >= ARRAY_SIZE(iio_chan_info_postfix))
1225 ret = __iio_add_chan_devattr(iio_chan_info_postfix[i],
1227 &iio_read_channel_info,
1228 &iio_write_channel_info,
1233 &iio_dev_opaque->channel_attr_list);
1234 if ((ret == -EBUSY) && (shared_by != IIO_SEPARATE))
1244 static int iio_device_add_info_mask_type_avail(struct iio_dev *indio_dev,
1245 struct iio_chan_spec const *chan,
1246 enum iio_shared_by shared_by,
1247 const long *infomask)
1249 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1250 int i, ret, attrcount = 0;
1251 char *avail_postfix;
1253 for_each_set_bit(i, infomask, sizeof(*infomask) * 8) {
1254 if (i >= ARRAY_SIZE(iio_chan_info_postfix))
1256 avail_postfix = kasprintf(GFP_KERNEL,
1258 iio_chan_info_postfix[i]);
1262 ret = __iio_add_chan_devattr(avail_postfix,
1264 &iio_read_channel_info_avail,
1270 &iio_dev_opaque->channel_attr_list);
1271 kfree(avail_postfix);
1272 if ((ret == -EBUSY) && (shared_by != IIO_SEPARATE))
1282 static int iio_device_add_channel_sysfs(struct iio_dev *indio_dev,
1283 struct iio_chan_spec const *chan)
1285 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1286 int ret, attrcount = 0;
1287 const struct iio_chan_spec_ext_info *ext_info;
1289 if (chan->channel < 0)
1291 ret = iio_device_add_info_mask_type(indio_dev, chan,
1293 &chan->info_mask_separate);
1298 ret = iio_device_add_info_mask_type_avail(indio_dev, chan,
1300 &chan->info_mask_separate_available);
1305 ret = iio_device_add_info_mask_type(indio_dev, chan,
1307 &chan->info_mask_shared_by_type);
1312 ret = iio_device_add_info_mask_type_avail(indio_dev, chan,
1314 &chan->info_mask_shared_by_type_available);
1319 ret = iio_device_add_info_mask_type(indio_dev, chan,
1321 &chan->info_mask_shared_by_dir);
1326 ret = iio_device_add_info_mask_type_avail(indio_dev, chan,
1328 &chan->info_mask_shared_by_dir_available);
1333 ret = iio_device_add_info_mask_type(indio_dev, chan,
1335 &chan->info_mask_shared_by_all);
1340 ret = iio_device_add_info_mask_type_avail(indio_dev, chan,
1342 &chan->info_mask_shared_by_all_available);
1347 ret = iio_device_add_channel_label(indio_dev, chan);
1352 if (chan->ext_info) {
1355 for (ext_info = chan->ext_info; ext_info->name; ext_info++) {
1356 ret = __iio_add_chan_devattr(ext_info->name,
1359 &iio_read_channel_ext_info : NULL,
1361 &iio_write_channel_ext_info : NULL,
1366 &iio_dev_opaque->channel_attr_list);
1368 if (ret == -EBUSY && ext_info->shared)
1382 * iio_free_chan_devattr_list() - Free a list of IIO device attributes
1383 * @attr_list: List of IIO device attributes
1385 * This function frees the memory allocated for each of the IIO device
1386 * attributes in the list.
1388 void iio_free_chan_devattr_list(struct list_head *attr_list)
1390 struct iio_dev_attr *p, *n;
1392 list_for_each_entry_safe(p, n, attr_list, l) {
1393 kfree_const(p->dev_attr.attr.name);
1399 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
1402 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
1404 return sysfs_emit(buf, "%s\n", indio_dev->name);
1407 static DEVICE_ATTR_RO(name);
1409 static ssize_t label_show(struct device *dev, struct device_attribute *attr,
1412 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
1414 return sysfs_emit(buf, "%s\n", indio_dev->label);
1417 static DEVICE_ATTR_RO(label);
1419 static const char * const clock_names[] = {
1420 [CLOCK_REALTIME] = "realtime",
1421 [CLOCK_MONOTONIC] = "monotonic",
1422 [CLOCK_PROCESS_CPUTIME_ID] = "process_cputime_id",
1423 [CLOCK_THREAD_CPUTIME_ID] = "thread_cputime_id",
1424 [CLOCK_MONOTONIC_RAW] = "monotonic_raw",
1425 [CLOCK_REALTIME_COARSE] = "realtime_coarse",
1426 [CLOCK_MONOTONIC_COARSE] = "monotonic_coarse",
1427 [CLOCK_BOOTTIME] = "boottime",
1428 [CLOCK_REALTIME_ALARM] = "realtime_alarm",
1429 [CLOCK_BOOTTIME_ALARM] = "boottime_alarm",
1430 [CLOCK_SGI_CYCLE] = "sgi_cycle",
1431 [CLOCK_TAI] = "tai",
1434 static ssize_t current_timestamp_clock_show(struct device *dev,
1435 struct device_attribute *attr,
1438 const struct iio_dev *indio_dev = dev_to_iio_dev(dev);
1439 const clockid_t clk = iio_device_get_clock(indio_dev);
1442 case CLOCK_REALTIME:
1443 case CLOCK_MONOTONIC:
1444 case CLOCK_MONOTONIC_RAW:
1445 case CLOCK_REALTIME_COARSE:
1446 case CLOCK_MONOTONIC_COARSE:
1447 case CLOCK_BOOTTIME:
1454 return sysfs_emit(buf, "%s\n", clock_names[clk]);
1457 static ssize_t current_timestamp_clock_store(struct device *dev,
1458 struct device_attribute *attr,
1459 const char *buf, size_t len)
1464 ret = sysfs_match_string(clock_names, buf);
1470 case CLOCK_REALTIME:
1471 case CLOCK_MONOTONIC:
1472 case CLOCK_MONOTONIC_RAW:
1473 case CLOCK_REALTIME_COARSE:
1474 case CLOCK_MONOTONIC_COARSE:
1475 case CLOCK_BOOTTIME:
1482 ret = iio_device_set_clock(dev_to_iio_dev(dev), clk);
1489 int iio_device_register_sysfs_group(struct iio_dev *indio_dev,
1490 const struct attribute_group *group)
1492 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1493 const struct attribute_group **new, **old = iio_dev_opaque->groups;
1494 unsigned int cnt = iio_dev_opaque->groupcounter;
1496 new = krealloc_array(old, cnt + 2, sizeof(*new), GFP_KERNEL);
1500 new[iio_dev_opaque->groupcounter++] = group;
1501 new[iio_dev_opaque->groupcounter] = NULL;
1503 iio_dev_opaque->groups = new;
1508 static DEVICE_ATTR_RW(current_timestamp_clock);
1510 static int iio_device_register_sysfs(struct iio_dev *indio_dev)
1512 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1513 int i, ret = 0, attrcount, attrn, attrcount_orig = 0;
1514 struct iio_dev_attr *p;
1515 struct attribute **attr, *clk = NULL;
1517 /* First count elements in any existing group */
1518 if (indio_dev->info->attrs) {
1519 attr = indio_dev->info->attrs->attrs;
1520 while (*attr++ != NULL)
1523 attrcount = attrcount_orig;
1525 * New channel registration method - relies on the fact a group does
1526 * not need to be initialized if its name is NULL.
1528 if (indio_dev->channels)
1529 for (i = 0; i < indio_dev->num_channels; i++) {
1530 const struct iio_chan_spec *chan =
1531 &indio_dev->channels[i];
1533 if (chan->type == IIO_TIMESTAMP)
1534 clk = &dev_attr_current_timestamp_clock.attr;
1536 ret = iio_device_add_channel_sysfs(indio_dev, chan);
1538 goto error_clear_attrs;
1542 if (iio_dev_opaque->event_interface)
1543 clk = &dev_attr_current_timestamp_clock.attr;
1545 if (indio_dev->name)
1547 if (indio_dev->label)
1552 iio_dev_opaque->chan_attr_group.attrs =
1553 kcalloc(attrcount + 1,
1554 sizeof(iio_dev_opaque->chan_attr_group.attrs[0]),
1556 if (iio_dev_opaque->chan_attr_group.attrs == NULL) {
1558 goto error_clear_attrs;
1560 /* Copy across original attributes, and point to original binary attributes */
1561 if (indio_dev->info->attrs) {
1562 memcpy(iio_dev_opaque->chan_attr_group.attrs,
1563 indio_dev->info->attrs->attrs,
1564 sizeof(iio_dev_opaque->chan_attr_group.attrs[0])
1566 iio_dev_opaque->chan_attr_group.is_visible =
1567 indio_dev->info->attrs->is_visible;
1568 iio_dev_opaque->chan_attr_group.bin_attrs =
1569 indio_dev->info->attrs->bin_attrs;
1571 attrn = attrcount_orig;
1572 /* Add all elements from the list. */
1573 list_for_each_entry(p, &iio_dev_opaque->channel_attr_list, l)
1574 iio_dev_opaque->chan_attr_group.attrs[attrn++] = &p->dev_attr.attr;
1575 if (indio_dev->name)
1576 iio_dev_opaque->chan_attr_group.attrs[attrn++] = &dev_attr_name.attr;
1577 if (indio_dev->label)
1578 iio_dev_opaque->chan_attr_group.attrs[attrn++] = &dev_attr_label.attr;
1580 iio_dev_opaque->chan_attr_group.attrs[attrn++] = clk;
1582 ret = iio_device_register_sysfs_group(indio_dev,
1583 &iio_dev_opaque->chan_attr_group);
1585 goto error_free_chan_attrs;
1589 error_free_chan_attrs:
1590 kfree(iio_dev_opaque->chan_attr_group.attrs);
1591 iio_dev_opaque->chan_attr_group.attrs = NULL;
1593 iio_free_chan_devattr_list(&iio_dev_opaque->channel_attr_list);
1598 static void iio_device_unregister_sysfs(struct iio_dev *indio_dev)
1600 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1602 iio_free_chan_devattr_list(&iio_dev_opaque->channel_attr_list);
1603 kfree(iio_dev_opaque->chan_attr_group.attrs);
1604 iio_dev_opaque->chan_attr_group.attrs = NULL;
1605 kfree(iio_dev_opaque->groups);
1606 iio_dev_opaque->groups = NULL;
1609 static void iio_dev_release(struct device *device)
1611 struct iio_dev *indio_dev = dev_to_iio_dev(device);
1612 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1614 if (indio_dev->modes & INDIO_ALL_TRIGGERED_MODES)
1615 iio_device_unregister_trigger_consumer(indio_dev);
1616 iio_device_unregister_eventset(indio_dev);
1617 iio_device_unregister_sysfs(indio_dev);
1619 iio_device_detach_buffers(indio_dev);
1621 lockdep_unregister_key(&iio_dev_opaque->mlock_key);
1623 ida_free(&iio_ida, iio_dev_opaque->id);
1624 kfree(iio_dev_opaque);
1627 const struct device_type iio_device_type = {
1628 .name = "iio_device",
1629 .release = iio_dev_release,
1633 * iio_device_alloc() - allocate an iio_dev from a driver
1634 * @parent: Parent device.
1635 * @sizeof_priv: Space to allocate for private structure.
1638 * Pointer to allocated iio_dev on success, NULL on failure.
1640 struct iio_dev *iio_device_alloc(struct device *parent, int sizeof_priv)
1642 struct iio_dev_opaque *iio_dev_opaque;
1643 struct iio_dev *indio_dev;
1646 alloc_size = sizeof(struct iio_dev_opaque);
1648 alloc_size = ALIGN(alloc_size, IIO_DMA_MINALIGN);
1649 alloc_size += sizeof_priv;
1652 iio_dev_opaque = kzalloc(alloc_size, GFP_KERNEL);
1653 if (!iio_dev_opaque)
1656 indio_dev = &iio_dev_opaque->indio_dev;
1657 indio_dev->priv = (char *)iio_dev_opaque +
1658 ALIGN(sizeof(struct iio_dev_opaque), IIO_DMA_MINALIGN);
1660 indio_dev->dev.parent = parent;
1661 indio_dev->dev.type = &iio_device_type;
1662 indio_dev->dev.bus = &iio_bus_type;
1663 device_initialize(&indio_dev->dev);
1664 mutex_init(&iio_dev_opaque->mlock);
1665 mutex_init(&iio_dev_opaque->info_exist_lock);
1666 INIT_LIST_HEAD(&iio_dev_opaque->channel_attr_list);
1668 iio_dev_opaque->id = ida_alloc(&iio_ida, GFP_KERNEL);
1669 if (iio_dev_opaque->id < 0) {
1670 /* cannot use a dev_err as the name isn't available */
1671 pr_err("failed to get device id\n");
1672 kfree(iio_dev_opaque);
1676 if (dev_set_name(&indio_dev->dev, "iio:device%d", iio_dev_opaque->id)) {
1677 ida_free(&iio_ida, iio_dev_opaque->id);
1678 kfree(iio_dev_opaque);
1682 INIT_LIST_HEAD(&iio_dev_opaque->buffer_list);
1683 INIT_LIST_HEAD(&iio_dev_opaque->ioctl_handlers);
1685 lockdep_register_key(&iio_dev_opaque->mlock_key);
1686 lockdep_set_class(&iio_dev_opaque->mlock, &iio_dev_opaque->mlock_key);
1690 EXPORT_SYMBOL(iio_device_alloc);
1693 * iio_device_free() - free an iio_dev from a driver
1694 * @dev: the iio_dev associated with the device
1696 void iio_device_free(struct iio_dev *dev)
1699 put_device(&dev->dev);
1701 EXPORT_SYMBOL(iio_device_free);
1703 static void devm_iio_device_release(void *iio_dev)
1705 iio_device_free(iio_dev);
1709 * devm_iio_device_alloc - Resource-managed iio_device_alloc()
1710 * @parent: Device to allocate iio_dev for, and parent for this IIO device
1711 * @sizeof_priv: Space to allocate for private structure.
1713 * Managed iio_device_alloc. iio_dev allocated with this function is
1714 * automatically freed on driver detach.
1717 * Pointer to allocated iio_dev on success, NULL on failure.
1719 struct iio_dev *devm_iio_device_alloc(struct device *parent, int sizeof_priv)
1721 struct iio_dev *iio_dev;
1724 iio_dev = iio_device_alloc(parent, sizeof_priv);
1728 ret = devm_add_action_or_reset(parent, devm_iio_device_release,
1735 EXPORT_SYMBOL_GPL(devm_iio_device_alloc);
1738 * iio_chrdev_open() - chrdev file open for buffer access and ioctls
1739 * @inode: Inode structure for identifying the device in the file system
1740 * @filp: File structure for iio device used to keep and later access
1743 * Returns: 0 on success or -EBUSY if the device is already opened
1745 static int iio_chrdev_open(struct inode *inode, struct file *filp)
1747 struct iio_dev_opaque *iio_dev_opaque =
1748 container_of(inode->i_cdev, struct iio_dev_opaque, chrdev);
1749 struct iio_dev *indio_dev = &iio_dev_opaque->indio_dev;
1750 struct iio_dev_buffer_pair *ib;
1752 if (test_and_set_bit(IIO_BUSY_BIT_POS, &iio_dev_opaque->flags))
1755 iio_device_get(indio_dev);
1757 ib = kmalloc(sizeof(*ib), GFP_KERNEL);
1759 iio_device_put(indio_dev);
1760 clear_bit(IIO_BUSY_BIT_POS, &iio_dev_opaque->flags);
1764 ib->indio_dev = indio_dev;
1765 ib->buffer = indio_dev->buffer;
1767 filp->private_data = ib;
1773 * iio_chrdev_release() - chrdev file close buffer access and ioctls
1774 * @inode: Inode structure pointer for the char device
1775 * @filp: File structure pointer for the char device
1777 * Returns: 0 for successful release.
1779 static int iio_chrdev_release(struct inode *inode, struct file *filp)
1781 struct iio_dev_buffer_pair *ib = filp->private_data;
1782 struct iio_dev_opaque *iio_dev_opaque =
1783 container_of(inode->i_cdev, struct iio_dev_opaque, chrdev);
1784 struct iio_dev *indio_dev = &iio_dev_opaque->indio_dev;
1787 clear_bit(IIO_BUSY_BIT_POS, &iio_dev_opaque->flags);
1788 iio_device_put(indio_dev);
1793 void iio_device_ioctl_handler_register(struct iio_dev *indio_dev,
1794 struct iio_ioctl_handler *h)
1796 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1798 list_add_tail(&h->entry, &iio_dev_opaque->ioctl_handlers);
1801 void iio_device_ioctl_handler_unregister(struct iio_ioctl_handler *h)
1803 list_del(&h->entry);
1806 static long iio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1808 struct iio_dev_buffer_pair *ib = filp->private_data;
1809 struct iio_dev *indio_dev = ib->indio_dev;
1810 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1811 struct iio_ioctl_handler *h;
1814 mutex_lock(&iio_dev_opaque->info_exist_lock);
1817 * The NULL check here is required to prevent crashing when a device
1818 * is being removed while userspace would still have open file handles
1819 * to try to access this device.
1821 if (!indio_dev->info)
1824 list_for_each_entry(h, &iio_dev_opaque->ioctl_handlers, entry) {
1825 ret = h->ioctl(indio_dev, filp, cmd, arg);
1826 if (ret != IIO_IOCTL_UNHANDLED)
1830 if (ret == IIO_IOCTL_UNHANDLED)
1834 mutex_unlock(&iio_dev_opaque->info_exist_lock);
1839 static const struct file_operations iio_buffer_fileops = {
1840 .owner = THIS_MODULE,
1841 .llseek = noop_llseek,
1842 .read = iio_buffer_read_outer_addr,
1843 .write = iio_buffer_write_outer_addr,
1844 .poll = iio_buffer_poll_addr,
1845 .unlocked_ioctl = iio_ioctl,
1846 .compat_ioctl = compat_ptr_ioctl,
1847 .open = iio_chrdev_open,
1848 .release = iio_chrdev_release,
1851 static const struct file_operations iio_event_fileops = {
1852 .owner = THIS_MODULE,
1853 .llseek = noop_llseek,
1854 .unlocked_ioctl = iio_ioctl,
1855 .compat_ioctl = compat_ptr_ioctl,
1856 .open = iio_chrdev_open,
1857 .release = iio_chrdev_release,
1860 static int iio_check_unique_scan_index(struct iio_dev *indio_dev)
1863 const struct iio_chan_spec *channels = indio_dev->channels;
1865 if (!(indio_dev->modes & INDIO_ALL_BUFFER_MODES))
1868 for (i = 0; i < indio_dev->num_channels - 1; i++) {
1869 if (channels[i].scan_index < 0)
1871 for (j = i + 1; j < indio_dev->num_channels; j++)
1872 if (channels[i].scan_index == channels[j].scan_index) {
1873 dev_err(&indio_dev->dev,
1874 "Duplicate scan index %d\n",
1875 channels[i].scan_index);
1883 static int iio_check_extended_name(const struct iio_dev *indio_dev)
1887 if (!indio_dev->info->read_label)
1890 for (i = 0; i < indio_dev->num_channels; i++) {
1891 if (indio_dev->channels[i].extend_name) {
1892 dev_err(&indio_dev->dev,
1893 "Cannot use labels and extend_name at the same time\n");
1901 static const struct iio_buffer_setup_ops noop_ring_setup_ops;
1903 static void iio_sanity_check_avail_scan_masks(struct iio_dev *indio_dev)
1905 unsigned int num_masks, masklength, longs_per_mask;
1906 const unsigned long *av_masks;
1909 av_masks = indio_dev->available_scan_masks;
1910 masklength = indio_dev->masklength;
1911 longs_per_mask = BITS_TO_LONGS(masklength);
1914 * The code determining how many available_scan_masks is in the array
1915 * will be assuming the end of masks when first long with all bits
1916 * zeroed is encountered. This is incorrect for masks where mask
1917 * consists of more than one long, and where some of the available masks
1918 * has long worth of bits zeroed (but has subsequent bit(s) set). This
1919 * is a safety measure against bug where array of masks is terminated by
1920 * a single zero while mask width is greater than width of a long.
1922 if (longs_per_mask > 1)
1923 dev_warn(indio_dev->dev.parent,
1924 "multi long available scan masks not fully supported\n");
1926 if (bitmap_empty(av_masks, masklength))
1927 dev_warn(indio_dev->dev.parent, "empty scan mask\n");
1929 for (num_masks = 0; *av_masks; num_masks++)
1930 av_masks += longs_per_mask;
1935 av_masks = indio_dev->available_scan_masks;
1938 * Go through all the masks from first to one before the last, and see
1939 * that no mask found later from the available_scan_masks array is a
1940 * subset of mask found earlier. If this happens, then the mask found
1941 * later will never get used because scanning the array is stopped when
1942 * the first suitable mask is found. Drivers should order the array of
1943 * available masks in the order of preference (presumably the least
1944 * costy to access masks first).
1946 for (i = 0; i < num_masks - 1; i++) {
1947 const unsigned long *mask1;
1950 mask1 = av_masks + i * longs_per_mask;
1951 for (j = i + 1; j < num_masks; j++) {
1952 const unsigned long *mask2;
1954 mask2 = av_masks + j * longs_per_mask;
1955 if (bitmap_subset(mask2, mask1, masklength))
1956 dev_warn(indio_dev->dev.parent,
1957 "available_scan_mask %d subset of %d. Never used\n",
1963 int __iio_device_register(struct iio_dev *indio_dev, struct module *this_mod)
1965 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
1966 struct fwnode_handle *fwnode = NULL;
1969 if (!indio_dev->info)
1972 iio_dev_opaque->driver_module = this_mod;
1974 /* If the calling driver did not initialize firmware node, do it here */
1975 if (dev_fwnode(&indio_dev->dev))
1976 fwnode = dev_fwnode(&indio_dev->dev);
1977 /* The default dummy IIO device has no parent */
1978 else if (indio_dev->dev.parent)
1979 fwnode = dev_fwnode(indio_dev->dev.parent);
1980 device_set_node(&indio_dev->dev, fwnode);
1982 fwnode_property_read_string(fwnode, "label", &indio_dev->label);
1984 ret = iio_check_unique_scan_index(indio_dev);
1988 ret = iio_check_extended_name(indio_dev);
1992 iio_device_register_debugfs(indio_dev);
1994 ret = iio_buffers_alloc_sysfs_and_mask(indio_dev);
1996 dev_err(indio_dev->dev.parent,
1997 "Failed to create buffer sysfs interfaces\n");
1998 goto error_unreg_debugfs;
2001 if (indio_dev->available_scan_masks)
2002 iio_sanity_check_avail_scan_masks(indio_dev);
2004 ret = iio_device_register_sysfs(indio_dev);
2006 dev_err(indio_dev->dev.parent,
2007 "Failed to register sysfs interfaces\n");
2008 goto error_buffer_free_sysfs;
2010 ret = iio_device_register_eventset(indio_dev);
2012 dev_err(indio_dev->dev.parent,
2013 "Failed to register event set\n");
2014 goto error_free_sysfs;
2016 if (indio_dev->modes & INDIO_ALL_TRIGGERED_MODES)
2017 iio_device_register_trigger_consumer(indio_dev);
2019 if ((indio_dev->modes & INDIO_ALL_BUFFER_MODES) &&
2020 indio_dev->setup_ops == NULL)
2021 indio_dev->setup_ops = &noop_ring_setup_ops;
2023 if (iio_dev_opaque->attached_buffers_cnt)
2024 cdev_init(&iio_dev_opaque->chrdev, &iio_buffer_fileops);
2025 else if (iio_dev_opaque->event_interface)
2026 cdev_init(&iio_dev_opaque->chrdev, &iio_event_fileops);
2028 if (iio_dev_opaque->attached_buffers_cnt || iio_dev_opaque->event_interface) {
2029 indio_dev->dev.devt = MKDEV(MAJOR(iio_devt), iio_dev_opaque->id);
2030 iio_dev_opaque->chrdev.owner = this_mod;
2033 /* assign device groups now; they should be all registered now */
2034 indio_dev->dev.groups = iio_dev_opaque->groups;
2036 ret = cdev_device_add(&iio_dev_opaque->chrdev, &indio_dev->dev);
2038 goto error_unreg_eventset;
2042 error_unreg_eventset:
2043 iio_device_unregister_eventset(indio_dev);
2045 iio_device_unregister_sysfs(indio_dev);
2046 error_buffer_free_sysfs:
2047 iio_buffers_free_sysfs_and_mask(indio_dev);
2048 error_unreg_debugfs:
2049 iio_device_unregister_debugfs(indio_dev);
2052 EXPORT_SYMBOL(__iio_device_register);
2055 * iio_device_unregister() - unregister a device from the IIO subsystem
2056 * @indio_dev: Device structure representing the device.
2058 void iio_device_unregister(struct iio_dev *indio_dev)
2060 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
2062 cdev_device_del(&iio_dev_opaque->chrdev, &indio_dev->dev);
2064 mutex_lock(&iio_dev_opaque->info_exist_lock);
2066 iio_device_unregister_debugfs(indio_dev);
2068 iio_disable_all_buffers(indio_dev);
2070 indio_dev->info = NULL;
2072 iio_device_wakeup_eventset(indio_dev);
2073 iio_buffer_wakeup_poll(indio_dev);
2075 mutex_unlock(&iio_dev_opaque->info_exist_lock);
2077 iio_buffers_free_sysfs_and_mask(indio_dev);
2079 EXPORT_SYMBOL(iio_device_unregister);
2081 static void devm_iio_device_unreg(void *indio_dev)
2083 iio_device_unregister(indio_dev);
2086 int __devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev,
2087 struct module *this_mod)
2091 ret = __iio_device_register(indio_dev, this_mod);
2095 return devm_add_action_or_reset(dev, devm_iio_device_unreg, indio_dev);
2097 EXPORT_SYMBOL_GPL(__devm_iio_device_register);
2100 * iio_device_claim_direct_mode - Keep device in direct mode
2101 * @indio_dev: the iio_dev associated with the device
2103 * If the device is in direct mode it is guaranteed to stay
2104 * that way until iio_device_release_direct_mode() is called.
2106 * Use with iio_device_release_direct_mode()
2108 * Returns: 0 on success, -EBUSY on failure.
2110 int iio_device_claim_direct_mode(struct iio_dev *indio_dev)
2112 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
2114 mutex_lock(&iio_dev_opaque->mlock);
2116 if (iio_buffer_enabled(indio_dev)) {
2117 mutex_unlock(&iio_dev_opaque->mlock);
2122 EXPORT_SYMBOL_GPL(iio_device_claim_direct_mode);
2125 * iio_device_release_direct_mode - releases claim on direct mode
2126 * @indio_dev: the iio_dev associated with the device
2128 * Release the claim. Device is no longer guaranteed to stay
2131 * Use with iio_device_claim_direct_mode()
2133 void iio_device_release_direct_mode(struct iio_dev *indio_dev)
2135 mutex_unlock(&to_iio_dev_opaque(indio_dev)->mlock);
2137 EXPORT_SYMBOL_GPL(iio_device_release_direct_mode);
2140 * iio_device_claim_buffer_mode - Keep device in buffer mode
2141 * @indio_dev: the iio_dev associated with the device
2143 * If the device is in buffer mode it is guaranteed to stay
2144 * that way until iio_device_release_buffer_mode() is called.
2146 * Use with iio_device_release_buffer_mode().
2148 * Returns: 0 on success, -EBUSY on failure.
2150 int iio_device_claim_buffer_mode(struct iio_dev *indio_dev)
2152 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
2154 mutex_lock(&iio_dev_opaque->mlock);
2156 if (iio_buffer_enabled(indio_dev))
2159 mutex_unlock(&iio_dev_opaque->mlock);
2162 EXPORT_SYMBOL_GPL(iio_device_claim_buffer_mode);
2165 * iio_device_release_buffer_mode - releases claim on buffer mode
2166 * @indio_dev: the iio_dev associated with the device
2168 * Release the claim. Device is no longer guaranteed to stay
2171 * Use with iio_device_claim_buffer_mode().
2173 void iio_device_release_buffer_mode(struct iio_dev *indio_dev)
2175 mutex_unlock(&to_iio_dev_opaque(indio_dev)->mlock);
2177 EXPORT_SYMBOL_GPL(iio_device_release_buffer_mode);
2180 * iio_device_get_current_mode() - helper function providing read-only access to
2181 * the opaque @currentmode variable
2182 * @indio_dev: IIO device structure for device
2184 int iio_device_get_current_mode(struct iio_dev *indio_dev)
2186 struct iio_dev_opaque *iio_dev_opaque = to_iio_dev_opaque(indio_dev);
2188 return iio_dev_opaque->currentmode;
2190 EXPORT_SYMBOL_GPL(iio_device_get_current_mode);
2192 subsys_initcall(iio_init);
2193 module_exit(iio_exit);
2195 MODULE_AUTHOR("Jonathan Cameron <jic23@kernel.org>");
2196 MODULE_DESCRIPTION("Industrial I/O core");
2197 MODULE_LICENSE("GPL");