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