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 scanopts[] = {
  24         SR_CONF_CONN,
  25         SR_CONF_SERIALCOMM,
  26 };
  27
  28 static const uint32_t drvopts[] = {
  29         /* Device class */
  30         SR_CONF_POWER_SUPPLY,
  31 };
  32
  33 static const uint32_t devopts[] = {
  34         /* Device class */
  35         /* Acquisition modes. */
  36         SR_CONF_CONTINUOUS,
  37         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  38         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  39         /* Device configuration */
  40         SR_CONF_VOLTAGE | SR_CONF_GET,
  41         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  42         SR_CONF_CURRENT | SR_CONF_GET,
  43         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  44         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  45         SR_CONF_REGULATION | SR_CONF_GET,
  46         SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  47         SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
  48 };
  49
  50 static const struct korad_kaxxxxp_model models[] = {
  51         /* Device enum, vendor, model, ID reply, channels, voltage, current */
  52         {VELLEMAN_PS3005D, "Velleman", "PS3005D",
  53                 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
  54         {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
  55                 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
  56         {KORAD_KA3005P, "Korad", "KA3005P",
  57                 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5, 0.001}},
  58         /* Sometimes the KA3005P has an extra 0x01 after the ID. */
  59         {KORAD_KA3005P_0X01, "Korad", "KA3005P",
  60                 "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5, 0.001}},
  61         ALL_ZERO
  62 };
  63
  64 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  65 {
  66         struct dev_context *devc;
  67         GSList *l;
  68         struct sr_dev_inst *sdi;
  69         struct sr_config *src;
  70         const char *conn, *serialcomm;
  71         struct sr_serial_dev_inst *serial;
  72         char reply[50];
  73         int i, model_id;
  74         unsigned int len;
  75
  76         conn = NULL;
  77         serialcomm = NULL;
  78
  79         for (l = options; l; l = l->next) {
  80                 src = l->data;
  81                 switch (src->key) {
  82                 case SR_CONF_CONN:
  83                         conn = g_variant_get_string(src->data, NULL);
  84                         break;
  85                 case SR_CONF_SERIALCOMM:
  86                         serialcomm = g_variant_get_string(src->data, NULL);
  87                         break;
  88                 default:
  89                         sr_err("Unknown option %d, skipping.", src->key);
  90                         break;
  91                 }
  92         }
  93
  94         if (!conn)
  95                 return NULL;
  96         if (!serialcomm)
  97                 serialcomm = "9600/8n1";
  98
  99         serial = sr_serial_dev_inst_new(conn, serialcomm);
 100         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 101                 return NULL;
 102
 103         serial_flush(serial);
 104
 105         /* Get the device model. */
 106         len = 0;
 107         for (i = 0; models[i].id; i++) {
 108                 if (strlen(models[i].id) > len)
 109                         len = strlen(models[i].id);
 110         }
 111         memset(&reply, 0, sizeof(reply));
 112         sr_dbg("Want max %d bytes.", len);
 113         if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
 114                 return NULL;
 115
 116         /* i is used here for debug purposes only. */
 117         if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
 118                 return NULL;
 119         sr_dbg("Received: %d, %s", i, reply);
 120         model_id = -1;
 121         for (i = 0; models[i].id; i++) {
 122                 if (!strcmp(models[i].id, reply))
 123                         model_id = i;
 124         }
 125         if (model_id < 0) {
 126                 sr_err("Unknown model ID '%s' detected, aborting.", reply);
 127                 return NULL;
 128         }
 129         sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
 130                 models[model_id].name, model_id, models[model_id].id);
 131
 132         /* Init device instance, etc. */
 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, "CH1");
 141
 142         devc = g_malloc0(sizeof(struct dev_context));
 143         sr_sw_limits_init(&devc->limits);
 144         devc->model = &models[model_id];
 145         devc->reply[5] = 0;
 146         devc->req_sent_at = 0;
 147         sdi->priv = devc;
 148
 149         /* Get current status of device. */
 150         if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
 151                 goto exit_err;
 152
 153         serial_close(serial);
 154
 155         return std_scan_complete(di, g_slist_append(NULL, sdi));
 156
 157 exit_err:
 158         sr_dev_inst_free(sdi);
 159         g_free(devc);
 160         sr_dbg("Scan failed.");
 161
 162         return NULL;
 163 }
 164
 165 static int config_get(uint32_t key, GVariant **data,
 166         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 167 {
 168         struct dev_context *devc;
 169
 170         (void)cg;
 171
 172         if (!sdi || !data)
 173                 return SR_ERR_ARG;
 174
 175         devc = sdi->priv;
 176
 177         switch (key) {
 178         case SR_CONF_LIMIT_SAMPLES:
 179         case SR_CONF_LIMIT_MSEC:
 180                 return sr_sw_limits_config_get(&devc->limits, key, data);
 181         case SR_CONF_VOLTAGE:
 182                 *data = g_variant_new_double(devc->voltage);
 183                 break;
 184         case SR_CONF_VOLTAGE_TARGET:
 185                 *data = g_variant_new_double(devc->voltage_max);
 186                 break;
 187         case SR_CONF_CURRENT:
 188                 *data = g_variant_new_double(devc->current);
 189                 break;
 190         case SR_CONF_CURRENT_LIMIT:
 191                 *data = g_variant_new_double(devc->current_max);
 192                 break;
 193         case SR_CONF_ENABLED:
 194                 *data = g_variant_new_boolean(devc->output_enabled);
 195                 break;
 196         case SR_CONF_REGULATION:
 197                 /* Dual channel not supported. */
 198                 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
 199                 break;
 200         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 201                 *data = g_variant_new_boolean(devc->ocp_enabled);
 202                 break;
 203         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 204                 *data = g_variant_new_boolean(devc->ovp_enabled);
 205                 break;
 206         default:
 207                 return SR_ERR_NA;
 208         }
 209
 210         return SR_OK;
 211 }
 212
 213 static int config_set(uint32_t key, GVariant *data,
 214         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 215 {
 216         struct dev_context *devc;
 217         double dval;
 218         gboolean bval;
 219
 220         (void)cg;
 221
 222         devc = sdi->priv;
 223
 224         switch (key) {
 225         case SR_CONF_LIMIT_MSEC:
 226         case SR_CONF_LIMIT_SAMPLES:
 227                 return sr_sw_limits_config_set(&devc->limits, key, data);
 228         case SR_CONF_VOLTAGE_TARGET:
 229                 dval = g_variant_get_double(data);
 230                 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
 231                         return SR_ERR_ARG;
 232                 devc->voltage_max = dval;
 233                 devc->target = KAXXXXP_VOLTAGE_MAX;
 234                 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
 235                         return SR_ERR;
 236                 break;
 237         case SR_CONF_CURRENT_LIMIT:
 238                 dval = g_variant_get_double(data);
 239                 if (dval < devc->model->current[0] || dval > devc->model->current[1])
 240                         return SR_ERR_ARG;
 241                 devc->current_max = dval;
 242                 devc->target = KAXXXXP_CURRENT_MAX;
 243                 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
 244                         return SR_ERR;
 245                 break;
 246         case SR_CONF_ENABLED:
 247                 bval = g_variant_get_boolean(data);
 248                 /* Set always so it is possible turn off with sigrok-cli. */
 249                 devc->output_enabled = bval;
 250                 devc->target = KAXXXXP_OUTPUT;
 251                 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
 252                         return SR_ERR;
 253                 break;
 254         case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
 255                 bval = g_variant_get_boolean(data);
 256                 devc->ocp_enabled = bval;
 257                 devc->target = KAXXXXP_OCP;
 258                 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
 259                         return SR_ERR;
 260                 break;
 261         case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
 262                 bval = g_variant_get_boolean(data);
 263                 devc->ovp_enabled = bval;
 264                 devc->target = KAXXXXP_OVP;
 265                 if (korad_kaxxxxp_set_value(sdi->conn, devc) < 0)
 266                         return SR_ERR;
 267                 break;
 268         default:
 269                 return SR_ERR_NA;
 270         }
 271
 272         return SR_OK;
 273 }
 274
 275 static int config_list(uint32_t key, GVariant **data,
 276         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 277 {
 278         struct dev_context *devc;
 279         GVariant *gvar;
 280         GVariantBuilder gvb;
 281         double dval;
 282         int idx;
 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                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 292                 /* Min, max, step. */
 293                 for (idx = 0; idx < 3; idx++) {
 294                         dval = devc->model->voltage[idx];
 295                         gvar = g_variant_new_double(dval);
 296                         g_variant_builder_add_value(&gvb, gvar);
 297                 }
 298                 *data = g_variant_builder_end(&gvb);
 299                 break;
 300         case SR_CONF_CURRENT_LIMIT:
 301                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 302                 /* Min, max, step. */
 303                 for (idx = 0; idx < 3; idx++) {
 304                         dval = devc->model->current[idx];
 305                         gvar = g_variant_new_double(dval);
 306                         g_variant_builder_add_value(&gvb, gvar);
 307                 }
 308                 *data = g_variant_builder_end(&gvb);
 309                 break;
 310         default:
 311                 return SR_ERR_NA;
 312         }
 313
 314         return SR_OK;
 315 }
 316
 317 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 318 {
 319         struct dev_context *devc;
 320         struct sr_serial_dev_inst *serial;
 321
 322         devc = sdi->priv;
 323
 324         sr_sw_limits_acquisition_start(&devc->limits);
 325         std_session_send_df_header(sdi);
 326
 327         devc->reply_pending = FALSE;
 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 = std_serial_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);