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)
31 #include "sigrok-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. */
67 SR_PRIV 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) {
251 limit_samples = *(const uint64_t *)value;
252 sr_dbg("demo: %s: setting limit_samples to %" PRIu64, __func__,
255 } else if (hwcap == SR_HWCAP_LIMIT_MSEC) {
256 limit_msec = *(const uint64_t *)value;
257 sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
260 } else if (hwcap == SR_HWCAP_PATTERN_MODE) {
263 if (!strcmp(stropt, "sigrok")) {
264 default_pattern = PATTERN_SIGROK;
265 } else if (!strcmp(stropt, "random")) {
266 default_pattern = PATTERN_RANDOM;
267 } else if (!strcmp(stropt, "incremental")) {
268 default_pattern = PATTERN_INC;
269 } else if (!strcmp(stropt, "all-low")) {
270 default_pattern = PATTERN_ALL_LOW;
271 } else if (!strcmp(stropt, "all-high")) {
272 default_pattern = PATTERN_ALL_HIGH;
276 sr_dbg("demo: %s: setting pattern to %d", __func__,
285 static void samples_generator(uint8_t *buf, uint64_t size, void *data)
287 static uint64_t p = 0;
288 struct context *ctx = data;
292 memset(buf, 0, size);
294 switch (ctx->sample_generator) {
295 case PATTERN_SIGROK: /* sigrok pattern */
296 for (i = 0; i < size; i++) {
297 *(buf + i) = ~(pattern_sigrok[p] >> 1);
302 case PATTERN_RANDOM: /* Random */
303 for (i = 0; i < size; i++)
304 *(buf + i) = (uint8_t)(rand() & 0xff);
306 case PATTERN_INC: /* Simple increment */
307 for (i = 0; i < size; i++)
310 case PATTERN_ALL_LOW: /* All probes are low */
311 memset(buf, 0x00, size);
313 case PATTERN_ALL_HIGH: /* All probes are high */
314 memset(buf, 0xff, size);
317 sr_err("demo: %s: unknown pattern %d", __func__,
318 ctx->sample_generator);
323 /* Thread function */
324 static void thread_func(void *data)
326 struct context *ctx = data;
327 uint8_t buf[BUFSIZE];
328 uint64_t nb_to_send = 0;
330 double time_cur, time_last, time_diff;
332 time_last = g_timer_elapsed(ctx->timer, NULL);
334 while (thread_running) {
336 time_cur = g_timer_elapsed(ctx->timer, NULL);
338 time_diff = time_cur - time_last;
339 time_last = time_cur;
341 nb_to_send = cur_samplerate * time_diff;
344 nb_to_send = MIN(nb_to_send,
345 limit_samples - ctx->samples_counter);
348 /* Make sure we don't overflow. */
349 nb_to_send = MIN(nb_to_send, BUFSIZE);
352 samples_generator(buf, nb_to_send, data);
353 ctx->samples_counter += nb_to_send;
355 g_io_channel_write_chars(channels[1], (gchar *)&buf,
356 nb_to_send, (gsize *)&bytes_written, NULL);
359 /* Check if we're done. */
360 if ((limit_msec && time_cur * 1000 > limit_msec) ||
361 (limit_samples && ctx->samples_counter >= limit_samples))
363 close(ctx->pipe_fds[1]);
371 /* Callback handling data */
372 static int receive_data(int fd, int revents, void *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(channels[0],
386 (gchar *)&c, BUFSIZE, &z, NULL);
389 packet.type = SR_DF_LOGIC;
390 packet.payload = &logic;
394 sr_session_send(cb_data, &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(channels[0], FALSE, NULL);
403 /* Send last packet. */
404 packet.type = SR_DF_END;
405 sr_session_send(cb_data, &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 channels[0] = g_io_channel_unix_new(ctx->pipe_fds[0]);
438 channels[1] = g_io_channel_unix_new(ctx->pipe_fds[1]);
440 /* Set channel encoding to binary (default is UTF-8). */
441 g_io_channel_set_encoding(channels[0], NULL, NULL);
442 g_io_channel_set_encoding(channels[1], NULL, NULL);
444 /* Make channels to unbuffered. */
445 g_io_channel_set_buffered(channels[0], FALSE);
446 g_io_channel_set_buffered(channels[1], FALSE);
448 sr_source_add(ctx->pipe_fds[0], G_IO_IN | G_IO_ERR, 40,
449 receive_data, ctx->session_dev_id);
451 /* Run the demo thread. */
453 /* This must to be done between g_thread_init() & g_thread_create(). */
454 ctx->timer = g_timer_new();
457 g_thread_create((GThreadFunc)thread_func, ctx, TRUE, NULL);
459 sr_err("demo: %s: g_thread_create failed", __func__);
460 return SR_ERR; /* TODO */
463 if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
464 sr_err("demo: %s: packet malloc failed", __func__);
465 return SR_ERR_MALLOC;
468 if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
469 sr_err("demo: %s: header malloc failed", __func__);
470 return SR_ERR_MALLOC;
473 packet->type = SR_DF_HEADER;
474 packet->payload = header;
475 header->feed_version = 1;
476 gettimeofday(&header->starttime, NULL);
477 sr_session_send(ctx->session_dev_id, packet);
479 /* Send metadata about the SR_DF_LOGIC packets to come. */
480 packet->type = SR_DF_META_LOGIC;
481 packet->payload = &meta;
482 meta.samplerate = cur_samplerate;
483 meta.num_probes = NUM_PROBES;
484 sr_session_send(ctx->session_dev_id, packet);
492 /* TODO: This stops acquisition on ALL devices, ignoring dev_index. */
493 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
495 /* Avoid compiler warnings. */
499 /* Stop generate thread. */
505 SR_PRIV struct sr_dev_driver demo_driver_info = {
507 .longname = "Demo driver and pattern generator",
510 .cleanup = hw_cleanup,
511 .dev_open = hw_dev_open,
512 .dev_close = hw_dev_close,
513 .dev_info_get = hw_dev_info_get,
514 .dev_status_get = hw_dev_status_get,
515 .hwcap_get_all = hw_hwcap_get_all,
516 .dev_config_set = hw_dev_config_set,
517 .dev_acquisition_start = hw_dev_acquisition_start,
518 .dev_acquisition_stop = hw_dev_acquisition_stop,