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         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         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,
 190         const struct sr_dev_inst *sdi, 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,
 228         const struct sr_dev_inst *sdi, 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
 267                 if (hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) {
 268                         sr_err("Could not send SR_CONF_ENABLED command.");
 269                         return SR_ERR;
 270                 }
 271                 if (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0) {
 272                         sr_err("Could not read SR_CONF_ENABLED reply.");
 273                         return SR_ERR;
 274                 }
 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,
 285         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 286 {
 287         const double *a;
 288         struct dev_context *devc;
 289
 290         devc = (sdi) ? sdi->priv : NULL;
 291
 292         switch (key) {
 293         case SR_CONF_SCAN_OPTIONS:
 294         case SR_CONF_DEVICE_OPTIONS:
 295                 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 296         case SR_CONF_VOLTAGE_TARGET:
 297                 if (!devc || !devc->model)
 298                         return SR_ERR_ARG;
 299                 a = devc->model->voltage;
 300                 *data = std_gvar_min_max_step(a[0], devc->voltage_max_device, a[2]);
 301                 break;
 302         case SR_CONF_CURRENT_LIMIT:
 303                 if (!devc || !devc->model)
 304                         return SR_ERR_ARG;
 305                 a = devc->model->current;
 306                 *data = std_gvar_min_max_step(a[0], devc->current_max_device, a[2]);
 307                 break;
 308         default:
 309                 return SR_ERR_NA;
 310         }
 311
 312         return SR_OK;
 313 }
 314
 315 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 316 {
 317         struct dev_context *devc;
 318         struct sr_serial_dev_inst *serial;
 319
 320         devc = sdi->priv;
 321
 322         sr_sw_limits_acquisition_start(&devc->limits);
 323         std_session_send_df_header(sdi);
 324
 325         devc->reply_pending = FALSE;
 326         devc->req_sent_at = 0;
 327
 328         serial = sdi->conn;
 329         serial_source_add(sdi->session, serial, G_IO_IN, 10,
 330                         hcs_receive_data, (void *)sdi);
 331
 332         return SR_OK;
 333 }
 334
 335 static struct sr_dev_driver manson_hcs_3xxx_driver_info = {
 336         .name = "manson-hcs-3xxx",
 337         .longname = "Manson HCS-3xxx",
 338         .api_version = 1,
 339         .init = std_init,
 340         .cleanup = std_cleanup,
 341         .scan = scan,
 342         .dev_list = std_dev_list,
 343         .dev_clear = std_dev_clear,
 344         .config_get = config_get,
 345         .config_set = config_set,
 346         .config_list = config_list,
 347         .dev_open = std_serial_dev_open,
 348         .dev_close = std_serial_dev_close,
 349         .dev_acquisition_start = dev_acquisition_start,
 350         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 351         .context = NULL,
 352 };
 353 SR_REGISTER_DEV_DRIVER(manson_hcs_3xxx_driver_info);