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