]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/openbench-logic-sniffer/api.c
ols: move device context creation from protocol.c to api.c
[libsigrok.git] / src / hardware / openbench-logic-sniffer / api.c
index 7a5f22011caed4fed85701036af512b12dcfa5e0..35f6be7e24582f7e65b834e752201c6570afbb16 100644 (file)
@@ -32,6 +32,7 @@ static const uint32_t drvopts[] = {
 };
 
 static const uint32_t devopts[] = {
+       SR_CONF_CONN | SR_CONF_GET,
        SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
        SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
        SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
@@ -48,9 +49,9 @@ static const int32_t trigger_matches[] = {
        SR_TRIGGER_ONE,
 };
 
-static const charexternal_clock_edges[] = {
-       "rising", // positive edge
-       "falling" // negative edge
+static const char *external_clock_edges[] = {
+       "rising", /* positive edge */
+       "falling" /* negative edge */
 };
 
 #define STR_PATTERN_NONE     "None"
@@ -101,6 +102,7 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
        unsigned int i;
        const char *conn, *serialcomm;
        char buf[4] = { 0, 0, 0, 0 };
+       struct dev_context *devc;
 
        conn = serialcomm = NULL;
        for (l = options; l; l = l->next) {
@@ -146,7 +148,8 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
                return NULL;
        }
 
-       num_read = serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
+       num_read =
+               serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
        if (num_read < 0) {
                sr_err("Getting ID reply failed (%d).", num_read);
                return NULL;
@@ -159,37 +162,50 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
 
                sr_hexdump_free(id);
                return NULL;
+       } else {
+               sr_dbg("Successful detection, got '%c%c%c%c' (0x%02x 0x%02x 0x%02x 0x%02x).",
+                      buf[0], buf[1], buf[2], buf[3],
+                      buf[0], buf[1], buf[2], buf[3]);
        }
 
-       /* Definitely using the OLS protocol, check if it supports
+       /*
+        * Create common data structures (sdi, devc) here in the common
+        * code path. These further get filled in either from metadata
+        * which is gathered from the device, or from open coded generic
+        * fallback data which is kept in the driver source code.
+        */
+       sdi = g_malloc0(sizeof(*sdi));
+       sdi->status = SR_ST_INACTIVE;
+       sdi->inst_type = SR_INST_SERIAL;
+       sdi->conn = serial;
+       sdi->connection_id = g_strdup(serial->port);
+       devc = g_malloc0(sizeof(*devc));
+       sdi->priv = devc;
+       devc->trigger_at_smpl = OLS_NO_TRIGGER;
+
+       /*
+        * Definitely using the OLS protocol, check if it supports
         * the metadata command.
         */
        send_shortcommand(serial, CMD_METADATA);
-
        g_usleep(RESPONSE_DELAY_US);
-
        if (serial_has_receive_data(serial) != 0) {
                /* Got metadata. */
-               sdi = get_metadata(serial);
+               (void)ols_get_metadata(sdi);
        } else {
                /* Not an OLS -- some other board that uses the sump protocol. */
                sr_info("Device does not support metadata.");
-               sdi = g_malloc0(sizeof(struct sr_dev_inst));
-               sdi->status = SR_ST_INACTIVE;
                sdi->vendor = g_strdup("Sump");
                sdi->model = g_strdup("Logic Analyzer");
                sdi->version = g_strdup("v1.0");
                for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
                        sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
-                                       ols_channel_names[i]);
-               sdi->priv = ols_dev_new();
+                                      ols_channel_names[i]);
        }
        /* Configure samplerate and divider. */
        if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
-               sr_dbg("Failed to set default samplerate (%"PRIu64").",
-                               DEFAULT_SAMPLERATE);
-       sdi->inst_type = SR_INST_SERIAL;
-       sdi->conn = serial;
+               sr_dbg("Failed to set default samplerate (%" PRIu64 ").",
+                      DEFAULT_SAMPLERATE);
 
        serial_close(serial);
 
@@ -197,7 +213,8 @@ static GSList *scan(struct sr_dev_driver *di, GSList *options)
 }
 
 static int config_get(uint32_t key, GVariant **data,
-       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
+                     const struct sr_dev_inst *sdi,
+                     const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
 
@@ -209,6 +226,11 @@ static int config_get(uint32_t key, GVariant **data,
        devc = sdi->priv;
 
        switch (key) {
+       case SR_CONF_CONN:
+               if (!sdi->conn || !sdi->connection_id)
+                       return SR_ERR_NA;
+               *data = g_variant_new_string(sdi->connection_id);
+               break;
        case SR_CONF_SAMPLERATE:
                *data = g_variant_new_uint64(devc->cur_samplerate);
                break;
@@ -227,15 +249,18 @@ static int config_get(uint32_t key, GVariant **data,
                        *data = g_variant_new_string(STR_PATTERN_NONE);
                break;
        case SR_CONF_RLE:
-               *data = g_variant_new_boolean(devc->capture_flags & CAPTURE_FLAG_RLE ? TRUE : FALSE);
+               *data = g_variant_new_boolean(
+                       devc->capture_flags & CAPTURE_FLAG_RLE ? TRUE : FALSE);
                break;
        case SR_CONF_EXTERNAL_CLOCK:
                *data = g_variant_new_boolean(
-                       devc->capture_flags & CAPTURE_FLAG_CLOCK_EXTERNAL ? TRUE : FALSE);
+                       devc->capture_flags & CAPTURE_FLAG_CLOCK_EXTERNAL
+                       ? TRUE : FALSE);
                break;
        case SR_CONF_CLOCK_EDGE:
                *data = g_variant_new_string(external_clock_edges[
-                       devc->capture_flags & CAPTURE_FLAG_INVERT_EXT_CLOCK ? 1 : 0]);
+                       devc->capture_flags & CAPTURE_FLAG_INVERT_EXT_CLOCK
+                       ? 1 : 0]);
                break;
        default:
                return SR_ERR_NA;
@@ -245,7 +270,8 @@ static int config_get(uint32_t key, GVariant **data,
 }
 
 static int config_set(uint32_t key, GVariant *data,
-       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
+                     const struct sr_dev_inst *sdi,
+                     const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
        uint16_t flag;
@@ -334,7 +360,8 @@ static int config_set(uint32_t key, GVariant *data,
 }
 
 static int config_list(uint32_t key, GVariant **data,
-       const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
+                      const struct sr_dev_inst *sdi,
+                      const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
        int num_ols_changrp, i;
@@ -342,7 +369,8 @@ static int config_list(uint32_t key, GVariant **data,
        switch (key) {
        case SR_CONF_SCAN_OPTIONS:
        case SR_CONF_DEVICE_OPTIONS:
-               return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
+               return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts,
+                                      devopts);
        case SR_CONF_SAMPLERATE:
                *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
                break;
@@ -359,8 +387,6 @@ static int config_list(uint32_t key, GVariant **data,
                if (!sdi)
                        return SR_ERR_ARG;
                devc = sdi->priv;
-               if (devc->capture_flags & CAPTURE_FLAG_RLE)
-                       return SR_ERR_NA;
                if (devc->max_samples == 0)
                        /* Device didn't specify sample memory size in metadata. */
                        return SR_ERR_NA;
@@ -375,8 +401,8 @@ static int config_list(uint32_t key, GVariant **data,
                                num_ols_changrp++;
                }
 
-               *data = std_gvar_tuple_u64(MIN_NUM_SAMPLES,
-                       (num_ols_changrp) ? devc->max_samples / num_ols_changrp : MIN_NUM_SAMPLES);
+               *data = std_gvar_tuple_u64(MIN_NUM_SAMPLES, (num_ols_changrp)
+                       ? devc->max_samples / num_ols_changrp : MIN_NUM_SAMPLES);
                break;
        default:
                return SR_ERR_NA;
@@ -413,10 +439,8 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi)
        /* If the device stops sending for longer than it takes to send a byte,
         * that means it's finished. But wait at least 100 ms to be safe.
         */
-       serial_source_add(sdi->session, serial, G_IO_IN, 100,
-                       ols_receive_data, (struct sr_dev_inst *)sdi);
-
-       return SR_OK;
+       return serial_source_add(sdi->session, serial, G_IO_IN, 100,
+                                ols_receive_data, (struct sr_dev_inst *)sdi);
 }
 
 static int dev_acquisition_stop(struct sr_dev_inst *sdi)