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
25 #ifndef LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H
26 #define LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H
30 #include "libsigrok.h"
31 #include "libsigrok-internal.h"
33 #define LOG_PREFIX "gmc-mh-1x-2x"
35 #define GMC_BUFSIZE 266
37 /** Message ID bits 4, 5 */
38 #define MSGID_MASK 0x30 /**< Mask to get message ID bits */
39 #define MSGID_INF 0x00 /**< Start of message with device info */
40 #define MSGID_D10 0x10 /**< Start of data message, non-displayed intermediate */
41 #define MSGID_DTA 0x20 /**< Start of data message, displayed, averaged */
42 #define MSGID_DATA 0x30 /**< Data byte in message */
44 #define MSGC_MASK 0x0f /**< Mask to get message byte contents in send mode */
46 #define MSGSRC_MASK 0xc0 /**< Mask to get bits related to message source */
48 #define bc(x) (x & MSGC_MASK) /**< Get contents from a byte */
50 #define MASK_6BITS 0x3f /**< Mask lower six bits. */
53 * Internal multimeter model codes. In opposite to the multimeter models from
54 * protocol (see decode_model()), these codes allow working with ranges.
57 METRAHIT_NONE = 0, /**< Value for uninitialized variable */
64 METRAHIT_16X = METRAHIT_16I, /**< All Metrahit 16 */
65 /* A Metrahit 17 exists, but seems not to have an IR interface. */
67 METRAHIT_2X = 20, /**< For model type comparisons */
68 METRAHIT_22SM = METRAHIT_2X + 1, /**< Send mode */
69 METRAHIT_22S = METRAHIT_22SM + 1, /**< Bidi mode */
70 METRAHIT_22M = METRAHIT_22S + 1, /**< Bidi mode */
71 METRAHIT_23S = METRAHIT_22M + 1,
72 METRAHIT_24S = METRAHIT_23S + 1,
73 METRAHIT_25S = METRAHIT_24S + 1,
74 METRAHIT_26SM = METRAHIT_25S + 1, /**< Send mode */
75 METRAHIT_26S = METRAHIT_26SM + 1, /**< Bidi mode */
76 METRAHIT_26M = METRAHIT_26S + 1, /**< Bidi mode */
77 METRAHIT_28S = METRAHIT_26M + 1,
78 METRAHIT_29S = METRAHIT_28S + 1,
81 /** Private, per-device-instance driver context. */
83 /* Model-specific information */
84 enum model model; /**< Model code. */
86 /* Acquisition settings */
87 uint64_t limit_samples; /**< Target number of samples */
88 uint64_t limit_msec; /**< Target sampling time */
90 /* Opaque pointer passed in by frontend. */
93 /* Operational state */
94 gboolean settings_ok; /**< Settings msg received yet. */
95 int msg_type; /**< Message type (MSGID_INF, ...). */
96 int msg_len; /**< Message lengh (valid when msg, curr. type known).*/
97 int mq; /**< Measured quantity */
98 int unit; /**< Measured unit */
99 uint64_t mqflags; /**< Measured quantity flags */
100 float value; /**< Measured value */
101 float scale; /**< Scale for value. */
102 int8_t scale1000; /**< Additional scale factor 1000x. */
103 gboolean vmains_29S; /**< Measured ctmv is V mains (29S only). */
104 int addr; /**< Device address (1..15). */
105 int cmd_idx; /**< Parameter "Idx" (Index) of current command, if required. */
106 int cmd_seq; /**< Command sequence. Used to query status every n messages. */
107 gboolean autorng; /**< Auto range enabled. */
108 float ubatt; /**< Battery voltage. */
109 uint8_t fw_ver_maj; /**< Firmware version major. */
110 uint8_t fw_ver_min; /**< Firmware version minor. */
111 int64_t req_sent_at; /**< Request sent. */
112 gboolean response_pending; /**< Request sent, response is pending. */
114 /* Temporary state across callbacks */
115 uint64_t num_samples; /**< Current #samples for limit_samples */
116 GTimer *elapsed_msec; /**< Used for sampling with limit_msec */
117 uint8_t buf[GMC_BUFSIZE]; /**< Buffer for read callback */
118 int buflen; /**< Data len in buf */
121 /* Forward declarations */
122 SR_PRIV int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
123 const struct sr_probe_group *probe_group);
124 SR_PRIV void create_cmd_14(guchar addr, guchar func, guchar* params, guchar* buf);
125 SR_PRIV void dump_msg14(guchar* buf, gboolean raw);
126 SR_PRIV int gmc_decode_model_bd(uint8_t mcode);
127 SR_PRIV int gmc_decode_model_sm(uint8_t mcode);
128 SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data);
129 SR_PRIV int gmc_mh_2x_receive_data(int fd, int revents, void *cb_data);
130 SR_PRIV const char *gmc_model_str(enum model mcode);
131 SR_PRIV int process_msg14(struct sr_dev_inst *sdi);
132 SR_PRIV int req_meas14(const struct sr_dev_inst *sdi);
133 SR_PRIV int req_stat14(const struct sr_dev_inst *sdi, gboolean power_on);