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