X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fdemo%2Fdemo.c;h=850cf8a8ef533b53a686951d9fe09ef773b32c6f;hb=1953564a96798bc298d1c94eb90c129adbde1c9e;hp=281d9da4521f50f9c1ed114486703ac58281de0b;hpb=4bfbf9fce71f91b3e7b7e968d436f7c436fc9648;p=libsigrok.git diff --git a/hardware/demo/demo.c b/hardware/demo/demo.c index 281d9da4..850cf8a8 100644 --- a/hardware/demo/demo.c +++ b/hardware/demo/demo.c @@ -3,6 +3,7 @@ * * Copyright (C) 2010 Uwe Hermann * Copyright (C) 2011 Olivier Fauchon + * Copyright (C) 2012 Alexandru Gagniuc * * 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 @@ -22,60 +23,99 @@ #include #include #include -#include #ifdef _WIN32 #include #include #define pipe(fds) _pipe(fds, 4096, _O_BINARY) #endif -#include "config.h" - +#include "libsigrok.h" +#include "libsigrok-internal.h" + +/* Message logging helpers with driver-specific prefix string. */ +#define DRIVER_LOG_DOMAIN "demo: " +#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args) +#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args) +#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args) +#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args) +#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args) +#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args) + +/* TODO: Number of probes should be configurable. */ #define NUM_PROBES 8 + #define DEMONAME "Demo device" -/* size of chunks to send through the session bus */ + +/* The size of chunks to send through the session bus. */ +/* TODO: Should be configurable. */ #define BUFSIZE 4096 +/* Supported patterns which we can generate */ enum { - GENMODE_DEFAULT, - GENMODE_RANDOM, - GENMODE_INC, + /** + * 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, + + /** Pattern where all probes have a low logic state. */ + PATTERN_ALL_LOW, + + /** Pattern where all probes have a high logic state. */ + PATTERN_ALL_HIGH, }; -GIOChannel *channels[2]; - -struct databag { +/* Private, per-device-instance driver context. */ +struct dev_context { int pipe_fds[2]; + GIOChannel *channels[2]; uint8_t sample_generator; - uint8_t thread_running; uint64_t samples_counter; - int device_index; - gpointer session_device_id; - GTimer *timer; + void *session_dev_id; + int64_t starttime; }; -static int capabilities[] = { - SR_HWCAP_LOGIC_ANALYZER, - SR_HWCAP_SAMPLERATE, - SR_HWCAP_PATTERN_MODE, - SR_HWCAP_LIMIT_SAMPLES, - SR_HWCAP_LIMIT_MSEC, - SR_HWCAP_CONTINUOUS, +static const int hwcaps[] = { + SR_CONF_LOGIC_ANALYZER, + SR_CONF_DEMO_DEV, + SR_CONF_SAMPLERATE, + SR_CONF_PATTERN_MODE, + SR_CONF_LIMIT_SAMPLES, + SR_CONF_LIMIT_MSEC, + SR_CONF_CONTINUOUS, }; -static struct sr_samplerates samplerates = { - 1, - GHZ(1), - 1, +static const struct sr_samplerates samplerates = { + SR_HZ(1), + SR_GHZ(1), + SR_HZ(1), NULL, }; -static const char *patternmodes[] = { +static const char *pattern_strings[] = { + "sigrok", "random", "incremental", + "all-low", + "all-high", + NULL, +}; + +/* We name the probes 0-7 on our demo driver. */ +static const char *probe_names[NUM_PROBES + 1] = { + "0", "1", "2", "3", "4", "5", "6", "7", NULL, }; -static uint8_t genmode_default[] = { +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, @@ -86,132 +126,173 @@ static uint8_t genmode_default[] = { 0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, }; -/* List of struct sr_device_instance, maintained by opendev()/closedev(). */ -static GSList *device_instances = NULL; -static uint64_t cur_samplerate = KHZ(200); +/* Private, per-device-instance driver context. */ +/* TODO: struct context as with the other drivers. */ + +/* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */ +SR_PRIV struct sr_dev_driver demo_driver_info; +static struct sr_dev_driver *di = &demo_driver_info; +static uint64_t cur_samplerate = SR_KHZ(200); static uint64_t limit_samples = 0; static uint64_t limit_msec = 0; -static int default_genmode = GENMODE_DEFAULT; -static GThread *my_thread; -static int thread_running; +static int default_pattern = PATTERN_SIGROK; + +static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data); + +static int clear_instances(void) +{ + /* Nothing needed so far. */ -static void hw_stop_acquisition(int device_index, gpointer session_device_id); + return SR_OK; +} + +static int hw_init(struct sr_context *sr_ctx) +{ + struct drv_context *drvc; + + if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) { + sr_err("Driver context malloc failed."); + return SR_ERR_MALLOC; + } + drvc->sr_ctx = sr_ctx; + di->priv = drvc; + + return SR_OK; +} -static int hw_init(char *deviceinfo) +static GSList *hw_scan(GSList *options) { - struct sr_device_instance *sdi; + struct sr_dev_inst *sdi; + struct sr_probe *probe; + struct drv_context *drvc; + GSList *devices; + int i; + + (void)options; - /* Avoid compiler warnings. */ - deviceinfo = deviceinfo; + drvc = di->priv; + devices = NULL; - sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL); - if (!sdi) + sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL); + if (!sdi) { + sr_err("%s: sr_dev_inst_new failed", __func__); return 0; + } + sdi->driver = di; - device_instances = g_slist_append(device_instances, sdi); + for (i = 0; probe_names[i]; i++) { + if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, + probe_names[i]))) + return NULL; + sdi->probes = g_slist_append(sdi->probes, probe); + } + + devices = g_slist_append(devices, sdi); + drvc->instances = g_slist_append(drvc->instances, sdi); + + return devices; +} + +static GSList *hw_dev_list(void) +{ + struct drv_context *drvc; - return 1; + drvc = di->priv; + + return drvc->instances; } -static int hw_opendev(int device_index) +static int hw_dev_open(struct sr_dev_inst *sdi) { - /* Avoid compiler warnings. */ - device_index = device_index; + (void)sdi; /* Nothing needed so far. */ + return SR_OK; } -static void hw_closedev(int device_index) +static int hw_dev_close(struct sr_dev_inst *sdi) { - /* Avoid compiler warnings. */ - device_index = device_index; + (void)sdi; /* Nothing needed so far. */ + + return SR_OK; } -static void hw_cleanup(void) +static int hw_cleanup(void) { /* Nothing needed so far. */ + return SR_OK; } -static void *hw_get_device_info(int device_index, int device_info_id) +static int hw_info_get(int info_id, const void **data, + const struct sr_dev_inst *sdi) { - struct sr_device_instance *sdi; - void *info = NULL; - - if (!(sdi = sr_get_device_instance(device_instances, device_index))) - return NULL; + (void)sdi; - switch (device_info_id) { - case SR_DI_INSTANCE: - info = sdi; - break; - case SR_DI_NUM_PROBES: - info = GINT_TO_POINTER(NUM_PROBES); + switch (info_id) { + case SR_DI_HWCAPS: + *data = hwcaps; break; case SR_DI_SAMPLERATES: - info = &samplerates; + *data = &samplerates; break; case SR_DI_CUR_SAMPLERATE: - info = &cur_samplerate; + *data = &cur_samplerate; break; - case SR_DI_PATTERNMODES: - info = &patternmodes; + case SR_DI_PATTERNS: + *data = &pattern_strings; break; + default: + return SR_ERR_ARG; } - return info; -} - -static int hw_get_status(int device_index) -{ - /* Avoid compiler warnings. */ - device_index = device_index; - - return SR_ST_ACTIVE; -} - -static int *hw_get_capabilities(void) -{ - return capabilities; + return SR_OK; } -static int hw_set_configuration(int device_index, int capability, void *value) +static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap, + const void *value) { int ret; - uint64_t *tmp_u64; - char *stropt; + const char *stropt; - /* Avoid compiler warnings. */ - device_index = device_index; + (void)sdi; - if (capability == SR_HWCAP_PROBECONFIG) { - /* Nothing to do, but must be supported */ + if (hwcap == SR_CONF_SAMPLERATE) { + cur_samplerate = *(const uint64_t *)value; + sr_dbg("%s: setting samplerate to %" PRIu64, __func__, + cur_samplerate); ret = SR_OK; - } else if (capability == SR_HWCAP_SAMPLERATE) { - tmp_u64 = value; - cur_samplerate = *tmp_u64; + } else if (hwcap == SR_CONF_LIMIT_SAMPLES) { + limit_msec = 0; + limit_samples = *(const uint64_t *)value; + sr_dbg("%s: setting limit_samples to %" PRIu64, __func__, + limit_samples); ret = SR_OK; - } else if (capability == SR_HWCAP_LIMIT_SAMPLES) { - tmp_u64 = value; - limit_samples = *tmp_u64; + } else if (hwcap == SR_CONF_LIMIT_MSEC) { + limit_msec = *(const uint64_t *)value; + limit_samples = 0; + sr_dbg("%s: setting limit_msec to %" PRIu64, __func__, + limit_msec); ret = SR_OK; - } else if (capability == SR_HWCAP_LIMIT_MSEC) { - tmp_u64 = value; - limit_msec = *tmp_u64; - ret = SR_OK; - } else if (capability == SR_HWCAP_PATTERN_MODE) { + } else if (hwcap == SR_CONF_PATTERN_MODE) { stropt = value; - if (!strcmp(stropt, "random")) { - default_genmode = GENMODE_RANDOM; - ret = SR_OK; + ret = SR_OK; + if (!strcmp(stropt, "sigrok")) { + default_pattern = PATTERN_SIGROK; + } else if (!strcmp(stropt, "random")) { + default_pattern = PATTERN_RANDOM; } else if (!strcmp(stropt, "incremental")) { - default_genmode = GENMODE_INC; - ret = SR_OK; + default_pattern = PATTERN_INC; + } else if (!strcmp(stropt, "all-low")) { + default_pattern = PATTERN_ALL_LOW; + } else if (!strcmp(stropt, "all-high")) { + default_pattern = PATTERN_ALL_HIGH; } else { ret = SR_ERR; } + sr_dbg("%s: setting pattern to %d", __func__, default_pattern); } else { ret = SR_ERR; } @@ -219,205 +300,201 @@ static int hw_set_configuration(int device_index, int capability, void *value) return ret; } -static void samples_generator(uint8_t *buf, uint64_t size, void *data) +static void samples_generator(uint8_t *buf, uint64_t size, + struct dev_context *devc) { static uint64_t p = 0; - struct databag *mydata = data; uint64_t i; + /* TODO: Needed? */ memset(buf, 0, size); - switch (mydata->sample_generator) { - case GENMODE_DEFAULT: + switch (devc->sample_generator) { + case PATTERN_SIGROK: /* sigrok pattern */ for (i = 0; i < size; i++) { - *(buf + i) = ~(genmode_default[p] >> 1); + *(buf + i) = ~(pattern_sigrok[p] >> 1); if (++p == 64) p = 0; } break; - case GENMODE_RANDOM: /* Random */ + case PATTERN_RANDOM: /* Random */ for (i = 0; i < size; i++) *(buf + i) = (uint8_t)(rand() & 0xff); break; - case GENMODE_INC: /* Simple increment */ + case PATTERN_INC: /* Simple increment */ for (i = 0; i < size; i++) *(buf + i) = i; break; - } -} - -/* 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; - - double time_cur, time_last, time_diff; - - time_last = g_timer_elapsed(mydata->timer, NULL); - - while (thread_running) { - /* Rate control */ - time_cur = g_timer_elapsed(mydata->timer, NULL); - - time_diff = time_cur - time_last; - time_last = time_cur; - - 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); - } - - /* 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); + case PATTERN_ALL_LOW: /* All probes are low */ + memset(buf, 0x00, size); + break; + case PATTERN_ALL_HIGH: /* All probes are high */ + memset(buf, 0xff, size); + break; + default: + sr_err("Unknown pattern: %d.", devc->sample_generator); + break; } } /* Callback handling data */ -static int receive_data(int fd, int revents, void *user_data) +static int receive_data(int fd, int revents, void *cb_data) { + struct dev_context *devc = cb_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); - } - } while (z > 0); - - if (!thread_running && z <= 0) - { - /* Make sure we don't receive more packets */ - g_io_channel_close(channels[0]); + struct sr_datafeed_logic logic; + uint8_t buf[BUFSIZE]; + static uint64_t samples_to_send, expected_samplenum, sending_now; + int64_t time, elapsed; + + (void)fd; + (void)revents; + + /* How many "virtual" samples should we have collected by now? */ + time = g_get_monotonic_time(); + elapsed = time - devc->starttime; + expected_samplenum = elapsed * cur_samplerate / 1000000; + /* Of those, how many do we still have to send? */ + samples_to_send = expected_samplenum - devc->samples_counter; + + if (limit_samples) { + samples_to_send = MIN(samples_to_send, + limit_samples - devc->samples_counter); + } - /* Send last packet. */ - packet.type = SR_DF_END; - sr_session_bus(user_data, &packet); + while (samples_to_send > 0) { + sending_now = MIN(samples_to_send, sizeof(buf)); + samples_to_send -= sending_now; + samples_generator(buf, sending_now, devc); + + packet.type = SR_DF_LOGIC; + packet.payload = &logic; + logic.length = sending_now; + logic.unitsize = 1; + logic.data = buf; + sr_session_send(devc->session_dev_id, &packet); + devc->samples_counter += sending_now; + } - return FALSE; + if (limit_samples && devc->samples_counter >= limit_samples) { + sr_info("Requested number of samples reached."); + hw_dev_acquisition_stop(NULL, cb_data); + return TRUE; } return TRUE; } -static int hw_start_acquisition(int device_index, gpointer session_device_id) +static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi, + void *cb_data) { struct sr_datafeed_packet *packet; struct sr_datafeed_header *header; - struct databag *mydata; + struct dev_context *devc; - mydata = malloc(sizeof(struct databag)); - if (!mydata) - return SR_ERR_MALLOC; + (void)sdi; - mydata->sample_generator = default_genmode; - mydata->session_device_id = session_device_id; - mydata->device_index = device_index; - mydata->samples_counter = 0; + sr_dbg("Starting acquisition."); + + /* TODO: 'devc' is never g_free()'d? */ + if (!(devc = g_try_malloc(sizeof(struct dev_context)))) { + sr_err("%s: devc malloc failed", __func__); + return SR_ERR_MALLOC; + } - if (pipe(mydata->pipe_fds)) + devc->sample_generator = default_pattern; + devc->session_dev_id = cb_data; + devc->samples_counter = 0; + + /* + * Setting two channels connected by a pipe is a remnant from when the + * demo driver generated data in a thread, and collected and sent the + * data in the main program loop. + * They are kept here because it provides a convenient way of setting + * up a timeout-based polling mechanism. + */ + if (pipe(devc->pipe_fds)) { + /* TODO: Better error message. */ + sr_err("%s: pipe() failed", __func__); return SR_ERR; + } + + devc->channels[0] = g_io_channel_unix_new(devc->pipe_fds[0]); + devc->channels[1] = g_io_channel_unix_new(devc->pipe_fds[1]); - channels[0] = g_io_channel_unix_new(mydata->pipe_fds[0]); - channels[1] = g_io_channel_unix_new(mydata->pipe_fds[1]); + g_io_channel_set_flags(devc->channels[0], G_IO_FLAG_NONBLOCK, NULL); /* 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); + g_io_channel_set_encoding(devc->channels[0], NULL, NULL); + g_io_channel_set_encoding(devc->channels[1], NULL, NULL); /* Make channels to unbuffered. */ - g_io_channel_set_buffered(channels[0], FALSE); - g_io_channel_set_buffered(channels[1], FALSE); - - 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; + g_io_channel_set_buffered(devc->channels[0], FALSE); + g_io_channel_set_buffered(devc->channels[1], FALSE); - packet = malloc(sizeof(struct sr_datafeed_packet)); - header = malloc(sizeof(struct sr_datafeed_header)); - if (!packet || !header) + sr_session_source_add_channel(devc->channels[0], G_IO_IN | G_IO_ERR, + 40, receive_data, devc); + + if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) { + sr_err("%s: packet malloc failed", __func__); return SR_ERR_MALLOC; + } + + if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) { + sr_err("%s: header malloc failed", __func__); + return SR_ERR_MALLOC; + } packet->type = SR_DF_HEADER; - packet->length = sizeof(struct sr_datafeed_header); - packet->payload = (unsigned char *)header; + packet->payload = 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); - free(header); - free(packet); + sr_session_send(devc->session_dev_id, packet); + + /* We use this timestamp to decide how many more samples to send. */ + devc->starttime = g_get_monotonic_time(); + + g_free(header); + g_free(packet); return SR_OK; } -static void hw_stop_acquisition(int device_index, gpointer session_device_id) +static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) { - /* Avoid compiler warnings. */ - device_index = device_index; - session_device_id = session_device_id; + struct dev_context *devc; + struct sr_datafeed_packet packet; + + (void)sdi; - /* Stop generate thread. */ - thread_running = 0; + devc = cb_data; + + sr_dbg("Stopping aquisition."); + + sr_session_source_remove_channel(devc->channels[0]); + g_io_channel_shutdown(devc->channels[0], FALSE, NULL); + + /* Send last packet. */ + packet.type = SR_DF_END; + sr_session_send(devc->session_dev_id, &packet); + + return SR_OK; } -struct sr_device_plugin demo_plugin_info = { - "demo", - "Demo driver and pattern generator", - 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, +SR_PRIV struct sr_dev_driver demo_driver_info = { + .name = "demo", + .longname = "Demo driver and pattern generator", + .api_version = 1, + .init = hw_init, + .cleanup = hw_cleanup, + .scan = hw_scan, + .dev_list = hw_dev_list, + .dev_clear = clear_instances, + .dev_open = hw_dev_open, + .dev_close = hw_dev_close, + .info_get = hw_info_get, + .dev_config_set = hw_dev_config_set, + .dev_acquisition_start = hw_dev_acquisition_start, + .dev_acquisition_stop = hw_dev_acquisition_stop, + .priv = NULL, };