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