xref: /openbmc/linux/tools/iio/iio_event_monitor.c (revision 6abeae2a)
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 <stdbool.h>
18 #include <stdio.h>
19 #include <errno.h>
20 #include <string.h>
21 #include <poll.h>
22 #include <fcntl.h>
23 #include <sys/ioctl.h>
24 #include "iio_utils.h"
25 #include <linux/iio/events.h>
26 #include <linux/iio/types.h>
27 
28 static const char * const iio_chan_type_name_spec[] = {
29 	[IIO_VOLTAGE] = "voltage",
30 	[IIO_CURRENT] = "current",
31 	[IIO_POWER] = "power",
32 	[IIO_ACCEL] = "accel",
33 	[IIO_ANGL_VEL] = "anglvel",
34 	[IIO_MAGN] = "magn",
35 	[IIO_LIGHT] = "illuminance",
36 	[IIO_INTENSITY] = "intensity",
37 	[IIO_PROXIMITY] = "proximity",
38 	[IIO_TEMP] = "temp",
39 	[IIO_INCLI] = "incli",
40 	[IIO_ROT] = "rot",
41 	[IIO_ANGL] = "angl",
42 	[IIO_TIMESTAMP] = "timestamp",
43 	[IIO_CAPACITANCE] = "capacitance",
44 	[IIO_ALTVOLTAGE] = "altvoltage",
45 	[IIO_CCT] = "cct",
46 	[IIO_PRESSURE] = "pressure",
47 	[IIO_HUMIDITYRELATIVE] = "humidityrelative",
48 	[IIO_ACTIVITY] = "activity",
49 	[IIO_STEPS] = "steps",
50 	[IIO_ENERGY] = "energy",
51 	[IIO_DISTANCE] = "distance",
52 	[IIO_VELOCITY] = "velocity",
53 	[IIO_CONCENTRATION] = "concentration",
54 	[IIO_RESISTANCE] = "resistance",
55 	[IIO_PH] = "ph",
56 	[IIO_UVINDEX] = "uvindex",
57 	[IIO_GRAVITY] = "gravity",
58 	[IIO_POSITIONRELATIVE] = "positionrelative",
59 	[IIO_PHASE] = "phase",
60 	[IIO_MASSCONCENTRATION] = "massconcentration",
61 };
62 
63 static const char * const iio_ev_type_text[] = {
64 	[IIO_EV_TYPE_THRESH] = "thresh",
65 	[IIO_EV_TYPE_MAG] = "mag",
66 	[IIO_EV_TYPE_ROC] = "roc",
67 	[IIO_EV_TYPE_THRESH_ADAPTIVE] = "thresh_adaptive",
68 	[IIO_EV_TYPE_MAG_ADAPTIVE] = "mag_adaptive",
69 	[IIO_EV_TYPE_CHANGE] = "change",
70 };
71 
72 static const char * const iio_ev_dir_text[] = {
73 	[IIO_EV_DIR_EITHER] = "either",
74 	[IIO_EV_DIR_RISING] = "rising",
75 	[IIO_EV_DIR_FALLING] = "falling"
76 };
77 
78 static const char * const iio_modifier_names[] = {
79 	[IIO_MOD_X] = "x",
80 	[IIO_MOD_Y] = "y",
81 	[IIO_MOD_Z] = "z",
82 	[IIO_MOD_X_AND_Y] = "x&y",
83 	[IIO_MOD_X_AND_Z] = "x&z",
84 	[IIO_MOD_Y_AND_Z] = "y&z",
85 	[IIO_MOD_X_AND_Y_AND_Z] = "x&y&z",
86 	[IIO_MOD_X_OR_Y] = "x|y",
87 	[IIO_MOD_X_OR_Z] = "x|z",
88 	[IIO_MOD_Y_OR_Z] = "y|z",
89 	[IIO_MOD_X_OR_Y_OR_Z] = "x|y|z",
90 	[IIO_MOD_LIGHT_BOTH] = "both",
91 	[IIO_MOD_LIGHT_IR] = "ir",
92 	[IIO_MOD_ROOT_SUM_SQUARED_X_Y] = "sqrt(x^2+y^2)",
93 	[IIO_MOD_SUM_SQUARED_X_Y_Z] = "x^2+y^2+z^2",
94 	[IIO_MOD_LIGHT_CLEAR] = "clear",
95 	[IIO_MOD_LIGHT_RED] = "red",
96 	[IIO_MOD_LIGHT_GREEN] = "green",
97 	[IIO_MOD_LIGHT_BLUE] = "blue",
98 	[IIO_MOD_LIGHT_UV] = "uv",
99 	[IIO_MOD_LIGHT_DUV] = "duv",
100 	[IIO_MOD_QUATERNION] = "quaternion",
101 	[IIO_MOD_TEMP_AMBIENT] = "ambient",
102 	[IIO_MOD_TEMP_OBJECT] = "object",
103 	[IIO_MOD_NORTH_MAGN] = "from_north_magnetic",
104 	[IIO_MOD_NORTH_TRUE] = "from_north_true",
105 	[IIO_MOD_NORTH_MAGN_TILT_COMP] = "from_north_magnetic_tilt_comp",
106 	[IIO_MOD_NORTH_TRUE_TILT_COMP] = "from_north_true_tilt_comp",
107 	[IIO_MOD_RUNNING] = "running",
108 	[IIO_MOD_JOGGING] = "jogging",
109 	[IIO_MOD_WALKING] = "walking",
110 	[IIO_MOD_STILL] = "still",
111 	[IIO_MOD_ROOT_SUM_SQUARED_X_Y_Z] = "sqrt(x^2+y^2+z^2)",
112 	[IIO_MOD_I] = "i",
113 	[IIO_MOD_Q] = "q",
114 	[IIO_MOD_CO2] = "co2",
115 	[IIO_MOD_ETHANOL] = "ethanol",
116 	[IIO_MOD_H2] = "h2",
117 	[IIO_MOD_VOC] = "voc",
118 	[IIO_MOD_PM1] = "pm1",
119 	[IIO_MOD_PM2P5] = "pm2p5",
120 	[IIO_MOD_PM4] = "pm4",
121 	[IIO_MOD_PM10] = "pm10",
122 	[IIO_MOD_O2] = "o2",
123 };
124 
125 static bool event_is_known(struct iio_event_data *event)
126 {
127 	enum iio_chan_type type = IIO_EVENT_CODE_EXTRACT_CHAN_TYPE(event->id);
128 	enum iio_modifier mod = IIO_EVENT_CODE_EXTRACT_MODIFIER(event->id);
129 	enum iio_event_type ev_type = IIO_EVENT_CODE_EXTRACT_TYPE(event->id);
130 	enum iio_event_direction dir = IIO_EVENT_CODE_EXTRACT_DIR(event->id);
131 
132 	switch (type) {
133 	case IIO_VOLTAGE:
134 	case IIO_CURRENT:
135 	case IIO_POWER:
136 	case IIO_ACCEL:
137 	case IIO_ANGL_VEL:
138 	case IIO_MAGN:
139 	case IIO_LIGHT:
140 	case IIO_INTENSITY:
141 	case IIO_PROXIMITY:
142 	case IIO_TEMP:
143 	case IIO_INCLI:
144 	case IIO_ROT:
145 	case IIO_ANGL:
146 	case IIO_TIMESTAMP:
147 	case IIO_CAPACITANCE:
148 	case IIO_ALTVOLTAGE:
149 	case IIO_CCT:
150 	case IIO_PRESSURE:
151 	case IIO_HUMIDITYRELATIVE:
152 	case IIO_ACTIVITY:
153 	case IIO_STEPS:
154 	case IIO_ENERGY:
155 	case IIO_DISTANCE:
156 	case IIO_VELOCITY:
157 	case IIO_CONCENTRATION:
158 	case IIO_RESISTANCE:
159 	case IIO_PH:
160 	case IIO_UVINDEX:
161 	case IIO_GRAVITY:
162 	case IIO_POSITIONRELATIVE:
163 	case IIO_PHASE:
164 	case IIO_MASSCONCENTRATION:
165 		break;
166 	default:
167 		return false;
168 	}
169 
170 	switch (mod) {
171 	case IIO_NO_MOD:
172 	case IIO_MOD_X:
173 	case IIO_MOD_Y:
174 	case IIO_MOD_Z:
175 	case IIO_MOD_X_AND_Y:
176 	case IIO_MOD_X_AND_Z:
177 	case IIO_MOD_Y_AND_Z:
178 	case IIO_MOD_X_AND_Y_AND_Z:
179 	case IIO_MOD_X_OR_Y:
180 	case IIO_MOD_X_OR_Z:
181 	case IIO_MOD_Y_OR_Z:
182 	case IIO_MOD_X_OR_Y_OR_Z:
183 	case IIO_MOD_LIGHT_BOTH:
184 	case IIO_MOD_LIGHT_IR:
185 	case IIO_MOD_ROOT_SUM_SQUARED_X_Y:
186 	case IIO_MOD_SUM_SQUARED_X_Y_Z:
187 	case IIO_MOD_LIGHT_CLEAR:
188 	case IIO_MOD_LIGHT_RED:
189 	case IIO_MOD_LIGHT_GREEN:
190 	case IIO_MOD_LIGHT_BLUE:
191 	case IIO_MOD_LIGHT_UV:
192 	case IIO_MOD_LIGHT_DUV:
193 	case IIO_MOD_QUATERNION:
194 	case IIO_MOD_TEMP_AMBIENT:
195 	case IIO_MOD_TEMP_OBJECT:
196 	case IIO_MOD_NORTH_MAGN:
197 	case IIO_MOD_NORTH_TRUE:
198 	case IIO_MOD_NORTH_MAGN_TILT_COMP:
199 	case IIO_MOD_NORTH_TRUE_TILT_COMP:
200 	case IIO_MOD_RUNNING:
201 	case IIO_MOD_JOGGING:
202 	case IIO_MOD_WALKING:
203 	case IIO_MOD_STILL:
204 	case IIO_MOD_ROOT_SUM_SQUARED_X_Y_Z:
205 	case IIO_MOD_I:
206 	case IIO_MOD_Q:
207 	case IIO_MOD_CO2:
208 	case IIO_MOD_ETHANOL:
209 	case IIO_MOD_H2:
210 	case IIO_MOD_VOC:
211 	case IIO_MOD_PM1:
212 	case IIO_MOD_PM2P5:
213 	case IIO_MOD_PM4:
214 	case IIO_MOD_PM10:
215 	case IIO_MOD_O2:
216 		break;
217 	default:
218 		return false;
219 	}
220 
221 	switch (ev_type) {
222 	case IIO_EV_TYPE_THRESH:
223 	case IIO_EV_TYPE_MAG:
224 	case IIO_EV_TYPE_ROC:
225 	case IIO_EV_TYPE_THRESH_ADAPTIVE:
226 	case IIO_EV_TYPE_MAG_ADAPTIVE:
227 	case IIO_EV_TYPE_CHANGE:
228 		break;
229 	default:
230 		return false;
231 	}
232 
233 	switch (dir) {
234 	case IIO_EV_DIR_EITHER:
235 	case IIO_EV_DIR_RISING:
236 	case IIO_EV_DIR_FALLING:
237 	case IIO_EV_DIR_NONE:
238 		break;
239 	default:
240 		return false;
241 	}
242 
243 	return true;
244 }
245 
246 static void print_event(struct iio_event_data *event)
247 {
248 	enum iio_chan_type type = IIO_EVENT_CODE_EXTRACT_CHAN_TYPE(event->id);
249 	enum iio_modifier mod = IIO_EVENT_CODE_EXTRACT_MODIFIER(event->id);
250 	enum iio_event_type ev_type = IIO_EVENT_CODE_EXTRACT_TYPE(event->id);
251 	enum iio_event_direction dir = IIO_EVENT_CODE_EXTRACT_DIR(event->id);
252 	int chan = IIO_EVENT_CODE_EXTRACT_CHAN(event->id);
253 	int chan2 = IIO_EVENT_CODE_EXTRACT_CHAN2(event->id);
254 	bool diff = IIO_EVENT_CODE_EXTRACT_DIFF(event->id);
255 
256 	if (!event_is_known(event)) {
257 		fprintf(stderr, "Unknown event: time: %lld, id: %llx\n",
258 			event->timestamp, event->id);
259 
260 		return;
261 	}
262 
263 	printf("Event: time: %lld, type: %s", event->timestamp,
264 	       iio_chan_type_name_spec[type]);
265 
266 	if (mod != IIO_NO_MOD)
267 		printf("(%s)", iio_modifier_names[mod]);
268 
269 	if (chan >= 0) {
270 		printf(", channel: %d", chan);
271 		if (diff && chan2 >= 0)
272 			printf("-%d", chan2);
273 	}
274 
275 	printf(", evtype: %s", iio_ev_type_text[ev_type]);
276 
277 	if (dir != IIO_EV_DIR_NONE)
278 		printf(", direction: %s", iio_ev_dir_text[dir]);
279 
280 	printf("\n");
281 }
282 
283 int main(int argc, char **argv)
284 {
285 	struct iio_event_data event;
286 	const char *device_name;
287 	char *chrdev_name;
288 	int ret;
289 	int dev_num;
290 	int fd, event_fd;
291 
292 	if (argc <= 1) {
293 		fprintf(stderr, "Usage: %s <device_name>\n", argv[0]);
294 		return -1;
295 	}
296 
297 	device_name = argv[1];
298 
299 	dev_num = find_type_by_name(device_name, "iio:device");
300 	if (dev_num >= 0) {
301 		printf("Found IIO device with name %s with device number %d\n",
302 		       device_name, dev_num);
303 		ret = asprintf(&chrdev_name, "/dev/iio:device%d", dev_num);
304 		if (ret < 0)
305 			return -ENOMEM;
306 	} else {
307 		/*
308 		 * If we can't find an IIO device by name assume device_name is
309 		 * an IIO chrdev
310 		 */
311 		chrdev_name = strdup(device_name);
312 		if (!chrdev_name)
313 			return -ENOMEM;
314 	}
315 
316 	fd = open(chrdev_name, 0);
317 	if (fd == -1) {
318 		ret = -errno;
319 		fprintf(stderr, "Failed to open %s\n", chrdev_name);
320 		goto error_free_chrdev_name;
321 	}
322 
323 	ret = ioctl(fd, IIO_GET_EVENT_FD_IOCTL, &event_fd);
324 	if (ret == -1 || event_fd == -1) {
325 		ret = -errno;
326 		if (ret == -ENODEV)
327 			fprintf(stderr,
328 				"This device does not support events\n");
329 		else
330 			fprintf(stderr, "Failed to retrieve event fd\n");
331 		if (close(fd) == -1)
332 			perror("Failed to close character device file");
333 
334 		goto error_free_chrdev_name;
335 	}
336 
337 	if (close(fd) == -1)  {
338 		ret = -errno;
339 		goto error_free_chrdev_name;
340 	}
341 
342 	while (true) {
343 		ret = read(event_fd, &event, sizeof(event));
344 		if (ret == -1) {
345 			if (errno == EAGAIN) {
346 				fprintf(stderr, "nothing available\n");
347 				continue;
348 			} else {
349 				ret = -errno;
350 				perror("Failed to read event from device");
351 				break;
352 			}
353 		}
354 
355 		if (ret != sizeof(event)) {
356 			fprintf(stderr, "Reading event failed!\n");
357 			ret = -EIO;
358 			break;
359 		}
360 
361 		print_event(&event);
362 	}
363 
364 	if (close(event_fd) == -1)
365 		perror("Failed to close event file");
366 
367 error_free_chrdev_name:
368 	free(chrdev_name);
369 
370 	return ret;
371 }
372