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