]> sigrok.org Git - libsigrok.git/blobdiff - hardware/kecheng-kc-330b/api.c
Replace 'probe' with 'channel' in most places.
[libsigrok.git] / hardware / kecheng-kc-330b / api.c
index 1555ac4872721252bfa2e943fd80680e1399d612..fcb54381e01b9da030bdfe2ac0b0d65e8e965b38 100644 (file)
@@ -103,7 +103,6 @@ static int scan_kecheng(struct sr_usb_dev_inst *usb, char **model)
 
        buf[buf[1] + 2] = '\x0';
        *model = g_strndup((const gchar *)buf + 2, 30);
-       //g_strstrip(*model);
 
        return SR_OK;
 }
@@ -113,7 +112,7 @@ static GSList *scan(GSList *options)
        struct drv_context *drvc;
        struct dev_context *devc;
        struct sr_dev_inst *sdi;
-       struct sr_probe *probe;
+       struct sr_channel *ch;
        GSList *usb_devices, *devices, *l;
        char *model;
 
@@ -136,9 +135,9 @@ static GSList *scan(GSList *options)
                        sdi->driver = di;
                        sdi->inst_type = SR_INST_USB;
                        sdi->conn = l->data;
-                       if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "SPL")))
+                       if (!(ch = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "SPL")))
                                return NULL;
-                       sdi->probes = g_slist_append(sdi->probes, probe);
+                       sdi->channels = g_slist_append(sdi->channels, ch);
 
                        if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
                                sr_dbg("Device context malloc failed.");
@@ -153,6 +152,7 @@ static GSList *scan(GSList *options)
                        devc->alarm_high = DEFAULT_ALARM_HIGH;
                        devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
                        devc->data_source = DEFAULT_DATA_SOURCE;
+                       devc->config_dirty = FALSE;
 
                        /* TODO: Set date/time? */
 
@@ -168,16 +168,7 @@ static GSList *scan(GSList *options)
 
 static GSList *dev_list(void)
 {
-       struct drv_context *drvc;
-
-       drvc = di->priv;
-
-       return drvc->instances;
-}
-
-static int dev_clear(void)
-{
-       return std_dev_clear(di, NULL);
+       return ((struct drv_context *)(di->priv))->instances;
 }
 
 static int dev_open(struct sr_dev_inst *sdi)
@@ -196,20 +187,23 @@ static int dev_open(struct sr_dev_inst *sdi)
        if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
                return SR_ERR;
 
+       if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
+               sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
+               return SR_ERR;
+       }
+
        if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
                sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
                return SR_ERR;
        }
        sdi->status = SR_ST_ACTIVE;
 
-       /* Force configuration. */
-       ret = kecheng_kc_330b_configure(sdi);
-
        return ret;
 }
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
+       struct dev_context *devc;
        struct sr_usb_dev_inst *usb;
 
        if (!di->priv) {
@@ -223,6 +217,12 @@ static int dev_close(struct sr_dev_inst *sdi)
                /*  Nothing to do. */
                return SR_OK;
 
+       /* This allows a frontend to configure the device without ever
+        * doing an acquisition step. */
+       devc = sdi->priv;
+       if (!devc->config_dirty)
+               kecheng_kc_330b_configure(sdi);
+
        libusb_release_interface(usb->devhdl, USB_INTERFACE);
        libusb_close(usb->devhdl);
        usb->devhdl = NULL;
@@ -240,19 +240,22 @@ static int cleanup(void)
                /* Can get called on an unused driver, doesn't matter. */
                return SR_OK;
 
-       ret = dev_clear();
+
+       ret = std_dev_clear(di, NULL);
        g_free(drvc);
        di->priv = NULL;
 
        return ret;
 }
 
-static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
+static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
        GVariant *rational[2];
        const uint64_t *si;
-       int tmp, ret;
+
+       (void)cg;
 
        devc = sdi->priv;
        switch (key) {
@@ -266,10 +269,8 @@ static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
                *data = g_variant_new_tuple(rational, 2);
                break;
        case SR_CONF_DATALOG:
-               if ((ret = kecheng_kc_330b_recording_get(sdi, &tmp)) == SR_OK)
-                       *data = g_variant_new_boolean(tmp);
-               else
-                       return SR_ERR;
+               /* There really isn't a way to be sure the device is logging. */
+               return SR_ERR_NA;
                break;
        case SR_CONF_SPL_WEIGHT_FREQ:
                if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
@@ -296,7 +297,8 @@ static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
-static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
+static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
+               const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
        uint64_t p, q;
@@ -304,6 +306,8 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
        int tmp, ret;
        const char *tmp_str;
 
+       (void)cg;
+
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
@@ -326,7 +330,7 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
                        if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
                                continue;
                        devc->sample_interval = i;
-                       kecheng_kc_330b_configure(sdi);
+                       devc->config_dirty = TRUE;
                        break;
                }
                if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
@@ -342,7 +346,7 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
                        return SR_ERR_ARG;
                devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
                devc->mqflags |= tmp;
-               kecheng_kc_330b_configure(sdi);
+               devc->config_dirty = TRUE;
                break;
        case SR_CONF_SPL_WEIGHT_TIME:
                tmp_str = g_variant_get_string(data, NULL);
@@ -354,7 +358,7 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
                        return SR_ERR_ARG;
                devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
                devc->mqflags |= tmp;
-               kecheng_kc_330b_configure(sdi);
+               devc->config_dirty = TRUE;
                break;
        case SR_CONF_DATA_SOURCE:
                tmp_str = g_variant_get_string(data, NULL);
@@ -364,6 +368,7 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
                        devc->data_source = DATA_SOURCE_MEMORY;
                else
                        return SR_ERR;
+               devc->config_dirty = TRUE;
                break;
        default:
                ret = SR_ERR_NA;
@@ -372,13 +377,15 @@ static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi)
        return ret;
 }
 
-static int config_list(int key, 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_channel_group *cg)
 {
        GVariant *tuple, *rational[2];
        GVariantBuilder gvb;
        unsigned int i;
 
        (void)sdi;
+       (void)cg;
 
        switch (key) {
        case SR_CONF_DEVICE_OPTIONS:
@@ -412,14 +419,18 @@ static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 }
 
 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+               void *cb_data)
 {
        struct drv_context *drvc;
        struct dev_context *devc;
+       struct sr_datafeed_packet packet;
+       struct sr_datafeed_meta meta;
+       struct sr_config *src;
        struct sr_usb_dev_inst *usb;
-       const struct libusb_pollfd **pfd;
-       int len, ret, i;
-       unsigned char cmd;
+       GVariant *gvar, *rational[2];
+       const uint64_t *si;
+       int stored_mqflags, req_len, buf_len, len, ret;
+       unsigned char buf[9];
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
@@ -431,44 +442,97 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        devc->cb_data = cb_data;
        devc->num_samples = 0;
 
-       if (!(devc->xfer = libusb_alloc_transfer(0)))
-               return SR_ERR;
-
        /* Send header packet to the session bus. */
        std_session_send_df_header(cb_data, LOG_PREFIX);
 
-       pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
-       for (i = 0; pfd[i]; i++) {
-               /* Handle USB events every 10ms. */
-               sr_source_add(pfd[i]->fd, pfd[i]->events, 10,
-                               kecheng_kc_330b_handle_events, (void *)sdi);
-               /* We'll need to remove this fd later. */
-               devc->usbfd[i] = pfd[i]->fd;
+       if (devc->data_source == DATA_SOURCE_LIVE) {
+               /* Force configuration. */
+               kecheng_kc_330b_configure(sdi);
+
+               if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
+                       return SR_ERR;
+               if (ret != DEVICE_ACTIVE) {
+                       sr_err("Device is inactive");
+                       /* Still continue though, since the device will
+                        * just return 30.0 until the user hits the button
+                        * on the device -- and then start feeding good
+                        * samples back. */
+               }
+       } else {
+               if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
+                       return SR_ERR;
+               stored_mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
+               stored_mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
+               devc->stored_samples = (buf[7] << 8) | buf[8];
+               if (devc->stored_samples == 0) {
+                       /* Notify frontend of empty log by sending start/end packets. */
+                       packet.type = SR_DF_END;
+                       sr_session_send(cb_data, &packet);
+                       return SR_OK;
+               }
+
+               if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
+                       devc->stored_samples = devc->limit_samples;
+
+               si = kecheng_kc_330b_sample_intervals[buf[1]];
+               rational[0] = g_variant_new_uint64(si[0]);
+               rational[1] = g_variant_new_uint64(si[1]);
+               gvar = g_variant_new_tuple(rational, 2);
+               src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
+               packet.type = SR_DF_META;
+               packet.payload = &meta;
+               meta.config = g_slist_append(NULL, src);
+               sr_session_send(devc->cb_data, &packet);
+               g_free(src);
        }
-       devc->usbfd[i] = -1;
 
-       cmd = CMD_GET_LIVE_SPL;
-       ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
+       if (!(devc->xfer = libusb_alloc_transfer(0)))
+               return SR_ERR;
+
+       usb_source_add(drvc->sr_ctx, 10,
+               kecheng_kc_330b_handle_events, (void *)sdi);
+
+       if (devc->data_source == DATA_SOURCE_LIVE) {
+               buf[0] = CMD_GET_LIVE_SPL;
+               buf_len = 1;
+               devc->state = LIVE_SPL_WAIT;
+               devc->last_live_request = g_get_monotonic_time() / 1000;
+               req_len = 3;
+       } else {
+               buf[0] = CMD_GET_LOG_DATA;
+               buf[1] = 0;
+               buf[2] = 0;
+               buf_len = 4;
+               devc->state = LOG_DATA_WAIT;
+               if (devc->stored_samples < 63)
+                       buf[3] = devc->stored_samples;
+               else
+                       buf[3] = 63;
+               /* Command ack byte + 2 bytes per sample. */
+               req_len = 1 + buf[3] * 2;
+       }
+
+       ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
        if (ret != 0 || len != 1) {
                sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
                libusb_free_transfer(devc->xfer);
                return SR_ERR;
        }
-       devc->last_live_request = g_get_monotonic_time() / 1000;
 
        libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
-                       16, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
+                       req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
        if (libusb_submit_transfer(devc->xfer) != 0) {
                libusb_free_transfer(devc->xfer);
                return SR_ERR;
        }
-       devc->state = LIVE_SPL_WAIT;
 
        return SR_OK;
 }
 
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
+       struct dev_context *devc;
+
        (void)cb_data;
 
        if (sdi->status != SR_ST_ACTIVE)
@@ -477,6 +541,17 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        /* Signal USB transfer handler to clean up and stop. */
        sdi->status = SR_ST_STOPPING;
 
+       devc = sdi->priv;
+       if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
+               /* The protocol doesn't have a command to clear stored data;
+                * it clears it whenever new configuration is set. That means
+                * we can't just configure the device any time we want when
+                * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
+                * it is now, when we're sure we've pulled in all the stored
+                * data. */
+               kecheng_kc_330b_configure(sdi);
+       }
+
        return SR_OK;
 }
 
@@ -488,7 +563,7 @@ SR_PRIV struct sr_dev_driver kecheng_kc_330b_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,