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