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  * Copyright (C) 2018-2019 Frank Stettner <frank-stettner@gmx.net>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <config.h>
  22 #include "protocol.h"
  23
  24 static const uint32_t scanopts[] = {
  25         SR_CONF_CONN,
  26         SR_CONF_SERIALCOMM,
  27         SR_CONF_FORCE_DETECT,
  28 };
  29
  30 static const uint32_t drvopts[] = {
  31         SR_CONF_POWER_SUPPLY,
  32 };
  33
  34 static const uint32_t devopts[] = {
  35         SR_CONF_CONN | SR_CONF_GET,
  36         SR_CONF_CONTINUOUS,
  37         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  38         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  39         SR_CONF_VOLTAGE | SR_CONF_GET,
  40         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  41         SR_CONF_CURRENT | SR_CONF_GET,
  42         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  43         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  44         SR_CONF_REGULATION | SR_CONF_GET,
  45         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  46         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  47 };
  48
  49 /* Voltage and current ranges. Values are: Min, max, step. */
  50 static const double volts_30[] = { 0, 31, 0.01, };
  51 static const double volts_60[] = { 0, 61, 0.01, };
  52 static const double amps_3[] = { 0, 3.1, 0.001, };
  53 static const double amps_5[] = { 0, 5.1, 0.001, };
  54
  55 static const struct korad_kaxxxxp_model models[] = {
  56         /* Vendor, model name, ID reply, channels, voltage, current, quirks. */
  57         {"Korad", "KA3005P", "KORADKA3005PV2.0", 1, volts_30, amps_5, 0},
  58         /* Some KA3005P have extra bytes after the ID text. */
  59         {"Korad", "KA3005P", "KORADKA3005PV2.0\x01", 1, volts_30, amps_5, 0},
  60         {"Korad", "KA3005P", "KORADKA3005PV2.0\xBC", 1, volts_30, amps_5, 0},
  61         {"Korad", "KA3005P", "KORAD KA3005P V4.2", 1, volts_30, amps_5, 0},
  62         {"Korad", "KA3005P", "KORAD KA3005P V5.5", 1, volts_30, amps_5, 0},
  63         {"Korad", "KD3005P", "KORAD KD3005P V2.0", 1, volts_30, amps_5, 0},
  64         {"Korad", "KD3005P", "KORADKD3005PV2.0", 1, volts_30, amps_5, 0},
  65         {"Korad", "KD3005P", "KORADKD3005PV2.1", 1, volts_30, amps_5, 0},
  66         {"Korad", "KD3005P", "KORAD KD3005P V4.1", 1, volts_30, amps_5, 0},
  67         {"Korad", "KD3005P", "KORAD KD3005P V6.8", 1, volts_30, amps_5, 0},
  68         {"Korad", "KD6005P", "KORAD KD6005P V2.2", 1, volts_60, amps_5, 0},
  69         {"RND", "KA3005P", "RND 320-KA3005P V5.5", 1, volts_30, amps_5, 0},
  70         {"RND", "KD3005P", "RND 320-KD3005P V4.2", 1, volts_30, amps_5, 0},
  71         {"RND", "KA3005P", "RND 320-KA3005P V2.0", 1, volts_30, amps_5, 0},
  72         {"Stamos Soldering", "S-LS-31", "S-LS-31 V2.0", 1, volts_30, amps_5, 0},
  73         {"Tenma", "72-2535", "TENMA 72-2535 V2.1", 1, volts_30, amps_3, 0},
  74         {"Tenma", "72-2540", "TENMA72-2540V2.0", 1, volts_30, amps_5, 0},
  75         {"Tenma", "72-2540", "TENMA 72-2540 V2.1", 1, volts_30, amps_5, 0},
  76         {"Tenma", "72-2540", "TENMA 72-2540 V5.2", 1, volts_30, amps_5, 0},
  77         {"Tenma", "72-2550", "TENMA72-2550V2.0", 1, volts_60, amps_3, 0},
  78         {"Tenma", "72-2710", "TENMA 72-2710 V6.6", 1, volts_30, amps_5, 0},
  79         {"Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0",
  80                 1, volts_30, amps_5, KORAD_QUIRK_LABPS_OVP_EN},
  81         {"Velleman", "PS3005D", "VELLEMANPS3005DV2.0",
  82                 1, volts_30, amps_5, 0},
  83         ALL_ZERO
  84 };
  85
  86 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  87 {
  88         static const char *serno_prefix = " SN:";
  89
  90         struct dev_context *devc;
  91         GSList *l;
  92         struct sr_dev_inst *sdi;
  93         struct sr_config *src;
  94         const char *conn, *serialcomm;
  95         const char *force_detect;
  96         struct sr_serial_dev_inst *serial;
  97         size_t i;
  98         char reply[50];
  99         int ret;
 100         const struct korad_kaxxxxp_model *model;
 101         size_t len;
 102         char *serno;
 103
 104         conn = NULL;
 105         serialcomm = NULL;
 106         force_detect = NULL;
 107
 108         for (l = options; l; l = l->next) {
 109                 src = l->data;
 110                 switch (src->key) {
 111                 case SR_CONF_CONN:
 112                         conn = g_variant_get_string(src->data, NULL);
 113                         break;
 114                 case SR_CONF_SERIALCOMM:
 115                         serialcomm = g_variant_get_string(src->data, NULL);
 116                         break;
 117                 case SR_CONF_FORCE_DETECT:
 118                         force_detect = g_variant_get_string(src->data, NULL);
 119                         break;
 120                 default:
 121                         sr_err("Unknown option %d, skipping.", src->key);
 122                         break;
 123                 }
 124         }
 125
 126         if (!conn)
 127                 return NULL;
 128         if (!serialcomm)
 129                 serialcomm = "9600/8n1";
 130         if (force_detect && !*force_detect)
 131                 force_detect = NULL;
 132
 133         serial = sr_serial_dev_inst_new(conn, serialcomm);
 134         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 135                 return NULL;
 136
 137         /*
 138          * Prepare a receive buffer for the identification response that
 139          * is large enough to hold the longest known model name, and an
 140          * optional serial number. Communicate the identification request.
 141          */
 142         len = 0;
 143         for (i = 0; models[i].id; i++) {
 144                 if (len < strlen(models[i].id))
 145                         len = strlen(models[i].id);
 146         }
 147         len += strlen(serno_prefix) + 12;
 148         if (len > sizeof(reply) - 1)
 149                 len = sizeof(reply) - 1;
 150         sr_dbg("Want max %zu bytes.", len);
 151
 152         ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
 153         if (ret < 0)
 154                 return NULL;
 155
 156         ret = korad_kaxxxxp_read_chars(serial, len, reply);
 157         if (ret < 0)
 158                 return NULL;
 159         sr_dbg("Received: %d, %s", ret, reply);
 160
 161         /*
 162          * Isolate the optional serial number at the response's end.
 163          * Lookup the response's model ID in the list of known models.
 164          */
 165         serno = g_strrstr(reply, serno_prefix);
 166         if (serno) {
 167                 *serno = '\0';
 168                 serno += strlen(serno_prefix);
 169         }
 170
 171         model = NULL;
 172         for (i = 0; models[i].id; i++) {
 173                 if (g_strcmp0(models[i].id, reply) != 0)
 174                         continue;
 175                 model = &models[i];
 176                 break;
 177         }
 178         if (!model && force_detect) {
 179                 sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
 180                         reply, force_detect);
 181                 for (i = 0; models[i].id; i++) {
 182                         if (strcmp(models[i].id, force_detect) != 0)
 183                                 continue;
 184                         sr_info("Found replacement, using it instead.");
 185                         model = &models[i];
 186                         break;
 187                 }
 188         }
 189         if (!model) {
 190                 sr_err("Unknown model ID '%s' detected, aborting.", reply);
 191                 return NULL;
 192         }
 193         sr_dbg("Found: %s %s (idx %zu, ID '%s').", model->vendor, model->name,
 194                 model - &models[0], model->id);
 195
 196         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 197         sdi->status = SR_ST_INACTIVE;
 198         sdi->vendor = g_strdup(model->vendor);
 199         sdi->model = g_strdup(model->name);
 200         if (serno)
 201                 sdi->serial_num = g_strdup(serno);
 202         sdi->inst_type = SR_INST_SERIAL;
 203         sdi->conn = serial;
 204         sdi->connection_id = g_strdup(conn);
 205
 206         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
 207         sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
 208
 209         devc = g_malloc0(sizeof(struct dev_context));
 210         sr_sw_limits_init(&devc->limits);
 211         g_mutex_init(&devc->rw_mutex);
 212         devc->model = model;
 213         devc->req_sent_at = 0;
 214         devc->cc_mode_1_changed = FALSE;
 215         devc->cc_mode_2_changed = FALSE;
 216         devc->output_enabled_changed = FALSE;
 217         devc->ocp_enabled_changed = FALSE;
 218         devc->ovp_enabled_changed = FALSE;
 219         sdi->priv = devc;
 220
 221         /* Get current status of device. */
 222         if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
 223                 goto exit_err;
 224
 225         serial_close(serial);
 226
 227         return std_scan_complete(di, g_slist_append(NULL, sdi));
 228
 229 exit_err:
 230         sr_dev_inst_free(sdi);
 231         g_free(devc);
 232         sr_dbg("Scan failed.");
 233
 234         return NULL;
 235 }
 236
 237 static int config_get(uint32_t key, GVariant **data,
 238         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 239 {
 240         struct dev_context *devc;
 241
 242         (void)cg;
 243
 244         if (!sdi || !data)
 245                 return SR_ERR_ARG;
 246
 247         devc = sdi->priv;
 248
 249         switch (key) {
 250         case SR_CONF_LIMIT_SAMPLES:
 251         case SR_CONF_LIMIT_MSEC:
 252                 return sr_sw_limits_config_get(&devc->limits, key, data);
 253         case SR_CONF_CONN:
 254                 *data = g_variant_new_string(sdi->connection_id);
 255                 break;
 256         case SR_CONF_VOLTAGE:
 257                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
 258                 *data = g_variant_new_double(devc->voltage);
 259                 break;
 260         case SR_CONF_VOLTAGE_TARGET:
 261                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
 262                 *data = g_variant_new_double(devc->voltage_target);
 263                 break;
 264         case SR_CONF_CURRENT:
 265                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
 266                 *data = g_variant_new_double(devc->current);
 267                 break;
 268         case SR_CONF_CURRENT_LIMIT:
 269                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
 270                 *data = g_variant_new_double(devc->current_limit);
 271                 break;
 272         case SR_CONF_ENABLED:
 273                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
 274                 *data = g_variant_new_boolean(devc->output_enabled);
 275                 break;
 276         case SR_CONF_REGULATION:
 277                 /* Dual channel not supported. */
 278                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
 279                 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
 280                 break;
 281         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 282                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
 283                 *data = g_variant_new_boolean(devc->ocp_enabled);
 284                 break;
 285         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 286                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
 287                 *data = g_variant_new_boolean(devc->ovp_enabled);
 288                 break;
 289         default:
 290                 return SR_ERR_NA;
 291         }
 292
 293         return SR_OK;
 294 }
 295
 296 static int config_set(uint32_t key, GVariant *data,
 297         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 298 {
 299         struct dev_context *devc;
 300         double dval;
 301         gboolean bval;
 302
 303         (void)cg;
 304
 305         devc = sdi->priv;
 306
 307         switch (key) {
 308         case SR_CONF_LIMIT_MSEC:
 309         case SR_CONF_LIMIT_SAMPLES:
 310                 return sr_sw_limits_config_set(&devc->limits, key, data);
 311         case SR_CONF_VOLTAGE_TARGET:
 312                 dval = g_variant_get_double(data);
 313                 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
 314                         return SR_ERR_ARG;
 315                 devc->set_voltage_target = dval;
 316                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
 317                         return SR_ERR;
 318                 break;
 319         case SR_CONF_CURRENT_LIMIT:
 320                 dval = g_variant_get_double(data);
 321                 if (dval < devc->model->current[0] || dval > devc->model->current[1])
 322                         return SR_ERR_ARG;
 323                 devc->set_current_limit = dval;
 324                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
 325                         return SR_ERR;
 326                 break;
 327         case SR_CONF_ENABLED:
 328                 bval = g_variant_get_boolean(data);
 329                 /* Set always so it is possible turn off with sigrok-cli. */
 330                 devc->set_output_enabled = bval;
 331                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
 332                         return SR_ERR;
 333                 break;
 334         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 335                 bval = g_variant_get_boolean(data);
 336                 devc->set_ocp_enabled = bval;
 337                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
 338                         return SR_ERR;
 339                 break;
 340         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 341                 bval = g_variant_get_boolean(data);
 342                 devc->set_ovp_enabled = bval;
 343                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
 344                         return SR_ERR;
 345                 break;
 346         default:
 347                 return SR_ERR_NA;
 348         }
 349
 350         return SR_OK;
 351 }
 352
 353 static int config_list(uint32_t key, GVariant **data,
 354         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 355 {
 356         struct dev_context *devc;
 357
 358         devc = (sdi) ? sdi->priv : NULL;
 359
 360         switch (key) {
 361         case SR_CONF_SCAN_OPTIONS:
 362         case SR_CONF_DEVICE_OPTIONS:
 363                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 364         case SR_CONF_VOLTAGE_TARGET:
 365                 if (!devc || !devc->model)
 366                         return SR_ERR_ARG;
 367                 *data = std_gvar_min_max_step_array(devc->model->voltage);
 368                 break;
 369         case SR_CONF_CURRENT_LIMIT:
 370                 if (!devc || !devc->model)
 371                         return SR_ERR_ARG;
 372                 *data = std_gvar_min_max_step_array(devc->model->current);
 373                 break;
 374         default:
 375                 return SR_ERR_NA;
 376         }
 377
 378         return SR_OK;
 379 }
 380
 381 static int dev_close(struct sr_dev_inst *sdi)
 382 {
 383         struct dev_context *devc;
 384
 385         devc = (sdi) ? sdi->priv : NULL;
 386         if (devc)
 387                 g_mutex_clear(&devc->rw_mutex);
 388
 389         return std_serial_dev_close(sdi);
 390 }
 391
 392 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 393 {
 394         struct dev_context *devc;
 395         struct sr_serial_dev_inst *serial;
 396
 397         devc = sdi->priv;
 398
 399         sr_sw_limits_acquisition_start(&devc->limits);
 400         std_session_send_df_header(sdi);
 401
 402         devc->req_sent_at = 0;
 403         serial = sdi->conn;
 404         serial_source_add(sdi->session, serial, G_IO_IN,
 405                         KAXXXXP_POLL_INTERVAL_MS,
 406                         korad_kaxxxxp_receive_data, (void *)sdi);
 407
 408         return SR_OK;
 409 }
 410
 411 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
 412         .name = "korad-kaxxxxp",
 413         .longname = "Korad KAxxxxP",
 414         .api_version = 1,
 415         .init = std_init,
 416         .cleanup = std_cleanup,
 417         .scan = scan,
 418         .dev_list = std_dev_list,
 419         .dev_clear = std_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 = dev_close,
 425         .dev_acquisition_start = dev_acquisition_start,
 426         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 427         .context = NULL,
 428 };
 429 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);