1 /* IIO - useful set of util functionality
3 * Copyright (c) 2008 Jonathan Cameron
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
16 #include "iio_utils.h"
18 const char *iio_dir = "/sys/bus/iio/devices/";
20 static char * const iio_direction[] = {
26 * iioutils_break_up_name() - extract generic name from full channel name
27 * @full_name: the full channel name
28 * @generic_name: the output generic channel name
30 * Returns 0 on success, or a negative error code if string extraction failed.
32 int iioutils_break_up_name(const char *full_name, char **generic_name)
36 char *working, *prefix = "";
39 for (i = 0; i < ARRAY_SIZE(iio_direction); i++)
40 if (!strncmp(full_name, iio_direction[i],
41 strlen(iio_direction[i]))) {
42 prefix = iio_direction[i];
46 current = strdup(full_name + strlen(prefix) + 1);
50 working = strtok(current, "_\0");
68 ret = asprintf(generic_name, "%s_%s", prefix, working);
71 return (ret == -1) ? -ENOMEM : 0;
75 * iioutils_get_type() - find and process _type attribute data
76 * @is_signed: output whether channel is signed
77 * @bytes: output how many bytes the channel storage occupies
78 * @bits_used: output number of valid bits of data
79 * @shift: output amount of bits to shift right data before applying bit mask
80 * @mask: output a bit mask for the raw data
81 * @be: output if data in big endian
82 * @device_dir: the IIO device directory
83 * @name: the channel name
84 * @generic_name: the channel type name
86 * Returns a value >= 0 on success, otherwise a negative error code.
88 int iioutils_get_type(unsigned *is_signed, unsigned *bytes, unsigned *bits_used,
89 unsigned *shift, uint64_t *mask, unsigned *be,
90 const char *device_dir, const char *name,
91 const char *generic_name)
96 char *scan_el_dir, *builtname, *builtname_generic, *filename = 0;
97 char signchar, endianchar;
99 const struct dirent *ent;
101 ret = asprintf(&scan_el_dir, FORMAT_SCAN_ELEMENTS_DIR, device_dir);
105 ret = asprintf(&builtname, FORMAT_TYPE_FILE, name);
108 goto error_free_scan_el_dir;
110 ret = asprintf(&builtname_generic, FORMAT_TYPE_FILE, generic_name);
113 goto error_free_builtname;
116 dp = opendir(scan_el_dir);
119 goto error_free_builtname_generic;
123 while (ent = readdir(dp), ent)
124 if ((strcmp(builtname, ent->d_name) == 0) ||
125 (strcmp(builtname_generic, ent->d_name) == 0)) {
126 ret = asprintf(&filename,
127 "%s/%s", scan_el_dir, ent->d_name);
133 sysfsfp = fopen(filename, "r");
136 fprintf(stderr, "failed to open %s\n",
138 goto error_free_filename;
141 ret = fscanf(sysfsfp,
150 "failed to pass scan type description\n");
151 goto error_close_sysfsfp;
152 } else if (ret != 5) {
155 "scan type description didn't match\n");
156 goto error_close_sysfsfp;
159 *be = (endianchar == 'b');
161 if (*bits_used == 64)
164 *mask = (1ULL << *bits_used) - 1ULL;
166 *is_signed = (signchar == 's');
167 if (fclose(sysfsfp)) {
169 fprintf(stderr, "Failed to close %s\n",
171 goto error_free_filename;
179 * Avoid having a more generic entry overwriting
182 if (strcmp(builtname, ent->d_name) == 0)
189 perror("iioutils_get_type(): Failed to close file");
196 if (closedir(dp) == -1)
197 perror("iioutils_get_type(): Failed to close directory");
199 error_free_builtname_generic:
200 free(builtname_generic);
201 error_free_builtname:
203 error_free_scan_el_dir:
210 * iioutils_get_param_float() - read a float value from a channel parameter
211 * @output: output the float value
212 * @param_name: the parameter name to read
213 * @device_dir: the IIO device directory in sysfs
214 * @name: the channel name
215 * @generic_name: the channel type name
217 * Returns a value >= 0 on success, otherwise a negative error code.
219 int iioutils_get_param_float(float *output, const char *param_name,
220 const char *device_dir, const char *name,
221 const char *generic_name)
226 char *builtname, *builtname_generic;
227 char *filename = NULL;
228 const struct dirent *ent;
230 ret = asprintf(&builtname, "%s_%s", name, param_name);
234 ret = asprintf(&builtname_generic,
235 "%s_%s", generic_name, param_name);
238 goto error_free_builtname;
241 dp = opendir(device_dir);
244 goto error_free_builtname_generic;
248 while (ent = readdir(dp), ent)
249 if ((strcmp(builtname, ent->d_name) == 0) ||
250 (strcmp(builtname_generic, ent->d_name) == 0)) {
251 ret = asprintf(&filename,
252 "%s/%s", device_dir, ent->d_name);
258 sysfsfp = fopen(filename, "r");
261 goto error_free_filename;
265 if (fscanf(sysfsfp, "%f", output) != 1)
266 ret = errno ? -errno : -ENODATA;
275 if (closedir(dp) == -1)
276 perror("iioutils_get_param_float(): Failed to close directory");
278 error_free_builtname_generic:
279 free(builtname_generic);
280 error_free_builtname:
287 * bsort_channel_array_by_index() - sort the array in index order
288 * @ci_array: the iio_channel_info array to be sorted
289 * @cnt: the amount of array elements
292 void bsort_channel_array_by_index(struct iio_channel_info *ci_array, int cnt)
294 struct iio_channel_info temp;
297 for (x = 0; x < cnt; x++)
298 for (y = 0; y < (cnt - 1); y++)
299 if (ci_array[y].index > ci_array[y + 1].index) {
300 temp = ci_array[y + 1];
301 ci_array[y + 1] = ci_array[y];
307 * build_channel_array() - function to figure out what channels are present
308 * @device_dir: the IIO device directory in sysfs
309 * @ci_array: output the resulting array of iio_channel_info
310 * @counter: output the amount of array elements
312 * Returns 0 on success, otherwise a negative error code.
314 int build_channel_array(const char *device_dir,
315 struct iio_channel_info **ci_array, int *counter)
320 struct iio_channel_info *current;
322 const struct dirent *ent;
327 ret = asprintf(&scan_el_dir, FORMAT_SCAN_ELEMENTS_DIR, device_dir);
331 dp = opendir(scan_el_dir);
334 goto error_free_name;
337 while (ent = readdir(dp), ent)
338 if (strcmp(ent->d_name + strlen(ent->d_name) - strlen("_en"),
340 ret = asprintf(&filename,
341 "%s/%s", scan_el_dir, ent->d_name);
344 goto error_close_dir;
347 sysfsfp = fopen(filename, "r");
351 goto error_close_dir;
355 if (fscanf(sysfsfp, "%i", &ret) != 1) {
356 ret = errno ? -errno : -ENODATA;
358 perror("build_channel_array(): Failed to close file");
361 goto error_close_dir;
366 if (fclose(sysfsfp)) {
369 goto error_close_dir;
375 *ci_array = malloc(sizeof(**ci_array) * (*counter));
378 goto error_close_dir;
382 while (ent = readdir(dp), ent) {
383 if (strcmp(ent->d_name + strlen(ent->d_name) - strlen("_en"),
385 int current_enabled = 0;
387 current = &(*ci_array)[count++];
388 ret = asprintf(&filename,
389 "%s/%s", scan_el_dir, ent->d_name);
392 /* decrement count to avoid freeing name */
394 goto error_cleanup_array;
397 sysfsfp = fopen(filename, "r");
402 goto error_cleanup_array;
406 if (fscanf(sysfsfp, "%i", ¤t_enabled) != 1) {
407 ret = errno ? -errno : -ENODATA;
410 goto error_cleanup_array;
413 if (fclose(sysfsfp)) {
417 goto error_cleanup_array;
420 if (!current_enabled) {
426 current->scale = 1.0;
428 current->name = strndup(ent->d_name,
429 strlen(ent->d_name) -
431 if (!current->name) {
435 goto error_cleanup_array;
438 /* Get the generic and specific name elements */
439 ret = iioutils_break_up_name(current->name,
440 ¤t->generic_name);
445 goto error_cleanup_array;
448 ret = asprintf(&filename,
455 goto error_cleanup_array;
458 sysfsfp = fopen(filename, "r");
461 fprintf(stderr, "failed to open %s\n",
464 goto error_cleanup_array;
468 if (fscanf(sysfsfp, "%u", ¤t->index) != 1) {
469 ret = errno ? -errno : -ENODATA;
471 perror("build_channel_array(): Failed to close file");
474 goto error_cleanup_array;
477 if (fclose(sysfsfp)) {
480 goto error_cleanup_array;
485 ret = iioutils_get_param_float(¤t->scale,
489 current->generic_name);
490 if ((ret < 0) && (ret != -ENOENT))
491 goto error_cleanup_array;
493 ret = iioutils_get_param_float(¤t->offset,
497 current->generic_name);
498 if ((ret < 0) && (ret != -ENOENT))
499 goto error_cleanup_array;
501 ret = iioutils_get_type(¤t->is_signed,
509 current->generic_name);
511 goto error_cleanup_array;
515 if (closedir(dp) == -1) {
517 goto error_cleanup_array;
521 /* reorder so that the array is in index order */
522 bsort_channel_array_by_index(*ci_array, *counter);
527 for (i = count - 1; i >= 0; i--) {
528 free((*ci_array)[i].name);
529 free((*ci_array)[i].generic_name);
536 if (closedir(dp) == -1)
537 perror("build_channel_array(): Failed to close dir");
545 static int calc_digits(int num)
549 /* It takes a digit to represent zero */
562 * find_type_by_name() - function to match top level types by name
563 * @name: top level type instance name
564 * @type: the type of top level instance being searched
566 * Returns the device number of a matched IIO device on success, otherwise a
567 * negative error code.
568 * Typical types this is used for are device and trigger.
570 int find_type_by_name(const char *name, const char *type)
572 const struct dirent *ent;
573 int number, numstrlen, ret;
577 char thisname[IIO_MAX_NAME_LENGTH];
580 dp = opendir(iio_dir);
582 fprintf(stderr, "No industrialio devices available\n");
586 while (ent = readdir(dp), ent) {
587 if (strcmp(ent->d_name, ".") != 0 &&
588 strcmp(ent->d_name, "..") != 0 &&
589 strlen(ent->d_name) > strlen(type) &&
590 strncmp(ent->d_name, type, strlen(type)) == 0) {
592 ret = sscanf(ent->d_name + strlen(type), "%d", &number);
596 "failed to read element number\n");
597 goto error_close_dir;
598 } else if (ret != 1) {
601 "failed to match element number\n");
602 goto error_close_dir;
605 numstrlen = calc_digits(number);
606 /* verify the next character is not a colon */
607 if (strncmp(ent->d_name + strlen(type) + numstrlen,
609 filename = malloc(strlen(iio_dir) + strlen(type)
613 goto error_close_dir;
616 ret = sprintf(filename, "%s%s%d/name", iio_dir,
620 goto error_close_dir;
623 namefp = fopen(filename, "r");
631 if (fscanf(namefp, "%s", thisname) != 1) {
632 ret = errno ? -errno : -ENODATA;
633 goto error_close_dir;
636 if (fclose(namefp)) {
638 goto error_close_dir;
641 if (strcmp(name, thisname) == 0) {
642 if (closedir(dp) == -1)
650 if (closedir(dp) == -1)
656 if (closedir(dp) == -1)
657 perror("find_type_by_name(): Failed to close directory");
662 static int _write_sysfs_int(const char *filename, const char *basedir, int val,
668 char *temp = malloc(strlen(basedir) + strlen(filename) + 2);
673 ret = sprintf(temp, "%s/%s", basedir, filename);
677 sysfsfp = fopen(temp, "w");
680 fprintf(stderr, "failed to open %s\n", temp);
684 ret = fprintf(sysfsfp, "%d", val);
687 perror("_write_sysfs_int(): Failed to close dir");
692 if (fclose(sysfsfp)) {
698 sysfsfp = fopen(temp, "r");
701 fprintf(stderr, "failed to open %s\n", temp);
705 if (fscanf(sysfsfp, "%d", &test) != 1) {
706 ret = errno ? -errno : -ENODATA;
708 perror("_write_sysfs_int(): Failed to close dir");
713 if (fclose(sysfsfp)) {
720 "Possible failure in int write %d to %s/%s\n",
721 val, basedir, filename);
732 * write_sysfs_int() - write an integer value to a sysfs file
733 * @filename: name of the file to write to
734 * @basedir: the sysfs directory in which the file is to be found
735 * @val: integer value to write to file
737 * Returns a value >= 0 on success, otherwise a negative error code.
739 int write_sysfs_int(const char *filename, const char *basedir, int val)
741 return _write_sysfs_int(filename, basedir, val, 0);
745 * write_sysfs_int_and_verify() - write an integer value to a sysfs file
747 * @filename: name of the file to write to
748 * @basedir: the sysfs directory in which the file is to be found
749 * @val: integer value to write to file
751 * Returns a value >= 0 on success, otherwise a negative error code.
753 int write_sysfs_int_and_verify(const char *filename, const char *basedir,
756 return _write_sysfs_int(filename, basedir, val, 1);
759 static int _write_sysfs_string(const char *filename, const char *basedir,
760 const char *val, int verify)
764 char *temp = malloc(strlen(basedir) + strlen(filename) + 2);
767 fprintf(stderr, "Memory allocation failed\n");
771 ret = sprintf(temp, "%s/%s", basedir, filename);
775 sysfsfp = fopen(temp, "w");
778 fprintf(stderr, "Could not open %s\n", temp);
782 ret = fprintf(sysfsfp, "%s", val);
785 perror("_write_sysfs_string(): Failed to close dir");
790 if (fclose(sysfsfp)) {
796 sysfsfp = fopen(temp, "r");
799 fprintf(stderr, "Could not open file to verify\n");
803 if (fscanf(sysfsfp, "%s", temp) != 1) {
804 ret = errno ? -errno : -ENODATA;
806 perror("_write_sysfs_string(): Failed to close dir");
811 if (fclose(sysfsfp)) {
816 if (strcmp(temp, val) != 0) {
818 "Possible failure in string write of %s "
819 "Should be %s written to %s/%s\n", temp, val,
832 * write_sysfs_string_and_verify() - string write, readback and verify
833 * @filename: name of file to write to
834 * @basedir: the sysfs directory in which the file is to be found
835 * @val: the string to write
837 * Returns a value >= 0 on success, otherwise a negative error code.
839 int write_sysfs_string_and_verify(const char *filename, const char *basedir,
842 return _write_sysfs_string(filename, basedir, val, 1);
846 * write_sysfs_string() - write string to a sysfs file
847 * @filename: name of file to write to
848 * @basedir: the sysfs directory in which the file is to be found
849 * @val: the string to write
851 * Returns a value >= 0 on success, otherwise a negative error code.
853 int write_sysfs_string(const char *filename, const char *basedir,
856 return _write_sysfs_string(filename, basedir, val, 0);
860 * read_sysfs_posint() - read an integer value from file
861 * @filename: name of file to read from
862 * @basedir: the sysfs directory in which the file is to be found
864 * Returns the read integer value >= 0 on success, otherwise a negative error
867 int read_sysfs_posint(const char *filename, const char *basedir)
871 char *temp = malloc(strlen(basedir) + strlen(filename) + 2);
874 fprintf(stderr, "Memory allocation failed");
878 ret = sprintf(temp, "%s/%s", basedir, filename);
882 sysfsfp = fopen(temp, "r");
889 if (fscanf(sysfsfp, "%d\n", &ret) != 1) {
890 ret = errno ? -errno : -ENODATA;
892 perror("read_sysfs_posint(): Failed to close dir");
907 * read_sysfs_float() - read a float value from file
908 * @filename: name of file to read from
909 * @basedir: the sysfs directory in which the file is to be found
910 * @val: output the read float value
912 * Returns a value >= 0 on success, otherwise a negative error code.
914 int read_sysfs_float(const char *filename, const char *basedir, float *val)
918 char *temp = malloc(strlen(basedir) + strlen(filename) + 2);
921 fprintf(stderr, "Memory allocation failed");
925 ret = sprintf(temp, "%s/%s", basedir, filename);
929 sysfsfp = fopen(temp, "r");
936 if (fscanf(sysfsfp, "%f\n", val) != 1) {
937 ret = errno ? -errno : -ENODATA;
939 perror("read_sysfs_float(): Failed to close dir");
954 * read_sysfs_string() - read a string from file
955 * @filename: name of file to read from
956 * @basedir: the sysfs directory in which the file is to be found
957 * @str: output the read string
959 * Returns a value >= 0 on success, otherwise a negative error code.
961 int read_sysfs_string(const char *filename, const char *basedir, char *str)
965 char *temp = malloc(strlen(basedir) + strlen(filename) + 2);
968 fprintf(stderr, "Memory allocation failed");
972 ret = sprintf(temp, "%s/%s", basedir, filename);
976 sysfsfp = fopen(temp, "r");
983 if (fscanf(sysfsfp, "%s\n", str) != 1) {
984 ret = errno ? -errno : -ENODATA;
986 perror("read_sysfs_string(): Failed to close dir");