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