X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=hardware%2Fdemo%2Fdemo.c;h=8a84e8ce65a3d6b7d4f407da0107703f510eb6e2;hp=cb6aa95cba0cb7dfe3bfd4674c52e110d4c98d6c;hb=d261dbbfcc73;hpb=17e1afcb81b8581091fcb660c2e61f05c75e00b5 diff --git a/hardware/demo/demo.c b/hardware/demo/demo.c index cb6aa95c..8a84e8ce 100644 --- a/hardware/demo/demo.c +++ b/hardware/demo/demo.c @@ -22,180 +22,261 @@ #include #include #include -#include -#include "config.h" - -#define BUFSIZE 4096 - -#define NUM_PROBES 8 -#define NUM_TRIGGER_STAGES 4 -#define TRIGGER_TYPES "01" - -/* Software trigger implementation: positive values indicate trigger stage. */ -#define TRIGGER_FIRED -1 - -#define USB_MODEL_NAME "demodevice" -#define USB_VENDOR_NAME "demovendor" -#define USB_MODEL_VERSION "1.0" +#ifdef _WIN32 +#include +#include +#define pipe(fds) _pipe(fds, 4096, _O_BINARY) +#endif +#include "sigrok.h" +#include "sigrok-internal.h" + +/* 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 + +/* 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 GENMODE_RANDOM 1 -#define GENMODE_INC 2 +/* FIXME: Should not be global. */ +SR_PRIV GIOChannel *channels[2]; -static GThread *my_thread; -static int thread_running; +struct databag { + int pipe_fds[2]; + uint8_t sample_generator; + uint8_t thread_running; + uint64_t samples_counter; + int dev_index; + gpointer session_data; + GTimer *timer; +}; -static int capabilities[] = { - HWCAP_LOGIC_ANALYZER, - HWCAP_SAMPLERATE, - HWCAP_LIMIT_SAMPLES, - HWCAP_CONTINUOUS +static 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, }; -/* 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[] = { + "sigrok", + "random", + "incremental", + "all-low", + "all-high", + NULL, }; -struct databag { - int pipe_fds[2]; - uint8_t sample_generator; - uint8_t thread_running; - uint64_t samples_counter; - int device_index; - int loop_sleep; - gpointer session_device_id; +/* 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, }; -/* List of struct sigrok_device_instance, maintained by opendev()/closedev(). */ -static GSList *device_instances = 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, + 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, +}; -/* TODO: All of these should go in a device-specific struct. */ -static uint64_t cur_samplerate = 0; -static uint64_t limit_samples = -1; -// 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 }; +/* Private, per-device-instance driver context. */ +/* TODO: struct context as with the other drivers. */ -// static int trigger_stage = TRIGGER_FIRED; +/* List of struct sr_dev_inst, maintained by dev_open()/dev_close(). */ +static GSList *dev_insts = 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); +static int hw_dev_acquisition_stop(int dev_index, gpointer session_data); -static int hw_init(char *deviceinfo) +static int hw_init(const char *devinfo) { - /* Avoid compiler warnings. */ - deviceinfo = deviceinfo; + struct sr_dev_inst *sdi; - struct sigrok_device_instance *sdi; - - sdi = sigrok_device_instance_new(0, ST_ACTIVE, - USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION); + /* Avoid compiler warnings. */ + (void)devinfo; - if (!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); + } + + dev_insts = g_slist_append(dev_insts, 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 SIGROK_OK; + + 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 void *hw_dev_info_get(int dev_index, int dev_info_id) { - struct sigrok_device_instance *sdi; + struct sr_dev_inst *sdi; void *info = NULL; - if (!(sdi = get_sigrok_device_instance(device_instances, device_index))) + if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { + sr_err("demo: %s: sdi was NULL", __func__); return NULL; + } - switch (device_info_id) { - case DI_INSTANCE: + switch (dev_info_id) { + case SR_DI_INST: info = sdi; break; - case DI_NUM_PROBES: + case SR_DI_NUM_PROBES: info = GINT_TO_POINTER(NUM_PROBES); break; - case DI_SAMPLERATES: - info = &samplerates; + case SR_DI_PROBE_NAMES: + info = probe_names; break; - case DI_TRIGGER_TYPES: - info = TRIGGER_TYPES; + case SR_DI_SAMPLERATES: + info = &samplerates; 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) +static int hw_dev_status_get(int dev_index) { /* Avoid compiler warnings. */ - device_index = device_index; + (void)dev_index; - return 0; /* FIXME */ + return SR_ST_ACTIVE; } -static int *hw_get_capabilities(void) +static 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, void *value) { int ret; - uint64_t *tmp_u64; + char *stropt; /* Avoid compiler warnings. */ - 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); FIXME - ret = SIGROK_OK; - } else if (capability == HWCAP_LIMIT_SAMPLES) { - tmp_u64 = value; - limit_samples = *tmp_u64; - ret = SIGROK_OK; + (void)dev_index; + + if (hwcap == SR_HWCAP_PROBECONFIG) { + /* Nothing to do, but must be supported */ + ret = SR_OK; + } else if (hwcap == SR_HWCAP_SAMPLERATE) { + cur_samplerate = *(uint64_t *)value; + sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__, + cur_samplerate); + ret = SR_OK; + } else if (hwcap == 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 (hwcap == 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 (hwcap == SR_HWCAP_PATTERN_MODE) { + stropt = value; + 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_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 = SIGROK_ERR; + ret = SR_ERR; } return ret; @@ -203,20 +284,38 @@ 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; uint64_t i; + /* TODO: Needed? */ memset(buf, 0, size); switch (mydata->sample_generator) { - case GENMODE_RANDOM: /* Random */ + case PATTERN_SIGROK: /* sigrok pattern */ + 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 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: + /* TODO: Error handling. */ + break; } } @@ -226,136 +325,186 @@ 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) { - if (limit_samples) - nb_to_send = limit_samples - mydata->samples_counter; - else - nb_to_send = BUFSIZE; // CONTINUOUS MODE + /* Rate control */ + time_cur = g_timer_elapsed(mydata->timer, NULL); + + time_diff = time_cur - time_last; + time_last = time_cur; - if (nb_to_send == 0) { + 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; - hw_stop_acquisition(mydata->device_index, - mydata->session_device_id); - } else if (nb_to_send > BUFSIZE) { - nb_to_send = BUFSIZE; } - samples_generator(buf, nb_to_send, data); - mydata->samples_counter += nb_to_send; - - write(mydata->pipe_fds[1], &buf, nb_to_send); - g_usleep(mydata->loop_sleep); + g_usleep(10); } } /* Callback handling data */ -static int receive_data(int fd, int revents, void *user_data) +static int receive_data(int fd, int revents, void *session_data) { - struct datafeed_packet packet; - /* uint16_t samples[1000]; */ - char c[BUFSIZE]; - uint64_t z; + struct sr_datafeed_packet packet; + struct sr_datafeed_logic logic; + static uint64_t samples_received = 0; + unsigned char c[BUFSIZE]; + gsize z; /* Avoid compiler warnings. */ - revents = revents; - - z = read(fd, &c, BUFSIZE); - if (z > 0) { - packet.type = DF_LOGIC; - packet.length = z; - packet.unitsize = 1; - packet.payload = c; - session_bus(user_data, &packet); + (void)fd; + (void)revents; + + do { + g_io_channel_read_chars(channels[0], + (gchar *)&c, BUFSIZE, &z, NULL); + + if (z > 0) { + packet.type = SR_DF_LOGIC; + packet.payload = &logic; + logic.length = z; + logic.unitsize = 1; + logic.data = c; + sr_session_bus(session_data, &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]); + + /* Send last packet. */ + packet.type = SR_DF_END; + sr_session_bus(session_data, &packet); + + return FALSE; } + return TRUE; } -static int hw_start_acquisition(int device_index, gpointer session_device_id) +static int hw_dev_acquisition_start(int dev_index, gpointer session_data) { - struct datafeed_packet *packet; - struct datafeed_header *header; - unsigned char *buf; + struct sr_datafeed_packet *packet; + struct sr_datafeed_header *header; struct databag *mydata; - mydata = malloc(sizeof(struct databag)); - if (!mydata) - return SIGROK_ERR_MALLOC; + /* 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; + } - mydata->sample_generator = GENMODE_RANDOM; - mydata->session_device_id = session_device_id; - mydata->device_index = device_index; + mydata->sample_generator = default_pattern; + mydata->session_data = session_data; + mydata->dev_index = dev_index; mydata->samples_counter = 0; - mydata->loop_sleep = 100000; if (pipe(mydata->pipe_fds)) { - fprintf(stderr, "Pipe failed.\n"); - return SIGROK_ERR_MALLOC; /* FIXME */ - + /* TODO: Better error message. */ + sr_err("demo: %s: pipe() failed", __func__); + return SR_ERR; } - source_add(mydata->pipe_fds[0], G_IO_IN | G_IO_ERR, 40, receive_data, - session_device_id); + + 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_data); /* Run the demo thread. */ g_thread_init(NULL); + /* This must to be done between g_thread_init() & 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) { - fprintf(stderr, "demo: Thread creation failed.\n"); - return SIGROK_ERR_MALLOC; /* FIXME */ + sr_err("demo: %s: g_thread_create failed", __func__); + return SR_ERR; /* TODO */ } - packet = malloc(sizeof(struct datafeed_packet)); - header = malloc(sizeof(struct datafeed_header)); - buf = malloc(2048); - if (!packet || !header || !buf) - return SIGROK_ERR_MALLOC; + if (!(packet = g_try_malloc(sizeof(struct sr_datafeed_packet)))) { + sr_err("demo: %s: packet malloc failed", __func__); + return SR_ERR_MALLOC; + } - /* FIXME */ - memset(buf, 0x55, 2048); + 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_HEADER; - packet->length = sizeof(struct datafeed_header); - packet->payload = (unsigned char *)header; + packet->type = SR_DF_HEADER; + packet->payload = header; header->feed_version = 1; gettimeofday(&header->starttime, NULL); header->samplerate = cur_samplerate; - header->protocol_id = 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_bus(session_data, packet); + g_free(header); + g_free(packet); - return SIGROK_OK; + return SR_OK; } -/* This stops acquisition on ALL devices, ignoring device_index. */ -static void hw_stop_acquisition(int device_index, gpointer session_device_id) +static int hw_dev_acquisition_stop(int dev_index, gpointer session_data) { - struct datafeed_packet packet; - /* Avoid compiler warnings. */ - device_index = device_index; + (void)dev_index; + (void)session_data; + + /* Stop generate thread. */ + thread_running = 0; - /* Send last packet. */ - packet.type = DF_END; - session_bus(session_device_id, &packet); + 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_plugin demo_plugin_info = { + .name = "demo", + .longname = "Demo driver and pattern generator", + .api_version = 1, + .init = hw_init, + .cleanup = hw_cleanup, + .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, };