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 static const uint32_t scanopts[] = {
40 /** Hardware capabilities for Metrahit 1x/2x devices in send mode. */
41 static const uint32_t devopts_sm[] = {
43 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
45 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
46 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
49 /** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */
50 static const uint32_t devopts_bd[] = {
52 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
54 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
55 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
56 SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET,
60 * - For the 29S SR_CONF_ENERGYMETER, too.
61 * - SR_CONF_PATTERN_MODE for some 2x devices
62 * - SR_CONF_DATALOG for 22M, 26M, 29S and storage adaptors.
63 * Need to implement device-specific lists.
67 * Read single byte from serial port.
69 * @retval -1 Timeout or error.
72 static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout)
78 rc = serial_read_nonblocking(serial, &result, 1);
80 sr_spew("read: 0x%02x/%d", result, result);
83 if (g_get_monotonic_time() > timeout)
90 * Try to detect GMC 1x/2x multimeter model in send mode for max. 1 second.
92 * @param serial Configured, open serial port.
94 * @retval NULL Detection failed.
95 * @retval other Model code.
97 static enum model scan_model_sm(struct sr_serial_dev_inst *serial)
99 int byte, bytecnt, cnt;
103 model = METRAHIT_NONE;
104 timeout_us = g_get_monotonic_time() + (1 * 1000 * 1000);
107 * Try to find message consisting of device code and several
108 * (at least 4) data bytes.
110 for (bytecnt = 0; bytecnt < 100; bytecnt++) {
111 byte = read_byte(serial, timeout_us);
112 if ((byte == -1) || (timeout_us < g_get_monotonic_time()))
114 if ((byte & MSGID_MASK) == MSGID_INF) {
115 if (!(model = gmc_decode_model_sm(byte & MSGC_MASK)))
117 /* Now expect (at least) 4 data bytes. */
118 for (cnt = 0; cnt < 4; cnt++) {
119 byte = read_byte(serial, timeout_us);
121 ((byte & MSGID_MASK) != MSGID_DATA))
123 model = METRAHIT_NONE;
136 * Scan for Metrahit 1x and Metrahit 2x in send mode using Gossen Metrawatt
139 * The older 1x models use 8192 baud and the newer 2x 9600 baud.
140 * The DMM usually sends up to about 20 messages per second. However, depending
141 * on configuration and measurement mode the intervals can be much larger and
142 * then the detection might not work.
144 static GSList *scan_1x_2x_rs232(struct sr_dev_driver *di, GSList *options)
146 struct sr_dev_inst *sdi;
147 struct drv_context *drvc;
148 struct dev_context *devc;
149 struct sr_config *src;
150 struct sr_serial_dev_inst *serial;
152 const char *conn, *serialcomm;
154 gboolean serialcomm_given;
158 conn = serialcomm = NULL;
159 serialcomm_given = FALSE;
161 sr_spew("scan_1x_2x_rs232() called!");
163 for (l = options; l; l = l->next) {
167 conn = g_variant_get_string(src->data, NULL);
169 case SR_CONF_SERIALCOMM:
170 serialcomm = g_variant_get_string(src->data, NULL);
171 serialcomm_given = TRUE;
178 serialcomm = SERIALCOMM_2X_RS232;
180 serial = sr_serial_dev_inst_new(conn, serialcomm);
182 if (serial_open(serial, SERIAL_RDWR) != SR_OK) {
183 sr_serial_dev_inst_free(serial);
187 serial_flush(serial);
189 model = scan_model_sm(serial);
192 * If detection failed and no user-supplied parameters,
193 * try second baud rate.
195 if ((model == METRAHIT_NONE) && !serialcomm_given) {
196 serialcomm = SERIALCOMM_1X_RS232;
197 g_free(serial->serialcomm);
198 serial->serialcomm = g_strdup(serialcomm);
199 if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
200 serial_flush(serial);
201 model = scan_model_sm(serial);
205 if (model != METRAHIT_NONE) {
206 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model));
207 sdi = g_malloc0(sizeof(struct sr_dev_inst));
208 sdi->status = SR_ST_INACTIVE;
209 sdi->vendor = g_strdup(VENDOR_GMC);
210 sdi->model = g_strdup(gmc_model_str(model));
211 devc = g_malloc0(sizeof(struct dev_context));
213 devc->limit_samples = 0;
214 devc->limit_msec = 0;
215 devc->num_samples = 0;
216 devc->elapsed_msec = g_timer_new();
217 devc->settings_ok = FALSE;
220 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
221 devices = g_slist_append(devices, sdi);
224 return std_scan_complete(di, devices);
228 * Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt
229 * 'BD 232' interface.
231 static GSList *scan_2x_bd232(struct sr_dev_driver *di, GSList *options)
233 struct sr_dev_inst *sdi;
234 struct drv_context *drvc;
235 struct dev_context *devc;
236 struct sr_config *src;
237 struct sr_serial_dev_inst *serial;
239 const char *conn, *serialcomm;
245 conn = serialcomm = NULL;
250 sr_spew("scan_2x_bd232() called!");
252 for (l = options; l; l = l->next) {
256 conn = g_variant_get_string(src->data, NULL);
258 case SR_CONF_SERIALCOMM:
259 serialcomm = g_variant_get_string(src->data, NULL);
266 serialcomm = SERIALCOMM_2X;
268 serial = sr_serial_dev_inst_new(conn, serialcomm);
270 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
273 devc = g_malloc0(sizeof(struct dev_context));
275 sdi = g_malloc0(sizeof(struct sr_dev_inst));
276 sdi->status = SR_ST_INACTIVE;
277 sdi->vendor = g_strdup(VENDOR_GMC);
280 /* Send message 03 "Query multimeter version and status" */
282 if (req_stat14(sdi, TRUE) != SR_OK)
285 /* Wait for reply from device(s) for up to 2s. */
286 timeout_us = g_get_monotonic_time() + (2 * 1000 * 1000);
288 while (timeout_us > g_get_monotonic_time()) {
289 /* Receive reply (14 bytes) */
291 for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
292 byte = read_byte(serial, timeout_us);
294 devc->buf[devc->buflen++] = (byte & MASK_6BITS);
297 if (devc->buflen != GMC_REPLY_SIZE)
300 devc->addr = devc->buf[0];
304 if (devc->model != METRAHIT_NONE) {
305 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
306 devc->elapsed_msec = g_timer_new();
307 sdi->model = g_strdup(gmc_model_str(devc->model));
308 sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
311 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
312 devices = g_slist_append(devices, sdi);
313 devc = g_malloc0(sizeof(struct dev_context));
314 sdi = g_malloc0(sizeof(struct sr_dev_inst));
315 sdi->status = SR_ST_INACTIVE;
316 sdi->vendor = g_strdup(VENDOR_GMC);
320 /* Free last alloc if no device found */
321 if (devc->model == METRAHIT_NONE) {
323 sr_dev_inst_free(sdi);
326 return std_scan_complete(di, devices);
329 sr_info("scan_2x_bd232(): Error!");
332 sr_serial_dev_inst_free(serial);
335 sr_dev_inst_free(sdi);
340 static int dev_close(struct sr_dev_inst *sdi)
342 struct dev_context *devc;
344 std_serial_dev_close(sdi);
346 sdi->status = SR_ST_INACTIVE;
348 /* Free dynamically allocated resources. */
349 if ((devc = sdi->priv) && devc->elapsed_msec) {
350 g_timer_destroy(devc->elapsed_msec);
351 devc->elapsed_msec = NULL;
352 devc->model = METRAHIT_NONE;
358 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
359 const struct sr_channel_group *cg)
362 struct dev_context *devc;
373 case SR_CONF_LIMIT_SAMPLES:
374 *data = g_variant_new_uint64(devc->limit_samples);
376 case SR_CONF_LIMIT_MSEC:
377 *data = g_variant_new_uint64(devc->limit_msec);
379 case SR_CONF_POWER_OFF:
380 *data = g_variant_new_boolean(FALSE);
389 /** Implementation of config_list, auxiliary function for common parts. */
390 static int config_list_common(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
391 const struct sr_channel_group *cg)
397 case SR_CONF_SCAN_OPTIONS:
398 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
399 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
408 /** Implementation of config_list for Metrahit 1x/2x send mode */
409 static int config_list_sm(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
410 const struct sr_channel_group *cg)
413 case SR_CONF_DEVICE_OPTIONS:
414 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
415 devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
418 return config_list_common(key, data, sdi, cg);
424 /** Implementation of config_list for Metrahit 2x bidirectional mode */
425 static int config_list_bd(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
426 const struct sr_channel_group *cg)
429 case SR_CONF_DEVICE_OPTIONS:
430 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
431 devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
434 return config_list_common(key, data, sdi, cg);
440 static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi)
442 struct dev_context *devc;
443 struct sr_serial_dev_inst *serial;
445 if (sdi->status != SR_ST_ACTIVE)
446 return SR_ERR_DEV_CLOSED;
449 devc->settings_ok = FALSE;
452 std_session_send_df_header(sdi, LOG_PREFIX);
454 /* Start timer, if required. */
455 if (devc->limit_msec)
456 g_timer_start(devc->elapsed_msec);
458 /* Poll every 40ms, or whenever some data comes in. */
460 serial_source_add(sdi->session, serial, G_IO_IN, 40,
461 gmc_mh_1x_2x_receive_data, (void *)sdi);
466 static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi)
468 struct dev_context *devc;
469 struct sr_serial_dev_inst *serial;
471 if (sdi->status != SR_ST_ACTIVE)
472 return SR_ERR_DEV_CLOSED;
475 devc->settings_ok = FALSE;
478 std_session_send_df_header(sdi, LOG_PREFIX);
480 /* Start timer, if required. */
481 if (devc->limit_msec)
482 g_timer_start(devc->elapsed_msec);
484 /* Poll every 40ms, or whenever some data comes in. */
486 serial_source_add(sdi->session, serial, G_IO_IN, 40,
487 gmc_mh_2x_receive_data, (void *)sdi);
489 /* Send start message */
490 return req_meas14(sdi);
493 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
495 struct dev_context *devc;
497 /* Stop timer, if required. */
498 if (sdi && (devc = sdi->priv) && devc->limit_msec)
499 g_timer_stop(devc->elapsed_msec);
501 return std_serial_dev_acquisition_stop(sdi, dev_close,
502 sdi->conn, LOG_PREFIX);
505 static struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
506 .name = "gmc-mh-1x-2x-rs232",
507 .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
510 .cleanup = std_cleanup,
511 .scan = scan_1x_2x_rs232,
512 .dev_list = std_dev_list,
514 .config_get = config_get,
515 .config_set = config_set,
516 .config_list = config_list_sm,
517 .dev_open = std_serial_dev_open,
518 .dev_close = dev_close,
519 .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
520 .dev_acquisition_stop = dev_acquisition_stop,
523 SR_REGISTER_DEV_DRIVER(gmc_mh_1x_2x_rs232_driver_info);
525 static struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
526 .name = "gmc-mh-2x-bd232",
527 .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
530 .cleanup = std_cleanup,
531 .scan = scan_2x_bd232,
532 .dev_list = std_dev_list,
534 .config_get = config_get,
535 .config_set = config_set,
536 .config_list = config_list_bd,
537 .dev_open = std_serial_dev_open,
538 .dev_close = dev_close,
539 .dev_acquisition_start = dev_acquisition_start_2x_bd232,
540 .dev_acquisition_stop = dev_acquisition_stop,
543 SR_REGISTER_DEV_DRIVER(gmc_mh_2x_bd232_driver_info);