xref: /openbmc/linux/tools/iio/iio_event_monitor.c (revision cce8e04c)
1 /* Industrialio event test code.
2  *
3  * Copyright (c) 2011-2012 Lars-Peter Clausen <lars@metafoo.de>
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 as published by
7  * the Free Software Foundation.
8  *
9  * This program is primarily intended as an example application.
10  * Reads the current buffer setup from sysfs and starts a short capture
11  * from the specified device, pretty printing the result after appropriate
12  * conversion.
13  *
14  * Usage:
15  *	iio_event_monitor <device_name>
16  */
17 
18 #include <unistd.h>
19 #include <stdlib.h>
20 #include <stdbool.h>
21 #include <stdio.h>
22 #include <errno.h>
23 #include <string.h>
24 #include <poll.h>
25 #include <fcntl.h>
26 #include <sys/ioctl.h>
27 #include "iio_utils.h"
28 #include <linux/iio/events.h>
29 #include <linux/iio/types.h>
30 
31 static const char * const iio_chan_type_name_spec[] = {
32 	[IIO_VOLTAGE] = "voltage",
33 	[IIO_CURRENT] = "current",
34 	[IIO_POWER] = "power",
35 	[IIO_ACCEL] = "accel",
36 	[IIO_ANGL_VEL] = "anglvel",
37 	[IIO_MAGN] = "magn",
38 	[IIO_LIGHT] = "illuminance",
39 	[IIO_INTENSITY] = "intensity",
40 	[IIO_PROXIMITY] = "proximity",
41 	[IIO_TEMP] = "temp",
42 	[IIO_INCLI] = "incli",
43 	[IIO_ROT] = "rot",
44 	[IIO_ANGL] = "angl",
45 	[IIO_TIMESTAMP] = "timestamp",
46 	[IIO_CAPACITANCE] = "capacitance",
47 	[IIO_ALTVOLTAGE] = "altvoltage",
48 	[IIO_CCT] = "cct",
49 	[IIO_PRESSURE] = "pressure",
50 	[IIO_HUMIDITYRELATIVE] = "humidityrelative",
51 	[IIO_ACTIVITY] = "activity",
52 	[IIO_STEPS] = "steps",
53 	[IIO_ENERGY] = "energy",
54 	[IIO_DISTANCE] = "distance",
55 	[IIO_VELOCITY] = "velocity",
56 	[IIO_CONCENTRATION] = "concentration",
57 	[IIO_RESISTANCE] = "resistance",
58 	[IIO_PH] = "ph",
59 	[IIO_UVINDEX] = "uvindex",
60 	[IIO_GRAVITY] = "gravity",
61 	[IIO_POSITIONRELATIVE] = "positionrelative",
62 	[IIO_PHASE] = "phase",
63 };
64 
65 static const char * const iio_ev_type_text[] = {
66 	[IIO_EV_TYPE_THRESH] = "thresh",
67 	[IIO_EV_TYPE_MAG] = "mag",
68 	[IIO_EV_TYPE_ROC] = "roc",
69 	[IIO_EV_TYPE_THRESH_ADAPTIVE] = "thresh_adaptive",
70 	[IIO_EV_TYPE_MAG_ADAPTIVE] = "mag_adaptive",
71 	[IIO_EV_TYPE_CHANGE] = "change",
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_VOC] = "voc",
118 };
119 
120 static bool event_is_known(struct iio_event_data *event)
121 {
122 	enum iio_chan_type type = IIO_EVENT_CODE_EXTRACT_CHAN_TYPE(event->id);
123 	enum iio_modifier mod = IIO_EVENT_CODE_EXTRACT_MODIFIER(event->id);
124 	enum iio_event_type ev_type = IIO_EVENT_CODE_EXTRACT_TYPE(event->id);
125 	enum iio_event_direction dir = IIO_EVENT_CODE_EXTRACT_DIR(event->id);
126 
127 	switch (type) {
128 	case IIO_VOLTAGE:
129 	case IIO_CURRENT:
130 	case IIO_POWER:
131 	case IIO_ACCEL:
132 	case IIO_ANGL_VEL:
133 	case IIO_MAGN:
134 	case IIO_LIGHT:
135 	case IIO_INTENSITY:
136 	case IIO_PROXIMITY:
137 	case IIO_TEMP:
138 	case IIO_INCLI:
139 	case IIO_ROT:
140 	case IIO_ANGL:
141 	case IIO_TIMESTAMP:
142 	case IIO_CAPACITANCE:
143 	case IIO_ALTVOLTAGE:
144 	case IIO_CCT:
145 	case IIO_PRESSURE:
146 	case IIO_HUMIDITYRELATIVE:
147 	case IIO_ACTIVITY:
148 	case IIO_STEPS:
149 	case IIO_ENERGY:
150 	case IIO_DISTANCE:
151 	case IIO_VELOCITY:
152 	case IIO_CONCENTRATION:
153 	case IIO_RESISTANCE:
154 	case IIO_PH:
155 	case IIO_UVINDEX:
156 	case IIO_GRAVITY:
157 	case IIO_POSITIONRELATIVE:
158 	case IIO_PHASE:
159 		break;
160 	default:
161 		return false;
162 	}
163 
164 	switch (mod) {
165 	case IIO_NO_MOD:
166 	case IIO_MOD_X:
167 	case IIO_MOD_Y:
168 	case IIO_MOD_Z:
169 	case IIO_MOD_X_AND_Y:
170 	case IIO_MOD_X_AND_Z:
171 	case IIO_MOD_Y_AND_Z:
172 	case IIO_MOD_X_AND_Y_AND_Z:
173 	case IIO_MOD_X_OR_Y:
174 	case IIO_MOD_X_OR_Z:
175 	case IIO_MOD_Y_OR_Z:
176 	case IIO_MOD_X_OR_Y_OR_Z:
177 	case IIO_MOD_LIGHT_BOTH:
178 	case IIO_MOD_LIGHT_IR:
179 	case IIO_MOD_ROOT_SUM_SQUARED_X_Y:
180 	case IIO_MOD_SUM_SQUARED_X_Y_Z:
181 	case IIO_MOD_LIGHT_CLEAR:
182 	case IIO_MOD_LIGHT_RED:
183 	case IIO_MOD_LIGHT_GREEN:
184 	case IIO_MOD_LIGHT_BLUE:
185 	case IIO_MOD_LIGHT_UV:
186 	case IIO_MOD_LIGHT_DUV:
187 	case IIO_MOD_QUATERNION:
188 	case IIO_MOD_TEMP_AMBIENT:
189 	case IIO_MOD_TEMP_OBJECT:
190 	case IIO_MOD_NORTH_MAGN:
191 	case IIO_MOD_NORTH_TRUE:
192 	case IIO_MOD_NORTH_MAGN_TILT_COMP:
193 	case IIO_MOD_NORTH_TRUE_TILT_COMP:
194 	case IIO_MOD_RUNNING:
195 	case IIO_MOD_JOGGING:
196 	case IIO_MOD_WALKING:
197 	case IIO_MOD_STILL:
198 	case IIO_MOD_ROOT_SUM_SQUARED_X_Y_Z:
199 	case IIO_MOD_I:
200 	case IIO_MOD_Q:
201 	case IIO_MOD_CO2:
202 	case IIO_MOD_VOC:
203 		break;
204 	default:
205 		return false;
206 	}
207 
208 	switch (ev_type) {
209 	case IIO_EV_TYPE_THRESH:
210 	case IIO_EV_TYPE_MAG:
211 	case IIO_EV_TYPE_ROC:
212 	case IIO_EV_TYPE_THRESH_ADAPTIVE:
213 	case IIO_EV_TYPE_MAG_ADAPTIVE:
214 	case IIO_EV_TYPE_CHANGE:
215 		break;
216 	default:
217 		return false;
218 	}
219 
220 	switch (dir) {
221 	case IIO_EV_DIR_EITHER:
222 	case IIO_EV_DIR_RISING:
223 	case IIO_EV_DIR_FALLING:
224 	case IIO_EV_DIR_NONE:
225 		break;
226 	default:
227 		return false;
228 	}
229 
230 	return true;
231 }
232 
233 static void print_event(struct iio_event_data *event)
234 {
235 	enum iio_chan_type type = IIO_EVENT_CODE_EXTRACT_CHAN_TYPE(event->id);
236 	enum iio_modifier mod = IIO_EVENT_CODE_EXTRACT_MODIFIER(event->id);
237 	enum iio_event_type ev_type = IIO_EVENT_CODE_EXTRACT_TYPE(event->id);
238 	enum iio_event_direction dir = IIO_EVENT_CODE_EXTRACT_DIR(event->id);
239 	int chan = IIO_EVENT_CODE_EXTRACT_CHAN(event->id);
240 	int chan2 = IIO_EVENT_CODE_EXTRACT_CHAN2(event->id);
241 	bool diff = IIO_EVENT_CODE_EXTRACT_DIFF(event->id);
242 
243 	if (!event_is_known(event)) {
244 		fprintf(stderr, "Unknown event: time: %lld, id: %llx\n",
245 			event->timestamp, event->id);
246 
247 		return;
248 	}
249 
250 	printf("Event: time: %lld, type: %s", event->timestamp,
251 	       iio_chan_type_name_spec[type]);
252 
253 	if (mod != IIO_NO_MOD)
254 		printf("(%s)", iio_modifier_names[mod]);
255 
256 	if (chan >= 0) {
257 		printf(", channel: %d", chan);
258 		if (diff && chan2 >= 0)
259 			printf("-%d", chan2);
260 	}
261 
262 	printf(", evtype: %s", iio_ev_type_text[ev_type]);
263 
264 	if (dir != IIO_EV_DIR_NONE)
265 		printf(", direction: %s", iio_ev_dir_text[dir]);
266 
267 	printf("\n");
268 }
269 
270 int main(int argc, char **argv)
271 {
272 	struct iio_event_data event;
273 	const char *device_name;
274 	char *chrdev_name;
275 	int ret;
276 	int dev_num;
277 	int fd, event_fd;
278 
279 	if (argc <= 1) {
280 		fprintf(stderr, "Usage: %s <device_name>\n", argv[0]);
281 		return -1;
282 	}
283 
284 	device_name = argv[1];
285 
286 	dev_num = find_type_by_name(device_name, "iio:device");
287 	if (dev_num >= 0) {
288 		printf("Found IIO device with name %s with device number %d\n",
289 		       device_name, dev_num);
290 		ret = asprintf(&chrdev_name, "/dev/iio:device%d", dev_num);
291 		if (ret < 0)
292 			return -ENOMEM;
293 	} else {
294 		/*
295 		 * If we can't find an IIO device by name assume device_name is
296 		 * an IIO chrdev
297 		 */
298 		chrdev_name = strdup(device_name);
299 		if (!chrdev_name)
300 			return -ENOMEM;
301 	}
302 
303 	fd = open(chrdev_name, 0);
304 	if (fd == -1) {
305 		ret = -errno;
306 		fprintf(stderr, "Failed to open %s\n", chrdev_name);
307 		goto error_free_chrdev_name;
308 	}
309 
310 	ret = ioctl(fd, IIO_GET_EVENT_FD_IOCTL, &event_fd);
311 	if (ret == -1 || event_fd == -1) {
312 		ret = -errno;
313 		if (ret == -ENODEV)
314 			fprintf(stderr,
315 				"This device does not support events\n");
316 		else
317 			fprintf(stderr, "Failed to retrieve event fd\n");
318 		if (close(fd) == -1)
319 			perror("Failed to close character device file");
320 
321 		goto error_free_chrdev_name;
322 	}
323 
324 	if (close(fd) == -1)  {
325 		ret = -errno;
326 		goto error_free_chrdev_name;
327 	}
328 
329 	while (true) {
330 		ret = read(event_fd, &event, sizeof(event));
331 		if (ret == -1) {
332 			if (errno == EAGAIN) {
333 				fprintf(stderr, "nothing available\n");
334 				continue;
335 			} else {
336 				ret = -errno;
337 				perror("Failed to read event from device");
338 				break;
339 			}
340 		}
341 
342 		if (ret != sizeof(event)) {
343 			fprintf(stderr, "Reading event failed!\n");
344 			ret = -EIO;
345 			break;
346 		}
347 
348 		print_event(&event);
349 	}
350 
351 	if (close(event_fd) == -1)
352 		perror("Failed to close event file");
353 
354 error_free_chrdev_name:
355 	free(chrdev_name);
356 
357 	return ret;
358 }
359