src/hardware/korad-kdxxxxp/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
   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 "protocol.h"
  22
  23 static const uint32_t drvopts[] = {
  24         /* Device class */
  25         SR_CONF_POWER_SUPPLY,
  26 };
  27
  28 static const uint32_t scanopts[] = {
  29         SR_CONF_CONN,
  30         SR_CONF_SERIALCOMM,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         /* Device class */
  35         SR_CONF_POWER_SUPPLY,
  36         /* Acquisition modes. */
  37         SR_CONF_CONTINUOUS,
  38         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  39         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  40         /* Device configuration */
  41         SR_CONF_VOLTAGE | SR_CONF_GET,
  42         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  43         SR_CONF_CURRENT | SR_CONF_GET,
  44         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  45         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  46         SR_CONF_REGULATION | SR_CONF_GET,
  47         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  48         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  49 };
  50
  51 static const struct korad_kdxxxxp_model models[] = {
  52         /* Device enum, vendor, model, ID reply, channels, voltage, current */
  53         {VELLEMAN_LABPS_3005D, "Velleman", "LABPS3005D",
  54                 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
  55         {0, NULL, NULL, NULL, 0, {0, 0, 0}, {0, 0, 0}}
  56 };
  57
  58 SR_PRIV struct sr_dev_driver korad_kdxxxxp_driver_info;
  59
  60 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  61 {
  62         return std_init(sr_ctx, di, LOG_PREFIX);
  63 }
  64
  65 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  66 {
  67         struct drv_context *drvc;
  68         struct dev_context *devc;
  69         GSList *devices, *l;
  70         struct sr_dev_inst *sdi;
  71         struct sr_config *src;
  72         const char *conn, *serialcomm;
  73         struct sr_serial_dev_inst *serial;
  74         char reply[50];
  75         int i, model_id;
  76         unsigned int len;
  77
  78         devices = NULL;
  79         conn = NULL;
  80         serialcomm = NULL;
  81         drvc = di->context;
  82         drvc->instances = NULL;
  83
  84         for (l = options; l; l = l->next) {
  85                 src = l->data;
  86                 switch (src->key) {
  87                 case SR_CONF_CONN:
  88                         conn = g_variant_get_string(src->data, NULL);
  89                         break;
  90                 case SR_CONF_SERIALCOMM:
  91                         serialcomm = g_variant_get_string(src->data, NULL);
  92                         break;
  93                 default:
  94                         sr_err("Unknown option %d, skipping.", src->key);
  95                         break;
  96                 }
  97         }
  98
  99         if (!conn)
 100                 return NULL;
 101         if (!serialcomm)
 102                 serialcomm = "9600/8n1";
 103
 104         serial = sr_serial_dev_inst_new(conn, serialcomm);
 105         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 106                 return NULL;
 107
 108         serial_flush(serial);
 109
 110         /* Get the device model. */
 111         len = 0;
 112         for (i = 0; models[i].id; i++) {
 113                 if (strlen(models[i].id) > len)
 114                         len = strlen(models[i].id);
 115         }
 116         memset(&reply, 0, sizeof(reply));
 117         sr_dbg("Want max %d bytes.", len);
 118         if ((korad_kdxxxxp_send_cmd(serial, "*IDN?") < 0))
 119                 return NULL;
 120
 121         /* i is used here for debug purposes only. */
 122         if ((i = korad_kdxxxxp_read_chars(serial, len, reply)) < 0)
 123                 return NULL;
 124         sr_dbg("Received: %d, %s", i, reply);
 125         model_id = -1;
 126         for (i = 0; models[i].id; i++) {
 127                 if (!strcmp(models[i].id, reply))
 128                         model_id = i;
 129         }
 130         if (model_id < 0) {
 131                 sr_err("Unknown model ID '%s' detected, aborting.", reply);
 132                 return NULL;
 133         }
 134         sr_dbg("Found: %s %s", models[model_id].vendor, models[model_id].name);
 135
 136         /* Init device instance, etc. */
 137         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 138         sdi->status = SR_ST_INACTIVE;
 139         sdi->vendor = g_strdup(models[model_id].vendor);
 140         sdi->model = g_strdup(models[model_id].name);
 141         sdi->inst_type = SR_INST_SERIAL;
 142         sdi->conn = serial;
 143         sdi->driver = di;
 144
 145         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
 146
 147         devc = g_malloc0(sizeof(struct dev_context));
 148         devc->model = &models[model_id];
 149         devc->reply[5] = 0;
 150         devc->req_sent_at = 0;
 151         sdi->priv = devc;
 152
 153         /* Get current status of device. */
 154         if (korad_kdxxxxp_get_all_values(serial, devc) < 0)
 155                 goto exit_err;
 156         drvc->instances = g_slist_append(drvc->instances, sdi);
 157         devices = g_slist_append(devices, sdi);
 158
 159         serial_close(serial);
 160         if (!devices)
 161                 sr_serial_dev_inst_free(serial);
 162
 163         return devices;
 164
 165 exit_err:
 166         sr_dev_inst_free(sdi);
 167         g_free(devc);
 168         sr_dbg("Scan failed.");
 169
 170         return NULL;
 171 }
 172
 173 static GSList *dev_list(const struct sr_dev_driver *di)
 174 {
 175         return ((struct drv_context *)(di->context))->instances;
 176 }
 177
 178 static int dev_clear(const struct sr_dev_driver *di)
 179 {
 180         return std_dev_clear(di, NULL);
 181 }
 182
 183 static int cleanup(const struct sr_dev_driver *di)
 184 {
 185         dev_clear(di);
 186         return SR_OK;
 187 }
 188
 189 static int config_get(uint32_t key, GVariant **data,
 190         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 191 {
 192         struct dev_context *devc;
 193
 194         (void)cg;
 195
 196         if (!sdi || !data)
 197                 return SR_ERR_ARG;
 198
 199         devc = sdi->priv;
 200
 201         switch (key) {
 202         case SR_CONF_LIMIT_SAMPLES:
 203                 *data = g_variant_new_uint64(devc->limit_samples);
 204                 break;
 205         case SR_CONF_LIMIT_MSEC:
 206                 *data = g_variant_new_uint64(devc->limit_msec);
 207                 break;
 208         case SR_CONF_VOLTAGE:
 209                 *data = g_variant_new_double(devc->voltage);
 210                 break;
 211         case SR_CONF_VOLTAGE_TARGET:
 212                 *data = g_variant_new_double(devc->voltage_max);
 213                 break;
 214         case SR_CONF_CURRENT:
 215                 *data = g_variant_new_double(devc->current);
 216                 break;
 217         case SR_CONF_CURRENT_LIMIT:
 218                 *data = g_variant_new_double(devc->current_max);
 219                 break;
 220         case SR_CONF_ENABLED:
 221                 *data = g_variant_new_boolean(devc->output_enabled);
 222                 break;
 223         case SR_CONF_REGULATION:
 224                 /* Dual channel not supported. */
 225                 if (devc->cc_mode[0])
 226                         *data = g_variant_new_string("CC");
 227                 else
 228                         *data = g_variant_new_string("CV");
 229                 break;
 230         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 231                 *data = g_variant_new_boolean(devc->OCP_enabled);
 232                 break;
 233         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 234                 *data = g_variant_new_boolean(devc->OVP_enabled);
 235                 break;
 236         default:
 237                 return SR_ERR_NA;
 238         }
 239
 240         return SR_OK;
 241 }
 242
 243 static int config_set(uint32_t key, GVariant *data,
 244         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 245 {
 246         struct dev_context *devc;
 247         double dval;
 248         gboolean bval;
 249
 250         (void)cg;
 251
 252         if (sdi->status != SR_ST_ACTIVE)
 253                 return SR_ERR_DEV_CLOSED;
 254
 255         devc = sdi->priv;
 256
 257         switch (key) {
 258         case SR_CONF_LIMIT_MSEC:
 259                 if (g_variant_get_uint64(data) == 0)
 260                         return SR_ERR_ARG;
 261                 devc->limit_msec = g_variant_get_uint64(data);
 262                 break;
 263         case SR_CONF_LIMIT_SAMPLES:
 264                 if (g_variant_get_uint64(data) == 0)
 265                         return SR_ERR_ARG;
 266                 devc->limit_samples = g_variant_get_uint64(data);
 267                 break;
 268         case SR_CONF_VOLTAGE_TARGET:
 269                 dval = g_variant_get_double(data);
 270                 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
 271                         return SR_ERR_ARG;
 272                 devc->voltage_max = dval;
 273                 devc->target = KDXXXXP_VOLTAGE_MAX;
 274                 if (korad_kdxxxxp_set_value(sdi->conn, devc) < 0)
 275                         return SR_ERR;
 276                 break;
 277         case SR_CONF_CURRENT_LIMIT:
 278                 dval = g_variant_get_double(data);
 279                 if (dval < devc->model->current[0] || dval > devc->model->current[1])
 280                         return SR_ERR_ARG;
 281                 devc->current_max = dval;
 282                 devc->target = KDXXXXP_CURRENT_MAX;
 283                 if (korad_kdxxxxp_set_value(sdi->conn, devc) < 0)
 284                         return SR_ERR;
 285                 break;
 286         case SR_CONF_ENABLED:
 287                 bval = g_variant_get_boolean(data);
 288                 /* Set always so it is possible turn off with sigrok-cli. */
 289                 devc->output_enabled = bval;
 290                 devc->target = KDXXXXP_OUTPUT;
 291                 if (korad_kdxxxxp_set_value(sdi->conn, devc) < 0)
 292                         return SR_ERR;
 293                 break;
 294         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 295                 bval = g_variant_get_boolean(data);
 296                 devc->OCP_enabled = bval;
 297                 devc->target = KDXXXXP_OCP;
 298                 if (korad_kdxxxxp_set_value(sdi->conn, devc) < 0)
 299                         return SR_ERR;
 300                 break;
 301         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 302                 bval = g_variant_get_boolean(data);
 303                 devc->OVP_enabled = bval;
 304                 devc->target = KDXXXXP_OVP;
 305                 if (korad_kdxxxxp_set_value(sdi->conn, devc) < 0)
 306                         return SR_ERR;
 307                 break;
 308         default:
 309                 return SR_ERR_NA;
 310         }
 311
 312         return SR_OK;
 313 }
 314
 315 static int config_list(uint32_t key, GVariant **data,
 316         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 317 {
 318
 319         struct dev_context *devc;
 320         GVariant *gvar;
 321         GVariantBuilder gvb;
 322         double dval;
 323         int idx;
 324
 325         (void)cg;
 326
 327         /* Always available (with or without sdi). */
 328         if (key == SR_CONF_SCAN_OPTIONS) {
 329                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 330                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 331                 return SR_OK;
 332         }
 333
 334         /* Return drvopts without sdi (and devopts with sdi, see below). */
 335         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 336                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 337                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 338                 return SR_OK;
 339         }
 340
 341         /* Every other key needs an sdi. */
 342         if (!sdi)
 343                 return SR_ERR_ARG;
 344
 345         devc = sdi->priv;
 346
 347         switch (key) {
 348         case SR_CONF_DEVICE_OPTIONS:
 349                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 350                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 351                 break;
 352         case SR_CONF_VOLTAGE_TARGET:
 353                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 354                 /* Min, max, step. */
 355                 for (idx = 0; idx < 3; idx++) {
 356                         dval = devc->model->voltage[idx];
 357                         gvar = g_variant_new_double(dval);
 358                         g_variant_builder_add_value(&gvb, gvar);
 359                 }
 360                 *data = g_variant_builder_end(&gvb);
 361                 break;
 362         case SR_CONF_CURRENT_LIMIT:
 363                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 364                 /* Min, max, step. */
 365                 for (idx = 0; idx < 3; idx++) {
 366                         dval = devc->model->current[idx];
 367                         gvar = g_variant_new_double(dval);
 368                         g_variant_builder_add_value(&gvb, gvar);
 369                 }
 370                 *data = g_variant_builder_end(&gvb);
 371                 break;
 372         default:
 373                 return SR_ERR_NA;
 374         }
 375
 376         return SR_OK;
 377 }
 378
 379 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 380 {
 381         struct dev_context *devc;
 382         struct sr_serial_dev_inst *serial;
 383
 384         if (sdi->status != SR_ST_ACTIVE)
 385                 return SR_ERR_DEV_CLOSED;
 386
 387         devc = sdi->priv;
 388         devc->cb_data = cb_data;
 389
 390         /* Send header packet to the session bus. */
 391         std_session_send_df_header(cb_data, LOG_PREFIX);
 392
 393         devc->starttime = g_get_monotonic_time();
 394         devc->num_samples = 0;
 395         devc->reply_pending = FALSE;
 396         devc->req_sent_at = 0;
 397         serial = sdi->conn;
 398         serial_source_add(sdi->session, serial, G_IO_IN,
 399                         KDXXXXP_POLL_INTERVAL_MS,
 400                         korad_kdxxxxp_receive_data, (void *)sdi);
 401
 402         return SR_OK;
 403 }
 404
 405 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 406 {
 407         if (sdi->status != SR_ST_ACTIVE)
 408                 return SR_ERR_DEV_CLOSED;
 409
 410         return std_serial_dev_acquisition_stop(sdi, cb_data,
 411                 std_serial_dev_close, sdi->conn, LOG_PREFIX);
 412 }
 413
 414 SR_PRIV struct sr_dev_driver korad_kdxxxxp_driver_info = {
 415         .name = "korad-kdxxxxp",
 416         .longname = "Korad KDxxxxP",
 417         .api_version = 1,
 418         .init = init,
 419         .cleanup = cleanup,
 420         .scan = scan,
 421         .dev_list = dev_list,
 422         .dev_clear = dev_clear,
 423         .config_get = config_get,
 424         .config_set = config_set,
 425         .config_list = config_list,
 426         .dev_open = std_serial_dev_open,
 427         .dev_close = std_serial_dev_close,
 428         .dev_acquisition_start = dev_acquisition_start,
 429         .dev_acquisition_stop = dev_acquisition_stop,
 430         .context = NULL,
 431 };