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
  23 #include <ctype.h>
  24
  25 #include "protocol.h"
  26
  27 static const uint32_t scanopts[] = {
  28         SR_CONF_CONN,
  29         SR_CONF_SERIALCOMM,
  30         SR_CONF_FORCE_DETECT,
  31 };
  32
  33 static const uint32_t drvopts[] = {
  34         SR_CONF_POWER_SUPPLY,
  35 };
  36
  37 static const uint32_t devopts[] = {
  38         SR_CONF_CONN | SR_CONF_GET,
  39         SR_CONF_CONTINUOUS,
  40         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  41         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  42         SR_CONF_VOLTAGE | SR_CONF_GET,
  43         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  44         SR_CONF_CURRENT | SR_CONF_GET,
  45         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  46         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  47         SR_CONF_REGULATION | SR_CONF_GET,
  48         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  49         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  50 };
  51
  52 /* Voltage and current ranges. Values are: Min, max, step. */
  53 static const double volts_30[] = { 0, 31, 0.01, };
  54 static const double volts_60[] = { 0, 61, 0.01, };
  55 static const double amps_3[] = { 0, 3.1, 0.001, };
  56 static const double amps_5[] = { 0, 5.1, 0.001, };
  57
  58 static const struct korad_kaxxxxp_model models[] = {
  59         /* Vendor, model name, ID reply, channels, voltage, current, quirks. */
  60         {"Korad", "KA3005P", "", 1, volts_30, amps_5,
  61                 KORAD_QUIRK_ID_TRAILING},
  62         {"Korad", "KD3005P", "", 1, volts_30, amps_5, 0},
  63         {"Korad", "KD6005P", "", 1, volts_60, amps_5, 0},
  64         {"RND", "KA3005P", "RND 320-KA3005P", 1, volts_30, amps_5,
  65                 KORAD_QUIRK_ID_OPT_VERSION},
  66         {"RND", "KD3005P", "RND 320-KD3005P", 1, volts_30, amps_5,
  67                 KORAD_QUIRK_ID_OPT_VERSION},
  68         {"Stamos Soldering", "S-LS-31", "", 1, volts_30, amps_5,
  69                 KORAD_QUIRK_ID_NO_VENDOR},
  70         {"Tenma", "72-2535", "", 1, volts_30, amps_3, 0},
  71         {"Tenma", "72-2540", "", 1, volts_30, amps_5, 0},
  72         {"Tenma", "72-2550", "", 1, volts_60, amps_3, 0},
  73         {"Tenma", "72-2710", "", 1, volts_30, amps_5, 0},
  74         {"Velleman", "LABPS3005D", "", 1, volts_30, amps_5,
  75                 KORAD_QUIRK_LABPS_OVP_EN},
  76         {"Velleman", "PS3005D", "", 1, volts_30, amps_5, 0},
  77         ALL_ZERO
  78 };
  79
  80 /*
  81  * Bump this when adding new models[] above. Make sure the text buffer
  82  * for the ID response can hold the longest sequence that we expect in
  83  * the field which consists of: vendor + model [ + version ][ + serno ].
  84  * Don't be too generous here, the maximum receive buffer size affects
  85  * the timeout within which the first response character is expected.
  86  */
  87 static const size_t id_text_buffer_size = 48;
  88
  89 /*
  90  * Check whether the device's "*IDN?" response matches a supported model.
  91  * The caller already stripped off the optional serial number.
  92  */
  93 static gboolean model_matches(const struct korad_kaxxxxp_model *model,
  94         const char *id_text)
  95 {
  96         gboolean matches;
  97         gboolean opt_version, skip_vendor, accept_trail;
  98         const char *want;
  99
 100         if (!model)
 101                 return FALSE;
 102
 103         /*
 104          * When the models[] entry contains a specific response text,
 105          * then expect to see this very text in literal form. This
 106          * lets the driver map weird and untypical responses to a
 107          * specific set of display texts for vendor and model names.
 108          * Accept an optionally trailing version if models[] says so.
 109          */
 110         if (model->id && model->id[0]) {
 111                 opt_version = model->quirks & KORAD_QUIRK_ID_OPT_VERSION;
 112                 if (!opt_version) {
 113                         matches = g_strcmp0(id_text, model->id) == 0;
 114                         if (!matches)
 115                                 return FALSE;
 116                         sr_dbg("Matches expected ID text: '%s'.", model->id);
 117                         return TRUE;
 118                 }
 119                 matches = g_str_has_prefix(id_text, model->id);
 120                 if (!matches)
 121                         return FALSE;
 122                 id_text += strlen(model->id);
 123                 while (isspace((int)*id_text))
 124                         id_text++;
 125                 if (*id_text == 'V') {
 126                         id_text++;
 127                         while (*id_text == '.' || isdigit((int)*id_text))
 128                                 id_text++;
 129                         while (isspace((int)*id_text))
 130                                 id_text++;
 131                 }
 132                 if (*id_text)
 133                         return FALSE;
 134                 sr_dbg("Matches expected ID text [vers]: '%s'.", model->id);
 135                 return TRUE;
 136         }
 137
 138         /*
 139          * A more generic approach which covers most devices: Check
 140          * for the very vendor and model names which also are shown
 141          * to users (the display texts). Weakened to match responses
 142          * more widely: Case insensitive checks, optional whitespace
 143          * in responses, optional version details. Optional trailing
 144          * garbage. Optional omission of the vendor name. Shall match
 145          * all the devices which were individually listed in earlier
 146          * implementations of the driver, and shall also match firmware
 147          * versions that were not listed before.
 148          */
 149         skip_vendor = model->quirks & KORAD_QUIRK_ID_NO_VENDOR;
 150         accept_trail = model->quirks & KORAD_QUIRK_ID_TRAILING;
 151         if (!skip_vendor) {
 152                 want = model->vendor;
 153                 matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
 154                 if (!matches)
 155                         return FALSE;
 156                 id_text += strlen(want);
 157                 while (isspace((int)*id_text))
 158                         id_text++;
 159         }
 160         want = model->name;
 161         matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
 162         if (!matches)
 163                 return FALSE;
 164         id_text += strlen(want);
 165         while (isspace((int)*id_text))
 166                 id_text++;
 167         if (*id_text == 'V') {
 168                 /* TODO Isolate and (also) return version details? */
 169                 id_text++;
 170                 while (*id_text == '.' || isdigit((int)*id_text))
 171                         id_text++;
 172                 while (isspace((int)*id_text))
 173                         id_text++;
 174         }
 175         if (accept_trail) {
 176                 /*
 177                  * TODO Determine how many non-printables to accept here
 178                  * and how strict to check for "known" garbage variants.
 179                  */
 180                 switch (*id_text) {
 181                 case '\x01':
 182                 case '\xbc':
 183                         id_text++;
 184                         break;
 185                 case '\x00':
 186                         /* EMPTY */
 187                         break;
 188                 default:
 189                         return FALSE;
 190                 }
 191         }
 192         if (*id_text)
 193                 return FALSE;
 194         sr_dbg("Matches generic '[vendor] model [vers] [trail]' pattern.");
 195         return TRUE;
 196 }
 197
 198 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 199 {
 200         static const char *serno_prefix = " SN:";
 201
 202         struct dev_context *devc;
 203         GSList *l;
 204         struct sr_dev_inst *sdi;
 205         struct sr_config *src;
 206         const char *conn, *serialcomm;
 207         const char *force_detect;
 208         struct sr_serial_dev_inst *serial;
 209         size_t i;
 210         char reply[50];
 211         int ret;
 212         const struct korad_kaxxxxp_model *model;
 213         size_t len;
 214         char *serno;
 215
 216         conn = NULL;
 217         serialcomm = NULL;
 218         force_detect = NULL;
 219
 220         for (l = options; l; l = l->next) {
 221                 src = l->data;
 222                 switch (src->key) {
 223                 case SR_CONF_CONN:
 224                         conn = g_variant_get_string(src->data, NULL);
 225                         break;
 226                 case SR_CONF_SERIALCOMM:
 227                         serialcomm = g_variant_get_string(src->data, NULL);
 228                         break;
 229                 case SR_CONF_FORCE_DETECT:
 230                         force_detect = g_variant_get_string(src->data, NULL);
 231                         break;
 232                 default:
 233                         sr_err("Unknown option %d, skipping.", src->key);
 234                         break;
 235                 }
 236         }
 237
 238         if (!conn)
 239                 return NULL;
 240         if (!serialcomm)
 241                 serialcomm = "9600/8n1";
 242         if (force_detect && !*force_detect)
 243                 force_detect = NULL;
 244
 245         serial = sr_serial_dev_inst_new(conn, serialcomm);
 246         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 247                 return NULL;
 248
 249         /* Communicate the identification request. */
 250         len = id_text_buffer_size;
 251         if (len > sizeof(reply) - 1)
 252                 len = sizeof(reply) - 1;
 253         sr_dbg("Want max %zu bytes.", len);
 254
 255         ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
 256         if (ret < 0)
 257                 return NULL;
 258
 259         ret = korad_kaxxxxp_read_chars(serial, len, reply);
 260         if (ret < 0)
 261                 return NULL;
 262         sr_dbg("Received: %d, %s", ret, reply);
 263
 264         /*
 265          * Isolate the optional serial number at the response's end.
 266          * Lookup the response's model ID in the list of known models.
 267          */
 268         serno = g_strrstr(reply, serno_prefix);
 269         if (serno) {
 270                 *serno = '\0';
 271                 serno += strlen(serno_prefix);
 272         }
 273
 274         model = NULL;
 275         for (i = 0; models[i].name; i++) {
 276                 if (!model_matches(&models[i], reply))
 277                         continue;
 278                 model = &models[i];
 279                 break;
 280         }
 281         if (!model && force_detect) {
 282                 sr_warn("Found unknown model ID '%s', trying '%s' spec.",
 283                         reply, force_detect);
 284                 for (i = 0; models[i].name; i++) {
 285                         if (!model_matches(&models[i], force_detect))
 286                                 continue;
 287                         sr_info("Found replacement, using it instead.");
 288                         model = &models[i];
 289                         break;
 290                 }
 291         }
 292         if (!model) {
 293                 sr_err("Found unknown model ID '%s', aborting.", reply);
 294                 return NULL;
 295         }
 296         sr_dbg("Found: %s %s (idx %zu).", model->vendor, model->name,
 297                 model - &models[0]);
 298
 299         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 300         sdi->status = SR_ST_INACTIVE;
 301         sdi->vendor = g_strdup(model->vendor);
 302         sdi->model = g_strdup(model->name);
 303         if (serno)
 304                 sdi->serial_num = g_strdup(serno);
 305         sdi->inst_type = SR_INST_SERIAL;
 306         sdi->conn = serial;
 307         sdi->connection_id = g_strdup(conn);
 308
 309         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
 310         sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
 311
 312         devc = g_malloc0(sizeof(struct dev_context));
 313         sr_sw_limits_init(&devc->limits);
 314         g_mutex_init(&devc->rw_mutex);
 315         devc->model = model;
 316         devc->req_sent_at = 0;
 317         devc->cc_mode_1_changed = FALSE;
 318         devc->cc_mode_2_changed = FALSE;
 319         devc->output_enabled_changed = FALSE;
 320         devc->ocp_enabled_changed = FALSE;
 321         devc->ovp_enabled_changed = FALSE;
 322         sdi->priv = devc;
 323
 324         /* Get current status of device. */
 325         if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
 326                 goto exit_err;
 327
 328         serial_close(serial);
 329
 330         return std_scan_complete(di, g_slist_append(NULL, sdi));
 331
 332 exit_err:
 333         sr_dev_inst_free(sdi);
 334         g_free(devc);
 335         sr_dbg("Scan failed.");
 336
 337         return NULL;
 338 }
 339
 340 static int config_get(uint32_t key, GVariant **data,
 341         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 342 {
 343         struct dev_context *devc;
 344
 345         (void)cg;
 346
 347         if (!sdi || !data)
 348                 return SR_ERR_ARG;
 349
 350         devc = sdi->priv;
 351
 352         switch (key) {
 353         case SR_CONF_LIMIT_SAMPLES:
 354         case SR_CONF_LIMIT_MSEC:
 355                 return sr_sw_limits_config_get(&devc->limits, key, data);
 356         case SR_CONF_CONN:
 357                 *data = g_variant_new_string(sdi->connection_id);
 358                 break;
 359         case SR_CONF_VOLTAGE:
 360                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
 361                 *data = g_variant_new_double(devc->voltage);
 362                 break;
 363         case SR_CONF_VOLTAGE_TARGET:
 364                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
 365                 *data = g_variant_new_double(devc->voltage_target);
 366                 break;
 367         case SR_CONF_CURRENT:
 368                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
 369                 *data = g_variant_new_double(devc->current);
 370                 break;
 371         case SR_CONF_CURRENT_LIMIT:
 372                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
 373                 *data = g_variant_new_double(devc->current_limit);
 374                 break;
 375         case SR_CONF_ENABLED:
 376                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
 377                 *data = g_variant_new_boolean(devc->output_enabled);
 378                 break;
 379         case SR_CONF_REGULATION:
 380                 /* Dual channel not supported. */
 381                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
 382                 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
 383                 break;
 384         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 385                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
 386                 *data = g_variant_new_boolean(devc->ocp_enabled);
 387                 break;
 388         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 389                 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
 390                 *data = g_variant_new_boolean(devc->ovp_enabled);
 391                 break;
 392         default:
 393                 return SR_ERR_NA;
 394         }
 395
 396         return SR_OK;
 397 }
 398
 399 static int config_set(uint32_t key, GVariant *data,
 400         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 401 {
 402         struct dev_context *devc;
 403         double dval;
 404         gboolean bval;
 405
 406         (void)cg;
 407
 408         devc = sdi->priv;
 409
 410         switch (key) {
 411         case SR_CONF_LIMIT_MSEC:
 412         case SR_CONF_LIMIT_SAMPLES:
 413                 return sr_sw_limits_config_set(&devc->limits, key, data);
 414         case SR_CONF_VOLTAGE_TARGET:
 415                 dval = g_variant_get_double(data);
 416                 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
 417                         return SR_ERR_ARG;
 418                 devc->set_voltage_target = dval;
 419                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
 420                         return SR_ERR;
 421                 break;
 422         case SR_CONF_CURRENT_LIMIT:
 423                 dval = g_variant_get_double(data);
 424                 if (dval < devc->model->current[0] || dval > devc->model->current[1])
 425                         return SR_ERR_ARG;
 426                 devc->set_current_limit = dval;
 427                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
 428                         return SR_ERR;
 429                 break;
 430         case SR_CONF_ENABLED:
 431                 bval = g_variant_get_boolean(data);
 432                 /* Set always so it is possible turn off with sigrok-cli. */
 433                 devc->set_output_enabled = bval;
 434                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
 435                         return SR_ERR;
 436                 break;
 437         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 438                 bval = g_variant_get_boolean(data);
 439                 devc->set_ocp_enabled = bval;
 440                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
 441                         return SR_ERR;
 442                 break;
 443         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 444                 bval = g_variant_get_boolean(data);
 445                 devc->set_ovp_enabled = bval;
 446                 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
 447                         return SR_ERR;
 448                 break;
 449         default:
 450                 return SR_ERR_NA;
 451         }
 452
 453         return SR_OK;
 454 }
 455
 456 static int config_list(uint32_t key, GVariant **data,
 457         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 458 {
 459         struct dev_context *devc;
 460
 461         devc = (sdi) ? sdi->priv : NULL;
 462
 463         switch (key) {
 464         case SR_CONF_SCAN_OPTIONS:
 465         case SR_CONF_DEVICE_OPTIONS:
 466                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 467         case SR_CONF_VOLTAGE_TARGET:
 468                 if (!devc || !devc->model)
 469                         return SR_ERR_ARG;
 470                 *data = std_gvar_min_max_step_array(devc->model->voltage);
 471                 break;
 472         case SR_CONF_CURRENT_LIMIT:
 473                 if (!devc || !devc->model)
 474                         return SR_ERR_ARG;
 475                 *data = std_gvar_min_max_step_array(devc->model->current);
 476                 break;
 477         default:
 478                 return SR_ERR_NA;
 479         }
 480
 481         return SR_OK;
 482 }
 483
 484 static int dev_close(struct sr_dev_inst *sdi)
 485 {
 486         struct dev_context *devc;
 487
 488         devc = (sdi) ? sdi->priv : NULL;
 489         if (devc)
 490                 g_mutex_clear(&devc->rw_mutex);
 491
 492         return std_serial_dev_close(sdi);
 493 }
 494
 495 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 496 {
 497         struct dev_context *devc;
 498         struct sr_serial_dev_inst *serial;
 499
 500         devc = sdi->priv;
 501
 502         sr_sw_limits_acquisition_start(&devc->limits);
 503         std_session_send_df_header(sdi);
 504
 505         devc->req_sent_at = 0;
 506         serial = sdi->conn;
 507         serial_source_add(sdi->session, serial, G_IO_IN,
 508                         KAXXXXP_POLL_INTERVAL_MS,
 509                         korad_kaxxxxp_receive_data, (void *)sdi);
 510
 511         return SR_OK;
 512 }
 513
 514 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
 515         .name = "korad-kaxxxxp",
 516         .longname = "Korad KAxxxxP",
 517         .api_version = 1,
 518         .init = std_init,
 519         .cleanup = std_cleanup,
 520         .scan = scan,
 521         .dev_list = std_dev_list,
 522         .dev_clear = std_dev_clear,
 523         .config_get = config_get,
 524         .config_set = config_set,
 525         .config_list = config_list,
 526         .dev_open = std_serial_dev_open,
 527         .dev_close = dev_close,
 528         .dev_acquisition_start = dev_acquisition_start,
 529         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 530         .context = NULL,
 531 };
 532 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);