xref: /openbmc/linux/tools/iio/iio_event_monitor.c (revision 20e2fc42)
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 };
123 
124 static bool event_is_known(struct iio_event_data *event)
125 {
126 	enum iio_chan_type type = IIO_EVENT_CODE_EXTRACT_CHAN_TYPE(event->id);
127 	enum iio_modifier mod = IIO_EVENT_CODE_EXTRACT_MODIFIER(event->id);
128 	enum iio_event_type ev_type = IIO_EVENT_CODE_EXTRACT_TYPE(event->id);
129 	enum iio_event_direction dir = IIO_EVENT_CODE_EXTRACT_DIR(event->id);
130 
131 	switch (type) {
132 	case IIO_VOLTAGE:
133 	case IIO_CURRENT:
134 	case IIO_POWER:
135 	case IIO_ACCEL:
136 	case IIO_ANGL_VEL:
137 	case IIO_MAGN:
138 	case IIO_LIGHT:
139 	case IIO_INTENSITY:
140 	case IIO_PROXIMITY:
141 	case IIO_TEMP:
142 	case IIO_INCLI:
143 	case IIO_ROT:
144 	case IIO_ANGL:
145 	case IIO_TIMESTAMP:
146 	case IIO_CAPACITANCE:
147 	case IIO_ALTVOLTAGE:
148 	case IIO_CCT:
149 	case IIO_PRESSURE:
150 	case IIO_HUMIDITYRELATIVE:
151 	case IIO_ACTIVITY:
152 	case IIO_STEPS:
153 	case IIO_ENERGY:
154 	case IIO_DISTANCE:
155 	case IIO_VELOCITY:
156 	case IIO_CONCENTRATION:
157 	case IIO_RESISTANCE:
158 	case IIO_PH:
159 	case IIO_UVINDEX:
160 	case IIO_GRAVITY:
161 	case IIO_POSITIONRELATIVE:
162 	case IIO_PHASE:
163 	case IIO_MASSCONCENTRATION:
164 		break;
165 	default:
166 		return false;
167 	}
168 
169 	switch (mod) {
170 	case IIO_NO_MOD:
171 	case IIO_MOD_X:
172 	case IIO_MOD_Y:
173 	case IIO_MOD_Z:
174 	case IIO_MOD_X_AND_Y:
175 	case IIO_MOD_X_AND_Z:
176 	case IIO_MOD_Y_AND_Z:
177 	case IIO_MOD_X_AND_Y_AND_Z:
178 	case IIO_MOD_X_OR_Y:
179 	case IIO_MOD_X_OR_Z:
180 	case IIO_MOD_Y_OR_Z:
181 	case IIO_MOD_X_OR_Y_OR_Z:
182 	case IIO_MOD_LIGHT_BOTH:
183 	case IIO_MOD_LIGHT_IR:
184 	case IIO_MOD_ROOT_SUM_SQUARED_X_Y:
185 	case IIO_MOD_SUM_SQUARED_X_Y_Z:
186 	case IIO_MOD_LIGHT_CLEAR:
187 	case IIO_MOD_LIGHT_RED:
188 	case IIO_MOD_LIGHT_GREEN:
189 	case IIO_MOD_LIGHT_BLUE:
190 	case IIO_MOD_LIGHT_UV:
191 	case IIO_MOD_LIGHT_DUV:
192 	case IIO_MOD_QUATERNION:
193 	case IIO_MOD_TEMP_AMBIENT:
194 	case IIO_MOD_TEMP_OBJECT:
195 	case IIO_MOD_NORTH_MAGN:
196 	case IIO_MOD_NORTH_TRUE:
197 	case IIO_MOD_NORTH_MAGN_TILT_COMP:
198 	case IIO_MOD_NORTH_TRUE_TILT_COMP:
199 	case IIO_MOD_RUNNING:
200 	case IIO_MOD_JOGGING:
201 	case IIO_MOD_WALKING:
202 	case IIO_MOD_STILL:
203 	case IIO_MOD_ROOT_SUM_SQUARED_X_Y_Z:
204 	case IIO_MOD_I:
205 	case IIO_MOD_Q:
206 	case IIO_MOD_CO2:
207 	case IIO_MOD_ETHANOL:
208 	case IIO_MOD_H2:
209 	case IIO_MOD_VOC:
210 	case IIO_MOD_PM1:
211 	case IIO_MOD_PM2P5:
212 	case IIO_MOD_PM4:
213 	case IIO_MOD_PM10:
214 		break;
215 	default:
216 		return false;
217 	}
218 
219 	switch (ev_type) {
220 	case IIO_EV_TYPE_THRESH:
221 	case IIO_EV_TYPE_MAG:
222 	case IIO_EV_TYPE_ROC:
223 	case IIO_EV_TYPE_THRESH_ADAPTIVE:
224 	case IIO_EV_TYPE_MAG_ADAPTIVE:
225 	case IIO_EV_TYPE_CHANGE:
226 		break;
227 	default:
228 		return false;
229 	}
230 
231 	switch (dir) {
232 	case IIO_EV_DIR_EITHER:
233 	case IIO_EV_DIR_RISING:
234 	case IIO_EV_DIR_FALLING:
235 	case IIO_EV_DIR_NONE:
236 		break;
237 	default:
238 		return false;
239 	}
240 
241 	return true;
242 }
243 
244 static void print_event(struct iio_event_data *event)
245 {
246 	enum iio_chan_type type = IIO_EVENT_CODE_EXTRACT_CHAN_TYPE(event->id);
247 	enum iio_modifier mod = IIO_EVENT_CODE_EXTRACT_MODIFIER(event->id);
248 	enum iio_event_type ev_type = IIO_EVENT_CODE_EXTRACT_TYPE(event->id);
249 	enum iio_event_direction dir = IIO_EVENT_CODE_EXTRACT_DIR(event->id);
250 	int chan = IIO_EVENT_CODE_EXTRACT_CHAN(event->id);
251 	int chan2 = IIO_EVENT_CODE_EXTRACT_CHAN2(event->id);
252 	bool diff = IIO_EVENT_CODE_EXTRACT_DIFF(event->id);
253 
254 	if (!event_is_known(event)) {
255 		fprintf(stderr, "Unknown event: time: %lld, id: %llx\n",
256 			event->timestamp, event->id);
257 
258 		return;
259 	}
260 
261 	printf("Event: time: %lld, type: %s", event->timestamp,
262 	       iio_chan_type_name_spec[type]);
263 
264 	if (mod != IIO_NO_MOD)
265 		printf("(%s)", iio_modifier_names[mod]);
266 
267 	if (chan >= 0) {
268 		printf(", channel: %d", chan);
269 		if (diff && chan2 >= 0)
270 			printf("-%d", chan2);
271 	}
272 
273 	printf(", evtype: %s", iio_ev_type_text[ev_type]);
274 
275 	if (dir != IIO_EV_DIR_NONE)
276 		printf(", direction: %s", iio_ev_dir_text[dir]);
277 
278 	printf("\n");
279 }
280 
281 int main(int argc, char **argv)
282 {
283 	struct iio_event_data event;
284 	const char *device_name;
285 	char *chrdev_name;
286 	int ret;
287 	int dev_num;
288 	int fd, event_fd;
289 
290 	if (argc <= 1) {
291 		fprintf(stderr, "Usage: %s <device_name>\n", argv[0]);
292 		return -1;
293 	}
294 
295 	device_name = argv[1];
296 
297 	dev_num = find_type_by_name(device_name, "iio:device");
298 	if (dev_num >= 0) {
299 		printf("Found IIO device with name %s with device number %d\n",
300 		       device_name, dev_num);
301 		ret = asprintf(&chrdev_name, "/dev/iio:device%d", dev_num);
302 		if (ret < 0)
303 			return -ENOMEM;
304 	} else {
305 		/*
306 		 * If we can't find an IIO device by name assume device_name is
307 		 * an IIO chrdev
308 		 */
309 		chrdev_name = strdup(device_name);
310 		if (!chrdev_name)
311 			return -ENOMEM;
312 	}
313 
314 	fd = open(chrdev_name, 0);
315 	if (fd == -1) {
316 		ret = -errno;
317 		fprintf(stderr, "Failed to open %s\n", chrdev_name);
318 		goto error_free_chrdev_name;
319 	}
320 
321 	ret = ioctl(fd, IIO_GET_EVENT_FD_IOCTL, &event_fd);
322 	if (ret == -1 || event_fd == -1) {
323 		ret = -errno;
324 		if (ret == -ENODEV)
325 			fprintf(stderr,
326 				"This device does not support events\n");
327 		else
328 			fprintf(stderr, "Failed to retrieve event fd\n");
329 		if (close(fd) == -1)
330 			perror("Failed to close character device file");
331 
332 		goto error_free_chrdev_name;
333 	}
334 
335 	if (close(fd) == -1)  {
336 		ret = -errno;
337 		goto error_free_chrdev_name;
338 	}
339 
340 	while (true) {
341 		ret = read(event_fd, &event, sizeof(event));
342 		if (ret == -1) {
343 			if (errno == EAGAIN) {
344 				fprintf(stderr, "nothing available\n");
345 				continue;
346 			} else {
347 				ret = -errno;
348 				perror("Failed to read event from device");
349 				break;
350 			}
351 		}
352 
353 		if (ret != sizeof(event)) {
354 			fprintf(stderr, "Reading event failed!\n");
355 			ret = -EIO;
356 			break;
357 		}
358 
359 		print_event(&event);
360 	}
361 
362 	if (close(event_fd) == -1)
363 		perror("Failed to close event file");
364 
365 error_free_chrdev_name:
366 	free(chrdev_name);
367 
368 	return ret;
369 }
370