]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/scpi-pps/api.c
Change sr_dev_inst_new() to take no parameters.
[libsigrok.git] / src / hardware / scpi-pps / api.c
index aea3bd5e26833c95cee54ea3c7e850dc98cfcd61..b62574e2abbb02492e8305f8aaad18139c97efac 100644 (file)
@@ -30,6 +30,11 @@ static const uint32_t scanopts[] = {
        SR_CONF_SERIALCOMM,
 };
 
+static const uint32_t devopts_driver[] = {
+       SR_CONF_POWER_SUPPLY,
+       SR_CONF_CONTINUOUS,
+};
+
 static struct pps_channel_instance pci[] = {
        { SR_MQ_VOLTAGE, SCPI_CMD_GET_MEAS_VOLTAGE, "V" },
        { SR_MQ_CURRENT, SCPI_CMD_GET_MEAS_CURRENT, "I" },
@@ -50,13 +55,15 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
        struct sr_channel *ch;
        const struct scpi_pps *device;
        struct pps_channel *pch;
-       const struct channel_group_spec *cgs;
+       struct channel_spec *channels;
+       struct channel_group_spec *channel_groups, *cgs;
        struct pps_channel_group *pcg;
        GRegex *model_re;
        GMatchInfo *model_mi;
        GSList *l;
        uint64_t mask;
-       unsigned int ch_num, ch_idx, i, j;
+       unsigned int num_channels, num_channel_groups, ch_num, ch_idx, i, j;
+       int ret;
        const char *vendor;
        char ch_name[16];
 
@@ -83,35 +90,62 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
                return NULL;
        }
 
-       sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, vendor, hw_info->model,
-                       hw_info->firmware_version);
+       sdi = sr_dev_inst_new();
+       sdi->status = SR_ST_ACTIVE;
+       sdi->vendor = g_strdup(vendor);
+       sdi->model = g_strdup(hw_info->model);
+       sdi->version = g_strdup(hw_info->firmware_version);
        sdi->conn = scpi;
        sdi->driver = di;
        sdi->inst_type = SR_INST_SCPI;
+       sdi->serial_num = g_strdup(hw_info->serial_number);
+
        devc = g_malloc0(sizeof(struct dev_context));
        devc->device = device;
        sdi->priv = devc;
 
+       if (device->num_channels) {
+               /* Static channels and groups. */
+               channels = device->channels;
+               num_channels = device->num_channels;
+               channel_groups = device->channel_groups;
+               num_channel_groups = device->num_channel_groups;
+       } else {
+               /* Channels and groups need to be probed. */
+               ret = device->probe_channels(sdi, hw_info, &channels, &num_channels,
+                               &channel_groups, &num_channel_groups);
+               if (ret != SR_OK) {
+                       sr_err("Failed to probe for channels.");
+                       return NULL;
+               }
+               /*
+                * Since these were dynamically allocated, we'll need to free them
+                * later.
+                */
+               devc->channels = channels;
+               devc->channel_groups = channel_groups;
+       }
+
        ch_idx = 0;
-       for (ch_num = 0; ch_num < device->num_channels; ch_num++) {
+       for (ch_num = 0; ch_num < num_channels; ch_num++) {
                /* Create one channel per measurable output unit. */
                for (i = 0; i < ARRAY_SIZE(pci); i++) {
                        if (!scpi_cmd_get(sdi, pci[i].command))
                                continue;
                        g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
-                                       device->channels[ch_num].name);
+                                       channels[ch_num].name);
                        ch = sr_channel_new(ch_idx++, SR_CHANNEL_ANALOG, TRUE, ch_name);
                        pch = g_malloc0(sizeof(struct pps_channel));
                        pch->hw_output_idx = ch_num;
-                       pch->hwname = device->channels[ch_num].name;
+                       pch->hwname = channels[ch_num].name;
                        pch->mq = pci[i].mq;
                        ch->priv = pch;
                        sdi->channels = g_slist_append(sdi->channels, ch);
                }
        }
 
-       for (i = 0; i < device->num_channel_groups; i++) {
-               cgs = &device->channel_groups[i];
+       for (i = 0; i < num_channel_groups; i++) {
+               cgs = &channel_groups[i];
                cg = g_malloc0(sizeof(struct sr_channel_group));
                cg->name = g_strdup(cgs->name);
                for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
@@ -130,8 +164,10 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
                sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
        }
 
-       /* SCPI devices commonly lock the panel keys when accessed remotely. */
-       scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
+       sr_scpi_hw_info_free(hw_info);
+       hw_info = NULL;
+
+       scpi_cmd(sdi, SCPI_CMD_LOCAL);
        sr_scpi_close(scpi);
 
        return sdi;
@@ -154,7 +190,9 @@ static int dev_clear(void)
 
 static int dev_open(struct sr_dev_inst *sdi)
 {
+       struct dev_context *devc;
        struct sr_scpi_dev_inst *scpi;
+       GVariant *beeper;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR;
@@ -165,19 +203,34 @@ static int dev_open(struct sr_dev_inst *sdi)
 
        sdi->status = SR_ST_ACTIVE;
 
+       scpi_cmd(sdi, SCPI_CMD_REMOTE);
+       devc = sdi->priv;
+       devc->beeper_was_set = FALSE;
+       if (scpi_cmd_resp(sdi, &beeper, G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
+               if (g_variant_get_boolean(beeper)) {
+                       devc->beeper_was_set = TRUE;
+                       scpi_cmd(sdi, SCPI_CMD_BEEPER_DISABLE);
+               }
+               g_variant_unref(beeper);
+       }
+
        return SR_OK;
 }
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
        struct sr_scpi_dev_inst *scpi;
+       struct dev_context *devc;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
+       devc = sdi->priv;
        scpi = sdi->conn;
        if (scpi) {
-               scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
+               if (devc->beeper_was_set)
+                       scpi_cmd(sdi, SCPI_CMD_BEEPER_ENABLE);
+               scpi_cmd(sdi, SCPI_CMD_LOCAL);
                sr_scpi_close(scpi);
                sdi->status = SR_ST_INACTIVE;
        }
@@ -185,28 +238,33 @@ static int dev_close(struct sr_dev_inst *sdi)
        return SR_OK;
 }
 
+static void clear_helper(void *priv)
+{
+       struct dev_context *devc;
+
+       devc = priv;
+       g_free(devc->channels);
+       g_free(devc->channel_groups);
+       g_free(devc);
+}
+
 static int cleanup(void)
 {
-       return SR_OK;
+       return std_dev_clear(di, clear_helper);
 }
 
 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
        struct dev_context *devc;
-       struct sr_scpi_dev_inst *scpi;
-       struct sr_channel *ch;
-       struct pps_channel *pch;
        const GVariantType *gvtype;
        unsigned int i;
        int cmd, ret;
-       char *s;
 
        if (!sdi)
                return SR_ERR_ARG;
 
        devc = sdi->priv;
-       scpi = sdi->conn;
 
        if (cg) {
                /*
@@ -226,9 +284,6 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                                break;
                        }
                }
-
-               ch = cg->channels->data;
-               pch = ch->priv;
        }
 
        gvtype = NULL;
@@ -242,17 +297,17 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                gvtype = G_VARIANT_TYPE_DOUBLE;
                cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
                break;
-       case SR_CONF_OUTPUT_VOLTAGE_MAX:
+       case SR_CONF_OUTPUT_VOLTAGE_TARGET:
                gvtype = G_VARIANT_TYPE_DOUBLE;
-               cmd = SCPI_CMD_GET_VOLTAGE_MAX;
+               cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
                break;
        case SR_CONF_OUTPUT_CURRENT:
                gvtype = G_VARIANT_TYPE_DOUBLE;
                cmd = SCPI_CMD_GET_MEAS_CURRENT;
                break;
-       case SR_CONF_OUTPUT_CURRENT_MAX:
+       case SR_CONF_OUTPUT_CURRENT_LIMIT:
                gvtype = G_VARIANT_TYPE_DOUBLE;
-               cmd = SCPI_CMD_GET_CURRENT_MAX;
+               cmd = SCPI_CMD_GET_CURRENT_LIMIT;
                break;
        case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
                gvtype = G_VARIANT_TYPE_BOOLEAN;
@@ -282,31 +337,14 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                gvtype = G_VARIANT_TYPE_BOOLEAN;
                cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
                break;
+       case SR_CONF_OUTPUT_REGULATION:
+               gvtype = G_VARIANT_TYPE_STRING;
+               cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
        }
        if (gvtype) {
                if (cg)
-                       ret = scpi_cmd_resp(sdi, data, gvtype, cmd, pch->hwname);
-               else
-                       ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
-       } else if (cg) {
-               switch (key) {
-               case SR_CONF_OUTPUT_REGULATION:
-                       ret = SR_ERR;
-                       if (scpi_cmd(sdi, SCPI_CMD_GET_OUTPUT_REGULATION, pch->hwname) == SR_OK) {
-                               if (sr_scpi_get_string(scpi, NULL, &s) == SR_OK) {
-                                       if (strcmp(s, "CC") && strcmp(s, "CV") && strcmp(s, "UR")) {
-                                               sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
-                                       } else {
-                                               *data = g_variant_new_string(s);
-                                               g_free(s);
-                                               ret = SR_OK;
-                                       }
-                               }
-                       }
-                       break;
-               default:
-                       ret = SR_ERR_NA;
-               }
+                       select_channel(sdi, cg->channels->data);
+               ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
        } else
                ret = SR_ERR_NA;
 
@@ -316,11 +354,8 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
-       struct sr_channel *ch;
-       struct pps_channel *pch;
        double d;
        int ret;
-       const char *s;
 
        if (!sdi)
                return SR_ERR_ARG;
@@ -328,69 +363,54 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       ret = SR_OK;
-       if (!cg) {
-               switch (key) {
-               /* No channel group: global options. */
-               case SR_CONF_OUTPUT_ENABLED:
-                       s = g_variant_get_boolean(data) ? "ON" : "OFF";
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, s);
-                       break;
-               case SR_CONF_OUTPUT_VOLTAGE_MAX:
-                       d = g_variant_get_double(data);
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, d);
-                       break;
-               case SR_CONF_OUTPUT_CURRENT_MAX:
-                       d = g_variant_get_double(data);
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, d);
-                       break;
-               case SR_CONF_OVER_TEMPERATURE_PROTECTION:
-                       s = g_variant_get_boolean(data) ? "ON" : "OFF";
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION, s);
-                       break;
-               default:
-                       ret = SR_ERR_NA;
-               }
-       } else {
+       if (cg)
                /* Channel group specified. */
-               ch = cg->channels->data;
-               pch = ch->priv;
-               switch (key) {
-               case SR_CONF_OUTPUT_ENABLED:
-                       s = g_variant_get_boolean(data) ? "ON" : "OFF";
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, pch->hwname, s);
-                       break;
-               case SR_CONF_OUTPUT_VOLTAGE_MAX:
-                       d = g_variant_get_double(data);
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, pch->hwname, d);
-                       break;
-               case SR_CONF_OUTPUT_CURRENT_MAX:
-                       d = g_variant_get_double(data);
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, pch->hwname, d);
-                       break;
-               case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
-                       s = g_variant_get_boolean(data) ? "ON" : "OFF";
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLED,
-                                       pch->hwname, s);
-                       break;
-               case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
-                       d = g_variant_get_double(data);
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
-                                       pch->hwname, d);
-                       break;
-               case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
-                       s = g_variant_get_boolean(data) ? "ON" : "OFF";
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLED,
-                                       pch->hwname, s);
-                       break;
-               case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
-                       d = g_variant_get_double(data);
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD,
-                                       pch->hwname, d);
-                       break;
-               default:
-                       ret = SR_ERR_NA;
-               }
+               select_channel(sdi, cg->channels->data);
+
+       ret = SR_OK;
+       switch (key) {
+       case SR_CONF_OUTPUT_ENABLED:
+               if (g_variant_get_boolean(data))
+                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLE);
+               else
+                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_DISABLE);
+               break;
+       case SR_CONF_OUTPUT_VOLTAGE_TARGET:
+               d = g_variant_get_double(data);
+               ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_TARGET, d);
+               break;
+       case SR_CONF_OUTPUT_CURRENT_LIMIT:
+               d = g_variant_get_double(data);
+               ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_LIMIT, d);
+               break;
+       case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
+               if (g_variant_get_boolean(data))
+                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
+               else
+                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
+               break;
+       case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
+               d = g_variant_get_double(data);
+               ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
+               break;
+       case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
+               if (g_variant_get_boolean(data))
+                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
+               else
+                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
+               break;
+       case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
+               d = g_variant_get_double(data);
+               ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
+               break;
+       case SR_CONF_OVER_TEMPERATURE_PROTECTION:
+               if (g_variant_get_boolean(data))
+                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
+               else
+                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
+               break;
+       default:
+               ret = SR_ERR_NA;
        }
 
        return ret;
@@ -412,6 +432,10 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
                                scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
                return SR_OK;
+       } else if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               devopts_driver, ARRAY_SIZE(devopts_driver), sizeof(uint32_t));
+               return SR_OK;
        }
 
        if (!sdi)
@@ -464,7 +488,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                                        devc->device->devopts_cg, devc->device->num_devopts_cg,
                                        sizeof(uint32_t));
                        break;
-               case SR_CONF_OUTPUT_VOLTAGE_MAX:
+               case SR_CONF_OUTPUT_VOLTAGE_TARGET:
                        ch_spec = &(devc->device->channels[ch->index]);
                        g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
                        /* Min, max, write resolution. */
@@ -474,7 +498,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                        }
                        *data = g_variant_builder_end(&gvb);
                        break;
-               case SR_CONF_OUTPUT_CURRENT_MAX:
+               case SR_CONF_OUTPUT_CURRENT_LIMIT:
                        g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
                        /* Min, max, step. */
                        for (i = 0; i < 3; i++) {
@@ -514,9 +538,10 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
        std_session_send_df_header(sdi, LOG_PREFIX);
 
        /* Prime the pipe with the first channel's fetch. */
-       ch = sdi->channels->data;
+       ch = next_enabled_channel(sdi, NULL);
        pch = ch->priv;
-       devc->cur_channel = ch;
+       if ((ret = select_channel(sdi, ch)) != SR_OK)
+               return ret;
        if (pch->mq == SR_MQ_VOLTAGE)
                cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
        else if (pch->mq == SR_MQ_CURRENT)
@@ -532,6 +557,7 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
+       struct sr_datafeed_packet packet;
        struct sr_scpi_dev_inst *scpi;
        float f;
 
@@ -550,6 +576,9 @@ static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
        sr_scpi_get_float(scpi, NULL, &f);
        sr_scpi_source_remove(sdi->session, scpi);
 
+       packet.type = SR_DF_END;
+       sr_session_send(sdi, &packet);
+
        return SR_OK;
 }