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 /**
  23  * @file
  24  *
  25  * <em>Manson HCS-3xxx series</em> power supply driver
  26  *
  27  * @internal
  28  */
  29
  30 #include <config.h>
  31 #include "protocol.h"
  32
  33 static const uint32_t drvopts[] = {
  34         /* Device class */
  35         SR_CONF_POWER_SUPPLY,
  36 };
  37
  38 static const uint32_t scanopts[] = {
  39         SR_CONF_CONN,
  40         SR_CONF_SERIALCOMM,
  41 };
  42
  43 static const uint32_t devopts[] = {
  44         /* Device class */
  45         SR_CONF_POWER_SUPPLY,
  46         /* Acquisition modes. */
  47         SR_CONF_CONTINUOUS,
  48         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  49         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  50         /* Device configuration */
  51         SR_CONF_VOLTAGE | SR_CONF_GET,
  52         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  53         SR_CONF_CURRENT | SR_CONF_GET,
  54         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  55         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  56 };
  57
  58 /* Note: All models have one power supply output only. */
  59 static const struct hcs_model models[] = {
  60         { MANSON_HCS_3100, "HCS-3100",     "3100", { 1, 18, 0.1 }, { 0, 10,   0.10 } },
  61         { MANSON_HCS_3102, "HCS-3102",     "3102", { 1, 36, 0.1 }, { 0,  5,   0.01 } },
  62         { MANSON_HCS_3104, "HCS-3104",     "3104", { 1, 60, 0.1 }, { 0,  2.5, 0.01 } },
  63         { MANSON_HCS_3150, "HCS-3150",     "3150", { 1, 18, 0.1 }, { 0, 15,   0.10 } },
  64         { MANSON_HCS_3200, "HCS-3200",     "3200", { 1, 18, 0.1 }, { 0, 20,   0.10 } },
  65         { MANSON_HCS_3202, "HCS-3202",     "3202", { 1, 36, 0.1 }, { 0, 10,   0.10 } },
  66         { MANSON_HCS_3204, "HCS-3204",     "3204", { 1, 60, 0.1 }, { 0,  5,   0.01 } },
  67         { MANSON_HCS_3300, "HCS-3300-USB", "3300", { 1, 16, 0.1 }, { 0, 30,   0.10 } },
  68         { MANSON_HCS_3302, "HCS-3302-USB", "3302", { 1, 32, 0.1 }, { 0, 15,   0.10 } },
  69         { MANSON_HCS_3304, "HCS-3304-USB", "3304", { 1, 60, 0.1 }, { 0,  8,   0.10 } },
  70         { MANSON_HCS_3400, "HCS-3400-USB", "3400", { 1, 16, 0.1 }, { 0, 40,   0.10 } },
  71         { MANSON_HCS_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20,   0.10 } },
  72         { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10,   0.10 } },
  73         { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60,   0.10 } },
  74         { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30,   0.10 } },
  75         { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15,   0.10 } },
  76         ALL_ZERO
  77 };
  78
  79 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  80 {
  81         int i, model_id;
  82         struct dev_context *devc;
  83         struct sr_dev_inst *sdi;
  84         struct sr_config *src;
  85         GSList *l;
  86         const char *conn, *serialcomm;
  87         struct sr_serial_dev_inst *serial;
  88         char reply[50], **tokens, *dummy;
  89
  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
 150         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
 151
 152         devc = g_malloc0(sizeof(struct dev_context));
 153         sr_sw_limits_init(&devc->limits);
 154         devc->model = &models[model_id];
 155
 156         sdi->priv = devc;
 157
 158         /* Get current voltage, current, status. */
 159         if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
 160             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 161                 goto exit_err;
 162         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 163         if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
 164                 g_strfreev(tokens);
 165                 goto exit_err;
 166         }
 167         g_strfreev(tokens);
 168
 169         /* Get max. voltage and current. */
 170         if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
 171             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 172                 goto exit_err;
 173         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 174         devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
 175         tokens[0][3] = '\0';
 176         devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
 177         g_strfreev(tokens);
 178
 179         serial_close(serial);
 180
 181         return std_scan_complete(di, g_slist_append(NULL, sdi));
 182
 183 exit_err:
 184         sr_dev_inst_free(sdi);
 185         g_free(devc);
 186
 187         return NULL;
 188 }
 189
 190 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 191                 const struct sr_channel_group *cg)
 192 {
 193         struct dev_context *devc;
 194
 195         (void)cg;
 196
 197         if (!sdi)
 198                 return SR_ERR_ARG;
 199
 200         devc = sdi->priv;
 201
 202         switch (key) {
 203         case SR_CONF_LIMIT_SAMPLES:
 204         case SR_CONF_LIMIT_MSEC:
 205                 return sr_sw_limits_config_get(&devc->limits, key, data);
 206         case SR_CONF_VOLTAGE:
 207                 *data = g_variant_new_double(devc->voltage);
 208                 break;
 209         case SR_CONF_VOLTAGE_TARGET:
 210                 *data = g_variant_new_double(devc->voltage_max);
 211                 break;
 212         case SR_CONF_CURRENT:
 213                 *data = g_variant_new_double(devc->current);
 214                 break;
 215         case SR_CONF_CURRENT_LIMIT:
 216                 *data = g_variant_new_double(devc->current_max);
 217                 break;
 218         case SR_CONF_ENABLED:
 219                 *data = g_variant_new_boolean(devc->output_enabled);
 220                 break;
 221         default:
 222                 return SR_ERR_NA;
 223         }
 224
 225         return SR_OK;
 226 }
 227
 228 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 229                 const struct sr_channel_group *cg)
 230 {
 231         struct dev_context *devc;
 232         gboolean bval;
 233         gdouble dval;
 234
 235         (void)cg;
 236
 237         if (sdi->status != SR_ST_ACTIVE)
 238                 return SR_ERR_DEV_CLOSED;
 239
 240         devc = sdi->priv;
 241
 242         switch (key) {
 243         case SR_CONF_LIMIT_MSEC:
 244         case SR_CONF_LIMIT_SAMPLES:
 245                 return sr_sw_limits_config_set(&devc->limits, key, data);
 246         case SR_CONF_VOLTAGE_TARGET:
 247                 dval = g_variant_get_double(data);
 248                 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
 249                         return SR_ERR_ARG;
 250
 251                 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
 252                         (dval / devc->model->voltage[2])) < 0) ||
 253                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 254                         return SR_ERR;
 255                 devc->voltage_max = dval;
 256                 break;
 257         case SR_CONF_CURRENT_LIMIT:
 258                 dval = g_variant_get_double(data);
 259                 if (dval < devc->model->current[0] || dval > devc->current_max_device)
 260                         return SR_ERR_ARG;
 261
 262                 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
 263                         (dval / devc->model->current[2])) < 0) ||
 264                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 265                         return SR_ERR;
 266                 devc->current_max = dval;
 267                 break;
 268         case SR_CONF_ENABLED:
 269                 bval = g_variant_get_boolean(data);
 270                 if (bval == devc->output_enabled) /* Nothing to do. */
 271                         break;
 272                 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
 273                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 274                         return SR_ERR;
 275                 devc->output_enabled = bval;
 276                 break;
 277         default:
 278                 return SR_ERR_NA;
 279         }
 280
 281         return SR_OK;
 282 }
 283
 284 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 285                 const struct sr_channel_group *cg)
 286 {
 287         struct dev_context *devc;
 288         GVariant *gvar;
 289         GVariantBuilder gvb;
 290         double dval;
 291         int idx;
 292
 293         (void)cg;
 294
 295         /* Always available (with or without sdi). */
 296         if (key == SR_CONF_SCAN_OPTIONS) {
 297                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 298                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 299                 return SR_OK;
 300         }
 301
 302         /* Return drvopts without sdi (and devopts with sdi, see below). */
 303         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 304                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 305                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 306                 return SR_OK;
 307         }
 308
 309         /* Every other key needs an sdi. */
 310         if (!sdi)
 311                 return SR_ERR_ARG;
 312         devc = sdi->priv;
 313
 314         switch (key) {
 315         case SR_CONF_DEVICE_OPTIONS:
 316                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 317                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 318                 break;
 319         case SR_CONF_VOLTAGE_TARGET:
 320                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 321                 /* Min, max, step. */
 322                 for (idx = 0; idx < 3; idx++) {
 323                         if (idx == 1)
 324                                 dval = devc->voltage_max_device;
 325                         else
 326                                 dval = devc->model->voltage[idx];
 327                         gvar = g_variant_new_double(dval);
 328                         g_variant_builder_add_value(&gvb, gvar);
 329                 }
 330                 *data = g_variant_builder_end(&gvb);
 331                 break;
 332         case SR_CONF_CURRENT_LIMIT:
 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->current_max_device;
 338                         else
 339                                 dval = devc->model->current[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         default:
 346                 return SR_ERR_NA;
 347         }
 348
 349         return SR_OK;
 350 }
 351
 352 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 353 {
 354         struct dev_context *devc;
 355         struct sr_serial_dev_inst *serial;
 356
 357         if (sdi->status != SR_ST_ACTIVE)
 358                 return SR_ERR_DEV_CLOSED;
 359
 360         devc = sdi->priv;
 361
 362         sr_sw_limits_acquisition_start(&devc->limits);
 363         std_session_send_df_header(sdi);
 364
 365         devc->reply_pending = FALSE;
 366         devc->req_sent_at = 0;
 367
 368         /* Poll every 10ms, or whenever some data comes in. */
 369         serial = sdi->conn;
 370         serial_source_add(sdi->session, serial, G_IO_IN, 10,
 371                         hcs_receive_data, (void *)sdi);
 372
 373         return SR_OK;
 374 }
 375
 376 static struct sr_dev_driver manson_hcs_3xxx_driver_info = {
 377         .name = "manson-hcs-3xxx",
 378         .longname = "Manson HCS-3xxx",
 379         .api_version = 1,
 380         .init = std_init,
 381         .cleanup = std_cleanup,
 382         .scan = scan,
 383         .dev_list = std_dev_list,
 384         .config_get = config_get,
 385         .config_set = config_set,
 386         .config_list = config_list,
 387         .dev_open = std_serial_dev_open,
 388         .dev_close = std_serial_dev_close,
 389         .dev_acquisition_start = dev_acquisition_start,
 390         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 391         .context = NULL,
 392 };
 393 SR_REGISTER_DEV_DRIVER(manson_hcs_3xxx_driver_info);