]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/scpi-pps/api.c
Change type of SR_CONF keys to uint32_t.
[libsigrok.git] / src / hardware / scpi-pps / api.c
index 2a179ca62a365b3ca15064d858c2de289ad69781..aea3bd5e26833c95cee54ea3c7e850dc98cfcd61 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <string.h>
 #include "protocol.h"
 
 SR_PRIV struct sr_dev_driver scpi_pps_driver_info;
 static struct sr_dev_driver *di = &scpi_pps_driver_info;
+extern unsigned int num_pps_profiles;
+extern const struct scpi_pps pps_profiles[];
+
+static const uint32_t scanopts[] = {
+       SR_CONF_CONN,
+       SR_CONF_SERIALCOMM,
+};
+
+static struct pps_channel_instance pci[] = {
+       { SR_MQ_VOLTAGE, SCPI_CMD_GET_MEAS_VOLTAGE, "V" },
+       { SR_MQ_CURRENT, SCPI_CMD_GET_MEAS_CURRENT, "I" },
+       { SR_MQ_POWER, SCPI_CMD_GET_MEAS_POWER, "P" },
+};
 
 static int init(struct sr_context *sr_ctx)
 {
        return std_init(sr_ctx, di, LOG_PREFIX);
 }
 
-static GSList *scan(GSList *options)
+static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
 {
-       struct drv_context *drvc;
-       GSList *devices;
+       struct dev_context *devc;
+       struct sr_dev_inst *sdi;
+       struct sr_scpi_hw_info *hw_info;
+       struct sr_channel_group *cg;
+       struct sr_channel *ch;
+       const struct scpi_pps *device;
+       struct pps_channel *pch;
+       const struct channel_group_spec *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;
+       const char *vendor;
+       char ch_name[16];
+
+       if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
+               sr_info("Couldn't get IDN response.");
+               return NULL;
+       }
+
+       device = NULL;
+       for (i = 0; i < num_pps_profiles; i++) {
+               vendor = get_vendor(hw_info->manufacturer);
+               if (strcasecmp(vendor, pps_profiles[i].vendor))
+                       continue;
+               model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
+               if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
+                       device = &pps_profiles[i];
+               g_match_info_unref(model_mi);
+               g_regex_unref(model_re);
+               if (device)
+                       break;
+       }
+       if (!device) {
+               sr_scpi_hw_info_free(hw_info);
+               return NULL;
+       }
 
-       (void)options;
+       sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, vendor, hw_info->model,
+                       hw_info->firmware_version);
+       sdi->conn = scpi;
+       sdi->driver = di;
+       sdi->inst_type = SR_INST_SCPI;
+       devc = g_malloc0(sizeof(struct dev_context));
+       devc->device = device;
+       sdi->priv = devc;
+
+       ch_idx = 0;
+       for (ch_num = 0; ch_num < device->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);
+                       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->mq = pci[i].mq;
+                       ch->priv = pch;
+                       sdi->channels = g_slist_append(sdi->channels, ch);
+               }
+       }
 
-       devices = NULL;
-       drvc = di->priv;
-       drvc->instances = NULL;
+       for (i = 0; i < device->num_channel_groups; i++) {
+               cgs = &device->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) {
+                       if (cgs->channel_index_mask & mask) {
+                               for (l = sdi->channels; l; l = l->next) {
+                                       ch = l->data;
+                                       pch = ch->priv;
+                                       if (pch->hw_output_idx == j)
+                                               cg->channels = g_slist_append(cg->channels, ch);
+                               }
+                       }
+               }
+               pcg = g_malloc0(sizeof(struct pps_channel_group));
+               pcg->features = cgs->features;
+               cg->priv = pcg;
+               sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
+       }
 
-       /* TODO: scan for devices, either based on a SR_CONF_CONN option
-        * or on a USB scan. */
+       /* SCPI devices commonly lock the panel keys when accessed remotely. */
+       scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
+       sr_scpi_close(scpi);
 
-       return devices;
+       return sdi;
+}
+
+static GSList *scan(GSList *options)
+{
+       return sr_scpi_scan(di->priv, options, probe_device);
 }
 
 static GSList *dev_list(void)
@@ -56,9 +154,14 @@ static int dev_clear(void)
 
 static int dev_open(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct sr_scpi_dev_inst *scpi;
+
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR;
 
-       /* TODO: get handle from sdi->conn and open it. */
+       scpi = sdi->conn;
+       if (sr_scpi_open(scpi) < 0)
+               return SR_ERR;
 
        sdi->status = SR_ST_ACTIVE;
 
@@ -67,106 +170,385 @@ static int dev_open(struct sr_dev_inst *sdi)
 
 static int dev_close(struct sr_dev_inst *sdi)
 {
-       (void)sdi;
+       struct sr_scpi_dev_inst *scpi;
 
-       /* TODO: get handle from sdi->conn and close it. */
+       if (sdi->status != SR_ST_ACTIVE)
+               return SR_ERR_DEV_CLOSED;
 
-       sdi->status = SR_ST_INACTIVE;
+       scpi = sdi->conn;
+       if (scpi) {
+               scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
+               sr_scpi_close(scpi);
+               sdi->status = SR_ST_INACTIVE;
+       }
 
        return SR_OK;
 }
 
 static int cleanup(void)
 {
-       dev_clear();
-
-       /* TODO: free other driver resources, if any. */
-
        return SR_OK;
 }
 
-static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
+static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
-       int ret;
-
-       (void)sdi;
-       (void)data;
-       (void)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) {
+               /*
+                * These options only apply to channel groups with a single
+                * channel -- they're per-channel settings for the device.
+                */
+
+               /*
+                * Config keys are handled below depending on whether a channel
+                * group was provided by the frontend. However some of these
+                * take a CG on one PPS but not on others. Check the device's
+                * profile for that here, and NULL out the channel group as needed.
+                */
+               for (i = 0; i < devc->device->num_devopts; i++) {
+                       if (devc->device->devopts[i] == key) {
+                               cg = NULL;
+                               break;
+                       }
+               }
+
+               ch = cg->channels->data;
+               pch = ch->priv;
+       }
 
-       ret = SR_OK;
+       gvtype = NULL;
+       cmd = -1;
        switch (key) {
-       /* TODO */
-       default:
-               return SR_ERR_NA;
+       case SR_CONF_OUTPUT_ENABLED:
+               gvtype = G_VARIANT_TYPE_BOOLEAN;
+               cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
+               break;
+       case SR_CONF_OUTPUT_VOLTAGE:
+               gvtype = G_VARIANT_TYPE_DOUBLE;
+               cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
+               break;
+       case SR_CONF_OUTPUT_VOLTAGE_MAX:
+               gvtype = G_VARIANT_TYPE_DOUBLE;
+               cmd = SCPI_CMD_GET_VOLTAGE_MAX;
+               break;
+       case SR_CONF_OUTPUT_CURRENT:
+               gvtype = G_VARIANT_TYPE_DOUBLE;
+               cmd = SCPI_CMD_GET_MEAS_CURRENT;
+               break;
+       case SR_CONF_OUTPUT_CURRENT_MAX:
+               gvtype = G_VARIANT_TYPE_DOUBLE;
+               cmd = SCPI_CMD_GET_CURRENT_MAX;
+               break;
+       case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
+               gvtype = G_VARIANT_TYPE_BOOLEAN;
+               cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
+               break;
+       case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
+               gvtype = G_VARIANT_TYPE_BOOLEAN;
+               cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
+               break;
+       case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
+               gvtype = G_VARIANT_TYPE_DOUBLE;
+               cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
+               break;
+       case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
+               gvtype = G_VARIANT_TYPE_BOOLEAN;
+               cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
+               break;
+       case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
+               gvtype = G_VARIANT_TYPE_BOOLEAN;
+               cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
+               break;
+       case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
+               gvtype = G_VARIANT_TYPE_DOUBLE;
+               cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
+               break;
+       case SR_CONF_OVER_TEMPERATURE_PROTECTION:
+               gvtype = G_VARIANT_TYPE_BOOLEAN;
+               cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
+               break;
        }
+       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;
+               }
+       } else
+               ret = SR_ERR_NA;
 
        return ret;
 }
 
-static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
+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;
 
-       (void)data;
-       (void)cg;
+       if (!sdi)
+               return SR_ERR_ARG;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
        ret = SR_OK;
-       switch (key) {
-       /* TODO */
-       default:
-               ret = SR_ERR_NA;
+       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 {
+               /* 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;
+               }
        }
 
        return ret;
 }
 
-static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
+static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg)
 {
-       int ret;
+       struct dev_context *devc;
+       struct sr_channel *ch;
+       struct channel_spec *ch_spec;
+       GVariant *gvar;
+       GVariantBuilder gvb;
+       int ret, i;
+       const char *s[16];
+
+       /* Always available, even without sdi. */
+       if (key == SR_CONF_SCAN_OPTIONS) {
+               *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                               scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
+               return SR_OK;
+       }
 
-       (void)sdi;
-       (void)data;
-       (void)cg;
+       if (!sdi)
+               return SR_ERR_ARG;
+       devc = sdi->priv;
 
        ret = SR_OK;
-       switch (key) {
-       /* TODO */
-       default:
-               return SR_ERR_NA;
+       if (!cg) {
+               /* No channel group: global options. */
+               switch (key) {
+               case SR_CONF_DEVICE_OPTIONS:
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                       devc->device->devopts, devc->device->num_devopts,
+                                       sizeof(uint32_t));
+                       break;
+               case SR_CONF_OUTPUT_CHANNEL_CONFIG:
+                       /* Not used. */
+                       i = 0;
+                       if (devc->device->features & PPS_INDEPENDENT)
+                               s[i++] = "Independent";
+                       if (devc->device->features & PPS_SERIES)
+                               s[i++] = "Series";
+                       if (devc->device->features & PPS_PARALLEL)
+                               s[i++] = "Parallel";
+                       if (i == 0) {
+                               /*
+                                * Shouldn't happen: independent-only devices
+                                * shouldn't advertise this option at all.
+                                */
+                               return SR_ERR_NA;
+                       }
+                       *data = g_variant_new_strv(s, i);
+                       break;
+               default:
+                       return SR_ERR_NA;
+               }
+       } else {
+               /* Channel group specified. */
+               /*
+                * Per-channel-group options depending on a channel are actually
+                * done with the first channel. Channel groups in PPS can have
+                * more than one channel, but they will typically be of equal
+                * specification for use in series or parallel mode.
+                */
+               ch = cg->channels->data;
+
+               switch (key) {
+               case SR_CONF_DEVICE_OPTIONS:
+                       *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
+                                       devc->device->devopts_cg, devc->device->num_devopts_cg,
+                                       sizeof(uint32_t));
+                       break;
+               case SR_CONF_OUTPUT_VOLTAGE_MAX:
+                       ch_spec = &(devc->device->channels[ch->index]);
+                       g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+                       /* Min, max, write resolution. */
+                       for (i = 0; i < 3; i++) {
+                               gvar = g_variant_new_double(ch_spec->voltage[i]);
+                               g_variant_builder_add_value(&gvb, gvar);
+                       }
+                       *data = g_variant_builder_end(&gvb);
+                       break;
+               case SR_CONF_OUTPUT_CURRENT_MAX:
+                       g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
+                       /* Min, max, step. */
+                       for (i = 0; i < 3; i++) {
+                               ch_spec = &(devc->device->channels[ch->index]);
+                               gvar = g_variant_new_double(ch_spec->current[i]);
+                               g_variant_builder_add_value(&gvb, gvar);
+                       }
+                       *data = g_variant_builder_end(&gvb);
+                       break;
+               default:
+                       return SR_ERR_NA;
+               }
        }
 
        return ret;
 }
 
 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
-                                   void *cb_data)
+               void *cb_data)
 {
-       (void)sdi;
-       (void)cb_data;
+       struct dev_context *devc;
+       struct sr_scpi_dev_inst *scpi;
+       struct sr_channel *ch;
+       struct pps_channel *pch;
+       int cmd, ret;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       /* TODO: configure hardware, reset acquisition state, set up
-        * callbacks and send header packet. */
+       devc = sdi->priv;
+       scpi = sdi->conn;
+       devc->cb_data = cb_data;
+
+       if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
+                       scpi_pps_receive_data, (void *)sdi)) != SR_OK)
+               return ret;
+       std_session_send_df_header(sdi, LOG_PREFIX);
+
+       /* Prime the pipe with the first channel's fetch. */
+       ch = sdi->channels->data;
+       pch = ch->priv;
+       devc->cur_channel = ch;
+       if (pch->mq == SR_MQ_VOLTAGE)
+               cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
+       else if (pch->mq == SR_MQ_CURRENT)
+               cmd = SCPI_CMD_GET_MEAS_CURRENT;
+       else if (pch->mq == SR_MQ_POWER)
+               cmd = SCPI_CMD_GET_MEAS_POWER;
+       else
+               return SR_ERR;
+       scpi_cmd(sdi, cmd, pch->hwname);
 
        return SR_OK;
 }
 
 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
+       struct sr_scpi_dev_inst *scpi;
+       float f;
+
        (void)cb_data;
 
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
-       /* TODO: stop acquisition. */
+       scpi = sdi->conn;
+
+       /*
+        * A requested value is certainly on the way. Retrieve it now,
+        * to avoid leaving the device in a state where it's not expecting
+        * commands.
+        */
+       sr_scpi_get_float(scpi, NULL, &f);
+       sr_scpi_source_remove(sdi->session, scpi);
 
        return SR_OK;
 }