]> sigrok.org Git - libsigrok.git/blobdiff - src/hardware/scpi-pps/api.c
Put driver pointers into special section
[libsigrok.git] / src / hardware / scpi-pps / api.c
index d4aa4923ff71f06941e049fab2e110d2a98e6313..c3e5d5d4ad6a90607fcea56a9304ed94889cedba 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include <string.h>
 #include <strings.h>
+#include "scpi.h"
 #include "protocol.h"
 
-SR_PRIV struct sr_dev_driver scpi_pps_driver_info;
+static struct sr_dev_driver scpi_pps_driver_info;
 
 static const uint32_t scanopts[] = {
        SR_CONF_CONN,
@@ -39,11 +41,6 @@ static const struct pps_channel_instance pci[] = {
        { SR_MQ_FREQUENCY, SCPI_CMD_GET_MEAS_FREQUENCY, "F" },
 };
 
-static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
-{
-       return std_init(sr_ctx, di, LOG_PREFIX);
-}
-
 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
 {
        struct dev_context *devc;
@@ -72,8 +69,8 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
 
        device = NULL;
        for (i = 0; i < num_pps_profiles; i++) {
-               vendor = get_vendor(hw_info->manufacturer);
-               if (strcasecmp(vendor, pps_profiles[i].vendor))
+               vendor = sr_vendor_alias(hw_info->manufacturer);
+               if (g_ascii_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))
@@ -89,7 +86,6 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
        }
 
        sdi = g_malloc0(sizeof(struct sr_dev_inst));
-       sdi->status = SR_ST_INACTIVE;
        sdi->vendor = g_strdup(vendor);
        sdi->model = g_strdup(hw_info->model);
        sdi->version = g_strdup(hw_info->firmware_version);
@@ -128,7 +124,7 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
        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))
+                       if (!scpi_cmd_get(devc->device->commands, pci[i].command))
                                continue;
                        g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
                                        channels[ch_num].name);
@@ -165,25 +161,14 @@ static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
        sr_scpi_hw_info_free(hw_info);
        hw_info = NULL;
 
-       scpi_cmd(sdi, SCPI_CMD_LOCAL);
-       sr_scpi_close(scpi);
+       scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
 
        return sdi;
 }
 
 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 {
-       return sr_scpi_scan(di->priv, options, probe_device);
-}
-
-static GSList *dev_list(const struct sr_dev_driver *di)
-{
-       return ((struct drv_context *)(di->priv))->instances;
-}
-
-static int dev_clear(const struct sr_dev_driver *di)
-{
-       return std_dev_clear(di, NULL);
+       return sr_scpi_scan(di->context, options, probe_device);
 }
 
 static int dev_open(struct sr_dev_inst *sdi)
@@ -201,13 +186,14 @@ static int dev_open(struct sr_dev_inst *sdi)
 
        sdi->status = SR_ST_ACTIVE;
 
-       scpi_cmd(sdi, SCPI_CMD_REMOTE);
        devc = sdi->priv;
+       scpi_cmd(sdi, devc->device->commands, SCPI_CMD_REMOTE);
        devc->beeper_was_set = FALSE;
-       if (scpi_cmd_resp(sdi, &beeper, G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
+       if (scpi_cmd_resp(sdi, devc->device->commands, &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);
+                       scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_DISABLE);
                }
                g_variant_unref(beeper);
        }
@@ -227,8 +213,8 @@ static int dev_close(struct sr_dev_inst *sdi)
        scpi = sdi->conn;
        if (scpi) {
                if (devc->beeper_was_set)
-                       scpi_cmd(sdi, SCPI_CMD_BEEPER_ENABLE);
-               scpi_cmd(sdi, SCPI_CMD_LOCAL);
+                       scpi_cmd(sdi, devc->device->commands, SCPI_CMD_BEEPER_ENABLE);
+               scpi_cmd(sdi, devc->device->commands, SCPI_CMD_LOCAL);
                sr_scpi_close(scpi);
                sdi->status = SR_ST_INACTIVE;
        }
@@ -246,7 +232,7 @@ static void clear_helper(void *priv)
        g_free(devc);
 }
 
-static int cleanup(const struct sr_dev_driver *di)
+static int dev_clear(const struct sr_dev_driver *di)
 {
        return std_dev_clear(di, clear_helper);
 }
@@ -258,6 +244,7 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        const GVariantType *gvtype;
        unsigned int i;
        int cmd, ret;
+       const char *s;
 
        if (!sdi)
                return SR_ERR_ARG;
@@ -287,15 +274,15 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
        gvtype = NULL;
        cmd = -1;
        switch (key) {
-       case SR_CONF_OUTPUT_ENABLED:
+       case SR_CONF_ENABLED:
                gvtype = G_VARIANT_TYPE_BOOLEAN;
                cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
                break;
-       case SR_CONF_OUTPUT_VOLTAGE:
+       case SR_CONF_VOLTAGE:
                gvtype = G_VARIANT_TYPE_DOUBLE;
                cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
                break;
-       case SR_CONF_OUTPUT_VOLTAGE_TARGET:
+       case SR_CONF_VOLTAGE_TARGET:
                gvtype = G_VARIANT_TYPE_DOUBLE;
                cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
                break;
@@ -307,11 +294,11 @@ static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *s
                gvtype = G_VARIANT_TYPE_DOUBLE;
                cmd = SCPI_CMD_GET_FREQUENCY_TARGET;
                break;
-       case SR_CONF_OUTPUT_CURRENT:
+       case SR_CONF_CURRENT:
                gvtype = G_VARIANT_TYPE_DOUBLE;
                cmd = SCPI_CMD_GET_MEAS_CURRENT;
                break;
-       case SR_CONF_OUTPUT_CURRENT_LIMIT:
+       case SR_CONF_CURRENT_LIMIT:
                gvtype = G_VARIANT_TYPE_DOUBLE;
                cmd = SCPI_CMD_GET_CURRENT_LIMIT;
                break;
@@ -343,16 +330,38 @@ 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:
+       case SR_CONF_REGULATION:
                gvtype = G_VARIANT_TYPE_STRING;
                cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
        }
-       if (gvtype) {
-               if (cg)
-                       select_channel(sdi, cg->channels->data);
-               ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
-       } else
-               ret = SR_ERR_NA;
+       if (!gvtype)
+               return SR_ERR_NA;
+
+       if (cg)
+               select_channel(sdi, cg->channels->data);
+       ret = scpi_cmd_resp(sdi, devc->device->commands, data, gvtype, cmd);
+
+       if (cmd == SCPI_CMD_GET_OUTPUT_REGULATION) {
+               /*
+                * The Rigol DP800 series return CV/CC/UR, Philips PM2800
+                * return VOLT/CURR. We always return a GVariant string in
+                * the Rigol notation.
+                */
+               s = g_variant_get_string(*data, NULL);
+               if (!strcmp(s, "VOLT")) {
+                       g_variant_unref(*data);
+                       *data = g_variant_new_string("CV");
+               } else if (!strcmp(s, "CURR")) {
+                       g_variant_unref(*data);
+                       *data = g_variant_new_string("CC");
+               }
+
+               s = g_variant_get_string(*data, NULL);
+               if (strcmp(s, "CV") && strcmp(s, "CC") && strcmp(s, "UR")) {
+                       sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
+                       ret = SR_ERR_DATA;
+               }
+       }
 
        return ret;
 }
@@ -360,6 +369,7 @@ 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 dev_context *devc;
        double d;
        int ret;
 
@@ -373,51 +383,65 @@ static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sd
                /* Channel group specified. */
                select_channel(sdi, cg->channels->data);
 
-       ret = SR_OK;
+       devc = sdi->priv;
+
        switch (key) {
-       case SR_CONF_OUTPUT_ENABLED:
+       case SR_CONF_ENABLED:
                if (g_variant_get_boolean(data))
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLE);
+                       ret = scpi_cmd(sdi, devc->device->commands,
+                                       SCPI_CMD_SET_OUTPUT_ENABLE);
                else
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_DISABLE);
+                       ret = scpi_cmd(sdi, devc->device->commands,
+                                       SCPI_CMD_SET_OUTPUT_DISABLE);
                break;
-       case SR_CONF_OUTPUT_VOLTAGE_TARGET:
+       case SR_CONF_VOLTAGE_TARGET:
                d = g_variant_get_double(data);
-               ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_TARGET, d);
+               ret = scpi_cmd(sdi, devc->device->commands,
+                               SCPI_CMD_SET_VOLTAGE_TARGET, d);
                break;
        case SR_CONF_OUTPUT_FREQUENCY_TARGET:
                d = g_variant_get_double(data);
-               ret = scpi_cmd(sdi, SCPI_CMD_SET_FREQUENCY_TARGET, d);
+               ret = scpi_cmd(sdi, devc->device->commands,
+                               SCPI_CMD_SET_FREQUENCY_TARGET, d);
                break;
-       case SR_CONF_OUTPUT_CURRENT_LIMIT:
+       case SR_CONF_CURRENT_LIMIT:
                d = g_variant_get_double(data);
-               ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_LIMIT, d);
+               ret = scpi_cmd(sdi, devc->device->commands,
+                               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);
+                       ret = scpi_cmd(sdi, devc->device->commands,
+                                       SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
                else
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
+                       ret = scpi_cmd(sdi, devc->device->commands,
+                                       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);
+               ret = scpi_cmd(sdi, devc->device->commands,
+                               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);
+                       ret = scpi_cmd(sdi, devc->device->commands,
+                                       SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
                else
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
+                       ret = scpi_cmd(sdi, devc->device->commands,
+                                       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);
+               ret = scpi_cmd(sdi, devc->device->commands,
+                               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);
+                       ret = scpi_cmd(sdi, devc->device->commands,
+                                       SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
                else
-                       ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
+                       ret = scpi_cmd(sdi, devc->device->commands,
+                                       SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
                break;
        default:
                ret = SR_ERR_NA;
@@ -461,7 +485,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
                                        devc->device->devopts, devc->device->num_devopts,
                                        sizeof(uint32_t));
                        break;
-               case SR_CONF_OUTPUT_CHANNEL_CONFIG:
+               case SR_CONF_CHANNEL_CONFIG:
                        /* Not used. */
                        i = 0;
                        if (devc->device->features & PPS_INDEPENDENT)
@@ -498,7 +522,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_TARGET:
+               case SR_CONF_VOLTAGE_TARGET:
                        ch_spec = &(devc->device->channels[ch->index]);
                        g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
                        /* Min, max, write resolution. */
@@ -518,7 +542,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_LIMIT:
+               case SR_CONF_CURRENT_LIMIT:
                        g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
                        /* Min, max, step. */
                        for (i = 0; i < 3; i++) {
@@ -536,8 +560,7 @@ static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *
        return ret;
 }
 
-static int dev_acquisition_start(const struct sr_dev_inst *sdi,
-               void *cb_data)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 {
        struct dev_context *devc;
        struct sr_scpi_dev_inst *scpi;
@@ -550,7 +573,6 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
 
        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)
@@ -558,9 +580,9 @@ 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 = next_enabled_channel(sdi, NULL);
+       ch = sr_next_enabled_channel(sdi, NULL);
        pch = ch->priv;
-       if ((ret = select_channel(sdi, ch)) != SR_OK)
+       if ((ret = select_channel(sdi, ch)) < 0)
                return ret;
        if (pch->mq == SR_MQ_VOLTAGE)
                cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
@@ -572,19 +594,16 @@ static int dev_acquisition_start(const struct sr_dev_inst *sdi,
                cmd = SCPI_CMD_GET_MEAS_POWER;
        else
                return SR_ERR;
-       scpi_cmd(sdi, cmd, pch->hwname);
+       scpi_cmd(sdi, devc->device->commands, cmd, pch->hwname);
 
        return SR_OK;
 }
 
-static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 {
-       struct sr_datafeed_packet packet;
        struct sr_scpi_dev_inst *scpi;
        float f;
 
-       (void)cb_data;
-
        if (sdi->status != SR_ST_ACTIVE)
                return SR_ERR_DEV_CLOSED;
 
@@ -598,20 +617,19 @@ 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);
+       std_session_send_df_end(sdi, LOG_PREFIX);
 
        return SR_OK;
 }
 
-SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
+static struct sr_dev_driver scpi_pps_driver_info = {
        .name = "scpi-pps",
        .longname = "SCPI PPS",
        .api_version = 1,
-       .init = init,
-       .cleanup = cleanup,
+       .init = std_init,
+       .cleanup = std_cleanup,
        .scan = scan,
-       .dev_list = dev_list,
+       .dev_list = std_dev_list,
        .dev_clear = dev_clear,
        .config_get = config_get,
        .config_set = config_set,
@@ -620,5 +638,6 @@ SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
        .dev_close = dev_close,
        .dev_acquisition_start = dev_acquisition_start,
        .dev_acquisition_stop = dev_acquisition_stop,
-       .priv = NULL,
+       .context = NULL,
 };
+SR_REGISTER_DEV_DRIVER(scpi_pps_driver_info);