]> sigrok.org Git - libsigrok.git/blame - src/hardware/fluke-dmm/api.c
Constify a few arrays and variables.
[libsigrok.git] / src / hardware / fluke-dmm / api.c
CommitLineData
883a2e9e 1/*
50985c20 2 * This file is part of the libsigrok project.
883a2e9e
BV
3 *
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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#include <glib.h>
4f958423
BV
21#include <sys/types.h>
22#include <sys/stat.h>
23#include <fcntl.h>
24#include <string.h>
25#include <errno.h>
6f22a8ef
UH
26#include "libsigrok.h"
27#include "libsigrok-internal.h"
28#include "fluke-dmm.h"
883a2e9e 29
a0e0bb41 30static const uint32_t scanopts[] = {
1953564a
BV
31 SR_CONF_CONN,
32 SR_CONF_SERIALCOMM,
d3f8f141
BV
33};
34
f254bc4b 35static const uint32_t devopts[] = {
1953564a 36 SR_CONF_MULTIMETER,
1953564a 37 SR_CONF_CONTINUOUS,
5827f61b
BV
38 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
39 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
d3f8f141
BV
40};
41
e7edd64f 42SR_PRIV struct sr_dev_driver flukedmm_driver_info;
883a2e9e 43
329733d9 44static const char *scan_conn[] = {
9fa09680
BV
45 /* 287/289 */
46 "115200/8n1",
47 /* 187/189 */
48 "9600/8n1",
49 /* Scopemeter 190 series */
50 "1200/8n1",
51 NULL
52};
53
4f958423 54static const struct flukedmm_profile supported_flukedmm[] = {
d4b11de0 55 { FLUKE_187, "187", 100, 1000 },
0bc3ab92 56 { FLUKE_189, "189", 100, 1000 },
d4b11de0
BV
57 { FLUKE_287, "287", 100, 1000 },
58 { FLUKE_190, "199B", 1000, 3500 },
4f958423
BV
59};
60
4f840ce9 61static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
883a2e9e 62{
f6beaac5 63 return std_init(sr_ctx, di, LOG_PREFIX);
883a2e9e
BV
64}
65
4f840ce9
ML
66static GSList *fluke_scan(struct sr_dev_driver *di, const char *conn,
67 const char *serialcomm)
883a2e9e 68{
4f958423 69 struct sr_dev_inst *sdi;
883a2e9e 70 struct drv_context *drvc;
4f958423 71 struct dev_context *devc;
58d03f03 72 struct sr_serial_dev_inst *serial;
41298320 73 GSList *devices;
58d03f03 74 int retry, len, i, s;
fb480d57 75 char buf[128], *b, **tokens;
883a2e9e 76
91219afc 77 serial = sr_serial_dev_inst_new(conn, serialcomm);
58d03f03 78
50276118 79 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
4f958423 80 return NULL;
4f958423 81
41298320 82 drvc = di->priv;
fb480d57
BV
83 b = buf;
84 retry = 0;
41298320 85 devices = NULL;
fb480d57
BV
86 /* We'll try the discovery sequence three times in case the device
87 * is not in an idle state when we send ID. */
88 while (!devices && retry < 3) {
89 retry++;
58d03f03 90 serial_flush(serial);
20401400 91 if (serial_write_blocking(serial, "ID\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
50276118 92 sr_err("Unable to send ID string");
fb480d57
BV
93 continue;
94 }
4f958423 95
fb480d57
BV
96 /* Response is first a CMD_ACK byte (ASCII '0' for OK,
97 * or '1' to signify an error. */
98 len = 128;
58d03f03 99 serial_readline(serial, &b, &len, 150);
fb480d57
BV
100 if (len != 1)
101 continue;
41298320 102 if (buf[0] != '0')
fb480d57 103 continue;
4f958423 104
fb480d57
BV
105 /* If CMD_ACK was OK, ID string follows. */
106 len = 128;
9fa09680 107 serial_readline(serial, &b, &len, 850);
fb480d57
BV
108 if (len < 10)
109 continue;
9fa09680
BV
110 if (strcspn(buf, ",") < 15)
111 /* Looks like it's comma-separated. */
112 tokens = g_strsplit(buf, ",", 3);
113 else
114 /* Fluke 199B, at least, uses semicolon. */
115 tokens = g_strsplit(buf, ";", 3);
fb480d57
BV
116 if (!strncmp("FLUKE", tokens[0], 5)
117 && tokens[1] && tokens[2]) {
118 for (i = 0; supported_flukedmm[i].model; i++) {
119 if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
120 continue;
121 /* Skip leading spaces in version number. */
122 for (s = 0; tokens[1][s] == ' '; s++);
aac29cc1 123 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
124 sdi->status = SR_ST_INACTIVE;
125 sdi->vendor = g_strdup("Fluke");
126 sdi->model = g_strdup(tokens[0] + 6);
127 sdi->version = g_strdup(tokens[1] + s);
f57d8ffe 128 devc = g_malloc0(sizeof(struct dev_context));
fb480d57 129 devc->profile = &supported_flukedmm[i];
771bd216 130 sdi->inst_type = SR_INST_SERIAL;
919681f0 131 sdi->conn = serial;
fb480d57
BV
132 sdi->priv = devc;
133 sdi->driver = di;
5e23fcab 134 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
fb480d57
BV
135 drvc->instances = g_slist_append(drvc->instances, sdi);
136 devices = g_slist_append(devices, sdi);
137 break;
4f958423 138 }
4f958423 139 }
fb480d57 140 g_strfreev(tokens);
9fa09680
BV
141 if (devices)
142 /* Found one. */
143 break;
4f958423 144 }
58d03f03
BV
145 serial_close(serial);
146 if (!devices)
147 sr_serial_dev_inst_free(serial);
883a2e9e
BV
148
149 return devices;
150}
151
4f840ce9 152static GSList *scan(struct sr_dev_driver *di, GSList *options)
41298320 153{
1987b8d6 154 struct sr_config *src;
41298320 155 GSList *l, *devices;
9fa09680 156 int i;
41298320
BV
157 const char *conn, *serialcomm;
158
159 conn = serialcomm = NULL;
160 for (l = options; l; l = l->next) {
1987b8d6
BV
161 src = l->data;
162 switch (src->key) {
1953564a 163 case SR_CONF_CONN:
70424328 164 conn = g_variant_get_string(src->data, NULL);
41298320 165 break;
1953564a 166 case SR_CONF_SERIALCOMM:
70424328 167 serialcomm = g_variant_get_string(src->data, NULL);
41298320
BV
168 break;
169 }
170 }
171 if (!conn)
172 return NULL;
173
f4d0020e 174 devices = NULL;
41298320
BV
175 if (serialcomm) {
176 /* Use the provided comm specs. */
4f840ce9 177 devices = fluke_scan(di, conn, serialcomm);
41298320 178 } else {
9fa09680 179 for (i = 0; scan_conn[i]; i++) {
4f840ce9 180 if ((devices = fluke_scan(di, conn, scan_conn[i])))
9fa09680
BV
181 break;
182 /* The Scopemeter 199B, at least, requires this
183 * after all the 115k/9.6k confusion. */
184 g_usleep(5000);
185 }
41298320
BV
186 }
187
188 return devices;
189}
190
4f840ce9 191static GSList *dev_list(const struct sr_dev_driver *di)
883a2e9e 192{
0e94d524 193 return ((struct drv_context *)(di->priv))->instances;
883a2e9e
BV
194}
195
4f840ce9 196static int cleanup(const struct sr_dev_driver *di)
883a2e9e 197{
a6630742 198 return std_dev_clear(di, NULL);
883a2e9e
BV
199}
200
584560f1 201static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 202 const struct sr_channel_group *cg)
883a2e9e 203{
d3f8f141 204 struct dev_context *devc;
883a2e9e 205
53b4680f 206 (void)cg;
8f996b89 207
883a2e9e 208 if (sdi->status != SR_ST_ACTIVE)
e73ffd42 209 return SR_ERR_DEV_CLOSED;
883a2e9e 210
d3f8f141 211 if (!(devc = sdi->priv)) {
31d84da3 212 sr_err("sdi->priv was NULL.");
d3f8f141
BV
213 return SR_ERR_BUG;
214 }
215
584560f1 216 switch (key) {
1953564a 217 case SR_CONF_LIMIT_MSEC:
d3f8f141 218 /* TODO: not yet implemented */
70424328 219 if (g_variant_get_uint64(data) == 0) {
31d84da3 220 sr_err("LIMIT_MSEC can't be 0.");
d3f8f141
BV
221 return SR_ERR;
222 }
70424328 223 devc->limit_msec = g_variant_get_uint64(data);
31d84da3 224 sr_dbg("Setting time limit to %" PRIu64 "ms.",
d3f8f141
BV
225 devc->limit_msec);
226 break;
1953564a 227 case SR_CONF_LIMIT_SAMPLES:
70424328 228 devc->limit_samples = g_variant_get_uint64(data);
31d84da3 229 sr_dbg("Setting sample limit to %" PRIu64 ".",
d3f8f141
BV
230 devc->limit_samples);
231 break;
883a2e9e 232 default:
bd6fbf62 233 return SR_ERR_NA;
883a2e9e
BV
234 }
235
d3f8f141 236 return SR_OK;
883a2e9e
BV
237}
238
584560f1 239static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 240 const struct sr_channel_group *cg)
a1c743fc 241{
a1c743fc 242 (void)sdi;
53b4680f 243 (void)cg;
a1c743fc
BV
244
245 switch (key) {
0d485e30 246 case SR_CONF_SCAN_OPTIONS:
584560f1 247 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 248 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0d485e30 249 break;
9a6517d1 250 case SR_CONF_DEVICE_OPTIONS:
584560f1 251 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 252 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1 253 break;
a1c743fc 254 default:
bd6fbf62 255 return SR_ERR_NA;
a1c743fc
BV
256 }
257
258 return SR_OK;
259}
260
6078d2c9 261static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
883a2e9e 262{
d3f8f141 263 struct dev_context *devc;
919681f0 264 struct sr_serial_dev_inst *serial;
d3f8f141 265
e73ffd42
BV
266 if (sdi->status != SR_ST_ACTIVE)
267 return SR_ERR_DEV_CLOSED;
268
d3f8f141 269 if (!(devc = sdi->priv)) {
31d84da3 270 sr_err("sdi->priv was NULL.");
d3f8f141
BV
271 return SR_ERR_BUG;
272 }
273
d3f8f141
BV
274 devc->cb_data = cb_data;
275
276 /* Send header packet to the session bus. */
29a27196 277 std_session_send_df_header(cb_data, LOG_PREFIX);
883a2e9e 278
d3f8f141 279 /* Poll every 100ms, or whenever some data comes in. */
919681f0 280 serial = sdi->conn;
102f1239
BV
281 serial_source_add(sdi->session, serial, G_IO_IN, 50,
282 fluke_receive_data, (void *)sdi);
d38d2ef0 283
20401400 284 if (serial_write_blocking(serial, "QM\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
50276118 285 sr_err("Unable to send QM.");
d38d2ef0
BV
286 return SR_ERR;
287 }
288 devc->cmd_sent_at = g_get_monotonic_time() / 1000;
289 devc->expect_response = TRUE;
883a2e9e
BV
290
291 return SR_OK;
292}
293
6078d2c9 294static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
883a2e9e 295{
d43b0908 296 return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
f6beaac5 297 sdi->conn, LOG_PREFIX);
883a2e9e
BV
298}
299
e7edd64f 300SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
883a2e9e
BV
301 .name = "fluke-dmm",
302 .longname = "Fluke 18x/28x series DMMs",
303 .api_version = 1,
6078d2c9
UH
304 .init = init,
305 .cleanup = cleanup,
306 .scan = scan,
307 .dev_list = dev_list,
a6630742 308 .dev_clear = NULL,
6fab7b8f 309 .config_get = NULL,
035a1078 310 .config_set = config_set,
a1c743fc 311 .config_list = config_list,
854434de 312 .dev_open = std_serial_dev_open,
bf2c987f 313 .dev_close = std_serial_dev_close,
6078d2c9
UH
314 .dev_acquisition_start = dev_acquisition_start,
315 .dev_acquisition_stop = dev_acquisition_stop,
883a2e9e
BV
316 .priv = NULL,
317};