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