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 uint32_t scanopts[] = {
42 /** Hardware capabilities for Metrahit 1x/2x devices in send mode. */
43 static const uint32_t devopts_sm[] = {
45 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
47 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
48 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
51 /** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */
52 static const uint32_t devopts_bd[] = {
54 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
56 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
57 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
58 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 /** 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_nonblocking(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_channel *ch;
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) != 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 sdi = sr_dev_inst_new();
227 sdi->status = SR_ST_INACTIVE;
228 sdi->vendor = g_strdup(VENDOR_GMC);
229 sdi->model = g_strdup(gmc_model_str(model));
230 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
231 sr_err("Device context malloc failed.");
235 devc->limit_samples = 0;
236 devc->limit_msec = 0;
237 devc->num_samples = 0;
238 devc->elapsed_msec = g_timer_new();
239 devc->settings_ok = FALSE;
243 sdi->driver = &gmc_mh_1x_2x_rs232_driver_info;
244 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
246 sdi->channels = g_slist_append(sdi->channels, ch);
247 drvc->instances = g_slist_append(drvc->instances, sdi);
248 devices = g_slist_append(devices, sdi);
254 /** Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt 'BD 232' interface.
257 static GSList *scan_2x_bd232(GSList *options)
259 struct sr_dev_inst *sdi;
260 struct drv_context *drvc;
261 struct dev_context *devc;
262 struct sr_config *src;
263 struct sr_channel *ch;
264 struct sr_serial_dev_inst *serial;
266 const char *conn, *serialcomm;
272 conn = serialcomm = NULL;
275 drvc = (&gmc_mh_2x_bd232_driver_info)->priv;
276 drvc->instances = NULL;
278 sr_spew("scan_2x_bd232() called!");
280 for (l = options; l; l = l->next) {
284 conn = g_variant_get_string(src->data, NULL);
286 case SR_CONF_SERIALCOMM:
287 serialcomm = g_variant_get_string(src->data, NULL);
294 serialcomm = SERIALCOMM_2X;
296 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
299 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
302 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
303 sr_err("Device context malloc failed.");
307 sdi = sr_dev_inst_new();
308 sdi->status = SR_ST_INACTIVE;
309 sdi->vendor = g_strdup(VENDOR_GMC);
312 /* Send message 03 "Query multimeter version and status" */
315 if (req_stat14(sdi, TRUE) != SR_OK)
318 /* Wait for reply from device(s) for up to 2s. */
319 timeout_us = g_get_monotonic_time() + 2*1000*1000;
321 while (timeout_us > g_get_monotonic_time()) {
322 /* Receive reply (14 bytes) */
324 for (cnt = 0; cnt < 14; cnt++) {
325 byte = read_byte(serial, timeout_us);
327 devc->buf[devc->buflen++] = (byte & MASK_6BITS);
330 if (devc->buflen != 14)
333 devc->addr = devc->buf[0];
337 if (devc->model != METRAHIT_NONE) {
338 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
340 devc->elapsed_msec = g_timer_new();
342 sdi->model = g_strdup(gmc_model_str(devc->model));
343 sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
346 sdi->driver = &gmc_mh_2x_bd232_driver_info;
347 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
349 sdi->channels = g_slist_append(sdi->channels, ch);
350 drvc->instances = g_slist_append(drvc->instances, sdi);
351 devices = g_slist_append(devices, sdi);
353 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
354 sr_err("Device context malloc failed.");
358 sdi = sr_dev_inst_new();
359 sdi->status = SR_ST_INACTIVE;
360 sdi->vendor = g_strdup(VENDOR_GMC);
364 /* Free last alloc if no device found */
365 if (devc->model == METRAHIT_NONE) {
367 sr_dev_inst_free(sdi);
373 sr_info("scan_2x_bd232(): Error!");
376 sr_serial_dev_inst_free(serial);
380 sr_dev_inst_free(sdi);
385 /** Driver device list function */
386 static GSList *dev_list_1x_2x_rs232(void)
388 return ((struct drv_context *)(gmc_mh_1x_2x_rs232_driver_info.priv))->instances;
391 /** Driver device list function */
392 static GSList *dev_list_2x_bd232(void)
394 return ((struct drv_context *)(gmc_mh_2x_bd232_driver_info.priv))
398 static int dev_close(struct sr_dev_inst *sdi)
400 struct dev_context *devc;
402 std_serial_dev_close(sdi);
404 sdi->status = SR_ST_INACTIVE;
406 /* Free dynamically allocated resources. */
407 if ((devc = sdi->priv) && devc->elapsed_msec) {
408 g_timer_destroy(devc->elapsed_msec);
409 devc->elapsed_msec = NULL;
410 devc->model = METRAHIT_NONE;
416 static int cleanup_sm_rs232(void)
418 return std_dev_clear(&gmc_mh_1x_2x_rs232_driver_info, NULL);
421 static int cleanup_2x_bd232(void)
423 return std_dev_clear(&gmc_mh_2x_bd232_driver_info, NULL);
426 /** Get value of configuration item */
427 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
428 const struct sr_channel_group *cg)
431 struct dev_context *devc;
437 if (!sdi || !(devc = sdi->priv))
442 case SR_CONF_LIMIT_SAMPLES:
443 *data = g_variant_new_uint64(devc->limit_samples);
445 case SR_CONF_LIMIT_MSEC:
446 *data = g_variant_new_uint64(devc->limit_msec);
448 case SR_CONF_POWER_OFF:
449 *data = g_variant_new_boolean(FALSE);
458 /** Implementation of config_list, auxiliary function for common parts, */
459 static int config_list_common(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
460 const struct sr_channel_group *cg)
466 case SR_CONF_SCAN_OPTIONS:
467 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
468 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
477 /** Implementation of config_list for Metrahit 1x/2x send mode */
478 static int config_list_sm(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
479 const struct sr_channel_group *cg)
482 case SR_CONF_DEVICE_OPTIONS:
483 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
484 devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
487 return config_list_common(key, data, sdi, cg);
493 /** Implementation of config_list for Metrahit 2x bidirectional mode */
494 static int config_list_bd(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
495 const struct sr_channel_group *cg)
498 case SR_CONF_DEVICE_OPTIONS:
499 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
500 devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
503 return config_list_common(key, data, sdi, cg);
509 static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi,
512 struct dev_context *devc;
513 struct sr_serial_dev_inst *serial;
515 if (!sdi || !cb_data || !(devc = sdi->priv))
518 if (sdi->status != SR_ST_ACTIVE)
519 return SR_ERR_DEV_CLOSED;
521 devc->cb_data = cb_data;
522 devc->settings_ok = FALSE;
525 /* Send header packet to the session bus. */
526 std_session_send_df_header(cb_data, LOG_PREFIX);
528 /* Start timer, if required. */
529 if (devc->limit_msec)
530 g_timer_start(devc->elapsed_msec);
532 /* Poll every 40ms, or whenever some data comes in. */
534 serial_source_add(sdi->session, serial, G_IO_IN, 40,
535 gmc_mh_1x_2x_receive_data, (void *)sdi);
540 static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi,
543 struct dev_context *devc;
544 struct sr_serial_dev_inst *serial;
546 if (!sdi || !cb_data || !(devc = sdi->priv))
549 if (sdi->status != SR_ST_ACTIVE)
550 return SR_ERR_DEV_CLOSED;
552 devc->cb_data = cb_data;
553 devc->settings_ok = FALSE;
556 /* Send header packet to the session bus. */
557 std_session_send_df_header(cb_data, LOG_PREFIX);
559 /* Start timer, if required. */
560 if (devc->limit_msec)
561 g_timer_start(devc->elapsed_msec);
563 /* Poll every 40ms, or whenever some data comes in. */
565 serial_source_add(sdi->session, serial, G_IO_IN, 40,
566 gmc_mh_2x_receive_data, (void *)sdi);
568 /* Send start message */
569 return req_meas14(sdi);
572 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
574 struct dev_context *devc;
576 /* Stop timer, if required. */
577 if (sdi && (devc = sdi->priv) && devc->limit_msec)
578 g_timer_stop(devc->elapsed_msec);
580 return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
581 sdi->conn, LOG_PREFIX);
584 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
585 .name = "gmc-mh-1x-2x-rs232",
586 .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
588 .init = init_1x_2x_rs232,
589 .cleanup = cleanup_sm_rs232,
590 .scan = scan_1x_2x_rs232,
591 .dev_list = dev_list_1x_2x_rs232,
593 .config_get = config_get,
594 .config_set = config_set,
595 .config_list = config_list_sm,
596 .dev_open = std_serial_dev_open,
597 .dev_close = dev_close,
598 .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
599 .dev_acquisition_stop = dev_acquisition_stop,
603 SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
604 .name = "gmc-mh-2x-bd232",
605 .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
607 .init = init_2x_bd232,
608 .cleanup = cleanup_2x_bd232,
609 .scan = scan_2x_bd232,
610 .dev_list = dev_list_2x_bd232,
612 .config_get = config_get,
613 .config_set = config_set,
614 .config_list = config_list_bd,
615 .dev_open = std_serial_dev_open,
616 .dev_close = dev_close,
617 .dev_acquisition_start = dev_acquisition_start_2x_bd232,
618 .dev_acquisition_stop = dev_acquisition_stop,