src/hardware/rohde-schwarz-sme-0x/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2016 Vlad Ivanov <vlad.ivanov@lab-systems.ru>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include <libserialport.h>
  22 #include <scpi.h>
  23 #include <string.h>
  24
  25 #include "protocol.h"
  26
  27 SR_PRIV struct sr_dev_driver rohde_schwarz_sme_0x_driver_info;
  28
  29 static const char *manufacturer = "Rohde&Schwarz";
  30
  31 static const struct rs_device_model device_models[] = {
  32         {
  33                 .model_str = "SME02",
  34                 .freq_max = SR_GHZ(1.5),
  35                 .freq_min = SR_KHZ(5),
  36                 .power_max = 16,
  37                 .power_min = -144,
  38         },
  39         {
  40                 .model_str = "SME03E",
  41                 .freq_max = SR_GHZ(2.2),
  42                 .freq_min = SR_KHZ(5),
  43                 .power_max = 16,
  44                 .power_min = -144,
  45         },
  46         {
  47                 .model_str = "SME03A",
  48                 .freq_max = SR_GHZ(3),
  49                 .freq_min = SR_KHZ(5),
  50                 .power_max = 16,
  51                 .power_min = -144,
  52         },
  53         {
  54                 .model_str = "SME03",
  55                 .freq_max = SR_GHZ(3),
  56                 .freq_min = SR_KHZ(5),
  57                 .power_max = 16,
  58                 .power_min = -144,
  59         },
  60         {
  61                 .model_str = "SME06",
  62                 .freq_max = SR_GHZ(1.5),
  63                 .freq_min = SR_KHZ(5),
  64                 .power_max = 16,
  65                 .power_min = -144,
  66         }
  67 };
  68
  69 static const uint32_t scanopts[] = {
  70         SR_CONF_CONN,
  71         SR_CONF_SERIALCOMM,
  72 };
  73
  74 static const uint32_t drvopts[] = {
  75         SR_CONF_SIGNAL_GENERATOR,
  76 };
  77
  78 static const uint32_t devopts[] = {
  79         SR_CONF_OUTPUT_FREQUENCY | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  80         SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  81 };
  82
  83 static int rs_init_device(struct sr_dev_inst *sdi)
  84 {
  85         struct dev_context *devc;
  86         uint8_t model_found;
  87
  88         devc = sdi->priv;
  89         model_found = 0;
  90
  91         for (size_t i = 0; i < ARRAY_SIZE(device_models); i++) {
  92                 if (!strcmp(device_models[i].model_str, sdi->model)) {
  93                         model_found = 1;
  94                         devc->model_config = &device_models[i];
  95                         break;
  96                 }
  97         }
  98
  99         if (!model_found) {
 100                 sr_dbg("Device %s %s is not supported by this driver.",
 101                         manufacturer, sdi->model);
 102                 return SR_ERR_NA;
 103         }
 104
 105         return SR_OK;
 106 }
 107
 108 static struct sr_dev_inst *rs_probe_serial_device(struct sr_scpi_dev_inst *scpi)
 109 {
 110         struct sr_dev_inst *sdi;
 111         struct dev_context *devc;
 112         struct sr_scpi_hw_info *hw_info;
 113
 114         sdi = NULL;
 115         devc = NULL;
 116         hw_info = NULL;
 117
 118         rs_sme0x_mode_remote(scpi);
 119
 120         if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK)
 121                 goto fail;
 122
 123         if (strcmp(hw_info->manufacturer, manufacturer) != 0)
 124                 goto fail;
 125
 126         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 127         sdi->vendor = g_strdup(hw_info->manufacturer);
 128         sdi->model = g_strdup(hw_info->model);
 129         sdi->version = g_strdup(hw_info->firmware_version);
 130         sdi->serial_num = g_strdup(hw_info->serial_number);
 131         sdi->driver = &rohde_schwarz_sme_0x_driver_info;
 132         sdi->inst_type = SR_INST_SCPI;
 133         sdi->conn = scpi;
 134
 135         sr_scpi_hw_info_free(hw_info);
 136         hw_info = NULL;
 137
 138         devc = g_malloc0(sizeof(struct dev_context));
 139         sdi->priv = devc;
 140
 141         if (rs_init_device(sdi) != SR_OK)
 142                 goto fail;
 143
 144         return sdi;
 145
 146 fail:
 147         if (hw_info)
 148                 sr_scpi_hw_info_free(hw_info);
 149         sr_dev_inst_free(sdi);
 150         g_free(devc);
 151         return NULL;
 152 }
 153
 154 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 155 {
 156         return sr_scpi_scan(di->context, options, rs_probe_serial_device);
 157 }
 158
 159 static int dev_clear(const struct sr_dev_driver *di)
 160 {
 161         return std_dev_clear(di, NULL);
 162 }
 163
 164 static int dev_open(struct sr_dev_inst *sdi)
 165 {
 166         if ((sdi->status != SR_ST_ACTIVE) && (sr_scpi_open(sdi->conn) != SR_OK))
 167                 return SR_ERR;
 168
 169         sdi->status = SR_ST_ACTIVE;
 170
 171         return SR_OK;
 172 }
 173
 174 static int dev_close(struct sr_dev_inst *sdi)
 175 {
 176         if (sdi->status == SR_ST_INACTIVE)
 177                 return SR_OK;
 178
 179         sr_scpi_close(sdi->conn);
 180
 181         sdi->status = SR_ST_INACTIVE;
 182
 183         return SR_OK;
 184 }
 185
 186 static int config_get(uint32_t key, GVariant **data,
 187         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 188 {
 189         double value_f;
 190
 191         (void) cg;
 192
 193         switch (key) {
 194         case SR_CONF_OUTPUT_FREQUENCY:
 195                 rs_sme0x_get_freq(sdi, &value_f);
 196                 *data = g_variant_new_double(value_f);
 197                 break;
 198         case SR_CONF_AMPLITUDE:
 199                 rs_sme0x_get_power(sdi, &value_f);
 200                 *data = g_variant_new_double(value_f);
 201                 break;
 202         default:
 203                 return SR_ERR_NA;
 204         }
 205
 206         return SR_OK;
 207 }
 208
 209 static int config_set(uint32_t key, GVariant *data,
 210         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 211 {
 212         double value_f;
 213
 214         (void)cg;
 215
 216         if (!sdi)
 217                 return SR_ERR_ARG;
 218
 219         if (sdi->status != SR_ST_ACTIVE)
 220                 return SR_ERR_DEV_CLOSED;
 221
 222         switch (key) {
 223         case SR_CONF_OUTPUT_FREQUENCY:
 224                 value_f = g_variant_get_double(data);
 225                 rs_sme0x_set_freq(sdi, value_f);
 226                 break;
 227         case SR_CONF_AMPLITUDE:
 228                 value_f = g_variant_get_double(data);
 229                 rs_sme0x_set_power(sdi, value_f);
 230                 break;
 231         default:
 232                 return SR_ERR_NA;
 233         }
 234
 235         return SR_OK;
 236 }
 237
 238 static int config_list(uint32_t key, GVariant **data,
 239         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 240 {
 241         (void)sdi;
 242         (void)cg;
 243
 244         /* Return drvopts without sdi (and devopts with sdi, see below). */
 245         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 246                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 247                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 248                 return SR_OK;
 249         }
 250
 251         switch (key) {
 252         case SR_CONF_SCAN_OPTIONS:
 253                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 254                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 255                 break;
 256         case SR_CONF_DEVICE_OPTIONS:
 257                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 258                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 259                 break;
 260         default:
 261                 return SR_ERR_NA;
 262         }
 263
 264         return SR_OK;
 265 }
 266
 267 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 268 {
 269         if (sdi->status != SR_ST_ACTIVE)
 270                 return SR_ERR_DEV_CLOSED;
 271
 272         return SR_OK;
 273 }
 274
 275 SR_PRIV struct sr_dev_driver rohde_schwarz_sme_0x_driver_info = {
 276         .name = "rohde-schwarz-sme-0x",
 277         .longname = "Rohde&Schwarz SME-0x",
 278         .api_version = 1,
 279         .init = std_init,
 280         .cleanup = std_cleanup,
 281         .scan = scan,
 282         .dev_list = std_dev_list,
 283         .dev_clear = dev_clear,
 284         .config_get = config_get,
 285         .config_set = config_set,
 286         .config_list = config_list,
 287         .dev_open = dev_open,
 288         .dev_close = dev_close,
 289         .dev_acquisition_start = dev_acquisition_start,
 290         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 291         .context = NULL,
 292 };
 293
 294 SR_REGISTER_DEV_DRIVER(rohde_schwarz_sme_0x_driver_info);