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, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  */
  21
  22 /** @file
  23   *  <em>Manson HCS-3xxx Series</em> power supply driver
  24   *  @internal
  25   */
  26
  27 #include "protocol.h"
  28
  29 static const uint32_t drvopts[] = {
  30         /* Device class */
  31         SR_CONF_POWER_SUPPLY,
  32 };
  33
  34 static const uint32_t scanopts[] = {
  35         SR_CONF_CONN,
  36         SR_CONF_SERIALCOMM,
  37 };
  38
  39 static const uint32_t devopts[] = {
  40         /* Device class */
  41         SR_CONF_POWER_SUPPLY,
  42         /* Aquisition modes. */
  43         SR_CONF_CONTINUOUS,
  44         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  45         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  46         /* Device configuration */
  47         SR_CONF_OUTPUT_VOLTAGE | SR_CONF_GET,
  48         SR_CONF_OUTPUT_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  49         SR_CONF_OUTPUT_CURRENT | SR_CONF_GET,
  50         SR_CONF_OUTPUT_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
  51         SR_CONF_OUTPUT_ENABLED | SR_CONF_GET | SR_CONF_SET,
  52 };
  53
  54 /* Note: All models have one power supply output only. */
  55 static struct hcs_model models[] = {
  56         { MANSON_HCS_3100, "HCS-3100",     "3100", { 1, 18, 0.1 }, { 0, 10,   0.10 } },
  57         { MANSON_HCS_3102, "HCS-3102",     "3102", { 1, 36, 0.1 }, { 0,  5,   0.01 } },
  58         { MANSON_HCS_3104, "HCS-3104",     "3104", { 1, 60, 0.1 }, { 0,  2.5, 0.01 } },
  59         { MANSON_HCS_3150, "HCS-3150",     "3150", { 1, 18, 0.1 }, { 0, 15,   0.10 } },
  60         { MANSON_HCS_3200, "HCS-3200",     "3200", { 1, 18, 0.1 }, { 0, 20,   0.10 } },
  61         { MANSON_HCS_3202, "HCS-3202",     "3202", { 1, 36, 0.1 }, { 0, 10,   0.10 } },
  62         { MANSON_HCS_3204, "HCS-3204",     "3204", { 1, 60, 0.1 }, { 0,  5,   0.01 } },
  63         { MANSON_HCS_3300, "HCS-3300-USB", "3300", { 1, 16, 0.1 }, { 0, 30,   0.10 } },
  64         { MANSON_HCS_3302, "HCS-3302-USB", "3302", { 1, 32, 0.1 }, { 0, 15,   0.10 } },
  65         { MANSON_HCS_3304, "HCS-3304-USB", "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_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20,   0.10 } },
  68         { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10,   0.10 } },
  69         { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60,   0.10 } },
  70         { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30,   0.10 } },
  71         { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15,   0.10 } },
  72         { 0, NULL, NULL, { 0, 0, 0 }, { 0, 0, 0 }, },
  73 };
  74
  75 SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info;
  76 static struct sr_dev_driver *di = &manson_hcs_3xxx_driver_info;
  77
  78 static int dev_clear(void)
  79 {
  80         return std_dev_clear(di, NULL);
  81 }
  82
  83 static int init(struct sr_context *sr_ctx)
  84 {
  85         return std_init(sr_ctx, di, LOG_PREFIX);
  86 }
  87
  88 static GSList *scan(GSList *options)
  89 {
  90         int i, model_id;
  91         struct drv_context *drvc;
  92         struct dev_context *devc;
  93         struct sr_dev_inst *sdi;
  94         struct sr_config *src;
  95         GSList *devices, *l;
  96         const char *conn, *serialcomm;
  97         struct sr_serial_dev_inst *serial;
  98         char reply[50], **tokens, *dummy;
  99
 100         drvc = di->priv;
 101         drvc->instances = NULL;
 102         devices = NULL;
 103         conn = NULL;
 104         serialcomm = NULL;
 105         devc = NULL;
 106
 107         for (l = options; l; l = l->next) {
 108                 src = l->data;
 109                 switch (src->key) {
 110                 case SR_CONF_CONN:
 111                         conn = g_variant_get_string(src->data, NULL);
 112                         break;
 113                 case SR_CONF_SERIALCOMM:
 114                         serialcomm = g_variant_get_string(src->data, NULL);
 115                         break;
 116                 default:
 117                         sr_err("Unknown option %d, skipping.", src->key);
 118                         break;
 119                 }
 120         }
 121
 122         if (!conn)
 123                 return NULL;
 124         if (!serialcomm)
 125                 serialcomm = "9600/8n1";
 126
 127         serial = sr_serial_dev_inst_new(conn, serialcomm);
 128
 129         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 130                 return NULL;
 131
 132         serial_flush(serial);
 133
 134         sr_info("Probing serial port %s.", conn);
 135
 136         /* Get the device model. */
 137         memset(&reply, 0, sizeof(reply));
 138         if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
 139             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 140                 return NULL;
 141         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 142
 143         model_id = -1;
 144         for (i = 0; models[i].id != NULL; i++) {
 145                 if (!strcmp(models[i].id, tokens[0]))
 146                         model_id = i;
 147         }
 148         g_strfreev(tokens);
 149
 150         if (model_id < 0) {
 151                 sr_err("Unknown model id '%s' detected, aborting.", tokens[0]);
 152                 return NULL;
 153         }
 154
 155         /* Init device instance, etc. */
 156         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 157         sdi->status = SR_ST_INACTIVE;
 158         sdi->vendor = g_strdup("Manson");
 159         sdi->model = g_strdup(models[model_id].name);
 160         sdi->inst_type = SR_INST_SERIAL;
 161         sdi->conn = serial;
 162         sdi->driver = di;
 163
 164         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CH1");
 165
 166         devc = g_malloc0(sizeof(struct dev_context));
 167         devc->model = &models[model_id];
 168
 169         sdi->priv = devc;
 170
 171         /* Get current voltage, current, status. */
 172         if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
 173             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 174                 goto exit_err;
 175         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 176         if (hcs_parse_volt_curr_mode(sdi, tokens) < 0)
 177                 goto exit_err;
 178         g_strfreev(tokens);
 179
 180         /* Get max. voltage and current. */
 181         if ((hcs_send_cmd(serial, "GMAX\r") < 0) ||
 182             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 183                 goto exit_err;
 184         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 185         devc->current_max_device = g_strtod(&tokens[0][3], &dummy) * devc->model->current[2];
 186         tokens[0][3] = '\0';
 187         devc->voltage_max_device = g_strtod(tokens[0], &dummy) * devc->model->voltage[2];
 188         g_strfreev(tokens);
 189
 190         drvc->instances = g_slist_append(drvc->instances, sdi);
 191         devices = g_slist_append(devices, sdi);
 192
 193         serial_close(serial);
 194         if (!devices)
 195                 sr_serial_dev_inst_free(serial);
 196
 197         return devices;
 198
 199 exit_err:
 200         sr_dev_inst_free(sdi);
 201         if (devc)
 202                 g_free(devc);
 203         return NULL;
 204 }
 205
 206 static GSList *dev_list(void)
 207 {
 208         return ((struct drv_context *)(di->priv))->instances;
 209 }
 210
 211 static int cleanup(void)
 212 {
 213         return dev_clear();
 214 }
 215
 216 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 217                 const struct sr_channel_group *cg)
 218 {
 219         struct dev_context *devc;
 220
 221         (void)cg;
 222
 223         if (!sdi)
 224                 return SR_ERR_ARG;
 225
 226         devc = sdi->priv;
 227
 228         switch (key) {
 229         case SR_CONF_LIMIT_SAMPLES:
 230                 *data = g_variant_new_uint64(devc->limit_samples);
 231                 break;
 232         case SR_CONF_LIMIT_MSEC:
 233                 *data = g_variant_new_uint64(devc->limit_msec);
 234                 break;
 235         case SR_CONF_OUTPUT_VOLTAGE:
 236                 *data = g_variant_new_double(devc->voltage);
 237                 break;
 238         case SR_CONF_OUTPUT_VOLTAGE_TARGET:
 239                 *data = g_variant_new_double(devc->voltage_max);
 240                 break;
 241         case SR_CONF_OUTPUT_CURRENT:
 242                 *data = g_variant_new_double(devc->current);
 243                 break;
 244         case SR_CONF_OUTPUT_CURRENT_LIMIT:
 245                 *data = g_variant_new_double(devc->current_max);
 246                 break;
 247         case SR_CONF_OUTPUT_ENABLED:
 248                 *data = g_variant_new_boolean(devc->output_enabled);
 249                 break;
 250         default:
 251                 return SR_ERR_NA;
 252         }
 253
 254         return SR_OK;
 255 }
 256
 257 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 258                 const struct sr_channel_group *cg)
 259 {
 260         struct dev_context *devc;
 261         gboolean bval;
 262         gdouble dval;
 263
 264         (void)cg;
 265
 266         if (sdi->status != SR_ST_ACTIVE)
 267                 return SR_ERR_DEV_CLOSED;
 268
 269         devc = sdi->priv;
 270
 271         switch (key) {
 272         case SR_CONF_LIMIT_MSEC:
 273                 if (g_variant_get_uint64(data) == 0)
 274                         return SR_ERR_ARG;
 275                 devc->limit_msec = g_variant_get_uint64(data);
 276                 break;
 277         case SR_CONF_LIMIT_SAMPLES:
 278                 if (g_variant_get_uint64(data) == 0)
 279                         return SR_ERR_ARG;
 280                 devc->limit_samples = g_variant_get_uint64(data);
 281                 break;
 282         case SR_CONF_OUTPUT_VOLTAGE_TARGET:
 283                 dval = g_variant_get_double(data);
 284                 if (dval < devc->model->voltage[0] || dval > devc->voltage_max_device)
 285                         return SR_ERR_ARG;
 286
 287                 if ((hcs_send_cmd(sdi->conn, "VOLT%03.0f\r",
 288                         (dval / devc->model->voltage[2])) < 0) ||
 289                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 290                         return SR_ERR;
 291                 devc->voltage_max = dval;
 292                 break;
 293         case SR_CONF_OUTPUT_CURRENT_LIMIT:
 294                 dval = g_variant_get_double(data);
 295                 if (dval < devc->model->current[0] || dval > devc->current_max_device)
 296                         return SR_ERR_ARG;
 297
 298                 if ((hcs_send_cmd(sdi->conn, "CURR%03.0f\r",
 299                         (dval / devc->model->current[2])) < 0) ||
 300                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 301                         return SR_ERR;
 302                 devc->current_max = dval;
 303                 break;
 304         case SR_CONF_OUTPUT_ENABLED:
 305                 bval = g_variant_get_boolean(data);
 306                 if (bval == devc->output_enabled) /* Nothing to do. */
 307                         break;
 308                 if ((hcs_send_cmd(sdi->conn, "SOUT%1d\r", !bval) < 0) ||
 309                     (hcs_read_reply(sdi->conn, 1, devc->buf, sizeof(devc->buf)) < 0))
 310                         return SR_ERR;
 311                 devc->output_enabled = bval;
 312                 break;
 313         default:
 314                 return SR_ERR_NA;
 315         }
 316
 317         return SR_OK;
 318 }
 319
 320 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 321                 const struct sr_channel_group *cg)
 322 {
 323         struct dev_context *devc;
 324         GVariant *gvar;
 325         GVariantBuilder gvb;
 326         double dval;
 327         int idx;
 328
 329         (void)cg;
 330
 331         /* Always available (with or without sdi). */
 332         if (key == SR_CONF_SCAN_OPTIONS) {
 333                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 334                         scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 335                 return SR_OK;
 336         }
 337
 338         /* Return drvopts without sdi (and devopts with sdi, see below). */
 339         if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
 340                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 341                                 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
 342                 return SR_OK;
 343         }
 344
 345         /* Every other key needs an sdi. */
 346         if (!sdi)
 347                 return SR_ERR_ARG;
 348         devc = sdi->priv;
 349
 350         switch (key) {
 351         case SR_CONF_DEVICE_OPTIONS:
 352                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 353                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 354                 break;
 355         case SR_CONF_OUTPUT_VOLTAGE_TARGET:
 356                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 357                 /* Min, max, step. */
 358                 for (idx = 0; idx < 3; idx++) {
 359                         if (idx == 1)
 360                                 dval = devc->voltage_max_device;
 361                         else
 362                                 dval = devc->model->voltage[idx];
 363                         gvar = g_variant_new_double(dval);
 364                         g_variant_builder_add_value(&gvb, gvar);
 365                 }
 366                 *data = g_variant_builder_end(&gvb);
 367                 break;
 368         case SR_CONF_OUTPUT_CURRENT_LIMIT:
 369                 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
 370                 /* Min, max, step. */
 371                 for (idx = 0; idx < 3; idx++) {
 372                         if (idx == 1)
 373                                 dval = devc->current_max_device;
 374                         else
 375                                 dval = devc->model->current[idx];
 376                         gvar = g_variant_new_double(dval);
 377                         g_variant_builder_add_value(&gvb, gvar);
 378                 }
 379                 *data = g_variant_builder_end(&gvb);
 380                 break;
 381         default:
 382                 return SR_ERR_NA;
 383         }
 384
 385         return SR_OK;
 386 }
 387
 388 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 389 {
 390         struct dev_context *devc;
 391         struct sr_serial_dev_inst *serial;
 392
 393         if (sdi->status != SR_ST_ACTIVE)
 394                 return SR_ERR_DEV_CLOSED;
 395
 396         devc = sdi->priv;
 397         devc->cb_data = cb_data;
 398
 399         /* Send header packet to the session bus. */
 400         std_session_send_df_header(cb_data, LOG_PREFIX);
 401
 402         devc->starttime = g_get_monotonic_time();
 403         devc->num_samples = 0;
 404         devc->reply_pending = FALSE;
 405         devc->req_sent_at = 0;
 406
 407         /* Poll every 10ms, or whenever some data comes in. */
 408         serial = sdi->conn;
 409         serial_source_add(sdi->session, serial, G_IO_IN, 10,
 410                         hcs_receive_data, (void *)sdi);
 411
 412         return SR_OK;
 413 }
 414
 415 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 416 {
 417         return std_serial_dev_acquisition_stop(sdi, cb_data,
 418                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 419 }
 420
 421 SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info = {
 422         .name = "manson-hcs-3xxx",
 423         .longname = "Manson HCS-3xxx",
 424         .api_version = 1,
 425         .init = init,
 426         .cleanup = cleanup,
 427         .scan = scan,
 428         .dev_list = dev_list,
 429         .dev_clear = dev_clear,
 430         .config_get = config_get,
 431         .config_set = config_set,
 432         .config_list = config_list,
 433         .dev_open = std_serial_dev_open,
 434         .dev_close = std_serial_dev_close,
 435         .dev_acquisition_start = dev_acquisition_start,
 436         .dev_acquisition_stop = dev_acquisition_stop,
 437         .priv = NULL,
 438 };