]> sigrok.org Git - libsigrok.git/blobdiff - hardware/demo/demo.c
Replace 'probe' with 'channel' in most places.
[libsigrok.git] / hardware / demo / demo.c
index 433f35229cdb6f284a9c539d3a6c8da93f129977..3c6585dd0086d81fad2a7e5957a5c2357a8ff171 100644 (file)
 /* Logic patterns we can generate. */
 enum {
        /**
-        * Spells "sigrok" across 8 probes using '0's (with '1's as
+        * Spells "sigrok" across 8 channels using '0's (with '1's as
         * "background") when displayed using the 'bits' output format.
-        * The pattern is repeasted every 8 probes, shifted to the right
+        * The pattern is repeasted every 8 channels, shifted to the right
         * in time by one bit.
         */
        PATTERN_SIGROK,
 
-       /** Pseudo-random values on all probes. */
+       /** Pseudo-random values on all channels. */
        PATTERN_RANDOM,
 
        /**
-        * Incrementing number across 8 probes. The pattern is repeasted
-        * every 8 probes, shifted to the right in time by one bit.
+        * Incrementing number across 8 channels. The pattern is repeasted
+        * every 8 channels, shifted to the right in time by one bit.
         */
        PATTERN_INC,
 
-       /** All probes have a low logic state. */
+       /** All channels have a low logic state. */
        PATTERN_ALL_LOW,
 
-       /** All probes have a high logic state. */
+       /** All channels have a high logic state. */
        PATTERN_ALL_HIGH,
 };
 
@@ -116,14 +116,14 @@ struct dev_context {
        int64_t starttime;
        uint64_t step;
        /* Logic */
-       int32_t num_logic_probes;
+       int32_t num_logic_channels;
        unsigned int logic_unitsize;
-       /* There is only ever one logic probe group, so its pattern goes here. */
+       /* There is only ever one logic channel group, so its pattern goes here. */
        uint8_t logic_pattern;
        unsigned char logic_data[LOGIC_BUFSIZE];
        /* Analog */
-       int32_t num_analog_probes;
-       GSList *analog_probe_groups;
+       int32_t num_analog_channels;
+       GSList *analog_channel_groups;
 };
 
 static const int32_t scanopts[] = {
@@ -139,7 +139,7 @@ static const int devopts[] = {
        SR_CONF_LIMIT_MSEC,
 };
 
-static const int devopts_pg[] = {
+static const int devopts_cg[] = {
        SR_CONF_PATTERN_MODE,
 };
 
@@ -166,17 +166,12 @@ static struct sr_dev_driver *di = &demo_driver_info;
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
 
 
-static int dev_clear(void)
-{
-       return std_dev_clear(di, NULL);
-}
-
 static int init(struct sr_context *sr_ctx)
 {
        return std_init(sr_ctx, di, LOG_PREFIX);
 }
 
-static void generate_analog_pattern(const struct sr_probe_group *probe_group, uint64_t sample_rate)
+static void generate_analog_pattern(const struct sr_channel_group *cg, uint64_t sample_rate)
 {
        struct analog_gen *ag;
        double t, frequency;
@@ -184,12 +179,11 @@ static void generate_analog_pattern(const struct sr_probe_group *probe_group, ui
        unsigned int num_samples, i;
        int last_end;
 
-       ag = probe_group->priv;
+       ag = cg->priv;
        num_samples = ANALOG_BUFSIZE / sizeof(float);
 
-       sr_dbg("Generating %s pattern for probe group %s",
-              analog_pattern_str[ag->pattern],
-              probe_group->name);
+       sr_dbg("Generating %s pattern for channel group %s",
+              analog_pattern_str[ag->pattern], cg->name);
 
        switch (ag->pattern) {
        case PATTERN_SQUARE:
@@ -261,26 +255,26 @@ static GSList *scan(GSList *options)
        struct drv_context *drvc;
        struct dev_context *devc;
        struct sr_dev_inst *sdi;
-       struct sr_probe *probe;
-       struct sr_probe_group *pg;
+       struct sr_channel *ch;
+       struct sr_channel_group *cg;
        struct sr_config *src;
        struct analog_gen *ag;
        GSList *devices, *l;
-       int num_logic_probes, num_analog_probes, pattern, i;
-       char probe_name[16];
+       int num_logic_channels, num_analog_channels, pattern, i;
+       char channel_name[16];
 
        drvc = di->priv;
 
-       num_logic_probes = DEFAULT_NUM_LOGIC_PROBES;
-       num_analog_probes = DEFAULT_NUM_ANALOG_PROBES;
+       num_logic_channels = DEFAULT_NUM_LOGIC_PROBES;
+       num_analog_channels = DEFAULT_NUM_ANALOG_PROBES;
        for (l = options; l; l = l->next) {
                src = l->data;
                switch (src->key) {
                case SR_CONF_NUM_LOGIC_PROBES:
-                       num_logic_probes = g_variant_get_int32(src->data);
+                       num_logic_channels = g_variant_get_int32(src->data);
                        break;
                case SR_CONF_NUM_ANALOG_PROBES:
-                       num_analog_probes = g_variant_get_int32(src->data);
+                       num_analog_channels = g_variant_get_int32(src->data);
                        break;
                }
        }
@@ -301,56 +295,56 @@ static GSList *scan(GSList *options)
        devc->limit_samples = 0;
        devc->limit_msec = 0;
        devc->step = 0;
-       devc->num_logic_probes = num_logic_probes;
-       devc->logic_unitsize = (devc->num_logic_probes + 7) / 8;
+       devc->num_logic_channels = num_logic_channels;
+       devc->logic_unitsize = (devc->num_logic_channels + 7) / 8;
        devc->logic_pattern = PATTERN_SIGROK;
-       devc->num_analog_probes = num_analog_probes;
-       devc->analog_probe_groups = NULL;
+       devc->num_analog_channels = num_analog_channels;
+       devc->analog_channel_groups = NULL;
 
-       /* Logic probes, all in one probe group. */
-       if (!(pg = g_try_malloc(sizeof(struct sr_probe_group))))
+       /* Logic channels, all in one channel group. */
+       if (!(cg = g_try_malloc(sizeof(struct sr_channel_group))))
                return NULL;
-       pg->name = g_strdup("Logic");
-       pg->probes = NULL;
-       pg->priv = NULL;
-       for (i = 0; i < num_logic_probes; i++) {
-               sprintf(probe_name, "D%d", i);
-               if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, probe_name)))
+       cg->name = g_strdup("Logic");
+       cg->channels = NULL;
+       cg->priv = NULL;
+       for (i = 0; i < num_logic_channels; i++) {
+               sprintf(channel_name, "D%d", i);
+               if (!(ch = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, channel_name)))
                        return NULL;
-               sdi->probes = g_slist_append(sdi->probes, probe);
-               pg->probes = g_slist_append(pg->probes, probe);
+               sdi->channels = g_slist_append(sdi->channels, ch);
+               cg->channels = g_slist_append(cg->channels, ch);
        }
-       sdi->probe_groups = g_slist_append(NULL, pg);
+       sdi->channel_groups = g_slist_append(NULL, cg);
 
-       /* Analog probes, probe groups and pattern generators. */
+       /* Analog channels, channel groups and pattern generators. */
 
        pattern = 0;
-       for (i = 0; i < num_analog_probes; i++) {
-               sprintf(probe_name, "A%d", i);
-               if (!(probe = sr_probe_new(i + num_logic_probes,
-                               SR_PROBE_ANALOG, TRUE, probe_name)))
+       for (i = 0; i < num_analog_channels; i++) {
+               sprintf(channel_name, "A%d", i);
+               if (!(ch = sr_probe_new(i + num_logic_channels,
+                               SR_PROBE_ANALOG, TRUE, channel_name)))
                        return NULL;
-               sdi->probes = g_slist_append(sdi->probes, probe);
+               sdi->channels = g_slist_append(sdi->channels, ch);
 
-               /* Every analog probe gets its own probe group. */
-               if (!(pg = g_try_malloc(sizeof(struct sr_probe_group))))
+               /* Every analog channel gets its own channel group. */
+               if (!(cg = g_try_malloc(sizeof(struct sr_channel_group))))
                        return NULL;
-               pg->name = g_strdup(probe_name);
-               pg->probes = g_slist_append(NULL, probe);
+               cg->name = g_strdup(channel_name);
+               cg->channels = g_slist_append(NULL, ch);
 
-               /* Every probe group gets a generator struct. */
+               /* Every channel group gets a generator struct. */
                if (!(ag = g_try_malloc(sizeof(struct analog_gen))))
                        return NULL;
-               ag->packet.probes = pg->probes;
+               ag->packet.channels = cg->channels;
                ag->packet.mq = 0;
                ag->packet.mqflags = 0;
                ag->packet.unit = SR_UNIT_VOLT;
                ag->packet.data = ag->pattern_data;
                ag->pattern = pattern;
-               pg->priv = ag;
+               cg->priv = ag;
 
-               sdi->probe_groups = g_slist_append(sdi->probe_groups, pg);
-               devc->analog_probe_groups = g_slist_append(devc->analog_probe_groups, pg);
+               sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
+               devc->analog_channel_groups = g_slist_append(devc->analog_channel_groups, cg);
 
                if (++pattern == ARRAY_SIZE(analog_pattern_str))
                        pattern = 0;
@@ -384,14 +378,14 @@ static int dev_close(struct sr_dev_inst *sdi)
 
 static int cleanup(void)
 {
-       return dev_clear();
+       return std_dev_clear(di, NULL);
 }
 
 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_probe_group *probe_group)
+               const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
-       struct sr_probe *probe;
+       struct sr_channel *ch;
        struct analog_gen *ag;
        int pattern;
 
@@ -410,24 +404,24 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
                *data = g_variant_new_uint64(devc->limit_msec);
                break;
        case SR_CONF_PATTERN_MODE:
-               if (!probe_group)
-                       return SR_ERR_PROBE_GROUP;
-               probe = probe_group->probes->data;
-               if (probe->type == SR_PROBE_LOGIC) {
+               if (!cg)
+                       return SR_ERR_CHANNEL_GROUP;
+               ch = cg->channels->data;
+               if (ch->type == SR_PROBE_LOGIC) {
                        pattern = devc->logic_pattern;
                        *data = g_variant_new_string(logic_pattern_str[pattern]);
-               } else if (probe->type == SR_PROBE_ANALOG) {
-                       ag = probe_group->priv;
+               } else if (ch->type == SR_PROBE_ANALOG) {
+                       ag = cg->priv;
                        pattern = ag->pattern;
                        *data = g_variant_new_string(analog_pattern_str[pattern]);
                } else
                        return SR_ERR_BUG;
                break;
        case SR_CONF_NUM_LOGIC_PROBES:
-               *data = g_variant_new_int32(devc->num_logic_probes);
+               *data = g_variant_new_int32(devc->num_logic_channels);
                break;
        case SR_CONF_NUM_ANALOG_PROBES:
-               *data = g_variant_new_int32(devc->num_analog_probes);
+               *data = g_variant_new_int32(devc->num_analog_channels);
                break;
        default:
                return SR_ERR_NA;
@@ -437,11 +431,11 @@ static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
 }
 
 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
-               const struct sr_probe_group *probe_group)
+               const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
        struct analog_gen *ag;
-       struct sr_probe *probe;
+       struct sr_channel *ch;
        int pattern, ret;
        unsigned int i;
        const char *stropt;
@@ -468,12 +462,12 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                sr_dbg("Setting time limit to %" PRIu64"ms", devc->limit_msec);
                break;
        case SR_CONF_PATTERN_MODE:
-               if (!probe_group)
-                       return SR_ERR_PROBE_GROUP;
+               if (!cg)
+                       return SR_ERR_CHANNEL_GROUP;
                stropt = g_variant_get_string(data, NULL);
-               probe = probe_group->probes->data;
+               ch = cg->channels->data;
                pattern = -1;
-               if (probe->type == SR_PROBE_LOGIC) {
+               if (ch->type == SR_PROBE_LOGIC) {
                        for (i = 0; i < ARRAY_SIZE(logic_pattern_str); i++) {
                                if (!strcmp(stropt, logic_pattern_str[i])) {
                                        pattern = i;
@@ -491,7 +485,7 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                                memset(devc->logic_data, 0xff, LOGIC_BUFSIZE);
                        sr_dbg("Setting logic pattern to %s",
                                        logic_pattern_str[pattern]);
-               } else if (probe->type == SR_PROBE_ANALOG) {
+               } else if (ch->type == SR_PROBE_ANALOG) {
                        for (i = 0; i < ARRAY_SIZE(analog_pattern_str); i++) {
                                if (!strcmp(stropt, analog_pattern_str[i])) {
                                        pattern = i;
@@ -500,10 +494,9 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
                        }
                        if (pattern == -1)
                                return SR_ERR_ARG;
-                       sr_dbg("Setting analog pattern for probe group %s to %s",
-                                       probe_group->name,
-                                       analog_pattern_str[pattern]);
-                       ag = probe_group->priv;
+                       sr_dbg("Setting analog pattern for channel group %s to %s",
+                                       cg->name, analog_pattern_str[pattern]);
+                       ag = cg->priv;
                        ag->pattern = pattern;
                } else
                        return SR_ERR_BUG;
@@ -516,9 +509,9 @@ static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
 }
 
 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
-               const struct sr_probe_group *probe_group)
+               const struct sr_channel_group *cg)
 {
-       struct sr_probe *probe;
+       struct sr_channel *ch;
        GVariant *gvar;
        GVariantBuilder gvb;
 
@@ -533,7 +526,7 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
        if (!sdi)
                return SR_ERR_ARG;
 
-       if (!probe_group) {
+       if (!cg) {
                switch (key) {
                case SR_CONF_DEVICE_OPTIONS:
                        *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
@@ -550,17 +543,17 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
                        return SR_ERR_NA;
                }
        } else {
-               probe = probe_group->probes->data;
+               ch = cg->channels->data;
                switch (key) {
                case SR_CONF_DEVICE_OPTIONS:
                        *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
-                                       devopts_pg, ARRAY_SIZE(devopts_pg), sizeof(int32_t));
+                                       devopts_cg, ARRAY_SIZE(devopts_cg), sizeof(int32_t));
                        break;
                case SR_CONF_PATTERN_MODE:
-                       if (probe->type == SR_PROBE_LOGIC)
+                       if (ch->type == SR_PROBE_LOGIC)
                                *data = g_variant_new_strv(logic_pattern_str,
                                                ARRAY_SIZE(logic_pattern_str));
-                       else if (probe->type == SR_PROBE_ANALOG)
+                       else if (ch->type == SR_PROBE_ANALOG)
                                *data = g_variant_new_strv(analog_pattern_str,
                                                ARRAY_SIZE(analog_pattern_str));
                        else
@@ -622,7 +615,7 @@ static int prepare_data(int fd, int revents, void *cb_data)
        struct dev_context *devc;
        struct sr_datafeed_packet packet;
        struct sr_datafeed_logic logic;
-       struct sr_probe_group *pg;
+       struct sr_channel_group *cg;
        struct analog_gen *ag;
        GSList *l;
        uint64_t logic_todo, analog_todo, expected_samplenum, analog_samples, sending_now;
@@ -645,7 +638,7 @@ static int prepare_data(int fd, int revents, void *cb_data)
 
        while (logic_todo || analog_todo) {
                /* Logic */
-               if (devc->num_logic_probes > 0 && logic_todo > 0) {
+               if (devc->num_logic_channels > 0 && logic_todo > 0) {
                        sending_now = MIN(logic_todo,
                                        LOGIC_BUFSIZE / devc->logic_unitsize);
                        logic_generator(sdi, sending_now * devc->logic_unitsize);
@@ -659,12 +652,12 @@ static int prepare_data(int fd, int revents, void *cb_data)
                        devc->logic_counter += sending_now;
                }
 
-               /* Analog, one probe at a time */
-               if (devc->num_analog_probes > 0 && analog_todo > 0) {
+               /* Analog, one channel at a time */
+               if (devc->num_analog_channels > 0 && analog_todo > 0) {
                        sending_now = 0;
-                       for (l = devc->analog_probe_groups; l; l = l->next) {
-                               pg = l->data;
-                               ag = pg->priv;
+                       for (l = devc->analog_channel_groups; l; l = l->next) {
+                               cg = l->data;
+                               ag = cg->priv;
                                packet.type = SR_DF_ANALOG;
                                packet.payload = &ag->packet;
 
@@ -674,7 +667,7 @@ static int prepare_data(int fd, int revents, void *cb_data)
                                 * help here as well */
 
                                analog_samples = MIN(analog_todo, ag->num_samples);
-                               /* Whichever probe group gets there first. */
+                               /* Whichever channel group gets there first. */
                                sending_now = MAX(sending_now, analog_samples);
                                ag->packet.num_samples = analog_samples;
                                sr_session_send(sdi, &packet);
@@ -719,7 +712,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
                return SR_ERR;
        }
 
-       for (l = devc->analog_probe_groups; l; l = l->next) {
+       for (l = devc->analog_channel_groups; l; l = l->next) {
                generate_analog_pattern(l->data, devc->cur_samplerate);
        }
 
@@ -753,7 +746,7 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        (void)cb_data;
 
        devc = sdi->priv;
-       sr_dbg("Stopping aquisition.");
+       sr_dbg("Stopping acquisition.");
 
        sr_session_source_remove_channel(devc->channel);
        g_io_channel_shutdown(devc->channel, FALSE, NULL);
@@ -775,7 +768,7 @@ SR_PRIV struct sr_dev_driver demo_driver_info = {
        .cleanup = cleanup,
        .scan = scan,
        .dev_list = dev_list,
-       .dev_clear = dev_clear,
+       .dev_clear = NULL,
        .config_get = config_get,
        .config_set = config_set,
        .config_list = config_list,