tools:iio:iio_utils: add missing documentation
[linux-2.6-block.git] / tools / iio / generic_buffer.c
CommitLineData
e58537cc
JC
1/* Industrialio buffer test code.
2 *
3 * Copyright (c) 2008 Jonathan Cameron
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 * Command line parameters
15 * generic_buffer -n <device_name> -t <trigger_name>
16 * If trigger name is not specified the program assumes you want a dataready
17 * trigger associated with the device and goes looking for it.
18 *
19 */
20
21#include <unistd.h>
bdcb31d0 22#include <stdlib.h>
e58537cc
JC
23#include <dirent.h>
24#include <fcntl.h>
25#include <stdio.h>
26#include <errno.h>
27#include <sys/stat.h>
28#include <sys/dir.h>
29#include <linux/types.h>
30268a3d 30#include <string.h>
52615d47 31#include <poll.h>
117cf8b7 32#include <endian.h>
bb23378c 33#include <getopt.h>
1bcdfbcf 34#include <inttypes.h>
e58537cc
JC
35#include "iio_utils.h"
36
e58537cc
JC
37/**
38 * size_from_channelarray() - calculate the storage size of a scan
d8da0eee
PM
39 * @channels: the channel info array
40 * @num_channels: number of channels
e58537cc
JC
41 *
42 * Has the side effect of filling the channels[i].location values used
43 * in processing the buffer output.
44 **/
45int size_from_channelarray(struct iio_channel_info *channels, int num_channels)
46{
47 int bytes = 0;
48 int i = 0;
ff39a252 49
e58537cc
JC
50 while (i < num_channels) {
51 if (bytes % channels[i].bytes == 0)
52 channels[i].location = bytes;
53 else
54 channels[i].location = bytes - bytes%channels[i].bytes
55 + channels[i].bytes;
56 bytes = channels[i].location + channels[i].bytes;
57 i++;
58 }
59 return bytes;
60}
61
8e926134 62void print2byte(uint16_t input, struct iio_channel_info *info)
52615d47 63{
117cf8b7 64 /* First swap if incorrect endian */
117cf8b7 65 if (info->be)
8e926134 66 input = be16toh(input);
117cf8b7 67 else
8e926134 68 input = le16toh(input);
117cf8b7 69
d8da0eee
PM
70 /*
71 * Shift before conversion to avoid sign extension
72 * of left aligned data
73 */
1525ecfc 74 input >>= info->shift;
8e926134 75 input &= info->mask;
52615d47 76 if (info->is_signed) {
8e926134
HK
77 int16_t val = (int16_t)(input << (16 - info->bits_used)) >>
78 (16 - info->bits_used);
79 printf("%05f ", ((float)val + info->offset) * info->scale);
80 } else {
81 printf("%05f ", ((float)input + info->offset) * info->scale);
82 }
83}
ff39a252 84
8e926134
HK
85void print4byte(uint32_t input, struct iio_channel_info *info)
86{
87 /* First swap if incorrect endian */
88 if (info->be)
89 input = be32toh(input);
90 else
91 input = le32toh(input);
92
93 /*
94 * Shift before conversion to avoid sign extension
95 * of left aligned data
96 */
97 input >>= info->shift;
98 input &= info->mask;
99 if (info->is_signed) {
100 int32_t val = (int32_t)(input << (32 - info->bits_used)) >>
101 (32 - info->bits_used);
102 printf("%05f ", ((float)val + info->offset) * info->scale);
52615d47 103 } else {
8e926134
HK
104 printf("%05f ", ((float)input + info->offset) * info->scale);
105 }
106}
ff39a252 107
8e926134
HK
108void print8byte(uint64_t input, struct iio_channel_info *info)
109{
110 /* First swap if incorrect endian */
111 if (info->be)
112 input = be64toh(input);
113 else
114 input = le64toh(input);
115
116 /*
117 * Shift before conversion to avoid sign extension
118 * of left aligned data
119 */
120 input >>= info->shift;
121 input &= info->mask;
122 if (info->is_signed) {
123 int64_t val = (int64_t)(input << (64 - info->bits_used)) >>
124 (64 - info->bits_used);
125 /* special case for timestamp */
126 if (info->scale == 1.0f && info->offset == 0.0f)
127 printf("%" PRId64 " ", val);
128 else
129 printf("%05f ",
130 ((float)val + info->offset) * info->scale);
131 } else {
132 printf("%05f ", ((float)input + info->offset) * info->scale);
52615d47
JC
133 }
134}
8e926134 135
e58537cc
JC
136/**
137 * process_scan() - print out the values in SI units
138 * @data: pointer to the start of the scan
d8da0eee 139 * @channels: information about the channels. Note
e58537cc
JC
140 * size_from_channelarray must have been called first to fill the
141 * location offsets.
d8da0eee 142 * @num_channels: number of channels
e58537cc
JC
143 **/
144void process_scan(char *data,
d8da0eee 145 struct iio_channel_info *channels,
e58537cc
JC
146 int num_channels)
147{
148 int k;
ff39a252 149
e58537cc 150 for (k = 0; k < num_channels; k++)
d8da0eee 151 switch (channels[k].bytes) {
e58537cc
JC
152 /* only a few cases implemented so far */
153 case 2:
d8da0eee
PM
154 print2byte(*(uint16_t *)(data + channels[k].location),
155 &channels[k]);
e58537cc 156 break;
6cffc1f8 157 case 4:
8e926134
HK
158 print4byte(*(uint32_t *)(data + channels[k].location),
159 &channels[k]);
6cffc1f8 160 break;
e58537cc 161 case 8:
8e926134
HK
162 print8byte(*(uint64_t *)(data + channels[k].location),
163 &channels[k]);
e58537cc
JC
164 break;
165 default:
166 break;
167 }
168 printf("\n");
169}
170
171int main(int argc, char **argv)
172{
96df9799
JC
173 unsigned long num_loops = 2;
174 unsigned long timedelay = 1000000;
175 unsigned long buf_len = 128;
176
e58537cc 177 int ret, c, i, j, toread;
e58537cc
JC
178 int fp;
179
180 int num_channels;
181 char *trigger_name = NULL, *device_name = NULL;
182 char *dev_dir_name, *buf_dir_name;
183
184 int datardytrigger = 1;
185 char *data;
c77b3810 186 ssize_t read_size;
e58537cc 187 int dev_num, trig_num;
52615d47 188 char *buffer_access;
e58537cc 189 int scan_size;
30268a3d 190 int noevents = 0;
b6d5be57 191 int notrigger = 0;
96df9799 192 char *dummy;
e58537cc 193
d8da0eee 194 struct iio_channel_info *channels;
e58537cc 195
b6d5be57 196 while ((c = getopt(argc, argv, "l:w:c:et:n:g")) != -1) {
e58537cc
JC
197 switch (c) {
198 case 'n':
199 device_name = optarg;
200 break;
201 case 't':
202 trigger_name = optarg;
203 datardytrigger = 0;
204 break;
30268a3d
JC
205 case 'e':
206 noevents = 1;
207 break;
96df9799 208 case 'c':
c8ce9903 209 errno = 0;
96df9799 210 num_loops = strtoul(optarg, &dummy, 10);
c8ce9903
HK
211 if (errno)
212 return -errno;
96df9799
JC
213 break;
214 case 'w':
c8ce9903 215 errno = 0;
96df9799 216 timedelay = strtoul(optarg, &dummy, 10);
c8ce9903
HK
217 if (errno)
218 return -errno;
96df9799
JC
219 break;
220 case 'l':
c8ce9903 221 errno = 0;
96df9799 222 buf_len = strtoul(optarg, &dummy, 10);
c8ce9903
HK
223 if (errno)
224 return -errno;
96df9799 225 break;
b6d5be57
KW
226 case 'g':
227 notrigger = 1;
228 break;
e58537cc
JC
229 case '?':
230 return -1;
231 }
232 }
233
065896e9
MH
234 if (device_name == NULL)
235 return -1;
236
e58537cc 237 /* Find the device requested */
1aa04278 238 dev_num = find_type_by_name(device_name, "iio:device");
e58537cc
JC
239 if (dev_num < 0) {
240 printf("Failed to find the %s\n", device_name);
e83a47cf 241 ret = dev_num;
e58537cc
JC
242 goto error_ret;
243 }
244 printf("iio device number being used is %d\n", dev_num);
245
e9e45b43
HK
246 ret = asprintf(&dev_dir_name, "%siio:device%d", iio_dir, dev_num);
247 if (ret < 0)
248 return -ENOMEM;
b6d5be57
KW
249
250 if (!notrigger) {
251 if (trigger_name == NULL) {
252 /*
253 * Build the trigger name. If it is device associated
254 * its name is <device_name>_dev[n] where n matches
255 * the device number found above.
256 */
257 ret = asprintf(&trigger_name,
258 "%s-dev%d", device_name, dev_num);
259 if (ret < 0) {
260 ret = -ENOMEM;
d3ccfc41 261 goto error_free_dev_dir_name;
b6d5be57 262 }
e58537cc 263 }
e58537cc 264
b6d5be57
KW
265 /* Verify the trigger exists */
266 trig_num = find_type_by_name(trigger_name, "trigger");
267 if (trig_num < 0) {
268 printf("Failed to find the trigger %s\n", trigger_name);
e83a47cf 269 ret = trig_num;
b6d5be57
KW
270 goto error_free_triggername;
271 }
272 printf("iio trigger number being used is %d\n", trig_num);
273 } else
274 printf("trigger-less mode selected\n");
e58537cc
JC
275
276 /*
277 * Parse the files in scan_elements to identify what channels are
278 * present
279 */
d8da0eee 280 ret = build_channel_array(dev_dir_name, &channels, &num_channels);
e58537cc 281 if (ret) {
52615d47 282 printf("Problem reading scan element information\n");
1aa04278 283 printf("diag %s\n", dev_dir_name);
e58537cc
JC
284 goto error_free_triggername;
285 }
286
287 /*
288 * Construct the directory name for the associated buffer.
289 * As we know that the lis3l02dq has only one buffer this may
290 * be built rather than found.
291 */
1aa04278
JC
292 ret = asprintf(&buf_dir_name,
293 "%siio:device%d/buffer", iio_dir, dev_num);
e58537cc
JC
294 if (ret < 0) {
295 ret = -ENOMEM;
63f05c85 296 goto error_free_channels;
e58537cc 297 }
b6d5be57
KW
298
299 if (!notrigger) {
300 printf("%s %s\n", dev_dir_name, trigger_name);
301 /* Set the device trigger to be the data ready trigger found
302 * above */
303 ret = write_sysfs_string_and_verify("trigger/current_trigger",
304 dev_dir_name,
305 trigger_name);
306 if (ret < 0) {
307 printf("Failed to write current_trigger file\n");
308 goto error_free_buf_dir_name;
309 }
e58537cc
JC
310 }
311
312 /* Setup ring buffer parameters */
313 ret = write_sysfs_int("length", buf_dir_name, buf_len);
314 if (ret < 0)
315 goto error_free_buf_dir_name;
316
317 /* Enable the buffer */
318 ret = write_sysfs_int("enable", buf_dir_name, 1);
319 if (ret < 0)
320 goto error_free_buf_dir_name;
d8da0eee 321 scan_size = size_from_channelarray(channels, num_channels);
e58537cc
JC
322 data = malloc(scan_size*buf_len);
323 if (!data) {
324 ret = -ENOMEM;
325 goto error_free_buf_dir_name;
326 }
327
1aa04278 328 ret = asprintf(&buffer_access, "/dev/iio:device%d", dev_num);
e58537cc
JC
329 if (ret < 0) {
330 ret = -ENOMEM;
331 goto error_free_data;
332 }
333
e58537cc
JC
334 /* Attempt to open non blocking the access dev */
335 fp = open(buffer_access, O_RDONLY | O_NONBLOCK);
d8da0eee 336 if (fp == -1) { /* If it isn't there make the node */
e58537cc 337 ret = -errno;
2b6a6e67 338 printf("Failed to open %s\n", buffer_access);
52615d47 339 goto error_free_buffer_access;
e58537cc
JC
340 }
341
342 /* Wait for events 10 times */
343 for (j = 0; j < num_loops; j++) {
30268a3d 344 if (!noevents) {
52615d47
JC
345 struct pollfd pfd = {
346 .fd = fp,
347 .events = POLLIN,
348 };
349
6bb7cac8
HK
350 ret = poll(&pfd, 1, -1);
351 if (ret < 0) {
352 ret = -errno;
353 goto error_close_buffer_access;
354 } else if (ret == 0) {
355 continue;
356 }
357
52615d47
JC
358 toread = buf_len;
359
30268a3d 360 } else {
96df9799 361 usleep(timedelay);
30268a3d 362 toread = 64;
e58537cc 363 }
30268a3d 364
e58537cc
JC
365 read_size = read(fp,
366 data,
367 toread*scan_size);
97b603a4 368 if (read_size < 0) {
8749948a 369 if (errno == EAGAIN) {
97b603a4
PM
370 printf("nothing available\n");
371 continue;
372 } else
373 break;
e58537cc
JC
374 }
375 for (i = 0; i < read_size/scan_size; i++)
376 process_scan(data + scan_size*i,
d8da0eee 377 channels,
e58537cc
JC
378 num_channels);
379 }
380
d8da0eee 381 /* Stop the buffer */
e58537cc
JC
382 ret = write_sysfs_int("enable", buf_dir_name, 0);
383 if (ret < 0)
52615d47 384 goto error_close_buffer_access;
e58537cc 385
b6d5be57
KW
386 if (!notrigger)
387 /* Disconnect the trigger - just write a dummy name. */
6bb7cac8
HK
388 ret = write_sysfs_string("trigger/current_trigger",
389 dev_dir_name, "NULL");
390 if (ret < 0)
391 printf("Failed to write to %s\n", dev_dir_name);
e58537cc 392
e58537cc 393error_close_buffer_access:
6bb7cac8
HK
394 if (close(fp) == -1)
395 perror("Failed to close buffer");
e58537cc
JC
396error_free_buffer_access:
397 free(buffer_access);
a71bfb4a
HK
398error_free_data:
399 free(data);
e58537cc
JC
400error_free_buf_dir_name:
401 free(buf_dir_name);
63f05c85
HK
402error_free_channels:
403 for (i = num_channels - 1; i >= 0; i--) {
404 free(channels[i].name);
405 free(channels[i].generic_name);
406 }
407 free(channels);
e58537cc
JC
408error_free_triggername:
409 if (datardytrigger)
410 free(trigger_name);
d3ccfc41
HK
411error_free_dev_dir_name:
412 free(dev_dir_name);
e58537cc
JC
413error_ret:
414 return ret;
415}