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
28 /* Serial communication parameters for Metrahit 1x/2x with 'RS232' adaptor */
29 #define SERIALCOMM_1X_RS232 "8228/6n1/dtr=1/rts=1/flow=0" /* =8192, closer with divider */
30 #define SERIALCOMM_2X_RS232 "9600/6n1/dtr=1/rts=1/flow=0"
31 #define SERIALCOMM_2X "9600/8n1/dtr=1/rts=1/flow=0"
32 #define VENDOR_GMC "Gossen Metrawatt"
34 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
35 SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info;
37 static const int32_t hwopts[] = {
42 /** Hardware capabilities for Metrahit 1x/2x devices in send mode. */
43 static const int32_t hwcaps_sm[] = {
45 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
46 SR_CONF_LIMIT_SAMPLES,
51 /** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */
52 static const int32_t hwcaps_bd[] = {
54 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
55 SR_CONF_LIMIT_SAMPLES,
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 /** Init driver gmc_mh_1x_2x_rs232. */
70 static int init_1x_2x_rs232(struct sr_context *sr_ctx)
72 return std_init(sr_ctx, &gmc_mh_1x_2x_rs232_driver_info, LOG_PREFIX);
75 /** Init driver gmc_mh_2x_bd232. */
76 static int init_2x_bd232(struct sr_context *sr_ctx)
78 return std_init(sr_ctx, &gmc_mh_2x_bd232_driver_info, LOG_PREFIX);
82 * Read single byte from serial port.
84 * @retval -1 Timeout or error.
87 static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout)
93 rc = serial_read(serial, &result, 1);
95 sr_spew("read: 0x%02x/%d", result, result);
98 if (g_get_monotonic_time() > timeout)
105 * Try to detect GMC 1x/2x multimeter model in send mode for max. 1 second.
107 * @param serial Configured, open serial port.
109 * @retval NULL Detection failed.
110 * @retval other Model code.
112 static enum model scan_model_sm(struct sr_serial_dev_inst *serial)
114 int byte, bytecnt, cnt;
118 model = METRAHIT_NONE;
119 timeout_us = g_get_monotonic_time() + 1 * 1000 * 1000;
122 * Try to find message consisting of device code and several
123 * (at least 4) data bytes.
125 for (bytecnt = 0; bytecnt < 100; bytecnt++) {
126 byte = read_byte(serial, timeout_us);
127 if ((byte == -1) || (timeout_us < g_get_monotonic_time()))
129 if ((byte & MSGID_MASK) == MSGID_INF) {
130 if (!(model = gmc_decode_model_sm(byte & MSGC_MASK)))
132 /* Now expect (at least) 4 data bytes. */
133 for (cnt = 0; cnt < 4; cnt++) {
134 byte = read_byte(serial, timeout_us);
136 ((byte & MSGID_MASK) != MSGID_DATA))
138 model = METRAHIT_NONE;
151 * Scan for Metrahit 1x and Metrahit 2x in send mode using Gossen Metrawatt
154 * The older 1x models use 8192 baud and the newer 2x 9600 baud.
155 * The DMM usually sends up to about 20 messages per second. However, depending
156 * on configuration and measurement mode the intervals can be much larger and
157 * then the detection might not work.
159 static GSList *scan_1x_2x_rs232(GSList *options)
161 struct sr_dev_inst *sdi;
162 struct drv_context *drvc;
163 struct dev_context *devc;
164 struct sr_config *src;
165 struct sr_probe *probe;
166 struct sr_serial_dev_inst *serial;
168 const char *conn, *serialcomm;
170 gboolean serialcomm_given;
173 drvc = (&gmc_mh_1x_2x_rs232_driver_info)->priv;
174 drvc->instances = NULL;
175 conn = serialcomm = NULL;
176 model = METRAHIT_NONE;
177 serialcomm_given = FALSE;
179 sr_spew("scan_1x_2x_rs232() called!");
181 for (l = options; l; l = l->next) {
185 conn = g_variant_get_string(src->data, NULL);
187 case SR_CONF_SERIALCOMM:
188 serialcomm = g_variant_get_string(src->data, NULL);
189 serialcomm_given = TRUE;
196 serialcomm = SERIALCOMM_2X_RS232;
198 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
201 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK) {
202 sr_serial_dev_inst_free(serial);
206 serial_flush(serial);
208 model = scan_model_sm(serial);
211 * If detection failed and no user-supplied parameters,
212 * try second baud rate.
214 if ((model == METRAHIT_NONE) && !serialcomm_given) {
215 serialcomm = SERIALCOMM_1X_RS232;
216 g_free(serial->serialcomm);
217 serial->serialcomm = g_strdup(serialcomm);
218 if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
219 serial_flush(serial);
220 model = scan_model_sm(serial);
224 if (model != METRAHIT_NONE) {
225 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model));
226 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC,
227 gmc_model_str(model), "")))
229 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
230 sr_err("Device context malloc failed.");
234 devc->limit_samples = 0;
235 devc->limit_msec = 0;
236 devc->num_samples = 0;
237 devc->elapsed_msec = g_timer_new();
238 devc->settings_ok = FALSE;
242 sdi->driver = &gmc_mh_1x_2x_rs232_driver_info;
243 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
245 sdi->probes = g_slist_append(sdi->probes, probe);
246 drvc->instances = g_slist_append(drvc->instances, sdi);
247 devices = g_slist_append(devices, sdi);
253 /** Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt 'BD 232' interface.
256 static GSList *scan_2x_bd232(GSList *options)
258 struct sr_dev_inst *sdi;
259 struct drv_context *drvc;
260 struct dev_context *devc;
261 struct sr_config *src;
262 struct sr_probe *probe;
263 struct sr_serial_dev_inst *serial;
265 const char *conn, *serialcomm;
271 conn = serialcomm = NULL;
274 drvc = (&gmc_mh_2x_bd232_driver_info)->priv;
275 drvc->instances = NULL;
277 sr_spew("scan_2x_bd232() called!");
279 for (l = options; l; l = l->next) {
283 conn = g_variant_get_string(src->data, NULL);
285 case SR_CONF_SERIALCOMM:
286 serialcomm = g_variant_get_string(src->data, NULL);
293 serialcomm = SERIALCOMM_2X;
295 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
298 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
301 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
302 sr_err("Device context malloc failed.");
306 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC, NULL, NULL)))
311 /* Send message 03 "Query multimeter version and status" */
314 if (req_stat14(sdi, TRUE) != SR_OK)
317 /* Wait for reply from device(s) for up to 2s. */
318 timeout_us = g_get_monotonic_time() + 2*1000*1000;
320 while (timeout_us > g_get_monotonic_time()) {
321 /* Receive reply (14 bytes) */
323 for (cnt = 0; cnt < 14; cnt++) {
324 byte = read_byte(serial, timeout_us);
326 devc->buf[devc->buflen++] = (byte & MASK_6BITS);
329 if (devc->buflen != 14)
332 devc->addr = devc->buf[0];
336 if (devc->model != METRAHIT_NONE) {
337 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
339 devc->elapsed_msec = g_timer_new();
341 sdi->model = g_strdup(gmc_model_str(devc->model));
342 sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
345 sdi->driver = &gmc_mh_2x_bd232_driver_info;
346 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
348 sdi->probes = g_slist_append(sdi->probes, probe);
349 drvc->instances = g_slist_append(drvc->instances, sdi);
350 devices = g_slist_append(devices, sdi);
352 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
353 sr_err("Device context malloc failed.");
357 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC, NULL, NULL)))
362 /* Free last alloc if no device found */
363 if (devc->model == METRAHIT_NONE) {
365 sr_dev_inst_free(sdi);
371 sr_info("scan_2x_bd232(): Error!");
374 sr_serial_dev_inst_free(serial);
378 sr_dev_inst_free(sdi);
383 /** Driver device list function */
384 static GSList *dev_list_1x_2x_rs232(void)
386 return ((struct drv_context *)(gmc_mh_1x_2x_rs232_driver_info.priv))->instances;
389 /** Driver device list function */
390 static GSList *dev_list_2x_bd232(void)
392 return ((struct drv_context *)(gmc_mh_2x_bd232_driver_info.priv))
396 static int dev_close(struct sr_dev_inst *sdi)
398 struct dev_context *devc;
400 std_serial_dev_close(sdi);
402 sdi->status = SR_ST_INACTIVE;
404 /* Free dynamically allocated resources. */
405 if ((devc = sdi->priv) && devc->elapsed_msec) {
406 g_timer_destroy(devc->elapsed_msec);
407 devc->elapsed_msec = NULL;
408 devc->model = METRAHIT_NONE;
414 static int cleanup_sm_rs232(void)
416 return std_dev_clear(&gmc_mh_1x_2x_rs232_driver_info, NULL);
419 static int cleanup_2x_bd232(void)
421 return std_dev_clear(&gmc_mh_2x_bd232_driver_info, NULL);
424 /** Get value of configuration item */
425 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
426 const struct sr_channel_group *channel_group)
429 struct dev_context *devc;
439 if (!sdi || !(devc = sdi->priv))
444 case SR_CONF_LIMIT_SAMPLES:
445 *data = g_variant_new_uint64(devc->limit_samples);
447 case SR_CONF_LIMIT_MSEC:
448 *data = g_variant_new_uint64(devc->limit_msec);
451 case SR_CONF_POWER_OFF:
452 *data = g_variant_new_boolean(FALSE);
461 /** Implementation of config_list, auxiliary function for common parts, */
462 static int config_list_common(int key, GVariant **data, const struct sr_dev_inst *sdi,
463 const struct sr_channel_group *channel_group)
469 case SR_CONF_SCAN_OPTIONS:
470 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
471 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
480 /** Implementation of config_list for Metrahit 1x/2x send mode */
481 static int config_list_sm(int key, GVariant **data, const struct sr_dev_inst *sdi,
482 const struct sr_channel_group *channel_group)
488 case SR_CONF_DEVICE_OPTIONS:
489 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
490 hwcaps_sm, ARRAY_SIZE(hwcaps_sm), sizeof(int32_t));
493 return config_list_common(key, data, sdi, channel_group);
499 /** Implementation of config_list for Metrahit 2x bidirectional mode */
500 static int config_list_bd(int key, GVariant **data, const struct sr_dev_inst *sdi,
501 const struct sr_channel_group *channel_group)
507 case SR_CONF_DEVICE_OPTIONS:
508 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
509 hwcaps_bd, ARRAY_SIZE(hwcaps_bd), sizeof(int32_t));
512 return config_list_common(key, data, sdi, channel_group);
518 static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi,
521 struct dev_context *devc;
522 struct sr_serial_dev_inst *serial;
524 if (!sdi || !cb_data || !(devc = sdi->priv))
527 if (sdi->status != SR_ST_ACTIVE)
528 return SR_ERR_DEV_CLOSED;
530 devc->cb_data = cb_data;
531 devc->settings_ok = FALSE;
534 /* Send header packet to the session bus. */
535 std_session_send_df_header(cb_data, LOG_PREFIX);
537 /* Start timer, if required. */
538 if (devc->limit_msec)
539 g_timer_start(devc->elapsed_msec);
541 /* Poll every 40ms, or whenever some data comes in. */
543 serial_source_add(serial, G_IO_IN, 40, gmc_mh_1x_2x_receive_data,
549 static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi,
552 struct dev_context *devc;
553 struct sr_serial_dev_inst *serial;
555 if (!sdi || !cb_data || !(devc = sdi->priv))
558 if (sdi->status != SR_ST_ACTIVE)
559 return SR_ERR_DEV_CLOSED;
561 devc->cb_data = cb_data;
562 devc->settings_ok = FALSE;
565 /* Send header packet to the session bus. */
566 std_session_send_df_header(cb_data, LOG_PREFIX);
568 /* Start timer, if required. */
569 if (devc->limit_msec)
570 g_timer_start(devc->elapsed_msec);
572 /* Poll every 40ms, or whenever some data comes in. */
574 serial_source_add(serial, G_IO_IN, 40, gmc_mh_2x_receive_data,
577 /* Send start message */
578 return req_meas14(sdi);
581 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
583 struct dev_context *devc;
585 /* Stop timer, if required. */
586 if (sdi && (devc = sdi->priv) && devc->limit_msec)
587 g_timer_stop(devc->elapsed_msec);
589 return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
590 sdi->conn, LOG_PREFIX);
593 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
594 .name = "gmc-mh-1x-2x-rs232",
595 .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
597 .init = init_1x_2x_rs232,
598 .cleanup = cleanup_sm_rs232,
599 .scan = scan_1x_2x_rs232,
600 .dev_list = dev_list_1x_2x_rs232,
602 .config_get = config_get,
603 .config_set = config_set,
604 .config_list = config_list_sm,
605 .dev_open = std_serial_dev_open,
606 .dev_close = dev_close,
607 .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
608 .dev_acquisition_stop = dev_acquisition_stop,
612 SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
613 .name = "gmc-mh-2x-bd232",
614 .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
616 .init = init_2x_bd232,
617 .cleanup = cleanup_2x_bd232,
618 .scan = scan_2x_bd232,
619 .dev_list = dev_list_2x_bd232,
621 .config_get = config_get,
622 .config_set = config_set,
623 .config_list = config_list_bd,
624 .dev_open = std_serial_dev_open,
625 .dev_close = dev_close,
626 .dev_acquisition_start = dev_acquisition_start_2x_bd232,
627 .dev_acquisition_stop = dev_acquisition_stop,