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>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28 #define pipe(fds) _pipe(fds, 4096, _O_BINARY)
30 #include "libsigrok.h"
31 #include "libsigrok-internal.h"
33 /* TODO: Number of probes should be configurable. */
36 #define DEMONAME "Demo device"
38 /* The size of chunks to send through the session bus. */
39 /* TODO: Should be configurable. */
42 /* Supported patterns which we can generate */
45 * Pattern which spells "sigrok" using '0's (with '1's as "background")
46 * when displayed using the 'bits' output format.
50 /** Pattern which consists of (pseudo-)random values on all probes. */
54 * Pattern which consists of incrementing numbers.
55 * TODO: Better description.
59 /** Pattern where all probes have a low logic state. */
62 /** Pattern where all probes have a high logic state. */
66 /* FIXME: Should not be global. */
70 GIOChannel *channels[2];
71 uint8_t sample_generator;
72 uint8_t thread_running;
73 uint64_t samples_counter;
79 static const int hwcaps[] = {
80 SR_HWCAP_LOGIC_ANALYZER,
83 SR_HWCAP_PATTERN_MODE,
84 SR_HWCAP_LIMIT_SAMPLES,
89 static const struct sr_samplerates samplerates = {
96 static const char *pattern_strings[] = {
105 /* We name the probes 0-7 on our demo driver. */
106 static const char *probe_names[NUM_PROBES + 1] = {
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 static GSList *dev_insts = NULL;
134 static uint64_t cur_samplerate = SR_KHZ(200);
135 static uint64_t limit_samples = 0;
136 static uint64_t limit_msec = 0;
137 static int default_pattern = PATTERN_SIGROK;
138 static GThread *my_thread;
139 static int thread_running;
141 static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
143 static int hw_init(void)
145 struct sr_dev_inst *sdi;
147 sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
149 sr_err("demo: %s: sr_dev_inst_new failed", __func__);
153 dev_insts = g_slist_append(dev_insts, sdi);
158 static int hw_dev_open(int dev_index)
160 /* Avoid compiler warnings. */
163 /* Nothing needed so far. */
168 static int hw_dev_close(int dev_index)
170 /* Avoid compiler warnings. */
173 /* Nothing needed so far. */
178 static int hw_cleanup(void)
180 /* Nothing needed so far. */
184 static const void *hw_dev_info_get(int dev_index, int dev_info_id)
186 struct sr_dev_inst *sdi;
187 const void *info = NULL;
189 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
190 sr_err("demo: %s: sdi was NULL", __func__);
194 switch (dev_info_id) {
198 case SR_DI_NUM_PROBES:
199 info = GINT_TO_POINTER(NUM_PROBES);
201 case SR_DI_PROBE_NAMES:
204 case SR_DI_SAMPLERATES:
207 case SR_DI_CUR_SAMPLERATE:
208 info = &cur_samplerate;
211 info = &pattern_strings;
218 static int hw_dev_status_get(int dev_index)
220 /* Avoid compiler warnings. */
226 static const int *hw_hwcap_get_all(void)
231 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
236 /* Avoid compiler warnings. */
239 if (hwcap == SR_HWCAP_PROBECONFIG) {
240 /* Nothing to do, but must be supported */
242 } else if (hwcap == SR_HWCAP_SAMPLERATE) {
243 cur_samplerate = *(const uint64_t *)value;
244 sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
247 } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
249 limit_samples = *(const uint64_t *)value;
250 sr_dbg("demo: %s: setting limit_samples to %" PRIu64, __func__,
253 } else if (hwcap == SR_HWCAP_LIMIT_MSEC) {
254 limit_msec = *(const uint64_t *)value;
256 sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
259 } else if (hwcap == SR_HWCAP_PATTERN_MODE) {
262 if (!strcmp(stropt, "sigrok")) {
263 default_pattern = PATTERN_SIGROK;
264 } else if (!strcmp(stropt, "random")) {
265 default_pattern = PATTERN_RANDOM;
266 } else if (!strcmp(stropt, "incremental")) {
267 default_pattern = PATTERN_INC;
268 } else if (!strcmp(stropt, "all-low")) {
269 default_pattern = PATTERN_ALL_LOW;
270 } else if (!strcmp(stropt, "all-high")) {
271 default_pattern = PATTERN_ALL_HIGH;
275 sr_dbg("demo: %s: setting pattern to %d", __func__,
284 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
286 static uint64_t p = 0;
287 struct context *ctx = data;
291 memset(buf, 0, size);
293 switch (ctx->sample_generator) {
294 case PATTERN_SIGROK: /* sigrok pattern */
295 for (i = 0; i < size; i++) {
296 *(buf + i) = ~(pattern_sigrok[p] >> 1);
301 case PATTERN_RANDOM: /* Random */
302 for (i = 0; i < size; i++)
303 *(buf + i) = (uint8_t)(rand() & 0xff);
305 case PATTERN_INC: /* Simple increment */
306 for (i = 0; i < size; i++)
309 case PATTERN_ALL_LOW: /* All probes are low */
310 memset(buf, 0x00, size);
312 case PATTERN_ALL_HIGH: /* All probes are high */
313 memset(buf, 0xff, size);
316 sr_err("demo: %s: unknown pattern %d", __func__,
317 ctx->sample_generator);
322 /* Thread function */
323 static void thread_func(void *data)
325 struct context *ctx = data;
326 uint8_t buf[BUFSIZE];
327 uint64_t nb_to_send = 0;
329 double time_cur, time_last, time_diff;
331 time_last = g_timer_elapsed(ctx->timer, NULL);
333 while (thread_running) {
335 time_cur = g_timer_elapsed(ctx->timer, NULL);
337 time_diff = time_cur - time_last;
338 time_last = time_cur;
340 nb_to_send = cur_samplerate * time_diff;
343 nb_to_send = MIN(nb_to_send,
344 limit_samples - ctx->samples_counter);
347 /* Make sure we don't overflow. */
348 nb_to_send = MIN(nb_to_send, BUFSIZE);
351 samples_generator(buf, nb_to_send, data);
352 ctx->samples_counter += nb_to_send;
354 g_io_channel_write_chars(ctx->channels[1], (gchar *)&buf,
355 nb_to_send, (gsize *)&bytes_written, NULL);
358 /* Check if we're done. */
359 if ((limit_msec && time_cur * 1000 > limit_msec) ||
360 (limit_samples && ctx->samples_counter >= limit_samples))
362 close(ctx->pipe_fds[1]);
370 /* Callback handling data */
371 static int receive_data(int fd, int revents, void *cb_data)
373 struct context *ctx = cb_data;
374 struct sr_datafeed_packet packet;
375 struct sr_datafeed_logic logic;
376 static uint64_t samples_received = 0;
377 unsigned char c[BUFSIZE];
380 /* Avoid compiler warnings. */
385 g_io_channel_read_chars(ctx->channels[0],
386 (gchar *)&c, BUFSIZE, &z, NULL);
389 packet.type = SR_DF_LOGIC;
390 packet.payload = &logic;
394 sr_session_send(ctx->session_dev_id, &packet);
395 samples_received += z;
399 if (!thread_running && z <= 0) {
400 /* Make sure we don't receive more packets. */
401 g_io_channel_shutdown(ctx->channels[0], FALSE, NULL);
403 /* Send last packet. */
404 packet.type = SR_DF_END;
405 sr_session_send(ctx->session_dev_id, &packet);
413 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
415 struct sr_datafeed_packet *packet;
416 struct sr_datafeed_header *header;
417 struct sr_datafeed_meta_logic meta;
420 /* TODO: 'ctx' is never g_free()'d? */
421 if (!(ctx = g_try_malloc(sizeof(struct context)))) {
422 sr_err("demo: %s: ctx malloc failed", __func__);
423 return SR_ERR_MALLOC;
426 ctx->sample_generator = default_pattern;
427 ctx->session_dev_id = cb_data;
428 ctx->dev_index = dev_index;
429 ctx->samples_counter = 0;
431 if (pipe(ctx->pipe_fds)) {
432 /* TODO: Better error message. */
433 sr_err("demo: %s: pipe() failed", __func__);
437 ctx->channels[0] = g_io_channel_unix_new(ctx->pipe_fds[0]);
438 ctx->channels[1] = g_io_channel_unix_new(ctx->pipe_fds[1]);
440 g_io_channel_set_flags(ctx->channels[0], G_IO_FLAG_NONBLOCK, NULL);
442 /* Set channel encoding to binary (default is UTF-8). */
443 g_io_channel_set_encoding(ctx->channels[0], NULL, NULL);
444 g_io_channel_set_encoding(ctx->channels[1], NULL, NULL);
446 /* Make channels to unbuffered. */
447 g_io_channel_set_buffered(ctx->channels[0], FALSE);
448 g_io_channel_set_buffered(ctx->channels[1], FALSE);
450 sr_session_source_add_channel(ctx->channels[0], G_IO_IN | G_IO_ERR,
451 40, receive_data, ctx);
453 /* Run the demo thread. */
455 /* This must to be done between g_thread_init() & g_thread_create(). */
456 ctx->timer = g_timer_new();
459 g_thread_create((GThreadFunc)thread_func, ctx, TRUE, NULL);
461 sr_err("demo: %s: g_thread_create failed", __func__);
462 return SR_ERR; /* TODO */
465 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
466 sr_err("demo: %s: packet malloc failed", __func__);
467 return SR_ERR_MALLOC;
470 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
471 sr_err("demo: %s: header malloc failed", __func__);
472 return SR_ERR_MALLOC;
475 packet->type = SR_DF_HEADER;
476 packet->payload = header;
477 header->feed_version = 1;
478 gettimeofday(&header->starttime, NULL);
479 sr_session_send(ctx->session_dev_id, packet);
481 /* Send metadata about the SR_DF_LOGIC packets to come. */
482 packet->type = SR_DF_META_LOGIC;
483 packet->payload = &meta;
484 meta.samplerate = cur_samplerate;
485 meta.num_probes = NUM_PROBES;
486 sr_session_send(ctx->session_dev_id, packet);
494 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
495 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
497 /* Avoid compiler warnings. */
501 /* Stop generate thread. */
507 SR_PRIV struct sr_dev_driver demo_driver_info = {
509 .longname = "Demo driver and pattern generator",
512 .cleanup = hw_cleanup,
513 .dev_open = hw_dev_open,
514 .dev_close = hw_dev_close,
515 .dev_info_get = hw_dev_info_get,
516 .dev_status_get = hw_dev_status_get,
517 .hwcap_get_all = hw_hwcap_get_all,
518 .dev_config_set = hw_dev_config_set,
519 .dev_acquisition_start = hw_dev_acquisition_start,
520 .dev_acquisition_stop = hw_dev_acquisition_stop,