]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013, 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
20 | /** @file | |
21 | * Gossen Metrawatt Metrahit 1x/2x drivers | |
22 | * @internal | |
23 | */ | |
24 | ||
25 | #ifndef LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H | |
26 | #define LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H | |
27 | ||
28 | #include <stdint.h> | |
29 | #include <glib.h> | |
30 | #include "libsigrok.h" | |
31 | #include "libsigrok-internal.h" | |
32 | ||
33 | #define LOG_PREFIX "gmc-mh-1x-2x" | |
34 | ||
35 | #define GMC_BUFSIZE 266 | |
36 | ||
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 */ | |
43 | ||
44 | #define MSGC_MASK 0x0f /**< Mask to get message byte contents in send mode */ | |
45 | ||
46 | #define MSGSRC_MASK 0xc0 /**< Mask to get bits related to message source */ | |
47 | ||
48 | #define bc(x) (x & MSGC_MASK) /**< Get contents from a byte */ | |
49 | ||
50 | #define MASK_6BITS 0x3f /**< Mask lower six bits. */ | |
51 | ||
52 | /** | |
53 | * Internal multimeter model codes. In opposite to the multimeter models from | |
54 | * protocol (see decode_model()), these codes allow working with ranges. | |
55 | */ | |
56 | enum model { | |
57 | METRAHIT_NONE = 0, /**< Value for uninitialized variable */ | |
58 | METRAHIT_12S = 12, | |
59 | METRAHIT_13S14A = 13, | |
60 | METRAHIT_14S = 14, | |
61 | METRAHIT_15S = 15, | |
62 | METRAHIT_16S = 16, | |
63 | METRAHIT_16I = 17, /**< Metrahit 16I, L */ | |
64 | METRAHIT_16T = 18, /**< Metrahit 16T, U, KMM2002 */ | |
65 | METRAHIT_16X = METRAHIT_16T, /**< All Metrahit 16 */ | |
66 | /* A Metrahit 17 exists, but seems not to have an IR interface. */ | |
67 | METRAHIT_18S = 19, | |
68 | METRAHIT_2X = 20, /**< For model type comparisons */ | |
69 | METRAHIT_22SM = METRAHIT_2X + 1, /**< Send mode */ | |
70 | METRAHIT_22S = METRAHIT_22SM + 1, /**< Bidi mode */ | |
71 | METRAHIT_22M = METRAHIT_22S + 1, /**< Bidi mode */ | |
72 | METRAHIT_23S = METRAHIT_22M + 1, | |
73 | METRAHIT_24S = METRAHIT_23S + 1, | |
74 | METRAHIT_25S = METRAHIT_24S + 1, | |
75 | METRAHIT_26SM = METRAHIT_25S + 1, /**< Send mode */ | |
76 | METRAHIT_26S = METRAHIT_26SM + 1, /**< Bidi mode */ | |
77 | METRAHIT_26M = METRAHIT_26S + 1, /**< Bidi mode */ | |
78 | /* The Metrahit 27x and 28Cx have a totally different protocol */ | |
79 | METRAHIT_28S = METRAHIT_26M + 1, | |
80 | METRAHIT_29S = METRAHIT_28S + 1, | |
81 | }; | |
82 | ||
83 | /** Private, per-device-instance driver context. */ | |
84 | struct dev_context { | |
85 | /* Model-specific information */ | |
86 | enum model model; /**< Model code. */ | |
87 | ||
88 | /* Acquisition settings */ | |
89 | uint64_t limit_samples; /**< Target number of samples */ | |
90 | uint64_t limit_msec; /**< Target sampling time */ | |
91 | ||
92 | /* Opaque pointer passed in by frontend. */ | |
93 | void *cb_data; | |
94 | ||
95 | /* Operational state */ | |
96 | gboolean settings_ok; /**< Settings msg received yet. */ | |
97 | int msg_type; /**< Message type (MSGID_INF, ...). */ | |
98 | int msg_len; /**< Message lengh (valid when msg, curr. type known).*/ | |
99 | int mq; /**< Measured quantity */ | |
100 | int unit; /**< Measured unit */ | |
101 | uint64_t mqflags; /**< Measured quantity flags */ | |
102 | float value; /**< Measured value */ | |
103 | float scale; /**< Scale for value. */ | |
104 | int8_t scale1000; /**< Additional scale factor 1000x. */ | |
105 | int addr; /**< Device address (1..15). */ | |
106 | int cmd_idx; /**< Parameter "Idx" (Index) of current command, if required. */ | |
107 | int cmd_seq; /**< Command sequence. Used to query status every n messages. */ | |
108 | gboolean autorng; /**< Auto range enabled. */ | |
109 | float ubatt; /**< Battery voltage. */ | |
110 | uint8_t fw_ver_maj; /**< Firmware version major. */ | |
111 | uint8_t fw_ver_min; /**< Firmware version minor. */ | |
112 | int64_t req_sent_at; /**< Request sent. */ | |
113 | gboolean response_pending; /**< Request sent, response is pending. */ | |
114 | ||
115 | /* Temporary state across callbacks */ | |
116 | uint64_t num_samples; /**< Current #samples for limit_samples */ | |
117 | GTimer *elapsed_msec; /**< Used for sampling with limit_msec */ | |
118 | uint8_t buf[GMC_BUFSIZE]; /**< Buffer for read callback */ | |
119 | int buflen; /**< Data len in buf */ | |
120 | }; | |
121 | ||
122 | /* Forward declarations */ | |
123 | SR_PRIV int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi, | |
124 | const struct sr_channel_group *cg); | |
125 | SR_PRIV void create_cmd_14(guchar addr, guchar func, guchar* params, guchar* buf); | |
126 | SR_PRIV void dump_msg14(guchar* buf, gboolean raw); | |
127 | SR_PRIV int gmc_decode_model_bd(uint8_t mcode); | |
128 | SR_PRIV int gmc_decode_model_sm(uint8_t mcode); | |
129 | SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data); | |
130 | SR_PRIV int gmc_mh_2x_receive_data(int fd, int revents, void *cb_data); | |
131 | SR_PRIV const char *gmc_model_str(enum model mcode); | |
132 | SR_PRIV int process_msg14(struct sr_dev_inst *sdi); | |
133 | SR_PRIV int req_meas14(const struct sr_dev_inst *sdi); | |
134 | SR_PRIV int req_stat14(const struct sr_dev_inst *sdi, gboolean power_on); | |
135 | ||
136 | #endif |