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