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_serial_dev_inst *serial;
167 const char *conn, *serialcomm;
169 gboolean serialcomm_given;
172 drvc = (&gmc_mh_1x_2x_rs232_driver_info)->priv;
173 drvc->instances = NULL;
174 conn = serialcomm = NULL;
175 model = METRAHIT_NONE;
176 serialcomm_given = FALSE;
178 sr_spew("scan_1x_2x_rs232() called!");
180 for (l = options; l; l = l->next) {
184 conn = g_variant_get_string(src->data, NULL);
186 case SR_CONF_SERIALCOMM:
187 serialcomm = g_variant_get_string(src->data, NULL);
188 serialcomm_given = TRUE;
195 serialcomm = SERIALCOMM_2X_RS232;
197 serial = sr_serial_dev_inst_new(conn, serialcomm);
199 if (serial_open(serial, SERIAL_RDWR) != SR_OK) {
200 sr_serial_dev_inst_free(serial);
204 serial_flush(serial);
206 model = scan_model_sm(serial);
209 * If detection failed and no user-supplied parameters,
210 * try second baud rate.
212 if ((model == METRAHIT_NONE) && !serialcomm_given) {
213 serialcomm = SERIALCOMM_1X_RS232;
214 g_free(serial->serialcomm);
215 serial->serialcomm = g_strdup(serialcomm);
216 if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
217 serial_flush(serial);
218 model = scan_model_sm(serial);
222 if (model != METRAHIT_NONE) {
223 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model));
224 sdi = g_malloc0(sizeof(struct sr_dev_inst));
225 sdi->status = SR_ST_INACTIVE;
226 sdi->vendor = g_strdup(VENDOR_GMC);
227 sdi->model = g_strdup(gmc_model_str(model));
228 devc = g_malloc0(sizeof(struct dev_context));
230 devc->limit_samples = 0;
231 devc->limit_msec = 0;
232 devc->num_samples = 0;
233 devc->elapsed_msec = g_timer_new();
234 devc->settings_ok = FALSE;
237 sdi->driver = &gmc_mh_1x_2x_rs232_driver_info;
238 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
239 drvc->instances = g_slist_append(drvc->instances, sdi);
240 devices = g_slist_append(devices, sdi);
246 /** Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt 'BD 232' interface.
249 static GSList *scan_2x_bd232(GSList *options)
251 struct sr_dev_inst *sdi;
252 struct drv_context *drvc;
253 struct dev_context *devc;
254 struct sr_config *src;
255 struct sr_serial_dev_inst *serial;
257 const char *conn, *serialcomm;
263 conn = serialcomm = NULL;
266 drvc = (&gmc_mh_2x_bd232_driver_info)->priv;
267 drvc->instances = NULL;
269 sr_spew("scan_2x_bd232() called!");
271 for (l = options; l; l = l->next) {
275 conn = g_variant_get_string(src->data, NULL);
277 case SR_CONF_SERIALCOMM:
278 serialcomm = g_variant_get_string(src->data, NULL);
285 serialcomm = SERIALCOMM_2X;
287 serial = sr_serial_dev_inst_new(conn, serialcomm);
289 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
292 devc = g_malloc0(sizeof(struct dev_context));
294 sdi = g_malloc0(sizeof(struct sr_dev_inst));
295 sdi->status = SR_ST_INACTIVE;
296 sdi->vendor = g_strdup(VENDOR_GMC);
299 /* Send message 03 "Query multimeter version and status" */
302 if (req_stat14(sdi, TRUE) != SR_OK)
305 /* Wait for reply from device(s) for up to 2s. */
306 timeout_us = g_get_monotonic_time() + 2*1000*1000;
308 while (timeout_us > g_get_monotonic_time()) {
309 /* Receive reply (14 bytes) */
311 for (cnt = 0; cnt < 14; cnt++) {
312 byte = read_byte(serial, timeout_us);
314 devc->buf[devc->buflen++] = (byte & MASK_6BITS);
317 if (devc->buflen != 14)
320 devc->addr = devc->buf[0];
324 if (devc->model != METRAHIT_NONE) {
325 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
326 devc->elapsed_msec = g_timer_new();
327 sdi->model = g_strdup(gmc_model_str(devc->model));
328 sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
331 sdi->driver = &gmc_mh_2x_bd232_driver_info;
332 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
333 drvc->instances = g_slist_append(drvc->instances, sdi);
334 devices = g_slist_append(devices, sdi);
335 devc = g_malloc0(sizeof(struct dev_context));
336 sdi = g_malloc0(sizeof(struct sr_dev_inst));
337 sdi->status = SR_ST_INACTIVE;
338 sdi->vendor = g_strdup(VENDOR_GMC);
342 /* Free last alloc if no device found */
343 if (devc->model == METRAHIT_NONE) {
345 sr_dev_inst_free(sdi);
351 sr_info("scan_2x_bd232(): Error!");
354 sr_serial_dev_inst_free(serial);
358 sr_dev_inst_free(sdi);
363 /** Driver device list function */
364 static GSList *dev_list_1x_2x_rs232(void)
366 return ((struct drv_context *)(gmc_mh_1x_2x_rs232_driver_info.priv))->instances;
369 /** Driver device list function */
370 static GSList *dev_list_2x_bd232(void)
372 return ((struct drv_context *)(gmc_mh_2x_bd232_driver_info.priv))
376 static int dev_close(struct sr_dev_inst *sdi)
378 struct dev_context *devc;
380 std_serial_dev_close(sdi);
382 sdi->status = SR_ST_INACTIVE;
384 /* Free dynamically allocated resources. */
385 if ((devc = sdi->priv) && devc->elapsed_msec) {
386 g_timer_destroy(devc->elapsed_msec);
387 devc->elapsed_msec = NULL;
388 devc->model = METRAHIT_NONE;
394 static int cleanup_sm_rs232(void)
396 return std_dev_clear(&gmc_mh_1x_2x_rs232_driver_info, NULL);
399 static int cleanup_2x_bd232(void)
401 return std_dev_clear(&gmc_mh_2x_bd232_driver_info, NULL);
404 /** Get value of configuration item */
405 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
406 const struct sr_channel_group *cg)
409 struct dev_context *devc;
415 if (!sdi || !(devc = sdi->priv))
420 case SR_CONF_LIMIT_SAMPLES:
421 *data = g_variant_new_uint64(devc->limit_samples);
423 case SR_CONF_LIMIT_MSEC:
424 *data = g_variant_new_uint64(devc->limit_msec);
426 case SR_CONF_POWER_OFF:
427 *data = g_variant_new_boolean(FALSE);
436 /** Implementation of config_list, auxiliary function for common parts, */
437 static int config_list_common(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
438 const struct sr_channel_group *cg)
444 case SR_CONF_SCAN_OPTIONS:
445 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
446 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
455 /** Implementation of config_list for Metrahit 1x/2x send mode */
456 static int config_list_sm(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
457 const struct sr_channel_group *cg)
460 case SR_CONF_DEVICE_OPTIONS:
461 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
462 devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
465 return config_list_common(key, data, sdi, cg);
471 /** Implementation of config_list for Metrahit 2x bidirectional mode */
472 static int config_list_bd(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
473 const struct sr_channel_group *cg)
476 case SR_CONF_DEVICE_OPTIONS:
477 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
478 devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
481 return config_list_common(key, data, sdi, cg);
487 static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi,
490 struct dev_context *devc;
491 struct sr_serial_dev_inst *serial;
493 if (!sdi || !cb_data || !(devc = sdi->priv))
496 if (sdi->status != SR_ST_ACTIVE)
497 return SR_ERR_DEV_CLOSED;
499 devc->cb_data = cb_data;
500 devc->settings_ok = FALSE;
503 /* Send header packet to the session bus. */
504 std_session_send_df_header(cb_data, LOG_PREFIX);
506 /* Start timer, if required. */
507 if (devc->limit_msec)
508 g_timer_start(devc->elapsed_msec);
510 /* Poll every 40ms, or whenever some data comes in. */
512 serial_source_add(sdi->session, serial, G_IO_IN, 40,
513 gmc_mh_1x_2x_receive_data, (void *)sdi);
518 static int dev_acquisition_start_2x_bd232(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(sdi->session, serial, G_IO_IN, 40,
544 gmc_mh_2x_receive_data, (void *)sdi);
546 /* Send start message */
547 return req_meas14(sdi);
550 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
552 struct dev_context *devc;
554 /* Stop timer, if required. */
555 if (sdi && (devc = sdi->priv) && devc->limit_msec)
556 g_timer_stop(devc->elapsed_msec);
558 return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
559 sdi->conn, LOG_PREFIX);
562 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
563 .name = "gmc-mh-1x-2x-rs232",
564 .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
566 .init = init_1x_2x_rs232,
567 .cleanup = cleanup_sm_rs232,
568 .scan = scan_1x_2x_rs232,
569 .dev_list = dev_list_1x_2x_rs232,
571 .config_get = config_get,
572 .config_set = config_set,
573 .config_list = config_list_sm,
574 .dev_open = std_serial_dev_open,
575 .dev_close = dev_close,
576 .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
577 .dev_acquisition_stop = dev_acquisition_stop,
581 SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
582 .name = "gmc-mh-2x-bd232",
583 .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
585 .init = init_2x_bd232,
586 .cleanup = cleanup_2x_bd232,
587 .scan = scan_2x_bd232,
588 .dev_list = dev_list_2x_bd232,
590 .config_get = config_get,
591 .config_set = config_set,
592 .config_list = config_list_bd,
593 .dev_open = std_serial_dev_open,
594 .dev_close = dev_close,
595 .dev_acquisition_start = dev_acquisition_start_2x_bd232,
596 .dev_acquisition_stop = dev_acquisition_stop,