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 scanopts[] = {
  33         SR_CONF_CONN,
  34         SR_CONF_SERIALCOMM,
  35 };
  36
  37 static const uint32_t drvopts[] = {
  38         /* Device class */
  39         SR_CONF_POWER_SUPPLY,
  40 };
  41
  42 static const uint32_t devopts[] = {
  43         /* Device class */
  44         /* Acquisition modes. */
  45         SR_CONF_CONTINUOUS,
  46         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  47         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  48         /* Device configuration */
  49         SR_CONF_VOLTAGE | SR_CONF_GET,
  50         SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  51         SR_CONF_CURRENT | SR_CONF_GET,
  52         SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  53         SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
  54 };
  55
  56 /* Note: All models have one power supply output only. */
  57 static const struct hcs_model models[] = {
  58         { MANSON_HCS_3100, "HCS-3100",     "3100", { 1, 18, 0.1 }, { 0, 10,   0.10 } },
  59         { MANSON_HCS_3102, "HCS-3102",     "3102", { 1, 36, 0.1 }, { 0,  5,   0.01 } },
  60         { MANSON_HCS_3104, "HCS-3104",     "3104", { 1, 60, 0.1 }, { 0,  2.5, 0.01 } },
  61         { MANSON_HCS_3150, "HCS-3150",     "3150", { 1, 18, 0.1 }, { 0, 15,   0.10 } },
  62         { MANSON_HCS_3200, "HCS-3200",     "3200", { 1, 18, 0.1 }, { 0, 20,   0.10 } },
  63         { MANSON_HCS_3202, "HCS-3202",     "3202", { 1, 36, 0.1 }, { 0, 10,   0.10 } },
  64         { MANSON_HCS_3204, "HCS-3204",     "3204", { 1, 60, 0.1 }, { 0,  5,   0.01 } },
  65         { MANSON_HCS_3300, "HCS-3300-USB", "3300", { 1, 16, 0.1 }, { 0, 30,   0.10 } },
  66         { MANSON_HCS_3302, "HCS-3302-USB", "3302", { 1, 32, 0.1 }, { 0, 15,   0.10 } },
  67         { MANSON_HCS_3304, "HCS-3304-USB", "3304", { 1, 60, 0.1 }, { 0,  8,   0.10 } },
  68         { MANSON_HCS_3400, "HCS-3400-USB", "3400", { 1, 16, 0.1 }, { 0, 40,   0.10 } },
  69         { MANSON_HCS_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20,   0.10 } },
  70         { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10,   0.10 } },
  71         { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60,   0.10 } },
  72         { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30,   0.10 } },
  73         { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15,   0.10 } },
  74         ALL_ZERO
  75 };
  76
  77 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  78 {
  79         int i, model_id;
  80         struct dev_context *devc;
  81         struct sr_dev_inst *sdi;
  82         struct sr_config *src;
  83         GSList *l;
  84         const char *conn, *serialcomm;
  85         struct sr_serial_dev_inst *serial;
  86         char reply[50], **tokens, *dummy;
  87
  88         conn = NULL;
  89         serialcomm = NULL;
  90         devc = NULL;
  91
  92         for (l = options; l; l = l->next) {
  93                 src = l->data;
  94                 switch (src->key) {
  95                 case SR_CONF_CONN:
  96                         conn = g_variant_get_string(src->data, NULL);
  97                         break;
  98                 case SR_CONF_SERIALCOMM:
  99                         serialcomm = g_variant_get_string(src->data, NULL);
 100                         break;
 101                 default:
 102                         sr_err("Unknown option %d, skipping.", src->key);
 103                         break;
 104                 }
 105         }
 106
 107         if (!conn)
 108                 return NULL;
 109         if (!serialcomm)
 110                 serialcomm = "9600/8n1";
 111
 112         serial = sr_serial_dev_inst_new(conn, serialcomm);
 113
 114         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 115                 return NULL;
 116
 117         serial_flush(serial);
 118
 119         sr_info("Probing serial port %s.", conn);
 120
 121         /* Get the device model. */
 122         memset(&reply, 0, sizeof(reply));
 123         if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
 124             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 125                 return NULL;
 126         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 127
 128         model_id = -1;
 129         for (i = 0; models[i].id != NULL; i++) {
 130                 if (!strcmp(models[i].id, tokens[0]))
 131                         model_id = i;
 132         }
 133         if (model_id < 0) {
 134                 sr_err("Unknown model ID '%s' detected, aborting.", tokens[0]);
 135                 g_strfreev(tokens);
 136                 return NULL;
 137         }
 138         g_strfreev(tokens);
 139
 140         /* Init device instance, etc. */
 141         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 142         sdi->status = SR_ST_INACTIVE;
 143         sdi->vendor = g_strdup("Manson");
 144         sdi->model = g_strdup(models[model_id].name);
 145         sdi->inst_type = SR_INST_SERIAL;
 146         sdi->conn = serial;
 147
 148         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
 149
 150         devc = g_malloc0(sizeof(struct dev_context));
 151         sr_sw_limits_init(&devc->limits);
 152         devc->model = &models[model_id];
 153
 154         sdi->priv = devc;
 155
 156         /* Get current voltage, current, status. */
 157         if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
 158             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 159                 goto exit_err;
 160         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 161         if (hcs_parse_volt_curr_mode(sdi, tokens) < 0) {
 162                 g_strfreev(tokens);
 163                 goto exit_err;
 164         }
 165         g_strfreev(tokens);
 166
 167         /* Get max. voltage and current. */
 168         if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
 169             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 170                 goto exit_err;
 171         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 172         devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
 173         tokens[0][3] = '\0';
 174         devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
 175         g_strfreev(tokens);
 176
 177         serial_close(serial);
 178
 179         return std_scan_complete(di, g_slist_append(NULL, sdi));
 180
 181 exit_err:
 182         sr_dev_inst_free(sdi);
 183         g_free(devc);
 184
 185         return NULL;
 186 }
 187
 188 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 189                 const struct sr_channel_group *cg)
 190 {
 191         struct dev_context *devc;
 192
 193         (void)cg;
 194
 195         if (!sdi)
 196                 return SR_ERR_ARG;
 197
 198         devc = sdi->priv;
 199
 200         switch (key) {
 201         case SR_CONF_LIMIT_SAMPLES:
 202         case SR_CONF_LIMIT_MSEC:
 203                 return sr_sw_limits_config_get(&devc->limits, key, data);
 204         case SR_CONF_VOLTAGE:
 205                 *data = g_variant_new_double(devc->voltage);
 206                 break;
 207         case SR_CONF_VOLTAGE_TARGET:
 208                 *data = g_variant_new_double(devc->voltage_max);
 209                 break;
 210         case SR_CONF_CURRENT:
 211                 *data = g_variant_new_double(devc->current);
 212                 break;
 213         case SR_CONF_CURRENT_LIMIT:
 214                 *data = g_variant_new_double(devc->current_max);
 215                 break;
 216         case SR_CONF_ENABLED:
 217                 *data = g_variant_new_boolean(devc->output_enabled);
 218                 break;
 219         default:
 220                 return SR_ERR_NA;
 221         }
 222
 223         return SR_OK;
 224 }
 225
 226 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 227                 const struct sr_channel_group *cg)
 228 {
 229         struct dev_context *devc;
 230         gboolean bval;
 231         gdouble dval;
 232
 233         (void)cg;
 234
 235         devc = sdi->priv;
 236
 237         switch (key) {
 238         case SR_CONF_LIMIT_MSEC:
 239         case SR_CONF_LIMIT_SAMPLES:
 240                 return sr_sw_limits_config_set(&devc->limits, key, data);
 241         case SR_CONF_VOLTAGE_TARGET:
 242                 dval = g_variant_get_double(data);
 243                 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
 244                         return SR_ERR_ARG;
 245
 246                 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
 247                         (dval / devc->model->voltage[2])) < 0) ||
 248                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 249                         return SR_ERR;
 250                 devc->voltage_max = dval;
 251                 break;
 252         case SR_CONF_CURRENT_LIMIT:
 253                 dval = g_variant_get_double(data);
 254                 if (dval < devc->model->current[0] || dval > devc->current_max_device)
 255                         return SR_ERR_ARG;
 256
 257                 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
 258                         (dval / devc->model->current[2])) < 0) ||
 259                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 260                         return SR_ERR;
 261                 devc->current_max = dval;
 262                 break;
 263         case SR_CONF_ENABLED:
 264                 bval = g_variant_get_boolean(data);
 265                 if (bval == devc->output_enabled) /* Nothing to do. */
 266                         break;
 267                 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
 268                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 269                         return SR_ERR;
 270                 devc->output_enabled = bval;
 271                 break;
 272         default:
 273                 return SR_ERR_NA;
 274         }
 275
 276         return SR_OK;
 277 }
 278
 279 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 280                 const struct sr_channel_group *cg)
 281 {
 282         struct dev_context *devc;
 283         GVariant *gvar;
 284         GVariantBuilder gvb;
 285         double dval;
 286         int idx;
 287
 288         devc = (sdi) ? sdi->priv : NULL;
 289
 290         switch (key) {
 291         case SR_CONF_SCAN_OPTIONS:
 292         case SR_CONF_DEVICE_OPTIONS:
 293                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 294         case SR_CONF_VOLTAGE_TARGET:
 295                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 296                 /* Min, max, step. */
 297                 for (idx = 0; idx < 3; idx++) {
 298                         if (idx == 1)
 299                                 dval = devc->voltage_max_device;
 300                         else
 301                                 dval = devc->model->voltage[idx];
 302                         gvar = g_variant_new_double(dval);
 303                         g_variant_builder_add_value(&gvb, gvar);
 304                 }
 305                 *data = g_variant_builder_end(&gvb);
 306                 break;
 307         case SR_CONF_CURRENT_LIMIT:
 308                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 309                 /* Min, max, step. */
 310                 for (idx = 0; idx < 3; idx++) {
 311                         if (idx == 1)
 312                                 dval = devc->current_max_device;
 313                         else
 314                                 dval = devc->model->current[idx];
 315                         gvar = g_variant_new_double(dval);
 316                         g_variant_builder_add_value(&gvb, gvar);
 317                 }
 318                 *data = g_variant_builder_end(&gvb);
 319                 break;
 320         default:
 321                 return SR_ERR_NA;
 322         }
 323
 324         return SR_OK;
 325 }
 326
 327 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 328 {
 329         struct dev_context *devc;
 330         struct sr_serial_dev_inst *serial;
 331
 332         devc = sdi->priv;
 333
 334         sr_sw_limits_acquisition_start(&devc->limits);
 335         std_session_send_df_header(sdi);
 336
 337         devc->reply_pending = FALSE;
 338         devc->req_sent_at = 0;
 339
 340         /* Poll every 10ms, or whenever some data comes in. */
 341         serial = sdi->conn;
 342         serial_source_add(sdi->session, serial, G_IO_IN, 10,
 343                         hcs_receive_data, (void *)sdi);
 344
 345         return SR_OK;
 346 }
 347
 348 static struct sr_dev_driver manson_hcs_3xxx_driver_info = {
 349         .name = "manson-hcs-3xxx",
 350         .longname = "Manson HCS-3xxx",
 351         .api_version = 1,
 352         .init = std_init,
 353         .cleanup = std_cleanup,
 354         .scan = scan,
 355         .dev_list = std_dev_list,
 356         .dev_clear = std_dev_clear,
 357         .config_get = config_get,
 358         .config_set = config_set,
 359         .config_list = config_list,
 360         .dev_open = std_serial_dev_open,
 361         .dev_close = std_serial_dev_close,
 362         .dev_acquisition_start = dev_acquisition_start,
 363         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 364         .context = NULL,
 365 };
 366 SR_REGISTER_DEV_DRIVER(manson_hcs_3xxx_driver_info);