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