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