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