X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fdemo%2Fdemo.c;h=cdd4d1d3415045605f7adc82fd28c024c32e5295;hb=dcf03d6dbdba67eb92ee887de1bc72816a3cd01b;hp=fda8091bbced50fe915ce8834d502c34751633dc;hpb=d81d29333e255a236b029860683f4bfadd1c15e3;p=libsigrok.git diff --git a/hardware/demo/demo.c b/hardware/demo/demo.c index fda8091b..cdd4d1d3 100644 --- a/hardware/demo/demo.c +++ b/hardware/demo/demo.c @@ -22,52 +22,100 @@ #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" +/* 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]; +/* FIXME: Should not be global. */ -struct databag { +struct 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; + int dev_index; + void *session_dev_id; GTimer *timer; }; -static int capabilities[] = { +static const int hwcaps[] = { SR_HWCAP_LOGIC_ANALYZER, + SR_HWCAP_DEMO_DEV, + SR_HWCAP_SAMPLERATE, SR_HWCAP_PATTERN_MODE, SR_HWCAP_LIMIT_SAMPLES, SR_HWCAP_LIMIT_MSEC, SR_HWCAP_CONTINUOUS, }; -static const char *patternmodes[] = { +static const struct sr_samplerates samplerates = { + SR_HZ(1), + SR_GHZ(1), + SR_HZ(1), + NULL, +}; + +static const char *pattern_strings[] = { + "sigrok", "random", "incremental", + "all-low", + "all-high", NULL, }; -static uint8_t genmode_default[] = { +/* 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 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, @@ -78,129 +126,163 @@ 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 *ddi = &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 int default_pattern = PATTERN_SIGROK; static GThread *my_thread; static int thread_running; -static void hw_stop_acquisition(int device_index, gpointer session_device_id); +static int hw_dev_acquisition_stop(int dev_index, void *cb_data); -static int hw_init(char *deviceinfo) +static int hw_init(void) { - struct sr_device_instance *sdi; - /* Avoid compiler warnings. */ - deviceinfo = deviceinfo; + /* Nothing to do. */ - sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL); - if (!sdi) + return SR_OK; +} + +static int hw_scan(void) +{ + struct sr_dev_inst *sdi; + + sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL); + if (!sdi) { + sr_err("demo: %s: sr_dev_inst_new failed", __func__); return 0; + } - device_instances = g_slist_append(device_instances, sdi); + ddi->instances = g_slist_append(ddi->instances, sdi); return 1; } -static int hw_opendev(int device_index) +static int hw_dev_open(int dev_index) { /* Avoid compiler warnings. */ - device_index = device_index; + (void)dev_index; /* Nothing needed so far. */ + return SR_OK; } -static void hw_closedev(int device_index) +static int hw_dev_close(int dev_index) { /* Avoid compiler warnings. */ - device_index = device_index; + (void)dev_index; /* 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 const void *hw_dev_info_get(int dev_index, int dev_info_id) { - struct sr_device_instance *sdi; - void *info = NULL; + struct sr_dev_inst *sdi; + const void *info = NULL; - if (!(sdi = sr_get_device_instance(device_instances, device_index))) + if (!(sdi = sr_dev_inst_get(ddi->instances, dev_index))) { + sr_err("demo: %s: sdi was NULL", __func__); return NULL; + } - switch (device_info_id) { - case SR_DI_INSTANCE: + switch (dev_info_id) { + case SR_DI_INST: info = sdi; break; case SR_DI_NUM_PROBES: info = GINT_TO_POINTER(NUM_PROBES); break; + case SR_DI_PROBE_NAMES: + info = probe_names; + break; + case SR_DI_SAMPLERATES: + info = &samplerates; + break; case SR_DI_CUR_SAMPLERATE: info = &cur_samplerate; break; - case SR_DI_PATTERNMODES: - info = &patternmodes; + case SR_DI_PATTERNS: + info = &pattern_strings; break; } return info; } -static int hw_get_status(int device_index) +static int hw_dev_status_get(int dev_index) { /* Avoid compiler warnings. */ - device_index = device_index; + (void)dev_index; return SR_ST_ACTIVE; } -static int *hw_get_capabilities(void) +static const int *hw_hwcap_get_all(void) { - return capabilities; + return hwcaps; } -static int hw_set_configuration(int device_index, int capability, void *value) +static int hw_dev_config_set(int dev_index, int hwcap, const void *value) { int ret; - uint64_t *tmp_u64; - char *stropt; + const char *stropt; /* Avoid compiler warnings. */ - device_index = device_index; + (void)dev_index; - if (capability == SR_HWCAP_PROBECONFIG) { + if (hwcap == SR_HWCAP_PROBECONFIG) { /* Nothing to do, but must be supported */ ret = SR_OK; - } else if (capability == SR_HWCAP_SAMPLERATE) { - tmp_u64 = value; - cur_samplerate = *tmp_u64; + } else if (hwcap == SR_HWCAP_SAMPLERATE) { + cur_samplerate = *(const uint64_t *)value; + sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__, + cur_samplerate); ret = SR_OK; - } else if (capability == SR_HWCAP_LIMIT_SAMPLES) { - tmp_u64 = value; - limit_samples = *tmp_u64; + } else if (hwcap == SR_HWCAP_LIMIT_SAMPLES) { + limit_msec = 0; + limit_samples = *(const 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) { - tmp_u64 = value; - limit_msec = *tmp_u64; + } else if (hwcap == SR_HWCAP_LIMIT_MSEC) { + limit_msec = *(const uint64_t *)value; + limit_samples = 0; + sr_dbg("demo: %s: setting limit_msec to %" PRIu64, __func__, + limit_msec); ret = SR_OK; - } else if (capability == SR_HWCAP_PATTERN_MODE) { + } else if (hwcap == SR_HWCAP_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("demo: %s: setting pattern to %d", __func__, + default_pattern); } else { ret = SR_ERR; } @@ -211,71 +293,82 @@ static int hw_set_configuration(int device_index, int capability, void *value) static void samples_generator(uint8_t *buf, uint64_t size, void *data) { static uint64_t p = 0; - struct databag *mydata = data; + struct context *ctx = data; uint64_t i; + /* TODO: Needed? */ memset(buf, 0, size); - switch (mydata->sample_generator) { - case GENMODE_DEFAULT: + switch (ctx->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; + 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("demo: %s: unknown pattern %d", __func__, + ctx->sample_generator); + break; } } /* Thread function */ static void thread_func(void *data) { - struct databag *mydata = data; + struct context *ctx = 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); + time_last = g_timer_elapsed(ctx->timer, NULL); while (thread_running) { /* Rate control */ - time_cur = g_timer_elapsed(mydata->timer, NULL); + time_cur = g_timer_elapsed(ctx->timer, NULL); time_diff = time_cur - time_last; time_last = time_cur; nb_to_send = cur_samplerate * time_diff; - if (limit_samples) + if (limit_samples) { nb_to_send = MIN(nb_to_send, - limit_samples - mydata->samples_counter); + limit_samples - ctx->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; + ctx->samples_counter += nb_to_send; - g_io_channel_write_chars(channels[1], (gchar *)&buf, - nb_to_send, (gsize *)&bytes_written, NULL); + g_io_channel_write_chars(ctx->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)) + (limit_samples && ctx->samples_counter >= limit_samples)) { - close(mydata->pipe_fds[1]); + close(ctx->pipe_fds[1]); thread_running = 0; } @@ -284,37 +377,41 @@ static void thread_func(void *data) } /* 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 context *ctx = cb_data; struct sr_datafeed_packet packet; - char c[BUFSIZE]; + struct sr_datafeed_logic logic; + static uint64_t samples_received = 0; + unsigned char c[BUFSIZE]; gsize z; /* Avoid compiler warnings. */ - fd = fd; - revents = revents; + (void)fd; + (void)revents; do { - g_io_channel_read_chars(channels[0], + g_io_channel_read_chars(ctx->channels[0], (gchar *)&c, BUFSIZE, &z, NULL); if (z > 0) { packet.type = SR_DF_LOGIC; - packet.length = z; - packet.unitsize = 1; - packet.payload = c; - session_bus(user_data, &packet); + packet.payload = &logic; + logic.length = z; + logic.unitsize = 1; + logic.data = c; + sr_session_send(ctx->session_dev_id, &packet); + samples_received += z; } } while (z > 0); - if (!thread_running && z <= 0) - { - /* Make sure we don't receive more packets */ - g_io_channel_close(channels[0]); + if (!thread_running && z <= 0) { + /* Make sure we don't receive more packets. */ + g_io_channel_shutdown(ctx->channels[0], FALSE, NULL); /* Send last packet. */ packet.type = SR_DF_END; - session_bus(user_data, &packet); + sr_session_send(ctx->session_dev_id, &packet); return FALSE; } @@ -322,91 +419,114 @@ static int receive_data(int fd, int revents, void *user_data) return TRUE; } -static int hw_start_acquisition(int device_index, gpointer session_device_id) +static int hw_dev_acquisition_start(int dev_index, void *cb_data) { struct sr_datafeed_packet *packet; struct sr_datafeed_header *header; - struct databag *mydata; + struct sr_datafeed_meta_logic meta; + struct context *ctx; - mydata = malloc(sizeof(struct databag)); - if (!mydata) + /* TODO: 'ctx' is never g_free()'d? */ + if (!(ctx = g_try_malloc(sizeof(struct context)))) { + sr_err("demo: %s: ctx malloc failed", __func__); return SR_ERR_MALLOC; + } - mydata->sample_generator = default_genmode; - mydata->session_device_id = session_device_id; - mydata->device_index = device_index; - mydata->samples_counter = 0; + ctx->sample_generator = default_pattern; + ctx->session_dev_id = cb_data; + ctx->dev_index = dev_index; + ctx->samples_counter = 0; - if (pipe(mydata->pipe_fds)) + if (pipe(ctx->pipe_fds)) { + /* TODO: Better error message. */ + sr_err("demo: %s: pipe() failed", __func__); return SR_ERR; + } + + ctx->channels[0] = g_io_channel_unix_new(ctx->pipe_fds[0]); + ctx->channels[1] = g_io_channel_unix_new(ctx->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(ctx->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(ctx->channels[0], NULL, NULL); + g_io_channel_set_encoding(ctx->channels[1], NULL, NULL); /* Make channels to unbuffered. */ - g_io_channel_set_buffered(channels[0], FALSE); - g_io_channel_set_buffered(channels[1], FALSE); + g_io_channel_set_buffered(ctx->channels[0], FALSE); + g_io_channel_set_buffered(ctx->channels[1], FALSE); - source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40, receive_data, - session_device_id); + sr_session_source_add_channel(ctx->channels[0], G_IO_IN | G_IO_ERR, + 40, receive_data, ctx); /* 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(); + /* This must to be done between g_thread_init() & g_thread_create(). */ + ctx->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_thread_create((GThreadFunc)thread_func, ctx, TRUE, NULL); + if (!my_thread) { + sr_err("demo: %s: g_thread_create failed", __func__); + return SR_ERR; /* TODO */ + } + + if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) { + sr_err("demo: %s: packet malloc failed", __func__); + return SR_ERR_MALLOC; + } - packet = malloc(sizeof(struct sr_datafeed_packet)); - header = malloc(sizeof(struct sr_datafeed_header)); - if (!packet || !header) + if (!(header = g_try_malloc(sizeof(struct sr_datafeed_header)))) { + sr_err("demo: %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; - session_bus(session_device_id, packet); - free(header); - free(packet); + sr_session_send(ctx->session_dev_id, packet); + + /* Send metadata about the SR_DF_LOGIC packets to come. */ + packet->type = SR_DF_META_LOGIC; + packet->payload = &meta; + meta.samplerate = cur_samplerate; + meta.num_probes = NUM_PROBES; + sr_session_send(ctx->session_dev_id, packet); + + g_free(header); + g_free(packet); return SR_OK; } -static void hw_stop_acquisition(int device_index, gpointer session_device_id) +/* TODO: This stops acquisition on ALL devices, ignoring dev_index. */ +static int hw_dev_acquisition_stop(int dev_index, void *cb_data) { /* Avoid compiler warnings. */ - device_index = device_index; - session_device_id = session_device_id; + (void)dev_index; + (void)cb_data; /* Stop generate thread. */ thread_running = 0; + + 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_open = hw_dev_open, + .dev_close = hw_dev_close, + .dev_info_get = hw_dev_info_get, + .dev_status_get = hw_dev_status_get, + .hwcap_get_all = hw_hwcap_get_all, + .dev_config_set = hw_dev_config_set, + .dev_acquisition_start = hw_dev_acquisition_start, + .dev_acquisition_stop = hw_dev_acquisition_stop, + .instances = NULL, };