hardware/gmc-mh-1x-2x/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <string.h>
  21 #include "protocol.h"
  22
  23 /* Serial communication parameters for Metrahit 1x/2x with 'RS232' adaptor */
  24 #define SERIALCOMM_1X_RS232 "8228/6n1/dtr=1/rts=1/flow=0" /* =8192, closer with divider */
  25 #define SERIALCOMM_2X_RS232 "9600/6n1/dtr=1/rts=1/flow=0"
  26 #define VENDOR_GMC "Gossen Metrawatt"
  27
  28 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
  29
  30 static const int32_t hwopts[] = {
  31         SR_CONF_CONN,
  32         SR_CONF_SERIALCOMM,
  33 };
  34
  35 static const int32_t hwcaps[] = {
  36         SR_CONF_MULTIMETER,
  37         SR_CONF_LIMIT_SAMPLES,
  38         SR_CONF_LIMIT_MSEC,
  39         SR_CONF_CONTINUOUS,
  40 };
  41
  42 static int init_1x_2x_rs232(struct sr_context *sr_ctx)
  43 {
  44         return std_init(sr_ctx, &gmc_mh_1x_2x_rs232_driver_info, LOG_PREFIX);
  45 }
  46
  47 /**
  48  * Read single byte from serial port.
  49  *
  50  * @retval -1 Timeout or error.
  51  * @retval other Byte.
  52  */
  53 static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout)
  54 {
  55         uint8_t result = 0;
  56         int rc = 0;
  57
  58         for (;;) {
  59                 rc = serial_read(serial, &result, 1);
  60                 if (rc == 1) {
  61                         sr_spew("read: 0x%02x/%d", result, result);
  62                         return result;
  63                 }
  64                 if (g_get_monotonic_time() > timeout)
  65                         return -1;
  66                 g_usleep(2000);
  67         }
  68 }
  69
  70 /**
  71  * Try to detect GMC 1x/2x multimeter model in send mode for max. 1 second.
  72  *
  73  * @param serial Configured, open serial port.
  74  *
  75  * @retval NULL Detection failed.
  76  * @retval other Model code.
  77  */
  78 static enum model scan_model_sm(struct sr_serial_dev_inst *serial)
  79 {
  80         int byte, bytecnt, cnt;
  81         enum model model;
  82         gint64 timeout_us;
  83
  84         model = SR_METRAHIT_NONE;
  85         timeout_us = g_get_monotonic_time() + 1 * 1000 * 1000;
  86
  87         /*
  88          * Try to find message consisting of device code and several
  89          * (at least 4) data bytes.
  90          */
  91         for (bytecnt = 0; bytecnt < 100; bytecnt++) {
  92                 byte = read_byte(serial, timeout_us);
  93                 if ((byte == -1) || (timeout_us < g_get_monotonic_time()))
  94                         break;
  95                 if ((byte & MSGID_MASK) == MSGID_INF) {
  96                         if (!(model = sr_gmc_decode_model_sm(byte & MSGC_MASK)))
  97                                 break;
  98                         /* Now expect (at least) 4 data bytes. */
  99                         for (cnt = 0; cnt < 4; cnt++) {
 100                                 byte = read_byte(serial, timeout_us);
 101                                 if ((byte == -1) ||
 102                                         ((byte & MSGID_MASK) != MSGID_DATA))
 103                                 {
 104                                         model = SR_METRAHIT_NONE;
 105                                         bytecnt = 100;
 106                                         break;
 107                                 }
 108                         }
 109                         break;
 110                 }
 111         }
 112
 113         return model;
 114 }
 115
 116 /**
 117  * Scan for Metrahit 1x and Metrahit 2x in send mode using Gossen Metrawatt
 118  * 'RS232' interface.
 119  *
 120  * The older 1x models use 8192 baud and the newer 2x 9600 baud.
 121  * The DMM usually sends up to about 20 messages per second. However, depending
 122  * on configuration and measurement mode the intervals can be much larger and
 123  * then the detection might not work.
 124  */
 125 static GSList *scan_1x_2x_rs232(GSList *options)
 126 {
 127         struct sr_dev_inst *sdi;
 128         struct drv_context *drvc;
 129         struct dev_context *devc;
 130         struct sr_config *src;
 131         struct sr_probe *probe;
 132         struct sr_serial_dev_inst *serial;
 133         GSList *l, *devices;
 134         const char *conn, *serialcomm;
 135         enum model model;
 136         gboolean serialcomm_given;
 137         int cnt;
 138
 139         devices = NULL;
 140         drvc = (&gmc_mh_1x_2x_rs232_driver_info)->priv;
 141         drvc->instances = NULL;
 142         conn = serialcomm = NULL;
 143         model = SR_METRAHIT_NONE;
 144         serialcomm_given = FALSE;
 145
 146         sr_spew("scan_1x_2x_rs232() called!");
 147
 148         for (l = options; l; l = l->next) {
 149                 src = l->data;
 150                 switch (src->key) {
 151                 case SR_CONF_CONN:
 152                         conn = g_variant_get_string(src->data, NULL);
 153                         break;
 154                 case SR_CONF_SERIALCOMM:
 155                         serialcomm = g_variant_get_string(src->data, NULL);
 156                         serialcomm_given = TRUE;
 157                         break;
 158                 }
 159         }
 160         if (!conn)
 161                 return NULL;
 162         if (!serialcomm)
 163                 serialcomm = SERIALCOMM_2X_RS232;
 164
 165         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
 166                 return NULL;
 167
 168         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK) {
 169                 sr_serial_dev_inst_free(serial);
 170                 return NULL;
 171         }
 172
 173         serial_flush(serial);
 174
 175         model = scan_model_sm(serial);
 176
 177         /*
 178          * If detection failed and no user-supplied parameters,
 179          * try second baud rate.
 180          */
 181         if ((model == SR_METRAHIT_NONE) && !serialcomm_given) {
 182                 serialcomm = SERIALCOMM_1X_RS232;
 183                 g_free(serial->serialcomm);
 184                 serial->serialcomm = g_strdup(serialcomm);
 185                 if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
 186                         serial_flush(serial);
 187                         model = scan_model_sm(serial);
 188                 }
 189         }
 190
 191         if (model != SR_METRAHIT_NONE) {
 192                 sr_spew("%s %s detected!", VENDOR_GMC, sr_gmc_model_str(model));
 193                 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC,
 194                                 sr_gmc_model_str(model), "")))
 195                         return NULL;
 196                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
 197                         sr_err("Device context malloc failed.");
 198                         return NULL;
 199                 }
 200                 devc->model = model;
 201                 devc->limit_samples = 0;
 202                 devc->limit_msec = 0;
 203                 devc->num_samples = 0;
 204                 devc->elapsed_msec = g_timer_new();
 205                 devc->settings_ok = FALSE;
 206
 207                 sdi->conn = serial;
 208                 sdi->priv = devc;
 209                 sdi->driver = &gmc_mh_1x_2x_rs232_driver_info;
 210                 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 211                         return NULL;
 212                 sdi->probes = g_slist_append(sdi->probes, probe);
 213                 drvc->instances = g_slist_append(drvc->instances, sdi);
 214                 devices = g_slist_append(devices, sdi);
 215         }
 216
 217         return devices;
 218 }
 219
 220 static GSList *dev_list_1x_2x_rs232(void)
 221 {
 222         return ((struct drv_context *)(gmc_mh_1x_2x_rs232_driver_info.priv))
 223                         ->instances;
 224 }
 225
 226 static int dev_clear_1x_2x_rs232(void)
 227 {
 228         return std_dev_clear(&gmc_mh_1x_2x_rs232_driver_info, NULL);
 229 }
 230
 231 static int dev_close(struct sr_dev_inst *sdi)
 232 {
 233         struct dev_context *devc;
 234
 235         std_serial_dev_close(sdi);
 236
 237         sdi->status = SR_ST_INACTIVE;
 238
 239         /* Free dynamically allocated resources. */
 240         if ((devc = sdi->priv) && devc->elapsed_msec) {
 241                 g_timer_destroy(devc->elapsed_msec);
 242                 devc->elapsed_msec = NULL;
 243                 devc->model = SR_METRAHIT_NONE;
 244         }
 245
 246         return SR_OK;
 247 }
 248
 249 static int cleanup_sm_rs232(void)
 250 {
 251         return dev_clear_1x_2x_rs232();
 252 }
 253
 254 /** TODO */
 255 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
 256                 const struct sr_probe_group *probe_group)
 257 {
 258         int ret;
 259
 260         (void)sdi;
 261         (void)data;
 262         (void)probe_group;
 263
 264         ret = SR_OK;
 265         switch (key) {
 266         /* TODO */
 267         default:
 268                 return SR_ERR_NA;
 269         }
 270
 271         return ret;
 272 }
 273
 274 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
 275                 const struct sr_probe_group *probe_group)
 276 {
 277         struct dev_context *devc;
 278
 279         (void)probe_group;
 280
 281         if (sdi->status != SR_ST_ACTIVE)
 282                 return SR_ERR_DEV_CLOSED;
 283
 284         if (!(devc = sdi->priv)) {
 285                 sr_err("sdi->priv was NULL.");
 286                 return SR_ERR_BUG;
 287         }
 288
 289         switch (key) {
 290         case SR_CONF_LIMIT_MSEC:
 291                 if (g_variant_get_uint64(data) == 0) {
 292                         sr_err("LIMIT_MSEC can't be 0.");
 293                         return SR_ERR;
 294                 }
 295                 devc->limit_msec = g_variant_get_uint64(data);
 296                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
 297                        devc->limit_msec);
 298                 break;
 299         case SR_CONF_LIMIT_SAMPLES:
 300                 devc->limit_samples = g_variant_get_uint64(data);
 301                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 302                        devc->limit_samples);
 303                 break;
 304         default:
 305                 return SR_ERR_NA;
 306         }
 307
 308         return SR_OK;
 309 }
 310
 311 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
 312                 const struct sr_probe_group *probe_group)
 313 {
 314         (void)sdi;
 315
 316         switch (key) {
 317         case SR_CONF_SCAN_OPTIONS:
 318                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 319                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 320                 break;
 321         case SR_CONF_DEVICE_OPTIONS:
 322                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 323                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 324                 break;
 325         default:
 326                 return SR_ERR_NA;
 327         }
 328
 329         return SR_OK;
 330 }
 331
 332 static int dev_acq_start_1x_2x_rs232(const struct sr_dev_inst *sdi,
 333                                      void *cb_data)
 334 {
 335         struct dev_context *devc;
 336         struct sr_serial_dev_inst *serial;
 337
 338         if (!sdi || !cb_data || !(devc = sdi->priv))
 339                 return SR_ERR_BUG;
 340
 341         if (sdi->status != SR_ST_ACTIVE)
 342                 return SR_ERR_DEV_CLOSED;
 343
 344         devc->cb_data = cb_data;
 345         devc->settings_ok = FALSE;
 346         devc->buflen = 0;
 347
 348         /* Send header packet to the session bus. */
 349         std_session_send_df_header(cb_data, LOG_PREFIX);
 350
 351         /* Start timer, if required. */
 352         if (devc->limit_msec)
 353                 g_timer_start(devc->elapsed_msec);
 354
 355         /* Poll every 40ms, or whenever some data comes in. */
 356         serial = sdi->conn;
 357         serial_source_add(serial, G_IO_IN, 40, gmc_mh_1x_2x_receive_data,
 358                 (void *)sdi);
 359
 360         return SR_OK;
 361 }
 362
 363 static int dev_acq_stop(struct sr_dev_inst *sdi, void *cb_data)
 364 {
 365         struct dev_context *devc;
 366
 367         /* Stop timer, if required. */
 368         if (sdi && (devc = sdi->priv) && devc->limit_msec)
 369                 g_timer_stop(devc->elapsed_msec);
 370
 371         return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
 372                         sdi->conn, LOG_PREFIX);
 373 }
 374
 375 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
 376         .name = "gmc-mh-1x-2x-rs232",
 377         .longname =
 378                 "Gossen Metrawatt Metrahit 1x/2x DMMs, 'RS232' Interface",
 379         .api_version = 1,
 380         .init = init_1x_2x_rs232,
 381         .cleanup = cleanup_sm_rs232,
 382         .scan = scan_1x_2x_rs232,
 383         .dev_list = dev_list_1x_2x_rs232,
 384         .dev_clear = dev_clear_1x_2x_rs232,
 385         .config_get = config_get,
 386         .config_set = config_set,
 387         .config_list = config_list,
 388         .dev_open = std_serial_dev_open,
 389         .dev_close = dev_close,
 390         .dev_acquisition_start = dev_acq_start_1x_2x_rs232,
 391         .dev_acquisition_stop = dev_acq_stop,
 392         .priv = NULL,
 393 };