]> sigrok.org Git - libsigrok.git/blame - hardware/fluke-dmm/api.c
Python bindings: Fix reported libsigrok version.
[libsigrok.git] / hardware / fluke-dmm / api.c
CommitLineData
883a2e9e
BV
1/*
2 * This file is part of the sigrok project.
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
70424328 30static const int32_t hwopts[] = {
1953564a
BV
31 SR_CONF_CONN,
32 SR_CONF_SERIALCOMM,
d3f8f141
BV
33};
34
70424328 35static const int32_t hwcaps[] = {
1953564a
BV
36 SR_CONF_MULTIMETER,
37 SR_CONF_LIMIT_SAMPLES,
38 SR_CONF_LIMIT_MSEC,
39 SR_CONF_CONTINUOUS,
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
BV
56 { FLUKE_187, "187", 100, 1000 },
57 { FLUKE_287, "287", 100, 1000 },
58 { FLUKE_190, "199B", 1000, 3500 },
4f958423
BV
59};
60
883a2e9e
BV
61
62/* Properly close and free all devices. */
63static int clear_instances(void)
64{
65 struct sr_dev_inst *sdi;
66 struct drv_context *drvc;
67 struct dev_context *devc;
68 GSList *l;
69
4f958423
BV
70 if (!(drvc = di->priv))
71 return SR_OK;
72
883a2e9e
BV
73 drvc = di->priv;
74 for (l = drvc->instances; l; l = l->next) {
4f958423 75 if (!(sdi = l->data))
883a2e9e 76 continue;
4f958423 77 if (!(devc = sdi->priv))
883a2e9e 78 continue;
4f958423 79 sr_serial_dev_inst_free(devc->serial);
883a2e9e
BV
80 sr_dev_inst_free(sdi);
81 }
883a2e9e
BV
82 g_slist_free(drvc->instances);
83 drvc->instances = NULL;
84
85 return SR_OK;
86}
87
34f06b90 88static int hw_init(struct sr_context *sr_ctx)
883a2e9e 89{
063e7aef 90 return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
883a2e9e
BV
91}
92
41298320 93static GSList *fluke_scan(const char *conn, const char *serialcomm)
883a2e9e 94{
4f958423 95 struct sr_dev_inst *sdi;
883a2e9e 96 struct drv_context *drvc;
4f958423 97 struct dev_context *devc;
4f958423 98 struct sr_probe *probe;
58d03f03 99 struct sr_serial_dev_inst *serial;
41298320 100 GSList *devices;
58d03f03 101 int retry, len, i, s;
fb480d57 102 char buf[128], *b, **tokens;
883a2e9e 103
58d03f03 104 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
4f958423 105 return NULL;
58d03f03 106
a54dd31e 107 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
4f958423 108 return NULL;
4f958423 109
41298320 110 drvc = di->priv;
fb480d57
BV
111 b = buf;
112 retry = 0;
41298320 113 devices = NULL;
fb480d57
BV
114 /* We'll try the discovery sequence three times in case the device
115 * is not in an idle state when we send ID. */
116 while (!devices && retry < 3) {
117 retry++;
58d03f03
BV
118 serial_flush(serial);
119 if (serial_write(serial, "ID\r", 3) == -1) {
31d84da3
UH
120 sr_err("Unable to send ID string: %s.",
121 strerror(errno));
fb480d57
BV
122 continue;
123 }
4f958423 124
fb480d57
BV
125 /* Response is first a CMD_ACK byte (ASCII '0' for OK,
126 * or '1' to signify an error. */
127 len = 128;
58d03f03 128 serial_readline(serial, &b, &len, 150);
fb480d57
BV
129 if (len != 1)
130 continue;
41298320 131 if (buf[0] != '0')
fb480d57 132 continue;
4f958423 133
fb480d57
BV
134 /* If CMD_ACK was OK, ID string follows. */
135 len = 128;
9fa09680 136 serial_readline(serial, &b, &len, 850);
fb480d57
BV
137 if (len < 10)
138 continue;
9fa09680
BV
139 if (strcspn(buf, ",") < 15)
140 /* Looks like it's comma-separated. */
141 tokens = g_strsplit(buf, ",", 3);
142 else
143 /* Fluke 199B, at least, uses semicolon. */
144 tokens = g_strsplit(buf, ";", 3);
fb480d57
BV
145 if (!strncmp("FLUKE", tokens[0], 5)
146 && tokens[1] && tokens[2]) {
147 for (i = 0; supported_flukedmm[i].model; i++) {
148 if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
149 continue;
150 /* Skip leading spaces in version number. */
151 for (s = 0; tokens[1][s] == ' '; s++);
152 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Fluke",
153 tokens[0] + 6, tokens[1] + s)))
154 return NULL;
155 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
31d84da3 156 sr_err("Device context malloc failed.");
fb480d57
BV
157 return NULL;
158 }
159 devc->profile = &supported_flukedmm[i];
58d03f03 160 devc->serial = serial;
fb480d57
BV
161 sdi->priv = devc;
162 sdi->driver = di;
163 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
164 return NULL;
165 sdi->probes = g_slist_append(sdi->probes, probe);
166 drvc->instances = g_slist_append(drvc->instances, sdi);
167 devices = g_slist_append(devices, sdi);
168 break;
4f958423 169 }
4f958423 170 }
fb480d57 171 g_strfreev(tokens);
9fa09680
BV
172 if (devices)
173 /* Found one. */
174 break;
4f958423 175 }
58d03f03
BV
176 serial_close(serial);
177 if (!devices)
178 sr_serial_dev_inst_free(serial);
883a2e9e
BV
179
180 return devices;
181}
182
41298320
BV
183static GSList *hw_scan(GSList *options)
184{
1987b8d6 185 struct sr_config *src;
41298320 186 GSList *l, *devices;
9fa09680 187 int i;
41298320
BV
188 const char *conn, *serialcomm;
189
190 conn = serialcomm = NULL;
191 for (l = options; l; l = l->next) {
1987b8d6
BV
192 src = l->data;
193 switch (src->key) {
1953564a 194 case SR_CONF_CONN:
70424328 195 conn = g_variant_get_string(src->data, NULL);
41298320 196 break;
1953564a 197 case SR_CONF_SERIALCOMM:
70424328 198 serialcomm = g_variant_get_string(src->data, NULL);
41298320
BV
199 break;
200 }
201 }
202 if (!conn)
203 return NULL;
204
205 if (serialcomm) {
206 /* Use the provided comm specs. */
207 devices = fluke_scan(conn, serialcomm);
208 } else {
9fa09680
BV
209 for (i = 0; scan_conn[i]; i++) {
210 if ((devices = fluke_scan(conn, scan_conn[i])))
211 break;
212 /* The Scopemeter 199B, at least, requires this
213 * after all the 115k/9.6k confusion. */
214 g_usleep(5000);
215 }
41298320
BV
216 }
217
218 return devices;
219}
220
883a2e9e
BV
221static GSList *hw_dev_list(void)
222{
0e94d524 223 return ((struct drv_context *)(di->priv))->instances;
883a2e9e
BV
224}
225
226static int hw_dev_open(struct sr_dev_inst *sdi)
227{
41298320 228 struct dev_context *devc;
883a2e9e 229
41298320 230 if (!(devc = sdi->priv)) {
31d84da3 231 sr_err("sdi->priv was NULL.");
41298320
BV
232 return SR_ERR_BUG;
233 }
234
a54dd31e 235 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
41298320 236 return SR_ERR;
58d03f03 237
41298320 238 sdi->status = SR_ST_ACTIVE;
883a2e9e
BV
239
240 return SR_OK;
241}
242
243static int hw_dev_close(struct sr_dev_inst *sdi)
244{
d3f8f141 245 struct dev_context *devc;
883a2e9e 246
961009b0 247 devc = sdi->priv;
d3f8f141
BV
248
249 if (devc->serial && devc->serial->fd != -1) {
58d03f03 250 serial_close(devc->serial);
d3f8f141
BV
251 sdi->status = SR_ST_INACTIVE;
252 }
883a2e9e
BV
253
254 return SR_OK;
255}
256
257static int hw_cleanup(void)
258{
259
260 clear_instances();
261
883a2e9e
BV
262 return SR_OK;
263}
264
70424328 265static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
883a2e9e 266{
d3f8f141 267 struct dev_context *devc;
883a2e9e
BV
268
269 if (sdi->status != SR_ST_ACTIVE)
270 return SR_ERR;
271
d3f8f141 272 if (!(devc = sdi->priv)) {
31d84da3 273 sr_err("sdi->priv was NULL.");
d3f8f141
BV
274 return SR_ERR_BUG;
275 }
276
035a1078 277 switch (id) {
1953564a 278 case SR_CONF_LIMIT_MSEC:
d3f8f141 279 /* TODO: not yet implemented */
70424328 280 if (g_variant_get_uint64(data) == 0) {
31d84da3 281 sr_err("LIMIT_MSEC can't be 0.");
d3f8f141
BV
282 return SR_ERR;
283 }
70424328 284 devc->limit_msec = g_variant_get_uint64(data);
31d84da3 285 sr_dbg("Setting time limit to %" PRIu64 "ms.",
d3f8f141
BV
286 devc->limit_msec);
287 break;
1953564a 288 case SR_CONF_LIMIT_SAMPLES:
70424328 289 devc->limit_samples = g_variant_get_uint64(data);
31d84da3 290 sr_dbg("Setting sample limit to %" PRIu64 ".",
d3f8f141
BV
291 devc->limit_samples);
292 break;
883a2e9e 293 default:
035a1078 294 sr_err("Unknown capability: %d.", id);
d3f8f141
BV
295 return SR_ERR;
296 break;
883a2e9e
BV
297 }
298
d3f8f141 299 return SR_OK;
883a2e9e
BV
300}
301
70424328 302static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
a1c743fc
BV
303{
304
305 (void)sdi;
306
307 switch (key) {
0d485e30 308 case SR_CONF_SCAN_OPTIONS:
70424328
BV
309 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
310 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
0d485e30 311 break;
9a6517d1 312 case SR_CONF_DEVICE_OPTIONS:
70424328
BV
313 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
314 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
9a6517d1 315 break;
a1c743fc
BV
316 default:
317 return SR_ERR_ARG;
318 }
319
320 return SR_OK;
321}
322
883a2e9e
BV
323static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
324 void *cb_data)
325{
d3f8f141
BV
326 struct dev_context *devc;
327
328 if (!(devc = sdi->priv)) {
31d84da3 329 sr_err("sdi->priv was NULL.");
d3f8f141
BV
330 return SR_ERR_BUG;
331 }
332
d3f8f141
BV
333 devc->cb_data = cb_data;
334
335 /* Send header packet to the session bus. */
4afdfd46 336 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
883a2e9e 337
d3f8f141 338 /* Poll every 100ms, or whenever some data comes in. */
d38d2ef0
BV
339 sr_source_add(devc->serial->fd, G_IO_IN, 50, fluke_receive_data, (void *)sdi);
340
58d03f03 341 if (serial_write(devc->serial, "QM\r", 3) == -1) {
31d84da3 342 sr_err("Unable to send QM: %s.", strerror(errno));
d38d2ef0
BV
343 return SR_ERR;
344 }
345 devc->cmd_sent_at = g_get_monotonic_time() / 1000;
346 devc->expect_response = TRUE;
883a2e9e
BV
347
348 return SR_OK;
349}
350
69b07d14 351static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
883a2e9e 352{
cd2f0fe2
UH
353 return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
354 ((struct dev_context *)(sdi->priv))->serial, DRIVER_LOG_DOMAIN);
883a2e9e
BV
355}
356
e7edd64f 357SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
883a2e9e
BV
358 .name = "fluke-dmm",
359 .longname = "Fluke 18x/28x series DMMs",
360 .api_version = 1,
361 .init = hw_init,
362 .cleanup = hw_cleanup,
363 .scan = hw_scan,
364 .dev_list = hw_dev_list,
365 .dev_clear = clear_instances,
6fab7b8f 366 .config_get = NULL,
035a1078 367 .config_set = config_set,
a1c743fc 368 .config_list = config_list,
883a2e9e
BV
369 .dev_open = hw_dev_open,
370 .dev_close = hw_dev_close,
883a2e9e
BV
371 .dev_acquisition_start = hw_dev_acquisition_start,
372 .dev_acquisition_stop = hw_dev_acquisition_stop,
373 .priv = NULL,
374};