tools/iio/iio_event_monitor.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /* Industrialio event test code.
   3  *
   4  * Copyright (c) 2011-2012 Lars-Peter Clausen <lars@metafoo.de>
   5  *
   6  * This program is primarily intended as an example application.
   7  * Reads the current buffer setup from sysfs and starts a short capture
   8  * from the specified device, pretty printing the result after appropriate
   9  * conversion.
  10  *
  11  * Usage:
  12  *      iio_event_monitor <device_name>
  13  */
  14
  15 #include <unistd.h>
  16 #include <stdlib.h>
  17 #include <dirent.h>
  18 #include <stdbool.h>
  19 #include <stdio.h>
  20 #include <errno.h>
  21 #include <string.h>
  22 #include <poll.h>
  23 #include <fcntl.h>
  24 #include <sys/ioctl.h>
  25 #include "iio_utils.h"
  26 #include <linux/iio/events.h>
  27 #include <linux/iio/types.h>
  28
  29 static const char * const iio_chan_type_name_spec[] = {
  30         [IIO_VOLTAGE] = "voltage",
  31         [IIO_CURRENT] = "current",
  32         [IIO_POWER] = "power",
  33         [IIO_ACCEL] = "accel",
  34         [IIO_ANGL_VEL] = "anglvel",
  35         [IIO_MAGN] = "magn",
  36         [IIO_LIGHT] = "illuminance",
  37         [IIO_INTENSITY] = "intensity",
  38         [IIO_PROXIMITY] = "proximity",
  39         [IIO_TEMP] = "temp",
  40         [IIO_INCLI] = "incli",
  41         [IIO_ROT] = "rot",
  42         [IIO_ANGL] = "angl",
  43         [IIO_TIMESTAMP] = "timestamp",
  44         [IIO_CAPACITANCE] = "capacitance",
  45         [IIO_ALTVOLTAGE] = "altvoltage",
  46         [IIO_CCT] = "cct",
  47         [IIO_PRESSURE] = "pressure",
  48         [IIO_HUMIDITYRELATIVE] = "humidityrelative",
  49         [IIO_ACTIVITY] = "activity",
  50         [IIO_STEPS] = "steps",
  51         [IIO_ENERGY] = "energy",
  52         [IIO_DISTANCE] = "distance",
  53         [IIO_VELOCITY] = "velocity",
  54         [IIO_CONCENTRATION] = "concentration",
  55         [IIO_RESISTANCE] = "resistance",
  56         [IIO_PH] = "ph",
  57         [IIO_UVINDEX] = "uvindex",
  58         [IIO_GRAVITY] = "gravity",
  59         [IIO_POSITIONRELATIVE] = "positionrelative",
  60         [IIO_PHASE] = "phase",
  61         [IIO_MASSCONCENTRATION] = "massconcentration",
  62         [IIO_DELTA_ANGL] = "deltaangl",
  63         [IIO_DELTA_VELOCITY] = "deltavelocity",
  64         [IIO_COLORTEMP] = "colortemp",
  65         [IIO_CHROMATICITY] = "chromaticity",
  66 };
  67
  68 static const char * const iio_ev_type_text[] = {
  69         [IIO_EV_TYPE_THRESH] = "thresh",
  70         [IIO_EV_TYPE_MAG] = "mag",
  71         [IIO_EV_TYPE_ROC] = "roc",
  72         [IIO_EV_TYPE_THRESH_ADAPTIVE] = "thresh_adaptive",
  73         [IIO_EV_TYPE_MAG_ADAPTIVE] = "mag_adaptive",
  74         [IIO_EV_TYPE_CHANGE] = "change",
  75         [IIO_EV_TYPE_MAG_REFERENCED] = "mag_referenced",
  76         [IIO_EV_TYPE_GESTURE] = "gesture",
  77 };
  78
  79 static const char * const iio_ev_dir_text[] = {
  80         [IIO_EV_DIR_EITHER] = "either",
  81         [IIO_EV_DIR_RISING] = "rising",
  82         [IIO_EV_DIR_FALLING] = "falling",
  83         [IIO_EV_DIR_SINGLETAP] = "singletap",
  84         [IIO_EV_DIR_DOUBLETAP] = "doubletap",
  85 };
  86
  87 static const char * const iio_modifier_names[] = {
  88         [IIO_MOD_X] = "x",
  89         [IIO_MOD_Y] = "y",
  90         [IIO_MOD_Z] = "z",
  91         [IIO_MOD_X_AND_Y] = "x&y",
  92         [IIO_MOD_X_AND_Z] = "x&z",
  93         [IIO_MOD_Y_AND_Z] = "y&z",
  94         [IIO_MOD_X_AND_Y_AND_Z] = "x&y&z",
  95         [IIO_MOD_X_OR_Y] = "x|y",
  96         [IIO_MOD_X_OR_Z] = "x|z",
  97         [IIO_MOD_Y_OR_Z] = "y|z",
  98         [IIO_MOD_X_OR_Y_OR_Z] = "x|y|z",
  99         [IIO_MOD_LIGHT_BOTH] = "both",
 100         [IIO_MOD_LIGHT_IR] = "ir",
 101         [IIO_MOD_ROOT_SUM_SQUARED_X_Y] = "sqrt(x^2+y^2)",
 102         [IIO_MOD_SUM_SQUARED_X_Y_Z] = "x^2+y^2+z^2",
 103         [IIO_MOD_LIGHT_CLEAR] = "clear",
 104         [IIO_MOD_LIGHT_RED] = "red",
 105         [IIO_MOD_LIGHT_GREEN] = "green",
 106         [IIO_MOD_LIGHT_BLUE] = "blue",
 107         [IIO_MOD_LIGHT_UV] = "uv",
 108         [IIO_MOD_LIGHT_UVA] = "uva",
 109         [IIO_MOD_LIGHT_UVB] = "uvb",
 110         [IIO_MOD_LIGHT_DUV] = "duv",
 111         [IIO_MOD_QUATERNION] = "quaternion",
 112         [IIO_MOD_TEMP_AMBIENT] = "ambient",
 113         [IIO_MOD_TEMP_OBJECT] = "object",
 114         [IIO_MOD_NORTH_MAGN] = "from_north_magnetic",
 115         [IIO_MOD_NORTH_TRUE] = "from_north_true",
 116         [IIO_MOD_NORTH_MAGN_TILT_COMP] = "from_north_magnetic_tilt_comp",
 117         [IIO_MOD_NORTH_TRUE_TILT_COMP] = "from_north_true_tilt_comp",
 118         [IIO_MOD_RUNNING] = "running",
 119         [IIO_MOD_JOGGING] = "jogging",
 120         [IIO_MOD_WALKING] = "walking",
 121         [IIO_MOD_STILL] = "still",
 122         [IIO_MOD_ROOT_SUM_SQUARED_X_Y_Z] = "sqrt(x^2+y^2+z^2)",
 123         [IIO_MOD_I] = "i",
 124         [IIO_MOD_Q] = "q",
 125         [IIO_MOD_CO2] = "co2",
 126         [IIO_MOD_ETHANOL] = "ethanol",
 127         [IIO_MOD_H2] = "h2",
 128         [IIO_MOD_VOC] = "voc",
 129         [IIO_MOD_PM1] = "pm1",
 130         [IIO_MOD_PM2P5] = "pm2p5",
 131         [IIO_MOD_PM4] = "pm4",
 132         [IIO_MOD_PM10] = "pm10",
 133         [IIO_MOD_O2] = "o2",
 134         [IIO_MOD_LINEAR_X] = "linear_x",
 135         [IIO_MOD_LINEAR_Y] = "linear_y",
 136         [IIO_MOD_LINEAR_Z] = "linear_z",
 137         [IIO_MOD_PITCH] = "pitch",
 138         [IIO_MOD_YAW] = "yaw",
 139         [IIO_MOD_ROLL] = "roll",
 140 };
 141
 142 static bool event_is_known(struct iio_event_data *event)
 143 {
 144         enum iio_chan_type type = IIO_EVENT_CODE_EXTRACT_CHAN_TYPE(event->id);
 145         enum iio_modifier mod = IIO_EVENT_CODE_EXTRACT_MODIFIER(event->id);
 146         enum iio_event_type ev_type = IIO_EVENT_CODE_EXTRACT_TYPE(event->id);
 147         enum iio_event_direction dir = IIO_EVENT_CODE_EXTRACT_DIR(event->id);
 148
 149         switch (type) {
 150         case IIO_VOLTAGE:
 151         case IIO_CURRENT:
 152         case IIO_POWER:
 153         case IIO_ACCEL:
 154         case IIO_ANGL_VEL:
 155         case IIO_MAGN:
 156         case IIO_LIGHT:
 157         case IIO_INTENSITY:
 158         case IIO_PROXIMITY:
 159         case IIO_TEMP:
 160         case IIO_INCLI:
 161         case IIO_ROT:
 162         case IIO_ANGL:
 163         case IIO_TIMESTAMP:
 164         case IIO_CAPACITANCE:
 165         case IIO_ALTVOLTAGE:
 166         case IIO_CCT:
 167         case IIO_PRESSURE:
 168         case IIO_HUMIDITYRELATIVE:
 169         case IIO_ACTIVITY:
 170         case IIO_STEPS:
 171         case IIO_ENERGY:
 172         case IIO_DISTANCE:
 173         case IIO_VELOCITY:
 174         case IIO_CONCENTRATION:
 175         case IIO_RESISTANCE:
 176         case IIO_PH:
 177         case IIO_UVINDEX:
 178         case IIO_GRAVITY:
 179         case IIO_POSITIONRELATIVE:
 180         case IIO_PHASE:
 181         case IIO_MASSCONCENTRATION:
 182         case IIO_DELTA_ANGL:
 183         case IIO_DELTA_VELOCITY:
 184         case IIO_COLORTEMP:
 185         case IIO_CHROMATICITY:
 186                 break;
 187         default:
 188                 return false;
 189         }
 190
 191         switch (mod) {
 192         case IIO_NO_MOD:
 193         case IIO_MOD_X:
 194         case IIO_MOD_Y:
 195         case IIO_MOD_Z:
 196         case IIO_MOD_X_AND_Y:
 197         case IIO_MOD_X_AND_Z:
 198         case IIO_MOD_Y_AND_Z:
 199         case IIO_MOD_X_AND_Y_AND_Z:
 200         case IIO_MOD_X_OR_Y:
 201         case IIO_MOD_X_OR_Z:
 202         case IIO_MOD_Y_OR_Z:
 203         case IIO_MOD_X_OR_Y_OR_Z:
 204         case IIO_MOD_LIGHT_BOTH:
 205         case IIO_MOD_LIGHT_IR:
 206         case IIO_MOD_ROOT_SUM_SQUARED_X_Y:
 207         case IIO_MOD_SUM_SQUARED_X_Y_Z:
 208         case IIO_MOD_LIGHT_CLEAR:
 209         case IIO_MOD_LIGHT_RED:
 210         case IIO_MOD_LIGHT_GREEN:
 211         case IIO_MOD_LIGHT_BLUE:
 212         case IIO_MOD_LIGHT_UV:
 213         case IIO_MOD_LIGHT_DUV:
 214         case IIO_MOD_QUATERNION:
 215         case IIO_MOD_TEMP_AMBIENT:
 216         case IIO_MOD_TEMP_OBJECT:
 217         case IIO_MOD_NORTH_MAGN:
 218         case IIO_MOD_NORTH_TRUE:
 219         case IIO_MOD_NORTH_MAGN_TILT_COMP:
 220         case IIO_MOD_NORTH_TRUE_TILT_COMP:
 221         case IIO_MOD_RUNNING:
 222         case IIO_MOD_JOGGING:
 223         case IIO_MOD_WALKING:
 224         case IIO_MOD_STILL:
 225         case IIO_MOD_ROOT_SUM_SQUARED_X_Y_Z:
 226         case IIO_MOD_I:
 227         case IIO_MOD_Q:
 228         case IIO_MOD_CO2:
 229         case IIO_MOD_ETHANOL:
 230         case IIO_MOD_H2:
 231         case IIO_MOD_VOC:
 232         case IIO_MOD_PM1:
 233         case IIO_MOD_PM2P5:
 234         case IIO_MOD_PM4:
 235         case IIO_MOD_PM10:
 236         case IIO_MOD_O2:
 237                 break;
 238         default:
 239                 return false;
 240         }
 241
 242         switch (ev_type) {
 243         case IIO_EV_TYPE_THRESH:
 244         case IIO_EV_TYPE_MAG:
 245         case IIO_EV_TYPE_ROC:
 246         case IIO_EV_TYPE_THRESH_ADAPTIVE:
 247         case IIO_EV_TYPE_MAG_ADAPTIVE:
 248         case IIO_EV_TYPE_CHANGE:
 249         case IIO_EV_TYPE_GESTURE:
 250                 break;
 251         default:
 252                 return false;
 253         }
 254
 255         switch (dir) {
 256         case IIO_EV_DIR_EITHER:
 257         case IIO_EV_DIR_RISING:
 258         case IIO_EV_DIR_FALLING:
 259         case IIO_EV_DIR_SINGLETAP:
 260         case IIO_EV_DIR_DOUBLETAP:
 261         case IIO_EV_DIR_NONE:
 262                 break;
 263         default:
 264                 return false;
 265         }
 266
 267         return true;
 268 }
 269
 270 static void print_event(struct iio_event_data *event)
 271 {
 272         enum iio_chan_type type = IIO_EVENT_CODE_EXTRACT_CHAN_TYPE(event->id);
 273         enum iio_modifier mod = IIO_EVENT_CODE_EXTRACT_MODIFIER(event->id);
 274         enum iio_event_type ev_type = IIO_EVENT_CODE_EXTRACT_TYPE(event->id);
 275         enum iio_event_direction dir = IIO_EVENT_CODE_EXTRACT_DIR(event->id);
 276         int chan = IIO_EVENT_CODE_EXTRACT_CHAN(event->id);
 277         int chan2 = IIO_EVENT_CODE_EXTRACT_CHAN2(event->id);
 278         bool diff = IIO_EVENT_CODE_EXTRACT_DIFF(event->id);
 279
 280         if (!event_is_known(event)) {
 281                 fprintf(stderr, "Unknown event: time: %lld, id: %llx\n",
 282                         event->timestamp, event->id);
 283
 284                 return;
 285         }
 286
 287         printf("Event: time: %lld, type: %s", event->timestamp,
 288                iio_chan_type_name_spec[type]);
 289
 290         if (mod != IIO_NO_MOD)
 291                 printf("(%s)", iio_modifier_names[mod]);
 292
 293         if (chan >= 0) {
 294                 printf(", channel: %d", chan);
 295                 if (diff && chan2 >= 0)
 296                         printf("-%d", chan2);
 297         }
 298
 299         printf(", evtype: %s", iio_ev_type_text[ev_type]);
 300
 301         if (dir != IIO_EV_DIR_NONE)
 302                 printf(", direction: %s", iio_ev_dir_text[dir]);
 303
 304         printf("\n");
 305         fflush(stdout);
 306 }
 307
 308 /* Enable or disable events in sysfs if the knob is available */
 309 static void enable_events(char *dev_dir, int enable)
 310 {
 311         const struct dirent *ent;
 312         char evdir[256];
 313         int ret;
 314         DIR *dp;
 315
 316         snprintf(evdir, sizeof(evdir), FORMAT_EVENTS_DIR, dev_dir);
 317         evdir[sizeof(evdir)-1] = '\0';
 318
 319         dp = opendir(evdir);
 320         if (!dp) {
 321                 fprintf(stderr, "Enabling/disabling events: can't open %s\n",
 322                         evdir);
 323                 return;
 324         }
 325
 326         while (ent = readdir(dp), ent) {
 327                 if (iioutils_check_suffix(ent->d_name, "_en")) {
 328                         printf("%sabling: %s\n",
 329                                enable ? "En" : "Dis",
 330                                ent->d_name);
 331                         ret = write_sysfs_int(ent->d_name, evdir,
 332                                               enable);
 333                         if (ret < 0)
 334                                 fprintf(stderr, "Failed to enable/disable %s\n",
 335                                         ent->d_name);
 336                 }
 337         }
 338
 339         if (closedir(dp) == -1) {
 340                 perror("Enabling/disabling channels: "
 341                        "Failed to close directory");
 342                 return;
 343         }
 344 }
 345
 346 int main(int argc, char **argv)
 347 {
 348         struct iio_event_data event;
 349         const char *device_name;
 350         char *dev_dir_name = NULL;
 351         char *chrdev_name;
 352         int ret;
 353         int dev_num;
 354         int fd, event_fd;
 355         bool all_events = false;
 356
 357         if (argc == 2) {
 358                 device_name = argv[1];
 359         } else if (argc == 3) {
 360                 device_name = argv[2];
 361                 if (!strcmp(argv[1], "-a"))
 362                         all_events = true;
 363         } else {
 364                 fprintf(stderr,
 365                         "Usage: iio_event_monitor [options] <device_name>\n"
 366                         "Listen and display events from IIO devices\n"
 367                         "  -a         Auto-activate all available events\n");
 368                 return -1;
 369         }
 370
 371         dev_num = find_type_by_name(device_name, "iio:device");
 372         if (dev_num >= 0) {
 373                 printf("Found IIO device with name %s with device number %d\n",
 374                        device_name, dev_num);
 375                 ret = asprintf(&chrdev_name, "/dev/iio:device%d", dev_num);
 376                 if (ret < 0)
 377                         return -ENOMEM;
 378                 /* Look up sysfs dir as well if we can */
 379                 ret = asprintf(&dev_dir_name, "%siio:device%d", iio_dir, dev_num);
 380                 if (ret < 0)
 381                         return -ENOMEM;
 382         } else {
 383                 /*
 384                  * If we can't find an IIO device by name assume device_name is
 385                  * an IIO chrdev
 386                  */
 387                 chrdev_name = strdup(device_name);
 388                 if (!chrdev_name)
 389                         return -ENOMEM;
 390         }
 391
 392         if (all_events && dev_dir_name)
 393                 enable_events(dev_dir_name, 1);
 394
 395         fd = open(chrdev_name, 0);
 396         if (fd == -1) {
 397                 ret = -errno;
 398                 fprintf(stderr, "Failed to open %s\n", chrdev_name);
 399                 goto error_free_chrdev_name;
 400         }
 401
 402         ret = ioctl(fd, IIO_GET_EVENT_FD_IOCTL, &event_fd);
 403         if (ret == -1 || event_fd == -1) {
 404                 ret = -errno;
 405                 if (ret == -ENODEV)
 406                         fprintf(stderr,
 407                                 "This device does not support events\n");
 408                 else
 409                         fprintf(stderr, "Failed to retrieve event fd\n");
 410                 if (close(fd) == -1)
 411                         perror("Failed to close character device file");
 412
 413                 goto error_free_chrdev_name;
 414         }
 415
 416         if (close(fd) == -1)  {
 417                 ret = -errno;
 418                 goto error_free_chrdev_name;
 419         }
 420
 421         while (true) {
 422                 ret = read(event_fd, &event, sizeof(event));
 423                 if (ret == -1) {
 424                         if (errno == EAGAIN) {
 425                                 fprintf(stderr, "nothing available\n");
 426                                 continue;
 427                         } else {
 428                                 ret = -errno;
 429                                 perror("Failed to read event from device");
 430                                 break;
 431                         }
 432                 }
 433
 434                 if (ret != sizeof(event)) {
 435                         fprintf(stderr, "Reading event failed!\n");
 436                         ret = -EIO;
 437                         break;
 438                 }
 439
 440                 print_event(&event);
 441         }
 442
 443         if (close(event_fd) == -1)
 444                 perror("Failed to close event file");
 445
 446 error_free_chrdev_name:
 447         /* Disable events after use */
 448         if (all_events && dev_dir_name)
 449                 enable_events(dev_dir_name, 0);
 450
 451         free(chrdev_name);
 452
 453         return ret;
 454 }