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