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  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include "protocol.h"
  22
  23 static const uint32_t drvopts[] = {
  24         /* Device class */
  25         SR_CONF_POWER_SUPPLY,
  26 };
  27
  28 static const uint32_t scanopts[] = {
  29         SR_CONF_CONN,
  30         SR_CONF_SERIALCOMM,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         /* Device class */
  35         SR_CONF_POWER_SUPPLY,
  36         /* Acquisition modes. */
  37         SR_CONF_CONTINUOUS,
  38         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  39         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  40         /* Device configuration */
  41         SR_CONF_VOLTAGE | SR_CONF_GET,
  42         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  43         SR_CONF_CURRENT | SR_CONF_GET,
  44         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  45         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  46         SR_CONF_REGULATION | SR_CONF_GET,
  47         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  48         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  49 };
  50
  51 static const struct korad_kaxxxxp_model models[] = {
  52         /* Device enum, vendor, model, ID reply, channels, voltage, current */
  53         {VELLEMAN_PS3005D, "Velleman", "PS3005D",
  54                 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
  55         {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
  56                 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
  57         {KORAD_KA3005P, "Korad", "KA3005P",
  58                 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
  59         /* Sometimes the KA3005P has an extra 0x01 after the ID. */
  60         {KORAD_KA3005P_0X01, "Korad", "KA3005P",
  61                 "KORADKA3005PV2.0\x01", 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 drv_context *drvc;
  68         struct dev_context *devc;
  69         GSList *devices, *l;
  70         struct sr_dev_inst *sdi;
  71         struct sr_config *src;
  72         const char *conn, *serialcomm;
  73         struct sr_serial_dev_inst *serial;
  74         char reply[50];
  75         int i, model_id;
  76         unsigned int len;
  77
  78         devices = NULL;
  79         conn = NULL;
  80         serialcomm = NULL;
  81         drvc = di->context;
  82
  83         for (l = options; l; l = l->next) {
  84                 src = l->data;
  85                 switch (src->key) {
  86                 case SR_CONF_CONN:
  87                         conn = g_variant_get_string(src->data, NULL);
  88                         break;
  89                 case SR_CONF_SERIALCOMM:
  90                         serialcomm = g_variant_get_string(src->data, NULL);
  91                         break;
  92                 default:
  93                         sr_err("Unknown option %d, skipping.", src->key);
  94                         break;
  95                 }
  96         }
  97
  98         if (!conn)
  99                 return NULL;
 100         if (!serialcomm)
 101                 serialcomm = "9600/8n1";
 102
 103         serial = sr_serial_dev_inst_new(conn, serialcomm);
 104         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 105                 return NULL;
 106
 107         serial_flush(serial);
 108
 109         /* Get the device model. */
 110         len = 0;
 111         for (i = 0; models[i].id; i++) {
 112                 if (strlen(models[i].id) > len)
 113                         len = strlen(models[i].id);
 114         }
 115         memset(&reply, 0, sizeof(reply));
 116         sr_dbg("Want max %d bytes.", len);
 117         if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
 118                 return NULL;
 119
 120         /* i is used here for debug purposes only. */
 121         if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
 122                 return NULL;
 123         sr_dbg("Received: %d, %s", i, reply);
 124         model_id = -1;
 125         for (i = 0; models[i].id; i++) {
 126                 if (!strcmp(models[i].id, reply))
 127                         model_id = i;
 128         }
 129         if (model_id < 0) {
 130                 sr_err("Unknown model ID '%s' detected, aborting.", reply);
 131                 return NULL;
 132         }
 133         sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
 134                 models[model_id].name, model_id, models[model_id].id);
 135
 136         /* Init device instance, etc. */
 137         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 138         sdi->status = SR_ST_INACTIVE;
 139         sdi->vendor = g_strdup(models[model_id].vendor);
 140         sdi->model = g_strdup(models[model_id].name);
 141         sdi->inst_type = SR_INST_SERIAL;
 142         sdi->conn = serial;
 143         sdi->driver = di;
 144
 145         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
 146
 147         devc = g_malloc0(sizeof(struct dev_context));
 148         sr_sw_limits_init(&devc->limits);
 149         devc->model = &models[model_id];
 150         devc->reply[5] = 0;
 151         devc->req_sent_at = 0;
 152         sdi->priv = devc;
 153
 154         /* Get current status of device. */
 155         if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
 156                 goto exit_err;
 157         drvc->instances = g_slist_append(drvc->instances, sdi);
 158         devices = g_slist_append(devices, sdi);
 159
 160         serial_close(serial);
 161         if (!devices)
 162                 sr_serial_dev_inst_free(serial);
 163
 164         return devices;
 165
 166 exit_err:
 167         sr_dev_inst_free(sdi);
 168         g_free(devc);
 169         sr_dbg("Scan failed.");
 170
 171         return NULL;
 172 }
 173
 174 static int config_get(uint32_t key, GVariant **data,
 175         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 176 {
 177         struct dev_context *devc;
 178
 179         (void)cg;
 180
 181         if (!sdi || !data)
 182                 return SR_ERR_ARG;
 183
 184         devc = sdi->priv;
 185
 186         switch (key) {
 187                 return sr_sw_limits_config_get(&devc->limits, key, data);
 188         case SR_CONF_VOLTAGE:
 189                 *data = g_variant_new_double(devc->voltage);
 190                 break;
 191         case SR_CONF_VOLTAGE_TARGET:
 192                 *data = g_variant_new_double(devc->voltage_max);
 193                 break;
 194         case SR_CONF_CURRENT:
 195                 *data = g_variant_new_double(devc->current);
 196                 break;
 197         case SR_CONF_CURRENT_LIMIT:
 198                 *data = g_variant_new_double(devc->current_max);
 199                 break;
 200         case SR_CONF_ENABLED:
 201                 *data = g_variant_new_boolean(devc->output_enabled);
 202                 break;
 203         case SR_CONF_REGULATION:
 204                 /* Dual channel not supported. */
 205                 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
 206                 break;
 207         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 208                 *data = g_variant_new_boolean(devc->ocp_enabled);
 209                 break;
 210         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 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         if (sdi->status != SR_ST_ACTIVE)
 230                 return SR_ERR_DEV_CLOSED;
 231
 232         devc = sdi->priv;
 233
 234         switch (key) {
 235         case SR_CONF_LIMIT_MSEC:
 236         case SR_CONF_LIMIT_SAMPLES:
 237                 return sr_sw_limits_config_set(&devc->limits, key, data);
 238         case SR_CONF_VOLTAGE_TARGET:
 239                 dval = g_variant_get_double(data);
 240                 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
 241                         return SR_ERR_ARG;
 242                 devc->voltage_max = dval;
 243                 devc->target = KAXXXXP_VOLTAGE_MAX;
 244                 if (korad_kaxxxxp_set_value(sdi->conn, 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                 devc->target = KAXXXXP_CURRENT_MAX;
 253                 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
 254                         return SR_ERR;
 255                 break;
 256         case SR_CONF_ENABLED:
 257                 bval = g_variant_get_boolean(data);
 258                 /* Set always so it is possible turn off with sigrok-cli. */
 259                 devc->output_enabled = bval;
 260                 devc->target = KAXXXXP_OUTPUT;
 261                 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
 262                         return SR_ERR;
 263                 break;
 264         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 265                 bval = g_variant_get_boolean(data);
 266                 devc->ocp_enabled = bval;
 267                 devc->target = KAXXXXP_OCP;
 268                 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
 269                         return SR_ERR;
 270                 break;
 271         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 272                 bval = g_variant_get_boolean(data);
 273                 devc->ovp_enabled = bval;
 274                 devc->target = KAXXXXP_OVP;
 275                 if (korad_kaxxxxp_set_value(sdi->conn, 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         GVariant *gvar;
 290         GVariantBuilder gvb;
 291         double dval;
 292         int idx;
 293
 294         (void)cg;
 295
 296         /* Always available (with or without sdi). */
 297         if (key == SR_CONF_SCAN_OPTIONS) {
 298                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 299                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 300                 return SR_OK;
 301         }
 302
 303         /* Return drvopts without sdi (and devopts with sdi, see below). */
 304         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 305                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 306                         drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 307                 return SR_OK;
 308         }
 309
 310         /* Every other key needs an sdi. */
 311         if (!sdi)
 312                 return SR_ERR_ARG;
 313
 314         devc = sdi->priv;
 315
 316         switch (key) {
 317         case SR_CONF_DEVICE_OPTIONS:
 318                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 319                         devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 320                 break;
 321         case SR_CONF_VOLTAGE_TARGET:
 322                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 323                 /* Min, max, step. */
 324                 for (idx = 0; idx < 3; idx++) {
 325                         dval = devc->model->voltage[idx];
 326                         gvar = g_variant_new_double(dval);
 327                         g_variant_builder_add_value(&gvb, gvar);
 328                 }
 329                 *data = g_variant_builder_end(&gvb);
 330                 break;
 331         case SR_CONF_CURRENT_LIMIT:
 332                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 333                 /* Min, max, step. */
 334                 for (idx = 0; idx < 3; idx++) {
 335                         dval = devc->model->current[idx];
 336                         gvar = g_variant_new_double(dval);
 337                         g_variant_builder_add_value(&gvb, gvar);
 338                 }
 339                 *data = g_variant_builder_end(&gvb);
 340                 break;
 341         default:
 342                 return SR_ERR_NA;
 343         }
 344
 345         return SR_OK;
 346 }
 347
 348 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 349 {
 350         struct dev_context *devc;
 351         struct sr_serial_dev_inst *serial;
 352
 353         if (sdi->status != SR_ST_ACTIVE)
 354                 return SR_ERR_DEV_CLOSED;
 355
 356         devc = sdi->priv;
 357
 358         sr_sw_limits_acquisition_start(&devc->limits);
 359         std_session_send_df_header(sdi, LOG_PREFIX);
 360
 361         devc->reply_pending = FALSE;
 362         devc->req_sent_at = 0;
 363         serial = sdi->conn;
 364         serial_source_add(sdi->session, serial, G_IO_IN,
 365                         KAXXXXP_POLL_INTERVAL_MS,
 366                         korad_kaxxxxp_receive_data, (void *)sdi);
 367
 368         return SR_OK;
 369 }
 370
 371 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 372 {
 373         if (sdi->status != SR_ST_ACTIVE)
 374                 return SR_ERR_DEV_CLOSED;
 375
 376         return std_serial_dev_acquisition_stop(sdi,
 377                 std_serial_dev_close, sdi->conn, LOG_PREFIX);
 378 }
 379
 380 static struct sr_dev_driver korad_kaxxxxp_driver_info = {
 381         .name = "korad-kaxxxxp",
 382         .longname = "Korad KAxxxxP",
 383         .api_version = 1,
 384         .init = std_init,
 385         .cleanup = std_cleanup,
 386         .scan = scan,
 387         .dev_list = std_dev_list,
 388         .config_get = config_get,
 389         .config_set = config_set,
 390         .config_list = config_list,
 391         .dev_open = std_serial_dev_open,
 392         .dev_close = std_serial_dev_close,
 393         .dev_acquisition_start = dev_acquisition_start,
 394         .dev_acquisition_stop = dev_acquisition_stop,
 395         .context = NULL,
 396 };
 397 SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);