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