2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013, 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
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.
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.
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/>.
21 * Gossen Metrawatt Metrahit 1x/2x drivers
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"
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;
38 static const uint32_t scanopts[] = {
43 /** Hardware capabilities for Metrahit 1x/2x devices in send mode. */
44 static const uint32_t devopts_sm[] = {
46 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
48 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
49 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
52 /** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */
53 static const uint32_t devopts_bd[] = {
55 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
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,
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.
69 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
71 return std_init(sr_ctx, di, LOG_PREFIX);
75 * Read single byte from serial port.
77 * @retval -1 Timeout or error.
80 static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout)
86 rc = serial_read_nonblocking(serial, &result, 1);
88 sr_spew("read: 0x%02x/%d", result, result);
91 if (g_get_monotonic_time() > timeout)
98 * Try to detect GMC 1x/2x multimeter model in send mode for max. 1 second.
100 * @param serial Configured, open serial port.
102 * @retval NULL Detection failed.
103 * @retval other Model code.
105 static enum model scan_model_sm(struct sr_serial_dev_inst *serial)
107 int byte, bytecnt, cnt;
111 model = METRAHIT_NONE;
112 timeout_us = g_get_monotonic_time() + (1 * 1000 * 1000);
115 * Try to find message consisting of device code and several
116 * (at least 4) data bytes.
118 for (bytecnt = 0; bytecnt < 100; bytecnt++) {
119 byte = read_byte(serial, timeout_us);
120 if ((byte == -1) || (timeout_us < g_get_monotonic_time()))
122 if ((byte & MSGID_MASK) == MSGID_INF) {
123 if (!(model = gmc_decode_model_sm(byte & MSGC_MASK)))
125 /* Now expect (at least) 4 data bytes. */
126 for (cnt = 0; cnt < 4; cnt++) {
127 byte = read_byte(serial, timeout_us);
129 ((byte & MSGID_MASK) != MSGID_DATA))
131 model = METRAHIT_NONE;
144 * Scan for Metrahit 1x and Metrahit 2x in send mode using Gossen Metrawatt
147 * The older 1x models use 8192 baud and the newer 2x 9600 baud.
148 * The DMM usually sends up to about 20 messages per second. However, depending
149 * on configuration and measurement mode the intervals can be much larger and
150 * then the detection might not work.
152 static GSList *scan_1x_2x_rs232(struct sr_dev_driver *di, GSList *options)
154 struct sr_dev_inst *sdi;
155 struct drv_context *drvc;
156 struct dev_context *devc;
157 struct sr_config *src;
158 struct sr_serial_dev_inst *serial;
160 const char *conn, *serialcomm;
162 gboolean serialcomm_given;
166 drvc->instances = NULL;
167 conn = serialcomm = NULL;
168 serialcomm_given = FALSE;
170 sr_spew("scan_1x_2x_rs232() called!");
172 for (l = options; l; l = l->next) {
176 conn = g_variant_get_string(src->data, NULL);
178 case SR_CONF_SERIALCOMM:
179 serialcomm = g_variant_get_string(src->data, NULL);
180 serialcomm_given = TRUE;
187 serialcomm = SERIALCOMM_2X_RS232;
189 serial = sr_serial_dev_inst_new(conn, serialcomm);
191 if (serial_open(serial, SERIAL_RDWR) != SR_OK) {
192 sr_serial_dev_inst_free(serial);
196 serial_flush(serial);
198 model = scan_model_sm(serial);
201 * If detection failed and no user-supplied parameters,
202 * try second baud rate.
204 if ((model == METRAHIT_NONE) && !serialcomm_given) {
205 serialcomm = SERIALCOMM_1X_RS232;
206 g_free(serial->serialcomm);
207 serial->serialcomm = g_strdup(serialcomm);
208 if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
209 serial_flush(serial);
210 model = scan_model_sm(serial);
214 if (model != METRAHIT_NONE) {
215 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model));
216 sdi = g_malloc0(sizeof(struct sr_dev_inst));
217 sdi->status = SR_ST_INACTIVE;
218 sdi->vendor = g_strdup(VENDOR_GMC);
219 sdi->model = g_strdup(gmc_model_str(model));
220 devc = g_malloc0(sizeof(struct dev_context));
222 devc->limit_samples = 0;
223 devc->limit_msec = 0;
224 devc->num_samples = 0;
225 devc->elapsed_msec = g_timer_new();
226 devc->settings_ok = FALSE;
230 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
231 drvc->instances = g_slist_append(drvc->instances, sdi);
232 devices = g_slist_append(devices, sdi);
239 * Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt
240 * 'BD 232' interface.
242 static GSList *scan_2x_bd232(struct sr_dev_driver *di, GSList *options)
244 struct sr_dev_inst *sdi;
245 struct drv_context *drvc;
246 struct dev_context *devc;
247 struct sr_config *src;
248 struct sr_serial_dev_inst *serial;
250 const char *conn, *serialcomm;
256 conn = serialcomm = NULL;
260 drvc->instances = NULL;
262 sr_spew("scan_2x_bd232() called!");
264 for (l = options; l; l = l->next) {
268 conn = g_variant_get_string(src->data, NULL);
270 case SR_CONF_SERIALCOMM:
271 serialcomm = g_variant_get_string(src->data, NULL);
278 serialcomm = SERIALCOMM_2X;
280 serial = sr_serial_dev_inst_new(conn, serialcomm);
282 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
285 devc = g_malloc0(sizeof(struct dev_context));
287 sdi = g_malloc0(sizeof(struct sr_dev_inst));
288 sdi->status = SR_ST_INACTIVE;
289 sdi->vendor = g_strdup(VENDOR_GMC);
292 /* Send message 03 "Query multimeter version and status" */
295 if (req_stat14(sdi, TRUE) != SR_OK)
298 /* Wait for reply from device(s) for up to 2s. */
299 timeout_us = g_get_monotonic_time() + (2 * 1000 * 1000);
301 while (timeout_us > g_get_monotonic_time()) {
302 /* Receive reply (14 bytes) */
304 for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
305 byte = read_byte(serial, timeout_us);
307 devc->buf[devc->buflen++] = (byte & MASK_6BITS);
310 if (devc->buflen != GMC_REPLY_SIZE)
313 devc->addr = devc->buf[0];
317 if (devc->model != METRAHIT_NONE) {
318 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
319 devc->elapsed_msec = g_timer_new();
320 sdi->model = g_strdup(gmc_model_str(devc->model));
321 sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
325 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
326 drvc->instances = g_slist_append(drvc->instances, sdi);
327 devices = g_slist_append(devices, sdi);
328 devc = g_malloc0(sizeof(struct dev_context));
329 sdi = g_malloc0(sizeof(struct sr_dev_inst));
330 sdi->status = SR_ST_INACTIVE;
331 sdi->vendor = g_strdup(VENDOR_GMC);
335 /* Free last alloc if no device found */
336 if (devc->model == METRAHIT_NONE) {
338 sr_dev_inst_free(sdi);
344 sr_info("scan_2x_bd232(): Error!");
347 sr_serial_dev_inst_free(serial);
350 sr_dev_inst_free(sdi);
355 static GSList *dev_list(const struct sr_dev_driver *di)
357 return ((struct drv_context *)(di->context))->instances;
360 static int dev_close(struct sr_dev_inst *sdi)
362 struct dev_context *devc;
364 std_serial_dev_close(sdi);
366 sdi->status = SR_ST_INACTIVE;
368 /* Free dynamically allocated resources. */
369 if ((devc = sdi->priv) && devc->elapsed_msec) {
370 g_timer_destroy(devc->elapsed_msec);
371 devc->elapsed_msec = NULL;
372 devc->model = METRAHIT_NONE;
378 static int cleanup(const struct sr_dev_driver *di)
380 return std_dev_clear(di, NULL);
383 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
384 const struct sr_channel_group *cg)
387 struct dev_context *devc;
391 if (!sdi || !(devc = sdi->priv))
396 case SR_CONF_LIMIT_SAMPLES:
397 *data = g_variant_new_uint64(devc->limit_samples);
399 case SR_CONF_LIMIT_MSEC:
400 *data = g_variant_new_uint64(devc->limit_msec);
402 case SR_CONF_POWER_OFF:
403 *data = g_variant_new_boolean(FALSE);
412 /** Implementation of config_list, auxiliary function for common parts. */
413 static int config_list_common(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
414 const struct sr_channel_group *cg)
420 case SR_CONF_SCAN_OPTIONS:
421 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
422 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
431 /** Implementation of config_list for Metrahit 1x/2x send mode */
432 static int config_list_sm(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
433 const struct sr_channel_group *cg)
436 case SR_CONF_DEVICE_OPTIONS:
437 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
438 devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
441 return config_list_common(key, data, sdi, cg);
447 /** Implementation of config_list for Metrahit 2x bidirectional mode */
448 static int config_list_bd(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
449 const struct sr_channel_group *cg)
452 case SR_CONF_DEVICE_OPTIONS:
453 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
454 devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
457 return config_list_common(key, data, sdi, cg);
463 static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi,
466 struct dev_context *devc;
467 struct sr_serial_dev_inst *serial;
469 if (!sdi || !cb_data || !(devc = sdi->priv))
472 if (sdi->status != SR_ST_ACTIVE)
473 return SR_ERR_DEV_CLOSED;
475 devc->cb_data = cb_data;
476 devc->settings_ok = FALSE;
479 /* Send header packet to the session bus. */
480 std_session_send_df_header(cb_data, LOG_PREFIX);
482 /* Start timer, if required. */
483 if (devc->limit_msec)
484 g_timer_start(devc->elapsed_msec);
486 /* Poll every 40ms, or whenever some data comes in. */
488 serial_source_add(sdi->session, serial, G_IO_IN, 40,
489 gmc_mh_1x_2x_receive_data, (void *)sdi);
494 static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi,
497 struct dev_context *devc;
498 struct sr_serial_dev_inst *serial;
500 if (!sdi || !cb_data || !(devc = sdi->priv))
503 if (sdi->status != SR_ST_ACTIVE)
504 return SR_ERR_DEV_CLOSED;
506 devc->cb_data = cb_data;
507 devc->settings_ok = FALSE;
510 /* Send header packet to the session bus. */
511 std_session_send_df_header(cb_data, LOG_PREFIX);
513 /* Start timer, if required. */
514 if (devc->limit_msec)
515 g_timer_start(devc->elapsed_msec);
517 /* Poll every 40ms, or whenever some data comes in. */
519 serial_source_add(sdi->session, serial, G_IO_IN, 40,
520 gmc_mh_2x_receive_data, (void *)sdi);
522 /* Send start message */
523 return req_meas14(sdi);
526 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
528 struct dev_context *devc;
530 /* Stop timer, if required. */
531 if (sdi && (devc = sdi->priv) && devc->limit_msec)
532 g_timer_stop(devc->elapsed_msec);
534 return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
535 sdi->conn, LOG_PREFIX);
538 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
539 .name = "gmc-mh-1x-2x-rs232",
540 .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
544 .scan = scan_1x_2x_rs232,
545 .dev_list = dev_list,
547 .config_get = config_get,
548 .config_set = config_set,
549 .config_list = config_list_sm,
550 .dev_open = std_serial_dev_open,
551 .dev_close = dev_close,
552 .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
553 .dev_acquisition_stop = dev_acquisition_stop,
557 SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
558 .name = "gmc-mh-2x-bd232",
559 .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
563 .scan = scan_2x_bd232,
564 .dev_list = dev_list,
566 .config_get = config_get,
567 .config_set = config_set,
568 .config_list = config_list_bd,
569 .dev_open = std_serial_dev_open,
570 .dev_close = dev_close,
571 .dev_acquisition_start = dev_acquisition_start_2x_bd232,
572 .dev_acquisition_stop = dev_acquisition_stop,