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