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