]> sigrok.org Git - libsigrok.git/blame - hardware/agilent-dmm/api.c
fluke-dmm: use new serial API
[libsigrok.git] / hardware / agilent-dmm / api.c
CommitLineData
e93cdf42
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>
e93cdf42
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 "agilent-dmm.h"
e93cdf42
BV
29
30static const int hwopts[] = {
31 SR_HWOPT_CONN,
32 SR_HWOPT_SERIALCOMM,
33 0,
34};
35
36static const int hwcaps[] = {
37 SR_HWCAP_MULTIMETER,
38 SR_HWCAP_LIMIT_SAMPLES,
39 SR_HWCAP_LIMIT_MSEC,
40 SR_HWCAP_CONTINUOUS,
41 0,
42};
43
44static const char *probe_names[] = {
45 "Probe",
46 NULL,
47};
48
8c0152f2
BV
49extern const struct agdmm_job agdmm_jobs_u123x[];
50extern const struct agdmm_recv agdmm_recvs_u123x[];
51extern const struct agdmm_job agdmm_jobs_u125x[];
52extern const struct agdmm_recv agdmm_recvs_u125x[];
e93cdf42 53
74ac7d7f
BV
54/* This works on all the Agilent U12xxA series, although the
55 * U127xA can apparently also run at 19200/8n1. */
56#define SERIALCOMM "9600/8n1"
57
e93cdf42 58static const struct agdmm_profile supported_agdmm[] = {
74ac7d7f
BV
59 { AGILENT_U1231A, "U1231A", agdmm_jobs_u123x, agdmm_recvs_u123x },
60 { AGILENT_U1232A, "U1232A", agdmm_jobs_u123x, agdmm_recvs_u123x },
61 { AGILENT_U1233A, "U1233A", agdmm_jobs_u123x, agdmm_recvs_u123x },
62 { AGILENT_U1251A, "U1251A", agdmm_jobs_u125x, agdmm_recvs_u125x },
63 { AGILENT_U1252A, "U1252A", agdmm_jobs_u125x, agdmm_recvs_u125x },
64 { AGILENT_U1253A, "U1253A", agdmm_jobs_u125x, agdmm_recvs_u125x },
65 { 0, NULL, NULL, NULL }
e93cdf42
BV
66};
67
68SR_PRIV struct sr_dev_driver agdmm_driver_info;
69static struct sr_dev_driver *di = &agdmm_driver_info;
70
71/* Properly close and free all devices. */
72static int clear_instances(void)
73{
74 struct sr_dev_inst *sdi;
75 struct drv_context *drvc;
76 struct dev_context *devc;
77 GSList *l;
78
79 if (!(drvc = di->priv))
80 return SR_OK;
81
82 drvc = di->priv;
83 for (l = drvc->instances; l; l = l->next) {
84 if (!(sdi = l->data))
85 continue;
86 if (!(devc = sdi->priv))
87 continue;
88 sr_serial_dev_inst_free(devc->serial);
89 sr_dev_inst_free(sdi);
90 }
91 g_slist_free(drvc->instances);
92 drvc->instances = NULL;
93
94 return SR_OK;
95}
96
97static int hw_init(void)
98{
99 struct drv_context *drvc;
100
101 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
38d326e8 102 sr_err("Driver context malloc failed.");
886a52b6 103 return SR_ERR_MALLOC;
e93cdf42
BV
104 }
105
106 di->priv = drvc;
107
108 return SR_OK;
109}
110
e93cdf42
BV
111static GSList *hw_scan(GSList *options)
112{
113 struct sr_dev_inst *sdi;
114 struct drv_context *drvc;
115 struct dev_context *devc;
116 struct sr_hwopt *opt;
117 struct sr_probe *probe;
118 GSList *l, *devices;
119 int len, fd, i;
120 const char *conn, *serialcomm;
121 char *buf, **tokens;
122
123 drvc = di->priv;
124 drvc->instances = NULL;
125
126 devices = NULL;
127 conn = serialcomm = NULL;
128 for (l = options; l; l = l->next) {
129 opt = l->data;
130 switch (opt->hwopt) {
131 case SR_HWOPT_CONN:
132 conn = opt->value;
133 break;
134 case SR_HWOPT_SERIALCOMM:
135 serialcomm = opt->value;
136 break;
137 }
138 }
74ac7d7f 139 if (!conn)
e93cdf42 140 return NULL;
e93cdf42
BV
141
142 if ((fd = serial_open(conn, O_RDWR|O_NONBLOCK)) == -1) {
38d326e8 143 sr_err("Unable to open %s: %s.", conn, strerror(errno));
e93cdf42
BV
144 return NULL;
145 }
146
74ac7d7f
BV
147 if (!serialcomm)
148 serialcomm = SERIALCOMM;
e93cdf42 149 if (serial_set_paramstr(fd, serialcomm) != SR_OK) {
38d326e8
UH
150 sr_err("Unable to set serial parameters: %s.",
151 strerror(errno));
e93cdf42
BV
152 return NULL;
153 }
154
155 serial_flush(fd);
156 if (serial_write(fd, "*IDN?\r\n", 7) == -1) {
38d326e8
UH
157 sr_err("Unable to send identification string: %s.",
158 strerror(errno));
e93cdf42
BV
159 return NULL;
160 }
161
162 len = 128;
886a52b6
UH
163 if (!(buf = g_try_malloc(len))) {
164 sr_err("Serial buffer malloc failed.");
165 return NULL;
166 }
63f7cb97 167 serial_readline(fd, &buf, &len, 150);
e93cdf42
BV
168 if (!len)
169 return NULL;
170
171 tokens = g_strsplit(buf, ",", 4);
172 if (!strcmp("Agilent Technologies", tokens[0])
173 && tokens[2] && tokens[3]) {
174 for (i = 0; supported_agdmm[i].model; i++) {
175 if (strcmp(supported_agdmm[i].modelname, tokens[1]))
176 continue;
177 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, tokens[0],
178 tokens[1], tokens[3])))
179 return NULL;
180 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
886a52b6 181 sr_err("Device context malloc failed.");
e93cdf42
BV
182 return NULL;
183 }
184 devc->profile = &supported_agdmm[i];
185 devc->serial = sr_serial_dev_inst_new(conn, -1);
186 devc->cur_mq = -1;
187 sdi->priv = devc;
188 sdi->driver = di;
189 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
190 return NULL;
191 sdi->probes = g_slist_append(sdi->probes, probe);
192 drvc->instances = g_slist_append(drvc->instances, sdi);
193 devices = g_slist_append(devices, sdi);
194 break;
195 }
196 }
197 g_strfreev(tokens);
198 g_free(buf);
199
200 serial_close(fd);
201
202 return devices;
203}
204
205static GSList *hw_dev_list(void)
206{
207 struct drv_context *drvc;
208
209 drvc = di->priv;
210
211 return drvc->instances;
212}
213
214static int hw_dev_open(struct sr_dev_inst *sdi)
215{
216 struct dev_context *devc;
217
218 if (!(devc = sdi->priv)) {
38d326e8 219 sr_err("sdi->priv was NULL.");
e93cdf42
BV
220 return SR_ERR_BUG;
221 }
222
223 devc->serial->fd = serial_open(devc->serial->port, O_RDWR | O_NONBLOCK);
224 if (devc->serial->fd == -1) {
38d326e8 225 sr_err("Couldn't open serial port '%s'.",
e93cdf42
BV
226 devc->serial->port);
227 return SR_ERR;
228 }
74ac7d7f 229 serial_set_paramstr(devc->serial->fd, SERIALCOMM);
e93cdf42
BV
230 sdi->status = SR_ST_ACTIVE;
231
232 return SR_OK;
233}
234
235static int hw_dev_close(struct sr_dev_inst *sdi)
236{
237 struct dev_context *devc;
238
239 if (!(devc = sdi->priv)) {
38d326e8 240 sr_err("sdi->priv was NULL.");
e93cdf42
BV
241 return SR_ERR_BUG;
242 }
243
244 if (devc->serial && devc->serial->fd != -1) {
245 serial_close(devc->serial->fd);
246 devc->serial->fd = -1;
247 sdi->status = SR_ST_INACTIVE;
248 }
249
250 return SR_OK;
251}
252
253static int hw_cleanup(void)
254{
255
256 clear_instances();
257
258 return SR_OK;
259}
260
261static int hw_info_get(int info_id, const void **data,
262 const struct sr_dev_inst *sdi)
263{
264
265 (void)sdi;
266
267 switch (info_id) {
268 case SR_DI_HWOPTS:
269 *data = hwopts;
270 break;
271 case SR_DI_HWCAPS:
272 *data = hwcaps;
273 break;
274 case SR_DI_NUM_PROBES:
275 *data = GINT_TO_POINTER(1);
276 break;
277 case SR_DI_PROBE_NAMES:
278 *data = probe_names;
279 break;
280 default:
281 return SR_ERR_ARG;
282 }
283
284 return SR_OK;
285}
286
287static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
288 const void *value)
289{
290 struct dev_context *devc;
291
292 if (sdi->status != SR_ST_ACTIVE)
293 return SR_ERR;
294
295 if (!(devc = sdi->priv)) {
38d326e8 296 sr_err("sdi->priv was NULL.");
e93cdf42
BV
297 return SR_ERR_BUG;
298 }
299
300 switch (hwcap) {
301 case SR_HWCAP_LIMIT_MSEC:
302 /* TODO: not yet implemented */
303 if (*(const uint64_t *)value == 0) {
38d326e8 304 sr_err("LIMIT_MSEC can't be 0.");
e93cdf42
BV
305 return SR_ERR;
306 }
307 devc->limit_msec = *(const uint64_t *)value;
38d326e8 308 sr_dbg("Setting time limit to %" PRIu64 "ms.",
e93cdf42
BV
309 devc->limit_msec);
310 break;
311 case SR_HWCAP_LIMIT_SAMPLES:
312 devc->limit_samples = *(const uint64_t *)value;
38d326e8 313 sr_dbg("Setting sample limit to %" PRIu64 ".",
e93cdf42
BV
314 devc->limit_samples);
315 break;
316 default:
38d326e8 317 sr_err("Unknown capability: %d.", hwcap);
e93cdf42
BV
318 return SR_ERR;
319 break;
320 }
321
322 return SR_OK;
323}
324
325static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
326 void *cb_data)
327{
328 struct sr_datafeed_packet packet;
329 struct sr_datafeed_header header;
330 struct sr_datafeed_meta_analog meta;
331 struct dev_context *devc;
332
333 if (!(devc = sdi->priv)) {
38d326e8 334 sr_err("sdi->priv was NULL.");
e93cdf42
BV
335 return SR_ERR_BUG;
336 }
337
38d326e8 338 sr_dbg("Starting acquisition.");
e93cdf42
BV
339
340 devc->cb_data = cb_data;
341
342 /* Send header packet to the session bus. */
38d326e8 343 sr_dbg("Sending SR_DF_HEADER.");
e93cdf42
BV
344 packet.type = SR_DF_HEADER;
345 packet.payload = (uint8_t *)&header;
346 header.feed_version = 1;
347 gettimeofday(&header.starttime, NULL);
348 sr_session_send(devc->cb_data, &packet);
349
350 /* Send metadata about the SR_DF_ANALOG packets to come. */
38d326e8 351 sr_dbg("Sending SR_DF_META_ANALOG.");
e93cdf42
BV
352 packet.type = SR_DF_META_ANALOG;
353 packet.payload = &meta;
354 meta.num_probes = 1;
355 sr_session_send(devc->cb_data, &packet);
356
357 /* Poll every 100ms, or whenever some data comes in. */
358 sr_source_add(devc->serial->fd, G_IO_IN, 100, agdmm_receive_data, (void *)sdi);
359
360 return SR_OK;
361}
362
69b07d14 363static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
e93cdf42
BV
364{
365 struct sr_datafeed_packet packet;
366 struct dev_context *devc;
367
368 if (sdi->status != SR_ST_ACTIVE)
369 return SR_ERR;
370
371 if (!(devc = sdi->priv)) {
38d326e8 372 sr_err("sdi->priv was NULL.");
e93cdf42
BV
373 return SR_ERR_BUG;
374 }
375
38d326e8 376 sr_dbg("Stopping acquisition.");
e93cdf42
BV
377
378 sr_source_remove(devc->serial->fd);
379 hw_dev_close((struct sr_dev_inst *)sdi);
380
381 /* Send end packet to the session bus. */
38d326e8 382 sr_dbg("Sending SR_DF_END.");
e93cdf42
BV
383 packet.type = SR_DF_END;
384 sr_session_send(cb_data, &packet);
385
386
387 return SR_OK;
388}
389
390SR_PRIV struct sr_dev_driver agdmm_driver_info = {
391 .name = "agilent-dmm",
392 .longname = "Agilent U12xx series DMMs",
393 .api_version = 1,
394 .init = hw_init,
395 .cleanup = hw_cleanup,
396 .scan = hw_scan,
397 .dev_list = hw_dev_list,
398 .dev_clear = clear_instances,
399 .dev_open = hw_dev_open,
400 .dev_close = hw_dev_close,
401 .info_get = hw_info_get,
402 .dev_config_set = hw_dev_config_set,
403 .dev_acquisition_start = hw_dev_acquisition_start,
404 .dev_acquisition_stop = hw_dev_acquisition_stop,
405 .priv = NULL,
406};