industrialio-core.c 31.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
/* 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.
 *
 * Based on elements of hwmon and input subsystems.
 */

12 13
#define pr_fmt(fmt) "iio-core: " fmt

14 15 16 17 18 19 20 21
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/idr.h>
#include <linux/kdev_t.h>
#include <linux/err.h>
#include <linux/device.h>
#include <linux/fs.h>
#include <linux/poll.h>
22
#include <linux/sched.h>
23
#include <linux/wait.h>
24
#include <linux/cdev.h>
25
#include <linux/slab.h>
26
#include <linux/anon_inodes.h>
27
#include <linux/debugfs.h>
28
#include <linux/iio/iio.h>
29
#include "iio_core.h"
30
#include "iio_core_trigger.h"
31 32
#include <linux/iio/sysfs.h>
#include <linux/iio/events.h>
33
#include <linux/iio/buffer.h>
34

35
/* IDA to assign each registered device a unique id */
36
static DEFINE_IDA(iio_ida);
37

38
static dev_t iio_devt;
39 40

#define IIO_DEV_MAX 256
41
struct bus_type iio_bus_type = {
42 43
	.name = "iio",
};
44
EXPORT_SYMBOL(iio_bus_type);
45

46 47
static struct dentry *iio_debugfs_dentry;

48 49 50 51 52
static const char * const iio_direction[] = {
	[0] = "in",
	[1] = "out",
};

53
static const char * const iio_chan_type_name_spec[] = {
54
	[IIO_VOLTAGE] = "voltage",
55 56
	[IIO_CURRENT] = "current",
	[IIO_POWER] = "power",
57
	[IIO_ACCEL] = "accel",
58
	[IIO_ANGL_VEL] = "anglvel",
59
	[IIO_MAGN] = "magn",
60 61
	[IIO_LIGHT] = "illuminance",
	[IIO_INTENSITY] = "intensity",
62
	[IIO_PROXIMITY] = "proximity",
63
	[IIO_TEMP] = "temp",
64 65 66
	[IIO_INCLI] = "incli",
	[IIO_ROT] = "rot",
	[IIO_ANGL] = "angl",
67
	[IIO_TIMESTAMP] = "timestamp",
68
	[IIO_CAPACITANCE] = "capacitance",
69
	[IIO_ALTVOLTAGE] = "altvoltage",
70
	[IIO_CCT] = "cct",
71
	[IIO_PRESSURE] = "pressure",
72
	[IIO_HUMIDITYRELATIVE] = "humidityrelative",
73 74
};

75
static const char * const iio_modifier_names[] = {
76 77 78
	[IIO_MOD_X] = "x",
	[IIO_MOD_Y] = "y",
	[IIO_MOD_Z] = "z",
79
	[IIO_MOD_ROOT_SUM_SQUARED_X_Y] = "sqrt(x^2+y^2)",
80
	[IIO_MOD_SUM_SQUARED_X_Y_Z] = "x^2+y^2+z^2",
81 82
	[IIO_MOD_LIGHT_BOTH] = "both",
	[IIO_MOD_LIGHT_IR] = "ir",
83 84 85 86
	[IIO_MOD_LIGHT_CLEAR] = "clear",
	[IIO_MOD_LIGHT_RED] = "red",
	[IIO_MOD_LIGHT_GREEN] = "green",
	[IIO_MOD_LIGHT_BLUE] = "blue",
87 88 89 90
};

/* relies on pairs of these shared then separate */
static const char * const iio_chan_info_postfix[] = {
91 92
	[IIO_CHAN_INFO_RAW] = "raw",
	[IIO_CHAN_INFO_PROCESSED] = "input",
93 94 95 96 97 98 99 100
	[IIO_CHAN_INFO_SCALE] = "scale",
	[IIO_CHAN_INFO_OFFSET] = "offset",
	[IIO_CHAN_INFO_CALIBSCALE] = "calibscale",
	[IIO_CHAN_INFO_CALIBBIAS] = "calibbias",
	[IIO_CHAN_INFO_PEAK] = "peak_raw",
	[IIO_CHAN_INFO_PEAK_SCALE] = "peak_scale",
	[IIO_CHAN_INFO_QUADRATURE_CORRECTION_RAW] = "quadrature_correction_raw",
	[IIO_CHAN_INFO_AVERAGE_RAW] = "mean_raw",
101 102
	[IIO_CHAN_INFO_LOW_PASS_FILTER_3DB_FREQUENCY]
	= "filter_low_pass_3db_frequency",
103
	[IIO_CHAN_INFO_SAMP_FREQ] = "sampling_frequency",
104 105
	[IIO_CHAN_INFO_FREQUENCY] = "frequency",
	[IIO_CHAN_INFO_PHASE] = "phase",
106
	[IIO_CHAN_INFO_HARDWAREGAIN] = "hardwaregain",
107
	[IIO_CHAN_INFO_HYSTERESIS] = "hysteresis",
108
	[IIO_CHAN_INFO_INT_TIME] = "integration_time",
109 110
};

111 112 113 114 115
/**
 * iio_find_channel_from_si() - get channel from its scan index
 * @indio_dev:		device
 * @si:			scan index to match
 */
116 117 118 119 120 121 122 123 124 125 126
const struct iio_chan_spec
*iio_find_channel_from_si(struct iio_dev *indio_dev, int si)
{
	int i;

	for (i = 0; i < indio_dev->num_channels; i++)
		if (indio_dev->channels[i].scan_index == si)
			return &indio_dev->channels[i];
	return NULL;
}

127 128 129 130 131 132 133 134 135 136 137 138 139
/* This turns up an awful lot */
ssize_t iio_read_const_attr(struct device *dev,
			    struct device_attribute *attr,
			    char *buf)
{
	return sprintf(buf, "%s\n", to_iio_const_attr(attr)->string);
}
EXPORT_SYMBOL(iio_read_const_attr);

static int __init iio_init(void)
{
	int ret;

140 141
	/* Register sysfs bus */
	ret  = bus_register(&iio_bus_type);
142
	if (ret < 0) {
143
		pr_err("could not register bus type\n");
144 145 146
		goto error_nothing;
	}

147 148
	ret = alloc_chrdev_region(&iio_devt, 0, IIO_DEV_MAX, "iio");
	if (ret < 0) {
149
		pr_err("failed to allocate char dev region\n");
150
		goto error_unregister_bus_type;
151
	}
152

153 154
	iio_debugfs_dentry = debugfs_create_dir("iio", NULL);

155 156
	return 0;

157 158
error_unregister_bus_type:
	bus_unregister(&iio_bus_type);
159 160 161 162 163 164
error_nothing:
	return ret;
}

static void __exit iio_exit(void)
{
165 166
	if (iio_devt)
		unregister_chrdev_region(iio_devt, IIO_DEV_MAX);
167
	bus_unregister(&iio_bus_type);
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
	debugfs_remove(iio_debugfs_dentry);
}

#if defined(CONFIG_DEBUG_FS)
static ssize_t iio_debugfs_read_reg(struct file *file, char __user *userbuf,
			      size_t count, loff_t *ppos)
{
	struct iio_dev *indio_dev = file->private_data;
	char buf[20];
	unsigned val = 0;
	ssize_t len;
	int ret;

	ret = indio_dev->info->debugfs_reg_access(indio_dev,
						  indio_dev->cached_reg_addr,
						  0, &val);
	if (ret)
		dev_err(indio_dev->dev.parent, "%s: read failed\n", __func__);

	len = snprintf(buf, sizeof(buf), "0x%X\n", val);

	return simple_read_from_buffer(userbuf, count, ppos, buf, len);
}

static ssize_t iio_debugfs_write_reg(struct file *file,
		     const char __user *userbuf, size_t count, loff_t *ppos)
{
	struct iio_dev *indio_dev = file->private_data;
	unsigned reg, val;
	char buf[80];
	int ret;

	count = min_t(size_t, count, (sizeof(buf)-1));
	if (copy_from_user(buf, userbuf, count))
		return -EFAULT;

	buf[count] = 0;

	ret = sscanf(buf, "%i %i", &reg, &val);

	switch (ret) {
	case 1:
		indio_dev->cached_reg_addr = reg;
		break;
	case 2:
		indio_dev->cached_reg_addr = reg;
		ret = indio_dev->info->debugfs_reg_access(indio_dev, reg,
							  val, NULL);
		if (ret) {
			dev_err(indio_dev->dev.parent, "%s: write failed\n",
				__func__);
			return ret;
		}
		break;
	default:
		return -EINVAL;
	}

	return count;
}

static const struct file_operations iio_debugfs_reg_fops = {
230
	.open = simple_open,
231 232 233 234 235 236 237
	.read = iio_debugfs_read_reg,
	.write = iio_debugfs_write_reg,
};

static void iio_device_unregister_debugfs(struct iio_dev *indio_dev)
{
	debugfs_remove_recursive(indio_dev->debugfs_dentry);
238 239
}

240 241 242 243 244 245 246
static int iio_device_register_debugfs(struct iio_dev *indio_dev)
{
	struct dentry *d;

	if (indio_dev->info->debugfs_reg_access == NULL)
		return 0;

247
	if (!iio_debugfs_dentry)
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
		return 0;

	indio_dev->debugfs_dentry =
		debugfs_create_dir(dev_name(&indio_dev->dev),
				   iio_debugfs_dentry);
	if (indio_dev->debugfs_dentry == NULL) {
		dev_warn(indio_dev->dev.parent,
			 "Failed to create debugfs directory\n");
		return -EFAULT;
	}

	d = debugfs_create_file("direct_reg_access", 0644,
				indio_dev->debugfs_dentry,
				indio_dev, &iio_debugfs_reg_fops);
	if (!d) {
		iio_device_unregister_debugfs(indio_dev);
		return -ENOMEM;
	}

	return 0;
}
#else
static int iio_device_register_debugfs(struct iio_dev *indio_dev)
{
	return 0;
}

static void iio_device_unregister_debugfs(struct iio_dev *indio_dev)
{
}
#endif /* CONFIG_DEBUG_FS */

280 281 282 283
static ssize_t iio_read_channel_ext_info(struct device *dev,
				     struct device_attribute *attr,
				     char *buf)
{
L
Lars-Peter Clausen 已提交
284
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
285 286 287 288 289
	struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
	const struct iio_chan_spec_ext_info *ext_info;

	ext_info = &this_attr->c->ext_info[this_attr->address];

290
	return ext_info->read(indio_dev, ext_info->private, this_attr->c, buf);
291 292 293 294 295 296 297
}

static ssize_t iio_write_channel_ext_info(struct device *dev,
				     struct device_attribute *attr,
				     const char *buf,
					 size_t len)
{
L
Lars-Peter Clausen 已提交
298
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
299 300 301 302 303
	struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
	const struct iio_chan_spec_ext_info *ext_info;

	ext_info = &this_attr->c->ext_info[this_attr->address];

304 305
	return ext_info->write(indio_dev, ext_info->private,
			       this_attr->c, buf, len);
306 307
}

308 309 310 311 312 313 314 315 316 317 318
ssize_t iio_enum_available_read(struct iio_dev *indio_dev,
	uintptr_t priv, const struct iio_chan_spec *chan, char *buf)
{
	const struct iio_enum *e = (const struct iio_enum *)priv;
	unsigned int i;
	size_t len = 0;

	if (!e->num_items)
		return 0;

	for (i = 0; i < e->num_items; ++i)
319
		len += scnprintf(buf + len, PAGE_SIZE - len, "%s ", e->items[i]);
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370

	/* replace last space with a newline */
	buf[len - 1] = '\n';

	return len;
}
EXPORT_SYMBOL_GPL(iio_enum_available_read);

ssize_t iio_enum_read(struct iio_dev *indio_dev,
	uintptr_t priv, const struct iio_chan_spec *chan, char *buf)
{
	const struct iio_enum *e = (const struct iio_enum *)priv;
	int i;

	if (!e->get)
		return -EINVAL;

	i = e->get(indio_dev, chan);
	if (i < 0)
		return i;
	else if (i >= e->num_items)
		return -EINVAL;

	return sprintf(buf, "%s\n", e->items[i]);
}
EXPORT_SYMBOL_GPL(iio_enum_read);

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)
{
	const struct iio_enum *e = (const struct iio_enum *)priv;
	unsigned int i;
	int ret;

	if (!e->set)
		return -EINVAL;

	for (i = 0; i < e->num_items; i++) {
		if (sysfs_streq(buf, e->items[i]))
			break;
	}

	if (i == e->num_items)
		return -EINVAL;

	ret = e->set(indio_dev, chan, i);
	return ret ? ret : len;
}
EXPORT_SYMBOL_GPL(iio_enum_write);

371 372 373 374 375 376 377 378 379
/**
 * iio_format_value() - Formats a IIO value into its string representation
 * @buf: The buffer to which the formated value gets written
 * @type: One of the IIO_VAL_... constants. This decides how the val and val2
 *        parameters are formatted.
 * @val: First part of the value, exact meaning depends on the type parameter.
 * @val2: Second part of the value, exact meaning depends on the type parameter.
 */
ssize_t iio_format_value(char *buf, unsigned int type, int val, int val2)
380
{
381
	unsigned long long tmp;
382
	bool scale_db = false;
383

384
	switch (type) {
385
	case IIO_VAL_INT:
386
		return sprintf(buf, "%d\n", val);
387 388 389
	case IIO_VAL_INT_PLUS_MICRO_DB:
		scale_db = true;
	case IIO_VAL_INT_PLUS_MICRO:
390
		if (val2 < 0)
391
			return sprintf(buf, "-%ld.%06u%s\n", abs(val), -val2,
392
				scale_db ? " dB" : "");
393
		else
394 395 396
			return sprintf(buf, "%d.%06u%s\n", val, val2,
				scale_db ? " dB" : "");
	case IIO_VAL_INT_PLUS_NANO:
397
		if (val2 < 0)
398
			return sprintf(buf, "-%ld.%09u\n", abs(val), -val2);
399 400
		else
			return sprintf(buf, "%d.%09u\n", val, val2);
401 402 403 404 405
	case IIO_VAL_FRACTIONAL:
		tmp = div_s64((s64)val * 1000000000LL, val2);
		val2 = do_div(tmp, 1000000000LL);
		val = tmp;
		return sprintf(buf, "%d.%09u\n", val, val2);
406 407 408 409 410
	case IIO_VAL_FRACTIONAL_LOG2:
		tmp = (s64)val * 1000000000LL >> val2;
		val2 = do_div(tmp, 1000000000LL);
		val = tmp;
		return sprintf(buf, "%d.%09u\n", val, val2);
411
	default:
412
		return 0;
413
	}
414 415
}

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
static ssize_t iio_read_channel_info(struct device *dev,
				     struct device_attribute *attr,
				     char *buf)
{
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
	struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
	int val, val2;
	int ret = indio_dev->info->read_raw(indio_dev, this_attr->c,
					    &val, &val2, this_attr->address);

	if (ret < 0)
		return ret;

	return iio_format_value(buf, ret, val, val2);
}

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
/**
 * iio_str_to_fixpoint() - Parse a fixed-point number from a string
 * @str: The string to parse
 * @fract_mult: Multiplier for the first decimal place, should be a power of 10
 * @integer: The integer part of the number
 * @fract: The fractional part of the number
 *
 * Returns 0 on success, or a negative error code if the string could not be
 * parsed.
 */
int iio_str_to_fixpoint(const char *str, int fract_mult,
	int *integer, int *fract)
{
	int i = 0, f = 0;
	bool integer_part = true, negative = false;

	if (str[0] == '-') {
		negative = true;
		str++;
	} else if (str[0] == '+') {
		str++;
	}

	while (*str) {
		if ('0' <= *str && *str <= '9') {
			if (integer_part) {
				i = i * 10 + *str - '0';
			} else {
				f += fract_mult * (*str - '0');
				fract_mult /= 10;
			}
		} else if (*str == '\n') {
			if (*(str + 1) == '\0')
				break;
			else
				return -EINVAL;
		} else if (*str == '.' && integer_part) {
			integer_part = false;
		} else {
			return -EINVAL;
		}
		str++;
	}

	if (negative) {
		if (i)
			i = -i;
		else
			f = -f;
	}

	*integer = i;
	*fract = f;

	return 0;
}
EXPORT_SYMBOL_GPL(iio_str_to_fixpoint);

490 491 492 493 494
static ssize_t iio_write_channel_info(struct device *dev,
				      struct device_attribute *attr,
				      const char *buf,
				      size_t len)
{
L
Lars-Peter Clausen 已提交
495
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
496
	struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
497 498
	int ret, fract_mult = 100000;
	int integer, fract;
499 500

	/* Assumes decimal - precision based on number of digits */
501
	if (!indio_dev->info->write_raw)
502
		return -EINVAL;
503 504 505 506 507 508 509 510 511 512 513 514 515 516

	if (indio_dev->info->write_raw_get_fmt)
		switch (indio_dev->info->write_raw_get_fmt(indio_dev,
			this_attr->c, this_attr->address)) {
		case IIO_VAL_INT_PLUS_MICRO:
			fract_mult = 100000;
			break;
		case IIO_VAL_INT_PLUS_NANO:
			fract_mult = 100000000;
			break;
		default:
			return -EINVAL;
		}

517 518 519
	ret = iio_str_to_fixpoint(buf, fract_mult, &integer, &fract);
	if (ret)
		return ret;
520

521
	ret = indio_dev->info->write_raw(indio_dev, this_attr->c,
522
					 integer, fract, this_attr->address);
523 524 525 526 527 528
	if (ret)
		return ret;

	return len;
}

529
static
530 531 532 533 534 535 536 537 538 539
int __iio_device_attr_init(struct device_attribute *dev_attr,
			   const char *postfix,
			   struct iio_chan_spec const *chan,
			   ssize_t (*readfunc)(struct device *dev,
					       struct device_attribute *attr,
					       char *buf),
			   ssize_t (*writefunc)(struct device *dev,
						struct device_attribute *attr,
						const char *buf,
						size_t len),
540
			   enum iio_shared_by shared_by)
541
{
542 543 544
	int ret = 0;
	char *name_format = NULL;
	char *full_postfix;
545 546
	sysfs_attr_init(&dev_attr->attr);

547
	/* Build up postfix of <extend_name>_<modifier>_postfix */
548
	if (chan->modified && (shared_by == IIO_SEPARATE)) {
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
		if (chan->extend_name)
			full_postfix = kasprintf(GFP_KERNEL, "%s_%s_%s",
						 iio_modifier_names[chan
								    ->channel2],
						 chan->extend_name,
						 postfix);
		else
			full_postfix = kasprintf(GFP_KERNEL, "%s_%s",
						 iio_modifier_names[chan
								    ->channel2],
						 postfix);
	} else {
		if (chan->extend_name == NULL)
			full_postfix = kstrdup(postfix, GFP_KERNEL);
		else
			full_postfix = kasprintf(GFP_KERNEL,
						 "%s_%s",
						 chan->extend_name,
						 postfix);
	}
569 570
	if (full_postfix == NULL)
		return -ENOMEM;
571

572
	if (chan->differential) { /* Differential can not have modifier */
573
		switch (shared_by) {
574 575 576 577 578 579 580 581
		case IIO_SHARED_BY_ALL:
			name_format = kasprintf(GFP_KERNEL, "%s", full_postfix);
			break;
		case IIO_SHARED_BY_DIR:
			name_format = kasprintf(GFP_KERNEL, "%s_%s",
						iio_direction[chan->output],
						full_postfix);
			break;
582
		case IIO_SHARED_BY_TYPE:
583 584 585 586 587 588
			name_format
				= kasprintf(GFP_KERNEL, "%s_%s-%s_%s",
					    iio_direction[chan->output],
					    iio_chan_type_name_spec[chan->type],
					    iio_chan_type_name_spec[chan->type],
					    full_postfix);
589 590 591 592 593 594 595
			break;
		case IIO_SEPARATE:
			if (!chan->indexed) {
				WARN_ON("Differential channels must be indexed\n");
				ret = -EINVAL;
				goto error_free_full_postfix;
			}
596
			name_format
597 598
				= kasprintf(GFP_KERNEL,
					    "%s_%s%d-%s%d_%s",
599 600 601 602 603 604
					    iio_direction[chan->output],
					    iio_chan_type_name_spec[chan->type],
					    chan->channel,
					    iio_chan_type_name_spec[chan->type],
					    chan->channel2,
					    full_postfix);
605
			break;
606 607
		}
	} else { /* Single ended */
608
		switch (shared_by) {
609 610 611 612 613 614 615 616
		case IIO_SHARED_BY_ALL:
			name_format = kasprintf(GFP_KERNEL, "%s", full_postfix);
			break;
		case IIO_SHARED_BY_DIR:
			name_format = kasprintf(GFP_KERNEL, "%s_%s",
						iio_direction[chan->output],
						full_postfix);
			break;
617
		case IIO_SHARED_BY_TYPE:
618 619 620 621 622
			name_format
				= kasprintf(GFP_KERNEL, "%s_%s_%s",
					    iio_direction[chan->output],
					    iio_chan_type_name_spec[chan->type],
					    full_postfix);
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
			break;

		case IIO_SEPARATE:
			if (chan->indexed)
				name_format
					= kasprintf(GFP_KERNEL, "%s_%s%d_%s",
						    iio_direction[chan->output],
						    iio_chan_type_name_spec[chan->type],
						    chan->channel,
						    full_postfix);
			else
				name_format
					= kasprintf(GFP_KERNEL, "%s_%s_%s",
						    iio_direction[chan->output],
						    iio_chan_type_name_spec[chan->type],
						    full_postfix);
			break;
		}
641
	}
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
	if (name_format == NULL) {
		ret = -ENOMEM;
		goto error_free_full_postfix;
	}
	dev_attr->attr.name = kasprintf(GFP_KERNEL,
					name_format,
					chan->channel,
					chan->channel2);
	if (dev_attr->attr.name == NULL) {
		ret = -ENOMEM;
		goto error_free_name_format;
	}

	if (readfunc) {
		dev_attr->attr.mode |= S_IRUGO;
		dev_attr->show = readfunc;
	}

	if (writefunc) {
		dev_attr->attr.mode |= S_IWUSR;
		dev_attr->store = writefunc;
	}
error_free_name_format:
	kfree(name_format);
error_free_full_postfix:
	kfree(full_postfix);
668

669 670 671
	return ret;
}

672
static void __iio_device_attr_deinit(struct device_attribute *dev_attr)
673 674 675 676 677 678 679 680 681 682 683 684 685
{
	kfree(dev_attr->attr.name);
}

int __iio_add_chan_devattr(const char *postfix,
			   struct iio_chan_spec const *chan,
			   ssize_t (*readfunc)(struct device *dev,
					       struct device_attribute *attr,
					       char *buf),
			   ssize_t (*writefunc)(struct device *dev,
						struct device_attribute *attr,
						const char *buf,
						size_t len),
686
			   u64 mask,
687
			   enum iio_shared_by shared_by,
688 689 690 691 692 693
			   struct device *dev,
			   struct list_head *attr_list)
{
	int ret;
	struct iio_dev_attr *iio_attr, *t;

S
Sachin Kamat 已提交
694
	iio_attr = kzalloc(sizeof(*iio_attr), GFP_KERNEL);
695 696 697 698 699 700
	if (iio_attr == NULL) {
		ret = -ENOMEM;
		goto error_ret;
	}
	ret = __iio_device_attr_init(&iio_attr->dev_attr,
				     postfix, chan,
701
				     readfunc, writefunc, shared_by);
702 703 704 705 706 707 708
	if (ret)
		goto error_iio_dev_attr_free;
	iio_attr->c = chan;
	iio_attr->address = mask;
	list_for_each_entry(t, attr_list, l)
		if (strcmp(t->dev_attr.attr.name,
			   iio_attr->dev_attr.attr.name) == 0) {
709
			if (shared_by == IIO_SEPARATE)
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
				dev_err(dev, "tried to double register : %s\n",
					t->dev_attr.attr.name);
			ret = -EBUSY;
			goto error_device_attr_deinit;
		}
	list_add(&iio_attr->l, attr_list);

	return 0;

error_device_attr_deinit:
	__iio_device_attr_deinit(&iio_attr->dev_attr);
error_iio_dev_attr_free:
	kfree(iio_attr);
error_ret:
	return ret;
}

727 728 729 730
static int iio_device_add_info_mask_type(struct iio_dev *indio_dev,
					 struct iio_chan_spec const *chan,
					 enum iio_shared_by shared_by,
					 const long *infomask)
731
{
732
	int i, ret, attrcount = 0;
733

734
	for_each_set_bit(i, infomask, sizeof(infomask)*8) {
735 736 737 738 739
		ret = __iio_add_chan_devattr(iio_chan_info_postfix[i],
					     chan,
					     &iio_read_channel_info,
					     &iio_write_channel_info,
					     i,
740
					     shared_by,
741 742
					     &indio_dev->dev,
					     &indio_dev->channel_attr_list);
743
		if ((ret == -EBUSY) && (shared_by != IIO_SEPARATE))
744
			continue;
745 746
		else if (ret < 0)
			return ret;
747 748
		attrcount++;
	}
749

750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
	return attrcount;
}

static int iio_device_add_channel_sysfs(struct iio_dev *indio_dev,
					struct iio_chan_spec const *chan)
{
	int ret, attrcount = 0;
	const struct iio_chan_spec_ext_info *ext_info;

	if (chan->channel < 0)
		return 0;
	ret = iio_device_add_info_mask_type(indio_dev, chan,
					    IIO_SEPARATE,
					    &chan->info_mask_separate);
	if (ret < 0)
		return ret;
	attrcount += ret;

	ret = iio_device_add_info_mask_type(indio_dev, chan,
					    IIO_SHARED_BY_TYPE,
					    &chan->info_mask_shared_by_type);
	if (ret < 0)
		return ret;
	attrcount += ret;

775 776 777 778 779 780 781 782 783 784 785 786 787 788
	ret = iio_device_add_info_mask_type(indio_dev, chan,
					    IIO_SHARED_BY_DIR,
					    &chan->info_mask_shared_by_dir);
	if (ret < 0)
		return ret;
	attrcount += ret;

	ret = iio_device_add_info_mask_type(indio_dev, chan,
					    IIO_SHARED_BY_ALL,
					    &chan->info_mask_shared_by_all);
	if (ret < 0)
		return ret;
	attrcount += ret;

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
	if (chan->ext_info) {
		unsigned int i = 0;
		for (ext_info = chan->ext_info; ext_info->name; ext_info++) {
			ret = __iio_add_chan_devattr(ext_info->name,
					chan,
					ext_info->read ?
					    &iio_read_channel_ext_info : NULL,
					ext_info->write ?
					    &iio_write_channel_ext_info : NULL,
					i,
					ext_info->shared,
					&indio_dev->dev,
					&indio_dev->channel_attr_list);
			i++;
			if (ret == -EBUSY && ext_info->shared)
				continue;

			if (ret)
807
				return ret;
808 809 810 811 812

			attrcount++;
		}
	}

813
	return attrcount;
814 815
}

816 817 818 819 820 821 822 823 824
/**
 * iio_free_chan_devattr_list() - Free a list of IIO device attributes
 * @attr_list: List of IIO device attributes
 *
 * This function frees the memory allocated for each of the IIO device
 * attributes in the list. Note: if you want to reuse the list after calling
 * this function you have to reinitialize it using INIT_LIST_HEAD().
 */
void iio_free_chan_devattr_list(struct list_head *attr_list)
825
{
826 827 828 829 830 831
	struct iio_dev_attr *p, *n;

	list_for_each_entry_safe(p, n, attr_list, l) {
		kfree(p->dev_attr.attr.name);
		kfree(p);
	}
832 833
}

834 835 836 837
static ssize_t iio_show_dev_name(struct device *dev,
				 struct device_attribute *attr,
				 char *buf)
{
L
Lars-Peter Clausen 已提交
838
	struct iio_dev *indio_dev = dev_to_iio_dev(dev);
839 840 841 842 843
	return sprintf(buf, "%s\n", indio_dev->name);
}

static DEVICE_ATTR(name, S_IRUGO, iio_show_dev_name, NULL);

844
static int iio_device_register_sysfs(struct iio_dev *indio_dev)
845
{
846
	int i, ret = 0, attrcount, attrn, attrcount_orig = 0;
847
	struct iio_dev_attr *p;
848
	struct attribute **attr;
849

850
	/* First count elements in any existing group */
851 852
	if (indio_dev->info->attrs) {
		attr = indio_dev->info->attrs->attrs;
853 854
		while (*attr++ != NULL)
			attrcount_orig++;
855
	}
856
	attrcount = attrcount_orig;
857 858
	/*
	 * New channel registration method - relies on the fact a group does
P
Peter Meerwald 已提交
859
	 * not need to be initialized if its name is NULL.
860
	 */
861 862 863 864
	if (indio_dev->channels)
		for (i = 0; i < indio_dev->num_channels; i++) {
			ret = iio_device_add_channel_sysfs(indio_dev,
							   &indio_dev
865 866 867
							   ->channels[i]);
			if (ret < 0)
				goto error_clear_attrs;
868
			attrcount += ret;
869
		}
870

871
	if (indio_dev->name)
872 873
		attrcount++;

874 875 876
	indio_dev->chan_attr_group.attrs = kcalloc(attrcount + 1,
						   sizeof(indio_dev->chan_attr_group.attrs[0]),
						   GFP_KERNEL);
877
	if (indio_dev->chan_attr_group.attrs == NULL) {
878 879
		ret = -ENOMEM;
		goto error_clear_attrs;
880
	}
881
	/* Copy across original attributes */
882 883 884 885
	if (indio_dev->info->attrs)
		memcpy(indio_dev->chan_attr_group.attrs,
		       indio_dev->info->attrs->attrs,
		       sizeof(indio_dev->chan_attr_group.attrs[0])
886 887 888
		       *attrcount_orig);
	attrn = attrcount_orig;
	/* Add all elements from the list. */
889 890 891 892
	list_for_each_entry(p, &indio_dev->channel_attr_list, l)
		indio_dev->chan_attr_group.attrs[attrn++] = &p->dev_attr.attr;
	if (indio_dev->name)
		indio_dev->chan_attr_group.attrs[attrn++] = &dev_attr_name.attr;
893

894 895
	indio_dev->groups[indio_dev->groupcounter++] =
		&indio_dev->chan_attr_group;
896

897
	return 0;
898

899
error_clear_attrs:
900
	iio_free_chan_devattr_list(&indio_dev->channel_attr_list);
901

902
	return ret;
903 904
}

905
static void iio_device_unregister_sysfs(struct iio_dev *indio_dev)
906
{
907

908
	iio_free_chan_devattr_list(&indio_dev->channel_attr_list);
909
	kfree(indio_dev->chan_attr_group.attrs);
910 911 912 913
}

static void iio_dev_release(struct device *device)
{
L
Lars-Peter Clausen 已提交
914
	struct iio_dev *indio_dev = dev_to_iio_dev(device);
915 916 917 918
	if (indio_dev->modes & INDIO_BUFFER_TRIGGERED)
		iio_device_unregister_trigger_consumer(indio_dev);
	iio_device_unregister_eventset(indio_dev);
	iio_device_unregister_sysfs(indio_dev);
919

920 921
	iio_buffer_put(indio_dev->buffer);

922 923
	ida_simple_remove(&iio_ida, indio_dev->id);
	kfree(indio_dev);
924 925
}

G
Guenter Roeck 已提交
926
struct device_type iio_device_type = {
927 928 929 930
	.name = "iio_device",
	.release = iio_dev_release,
};

931 932 933 934
/**
 * iio_device_alloc() - allocate an iio_dev from a driver
 * @sizeof_priv:	Space to allocate for private structure.
 **/
935
struct iio_dev *iio_device_alloc(int sizeof_priv)
936
{
937 938 939 940 941 942 943 944 945 946 947 948
	struct iio_dev *dev;
	size_t alloc_size;

	alloc_size = sizeof(struct iio_dev);
	if (sizeof_priv) {
		alloc_size = ALIGN(alloc_size, IIO_ALIGN);
		alloc_size += sizeof_priv;
	}
	/* ensure 32-byte alignment of whole construct ? */
	alloc_size += IIO_ALIGN - 1;

	dev = kzalloc(alloc_size, GFP_KERNEL);
949 950

	if (dev) {
951
		dev->dev.groups = dev->groups;
G
Guenter Roeck 已提交
952
		dev->dev.type = &iio_device_type;
953
		dev->dev.bus = &iio_bus_type;
954 955 956
		device_initialize(&dev->dev);
		dev_set_drvdata(&dev->dev, (void *)dev);
		mutex_init(&dev->mlock);
957
		mutex_init(&dev->info_exist_lock);
958
		INIT_LIST_HEAD(&dev->channel_attr_list);
959 960 961 962

		dev->id = ida_simple_get(&iio_ida, 0, 0, GFP_KERNEL);
		if (dev->id < 0) {
			/* cannot use a dev_err as the name isn't available */
963
			pr_err("failed to get device id\n");
964 965 966 967
			kfree(dev);
			return NULL;
		}
		dev_set_name(&dev->dev, "iio:device%d", dev->id);
968
		INIT_LIST_HEAD(&dev->buffer_list);
969 970 971 972
	}

	return dev;
}
973
EXPORT_SYMBOL(iio_device_alloc);
974

975 976 977 978
/**
 * iio_device_free() - free an iio_dev from a driver
 * @dev:		the iio_dev associated with the device
 **/
979
void iio_device_free(struct iio_dev *dev)
980
{
981 982
	if (dev)
		put_device(&dev->dev);
983
}
984
EXPORT_SYMBOL(iio_device_free);
985

986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
static void devm_iio_device_release(struct device *dev, void *res)
{
	iio_device_free(*(struct iio_dev **)res);
}

static int devm_iio_device_match(struct device *dev, void *res, void *data)
{
	struct iio_dev **r = res;
	if (!r || !*r) {
		WARN_ON(!r || !*r);
		return 0;
	}
	return *r == data;
}

1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
/**
 * 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.
 */
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
struct iio_dev *devm_iio_device_alloc(struct device *dev, int sizeof_priv)
{
	struct iio_dev **ptr, *iio_dev;

	ptr = devres_alloc(devm_iio_device_release, sizeof(*ptr),
			   GFP_KERNEL);
	if (!ptr)
		return NULL;

	/* use raw alloc_dr for kmalloc caller tracing */
	iio_dev = iio_device_alloc(sizeof_priv);
	if (iio_dev) {
		*ptr = iio_dev;
		devres_add(dev, ptr);
	} else {
		devres_free(ptr);
	}

	return iio_dev;
}
EXPORT_SYMBOL_GPL(devm_iio_device_alloc);

1037 1038 1039 1040 1041 1042 1043
/**
 * devm_iio_device_free - Resource-managed iio_device_free()
 * @dev:		Device this iio_dev belongs to
 * @iio_dev:		the iio_dev associated with the device
 *
 * Free iio_dev allocated with devm_iio_device_alloc().
 */
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
void devm_iio_device_free(struct device *dev, struct iio_dev *iio_dev)
{
	int rc;

	rc = devres_release(dev, devm_iio_device_release,
			    devm_iio_device_match, iio_dev);
	WARN_ON(rc);
}
EXPORT_SYMBOL_GPL(devm_iio_device_free);

1054
/**
1055
 * iio_chrdev_open() - chrdev file open for buffer access and ioctls
1056 1057 1058
 **/
static int iio_chrdev_open(struct inode *inode, struct file *filp)
{
1059
	struct iio_dev *indio_dev = container_of(inode->i_cdev,
1060
						struct iio_dev, chrdev);
1061 1062 1063 1064

	if (test_and_set_bit(IIO_BUSY_BIT_POS, &indio_dev->flags))
		return -EBUSY;

1065 1066
	iio_device_get(indio_dev);

1067
	filp->private_data = indio_dev;
1068

1069
	return 0;
1070 1071 1072
}

/**
1073
 * iio_chrdev_release() - chrdev file close buffer access and ioctls
1074 1075 1076
 **/
static int iio_chrdev_release(struct inode *inode, struct file *filp)
{
1077 1078 1079
	struct iio_dev *indio_dev = container_of(inode->i_cdev,
						struct iio_dev, chrdev);
	clear_bit(IIO_BUSY_BIT_POS, &indio_dev->flags);
1080 1081
	iio_device_put(indio_dev);

1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
	return 0;
}

/* Somewhat of a cross file organization violation - ioctls here are actually
 * event related */
static long iio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
{
	struct iio_dev *indio_dev = filp->private_data;
	int __user *ip = (int __user *)arg;
	int fd;

1093 1094 1095
	if (!indio_dev->info)
		return -ENODEV;

1096 1097 1098 1099 1100 1101 1102 1103 1104
	if (cmd == IIO_GET_EVENT_FD_IOCTL) {
		fd = iio_event_getfd(indio_dev);
		if (copy_to_user(ip, &fd, sizeof(fd)))
			return -EFAULT;
		return 0;
	}
	return -EINVAL;
}

1105 1106
static const struct file_operations iio_buffer_fileops = {
	.read = iio_buffer_read_first_n_outer_addr,
1107 1108
	.release = iio_chrdev_release,
	.open = iio_chrdev_open,
1109
	.poll = iio_buffer_poll_addr,
1110 1111 1112 1113 1114 1115
	.owner = THIS_MODULE,
	.llseek = noop_llseek,
	.unlocked_ioctl = iio_ioctl,
	.compat_ioctl = iio_ioctl,
};

1116 1117
static const struct iio_buffer_setup_ops noop_ring_setup_ops;

1118 1119 1120 1121
/**
 * iio_device_register() - register a device with the IIO subsystem
 * @indio_dev:		Device structure filled by the device driver
 **/
1122
int iio_device_register(struct iio_dev *indio_dev)
1123 1124 1125
{
	int ret;

G
Guenter Roeck 已提交
1126 1127 1128 1129
	/* If the calling driver did not initialize of_node, do it here */
	if (!indio_dev->dev.of_node && indio_dev->dev.parent)
		indio_dev->dev.of_node = indio_dev->dev.parent->of_node;

1130
	/* configure elements for the chrdev */
1131
	indio_dev->dev.devt = MKDEV(MAJOR(iio_devt), indio_dev->id);
1132

1133 1134 1135 1136 1137 1138
	ret = iio_device_register_debugfs(indio_dev);
	if (ret) {
		dev_err(indio_dev->dev.parent,
			"Failed to register debugfs interfaces\n");
		goto error_ret;
	}
1139
	ret = iio_device_register_sysfs(indio_dev);
1140
	if (ret) {
1141
		dev_err(indio_dev->dev.parent,
1142
			"Failed to register sysfs interfaces\n");
1143
		goto error_unreg_debugfs;
1144
	}
1145
	ret = iio_device_register_eventset(indio_dev);
1146
	if (ret) {
1147
		dev_err(indio_dev->dev.parent,
1148
			"Failed to register event set\n");
1149 1150
		goto error_free_sysfs;
	}
1151 1152
	if (indio_dev->modes & INDIO_BUFFER_TRIGGERED)
		iio_device_register_trigger_consumer(indio_dev);
1153

1154 1155 1156 1157
	if ((indio_dev->modes & INDIO_ALL_BUFFER_MODES) &&
		indio_dev->setup_ops == NULL)
		indio_dev->setup_ops = &noop_ring_setup_ops;

1158 1159
	cdev_init(&indio_dev->chrdev, &iio_buffer_fileops);
	indio_dev->chrdev.owner = indio_dev->info->driver_module;
1160
	indio_dev->chrdev.kobj.parent = &indio_dev->dev.kobj;
1161
	ret = cdev_add(&indio_dev->chrdev, indio_dev->dev.devt, 1);
1162
	if (ret < 0)
1163
		goto error_unreg_eventset;
1164

1165 1166 1167 1168 1169 1170 1171
	ret = device_add(&indio_dev->dev);
	if (ret < 0)
		goto error_cdev_del;

	return 0;
error_cdev_del:
	cdev_del(&indio_dev->chrdev);
1172
error_unreg_eventset:
1173
	iio_device_unregister_eventset(indio_dev);
1174
error_free_sysfs:
1175
	iio_device_unregister_sysfs(indio_dev);
1176 1177
error_unreg_debugfs:
	iio_device_unregister_debugfs(indio_dev);
1178 1179 1180 1181 1182
error_ret:
	return ret;
}
EXPORT_SYMBOL(iio_device_register);

1183 1184 1185 1186
/**
 * iio_device_unregister() - unregister a device from the IIO subsystem
 * @indio_dev:		Device structure representing the device.
 **/
1187
void iio_device_unregister(struct iio_dev *indio_dev)
1188
{
1189
	mutex_lock(&indio_dev->info_exist_lock);
1190 1191 1192

	device_del(&indio_dev->dev);

1193 1194
	if (indio_dev->chrdev.dev)
		cdev_del(&indio_dev->chrdev);
1195
	iio_device_unregister_debugfs(indio_dev);
1196

1197 1198
	iio_disable_all_buffers(indio_dev);

1199
	indio_dev->info = NULL;
1200 1201 1202 1203

	iio_device_wakeup_eventset(indio_dev);
	iio_buffer_wakeup_poll(indio_dev);

1204
	mutex_unlock(&indio_dev->info_exist_lock);
1205 1206
}
EXPORT_SYMBOL(iio_device_unregister);
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265

static void devm_iio_device_unreg(struct device *dev, void *res)
{
	iio_device_unregister(*(struct iio_dev **)res);
}

/**
 * devm_iio_device_register - Resource-managed iio_device_register()
 * @dev:	Device to allocate iio_dev for
 * @indio_dev:	Device structure filled by the device driver
 *
 * Managed iio_device_register.  The IIO device registered with this
 * function is automatically unregistered on driver detach. This function
 * calls iio_device_register() internally. Refer to that function for more
 * information.
 *
 * If an iio_dev registered with this function needs to be unregistered
 * separately, devm_iio_device_unregister() must be used.
 *
 * RETURNS:
 * 0 on success, negative error number on failure.
 */
int devm_iio_device_register(struct device *dev, struct iio_dev *indio_dev)
{
	struct iio_dev **ptr;
	int ret;

	ptr = devres_alloc(devm_iio_device_unreg, sizeof(*ptr), GFP_KERNEL);
	if (!ptr)
		return -ENOMEM;

	*ptr = indio_dev;
	ret = iio_device_register(indio_dev);
	if (!ret)
		devres_add(dev, ptr);
	else
		devres_free(ptr);

	return ret;
}
EXPORT_SYMBOL_GPL(devm_iio_device_register);

/**
 * devm_iio_device_unregister - Resource-managed iio_device_unregister()
 * @dev:	Device this iio_dev belongs to
 * @indio_dev:	the iio_dev associated with the device
 *
 * Unregister iio_dev registered with devm_iio_device_register().
 */
void devm_iio_device_unregister(struct device *dev, struct iio_dev *indio_dev)
{
	int rc;

	rc = devres_release(dev, devm_iio_device_unreg,
			    devm_iio_device_match, indio_dev);
	WARN_ON(rc);
}
EXPORT_SYMBOL_GPL(devm_iio_device_unregister);

1266 1267 1268
subsys_initcall(iio_init);
module_exit(iio_exit);

1269
MODULE_AUTHOR("Jonathan Cameron <jic23@kernel.org>");
1270 1271
MODULE_DESCRIPTION("Industrial I/O core");
MODULE_LICENSE("GPL");