sr: Fix/document probe names.

[libsigrok.git] / hardware / demo / demo.c

diff --git a/hardware/demo/demo.c b/hardware/demo/demo.c
index 0b0ccfa235841afbbebd3eb69944696ba52e5ffc..8a84e8ce65a3d6b7d4f407da0107703f510eb6e2 100644 (file)
--- a/hardware/demo/demo.c
+++ b/hardware/demo/demo.c
@@ -76,7 +76,7 @@ struct databag {
        GTimer *timer;
 };
 
-static int capabilities[] = {
+static int hwcaps[] = {
        SR_HWCAP_LOGIC_ANALYZER,
        SR_HWCAP_DEMO_DEV,
        SR_HWCAP_SAMPLERATE,
@@ -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,7 +126,10 @@ static uint8_t pattern_sigrok[] = {
        0xbe, 0xbe, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
 };
 
-/* List of struct sr_dev_inst, maintained by opendev()/closedev(). */
+/* 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 limit_samples = 0;
@@ -134,7 +138,7 @@ static int default_pattern = PATTERN_SIGROK;
 static GThread *my_thread;
 static int thread_running;
 
-static int hw_stop_acquisition(int dev_index, gpointer session_data);
+static int hw_dev_acquisition_stop(int dev_index, gpointer session_data);
 
 static int hw_init(const char *devinfo)
 {
@@ -154,7 +158,7 @@ static int hw_init(const char *devinfo)
        return 1;
 }
 
-static int hw_opendev(int dev_index)
+static int hw_dev_open(int dev_index)
 {
        /* Avoid compiler warnings. */
        (void)dev_index;
@@ -164,7 +168,7 @@ static int hw_opendev(int dev_index)
        return SR_OK;
 }
 
-static int hw_closedev(int dev_index)
+static int hw_dev_close(int dev_index)
 {
        /* Avoid compiler warnings. */
        (void)dev_index;
@@ -180,7 +184,7 @@ static int hw_cleanup(void)
        return SR_OK;
 }
 
-static void *hw_get_dev_info(int dev_index, int dev_info_id)
+static void *hw_dev_info_get(int dev_index, int dev_info_id)
 {
        struct sr_dev_inst *sdi;
        void *info = NULL;
@@ -191,7 +195,7 @@ static void *hw_get_dev_info(int dev_index, int dev_info_id)
        }
 
        switch (dev_info_id) {
-       case SR_DI_INSTANCE:
+       case SR_DI_INST:
                info = sdi;
                break;
        case SR_DI_NUM_PROBES:
@@ -214,7 +218,7 @@ static void *hw_get_dev_info(int dev_index, int dev_info_id)
        return info;
 }
 
-static int hw_get_status(int dev_index)
+static int hw_dev_status_get(int dev_index)
 {
        /* Avoid compiler warnings. */
        (void)dev_index;
@@ -222,12 +226,12 @@ static int hw_get_status(int 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 dev_index, int capability, void *value)
+static int hw_dev_config_set(int dev_index, int hwcap, void *value)
 {
        int ret;
        char *stropt;
@@ -235,25 +239,25 @@ static int hw_set_configuration(int dev_index, int capability, void *value)
        /* Avoid compiler warnings. */
        (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;
                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")) {
@@ -405,7 +409,7 @@ static int receive_data(int fd, int revents, void *session_data)
        return TRUE;
 }
 
-static int hw_start_acquisition(int dev_index, gpointer session_data)
+static int hw_dev_acquisition_start(int dev_index, gpointer session_data)
 {
        struct sr_datafeed_packet *packet;
        struct sr_datafeed_header *header;
@@ -477,7 +481,7 @@ static int hw_start_acquisition(int dev_index, gpointer session_data)
        return SR_OK;
 }
 
-static int hw_stop_acquisition(int dev_index, gpointer session_data)
+static int hw_dev_acquisition_stop(int dev_index, gpointer session_data)
 {
        /* Avoid compiler warnings. */
        (void)dev_index;
@@ -495,12 +499,12 @@ SR_PRIV struct sr_dev_plugin demo_plugin_info = {
        .api_version = 1,
        .init = hw_init,
        .cleanup = hw_cleanup,
-       .opendev = hw_opendev,
-       .closedev = hw_closedev,
-       .get_dev_info = hw_get_dev_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,
 };