]> sigrok.org Git - libsigrok.git/blobdiff - hardware/demo/demo.c
sr: Fix some TODOs, improve comments/docs.
[libsigrok.git] / hardware / demo / demo.c
index 6605d1e6c321f6fe5be8998d65a4799a5594cce3..98bf4fb0bda474328a2f37f910cb890407dd575f 100644 (file)
@@ -27,7 +27,6 @@
 #include <fcntl.h>
 #define pipe(fds) _pipe(fds, 4096, _O_BINARY)
 #endif
-#include "config.h"
 #include "sigrok.h"
 #include "sigrok-internal.h"
 
@@ -65,20 +64,21 @@ enum {
 };
 
 /* FIXME: Should not be global. */
-GIOChannel *channels[2];
+SR_PRIV GIOChannel *channels[2];
 
 struct databag {
        int pipe_fds[2];
        uint8_t sample_generator;
        uint8_t thread_running;
        uint64_t samples_counter;
-       int device_index;
-       gpointer session_data;
+       int dev_index;
+       void *session_dev_id;
        GTimer *timer;
 };
 
-static int capabilities[] = {
+static int hwcaps[] = {
        SR_HWCAP_LOGIC_ANALYZER,
+       SR_HWCAP_DEMO_DEV,
        SR_HWCAP_SAMPLERATE,
        SR_HWCAP_PATTERN_MODE,
        SR_HWCAP_LIMIT_SAMPLES,
@@ -102,6 +102,7 @@ static const char *pattern_strings[] = {
        NULL,
 };
 
+/* We name the probes 0-7 on our demo driver. */
 static const char *probe_names[NUM_PROBES + 1] = {
        "0",
        "1",
@@ -125,73 +126,76 @@ static uint8_t pattern_sigrok[] = {
        0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 };
 
-/* List of struct sr_device_instance, maintained by opendev()/closedev(). */
-static GSList *device_instances = NULL;
+/* 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(). */
+static GSList *dev_insts = NULL;
 static uint64_t cur_samplerate = SR_KHZ(200);
-static uint64_t period_ps = 5000000;
 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 void hw_stop_acquisition(int device_index, gpointer session_data);
+static int hw_dev_acquisition_stop(int dev_index, void *cb_data);
 
-static int hw_init(const char *deviceinfo)
+static int hw_init(const char *devinfo)
 {
-       struct sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
 
        /* Avoid compiler warnings. */
-       (void)deviceinfo;
+       (void)devinfo;
 
-       sdi = sr_device_instance_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
+       sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, DEMONAME, NULL, NULL);
        if (!sdi) {
-               sr_err("demo: %s: sr_device_instance_new failed", __func__);
+               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. */
-       (void)device_index;
+       (void)dev_index;
 
        /* Nothing needed so far. */
 
        return SR_OK;
 }
 
-static int hw_closedev(int device_index)
+static int hw_dev_close(int dev_index)
 {
        /* Avoid compiler warnings. */
-       (void)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 sr_device_instance *sdi;
+       struct sr_dev_inst *sdi;
        void *info = NULL;
 
-       if (!(sdi = sr_get_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 SR_DI_INSTANCE:
+       switch (dev_info_id) {
+       case SR_DI_INST:
                info = sdi;
                break;
        case SR_DI_NUM_PROBES:
@@ -214,47 +218,46 @@ static void *hw_get_device_info(int device_index, int device_info_id)
        return info;
 }
 
-static int hw_get_status(int device_index)
+static int hw_dev_status_get(int dev_index)
 {
        /* Avoid compiler warnings. */
-       (void)device_index;
+       (void)dev_index;
 
        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;
        char *stropt;
 
        /* Avoid compiler warnings. */
-       (void)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) {
+       } else if (hwcap == SR_HWCAP_SAMPLERATE) {
                cur_samplerate = *(uint64_t *)value;
-               period_ps = 1000000000000 / cur_samplerate;
                sr_dbg("demo: %s: setting samplerate to %" PRIu64, __func__,
                       cur_samplerate);
                ret = SR_OK;
-       } else if (capability == SR_HWCAP_LIMIT_SAMPLES) {
+       } 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 (capability == SR_HWCAP_LIMIT_MSEC) {
+       } 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 (capability == SR_HWCAP_PATTERN_MODE) {
+       } else if (hwcap == SR_HWCAP_PATTERN_MODE) {
                stropt = value;
                ret = SR_OK;
                if (!strcmp(stropt, "sigrok")) {
@@ -311,7 +314,8 @@ static void samples_generator(uint8_t *buf, uint64_t size, void *data)
                memset(buf, 0xff, size);
                break;
        default:
-               /* TODO: Error handling. */
+               sr_err("demo: %s: unknown pattern %d", __func__,
+                      mydata->sample_generator);
                break;
        }
 }
@@ -365,7 +369,7 @@ static void thread_func(void *data)
 }
 
 /* Callback handling data */
-static int receive_data(int fd, int revents, void *session_data)
+static int receive_data(int fd, int revents, void *cb_data)
 {
        struct sr_datafeed_packet packet;
        struct sr_datafeed_logic logic;
@@ -384,12 +388,10 @@ static int receive_data(int fd, int revents, void *session_data)
                if (z > 0) {
                        packet.type = SR_DF_LOGIC;
                        packet.payload = &logic;
-                       packet.timeoffset =  samples_received * period_ps;
-                       packet.duration = z * period_ps;
                        logic.length = z;
                        logic.unitsize = 1;
                        logic.data = c;
-                       sr_session_bus(session_data, &packet);
+                       sr_session_send(cb_data, &packet);
                        samples_received += z;
                }
        } while (z > 0);
@@ -400,7 +402,7 @@ static int receive_data(int fd, int revents, void *session_data)
 
                /* Send last packet. */
                packet.type = SR_DF_END;
-               sr_session_bus(session_data, &packet);
+               sr_session_send(cb_data, &packet);
 
                return FALSE;
        }
@@ -408,7 +410,7 @@ static int receive_data(int fd, int revents, void *session_data)
        return TRUE;
 }
 
-static int hw_start_acquisition(int device_index, gpointer session_data)
+static int hw_dev_acquisition_start(int dev_index, void *cb_data)
 {
        struct sr_datafeed_packet *packet;
        struct sr_datafeed_header *header;
@@ -421,8 +423,8 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        }
 
        mydata->sample_generator = default_pattern;
-       mydata->session_data = session_data;
-       mydata->device_index = device_index;
+       mydata->session_dev_id = cb_data;
+       mydata->dev_index = dev_index;
        mydata->samples_counter = 0;
 
        if (pipe(mydata->pipe_fds)) {
@@ -443,7 +445,7 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
        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);
+                     receive_data, mydata->session_dev_id);
 
        /* Run the demo thread. */
        g_thread_init(NULL);
@@ -469,42 +471,42 @@ static int hw_start_acquisition(int device_index, gpointer session_data)
 
        packet->type = SR_DF_HEADER;
        packet->payload = header;
-       packet->timeoffset = 0;
-       packet->duration = 0;
        header->feed_version = 1;
        gettimeofday(&header->starttime, NULL);
        header->samplerate = cur_samplerate;
        header->num_logic_probes = NUM_PROBES;
-       header->num_analog_probes = 0;
-       sr_session_bus(session_data, packet);
+       sr_session_send(mydata->session_dev_id, packet);
        g_free(header);
        g_free(packet);
 
        return SR_OK;
 }
 
-static void hw_stop_acquisition(int device_index, gpointer session_data)
+/* 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. */
-       (void)device_index;
-       (void)session_data;
+       (void)dev_index;
+       (void)cb_data;
 
        /* Stop generate thread. */
        thread_running = 0;
+
+       return SR_OK;
 }
 
-struct sr_device_plugin demo_plugin_info = {
+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,
-       .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,
+       .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,
 };