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 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 model = METRAHIT_NONE;
169 serialcomm_given = FALSE;
171 sr_spew("scan_1x_2x_rs232() called!");
173 for (l = options; l; l = l->next) {
177 conn = g_variant_get_string(src->data, NULL);
179 case SR_CONF_SERIALCOMM:
180 serialcomm = g_variant_get_string(src->data, NULL);
181 serialcomm_given = TRUE;
188 serialcomm = SERIALCOMM_2X_RS232;
190 serial = sr_serial_dev_inst_new(conn, serialcomm);
192 if (serial_open(serial, SERIAL_RDWR) != SR_OK) {
193 sr_serial_dev_inst_free(serial);
197 serial_flush(serial);
199 model = scan_model_sm(serial);
202 * If detection failed and no user-supplied parameters,
203 * try second baud rate.
205 if ((model == METRAHIT_NONE) && !serialcomm_given) {
206 serialcomm = SERIALCOMM_1X_RS232;
207 g_free(serial->serialcomm);
208 serial->serialcomm = g_strdup(serialcomm);
209 if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
210 serial_flush(serial);
211 model = scan_model_sm(serial);
215 if (model != METRAHIT_NONE) {
216 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model));
217 sdi = g_malloc0(sizeof(struct sr_dev_inst));
218 sdi->status = SR_ST_INACTIVE;
219 sdi->vendor = g_strdup(VENDOR_GMC);
220 sdi->model = g_strdup(gmc_model_str(model));
221 devc = g_malloc0(sizeof(struct dev_context));
223 devc->limit_samples = 0;
224 devc->limit_msec = 0;
225 devc->num_samples = 0;
226 devc->elapsed_msec = g_timer_new();
227 devc->settings_ok = FALSE;
231 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
232 drvc->instances = g_slist_append(drvc->instances, sdi);
233 devices = g_slist_append(devices, sdi);
240 * Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt
241 * 'BD 232' interface.
243 static GSList *scan_2x_bd232(struct sr_dev_driver *di, GSList *options)
245 struct sr_dev_inst *sdi;
246 struct drv_context *drvc;
247 struct dev_context *devc;
248 struct sr_config *src;
249 struct sr_serial_dev_inst *serial;
251 const char *conn, *serialcomm;
257 conn = serialcomm = NULL;
261 drvc->instances = NULL;
263 sr_spew("scan_2x_bd232() called!");
265 for (l = options; l; l = l->next) {
269 conn = g_variant_get_string(src->data, NULL);
271 case SR_CONF_SERIALCOMM:
272 serialcomm = g_variant_get_string(src->data, NULL);
279 serialcomm = SERIALCOMM_2X;
281 serial = sr_serial_dev_inst_new(conn, serialcomm);
283 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
286 devc = g_malloc0(sizeof(struct dev_context));
288 sdi = g_malloc0(sizeof(struct sr_dev_inst));
289 sdi->status = SR_ST_INACTIVE;
290 sdi->vendor = g_strdup(VENDOR_GMC);
293 /* Send message 03 "Query multimeter version and status" */
296 if (req_stat14(sdi, TRUE) != SR_OK)
299 /* Wait for reply from device(s) for up to 2s. */
300 timeout_us = g_get_monotonic_time() + 2*1000*1000;
302 while (timeout_us > g_get_monotonic_time()) {
303 /* Receive reply (14 bytes) */
305 for (cnt = 0; cnt < 14; cnt++) {
306 byte = read_byte(serial, timeout_us);
308 devc->buf[devc->buflen++] = (byte & MASK_6BITS);
311 if (devc->buflen != 14)
314 devc->addr = devc->buf[0];
318 if (devc->model != METRAHIT_NONE) {
319 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
320 devc->elapsed_msec = g_timer_new();
321 sdi->model = g_strdup(gmc_model_str(devc->model));
322 sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
326 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
327 drvc->instances = g_slist_append(drvc->instances, sdi);
328 devices = g_slist_append(devices, sdi);
329 devc = g_malloc0(sizeof(struct dev_context));
330 sdi = g_malloc0(sizeof(struct sr_dev_inst));
331 sdi->status = SR_ST_INACTIVE;
332 sdi->vendor = g_strdup(VENDOR_GMC);
336 /* Free last alloc if no device found */
337 if (devc->model == METRAHIT_NONE) {
339 sr_dev_inst_free(sdi);
345 sr_info("scan_2x_bd232(): Error!");
348 sr_serial_dev_inst_free(serial);
352 sr_dev_inst_free(sdi);
357 static GSList *dev_list(const struct sr_dev_driver *di)
359 return ((struct drv_context *)(di->priv))->instances;
362 static int dev_close(struct sr_dev_inst *sdi)
364 struct dev_context *devc;
366 std_serial_dev_close(sdi);
368 sdi->status = SR_ST_INACTIVE;
370 /* Free dynamically allocated resources. */
371 if ((devc = sdi->priv) && devc->elapsed_msec) {
372 g_timer_destroy(devc->elapsed_msec);
373 devc->elapsed_msec = NULL;
374 devc->model = METRAHIT_NONE;
380 static int cleanup(const struct sr_dev_driver *di)
382 return std_dev_clear(di, NULL);
385 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
386 const struct sr_channel_group *cg)
389 struct dev_context *devc;
395 if (!sdi || !(devc = sdi->priv))
400 case SR_CONF_LIMIT_SAMPLES:
401 *data = g_variant_new_uint64(devc->limit_samples);
403 case SR_CONF_LIMIT_MSEC:
404 *data = g_variant_new_uint64(devc->limit_msec);
406 case SR_CONF_POWER_OFF:
407 *data = g_variant_new_boolean(FALSE);
416 /** Implementation of config_list, auxiliary function for common parts. */
417 static int config_list_common(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
418 const struct sr_channel_group *cg)
424 case SR_CONF_SCAN_OPTIONS:
425 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
426 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
435 /** Implementation of config_list for Metrahit 1x/2x send mode */
436 static int config_list_sm(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
437 const struct sr_channel_group *cg)
440 case SR_CONF_DEVICE_OPTIONS:
441 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
442 devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
445 return config_list_common(key, data, sdi, cg);
451 /** Implementation of config_list for Metrahit 2x bidirectional mode */
452 static int config_list_bd(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
453 const struct sr_channel_group *cg)
456 case SR_CONF_DEVICE_OPTIONS:
457 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
458 devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
461 return config_list_common(key, data, sdi, cg);
467 static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi,
470 struct dev_context *devc;
471 struct sr_serial_dev_inst *serial;
473 if (!sdi || !cb_data || !(devc = sdi->priv))
476 if (sdi->status != SR_ST_ACTIVE)
477 return SR_ERR_DEV_CLOSED;
479 devc->cb_data = cb_data;
480 devc->settings_ok = FALSE;
483 /* Send header packet to the session bus. */
484 std_session_send_df_header(cb_data, LOG_PREFIX);
486 /* Start timer, if required. */
487 if (devc->limit_msec)
488 g_timer_start(devc->elapsed_msec);
490 /* Poll every 40ms, or whenever some data comes in. */
492 serial_source_add(sdi->session, serial, G_IO_IN, 40,
493 gmc_mh_1x_2x_receive_data, (void *)sdi);
498 static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi,
501 struct dev_context *devc;
502 struct sr_serial_dev_inst *serial;
504 if (!sdi || !cb_data || !(devc = sdi->priv))
507 if (sdi->status != SR_ST_ACTIVE)
508 return SR_ERR_DEV_CLOSED;
510 devc->cb_data = cb_data;
511 devc->settings_ok = FALSE;
514 /* Send header packet to the session bus. */
515 std_session_send_df_header(cb_data, LOG_PREFIX);
517 /* Start timer, if required. */
518 if (devc->limit_msec)
519 g_timer_start(devc->elapsed_msec);
521 /* Poll every 40ms, or whenever some data comes in. */
523 serial_source_add(sdi->session, serial, G_IO_IN, 40,
524 gmc_mh_2x_receive_data, (void *)sdi);
526 /* Send start message */
527 return req_meas14(sdi);
530 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
532 struct dev_context *devc;
534 /* Stop timer, if required. */
535 if (sdi && (devc = sdi->priv) && devc->limit_msec)
536 g_timer_stop(devc->elapsed_msec);
538 return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
539 sdi->conn, LOG_PREFIX);
542 SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
543 .name = "gmc-mh-1x-2x-rs232",
544 .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
548 .scan = scan_1x_2x_rs232,
549 .dev_list = dev_list,
551 .config_get = config_get,
552 .config_set = config_set,
553 .config_list = config_list_sm,
554 .dev_open = std_serial_dev_open,
555 .dev_close = dev_close,
556 .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
557 .dev_acquisition_stop = dev_acquisition_stop,
561 SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
562 .name = "gmc-mh-2x-bd232",
563 .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
567 .scan = scan_2x_bd232,
568 .dev_list = dev_list,
570 .config_get = config_get,
571 .config_set = config_set,
572 .config_list = config_list_bd,
573 .dev_open = std_serial_dev_open,
574 .dev_close = dev_close,
575 .dev_acquisition_start = dev_acquisition_start_2x_bd232,
576 .dev_acquisition_stop = dev_acquisition_stop,