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

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013, 2014 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 /** @file
  21  *  Gossen Metrawatt Metrahit 1x/2x drivers
  22  *  @internal
  23  */
  24
  25 #include <config.h>
  26 #include <string.h>
  27 #include "protocol.h"
  28
  29 /* Serial communication parameters for Metrahit 1x/2x with 'RS232' adaptor */
  30 #define SERIALCOMM_1X_RS232 "8228/6n1/dtr=1/rts=1/flow=0" /* =8192, closer with divider */
  31 #define SERIALCOMM_2X_RS232 "9600/6n1/dtr=1/rts=1/flow=0"
  32 #define SERIALCOMM_2X "9600/8n1/dtr=1/rts=1/flow=0"
  33 #define VENDOR_GMC "Gossen Metrawatt"
  34
  35 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
  36 SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info;
  37
  38 static const uint32_t scanopts[] = {
  39         SR_CONF_CONN,
  40         SR_CONF_SERIALCOMM,
  41 };
  42
  43 /** Hardware capabilities for Metrahit 1x/2x devices in send mode. */
  44 static const uint32_t devopts_sm[] = {
  45         SR_CONF_MULTIMETER,
  46         SR_CONF_THERMOMETER,    /**< All GMC 1x/2x multimeters seem to support this */
  47         SR_CONF_CONTINUOUS,
  48         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  49         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  50 };
  51
  52 /** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */
  53 static const uint32_t devopts_bd[] = {
  54         SR_CONF_MULTIMETER,
  55         SR_CONF_THERMOMETER,    /**< All GMC 1x/2x multimeters seem to support this */
  56         SR_CONF_CONTINUOUS,
  57         SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
  58         SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
  59         SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET,
  60 };
  61
  62 /* TODO:
  63  * - For the 29S SR_CONF_ENERGYMETER, too.
  64  * - SR_CONF_PATTERN_MODE for some 2x devices
  65  * - SR_CONF_DATALOG for 22M, 26M, 29S and storage adaptors.
  66  * Need to implement device-specific lists.
  67  */
  68
  69 /**
  70  * Read single byte from serial port.
  71  *
  72  * @retval -1 Timeout or error.
  73  * @retval other Byte.
  74  */
  75 static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout)
  76 {
  77         uint8_t result = 0;
  78         int rc = 0;
  79
  80         for (;;) {
  81                 rc = serial_read_nonblocking(serial, &result, 1);
  82                 if (rc == 1) {
  83                         sr_spew("read: 0x%02x/%d", result, result);
  84                         return result;
  85                 }
  86                 if (g_get_monotonic_time() > timeout)
  87                         return -1;
  88                 g_usleep(2000);
  89         }
  90 }
  91
  92 /**
  93  * Try to detect GMC 1x/2x multimeter model in send mode for max. 1 second.
  94  *
  95  * @param serial Configured, open serial port.
  96  *
  97  * @retval NULL Detection failed.
  98  * @retval other Model code.
  99  */
 100 static enum model scan_model_sm(struct sr_serial_dev_inst *serial)
 101 {
 102         int byte, bytecnt, cnt;
 103         enum model model;
 104         gint64 timeout_us;
 105
 106         model = METRAHIT_NONE;
 107         timeout_us = g_get_monotonic_time() + (1 * 1000 * 1000);
 108
 109         /*
 110          * Try to find message consisting of device code and several
 111          * (at least 4) data bytes.
 112          */
 113         for (bytecnt = 0; bytecnt < 100; bytecnt++) {
 114                 byte = read_byte(serial, timeout_us);
 115                 if ((byte == -1) || (timeout_us < g_get_monotonic_time()))
 116                         break;
 117                 if ((byte & MSGID_MASK) == MSGID_INF) {
 118                         if (!(model = gmc_decode_model_sm(byte & MSGC_MASK)))
 119                                 break;
 120                         /* Now expect (at least) 4 data bytes. */
 121                         for (cnt = 0; cnt < 4; cnt++) {
 122                                 byte = read_byte(serial, timeout_us);
 123                                 if ((byte == -1) ||
 124                                                 ((byte & MSGID_MASK) != MSGID_DATA))
 125                                 {
 126                                         model = METRAHIT_NONE;
 127                                         bytecnt = 100;
 128                                         break;
 129                                 }
 130                         }
 131                         break;
 132                 }
 133         }
 134
 135         return model;
 136 }
 137
 138 /**
 139  * Scan for Metrahit 1x and Metrahit 2x in send mode using Gossen Metrawatt
 140  * 'RS232' interface.
 141  *
 142  * The older 1x models use 8192 baud and the newer 2x 9600 baud.
 143  * The DMM usually sends up to about 20 messages per second. However, depending
 144  * on configuration and measurement mode the intervals can be much larger and
 145  * then the detection might not work.
 146  */
 147 static GSList *scan_1x_2x_rs232(struct sr_dev_driver *di, GSList *options)
 148 {
 149         struct sr_dev_inst *sdi;
 150         struct drv_context *drvc;
 151         struct dev_context *devc;
 152         struct sr_config *src;
 153         struct sr_serial_dev_inst *serial;
 154         GSList *l, *devices;
 155         const char *conn, *serialcomm;
 156         enum model model;
 157         gboolean serialcomm_given;
 158
 159         devices = NULL;
 160         drvc = di->context;
 161         drvc->instances = NULL;
 162         conn = serialcomm = NULL;
 163         serialcomm_given = FALSE;
 164
 165         sr_spew("scan_1x_2x_rs232() called!");
 166
 167         for (l = options; l; l = l->next) {
 168                 src = l->data;
 169                 switch (src->key) {
 170                 case SR_CONF_CONN:
 171                         conn = g_variant_get_string(src->data, NULL);
 172                         break;
 173                 case SR_CONF_SERIALCOMM:
 174                         serialcomm = g_variant_get_string(src->data, NULL);
 175                         serialcomm_given = TRUE;
 176                         break;
 177                 }
 178         }
 179         if (!conn)
 180                 return NULL;
 181         if (!serialcomm)
 182                 serialcomm = SERIALCOMM_2X_RS232;
 183
 184         serial = sr_serial_dev_inst_new(conn, serialcomm);
 185
 186         if (serial_open(serial, SERIAL_RDWR) != SR_OK) {
 187                 sr_serial_dev_inst_free(serial);
 188                 return NULL;
 189         }
 190
 191         serial_flush(serial);
 192
 193         model = scan_model_sm(serial);
 194
 195         /*
 196          * If detection failed and no user-supplied parameters,
 197          * try second baud rate.
 198          */
 199         if ((model == METRAHIT_NONE) && !serialcomm_given) {
 200                 serialcomm = SERIALCOMM_1X_RS232;
 201                 g_free(serial->serialcomm);
 202                 serial->serialcomm = g_strdup(serialcomm);
 203                 if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
 204                         serial_flush(serial);
 205                         model = scan_model_sm(serial);
 206                 }
 207         }
 208
 209         if (model != METRAHIT_NONE) {
 210                 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model));
 211                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 212                 sdi->status = SR_ST_INACTIVE;
 213                 sdi->vendor = g_strdup(VENDOR_GMC);
 214                 sdi->model = g_strdup(gmc_model_str(model));
 215                 devc = g_malloc0(sizeof(struct dev_context));
 216                 devc->model = model;
 217                 devc->limit_samples = 0;
 218                 devc->limit_msec = 0;
 219                 devc->num_samples = 0;
 220                 devc->elapsed_msec = g_timer_new();
 221                 devc->settings_ok = FALSE;
 222                 sdi->conn = serial;
 223                 sdi->priv = devc;
 224                 sdi->driver = di;
 225                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 226                 drvc->instances = g_slist_append(drvc->instances, sdi);
 227                 devices = g_slist_append(devices, sdi);
 228         }
 229
 230         return devices;
 231 }
 232
 233 /**
 234  * Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt
 235  * 'BD 232' interface.
 236  */
 237 static GSList *scan_2x_bd232(struct sr_dev_driver *di, GSList *options)
 238 {
 239         struct sr_dev_inst *sdi;
 240         struct drv_context *drvc;
 241         struct dev_context *devc;
 242         struct sr_config *src;
 243         struct sr_serial_dev_inst *serial;
 244         GSList *l, *devices;
 245         const char *conn, *serialcomm;
 246         int cnt, byte;
 247         gint64 timeout_us;
 248
 249         sdi = NULL;
 250         devc = NULL;
 251         conn = serialcomm = NULL;
 252         devices = NULL;
 253
 254         drvc = di->context;
 255         drvc->instances = NULL;
 256
 257         sr_spew("scan_2x_bd232() called!");
 258
 259         for (l = options; l; l = l->next) {
 260                 src = l->data;
 261                 switch (src->key) {
 262                 case SR_CONF_CONN:
 263                         conn = g_variant_get_string(src->data, NULL);
 264                         break;
 265                 case SR_CONF_SERIALCOMM:
 266                         serialcomm = g_variant_get_string(src->data, NULL);
 267                         break;
 268                 }
 269         }
 270         if (!conn)
 271                 return NULL;
 272         if (!serialcomm)
 273                 serialcomm = SERIALCOMM_2X;
 274
 275         serial = sr_serial_dev_inst_new(conn, serialcomm);
 276
 277         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
 278                 goto exit_err;
 279
 280         devc = g_malloc0(sizeof(struct dev_context));
 281
 282         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 283         sdi->status = SR_ST_INACTIVE;
 284         sdi->vendor = g_strdup(VENDOR_GMC);
 285         sdi->priv = devc;
 286
 287         /* Send message 03 "Query multimeter version and status" */
 288         sdi->conn = serial;
 289         if (req_stat14(sdi, TRUE) != SR_OK)
 290                 goto exit_err;
 291
 292         /* Wait for reply from device(s) for up to 2s. */
 293         timeout_us = g_get_monotonic_time() + (2 * 1000 * 1000);
 294
 295         while (timeout_us > g_get_monotonic_time()) {
 296                 /* Receive reply (14 bytes) */
 297                 devc->buflen = 0;
 298                 for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
 299                         byte = read_byte(serial, timeout_us);
 300                         if (byte != -1)
 301                                 devc->buf[devc->buflen++] = (byte & MASK_6BITS);
 302                 }
 303
 304                 if (devc->buflen != GMC_REPLY_SIZE)
 305                         continue;
 306
 307                 devc->addr = devc->buf[0];
 308                 process_msg14(sdi);
 309                 devc->buflen = 0;
 310
 311                 if (devc->model != METRAHIT_NONE) {
 312                         sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
 313                         devc->elapsed_msec = g_timer_new();
 314                         sdi->model = g_strdup(gmc_model_str(devc->model));
 315                         sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
 316                         sdi->conn = serial;
 317                         sdi->priv = devc;
 318                         sdi->driver = di;
 319                         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 320                         drvc->instances = g_slist_append(drvc->instances, sdi);
 321                         devices = g_slist_append(devices, sdi);
 322                         devc = g_malloc0(sizeof(struct dev_context));
 323                         sdi = g_malloc0(sizeof(struct sr_dev_inst));
 324                         sdi->status = SR_ST_INACTIVE;
 325                         sdi->vendor = g_strdup(VENDOR_GMC);
 326                 }
 327         };
 328
 329         /* Free last alloc if no device found */
 330         if (devc->model == METRAHIT_NONE) {
 331                 g_free(devc);
 332                 sr_dev_inst_free(sdi);
 333         }
 334
 335         return devices;
 336
 337 exit_err:
 338         sr_info("scan_2x_bd232(): Error!");
 339
 340         if (serial)
 341                 sr_serial_dev_inst_free(serial);
 342         g_free(devc);
 343         if (sdi)
 344                 sr_dev_inst_free(sdi);
 345
 346         return NULL;
 347 }
 348
 349 static int dev_close(struct sr_dev_inst *sdi)
 350 {
 351         struct dev_context *devc;
 352
 353         std_serial_dev_close(sdi);
 354
 355         sdi->status = SR_ST_INACTIVE;
 356
 357         /* Free dynamically allocated resources. */
 358         if ((devc = sdi->priv) && devc->elapsed_msec) {
 359                 g_timer_destroy(devc->elapsed_msec);
 360                 devc->elapsed_msec = NULL;
 361                 devc->model = METRAHIT_NONE;
 362         }
 363
 364         return SR_OK;
 365 }
 366
 367 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 368                 const struct sr_channel_group *cg)
 369 {
 370         int ret;
 371         struct dev_context *devc;
 372
 373         (void)cg;
 374
 375         if (!sdi)
 376                 return SR_ERR_ARG;
 377
 378         devc = sdi->priv;
 379
 380         ret = SR_OK;
 381         switch (key) {
 382         case SR_CONF_LIMIT_SAMPLES:
 383                 *data = g_variant_new_uint64(devc->limit_samples);
 384                 break;
 385         case SR_CONF_LIMIT_MSEC:
 386                 *data = g_variant_new_uint64(devc->limit_msec);
 387                 break;
 388         case SR_CONF_POWER_OFF:
 389                 *data = g_variant_new_boolean(FALSE);
 390                 break;
 391         default:
 392                 return SR_ERR_NA;
 393         }
 394
 395         return ret;
 396 }
 397
 398 /** Implementation of config_list, auxiliary function for common parts. */
 399 static int config_list_common(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 400                 const struct sr_channel_group *cg)
 401 {
 402         (void)sdi;
 403         (void)cg;
 404
 405         switch (key) {
 406         case SR_CONF_SCAN_OPTIONS:
 407                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 408                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 409                 break;
 410         default:
 411                 return SR_ERR_NA;
 412         }
 413
 414         return SR_OK;
 415 }
 416
 417 /** Implementation of config_list for Metrahit 1x/2x send mode */
 418 static int config_list_sm(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 419                           const struct sr_channel_group *cg)
 420 {
 421         switch (key) {
 422         case SR_CONF_DEVICE_OPTIONS:
 423                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 424                                 devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
 425                 break;
 426         default:
 427                 return config_list_common(key, data, sdi, cg);
 428         }
 429
 430         return SR_OK;
 431 }
 432
 433 /** Implementation of config_list for Metrahit 2x bidirectional mode */
 434 static int config_list_bd(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 435                           const struct sr_channel_group *cg)
 436 {
 437         switch (key) {
 438         case SR_CONF_DEVICE_OPTIONS:
 439                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 440                                 devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
 441                 break;
 442         default:
 443                 return config_list_common(key, data, sdi, cg);
 444         }
 445
 446         return SR_OK;
 447 }
 448
 449 static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi)
 450 {
 451         struct dev_context *devc;
 452         struct sr_serial_dev_inst *serial;
 453
 454         if (sdi->status != SR_ST_ACTIVE)
 455                 return SR_ERR_DEV_CLOSED;
 456
 457         devc = sdi->priv;
 458         devc->settings_ok = FALSE;
 459         devc->buflen = 0;
 460
 461         std_session_send_df_header(sdi, LOG_PREFIX);
 462
 463         /* Start timer, if required. */
 464         if (devc->limit_msec)
 465                 g_timer_start(devc->elapsed_msec);
 466
 467         /* Poll every 40ms, or whenever some data comes in. */
 468         serial = sdi->conn;
 469         serial_source_add(sdi->session, serial, G_IO_IN, 40,
 470                         gmc_mh_1x_2x_receive_data, (void *)sdi);
 471
 472         return SR_OK;
 473 }
 474
 475 static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi)
 476 {
 477         struct dev_context *devc;
 478         struct sr_serial_dev_inst *serial;
 479
 480         if (sdi->status != SR_ST_ACTIVE)
 481                 return SR_ERR_DEV_CLOSED;
 482
 483         devc = sdi->priv;
 484         devc->settings_ok = FALSE;
 485         devc->buflen = 0;
 486
 487         std_session_send_df_header(sdi, LOG_PREFIX);
 488
 489         /* Start timer, if required. */
 490         if (devc->limit_msec)
 491                 g_timer_start(devc->elapsed_msec);
 492
 493         /* Poll every 40ms, or whenever some data comes in. */
 494         serial = sdi->conn;
 495         serial_source_add(sdi->session, serial, G_IO_IN, 40,
 496                         gmc_mh_2x_receive_data, (void *)sdi);
 497
 498         /* Send start message */
 499         return req_meas14(sdi);
 500 }
 501
 502 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 503 {
 504         struct dev_context *devc;
 505
 506         /* Stop timer, if required. */
 507         if (sdi && (devc = sdi->priv) && devc->limit_msec)
 508                 g_timer_stop(devc->elapsed_msec);
 509
 510         return std_serial_dev_acquisition_stop(sdi, dev_close,
 511                         sdi->conn, LOG_PREFIX);
 512 }
 513
 514 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
 515         .name = "gmc-mh-1x-2x-rs232",
 516         .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
 517         .api_version = 1,
 518         .init = std_init,
 519         .cleanup = std_cleanup,
 520         .scan = scan_1x_2x_rs232,
 521         .dev_list = std_dev_list,
 522         .dev_clear = NULL,
 523         .config_get = config_get,
 524         .config_set = config_set,
 525         .config_list = config_list_sm,
 526         .dev_open = std_serial_dev_open,
 527         .dev_close = dev_close,
 528         .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
 529         .dev_acquisition_stop = dev_acquisition_stop,
 530         .context = NULL,
 531 };
 532
 533 SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
 534         .name = "gmc-mh-2x-bd232",
 535         .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
 536         .api_version = 1,
 537         .init = std_init,
 538         .cleanup = std_cleanup,
 539         .scan = scan_2x_bd232,
 540         .dev_list = std_dev_list,
 541         .dev_clear = NULL,
 542         .config_get = config_get,
 543         .config_set = config_set,
 544         .config_list = config_list_bd,
 545         .dev_open = std_serial_dev_open,
 546         .dev_close = dev_close,
 547         .dev_acquisition_start = dev_acquisition_start_2x_bd232,
 548         .dev_acquisition_stop = dev_acquisition_stop,
 549         .context = NULL,
 550 };