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