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