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