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(const char *devinfo)
145 struct sr_dev_inst *sdi;
147 /* Avoid compiler warnings. */
150 sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
152 sr_err("demo: %s: sr_dev_inst_new failed", __func__);
156 dev_insts = g_slist_append(dev_insts, sdi);
161 static int hw_dev_open(int dev_index)
163 /* Avoid compiler warnings. */
166 /* Nothing needed so far. */
171 static int hw_dev_close(int dev_index)
173 /* Avoid compiler warnings. */
176 /* Nothing needed so far. */
181 static int hw_cleanup(void)
183 /* Nothing needed so far. */
187 static const void *hw_dev_info_get(int dev_index, int dev_info_id)
189 struct sr_dev_inst *sdi;
190 const void *info = NULL;
192 if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) {
193 sr_err("demo: %s: sdi was NULL", __func__);
197 switch (dev_info_id) {
201 case SR_DI_NUM_PROBES:
202 info = GINT_TO_POINTER(NUM_PROBES);
204 case SR_DI_PROBE_NAMES:
207 case SR_DI_SAMPLERATES:
210 case SR_DI_CUR_SAMPLERATE:
211 info = &cur_samplerate;
214 info = &pattern_strings;
221 static int hw_dev_status_get(int dev_index)
223 /* Avoid compiler warnings. */
229 static const int *hw_hwcap_get_all(void)
234 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
239 /* Avoid compiler warnings. */
242 if (hwcap == SR_HWCAP_PROBECONFIG) {
243 /* Nothing to do, but must be supported */
245 } else if (hwcap == SR_HWCAP_SAMPLERATE) {
246 cur_samplerate = *(const uint64_t *)value;
247 sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
250 } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) {
252 limit_samples = *(const uint64_t *)value;
253 sr_dbg("demo: %s: setting limit_samples to %" PRIu64, __func__,
256 } else if (hwcap == SR_HWCAP_LIMIT_MSEC) {
257 limit_msec = *(const uint64_t *)value;
259 sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
262 } else if (hwcap == SR_HWCAP_PATTERN_MODE) {
265 if (!strcmp(stropt, "sigrok")) {
266 default_pattern = PATTERN_SIGROK;
267 } else if (!strcmp(stropt, "random")) {
268 default_pattern = PATTERN_RANDOM;
269 } else if (!strcmp(stropt, "incremental")) {
270 default_pattern = PATTERN_INC;
271 } else if (!strcmp(stropt, "all-low")) {
272 default_pattern = PATTERN_ALL_LOW;
273 } else if (!strcmp(stropt, "all-high")) {
274 default_pattern = PATTERN_ALL_HIGH;
278 sr_dbg("demo: %s: setting pattern to %d", __func__,
287 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
289 static uint64_t p = 0;
290 struct context *ctx = data;
294 memset(buf, 0, size);
296 switch (ctx->sample_generator) {
297 case PATTERN_SIGROK: /* sigrok pattern */
298 for (i = 0; i < size; i++) {
299 *(buf + i) = ~(pattern_sigrok[p] >> 1);
304 case PATTERN_RANDOM: /* Random */
305 for (i = 0; i < size; i++)
306 *(buf + i) = (uint8_t)(rand() & 0xff);
308 case PATTERN_INC: /* Simple increment */
309 for (i = 0; i < size; i++)
312 case PATTERN_ALL_LOW: /* All probes are low */
313 memset(buf, 0x00, size);
315 case PATTERN_ALL_HIGH: /* All probes are high */
316 memset(buf, 0xff, size);
319 sr_err("demo: %s: unknown pattern %d", __func__,
320 ctx->sample_generator);
325 /* Thread function */
326 static void thread_func(void *data)
328 struct context *ctx = data;
329 uint8_t buf[BUFSIZE];
330 uint64_t nb_to_send = 0;
332 double time_cur, time_last, time_diff;
334 time_last = g_timer_elapsed(ctx->timer, NULL);
336 while (thread_running) {
338 time_cur = g_timer_elapsed(ctx->timer, NULL);
340 time_diff = time_cur - time_last;
341 time_last = time_cur;
343 nb_to_send = cur_samplerate * time_diff;
346 nb_to_send = MIN(nb_to_send,
347 limit_samples - ctx->samples_counter);
350 /* Make sure we don't overflow. */
351 nb_to_send = MIN(nb_to_send, BUFSIZE);
354 samples_generator(buf, nb_to_send, data);
355 ctx->samples_counter += nb_to_send;
357 g_io_channel_write_chars(ctx->channels[1], (gchar *)&buf,
358 nb_to_send, (gsize *)&bytes_written, NULL);
361 /* Check if we're done. */
362 if ((limit_msec && time_cur * 1000 > limit_msec) ||
363 (limit_samples && ctx->samples_counter >= limit_samples))
365 close(ctx->pipe_fds[1]);
373 /* Callback handling data */
374 static int receive_data(int fd, int revents, void *cb_data)
376 struct context *ctx = cb_data;
377 struct sr_datafeed_packet packet;
378 struct sr_datafeed_logic logic;
379 static uint64_t samples_received = 0;
380 unsigned char c[BUFSIZE];
383 /* Avoid compiler warnings. */
388 g_io_channel_read_chars(ctx->channels[0],
389 (gchar *)&c, BUFSIZE, &z, NULL);
392 packet.type = SR_DF_LOGIC;
393 packet.payload = &logic;
397 sr_session_send(ctx->session_dev_id, &packet);
398 samples_received += z;
402 if (!thread_running && z <= 0) {
403 /* Make sure we don't receive more packets. */
404 g_io_channel_shutdown(ctx->channels[0], FALSE, NULL);
406 /* Send last packet. */
407 packet.type = SR_DF_END;
408 sr_session_send(ctx->session_dev_id, &packet);
416 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
418 struct sr_datafeed_packet *packet;
419 struct sr_datafeed_header *header;
420 struct sr_datafeed_meta_logic meta;
423 /* TODO: 'ctx' is never g_free()'d? */
424 if (!(ctx = g_try_malloc(sizeof(struct context)))) {
425 sr_err("demo: %s: ctx malloc failed", __func__);
426 return SR_ERR_MALLOC;
429 ctx->sample_generator = default_pattern;
430 ctx->session_dev_id = cb_data;
431 ctx->dev_index = dev_index;
432 ctx->samples_counter = 0;
434 if (pipe(ctx->pipe_fds)) {
435 /* TODO: Better error message. */
436 sr_err("demo: %s: pipe() failed", __func__);
440 ctx->channels[0] = g_io_channel_unix_new(ctx->pipe_fds[0]);
441 ctx->channels[1] = g_io_channel_unix_new(ctx->pipe_fds[1]);
443 /* Set channel encoding to binary (default is UTF-8). */
444 g_io_channel_set_encoding(ctx->channels[0], NULL, NULL);
445 g_io_channel_set_encoding(ctx->channels[1], NULL, NULL);
447 /* Make channels to unbuffered. */
448 g_io_channel_set_buffered(ctx->channels[0], FALSE);
449 g_io_channel_set_buffered(ctx->channels[1], FALSE);
451 sr_session_source_add_channel(ctx->channels[0], G_IO_IN | G_IO_ERR,
452 40, receive_data, ctx);
454 /* Run the demo thread. */
456 /* This must to be done between g_thread_init() & g_thread_create(). */
457 ctx->timer = g_timer_new();
460 g_thread_create((GThreadFunc)thread_func, ctx, TRUE, NULL);
462 sr_err("demo: %s: g_thread_create failed", __func__);
463 return SR_ERR; /* TODO */
466 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
467 sr_err("demo: %s: packet malloc failed", __func__);
468 return SR_ERR_MALLOC;
471 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
472 sr_err("demo: %s: header malloc failed", __func__);
473 return SR_ERR_MALLOC;
476 packet->type = SR_DF_HEADER;
477 packet->payload = header;
478 header->feed_version = 1;
479 gettimeofday(&header->starttime, NULL);
480 sr_session_send(ctx->session_dev_id, packet);
482 /* Send metadata about the SR_DF_LOGIC packets to come. */
483 packet->type = SR_DF_META_LOGIC;
484 packet->payload = &meta;
485 meta.samplerate = cur_samplerate;
486 meta.num_probes = NUM_PROBES;
487 sr_session_send(ctx->session_dev_id, packet);
495 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
496 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
498 /* Avoid compiler warnings. */
502 /* Stop generate thread. */
508 SR_PRIV struct sr_dev_driver demo_driver_info = {
510 .longname = "Demo driver and pattern generator",
513 .cleanup = hw_cleanup,
514 .dev_open = hw_dev_open,
515 .dev_close = hw_dev_close,
516 .dev_info_get = hw_dev_info_get,
517 .dev_status_get = hw_dev_status_get,
518 .hwcap_get_all = hw_hwcap_get_all,
519 .dev_config_set = hw_dev_config_set,
520 .dev_acquisition_start = hw_dev_acquisition_start,
521 .dev_acquisition_stop = hw_dev_acquisition_stop,