X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fdemo%2Fdemo.c;h=8cfd1c8946a5ca96b43a14b854c4a57c055b78d2;hb=5c64390e5ac8a0052d8b7eeb49c781d86027c814;hp=2f32b2cd9661a28b550cae3178cdffb0b1a03de4;hpb=59df0c77e2906323290544ea62801831818ec096;p=libsigrok.git diff --git a/hardware/demo/demo.c b/hardware/demo/demo.c index 2f32b2cd..8cfd1c89 100644 --- a/hardware/demo/demo.c +++ b/hardware/demo/demo.c @@ -22,27 +22,49 @@ #include #include #include -#include #ifdef _WIN32 #include #include #define pipe(fds) _pipe(fds, 4096, _O_BINARY) #endif -#include "config.h" +#include "sigrok.h" +#include "sigrok-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, }; /* FIXME: Should not be global. */ -GIOChannel *channels[2]; +SR_PRIV GIOChannel *channels[2]; struct databag { int pipe_fds[2]; @@ -50,12 +72,13 @@ struct databag { uint8_t thread_running; uint64_t samples_counter; int device_index; - gpointer session_device_id; + gpointer session_data; GTimer *timer; }; static int capabilities[] = { SR_HWCAP_LOGIC_ANALYZER, + SR_HWCAP_DEMO_DEVICE, SR_HWCAP_SAMPLERATE, SR_HWCAP_PATTERN_MODE, SR_HWCAP_LIMIT_SAMPLES, @@ -64,19 +87,34 @@ static int capabilities[] = { }; static struct sr_samplerates samplerates = { - 1, + SR_HZ(1), SR_GHZ(1), - 1, + SR_HZ(1), NULL, }; -static const char *patternmodes[] = { +static const char *pattern_strings[] = { + "sigrok", "random", "incremental", + "all-low", + "all-high", NULL, }; -static uint8_t genmode_default[] = { +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, @@ -92,22 +130,24 @@ 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_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 void hw_stop_acquisition(int device_index, gpointer session_data); static int hw_init(const char *deviceinfo) { struct sr_device_instance *sdi; /* Avoid compiler warnings. */ - deviceinfo = deviceinfo; + (void)deviceinfo; sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL); - if (!sdi) + if (!sdi) { + sr_err("demo: %s: sr_device_instance_new failed", __func__); return 0; + } device_instances = g_slist_append(device_instances, sdi); @@ -117,18 +157,21 @@ static int hw_init(const char *deviceinfo) static int hw_opendev(int device_index) { /* Avoid compiler warnings. */ - device_index = device_index; + (void)device_index; /* Nothing needed so far. */ + return SR_OK; } -static void hw_closedev(int device_index) +static int hw_closedev(int device_index) { /* Avoid compiler warnings. */ - device_index = device_index; + (void)device_index; /* Nothing needed so far. */ + + return SR_OK; } static void hw_cleanup(void) @@ -141,8 +184,10 @@ static void *hw_get_device_info(int device_index, int device_info_id) struct sr_device_instance *sdi; void *info = NULL; - if (!(sdi = sr_get_device_instance(device_instances, device_index))) + if (!(sdi = sr_get_device_instance(device_instances, device_index))) { + sr_err("demo: %s: sdi was NULL", __func__); return NULL; + } switch (device_info_id) { case SR_DI_INSTANCE: @@ -151,6 +196,9 @@ static void *hw_get_device_info(int device_index, int device_info_id) 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; @@ -158,7 +206,7 @@ static void *hw_get_device_info(int device_index, int device_info_id) info = &cur_samplerate; break; case SR_DI_PATTERNMODES: - info = &patternmodes; + info = &pattern_strings; break; } @@ -168,7 +216,7 @@ static void *hw_get_device_info(int device_index, int device_info_id) static int hw_get_status(int device_index) { /* Avoid compiler warnings. */ - device_index = device_index; + (void)device_index; return SR_ST_ACTIVE; } @@ -181,38 +229,47 @@ static int *hw_get_capabilities(void) static int hw_set_configuration(int device_index, int capability, void *value) { int ret; - uint64_t *tmp_u64; char *stropt; /* Avoid compiler warnings. */ - device_index = device_index; + (void)device_index; if (capability == 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; + cur_samplerate = *(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; + 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) { - tmp_u64 = value; - limit_msec = *tmp_u64; + 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_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; } @@ -226,24 +283,34 @@ static void samples_generator(uint8_t *buf, uint64_t size, void *data) struct databag *mydata = data; uint64_t i; + /* TODO: Needed? */ memset(buf, 0, size); switch (mydata->sample_generator) { - case GENMODE_DEFAULT: + 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: + /* TODO: Error handling. */ + break; } } @@ -254,7 +321,6 @@ static void thread_func(void *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); @@ -268,9 +334,10 @@ static void thread_func(void *data) 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 - mydata->samples_counter); + } /* Make sure we don't overflow. */ nb_to_send = MIN(nb_to_send, BUFSIZE); @@ -280,7 +347,7 @@ static void thread_func(void *data) mydata->samples_counter += nb_to_send; g_io_channel_write_chars(channels[1], (gchar *)&buf, - nb_to_send, (gsize *)&bytes_written, NULL); + nb_to_send, (gsize *)&bytes_written, NULL); } /* Check if we're done. */ @@ -296,15 +363,17 @@ 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 *session_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], @@ -312,21 +381,22 @@ static int receive_data(int fd, int revents, void *user_data) if (z > 0) { packet.type = SR_DF_LOGIC; - packet.length = z; - packet.unitsize = 1; - packet.payload = c; - sr_session_bus(user_data, &packet); + 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 */ + 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); + sr_session_bus(session_data, &packet); return FALSE; } @@ -334,23 +404,28 @@ 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_start_acquisition(int device_index, gpointer session_data) { struct sr_datafeed_packet *packet; struct sr_datafeed_header *header; struct databag *mydata; - mydata = malloc(sizeof(struct databag)); - if (!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; + } - mydata->sample_generator = default_genmode; - mydata->session_device_id = session_device_id; + mydata->sample_generator = default_pattern; + mydata->session_data = session_data; mydata->device_index = device_index; mydata->samples_counter = 0; - if (pipe(mydata->pipe_fds)) + if (pipe(mydata->pipe_fds)) { + /* TODO: Better error message. */ + sr_err("demo: %s: pipe() failed", __func__); 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]); @@ -364,61 +439,65 @@ static int hw_start_acquisition(int device_index, gpointer session_device_id) 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); + receive_data, session_data); /* Run the demo thread. */ g_thread_init(NULL); - /* this needs to be done between g_thread_init() and g_thread_create() */ + /* 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) - return SR_ERR; + 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; - sr_session_bus(session_device_id, packet); - free(header); - free(packet); + sr_session_bus(session_data, packet); + g_free(header); + g_free(packet); return SR_OK; } -static void hw_stop_acquisition(int device_index, gpointer session_device_id) +static void hw_stop_acquisition(int device_index, gpointer session_data) { /* Avoid compiler warnings. */ - device_index = device_index; - session_device_id = session_device_id; + (void)device_index; + (void)session_data; /* Stop generate thread. */ thread_running = 0; } -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_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, };