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