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 dev_clear(const struct sr_dev_driver *di)
  79 {
  80         return std_dev_clear(di, NULL);
  81 }
  82
  83 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
  84 {
  85         return std_init(sr_ctx, di, LOG_PREFIX);
  86 }
  87
  88 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  89 {
  90         int i, model_id;
  91         struct drv_context *drvc;
  92         struct dev_context *devc;
  93         struct sr_dev_inst *sdi;
  94         struct sr_config *src;
  95         GSList *devices, *l;
  96         const char *conn, *serialcomm;
  97         struct sr_serial_dev_inst *serial;
  98         char reply[50], **tokens, *dummy;
  99
 100         drvc = di->context;
 101         drvc->instances = NULL;
 102         devices = NULL;
 103         conn = NULL;
 104         serialcomm = NULL;
 105         devc = NULL;
 106
 107         for (l = options; l; l = l->next) {
 108                 src = l->data;
 109                 switch (src->key) {
 110                 case SR_CONF_CONN:
 111                         conn = g_variant_get_string(src->data, NULL);
 112                         break;
 113                 case SR_CONF_SERIALCOMM:
 114                         serialcomm = g_variant_get_string(src->data, NULL);
 115                         break;
 116                 default:
 117                         sr_err("Unknown option %d, skipping.", src->key);
 118                         break;
 119                 }
 120         }
 121
 122         if (!conn)
 123                 return NULL;
 124         if (!serialcomm)
 125                 serialcomm = "9600/8n1";
 126
 127         serial = sr_serial_dev_inst_new(conn, serialcomm);
 128
 129         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 130                 return NULL;
 131
 132         serial_flush(serial);
 133
 134         sr_info("Probing serial port %s.", conn);
 135
 136         /* Get the device model. */
 137         memset(&reply, 0, sizeof(reply));
 138         if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
 139             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 140                 return NULL;
 141         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 142
 143         model_id = -1;
 144         for (i = 0; models[i].id != NULL; i++) {
 145                 if (!strcmp(models[i].id, tokens[0]))
 146                         model_id = i;
 147         }
 148         if (model_id < 0) {
 149                 sr_err("Unknown model ID '%s' detected, aborting.", tokens[0]);
 150                 g_strfreev(tokens);
 151                 return NULL;
 152         }
 153         g_strfreev(tokens);
 154
 155         /* Init device instance, etc. */
 156         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 157         sdi->status = SR_ST_INACTIVE;
 158         sdi->vendor = g_strdup("Manson");
 159         sdi->model = g_strdup(models[model_id].name);
 160         sdi->inst_type = SR_INST_SERIAL;
 161         sdi->conn = serial;
 162         sdi->driver = di;
 163
 164         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
 165
 166         devc = g_malloc0(sizeof(struct dev_context));
 167         devc->model = &models[model_id];
 168
 169         sdi->priv = devc;
 170
 171         /* Get current voltage, current, status. */
 172         if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
 173             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 174                 goto exit_err;
 175         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 176         if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
 177                 g_strfreev(tokens);
 178                 goto exit_err;
 179         }
 180         g_strfreev(tokens);
 181
 182         /* Get max. voltage and current. */
 183         if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
 184             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 185                 goto exit_err;
 186         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 187         devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
 188         tokens[0][3] = '\0';
 189         devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
 190         g_strfreev(tokens);
 191
 192         drvc->instances = g_slist_append(drvc->instances, sdi);
 193         devices = g_slist_append(devices, sdi);
 194
 195         serial_close(serial);
 196         if (!devices)
 197                 sr_serial_dev_inst_free(serial);
 198
 199         return devices;
 200
 201 exit_err:
 202         sr_dev_inst_free(sdi);
 203         g_free(devc);
 204
 205         return NULL;
 206 }
 207
 208 static GSList *dev_list(const struct sr_dev_driver *di)
 209 {
 210         return ((struct drv_context *)(di->context))->instances;
 211 }
 212
 213 static int cleanup(const struct sr_dev_driver *di)
 214 {
 215         return dev_clear(di);
 216 }
 217
 218 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 219                 const struct sr_channel_group *cg)
 220 {
 221         struct dev_context *devc;
 222
 223         (void)cg;
 224
 225         if (!sdi)
 226                 return SR_ERR_ARG;
 227
 228         devc = sdi->priv;
 229
 230         switch (key) {
 231         case SR_CONF_LIMIT_SAMPLES:
 232                 *data = g_variant_new_uint64(devc->limit_samples);
 233                 break;
 234         case SR_CONF_LIMIT_MSEC:
 235                 *data = g_variant_new_uint64(devc->limit_msec);
 236                 break;
 237         case SR_CONF_VOLTAGE:
 238                 *data = g_variant_new_double(devc->voltage);
 239                 break;
 240         case SR_CONF_VOLTAGE_TARGET:
 241                 *data = g_variant_new_double(devc->voltage_max);
 242                 break;
 243         case SR_CONF_CURRENT:
 244                 *data = g_variant_new_double(devc->current);
 245                 break;
 246         case SR_CONF_CURRENT_LIMIT:
 247                 *data = g_variant_new_double(devc->current_max);
 248                 break;
 249         case SR_CONF_ENABLED:
 250                 *data = g_variant_new_boolean(devc->output_enabled);
 251                 break;
 252         default:
 253                 return SR_ERR_NA;
 254         }
 255
 256         return SR_OK;
 257 }
 258
 259 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 260                 const struct sr_channel_group *cg)
 261 {
 262         struct dev_context *devc;
 263         gboolean bval;
 264         gdouble dval;
 265
 266         (void)cg;
 267
 268         if (sdi->status != SR_ST_ACTIVE)
 269                 return SR_ERR_DEV_CLOSED;
 270
 271         devc = sdi->priv;
 272
 273         switch (key) {
 274         case SR_CONF_LIMIT_MSEC:
 275                 if (g_variant_get_uint64(data) == 0)
 276                         return SR_ERR_ARG;
 277                 devc->limit_msec = g_variant_get_uint64(data);
 278                 break;
 279         case SR_CONF_LIMIT_SAMPLES:
 280                 if (g_variant_get_uint64(data) == 0)
 281                         return SR_ERR_ARG;
 282                 devc->limit_samples = g_variant_get_uint64(data);
 283                 break;
 284         case SR_CONF_VOLTAGE_TARGET:
 285                 dval = g_variant_get_double(data);
 286                 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
 287                         return SR_ERR_ARG;
 288
 289                 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
 290                         (dval / devc->model->voltage[2])) < 0) ||
 291                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 292                         return SR_ERR;
 293                 devc->voltage_max = dval;
 294                 break;
 295         case SR_CONF_CURRENT_LIMIT:
 296                 dval = g_variant_get_double(data);
 297                 if (dval < devc->model->current[0] || dval > devc->current_max_device)
 298                         return SR_ERR_ARG;
 299
 300                 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
 301                         (dval / devc->model->current[2])) < 0) ||
 302                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 303                         return SR_ERR;
 304                 devc->current_max = dval;
 305                 break;
 306         case SR_CONF_ENABLED:
 307                 bval = g_variant_get_boolean(data);
 308                 if (bval == devc->output_enabled) /* Nothing to do. */
 309                         break;
 310                 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
 311                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 312                         return SR_ERR;
 313                 devc->output_enabled = bval;
 314                 break;
 315         default:
 316                 return SR_ERR_NA;
 317         }
 318
 319         return SR_OK;
 320 }
 321
 322 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 323                 const struct sr_channel_group *cg)
 324 {
 325         struct dev_context *devc;
 326         GVariant *gvar;
 327         GVariantBuilder gvb;
 328         double dval;
 329         int idx;
 330
 331         (void)cg;
 332
 333         /* Always available (with or without sdi). */
 334         if (key == SR_CONF_SCAN_OPTIONS) {
 335                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 336                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 337                 return SR_OK;
 338         }
 339
 340         /* Return drvopts without sdi (and devopts with sdi, see below). */
 341         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 342                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 343                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 344                 return SR_OK;
 345         }
 346
 347         /* Every other key needs an sdi. */
 348         if (!sdi)
 349                 return SR_ERR_ARG;
 350         devc = sdi->priv;
 351
 352         switch (key) {
 353         case SR_CONF_DEVICE_OPTIONS:
 354                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 355                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 356                 break;
 357         case SR_CONF_VOLTAGE_TARGET:
 358                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 359                 /* Min, max, step. */
 360                 for (idx = 0; idx < 3; idx++) {
 361                         if (idx == 1)
 362                                 dval = devc->voltage_max_device;
 363                         else
 364                                 dval = devc->model->voltage[idx];
 365                         gvar = g_variant_new_double(dval);
 366                         g_variant_builder_add_value(&gvb, gvar);
 367                 }
 368                 *data = g_variant_builder_end(&gvb);
 369                 break;
 370         case SR_CONF_CURRENT_LIMIT:
 371                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 372                 /* Min, max, step. */
 373                 for (idx = 0; idx < 3; idx++) {
 374                         if (idx == 1)
 375                                 dval = devc->current_max_device;
 376                         else
 377                                 dval = devc->model->current[idx];
 378                         gvar = g_variant_new_double(dval);
 379                         g_variant_builder_add_value(&gvb, gvar);
 380                 }
 381                 *data = g_variant_builder_end(&gvb);
 382                 break;
 383         default:
 384                 return SR_ERR_NA;
 385         }
 386
 387         return SR_OK;
 388 }
 389
 390 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 391 {
 392         struct dev_context *devc;
 393         struct sr_serial_dev_inst *serial;
 394
 395         if (sdi->status != SR_ST_ACTIVE)
 396                 return SR_ERR_DEV_CLOSED;
 397
 398         devc = sdi->priv;
 399
 400         std_session_send_df_header(sdi, LOG_PREFIX);
 401
 402         devc->starttime = g_get_monotonic_time();
 403         devc->num_samples = 0;
 404         devc->reply_pending = FALSE;
 405         devc->req_sent_at = 0;
 406
 407         /* Poll every 10ms, or whenever some data comes in. */
 408         serial = sdi->conn;
 409         serial_source_add(sdi->session, serial, G_IO_IN, 10,
 410                         hcs_receive_data, (void *)sdi);
 411
 412         return SR_OK;
 413 }
 414
 415 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 416 {
 417         return std_serial_dev_acquisition_stop(sdi,
 418                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 419 }
 420
 421 SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info = {
 422         .name = "manson-hcs-3xxx",
 423         .longname = "Manson HCS-3xxx",
 424         .api_version = 1,
 425         .init = init,
 426         .cleanup = cleanup,
 427         .scan = scan,
 428         .dev_list = dev_list,
 429         .dev_clear = dev_clear,
 430         .config_get = config_get,
 431         .config_set = config_set,
 432         .config_list = config_list,
 433         .dev_open = std_serial_dev_open,
 434         .dev_close = std_serial_dev_close,
 435         .dev_acquisition_start = dev_acquisition_start,
 436         .dev_acquisition_stop = dev_acquisition_stop,
 437         .context = NULL,
 438 };