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