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