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