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