X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fdemo%2Fdemo.c;h=b7a07c12a3ad0b44470bf0e80db570fd59666ec8;hb=962af1a379f2c1715b22f0779ed3ebc6f0d8c2ec;hp=b8f36fbfd4e77c967c7994b016f799efe3861b4c;hpb=6239c175c1b967b577f760032d326322dd4c4576;p=libsigrok.git diff --git a/hardware/demo/demo.c b/hardware/demo/demo.c index b8f36fbf..b7a07c12 100644 --- a/hardware/demo/demo.c +++ b/hardware/demo/demo.c @@ -1,7 +1,9 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * * 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 @@ -19,314 +21,504 @@ */ #include +#include #include -#include -#include "config.h" +#ifdef _WIN32 +#include +#include +#define pipe(fds) _pipe(fds, 4096, _O_BINARY) +#endif +#include "libsigrok.h" +#include "libsigrok-internal.h" + +/* Message logging helpers with subsystem-specific prefix string. */ +#define LOG_PREFIX "demo: " +#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args) +#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args) +#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args) +#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args) +#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args) +#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args) + +/* TODO: Number of probes should be configurable. */ +#define NUM_PROBES 8 + +#define DEMONAME "Demo device" + +/* The size of chunks to send through the session bus. */ +/* TODO: Should be configurable. */ +#define BUFSIZE 4096 + +#define STR_PATTERN_SIGROK "sigrok" +#define STR_PATTERN_RANDOM "random" +#define STR_PATTERN_INC "incremental" +#define STR_PATTERN_ALL_LOW "all-low" +#define STR_PATTERN_ALL_HIGH "all-high" + +/* 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, + + /** Pattern where all probes have a low logic state. */ + PATTERN_ALL_LOW, + + /** Pattern where all probes have a high logic state. */ + PATTERN_ALL_HIGH, +}; -#define NUM_PROBES 8 -#define NUM_TRIGGER_STAGES 4 -#define TRIGGER_TYPES "01" +/* Private, per-device-instance driver context. */ +struct dev_context { + struct sr_dev_inst *sdi; + int pipe_fds[2]; + GIOChannel *channel; + uint64_t cur_samplerate; + uint64_t limit_samples; + uint64_t limit_msec; + uint8_t sample_generator; + uint64_t samples_counter; + void *cb_data; + int64_t starttime; +}; -/* Software trigger implementation: positive values indicate trigger stage. */ -#define TRIGGER_FIRED -1 +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 int capabilities[] = { - HWCAP_LOGIC_ANALYZER, - HWCAP_SAMPLERATE, - HWCAP_LIMIT_SAMPLES, +static const uint64_t samplerates[] = { + SR_HZ(1), + SR_GHZ(1), + SR_HZ(1), }; -/* 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 const char *pattern_strings[] = { + "sigrok", + "random", + "incremental", + "all-low", + "all-high", }; -static struct samplerates samplerates = { - KHZ(100), - MHZ(24), - 0, - supported_samplerates, +/* 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, }; -/* 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; +/* Private, per-device-instance driver context. */ +/* TODO: struct context as with the other drivers. */ -static int hw_set_configuration(int device_index, int capability, void *value); -static void hw_stop_acquisition(int device_index, gpointer session_device_id); +/* 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 int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data); + +static int dev_clear(void) +{ + return std_dev_clear(di, NULL); +} -#if 0 -static int configure_probes(GSList *probes) +static int init(struct sr_context *sr_ctx) { - 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; + return std_init(sr_ctx, di, LOG_PREFIX); +} + +static GSList *scan(GSList *options) +{ + struct sr_dev_inst *sdi; + struct sr_probe *probe; + struct drv_context *drvc; + struct dev_context *devc; + GSList *devices; + int i; + + (void)options; + + drvc = di->priv; + + devices = NULL; + + sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL); + if (!sdi) { + sr_err("Device instance creation failed."); + return NULL; } + sdi->driver = di; - 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; - } + 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); } - 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; + devices = g_slist_append(devices, sdi); + drvc->instances = g_slist_append(drvc->instances, sdi); - return SIGROK_OK; + if (!(devc = g_try_malloc(sizeof(struct dev_context)))) { + sr_err("Device context malloc failed."); + return NULL; + } + + devc->sdi = sdi; + devc->cur_samplerate = SR_KHZ(200); + devc->limit_samples = 0; + devc->limit_msec = 0; + devc->sample_generator = PATTERN_SIGROK; + + sdi->priv = devc; + + return devices; } -#endif -static int hw_init(char *deviceinfo) +static GSList *dev_list(void) { - /* Avoid compiler warning. */ - deviceinfo = deviceinfo; - - /* Nothing needed so far. */ - return 1; /* FIXME? */ + return ((struct drv_context *)(di->priv))->instances; } -static int hw_opendev(int device_index) +static int dev_open(struct sr_dev_inst *sdi) { - /* Avoid compiler warning. */ - device_index = device_index; + sdi->status = SR_ST_ACTIVE; - /* Nothing needed so far. */ - return SIGROK_OK; + return SR_OK; } -static void hw_closedev(int device_index) +static int dev_close(struct sr_dev_inst *sdi) { - /* Avoid compiler warning. */ - device_index = device_index; + sdi->status = SR_ST_INACTIVE; - /* Nothing needed so far. */ + return SR_OK; } -static void hw_cleanup(void) +static int cleanup(void) { - /* Nothing needed so far. */ + return dev_clear(); } -static void *hw_get_device_info(int device_index, int device_info_id) +static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi, + const struct sr_probe_group *probe_group) { - void *info = NULL; + struct dev_context *const devc = sdi->priv; - /* Avoid compiler warning. */ - device_index = device_index; + (void)probe_group; - switch (device_info_id) { - case DI_INSTANCE: - /// info = sdi; - /* TODO */ + switch (id) { + case SR_CONF_SAMPLERATE: + *data = g_variant_new_uint64(devc->cur_samplerate); break; - case DI_NUM_PROBES: - info = GINT_TO_POINTER(NUM_PROBES); + case SR_CONF_LIMIT_SAMPLES: + *data = g_variant_new_uint64(devc->limit_samples); break; - case DI_SAMPLERATES: - info = &samplerates; + case SR_CONF_LIMIT_MSEC: + *data = g_variant_new_uint64(devc->limit_msec); break; - case DI_TRIGGER_TYPES: - info = TRIGGER_TYPES; - break; - case DI_CUR_SAMPLERATE: - info = &cur_samplerate; + case SR_CONF_PATTERN_MODE: + switch (devc->sample_generator) { + case PATTERN_SIGROK: + *data = g_variant_new_string(STR_PATTERN_SIGROK); + break; + case PATTERN_RANDOM: + *data = g_variant_new_string(STR_PATTERN_RANDOM); + break; + case PATTERN_INC: + *data = g_variant_new_string(STR_PATTERN_INC); + break; + case PATTERN_ALL_LOW: + *data = g_variant_new_string(STR_PATTERN_ALL_LOW); + break; + case PATTERN_ALL_HIGH: + *data = g_variant_new_string(STR_PATTERN_ALL_HIGH); + break; + } break; + default: + return SR_ERR_NA; } - return info; + return SR_OK; } -static int hw_get_status(int device_index) +static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi, + const struct sr_probe_group *probe_group) { - /* Avoid compiler warning. */ - device_index = device_index; + int ret; + const char *stropt; + + (void)probe_group; + struct dev_context *const devc = sdi->priv; + + if (sdi->status != SR_ST_ACTIVE) + return SR_ERR_DEV_CLOSED; + + if (id == SR_CONF_SAMPLERATE) { + devc->cur_samplerate = g_variant_get_uint64(data); + sr_dbg("%s: setting samplerate to %" PRIu64, __func__, + devc->cur_samplerate); + ret = SR_OK; + } else if (id == SR_CONF_LIMIT_SAMPLES) { + devc->limit_msec = 0; + devc->limit_samples = g_variant_get_uint64(data); + sr_dbg("%s: setting limit_samples to %" PRIu64, __func__, + devc->limit_samples); + ret = SR_OK; + } else if (id == SR_CONF_LIMIT_MSEC) { + devc->limit_msec = g_variant_get_uint64(data); + devc->limit_samples = 0; + sr_dbg("%s: setting limit_msec to %" PRIu64, __func__, + devc->limit_msec); + ret = SR_OK; + } else if (id == SR_CONF_PATTERN_MODE) { + stropt = g_variant_get_string(data, NULL); + ret = SR_OK; + if (!strcmp(stropt, STR_PATTERN_SIGROK)) { + devc->sample_generator = PATTERN_SIGROK; + } else if (!strcmp(stropt, STR_PATTERN_RANDOM)) { + devc->sample_generator = PATTERN_RANDOM; + } else if (!strcmp(stropt, STR_PATTERN_INC)) { + devc->sample_generator = PATTERN_INC; + } else if (!strcmp(stropt, STR_PATTERN_ALL_LOW)) { + devc->sample_generator = PATTERN_ALL_LOW; + } else if (!strcmp(stropt, STR_PATTERN_ALL_HIGH)) { + devc->sample_generator = PATTERN_ALL_HIGH; + } else { + ret = SR_ERR; + } + sr_dbg("%s: setting pattern to %d", + __func__, devc->sample_generator); + } else { + ret = SR_ERR_NA; + } - return 0; /* FIXME */ + return ret; } -static int *hw_get_capabilities(void) +static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi, + const struct sr_probe_group *probe_group) { - return capabilities; -} + GVariant *gvar; + GVariantBuilder gvb; -static int hw_set_configuration(int device_index, int capability, void *value) -{ - int ret; + (void)sdi; + (void)probe_group; - /* Avoid compiler warning. */ - device_index = device_index; - - if (capability == 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; - } else { - ret = SIGROK_ERR; + switch (key) { + case SR_CONF_DEVICE_OPTIONS: + *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, + hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t)); + break; + case SR_CONF_SAMPLERATE: + g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}")); + gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates, + ARRAY_SIZE(samplerates), sizeof(uint64_t)); + g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar); + *data = g_variant_builder_end(&gvb); + break; + case SR_CONF_PATTERN_MODE: + *data = g_variant_new_strv(pattern_strings, ARRAY_SIZE(pattern_strings)); + break; + default: + return SR_ERR_NA; } - return ret; + return SR_OK; } -static int hw_start_acquisition(int device_index, gpointer session_device_id) +static void samples_generator(uint8_t *buf, uint64_t size, + struct dev_context *devc) { - struct datafeed_packet *packet; - struct datafeed_header *header; - unsigned char *buf; - - /* Avoid compiler warning. */ - device_index = device_index; - - packet = malloc(sizeof(struct datafeed_packet)); - header = malloc(sizeof(struct datafeed_header)); - buf = malloc(2048); - if (!packet || !header || !buf) - return SIGROK_ERR_MALLOC; - - /* FIXME */ - memset(buf, 0x55, 2048); - - 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); - - return SIGROK_OK; + static uint64_t p = 0; + uint64_t i; + + /* TODO: Needed? */ + memset(buf, 0, size); + + switch (devc->sample_generator) { + case PATTERN_SIGROK: /* sigrok pattern */ + for (i = 0; i < size; i++) { + *(buf + i) = ~(pattern_sigrok[ + p++ % sizeof(pattern_sigrok)] >> 1); + } + 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) = p++; + break; + 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; + } } -#if 0 -void receive_transfer(struct libusb_transfer *transfer) +/* Callback handling data */ +static int receive_data(int fd, int revents, void *cb_data) { - 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"); + struct dev_context *devc = cb_data; + struct sr_datafeed_packet packet; + 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 * devc->cur_samplerate / 1000000; + /* Of those, how many do we still have to send? */ + samples_to_send = expected_samplenum - devc->samples_counter; + + if (devc->limit_samples) { + samples_to_send = MIN(samples_to_send, + devc->limit_samples - devc->samples_counter); } - trigger_offset = 0; - if (trigger_stage >= 0) { - for (i = 0; i < cur_buflen; i++) { - trigger_helper(i, cur_buf, &packet, user_data, - &trigger_offset); - } + 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->cb_data, &packet); + devc->samples_counter += sending_now; } - 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); - } - } else { - /* - * TODO: Buffer pre-trigger data in capture - * ratio-sized buffer. - */ + if (devc->limit_samples && + devc->samples_counter >= devc->limit_samples) { + sr_info("Requested number of samples reached."); + dev_acquisition_stop(devc->sdi, cb_data); + return TRUE; } + + 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 dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data) +{ + struct dev_context *const devc = sdi->priv; + + if (sdi->status != SR_ST_ACTIVE) + return SR_ERR_DEV_CLOSED; + + devc->cb_data = 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->channel = g_io_channel_unix_new(devc->pipe_fds[0]); + + g_io_channel_set_flags(devc->channel, G_IO_FLAG_NONBLOCK, NULL); + + /* Set channel encoding to binary (default is UTF-8). */ + g_io_channel_set_encoding(devc->channel, NULL, NULL); + + /* Make channels to unbuffered. */ + g_io_channel_set_buffered(devc->channel, FALSE); + + sr_session_source_add_channel(devc->channel, G_IO_IN | G_IO_ERR, + 40, receive_data, devc); + + /* Send header packet to the session bus. */ + std_session_send_df_header(cb_data, LOG_PREFIX); + + /* We use this timestamp to decide how many more samples to send. */ + devc->starttime = g_get_monotonic_time(); + + return SR_OK; +} + +static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data) { - struct datafeed_packet packet; + struct dev_context *const devc = sdi->priv; + struct sr_datafeed_packet packet; + + (void)cb_data; - /* QUICK HACK */ - device_index = device_index; + sr_dbg("Stopping aquisition."); - packet.type = DF_END; - session_bus(session_device_id, &packet); + sr_session_source_remove_channel(devc->channel); + g_io_channel_shutdown(devc->channel, FALSE, NULL); + g_io_channel_unref(devc->channel); + devc->channel = NULL; - /// receive_transfer(NULL); + /* Send last packet. */ + packet.type = SR_DF_END; + sr_session_send(devc->cb_data, &packet); - /* TODO: Need to cancel and free any queued up transfers. */ + return SR_OK; } -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, +SR_PRIV struct sr_dev_driver demo_driver_info = { + .name = "demo", + .longname = "Demo driver and pattern generator", + .api_version = 1, + .init = init, + .cleanup = cleanup, + .scan = scan, + .dev_list = dev_list, + .dev_clear = dev_clear, + .config_get = config_get, + .config_set = config_set, + .config_list = config_list, + .dev_open = dev_open, + .dev_close = dev_close, + .dev_acquisition_start = dev_acquisition_start, + .dev_acquisition_stop = dev_acquisition_stop, + .priv = NULL, };