]> sigrok.org Git - libsigrok.git/blame - hardware/fluke-dmm/api.c
Use consistent API callback function names.
[libsigrok.git] / 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
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;
919681f0 68 struct sr_serial_dev_inst *serial;
883a2e9e
BV
69 GSList *l;
70
4f958423
BV
71 if (!(drvc = di->priv))
72 return SR_OK;
73
883a2e9e
BV
74 drvc = di->priv;
75 for (l = drvc->instances; l; l = l->next) {
4f958423 76 if (!(sdi = l->data))
883a2e9e 77 continue;
4f958423 78 if (!(devc = sdi->priv))
883a2e9e 79 continue;
919681f0
BV
80 serial = sdi->conn;
81 sr_serial_dev_inst_free(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
6078d2c9 90static int init(struct sr_context *sr_ctx)
883a2e9e 91{
29a27196 92 return std_hw_init(sr_ctx, di, LOG_PREFIX);
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];
919681f0 162 sdi->conn = 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
6078d2c9 185static GSList *scan(GSList *options)
41298320 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:
70424328 197 conn = g_variant_get_string(src->data, NULL);
41298320 198 break;
1953564a 199 case SR_CONF_SERIALCOMM:
70424328 200 serialcomm = g_variant_get_string(src->data, NULL);
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
6078d2c9 223static GSList *dev_list(void)
883a2e9e 224{
0e94d524 225 return ((struct drv_context *)(di->priv))->instances;
883a2e9e
BV
226}
227
6078d2c9 228static int dev_open(struct sr_dev_inst *sdi)
883a2e9e 229{
919681f0 230 struct sr_serial_dev_inst *serial;
41298320 231
919681f0
BV
232 serial = sdi->conn;
233 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
41298320 234 return SR_ERR;
58d03f03 235
41298320 236 sdi->status = SR_ST_ACTIVE;
883a2e9e
BV
237
238 return SR_OK;
239}
240
6078d2c9 241static int dev_close(struct sr_dev_inst *sdi)
883a2e9e 242{
919681f0 243 struct sr_serial_dev_inst *serial;
d3f8f141 244
919681f0
BV
245 serial = sdi->conn;
246 if (serial && serial->fd != -1) {
247 serial_close(serial);
d3f8f141
BV
248 sdi->status = SR_ST_INACTIVE;
249 }
883a2e9e
BV
250
251 return SR_OK;
252}
253
6078d2c9 254static int cleanup(void)
883a2e9e
BV
255{
256
257 clear_instances();
258
883a2e9e
BV
259 return SR_OK;
260}
261
70424328 262static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
883a2e9e 263{
d3f8f141 264 struct dev_context *devc;
883a2e9e
BV
265
266 if (sdi->status != SR_ST_ACTIVE)
e73ffd42 267 return SR_ERR_DEV_CLOSED;
883a2e9e 268
d3f8f141 269 if (!(devc = sdi->priv)) {
31d84da3 270 sr_err("sdi->priv was NULL.");
d3f8f141
BV
271 return SR_ERR_BUG;
272 }
273
035a1078 274 switch (id) {
1953564a 275 case SR_CONF_LIMIT_MSEC:
d3f8f141 276 /* TODO: not yet implemented */
70424328 277 if (g_variant_get_uint64(data) == 0) {
31d84da3 278 sr_err("LIMIT_MSEC can't be 0.");
d3f8f141
BV
279 return SR_ERR;
280 }
70424328 281 devc->limit_msec = g_variant_get_uint64(data);
31d84da3 282 sr_dbg("Setting time limit to %" PRIu64 "ms.",
d3f8f141
BV
283 devc->limit_msec);
284 break;
1953564a 285 case SR_CONF_LIMIT_SAMPLES:
70424328 286 devc->limit_samples = g_variant_get_uint64(data);
31d84da3 287 sr_dbg("Setting sample limit to %" PRIu64 ".",
d3f8f141
BV
288 devc->limit_samples);
289 break;
883a2e9e 290 default:
bd6fbf62 291 return SR_ERR_NA;
883a2e9e
BV
292 }
293
d3f8f141 294 return SR_OK;
883a2e9e
BV
295}
296
70424328 297static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
a1c743fc
BV
298{
299
300 (void)sdi;
301
302 switch (key) {
0d485e30 303 case SR_CONF_SCAN_OPTIONS:
70424328
BV
304 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
305 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
0d485e30 306 break;
9a6517d1 307 case SR_CONF_DEVICE_OPTIONS:
70424328
BV
308 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
309 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
9a6517d1 310 break;
a1c743fc 311 default:
bd6fbf62 312 return SR_ERR_NA;
a1c743fc
BV
313 }
314
315 return SR_OK;
316}
317
6078d2c9 318static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
883a2e9e 319{
d3f8f141 320 struct dev_context *devc;
919681f0 321 struct sr_serial_dev_inst *serial;
d3f8f141 322
e73ffd42
BV
323 if (sdi->status != SR_ST_ACTIVE)
324 return SR_ERR_DEV_CLOSED;
325
d3f8f141 326 if (!(devc = sdi->priv)) {
31d84da3 327 sr_err("sdi->priv was NULL.");
d3f8f141
BV
328 return SR_ERR_BUG;
329 }
330
d3f8f141
BV
331 devc->cb_data = cb_data;
332
333 /* Send header packet to the session bus. */
29a27196 334 std_session_send_df_header(cb_data, LOG_PREFIX);
883a2e9e 335
d3f8f141 336 /* Poll every 100ms, or whenever some data comes in. */
919681f0
BV
337 serial = sdi->conn;
338 sr_source_add(serial->fd, G_IO_IN, 50, fluke_receive_data, (void *)sdi);
d38d2ef0 339
919681f0 340 if (serial_write(serial, "QM\r", 3) == -1) {
31d84da3 341 sr_err("Unable to send QM: %s.", strerror(errno));
d38d2ef0
BV
342 return SR_ERR;
343 }
344 devc->cmd_sent_at = g_get_monotonic_time() / 1000;
345 devc->expect_response = TRUE;
883a2e9e
BV
346
347 return SR_OK;
348}
349
6078d2c9 350static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
883a2e9e 351{
6078d2c9 352 return std_hw_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
29a27196 353 sdi->conn, LOG_PREFIX);
883a2e9e
BV
354}
355
e7edd64f 356SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
883a2e9e
BV
357 .name = "fluke-dmm",
358 .longname = "Fluke 18x/28x series DMMs",
359 .api_version = 1,
6078d2c9
UH
360 .init = init,
361 .cleanup = cleanup,
362 .scan = scan,
363 .dev_list = dev_list,
883a2e9e 364 .dev_clear = clear_instances,
6fab7b8f 365 .config_get = NULL,
035a1078 366 .config_set = config_set,
a1c743fc 367 .config_list = config_list,
6078d2c9
UH
368 .dev_open = dev_open,
369 .dev_close = dev_close,
370 .dev_acquisition_start = dev_acquisition_start,
371 .dev_acquisition_stop = dev_acquisition_stop,
883a2e9e
BV
372 .priv = NULL,
373};