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, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 /**
  22  * @file
  23  *
  24  * <em>Manson HCS-3xxx series</em> power supply driver
  25  *
  26  * @internal
  27  */
  28
  29 #include <config.h>
  30 #include "protocol.h"
  31
  32 static const uint32_t drvopts[] = {
  33         /* Device class */
  34         SR_CONF_POWER_SUPPLY,
  35 };
  36
  37 static const uint32_t scanopts[] = {
  38         SR_CONF_CONN,
  39         SR_CONF_SERIALCOMM,
  40 };
  41
  42 static const uint32_t devopts[] = {
  43         /* Device class */
  44         SR_CONF_POWER_SUPPLY,
  45         /* Acquisition modes. */
  46         SR_CONF_CONTINUOUS,
  47         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  48         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  49         /* Device configuration */
  50         SR_CONF_VOLTAGE | SR_CONF_GET,
  51         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  52         SR_CONF_CURRENT | SR_CONF_GET,
  53         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  54         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  55 };
  56
  57 /* Note: All models have one power supply output only. */
  58 static const struct hcs_model models[] = {
  59         { MANSON_HCS_3100, "HCS-3100",     "3100", { 1, 18, 0.1 }, { 0, 10,   0.10 } },
  60         { MANSON_HCS_3102, "HCS-3102",     "3102", { 1, 36, 0.1 }, { 0,  5,   0.01 } },
  61         { MANSON_HCS_3104, "HCS-3104",     "3104", { 1, 60, 0.1 }, { 0,  2.5, 0.01 } },
  62         { MANSON_HCS_3150, "HCS-3150",     "3150", { 1, 18, 0.1 }, { 0, 15,   0.10 } },
  63         { MANSON_HCS_3200, "HCS-3200",     "3200", { 1, 18, 0.1 }, { 0, 20,   0.10 } },
  64         { MANSON_HCS_3202, "HCS-3202",     "3202", { 1, 36, 0.1 }, { 0, 10,   0.10 } },
  65         { MANSON_HCS_3204, "HCS-3204",     "3204", { 1, 60, 0.1 }, { 0,  5,   0.01 } },
  66         { MANSON_HCS_3300, "HCS-3300-USB", "3300", { 1, 16, 0.1 }, { 0, 30,   0.10 } },
  67         { MANSON_HCS_3302, "HCS-3302-USB", "3302", { 1, 32, 0.1 }, { 0, 15,   0.10 } },
  68         { MANSON_HCS_3304, "HCS-3304-USB", "3304", { 1, 60, 0.1 }, { 0,  8,   0.10 } },
  69         { MANSON_HCS_3400, "HCS-3400-USB", "3400", { 1, 16, 0.1 }, { 0, 40,   0.10 } },
  70         { MANSON_HCS_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20,   0.10 } },
  71         { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10,   0.10 } },
  72         { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60,   0.10 } },
  73         { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30,   0.10 } },
  74         { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15,   0.10 } },
  75         ALL_ZERO
  76 };
  77
  78 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  79 {
  80         int i, model_id;
  81         struct dev_context *devc;
  82         struct sr_dev_inst *sdi;
  83         struct sr_config *src;
  84         GSList *l;
  85         const char *conn, *serialcomm;
  86         struct sr_serial_dev_inst *serial;
  87         char reply[50], **tokens, *dummy;
  88
  89         conn = NULL;
  90         serialcomm = NULL;
  91         devc = NULL;
  92
  93         for (l = options; l; l = l->next) {
  94                 src = l->data;
  95                 switch (src->key) {
  96                 case SR_CONF_CONN:
  97                         conn = g_variant_get_string(src->data, NULL);
  98                         break;
  99                 case SR_CONF_SERIALCOMM:
 100                         serialcomm = g_variant_get_string(src->data, NULL);
 101                         break;
 102                 default:
 103                         sr_err("Unknown option %d, skipping.", src->key);
 104                         break;
 105                 }
 106         }
 107
 108         if (!conn)
 109                 return NULL;
 110         if (!serialcomm)
 111                 serialcomm = "9600/8n1";
 112
 113         serial = sr_serial_dev_inst_new(conn, serialcomm);
 114
 115         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 116                 return NULL;
 117
 118         serial_flush(serial);
 119
 120         sr_info("Probing serial port %s.", conn);
 121
 122         /* Get the device model. */
 123         memset(&reply, 0, sizeof(reply));
 124         if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
 125             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 126                 return NULL;
 127         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 128
 129         model_id = -1;
 130         for (i = 0; models[i].id != NULL; i++) {
 131                 if (!strcmp(models[i].id, tokens[0]))
 132                         model_id = i;
 133         }
 134         if (model_id < 0) {
 135                 sr_err("Unknown model ID '%s' detected, aborting.", tokens[0]);
 136                 g_strfreev(tokens);
 137                 return NULL;
 138         }
 139         g_strfreev(tokens);
 140
 141         /* Init device instance, etc. */
 142         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 143         sdi->status = SR_ST_INACTIVE;
 144         sdi->vendor = g_strdup("Manson");
 145         sdi->model = g_strdup(models[model_id].name);
 146         sdi->inst_type = SR_INST_SERIAL;
 147         sdi->conn = serial;
 148
 149         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
 150
 151         devc = g_malloc0(sizeof(struct dev_context));
 152         sr_sw_limits_init(&devc->limits);
 153         devc->model = &models[model_id];
 154
 155         sdi->priv = devc;
 156
 157         /* Get current voltage, current, status. */
 158         if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
 159             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 160                 goto exit_err;
 161         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 162         if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
 163                 g_strfreev(tokens);
 164                 goto exit_err;
 165         }
 166         g_strfreev(tokens);
 167
 168         /* Get max. voltage and current. */
 169         if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
 170             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 171                 goto exit_err;
 172         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 173         devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
 174         tokens[0][3] = '\0';
 175         devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
 176         g_strfreev(tokens);
 177
 178         serial_close(serial);
 179
 180         return std_scan_complete(di, g_slist_append(NULL, sdi));
 181
 182 exit_err:
 183         sr_dev_inst_free(sdi);
 184         g_free(devc);
 185
 186         return NULL;
 187 }
 188
 189 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 190                 const struct sr_channel_group *cg)
 191 {
 192         struct dev_context *devc;
 193
 194         (void)cg;
 195
 196         if (!sdi)
 197                 return SR_ERR_ARG;
 198
 199         devc = sdi->priv;
 200
 201         switch (key) {
 202         case SR_CONF_LIMIT_SAMPLES:
 203         case SR_CONF_LIMIT_MSEC:
 204                 return sr_sw_limits_config_get(&devc->limits, key, data);
 205         case SR_CONF_VOLTAGE:
 206                 *data = g_variant_new_double(devc->voltage);
 207                 break;
 208         case SR_CONF_VOLTAGE_TARGET:
 209                 *data = g_variant_new_double(devc->voltage_max);
 210                 break;
 211         case SR_CONF_CURRENT:
 212                 *data = g_variant_new_double(devc->current);
 213                 break;
 214         case SR_CONF_CURRENT_LIMIT:
 215                 *data = g_variant_new_double(devc->current_max);
 216                 break;
 217         case SR_CONF_ENABLED:
 218                 *data = g_variant_new_boolean(devc->output_enabled);
 219                 break;
 220         default:
 221                 return SR_ERR_NA;
 222         }
 223
 224         return SR_OK;
 225 }
 226
 227 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 228                 const struct sr_channel_group *cg)
 229 {
 230         struct dev_context *devc;
 231         gboolean bval;
 232         gdouble dval;
 233
 234         (void)cg;
 235
 236         devc = sdi->priv;
 237
 238         switch (key) {
 239         case SR_CONF_LIMIT_MSEC:
 240         case SR_CONF_LIMIT_SAMPLES:
 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         devc = sdi->priv;
 354
 355         sr_sw_limits_acquisition_start(&devc->limits);
 356         std_session_send_df_header(sdi);
 357
 358         devc->reply_pending = FALSE;
 359         devc->req_sent_at = 0;
 360
 361         /* Poll every 10ms, or whenever some data comes in. */
 362         serial = sdi->conn;
 363         serial_source_add(sdi->session, serial, G_IO_IN, 10,
 364                         hcs_receive_data, (void *)sdi);
 365
 366         return SR_OK;
 367 }
 368
 369 static struct sr_dev_driver manson_hcs_3xxx_driver_info = {
 370         .name = "manson-hcs-3xxx",
 371         .longname = "Manson HCS-3xxx",
 372         .api_version = 1,
 373         .init = std_init,
 374         .cleanup = std_cleanup,
 375         .scan = scan,
 376         .dev_list = std_dev_list,
 377         .config_get = config_get,
 378         .config_set = config_set,
 379         .config_list = config_list,
 380         .dev_open = std_serial_dev_open,
 381         .dev_close = std_serial_dev_close,
 382         .dev_acquisition_start = dev_acquisition_start,
 383         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 384         .context = NULL,
 385 };
 386 SR_REGISTER_DEV_DRIVER(manson_hcs_3xxx_driver_info);