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