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