1 // SPDX-License-Identifier: GPL-2.0-only
2 /* IIO - useful set of util functionality
4 * Copyright (c) 2008 Jonathan Cameron
13 #include "iio_utils.h"
15 const char *iio_dir
= "/sys/bus/iio/devices/";
17 static char * const iio_direction
[] = {
23 * iioutils_break_up_name() - extract generic name from full channel name
24 * @full_name: the full channel name
25 * @generic_name: the output generic channel name
27 * Returns 0 on success, or a negative error code if string extraction failed.
29 int iioutils_break_up_name(const char *full_name
, char **generic_name
)
33 char *working
, *prefix
= "";
36 for (i
= 0; i
< ARRAY_SIZE(iio_direction
); i
++)
37 if (!strncmp(full_name
, iio_direction
[i
],
38 strlen(iio_direction
[i
]))) {
39 prefix
= iio_direction
[i
];
43 current
= strdup(full_name
+ strlen(prefix
) + 1);
47 working
= strtok(current
, "_\0");
65 ret
= asprintf(generic_name
, "%s_%s", prefix
, working
);
68 return (ret
== -1) ? -ENOMEM
: 0;
72 * iioutils_get_type() - find and process _type attribute data
73 * @is_signed: output whether channel is signed
74 * @bytes: output how many bytes the channel storage occupies
75 * @bits_used: output number of valid bits of data
76 * @shift: output amount of bits to shift right data before applying bit mask
77 * @mask: output a bit mask for the raw data
78 * @be: output if data in big endian
79 * @device_dir: the IIO device directory
80 * @buffer_idx: the IIO buffer index
81 * @name: the channel name
82 * @generic_name: the channel type name
84 * Returns a value >= 0 on success, otherwise a negative error code.
86 static int iioutils_get_type(unsigned int *is_signed
, unsigned int *bytes
,
87 unsigned int *bits_used
, unsigned int *shift
,
88 uint64_t *mask
, unsigned int *be
,
89 const char *device_dir
, int buffer_idx
,
90 const char *name
, const char *generic_name
)
95 char *scan_el_dir
, *builtname
, *builtname_generic
, *filename
= 0;
96 char signchar
, endianchar
;
98 const struct dirent
*ent
;
100 ret
= asprintf(&scan_el_dir
, FORMAT_SCAN_ELEMENTS_DIR
, device_dir
, buffer_idx
);
104 ret
= asprintf(&builtname
, FORMAT_TYPE_FILE
, name
);
107 goto error_free_scan_el_dir
;
109 ret
= asprintf(&builtname_generic
, FORMAT_TYPE_FILE
, generic_name
);
112 goto error_free_builtname
;
115 dp
= opendir(scan_el_dir
);
118 goto error_free_builtname_generic
;
122 while (ent
= readdir(dp
), ent
)
123 if ((strcmp(builtname
, ent
->d_name
) == 0) ||
124 (strcmp(builtname_generic
, ent
->d_name
) == 0)) {
125 ret
= asprintf(&filename
,
126 "%s/%s", scan_el_dir
, ent
->d_name
);
132 sysfsfp
= fopen(filename
, "r");
135 fprintf(stderr
, "failed to open %s\n",
137 goto error_free_filename
;
140 ret
= fscanf(sysfsfp
,
149 "failed to pass scan type description\n");
150 goto error_close_sysfsfp
;
151 } else if (ret
!= 5) {
154 "scan type description didn't match\n");
155 goto error_close_sysfsfp
;
158 *be
= (endianchar
== 'b');
160 if (*bits_used
== 64)
163 *mask
= (1ULL << *bits_used
) - 1ULL;
165 *is_signed
= (signchar
== 's');
166 if (fclose(sysfsfp
)) {
168 fprintf(stderr
, "Failed to close %s\n",
170 goto error_free_filename
;
178 * Avoid having a more generic entry overwriting
181 if (strcmp(builtname
, ent
->d_name
) == 0)
188 perror("iioutils_get_type(): Failed to close file");
195 if (closedir(dp
) == -1)
196 perror("iioutils_get_type(): Failed to close directory");
198 error_free_builtname_generic
:
199 free(builtname_generic
);
200 error_free_builtname
:
202 error_free_scan_el_dir
:
209 * iioutils_get_param_float() - read a float value from a channel parameter
210 * @output: output the float value
211 * @param_name: the parameter name to read
212 * @device_dir: the IIO device directory in sysfs
213 * @name: the channel name
214 * @generic_name: the channel type name
216 * Returns a value >= 0 on success, otherwise a negative error code.
218 int iioutils_get_param_float(float *output
, const char *param_name
,
219 const char *device_dir
, const char *name
,
220 const char *generic_name
)
225 char *builtname
, *builtname_generic
;
226 char *filename
= NULL
;
227 const struct dirent
*ent
;
229 ret
= asprintf(&builtname
, "%s_%s", name
, param_name
);
233 ret
= asprintf(&builtname_generic
,
234 "%s_%s", generic_name
, param_name
);
237 goto error_free_builtname
;
240 dp
= opendir(device_dir
);
243 goto error_free_builtname_generic
;
247 while (ent
= readdir(dp
), ent
)
248 if ((strcmp(builtname
, ent
->d_name
) == 0) ||
249 (strcmp(builtname_generic
, ent
->d_name
) == 0)) {
250 ret
= asprintf(&filename
,
251 "%s/%s", device_dir
, ent
->d_name
);
257 sysfsfp
= fopen(filename
, "r");
260 goto error_free_filename
;
264 if (fscanf(sysfsfp
, "%f", output
) != 1)
265 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 * @buffer_idx: the IIO buffer for this channel array
310 * @ci_array: output the resulting array of iio_channel_info
311 * @counter: output the amount of array elements
313 * Returns 0 on success, otherwise a negative error code.
315 int build_channel_array(const char *device_dir
, int buffer_idx
,
316 struct iio_channel_info
**ci_array
, int *counter
)
321 struct iio_channel_info
*current
;
323 const struct dirent
*ent
;
328 ret
= asprintf(&scan_el_dir
, FORMAT_SCAN_ELEMENTS_DIR
, device_dir
, buffer_idx
);
332 dp
= opendir(scan_el_dir
);
335 goto error_free_name
;
338 while (ent
= readdir(dp
), ent
)
339 if (strcmp(ent
->d_name
+ strlen(ent
->d_name
) - strlen("_en"),
341 ret
= asprintf(&filename
,
342 "%s/%s", scan_el_dir
, ent
->d_name
);
345 goto error_close_dir
;
348 sysfsfp
= fopen(filename
, "r");
352 goto error_close_dir
;
356 if (fscanf(sysfsfp
, "%i", &ret
) != 1) {
357 ret
= errno
? -errno
: -ENODATA
;
359 perror("build_channel_array(): Failed to close file");
361 goto error_close_dir
;
366 if (fclose(sysfsfp
)) {
368 goto error_close_dir
;
373 *ci_array
= malloc(sizeof(**ci_array
) * (*counter
));
376 goto error_close_dir
;
380 while (ent
= readdir(dp
), ent
) {
381 if (strcmp(ent
->d_name
+ strlen(ent
->d_name
) - strlen("_en"),
383 int current_enabled
= 0;
385 current
= &(*ci_array
)[count
++];
386 ret
= asprintf(&filename
,
387 "%s/%s", scan_el_dir
, ent
->d_name
);
390 /* decrement count to avoid freeing name */
392 goto error_cleanup_array
;
395 sysfsfp
= fopen(filename
, "r");
400 goto error_cleanup_array
;
404 if (fscanf(sysfsfp
, "%i", ¤t_enabled
) != 1) {
405 ret
= errno
? -errno
: -ENODATA
;
407 goto error_cleanup_array
;
410 if (fclose(sysfsfp
)) {
413 goto error_cleanup_array
;
416 if (!current_enabled
) {
421 current
->scale
= 1.0;
423 current
->name
= strndup(ent
->d_name
,
424 strlen(ent
->d_name
) -
426 if (!current
->name
) {
429 goto error_cleanup_array
;
432 /* Get the generic and specific name elements */
433 ret
= iioutils_break_up_name(current
->name
,
434 ¤t
->generic_name
);
438 goto error_cleanup_array
;
441 ret
= asprintf(&filename
,
447 goto error_cleanup_array
;
450 sysfsfp
= fopen(filename
, "r");
454 fprintf(stderr
, "failed to open %s/%s_index\n",
455 scan_el_dir
, current
->name
);
456 goto error_cleanup_array
;
460 if (fscanf(sysfsfp
, "%u", ¤t
->index
) != 1) {
461 ret
= errno
? -errno
: -ENODATA
;
463 perror("build_channel_array(): Failed to close file");
465 goto error_cleanup_array
;
468 if (fclose(sysfsfp
)) {
470 goto error_cleanup_array
;
474 ret
= iioutils_get_param_float(¤t
->scale
,
478 current
->generic_name
);
479 if ((ret
< 0) && (ret
!= -ENOENT
))
480 goto error_cleanup_array
;
482 ret
= iioutils_get_param_float(¤t
->offset
,
486 current
->generic_name
);
487 if ((ret
< 0) && (ret
!= -ENOENT
))
488 goto error_cleanup_array
;
490 ret
= iioutils_get_type(¤t
->is_signed
,
499 current
->generic_name
);
501 goto error_cleanup_array
;
505 if (closedir(dp
) == -1) {
507 goto error_cleanup_array
;
511 /* reorder so that the array is in index order */
512 bsort_channel_array_by_index(*ci_array
, *counter
);
517 for (i
= count
- 1; i
>= 0; i
--) {
518 free((*ci_array
)[i
].name
);
519 free((*ci_array
)[i
].generic_name
);
526 if (closedir(dp
) == -1)
527 perror("build_channel_array(): Failed to close dir");
535 static int calc_digits(int num
)
539 /* It takes a digit to represent zero */
552 * find_type_by_name() - function to match top level types by name
553 * @name: top level type instance name
554 * @type: the type of top level instance being searched
556 * Returns the device number of a matched IIO device on success, otherwise a
557 * negative error code.
558 * Typical types this is used for are device and trigger.
560 int find_type_by_name(const char *name
, const char *type
)
562 const struct dirent
*ent
;
563 int number
, numstrlen
, ret
;
567 char thisname
[IIO_MAX_NAME_LENGTH
];
570 dp
= opendir(iio_dir
);
572 fprintf(stderr
, "No industrialio devices available\n");
576 while (ent
= readdir(dp
), ent
) {
577 if (strcmp(ent
->d_name
, ".") != 0 &&
578 strcmp(ent
->d_name
, "..") != 0 &&
579 strlen(ent
->d_name
) > strlen(type
) &&
580 strncmp(ent
->d_name
, type
, strlen(type
)) == 0) {
582 ret
= sscanf(ent
->d_name
+ strlen(type
), "%d", &number
);
586 "failed to read element number\n");
587 goto error_close_dir
;
588 } else if (ret
!= 1) {
591 "failed to match element number\n");
592 goto error_close_dir
;
595 numstrlen
= calc_digits(number
);
596 /* verify the next character is not a colon */
597 if (strncmp(ent
->d_name
+ strlen(type
) + numstrlen
,
599 filename
= malloc(strlen(iio_dir
) + strlen(type
)
603 goto error_close_dir
;
606 ret
= sprintf(filename
, "%s%s%d/name", iio_dir
,
610 goto error_close_dir
;
613 namefp
= fopen(filename
, "r");
621 if (fscanf(namefp
, "%s", thisname
) != 1) {
622 ret
= errno
? -errno
: -ENODATA
;
623 goto error_close_dir
;
626 if (fclose(namefp
)) {
628 goto error_close_dir
;
631 if (strcmp(name
, thisname
) == 0) {
632 if (closedir(dp
) == -1)
640 if (closedir(dp
) == -1)
646 if (closedir(dp
) == -1)
647 perror("find_type_by_name(): Failed to close directory");
652 static int _write_sysfs_int(const char *filename
, const char *basedir
, int val
,
658 char *temp
= malloc(strlen(basedir
) + strlen(filename
) + 2);
663 ret
= sprintf(temp
, "%s/%s", basedir
, filename
);
667 sysfsfp
= fopen(temp
, "w");
670 fprintf(stderr
, "failed to open %s\n", temp
);
674 ret
= fprintf(sysfsfp
, "%d", val
);
677 perror("_write_sysfs_int(): Failed to close dir");
682 if (fclose(sysfsfp
)) {
688 sysfsfp
= fopen(temp
, "r");
691 fprintf(stderr
, "failed to open %s\n", temp
);
695 if (fscanf(sysfsfp
, "%d", &test
) != 1) {
696 ret
= errno
? -errno
: -ENODATA
;
698 perror("_write_sysfs_int(): Failed to close dir");
703 if (fclose(sysfsfp
)) {
710 "Possible failure in int write %d to %s/%s\n",
711 val
, basedir
, filename
);
722 * write_sysfs_int() - write an integer value to a sysfs file
723 * @filename: name of the file to write to
724 * @basedir: the sysfs directory in which the file is to be found
725 * @val: integer value to write to file
727 * Returns a value >= 0 on success, otherwise a negative error code.
729 int write_sysfs_int(const char *filename
, const char *basedir
, int val
)
731 return _write_sysfs_int(filename
, basedir
, val
, 0);
735 * write_sysfs_int_and_verify() - write an integer value to a sysfs file
737 * @filename: name of the file to write to
738 * @basedir: the sysfs directory in which the file is to be found
739 * @val: integer value to write to file
741 * Returns a value >= 0 on success, otherwise a negative error code.
743 int write_sysfs_int_and_verify(const char *filename
, const char *basedir
,
746 return _write_sysfs_int(filename
, basedir
, val
, 1);
749 static int _write_sysfs_string(const char *filename
, const char *basedir
,
750 const char *val
, int verify
)
754 char *temp
= malloc(strlen(basedir
) + strlen(filename
) + 2);
757 fprintf(stderr
, "Memory allocation failed\n");
761 ret
= sprintf(temp
, "%s/%s", basedir
, filename
);
765 sysfsfp
= fopen(temp
, "w");
768 fprintf(stderr
, "Could not open %s\n", temp
);
772 ret
= fprintf(sysfsfp
, "%s", val
);
775 perror("_write_sysfs_string(): Failed to close dir");
780 if (fclose(sysfsfp
)) {
786 sysfsfp
= fopen(temp
, "r");
789 fprintf(stderr
, "Could not open file to verify\n");
793 if (fscanf(sysfsfp
, "%s", temp
) != 1) {
794 ret
= errno
? -errno
: -ENODATA
;
796 perror("_write_sysfs_string(): Failed to close dir");
801 if (fclose(sysfsfp
)) {
806 if (strcmp(temp
, val
) != 0) {
808 "Possible failure in string write of %s "
809 "Should be %s written to %s/%s\n", temp
, val
,
822 * write_sysfs_string_and_verify() - string write, readback and verify
823 * @filename: name of file to write to
824 * @basedir: the sysfs directory in which the file is to be found
825 * @val: the string to write
827 * Returns a value >= 0 on success, otherwise a negative error code.
829 int write_sysfs_string_and_verify(const char *filename
, const char *basedir
,
832 return _write_sysfs_string(filename
, basedir
, val
, 1);
836 * write_sysfs_string() - write string to a sysfs file
837 * @filename: name of file to write to
838 * @basedir: the sysfs directory in which the file is to be found
839 * @val: the string to write
841 * Returns a value >= 0 on success, otherwise a negative error code.
843 int write_sysfs_string(const char *filename
, const char *basedir
,
846 return _write_sysfs_string(filename
, basedir
, val
, 0);
850 * read_sysfs_posint() - read an integer value from file
851 * @filename: name of file to read from
852 * @basedir: the sysfs directory in which the file is to be found
854 * Returns the read integer value >= 0 on success, otherwise a negative error
857 int read_sysfs_posint(const char *filename
, const char *basedir
)
861 char *temp
= malloc(strlen(basedir
) + strlen(filename
) + 2);
864 fprintf(stderr
, "Memory allocation failed");
868 ret
= sprintf(temp
, "%s/%s", basedir
, filename
);
872 sysfsfp
= fopen(temp
, "r");
879 if (fscanf(sysfsfp
, "%d\n", &ret
) != 1) {
880 ret
= errno
? -errno
: -ENODATA
;
882 perror("read_sysfs_posint(): Failed to close dir");
897 * read_sysfs_float() - read a float value from file
898 * @filename: name of file to read from
899 * @basedir: the sysfs directory in which the file is to be found
900 * @val: output the read float value
902 * Returns a value >= 0 on success, otherwise a negative error code.
904 int read_sysfs_float(const char *filename
, const char *basedir
, float *val
)
908 char *temp
= malloc(strlen(basedir
) + strlen(filename
) + 2);
911 fprintf(stderr
, "Memory allocation failed");
915 ret
= sprintf(temp
, "%s/%s", basedir
, filename
);
919 sysfsfp
= fopen(temp
, "r");
926 if (fscanf(sysfsfp
, "%f\n", val
) != 1) {
927 ret
= errno
? -errno
: -ENODATA
;
929 perror("read_sysfs_float(): Failed to close dir");
944 * read_sysfs_string() - read a string from file
945 * @filename: name of file to read from
946 * @basedir: the sysfs directory in which the file is to be found
947 * @str: output the read string
949 * Returns a value >= 0 on success, otherwise a negative error code.
951 int read_sysfs_string(const char *filename
, const char *basedir
, char *str
)
955 char *temp
= malloc(strlen(basedir
) + strlen(filename
) + 2);
958 fprintf(stderr
, "Memory allocation failed");
962 ret
= sprintf(temp
, "%s/%s", basedir
, filename
);
966 sysfsfp
= fopen(temp
, "r");
973 if (fscanf(sysfsfp
, "%s\n", str
) != 1) {
974 ret
= errno
? -errno
: -ENODATA
;
976 perror("read_sysfs_string(): Failed to close dir");