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 int32_t hwopts[] = {
  30         SR_CONF_CONN,
  31         SR_CONF_SERIALCOMM,
  32 };
  33
  34 static const int32_t devopts[] = {
  35         SR_CONF_POWER_SUPPLY,
  36         SR_CONF_LIMIT_SAMPLES,
  37         SR_CONF_LIMIT_MSEC,
  38         SR_CONF_CONTINUOUS,
  39         SR_CONF_OUTPUT_VOLTAGE,
  40         SR_CONF_OUTPUT_CURRENT,
  41 };
  42
  43 /* Note: All models have one power supply output only. */
  44 static struct hcs_model models[] = {
  45         { MANSON_HCS_3100, "HCS-3100",     "3100", { 1, 18, 0.1 }, { 0, 10,   0.10 } },
  46         { MANSON_HCS_3102, "HCS-3102",     "3102", { 1, 36, 0.1 }, { 0,  5,   0.01 } },
  47         { MANSON_HCS_3104, "HCS-3104",     "3104", { 1, 60, 0.1 }, { 0,  2.5, 0.01 } },
  48         { MANSON_HCS_3150, "HCS-3150",     "3150", { 1, 18, 0.1 }, { 0, 15,   0.10 } },
  49         { MANSON_HCS_3200, "HCS-3200",     "3200", { 1, 18, 0.1 }, { 0, 20,   0.10 } },
  50         { MANSON_HCS_3202, "HCS-3202",     "3202", { 1, 36, 0.1 }, { 0, 10,   0.10 } },
  51         { MANSON_HCS_3204, "HCS-3204",     "3204", { 1, 60, 0.1 }, { 0,  5,   0.01 } },
  52         { MANSON_HCS_3300, "HCS-3300-USB", "3300", { 1, 16, 0.1 }, { 0, 30,   0.10 } },
  53         { MANSON_HCS_3302, "HCS-3302-USB", "3302", { 1, 32, 0.1 }, { 0, 15,   0.10 } },
  54         { MANSON_HCS_3304, "HCS-3304-USB", "3304", { 1, 60, 0.1 }, { 0,  8,   0.10 } },
  55         { MANSON_HCS_3400, "HCS-3400-USB", "3400", { 1, 16, 0.1 }, { 0, 40,   0.10 } },
  56         { MANSON_HCS_3402, "HCS-3402-USB", "3402", { 1, 32, 0.1 }, { 0, 20,   0.10 } },
  57         { MANSON_HCS_3404, "HCS-3404-USB", "3404", { 1, 60, 0.1 }, { 0, 10,   0.10 } },
  58         { MANSON_HCS_3600, "HCS-3600-USB", "3600", { 1, 16, 0.1 }, { 0, 60,   0.10 } },
  59         { MANSON_HCS_3602, "HCS-3602-USB", "3602", { 1, 32, 0.1 }, { 0, 30,   0.10 } },
  60         { MANSON_HCS_3604, "HCS-3604-USB", "3604", { 1, 60, 0.1 }, { 0, 15,   0.10 } },
  61         { 0, NULL, NULL, { 0, 0, 0 }, { 0, 0, 0 }, },
  62 };
  63
  64 SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info;
  65 static struct sr_dev_driver *di = &manson_hcs_3xxx_driver_info;
  66
  67 static int dev_clear(void)
  68 {
  69         return std_dev_clear(di, NULL);
  70 }
  71
  72 static int init(struct sr_context *sr_ctx)
  73 {
  74         return std_init(sr_ctx, di, LOG_PREFIX);
  75 }
  76
  77 static GSList *scan(GSList *options)
  78 {
  79         int i, model_id;
  80         struct drv_context *drvc;
  81         struct dev_context *devc;
  82         struct sr_dev_inst *sdi;
  83         struct sr_config *src;
  84         struct sr_channel *ch;
  85         GSList *devices, *l;
  86         const char *conn, *serialcomm;
  87         struct sr_serial_dev_inst *serial;
  88         char reply[50], **tokens;
  89
  90         drvc = di->priv;
  91         drvc->instances = NULL;
  92         devices = NULL;
  93         conn = NULL;
  94         serialcomm = NULL;
  95         devc = NULL;
  96
  97         for (l = options; l; l = l->next) {
  98                 src = l->data;
  99                 switch (src->key) {
 100                 case SR_CONF_CONN:
 101                         conn = g_variant_get_string(src->data, NULL);
 102                         break;
 103                 case SR_CONF_SERIALCOMM:
 104                         serialcomm = g_variant_get_string(src->data, NULL);
 105                         break;
 106                 default:
 107                         sr_err("Unknown option %d, skipping.", src->key);
 108                         break;
 109                 }
 110         }
 111
 112         if (!conn)
 113                 return NULL;
 114         if (!serialcomm)
 115                 serialcomm = "9600/8n1";
 116
 117         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
 118                 return NULL;
 119
 120         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 121                 return NULL;
 122
 123         serial_flush(serial);
 124
 125         sr_info("Probing serial port %s.", conn);
 126
 127         /* Get the device model. */
 128         memset(&reply, 0, sizeof(reply));
 129         if ((hcs_send_cmd(serial, "GMOD\r") < 0) ||
 130             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 131                 return NULL;
 132         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 133
 134         model_id = -1;
 135         for (i = 0; models[i].id != NULL; i++) {
 136                 if (!strcmp(models[i].id, tokens[0]))
 137                         model_id = i;
 138         }
 139         g_strfreev(tokens);
 140
 141         if (model_id < 0) {
 142                 sr_err("Unknown model id '%s' detected, aborting.", tokens[0]);
 143                 return NULL;
 144         }
 145
 146         /* Init device instance, etc. */
 147         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Manson",
 148                                     models[model_id].name, NULL))) {
 149                 sr_err("Failed to create device instance.");
 150                 return NULL;
 151         }
 152
 153         sdi->inst_type = SR_INST_SERIAL;
 154         sdi->conn = serial;
 155         sdi->driver = di;
 156
 157         if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "CH1"))) {
 158                 sr_err("Failed to create channel.");
 159                 goto exit_err;
 160         }
 161         sdi->channels = g_slist_append(sdi->channels, ch);
 162
 163         devc = g_malloc0(sizeof(struct dev_context));
 164         devc->model = &models[model_id];
 165
 166         sdi->priv = devc;
 167
 168         /* Get current device status. */
 169         if ((hcs_send_cmd(serial, "GETD\r") < 0) ||
 170             (hcs_read_reply(serial, 2, reply, sizeof(reply)) < 0))
 171                 return NULL;
 172         tokens = g_strsplit((const gchar *)&reply, "\r", 2);
 173         if (hcs_parse_volt_curr_mode(sdi, tokens) < 0)
 174                 goto exit_err;
 175
 176         drvc->instances = g_slist_append(drvc->instances, sdi);
 177         devices = g_slist_append(devices, sdi);
 178
 179         serial_close(serial);
 180         if (!devices)
 181                 sr_serial_dev_inst_free(serial);
 182
 183         return devices;
 184
 185 exit_err:
 186         sr_dev_inst_free(sdi);
 187         if (devc)
 188                 g_free(devc);
 189         return NULL;
 190 }
 191
 192 static GSList *dev_list(void)
 193 {
 194         return ((struct drv_context *)(di->priv))->instances;
 195 }
 196
 197 static int cleanup(void)
 198 {
 199         return dev_clear();
 200 }
 201
 202 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
 203                 const struct sr_channel_group *cg)
 204 {
 205         struct dev_context *devc;
 206
 207         (void)cg;
 208
 209         if (!sdi)
 210                 return SR_ERR_ARG;
 211
 212         devc = sdi->priv;
 213
 214         switch (key) {
 215         case SR_CONF_LIMIT_SAMPLES:
 216                 *data = g_variant_new_uint64(devc->limit_samples);
 217                 break;
 218         case SR_CONF_LIMIT_MSEC:
 219                 *data = g_variant_new_uint64(devc->limit_msec);
 220                 break;
 221         case SR_CONF_OUTPUT_VOLTAGE:
 222                 *data = g_variant_new_double(devc->voltage);
 223                 break;
 224         case SR_CONF_OUTPUT_CURRENT:
 225                 *data = g_variant_new_double(devc->current);
 226                 break;
 227         default:
 228                 return SR_ERR_NA;
 229         }
 230
 231         return SR_OK;
 232 }
 233
 234 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 235                 const struct sr_channel_group *cg)
 236 {
 237         struct dev_context *devc;
 238
 239         (void)cg;
 240
 241         if (sdi->status != SR_ST_ACTIVE)
 242                 return SR_ERR_DEV_CLOSED;
 243
 244         devc = sdi->priv;
 245
 246         switch (key) {
 247         case SR_CONF_LIMIT_MSEC:
 248                 if (g_variant_get_uint64(data) == 0)
 249                         return SR_ERR_ARG;
 250                 devc->limit_msec = g_variant_get_uint64(data);
 251                 break;
 252         case SR_CONF_LIMIT_SAMPLES:
 253                 if (g_variant_get_uint64(data) == 0)
 254                         return SR_ERR_ARG;
 255                 devc->limit_samples = g_variant_get_uint64(data);
 256                 break;
 257         default:
 258                 return SR_ERR_NA;
 259         }
 260
 261         return SR_OK;
 262 }
 263
 264 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 265                 const struct sr_channel_group *cg)
 266 {
 267         (void)sdi;
 268         (void)cg;
 269
 270         switch (key) {
 271         case SR_CONF_SCAN_OPTIONS:
 272                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 273                         hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 274                 break;
 275         case SR_CONF_DEVICE_OPTIONS:
 276                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 277                         devopts, ARRAY_SIZE(devopts), sizeof(int32_t));
 278                 break;
 279         default:
 280                 return SR_ERR_NA;
 281         }
 282
 283         return SR_OK;
 284 }
 285
 286 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 287 {
 288         struct dev_context *devc;
 289         struct sr_serial_dev_inst *serial;
 290
 291         if (sdi->status != SR_ST_ACTIVE)
 292                 return SR_ERR_DEV_CLOSED;
 293
 294         devc = sdi->priv;
 295         devc->cb_data = cb_data;
 296
 297         /* Send header packet to the session bus. */
 298         std_session_send_df_header(cb_data, LOG_PREFIX);
 299
 300         devc->starttime = g_get_monotonic_time();
 301         devc->num_samples = 0;
 302         devc->reply_pending = FALSE;
 303         devc->req_sent_at = 0;
 304
 305         /* Poll every 10ms, or whenever some data comes in. */
 306         serial = sdi->conn;
 307         serial_source_add(serial, G_IO_IN, 10, hcs_receive_data, (void *)sdi);
 308
 309         return SR_OK;
 310 }
 311
 312 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 313 {
 314         return std_serial_dev_acquisition_stop(sdi, cb_data,
 315                         std_serial_dev_close, sdi->conn, LOG_PREFIX);
 316 }
 317
 318 SR_PRIV struct sr_dev_driver manson_hcs_3xxx_driver_info = {
 319         .name = "manson-hcs-3xxx",
 320         .longname = "Manson HCS-3xxx",
 321         .api_version = 1,
 322         .init = init,
 323         .cleanup = cleanup,
 324         .scan = scan,
 325         .dev_list = dev_list,
 326         .dev_clear = dev_clear,
 327         .config_get = config_get,
 328         .config_set = config_set,
 329         .config_list = config_list,
 330         .dev_open = std_serial_dev_open,
 331         .dev_close = std_serial_dev_close,
 332         .dev_acquisition_start = dev_acquisition_start,
 333         .dev_acquisition_stop = dev_acquisition_stop,
 334         .priv = NULL,
 335 };