2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
6 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
29 #define pipe(fds) _pipe(fds, 4096, _O_BINARY)
31 #include "libsigrok.h"
32 #include "libsigrok-internal.h"
34 /* Message logging helpers with driver-specific prefix string. */
35 #define DRIVER_LOG_DOMAIN "demo: "
36 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
37 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
38 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
39 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
40 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
41 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
43 /* TODO: Number of probes should be configurable. */
46 #define DEMONAME "Demo device"
48 /* The size of chunks to send through the session bus. */
49 /* TODO: Should be configurable. */
52 /* Supported patterns which we can generate */
55 * Pattern which spells "sigrok" using '0's (with '1's as "background")
56 * when displayed using the 'bits' output format.
60 /** Pattern which consists of (pseudo-)random values on all probes. */
64 * Pattern which consists of incrementing numbers.
65 * TODO: Better description.
69 /** Pattern where all probes have a low logic state. */
72 /** Pattern where all probes have a high logic state. */
76 /* Private, per-device-instance driver context. */
79 GIOChannel *channels[2];
80 uint8_t sample_generator;
81 uint64_t samples_counter;
86 static const int hwcaps[] = {
87 SR_CONF_LOGIC_ANALYZER,
91 SR_CONF_LIMIT_SAMPLES,
96 static const struct sr_samplerates samplerates = {
103 static const char *pattern_strings[] = {
112 /* We name the probes 0-7 on our demo driver. */
113 static const char *probe_names[NUM_PROBES + 1] = {
114 "0", "1", "2", "3", "4", "5", "6", "7",
118 static uint8_t pattern_sigrok[] = {
119 0x4c, 0x92, 0x92, 0x92, 0x64, 0x00, 0x00, 0x00,
120 0x82, 0xfe, 0xfe, 0x82, 0x00, 0x00, 0x00, 0x00,
121 0x7c, 0x82, 0x82, 0x92, 0x74, 0x00, 0x00, 0x00,
122 0xfe, 0x12, 0x12, 0x32, 0xcc, 0x00, 0x00, 0x00,
123 0x7c, 0x82, 0x82, 0x82, 0x7c, 0x00, 0x00, 0x00,
124 0xfe, 0x10, 0x28, 0x44, 0x82, 0x00, 0x00, 0x00,
125 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
126 0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
129 /* Private, per-device-instance driver context. */
130 /* TODO: struct context as with the other drivers. */
132 /* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */
133 SR_PRIV struct sr_dev_driver demo_driver_info;
134 static struct sr_dev_driver *di = &demo_driver_info;
135 static uint64_t cur_samplerate = SR_KHZ(200);
136 static uint64_t limit_samples = 0;
137 static uint64_t limit_msec = 0;
138 static int default_pattern = PATTERN_SIGROK;
140 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
142 static int clear_instances(void)
144 /* Nothing needed so far. */
149 static int hw_init(struct sr_context *sr_ctx)
151 struct drv_context *drvc;
153 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
154 sr_err("Driver context malloc failed.");
155 return SR_ERR_MALLOC;
157 drvc->sr_ctx = sr_ctx;
163 static GSList *hw_scan(GSList *options)
165 struct sr_dev_inst *sdi;
166 struct sr_probe *probe;
167 struct drv_context *drvc;
176 sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
178 sr_err("%s: sr_dev_inst_new failed", __func__);
183 for (i = 0; probe_names[i]; i++) {
184 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
187 sdi->probes = g_slist_append(sdi->probes, probe);
190 devices = g_slist_append(devices, sdi);
191 drvc->instances = g_slist_append(drvc->instances, sdi);
196 static GSList *hw_dev_list(void)
198 struct drv_context *drvc;
202 return drvc->instances;
205 static int hw_dev_open(struct sr_dev_inst *sdi)
209 /* Nothing needed so far. */
214 static int hw_dev_close(struct sr_dev_inst *sdi)
218 /* Nothing needed so far. */
223 static int hw_cleanup(void)
225 /* Nothing needed so far. */
229 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
237 case SR_DI_SAMPLERATES:
238 *data = &samplerates;
240 case SR_DI_CUR_SAMPLERATE:
241 *data = &cur_samplerate;
244 *data = &pattern_strings;
253 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
260 if (id == SR_CONF_SAMPLERATE) {
261 cur_samplerate = *(const uint64_t *)value;
262 sr_dbg("%s: setting samplerate to %" PRIu64, __func__,
265 } else if (id == SR_CONF_LIMIT_SAMPLES) {
267 limit_samples = *(const uint64_t *)value;
268 sr_dbg("%s: setting limit_samples to %" PRIu64, __func__,
271 } else if (id == SR_CONF_LIMIT_MSEC) {
272 limit_msec = *(const uint64_t *)value;
274 sr_dbg("%s: setting limit_msec to %" PRIu64, __func__,
277 } else if (id == SR_CONF_PATTERN_MODE) {
280 if (!strcmp(stropt, "sigrok")) {
281 default_pattern = PATTERN_SIGROK;
282 } else if (!strcmp(stropt, "random")) {
283 default_pattern = PATTERN_RANDOM;
284 } else if (!strcmp(stropt, "incremental")) {
285 default_pattern = PATTERN_INC;
286 } else if (!strcmp(stropt, "all-low")) {
287 default_pattern = PATTERN_ALL_LOW;
288 } else if (!strcmp(stropt, "all-high")) {
289 default_pattern = PATTERN_ALL_HIGH;
293 sr_dbg("%s: setting pattern to %d", __func__, default_pattern);
301 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
307 case SR_CONF_SAMPLERATE:
308 *data = &samplerates;
317 static void samples_generator(uint8_t *buf, uint64_t size,
318 struct dev_context *devc)
320 static uint64_t p = 0;
324 memset(buf, 0, size);
326 switch (devc->sample_generator) {
327 case PATTERN_SIGROK: /* sigrok pattern */
328 for (i = 0; i < size; i++) {
329 *(buf + i) = ~(pattern_sigrok[p] >> 1);
334 case PATTERN_RANDOM: /* Random */
335 for (i = 0; i < size; i++)
336 *(buf + i) = (uint8_t)(rand() & 0xff);
338 case PATTERN_INC: /* Simple increment */
339 for (i = 0; i < size; i++)
342 case PATTERN_ALL_LOW: /* All probes are low */
343 memset(buf, 0x00, size);
345 case PATTERN_ALL_HIGH: /* All probes are high */
346 memset(buf, 0xff, size);
349 sr_err("Unknown pattern: %d.", devc->sample_generator);
354 /* Callback handling data */
355 static int receive_data(int fd, int revents, void *cb_data)
357 struct dev_context *devc = cb_data;
358 struct sr_datafeed_packet packet;
359 struct sr_datafeed_logic logic;
360 uint8_t buf[BUFSIZE];
361 static uint64_t samples_to_send, expected_samplenum, sending_now;
362 int64_t time, elapsed;
367 /* How many "virtual" samples should we have collected by now? */
368 time = g_get_monotonic_time();
369 elapsed = time - devc->starttime;
370 expected_samplenum = elapsed * cur_samplerate / 1000000;
371 /* Of those, how many do we still have to send? */
372 samples_to_send = expected_samplenum - devc->samples_counter;
375 samples_to_send = MIN(samples_to_send,
376 limit_samples - devc->samples_counter);
379 while (samples_to_send > 0) {
380 sending_now = MIN(samples_to_send, sizeof(buf));
381 samples_to_send -= sending_now;
382 samples_generator(buf, sending_now, devc);
384 packet.type = SR_DF_LOGIC;
385 packet.payload = &logic;
386 logic.length = sending_now;
389 sr_session_send(devc->session_dev_id, &packet);
390 devc->samples_counter += sending_now;
393 if (limit_samples && devc->samples_counter >= limit_samples) {
394 sr_info("Requested number of samples reached.");
395 hw_dev_acquisition_stop(NULL, cb_data);
402 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
405 struct sr_datafeed_packet *packet;
406 struct sr_datafeed_header *header;
407 struct dev_context *devc;
411 sr_dbg("Starting acquisition.");
413 /* TODO: 'devc' is never g_free()'d? */
414 if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
415 sr_err("%s: devc malloc failed", __func__);
416 return SR_ERR_MALLOC;
419 devc->sample_generator = default_pattern;
420 devc->session_dev_id = cb_data;
421 devc->samples_counter = 0;
424 * Setting two channels connected by a pipe is a remnant from when the
425 * demo driver generated data in a thread, and collected and sent the
426 * data in the main program loop.
427 * They are kept here because it provides a convenient way of setting
428 * up a timeout-based polling mechanism.
430 if (pipe(devc->pipe_fds)) {
431 /* TODO: Better error message. */
432 sr_err("%s: pipe() failed", __func__);
436 devc->channels[0] = g_io_channel_unix_new(devc->pipe_fds[0]);
437 devc->channels[1] = g_io_channel_unix_new(devc->pipe_fds[1]);
439 g_io_channel_set_flags(devc->channels[0], G_IO_FLAG_NONBLOCK, NULL);
441 /* Set channel encoding to binary (default is UTF-8). */
442 g_io_channel_set_encoding(devc->channels[0], NULL, NULL);
443 g_io_channel_set_encoding(devc->channels[1], NULL, NULL);
445 /* Make channels to unbuffered. */
446 g_io_channel_set_buffered(devc->channels[0], FALSE);
447 g_io_channel_set_buffered(devc->channels[1], FALSE);
449 sr_session_source_add_channel(devc->channels[0], G_IO_IN | G_IO_ERR,
450 40, receive_data, devc);
452 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
453 sr_err("%s: packet malloc failed", __func__);
454 return SR_ERR_MALLOC;
457 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
458 sr_err("%s: header malloc failed", __func__);
459 return SR_ERR_MALLOC;
462 packet->type = SR_DF_HEADER;
463 packet->payload = header;
464 header->feed_version = 1;
465 gettimeofday(&header->starttime, NULL);
466 sr_session_send(devc->session_dev_id, packet);
468 /* We use this timestamp to decide how many more samples to send. */
469 devc->starttime = g_get_monotonic_time();
477 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
479 struct dev_context *devc;
480 struct sr_datafeed_packet packet;
486 sr_dbg("Stopping aquisition.");
488 sr_session_source_remove_channel(devc->channels[0]);
489 g_io_channel_shutdown(devc->channels[0], FALSE, NULL);
491 /* Send last packet. */
492 packet.type = SR_DF_END;
493 sr_session_send(devc->session_dev_id, &packet);
498 SR_PRIV struct sr_dev_driver demo_driver_info = {
500 .longname = "Demo driver and pattern generator",
503 .cleanup = hw_cleanup,
505 .dev_list = hw_dev_list,
506 .dev_clear = clear_instances,
507 .config_get = config_get,
508 .config_set = config_set,
509 .config_list = config_list,
510 .dev_open = hw_dev_open,
511 .dev_close = hw_dev_close,
512 .dev_acquisition_start = hw_dev_acquisition_start,
513 .dev_acquisition_stop = hw_dev_acquisition_stop,