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