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