* This file is part of the sigrok project.
*
* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*/
#include <stdlib.h>
+#include <unistd.h>
#include <string.h>
#include <sigrok.h>
+#include <sigrok-internal.h>
+#ifdef _WIN32
+#include <io.h>
+#include <fcntl.h>
+#define pipe(fds) _pipe(fds, 4096, _O_BINARY)
+#endif
#include "config.h"
-#define NUM_PROBES 8
-#define NUM_TRIGGER_STAGES 4
-#define TRIGGER_TYPES "01"
+#define NUM_PROBES 8
+#define DEMONAME "Demo device"
+/* size of chunks to send through the session bus */
+#define BUFSIZE 4096
+
+/* Supported patterns which we can generate */
+enum {
+ /**
+ * Pattern which spells "sigrok" using '0's (with '1's as "background")
+ * when displayed using the 'bits' output format.
+ */
+ PATTERN_SIGROK,
+
+ /**
+ * Pattern which consists of (pseudo-)random values on all probes.
+ */
+ PATTERN_RANDOM,
+
+ /**
+ * Pattern which consists of incrementing numbers.
+ * TODO: Better description.
+ */
+ PATTERN_INC,
+};
-/* Software trigger implementation: positive values indicate trigger stage. */
-#define TRIGGER_FIRED -1
+/* FIXME: Should not be global. */
+GIOChannel *channels[2];
+
+struct databag {
+ int pipe_fds[2];
+ uint8_t sample_generator;
+ uint8_t thread_running;
+ uint64_t samples_counter;
+ int device_index;
+ gpointer session_device_id;
+ GTimer *timer;
+};
static int capabilities[] = {
- HWCAP_LOGIC_ANALYZER,
- HWCAP_SAMPLERATE,
- HWCAP_LIMIT_SAMPLES,
+ SR_HWCAP_LOGIC_ANALYZER,
+ SR_HWCAP_SAMPLERATE,
+ SR_HWCAP_PATTERN_MODE,
+ SR_HWCAP_LIMIT_SAMPLES,
+ SR_HWCAP_LIMIT_MSEC,
+ SR_HWCAP_CONTINUOUS,
};
-/* Random selection of samplerates this "device" shall support. */
-static uint64_t supported_samplerates[] = {
- KHZ(100),
- KHZ(500),
- MHZ(1),
- MHZ(2),
- MHZ(12),
- MHZ(24),
- 0,
+static struct sr_samplerates samplerates = {
+ SR_HZ(1),
+ SR_GHZ(1),
+ SR_HZ(1),
+ NULL,
};
-static struct samplerates samplerates = {
- KHZ(100),
- MHZ(24),
- 0,
- supported_samplerates,
+static const char *pattern_strings[] = {
+ "random",
+ "incremental",
+ NULL,
};
-/* TODO: All of these should go in a device-specific struct. */
-static uint64_t cur_samplerate = 0;
-static uint64_t limit_samples = 0;
-// static uint8_t probe_mask = 0;
-// static uint8_t trigger_mask[NUM_TRIGGER_STAGES] = { 0 };
-// static uint8_t trigger_value[NUM_TRIGGER_STAGES] = { 0 };
-// static uint8_t trigger_buffer[NUM_TRIGGER_STAGES] = { 0 };
+static uint8_t pattern_sigrok[] = {
+ 0x4c, 0x92, 0x92, 0x92, 0x64, 0x00, 0x00, 0x00,
+ 0x82, 0xfe, 0xfe, 0x82, 0x00, 0x00, 0x00, 0x00,
+ 0x7c, 0x82, 0x82, 0x92, 0x74, 0x00, 0x00, 0x00,
+ 0xfe, 0x12, 0x12, 0x32, 0xcc, 0x00, 0x00, 0x00,
+ 0x7c, 0x82, 0x82, 0x82, 0x7c, 0x00, 0x00, 0x00,
+ 0xfe, 0x10, 0x28, 0x44, 0x82, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+};
-// static int trigger_stage = TRIGGER_FIRED;
+/* List of struct sr_device_instance, maintained by opendev()/closedev(). */
+static GSList *device_instances = NULL;
+static uint64_t cur_samplerate = SR_KHZ(200);
+static uint64_t limit_samples = 0;
+static uint64_t limit_msec = 0;
+static int default_pattern = PATTERN_SIGROK;
+static GThread *my_thread;
+static int thread_running;
-static int hw_set_configuration(int device_index, int capability, void *value);
static void hw_stop_acquisition(int device_index, gpointer session_device_id);
-#if 0
-static int configure_probes(GSList *probes)
+static int hw_init(const char *deviceinfo)
{
- struct probe *probe;
- GSList *l;
- int probe_bit, stage, i;
- char *tc;
-
- probe_mask = 0;
- for (i = 0; i < NUM_TRIGGER_STAGES; i++) {
- trigger_mask[i] = 0;
- trigger_value[i] = 0;
- }
+ struct sr_device_instance *sdi;
- stage = -1;
- for (l = probes; l; l = l->next) {
- probe = (struct probe *)l->data;
- if (!(probe->enabled))
- continue;
- probe_bit = 1 << (probe->index - 1);
- probe_mask |= probe_bit;
- if (!(probe->trigger))
- continue;
-
- stage = 0;
- for (tc = probe->trigger; *tc; tc++) {
- trigger_mask[stage] |= probe_bit;
- if (*tc == '1')
- trigger_value[stage] |= probe_bit;
- stage++;
- if (stage > NUM_TRIGGER_STAGES)
- return SIGROK_ERR;
- }
- }
-
- if (stage == -1)
- /*
- * We didn't configure any triggers, make sure acquisition
- * doesn't wait for any.
- */
- trigger_stage = TRIGGER_FIRED;
- else
- trigger_stage = 0;
+ /* Avoid compiler warnings. */
+ deviceinfo = deviceinfo;
- return SIGROK_OK;
-}
-#endif
+ sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
+ if (!sdi)
+ return 0;
-static int hw_init(char *deviceinfo)
-{
- /* Avoid compiler warning. */
- deviceinfo = deviceinfo;
+ device_instances = g_slist_append(device_instances, sdi);
- /* Nothing needed so far. */
- return 1; /* FIXME? */
+ return 1;
}
static int hw_opendev(int device_index)
{
- /* Avoid compiler warning. */
+ /* Avoid compiler warnings. */
device_index = device_index;
/* Nothing needed so far. */
- return SIGROK_OK;
+
+ return SR_OK;
}
-static void hw_closedev(int device_index)
+static int hw_closedev(int device_index)
{
- /* Avoid compiler warning. */
+ /* Avoid compiler warnings. */
device_index = device_index;
/* Nothing needed so far. */
+
+ return SR_OK;
}
static void hw_cleanup(void)
static void *hw_get_device_info(int device_index, int device_info_id)
{
+ struct sr_device_instance *sdi;
void *info = NULL;
- /* Avoid compiler warning. */
- device_index = device_index;
+ if (!(sdi = sr_get_device_instance(device_instances, device_index)))
+ return NULL;
switch (device_info_id) {
- case DI_INSTANCE:
- /// info = sdi;
- /* TODO */
+ case SR_DI_INSTANCE:
+ info = sdi;
break;
- case DI_NUM_PROBES:
+ case SR_DI_NUM_PROBES:
info = GINT_TO_POINTER(NUM_PROBES);
break;
- case DI_SAMPLERATES:
+ case SR_DI_SAMPLERATES:
info = &samplerates;
break;
- case DI_TRIGGER_TYPES:
- info = TRIGGER_TYPES;
- break;
- case DI_CUR_SAMPLERATE:
+ case SR_DI_CUR_SAMPLERATE:
info = &cur_samplerate;
break;
+ case SR_DI_PATTERNMODES:
+ info = &pattern_strings;
+ break;
}
return info;
static int hw_get_status(int device_index)
{
- /* Avoid compiler warning. */
+ /* Avoid compiler warnings. */
device_index = device_index;
- return 0; /* FIXME */
+ return SR_ST_ACTIVE;
}
static int *hw_get_capabilities(void)
static int hw_set_configuration(int device_index, int capability, void *value)
{
int ret;
+ char *stropt;
- /* Avoid compiler warning. */
+ /* Avoid compiler warnings. */
device_index = device_index;
- if (capability == HWCAP_SAMPLERATE) {
+ if (capability == SR_HWCAP_PROBECONFIG) {
+ /* Nothing to do, but must be supported */
+ ret = SR_OK;
+ } else if (capability == SR_HWCAP_SAMPLERATE) {
cur_samplerate = *(uint64_t *)value;
- ret = SIGROK_OK;
- } else if (capability == HWCAP_PROBECONFIG) {
- // ret = configure_probes((GSList *) value);
- ret = SIGROK_ERR;
- } else if (capability == HWCAP_LIMIT_SAMPLES) {
- limit_samples = strtoull(value, NULL, 10);
- ret = SIGROK_OK;
+ sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
+ cur_samplerate);
+ ret = SR_OK;
+ } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
+ limit_samples = *(uint64_t *)value;
+ sr_dbg("demo: %s: setting limit_samples to %" PRIu64, __func__,
+ limit_samples);
+ ret = SR_OK;
+ } else if (capability == SR_HWCAP_LIMIT_MSEC) {
+ limit_msec = *(uint64_t *)value;
+ sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__,
+ limit_msec);
+ ret = SR_OK;
+ } else if (capability == SR_HWCAP_PATTERN_MODE) {
+ stropt = value;
+ if (!strcmp(stropt, "random")) {
+ default_pattern = PATTERN_RANDOM;
+ ret = SR_OK;
+ } else if (!strcmp(stropt, "incremental")) {
+ default_pattern = PATTERN_INC;
+ ret = SR_OK;
+ } else {
+ ret = SR_ERR;
+ }
+ sr_dbg("demo: %s: setting pattern to %d", __func__,
+ default_pattern);
} else {
- ret = SIGROK_ERR;
+ ret = SR_ERR;
}
return ret;
}
-static int hw_start_acquisition(int device_index, gpointer session_device_id)
+static void samples_generator(uint8_t *buf, uint64_t size, void *data)
{
- struct datafeed_packet *packet;
- struct datafeed_header *header;
- unsigned char *buf;
+ static uint64_t p = 0;
+ struct databag *mydata = data;
+ uint64_t i;
+
+ memset(buf, 0, size);
+
+ switch (mydata->sample_generator) {
+ case PATTERN_SIGROK:
+ for (i = 0; i < size; i++) {
+ *(buf + i) = ~(pattern_sigrok[p] >> 1);
+ if (++p == 64)
+ p = 0;
+ }
+ break;
+ case PATTERN_RANDOM: /* Random */
+ for (i = 0; i < size; i++)
+ *(buf + i) = (uint8_t)(rand() & 0xff);
+ break;
+ case PATTERN_INC: /* Simple increment */
+ for (i = 0; i < size; i++)
+ *(buf + i) = i;
+ break;
+ }
+}
- /* Avoid compiler warning. */
- device_index = device_index;
+/* Thread function */
+static void thread_func(void *data)
+{
+ struct databag *mydata = data;
+ uint8_t buf[BUFSIZE];
+ uint64_t nb_to_send = 0;
+ int bytes_written;
- packet = malloc(sizeof(struct datafeed_packet));
- header = malloc(sizeof(struct datafeed_header));
- buf = malloc(2048);
- if (!packet || !header || !buf)
- return SIGROK_ERR_MALLOC;
+ double time_cur, time_last, time_diff;
- /* FIXME */
- memset(buf, 0x55, 2048);
+ time_last = g_timer_elapsed(mydata->timer, NULL);
- packet->type = DF_HEADER;
- packet->length = sizeof(struct datafeed_header);
- packet->payload = (unsigned char *)header;
- header->feed_version = 1;
- gettimeofday(&header->starttime, NULL);
- header->samplerate = cur_samplerate;
- header->protocol_id = PROTO_RAW;
- header->num_probes = NUM_PROBES;
- session_bus(session_device_id, packet);
- free(header);
- free(packet);
+ while (thread_running) {
+ /* Rate control */
+ time_cur = g_timer_elapsed(mydata->timer, NULL);
- return SIGROK_OK;
-}
+ time_diff = time_cur - time_last;
+ time_last = time_cur;
-#if 0
-void receive_transfer(struct libusb_transfer *transfer)
-{
- static int num_samples = 0;
- static int empty_transfer_count = 0;
- struct datafeed_packet packet;
- void *user_data;
- int cur_buflen, trigger_offset, i;
- unsigned char *cur_buf, *new_buf;
-
- g_message("receive_transfer(): status %d received %d bytes",
- transfer->status, transfer->actual_length);
-
- /* Save incoming transfer before reusing the transfer struct. */
- cur_buf = transfer->buffer;
- cur_buflen = transfer->actual_length;
- user_data = transfer->user_data;
-
- /* Fire off a new request. */
- new_buf = g_malloc(4096);
- transfer->buffer = new_buf;
- transfer->length = 4096;
- if (libusb_submit_transfer(transfer) != 0) {
- /* TODO: Stop session? */
- g_warning("eek");
- }
+ nb_to_send = cur_samplerate * time_diff;
+
+ if (limit_samples)
+ nb_to_send = MIN(nb_to_send,
+ limit_samples - mydata->samples_counter);
+
+ /* Make sure we don't overflow. */
+ nb_to_send = MIN(nb_to_send, BUFSIZE);
+
+ if (nb_to_send) {
+ samples_generator(buf, nb_to_send, data);
+ mydata->samples_counter += nb_to_send;
+
+ g_io_channel_write_chars(channels[1], (gchar *)&buf,
+ nb_to_send, (gsize *)&bytes_written, NULL);
+ }
- trigger_offset = 0;
- if (trigger_stage >= 0) {
- for (i = 0; i < cur_buflen; i++) {
- trigger_helper(i, cur_buf, &packet, user_data,
- &trigger_offset);
+ /* Check if we're done. */
+ if ((limit_msec && time_cur * 1000 > limit_msec) ||
+ (limit_samples && mydata->samples_counter >= limit_samples))
+ {
+ close(mydata->pipe_fds[1]);
+ thread_running = 0;
}
+
+ g_usleep(10);
}
+}
- if (trigger_stage == TRIGGER_FIRED) {
- /* Send the incoming transfer to the session bus. */
- packet.type = DF_LOGIC8;
- packet.length = cur_buflen - trigger_offset;
- packet.payload = cur_buf + trigger_offset;
- session_bus(user_data, &packet);
- free(cur_buf);
-
- num_samples += cur_buflen;
- if ((unsigned int)num_samples > limit_samples) {
- hw_stop_acquisition(-1, user_data);
+/* Callback handling data */
+static int receive_data(int fd, int revents, void *user_data)
+{
+ struct sr_datafeed_packet packet;
+ char c[BUFSIZE];
+ gsize z;
+
+ /* Avoid compiler warnings. */
+ fd = fd;
+ revents = revents;
+
+ do {
+ g_io_channel_read_chars(channels[0],
+ (gchar *)&c, BUFSIZE, &z, NULL);
+
+ if (z > 0) {
+ packet.type = SR_DF_LOGIC;
+ packet.length = z;
+ packet.unitsize = 1;
+ packet.payload = c;
+ sr_session_bus(user_data, &packet);
}
- } else {
- /*
- * TODO: Buffer pre-trigger data in capture
- * ratio-sized buffer.
- */
+ } while (z > 0);
+
+ if (!thread_running && z <= 0)
+ {
+ /* Make sure we don't receive more packets */
+ g_io_channel_close(channels[0]);
+
+ /* Send last packet. */
+ packet.type = SR_DF_END;
+ sr_session_bus(user_data, &packet);
+
+ return FALSE;
}
+
+ return TRUE;
}
-#endif
-/* This stops acquisition on ALL devices, ignoring device_index. */
-static void hw_stop_acquisition(int device_index, gpointer session_device_id)
+static int hw_start_acquisition(int device_index, gpointer session_device_id)
{
- struct datafeed_packet packet;
+ struct sr_datafeed_packet *packet;
+ struct sr_datafeed_header *header;
+ struct databag *mydata;
+
+ /* TODO: 'mydata' is never g_free()'d? */
+ if (!(mydata = g_try_malloc(sizeof(struct databag)))) {
+ sr_err("demo: %s: mydata malloc failed", __func__);
+ return SR_ERR_MALLOC;
+ }
- /* QUICK HACK */
- device_index = device_index;
+ mydata->sample_generator = default_pattern;
+ mydata->session_device_id = session_device_id;
+ mydata->device_index = device_index;
+ mydata->samples_counter = 0;
+
+ if (pipe(mydata->pipe_fds))
+ return SR_ERR;
+
+ channels[0] = g_io_channel_unix_new(mydata->pipe_fds[0]);
+ channels[1] = g_io_channel_unix_new(mydata->pipe_fds[1]);
+
+ /* Set channel encoding to binary (default is UTF-8). */
+ g_io_channel_set_encoding(channels[0], NULL, NULL);
+ g_io_channel_set_encoding(channels[1], NULL, NULL);
+
+ /* Make channels to unbuffered. */
+ g_io_channel_set_buffered(channels[0], FALSE);
+ g_io_channel_set_buffered(channels[1], FALSE);
+
+ sr_source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40,
+ receive_data, session_device_id);
+
+ /* Run the demo thread. */
+ g_thread_init(NULL);
+ /* this needs to be done between g_thread_init() and g_thread_create() */
+ mydata->timer = g_timer_new();
+ thread_running = 1;
+ my_thread =
+ g_thread_create((GThreadFunc)thread_func, mydata, TRUE, NULL);
+ if (!my_thread)
+ return SR_ERR;
+
+ if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) {
+ sr_err("demo: %s: packet malloc failed", __func__);
+ return SR_ERR_MALLOC;
+ }
+
+ if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) {
+ sr_err("demo: %s: header malloc failed", __func__);
+ return SR_ERR_MALLOC;
+ }
- packet.type = DF_END;
- session_bus(session_device_id, &packet);
+ packet->type = SR_DF_HEADER;
+ packet->length = sizeof(struct sr_datafeed_header);
+ packet->payload = (unsigned char *)header;
+ header->feed_version = 1;
+ gettimeofday(&header->starttime, NULL);
+ header->samplerate = cur_samplerate;
+ header->protocol_id = SR_PROTO_RAW;
+ header->num_logic_probes = NUM_PROBES;
+ header->num_analog_probes = 0;
+ sr_session_bus(session_device_id, packet);
+ g_free(header);
+ g_free(packet);
+
+ return SR_OK;
+}
- /// receive_transfer(NULL);
+static void hw_stop_acquisition(int device_index, gpointer session_device_id)
+{
+ /* Avoid compiler warnings. */
+ device_index = device_index;
+ session_device_id = session_device_id;
- /* TODO: Need to cancel and free any queued up transfers. */
+ /* Stop generate thread. */
+ thread_running = 0;
}
-struct device_plugin demo_plugin_info = {
- "demo",
- 1,
- hw_init,
- hw_cleanup,
- hw_opendev,
- hw_closedev,
- hw_get_device_info,
- hw_get_status,
- hw_get_capabilities,
- hw_set_configuration,
- hw_start_acquisition,
- hw_stop_acquisition,
+struct sr_device_plugin demo_plugin_info = {
+ .name = "demo",
+ .longname = "Demo driver and pattern generator",
+ .api_version = 1,
+ .init = hw_init,
+ .cleanup = hw_cleanup,
+ .opendev = hw_opendev,
+ .closedev = hw_closedev,
+ .get_device_info = hw_get_device_info,
+ .get_status = hw_get_status,
+ .get_capabilities = hw_get_capabilities,
+ .set_configuration = hw_set_configuration,
+ .start_acquisition = hw_start_acquisition,
+ .stop_acquisition = hw_stop_acquisition,
};
projects / libsigrok.git / blobdiff