src/hardware/manson-hcs-3xxx/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
   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 2 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, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  */
  21
  22 /** @file
  23   *  <em>Manson HCS-3xxx series</em> power supply driver
  24   *  @internal
  25   */
  26
  27 #include <config.h>
  28 #include "protocol.h"
  29
  30 static const uint32_t drvopts[] = {
  31         /* Device class */
  32         SR_CONF_POWER_SUPPLY,
  33 };
  34
  35 static const uint32_t scanopts[] = {
  36         SR_CONF_CONN,
  37         SR_CONF_SERIALCOMM,
  38 };
  39
  40 static const uint32_t devopts[] = {
  41         /* Device class */
  42         SR_CONF_POWER_SUPPLY,
  43         /* Acquisition modes. */
  44         SR_CONF_CONTINUOUS,
  45         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  46         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  47         /* Device configuration */
  48         SR_CONF_VOLTAGE | SR_CONF_GET,
  49         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  50         SR_CONF_CURRENT | SR_CONF_GET,
  51         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  52         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  53 };
  54
  55 /* Note: All models have one power supply output only. */
  56 static const struct hcs_model models[] = {
  57         { MANSON_HCS_3100, "HCS-3100",     "3100", { 1, 18, 0.1 }, { 0, 10,   0.10 } },
  58         { MANSON_HCS_3102, "HCS-3102",     "3102", { 1, 36, 0.1 }, { 0,  5,   0.01 } },
  59         { MANSON_HCS_3104, "HCS-3104",     "3104", { 1, 60, 0.1 }, { 0,  2.5, 0.01 } },
  60         { MANSON_HCS_3150, "HCS-3150",     "3150", { 1, 18, 0.1 }, { 0, 15,   0.10 } },
  61         { MANSON_HCS_3200, "HCS-3200",     "3200", { 1, 18, 0.1 }, { 0, 20,   0.10 } },
  62         { MANSON_HCS_3202, "HCS-3202",     "3202", { 1, 36, 0.1 }, { 0, 10,   0.10 } },
  63         { MANSON_HCS_3204, "HCS-3204",     "3204", { 1, 60, 0.1 }, { 0,  5,   0.01 } },
  64         { MANSON_HCS_3300, "HCS-3300-USB", "3300", { 1, 16, 0.1 }, { 0, 30,   0.10 } },
  65         { MANSON_HCS_3302, "HCS-3302-USB", "3302", { 1, 32, 0.1 }, { 0, 15,   0.10 } },
  66         { MANSON_HCS_3304, "HCS-3304-USB", "3304", { 1, 60, 0.1 }, { 0,  8,   0.10 } },
  67         { MANSON_HCS_3400, "HCS-3400-USB", "3400", { 1, 16, 0.1 }, { 0, 40,   0.10 } },
  68         { MANSON_HCS_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20,   0.10 } },
  69         { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10,   0.10 } },
  70         { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60,   0.10 } },
  71         { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30,   0.10 } },
  72         { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15,   0.10 } },
  73         ALL_ZERO
  74 };
  75
  76 SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info;
  77
  78 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  79 {
  80         return std_init(di, sr_ctx, LOG_PREFIX);
  81 }
  82
  83 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  84 {
  85         int i, model_id;
  86         struct drv_context *drvc;
  87         struct dev_context *devc;
  88         struct sr_dev_inst *sdi;
  89         struct sr_config *src;
  90         GSList *devices, *l;
  91         const char *conn, *serialcomm;
  92         struct sr_serial_dev_inst *serial;
  93         char reply[50], **tokens, *dummy;
  94
  95         drvc = di->context;
  96         drvc->instances = NULL;
  97         devices = NULL;
  98         conn = NULL;
  99         serialcomm = NULL;
 100         devc = NULL;
 101
 102         for (l = options; l; l = l->next) {
 103                 src = l->data;
 104                 switch (src->key) {
 105                 case SR_CONF_CONN:
 106                         conn = g_variant_get_string(src->data, NULL);
 107                         break;
 108                 case SR_CONF_SERIALCOMM:
 109                         serialcomm = g_variant_get_string(src->data, NULL);
 110                         break;
 111                 default:
 112                         sr_err("Unknown option %d, skipping.", src->key);
 113                         break;
 114                 }
 115         }
 116
 117         if (!conn)
 118                 return NULL;
 119         if (!serialcomm)
 120                 serialcomm = "9600/8n1";
 121
 122         serial = sr_serial_dev_inst_new(conn, serialcomm);
 123
 124         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 125                 return NULL;
 126
 127         serial_flush(serial);
 128
 129         sr_info("Probing serial port %s.", conn);
 130
 131         /* Get the device model. */
 132         memset(&reply, 0, sizeof(reply));
 133         if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
 134             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 135                 return NULL;
 136         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 137
 138         model_id = -1;
 139         for (i = 0; models[i].id != NULL; i++) {
 140                 if (!strcmp(models[i].id, tokens[0]))
 141                         model_id = i;
 142         }
 143         if (model_id < 0) {
 144                 sr_err("Unknown model ID '%s' detected, aborting.", tokens[0]);
 145                 g_strfreev(tokens);
 146                 return NULL;
 147         }
 148         g_strfreev(tokens);
 149
 150         /* Init device instance, etc. */
 151         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 152         sdi->status = SR_ST_INACTIVE;
 153         sdi->vendor = g_strdup("Manson");
 154         sdi->model = g_strdup(models[model_id].name);
 155         sdi->inst_type = SR_INST_SERIAL;
 156         sdi->conn = serial;
 157         sdi->driver = di;
 158
 159         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
 160
 161         devc = g_malloc0(sizeof(struct dev_context));
 162         sr_sw_limits_init(&devc->limits);
 163         devc->model = &models[model_id];
 164
 165         sdi->priv = devc;
 166
 167         /* Get current voltage, current, status. */
 168         if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
 169             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 170                 goto exit_err;
 171         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 172         if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
 173                 g_strfreev(tokens);
 174                 goto exit_err;
 175         }
 176         g_strfreev(tokens);
 177
 178         /* Get max. voltage and current. */
 179         if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
 180             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 181                 goto exit_err;
 182         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 183         devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
 184         tokens[0][3] = '\0';
 185         devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
 186         g_strfreev(tokens);
 187
 188         drvc->instances = g_slist_append(drvc->instances, sdi);
 189         devices = g_slist_append(devices, sdi);
 190
 191         serial_close(serial);
 192         if (!devices)
 193                 sr_serial_dev_inst_free(serial);
 194
 195         return devices;
 196
 197 exit_err:
 198         sr_dev_inst_free(sdi);
 199         g_free(devc);
 200
 201         return NULL;
 202 }
 203
 204 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 205                 const struct sr_channel_group *cg)
 206 {
 207         struct dev_context *devc;
 208
 209         (void)cg;
 210
 211         if (!sdi)
 212                 return SR_ERR_ARG;
 213
 214         devc = sdi->priv;
 215
 216         switch (key) {
 217         case SR_CONF_LIMIT_SAMPLES:
 218         case SR_CONF_LIMIT_MSEC:
 219                 return sr_sw_limits_config_get(&devc->limits, key, data);
 220         case SR_CONF_VOLTAGE:
 221                 *data = g_variant_new_double(devc->voltage);
 222                 break;
 223         case SR_CONF_VOLTAGE_TARGET:
 224                 *data = g_variant_new_double(devc->voltage_max);
 225                 break;
 226         case SR_CONF_CURRENT:
 227                 *data = g_variant_new_double(devc->current);
 228                 break;
 229         case SR_CONF_CURRENT_LIMIT:
 230                 *data = g_variant_new_double(devc->current_max);
 231                 break;
 232         case SR_CONF_ENABLED:
 233                 *data = g_variant_new_boolean(devc->output_enabled);
 234                 break;
 235         default:
 236                 return SR_ERR_NA;
 237         }
 238
 239         return SR_OK;
 240 }
 241
 242 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 243                 const struct sr_channel_group *cg)
 244 {
 245         struct dev_context *devc;
 246         gboolean bval;
 247         gdouble dval;
 248
 249         (void)cg;
 250
 251         if (sdi->status != SR_ST_ACTIVE)
 252                 return SR_ERR_DEV_CLOSED;
 253
 254         devc = sdi->priv;
 255
 256         switch (key) {
 257         case SR_CONF_LIMIT_MSEC:
 258                 return sr_sw_limits_config_set(&devc->limits, key, data);
 259         case SR_CONF_VOLTAGE_TARGET:
 260                 dval = g_variant_get_double(data);
 261                 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
 262                         return SR_ERR_ARG;
 263
 264                 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
 265                         (dval / devc->model->voltage[2])) < 0) ||
 266                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 267                         return SR_ERR;
 268                 devc->voltage_max = dval;
 269                 break;
 270         case SR_CONF_CURRENT_LIMIT:
 271                 dval = g_variant_get_double(data);
 272                 if (dval < devc->model->current[0] || dval > devc->current_max_device)
 273                         return SR_ERR_ARG;
 274
 275                 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
 276                         (dval / devc->model->current[2])) < 0) ||
 277                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 278                         return SR_ERR;
 279                 devc->current_max = dval;
 280                 break;
 281         case SR_CONF_ENABLED:
 282                 bval = g_variant_get_boolean(data);
 283                 if (bval == devc->output_enabled) /* Nothing to do. */
 284                         break;
 285                 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
 286                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 287                         return SR_ERR;
 288                 devc->output_enabled = bval;
 289                 break;
 290         default:
 291                 return SR_ERR_NA;
 292         }
 293
 294         return SR_OK;
 295 }
 296
 297 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 298                 const struct sr_channel_group *cg)
 299 {
 300         struct dev_context *devc;
 301         GVariant *gvar;
 302         GVariantBuilder gvb;
 303         double dval;
 304         int idx;
 305
 306         (void)cg;
 307
 308         /* Always available (with or without sdi). */
 309         if (key == SR_CONF_SCAN_OPTIONS) {
 310                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 311                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 312                 return SR_OK;
 313         }
 314
 315         /* Return drvopts without sdi (and devopts with sdi, see below). */
 316         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 317                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 318                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 319                 return SR_OK;
 320         }
 321
 322         /* Every other key needs an sdi. */
 323         if (!sdi)
 324                 return SR_ERR_ARG;
 325         devc = sdi->priv;
 326
 327         switch (key) {
 328         case SR_CONF_DEVICE_OPTIONS:
 329                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 330                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 331                 break;
 332         case SR_CONF_VOLTAGE_TARGET:
 333                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 334                 /* Min, max, step. */
 335                 for (idx = 0; idx < 3; idx++) {
 336                         if (idx == 1)
 337                                 dval = devc->voltage_max_device;
 338                         else
 339                                 dval = devc->model->voltage[idx];
 340                         gvar = g_variant_new_double(dval);
 341                         g_variant_builder_add_value(&gvb, gvar);
 342                 }
 343                 *data = g_variant_builder_end(&gvb);
 344                 break;
 345         case SR_CONF_CURRENT_LIMIT:
 346                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 347                 /* Min, max, step. */
 348                 for (idx = 0; idx < 3; idx++) {
 349                         if (idx == 1)
 350                                 dval = devc->current_max_device;
 351                         else
 352                                 dval = devc->model->current[idx];
 353                         gvar = g_variant_new_double(dval);
 354                         g_variant_builder_add_value(&gvb, gvar);
 355                 }
 356                 *data = g_variant_builder_end(&gvb);
 357                 break;
 358         default:
 359                 return SR_ERR_NA;
 360         }
 361
 362         return SR_OK;
 363 }
 364
 365 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 366 {
 367         struct dev_context *devc;
 368         struct sr_serial_dev_inst *serial;
 369
 370         if (sdi->status != SR_ST_ACTIVE)
 371                 return SR_ERR_DEV_CLOSED;
 372
 373         devc = sdi->priv;
 374
 375         sr_sw_limits_acquisition_start(&devc->limits);
 376         std_session_send_df_header(sdi, LOG_PREFIX);
 377
 378         devc->reply_pending = FALSE;
 379         devc->req_sent_at = 0;
 380
 381         /* Poll every 10ms, or whenever some data comes in. */
 382         serial = sdi->conn;
 383         serial_source_add(sdi->session, serial, G_IO_IN, 10,
 384                         hcs_receive_data, (void *)sdi);
 385
 386         return SR_OK;
 387 }
 388
 389 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 390 {
 391         return std_serial_dev_acquisition_stop(sdi,
 392                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 393 }
 394
 395 SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info = {
 396         .name = "manson-hcs-3xxx",
 397         .longname = "Manson HCS-3xxx",
 398         .api_version = 1,
 399         .init = init,
 400         .cleanup = std_cleanup,
 401         .scan = scan,
 402         .dev_list = std_dev_list,
 403         .config_get = config_get,
 404         .config_set = config_set,
 405         .config_list = config_list,
 406         .dev_open = std_serial_dev_open,
 407         .dev_close = std_serial_dev_close,
 408         .dev_acquisition_start = dev_acquisition_start,
 409         .dev_acquisition_stop = dev_acquisition_stop,
 410         .context = NULL,
 411 };