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