]> sigrok.org Git - libsigrok.git/blame - hardware/agilent-dmm/api.c
drivers: implement config_list()
[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
BV
93{
94 struct drv_context *drvc;
95
96 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
38d326e8 97 sr_err("Driver context malloc failed.");
886a52b6 98 return SR_ERR_MALLOC;
e93cdf42
BV
99 }
100
1ebe4b4e 101 drvc->sr_ctx = sr_ctx;
e93cdf42
BV
102 di->priv = drvc;
103
104 return SR_OK;
105}
106
e93cdf42
BV
107static GSList *hw_scan(GSList *options)
108{
109 struct sr_dev_inst *sdi;
110 struct drv_context *drvc;
111 struct dev_context *devc;
1987b8d6 112 struct sr_config *src;
e93cdf42 113 struct sr_probe *probe;
109a3ba4 114 struct sr_serial_dev_inst *serial;
e93cdf42 115 GSList *l, *devices;
109a3ba4 116 int len, i;
e93cdf42
BV
117 const char *conn, *serialcomm;
118 char *buf, **tokens;
119
120 drvc = di->priv;
121 drvc->instances = NULL;
122
123 devices = NULL;
124 conn = serialcomm = NULL;
125 for (l = options; l; l = l->next) {
1987b8d6
BV
126 src = l->data;
127 switch (src->key) {
1953564a 128 case SR_CONF_CONN:
1987b8d6 129 conn = src->value;
e93cdf42 130 break;
1953564a 131 case SR_CONF_SERIALCOMM:
1987b8d6 132 serialcomm = src->value;
e93cdf42
BV
133 break;
134 }
135 }
74ac7d7f 136 if (!conn)
e93cdf42 137 return NULL;
109a3ba4
BV
138 if (!serialcomm)
139 serialcomm = SERIALCOMM;
e93cdf42 140
109a3ba4 141 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
e93cdf42 142 return NULL;
e93cdf42 143
a54dd31e 144 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
e93cdf42 145 return NULL;
e93cdf42 146
109a3ba4
BV
147 serial_flush(serial);
148 if (serial_write(serial, "*IDN?\r\n", 7) == -1) {
38d326e8
UH
149 sr_err("Unable to send identification string: %s.",
150 strerror(errno));
e93cdf42
BV
151 return NULL;
152 }
153
154 len = 128;
886a52b6
UH
155 if (!(buf = g_try_malloc(len))) {
156 sr_err("Serial buffer malloc failed.");
157 return NULL;
158 }
109a3ba4 159 serial_readline(serial, &buf, &len, 150);
e93cdf42
BV
160 if (!len)
161 return NULL;
162
163 tokens = g_strsplit(buf, ",", 4);
164 if (!strcmp("Agilent Technologies", tokens[0])
165 && tokens[2] && tokens[3]) {
166 for (i = 0; supported_agdmm[i].model; i++) {
167 if (strcmp(supported_agdmm[i].modelname, tokens[1]))
168 continue;
169 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, tokens[0],
170 tokens[1], tokens[3])))
171 return NULL;
172 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
886a52b6 173 sr_err("Device context malloc failed.");
e93cdf42
BV
174 return NULL;
175 }
176 devc->profile = &supported_agdmm[i];
109a3ba4 177 devc->serial = serial;
e93cdf42
BV
178 devc->cur_mq = -1;
179 sdi->priv = devc;
180 sdi->driver = di;
181 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
182 return NULL;
183 sdi->probes = g_slist_append(sdi->probes, probe);
184 drvc->instances = g_slist_append(drvc->instances, sdi);
185 devices = g_slist_append(devices, sdi);
186 break;
187 }
188 }
189 g_strfreev(tokens);
190 g_free(buf);
191
109a3ba4
BV
192 serial_close(serial);
193 if (!devices)
194 sr_serial_dev_inst_free(serial);
e93cdf42
BV
195
196 return devices;
197}
198
199static GSList *hw_dev_list(void)
200{
201 struct drv_context *drvc;
202
203 drvc = di->priv;
204
205 return drvc->instances;
206}
207
208static int hw_dev_open(struct sr_dev_inst *sdi)
209{
210 struct dev_context *devc;
211
212 if (!(devc = sdi->priv)) {
38d326e8 213 sr_err("sdi->priv was NULL.");
e93cdf42
BV
214 return SR_ERR_BUG;
215 }
216
a54dd31e 217 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
e93cdf42 218 return SR_ERR;
109a3ba4 219
e93cdf42
BV
220 sdi->status = SR_ST_ACTIVE;
221
222 return SR_OK;
223}
224
225static int hw_dev_close(struct sr_dev_inst *sdi)
226{
227 struct dev_context *devc;
228
229 if (!(devc = sdi->priv)) {
38d326e8 230 sr_err("sdi->priv was NULL.");
e93cdf42
BV
231 return SR_ERR_BUG;
232 }
233
234 if (devc->serial && devc->serial->fd != -1) {
109a3ba4 235 serial_close(devc->serial);
e93cdf42
BV
236 sdi->status = SR_ST_INACTIVE;
237 }
238
239 return SR_OK;
240}
241
242static int hw_cleanup(void)
243{
244
245 clear_instances();
246
247 return SR_OK;
248}
249
035a1078 250static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
e93cdf42 251{
e93cdf42
BV
252 (void)sdi;
253
035a1078 254 switch (id) {
e93cdf42
BV
255 case SR_DI_HWOPTS:
256 *data = hwopts;
257 break;
258 case SR_DI_HWCAPS:
259 *data = hwcaps;
260 break;
e93cdf42
BV
261 default:
262 return SR_ERR_ARG;
263 }
264
265 return SR_OK;
266}
267
035a1078 268static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
e93cdf42
BV
269{
270 struct dev_context *devc;
271
272 if (sdi->status != SR_ST_ACTIVE)
273 return SR_ERR;
274
275 if (!(devc = sdi->priv)) {
38d326e8 276 sr_err("sdi->priv was NULL.");
e93cdf42
BV
277 return SR_ERR_BUG;
278 }
279
035a1078 280 switch (id) {
1953564a 281 case SR_CONF_LIMIT_MSEC:
e93cdf42
BV
282 /* TODO: not yet implemented */
283 if (*(const uint64_t *)value == 0) {
38d326e8 284 sr_err("LIMIT_MSEC can't be 0.");
e93cdf42
BV
285 return SR_ERR;
286 }
287 devc->limit_msec = *(const uint64_t *)value;
38d326e8 288 sr_dbg("Setting time limit to %" PRIu64 "ms.",
e93cdf42
BV
289 devc->limit_msec);
290 break;
1953564a 291 case SR_CONF_LIMIT_SAMPLES:
e93cdf42 292 devc->limit_samples = *(const uint64_t *)value;
38d326e8 293 sr_dbg("Setting sample limit to %" PRIu64 ".",
e93cdf42
BV
294 devc->limit_samples);
295 break;
296 default:
035a1078 297 sr_err("Unknown capability: %d.", id);
e93cdf42
BV
298 return SR_ERR;
299 break;
300 }
301
302 return SR_OK;
303}
304
a1c743fc
BV
305static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
306{
307
308 (void)sdi;
309
310 switch (key) {
311 default:
312 return SR_ERR_ARG;
313 }
314
315 return SR_OK;
316}
317
e93cdf42
BV
318static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
319 void *cb_data)
320{
321 struct sr_datafeed_packet packet;
322 struct sr_datafeed_header header;
e93cdf42
BV
323 struct dev_context *devc;
324
325 if (!(devc = sdi->priv)) {
38d326e8 326 sr_err("sdi->priv was NULL.");
e93cdf42
BV
327 return SR_ERR_BUG;
328 }
329
38d326e8 330 sr_dbg("Starting acquisition.");
e93cdf42
BV
331
332 devc->cb_data = cb_data;
333
334 /* Send header packet to the session bus. */
38d326e8 335 sr_dbg("Sending SR_DF_HEADER.");
e93cdf42
BV
336 packet.type = SR_DF_HEADER;
337 packet.payload = (uint8_t *)&header;
338 header.feed_version = 1;
339 gettimeofday(&header.starttime, NULL);
340 sr_session_send(devc->cb_data, &packet);
341
e93cdf42
BV
342 /* Poll every 100ms, or whenever some data comes in. */
343 sr_source_add(devc->serial->fd, G_IO_IN, 100, agdmm_receive_data, (void *)sdi);
344
345 return SR_OK;
346}
347
69b07d14 348static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
e93cdf42
BV
349{
350 struct sr_datafeed_packet packet;
351 struct dev_context *devc;
352
353 if (sdi->status != SR_ST_ACTIVE)
354 return SR_ERR;
355
356 if (!(devc = sdi->priv)) {
38d326e8 357 sr_err("sdi->priv was NULL.");
e93cdf42
BV
358 return SR_ERR_BUG;
359 }
360
38d326e8 361 sr_dbg("Stopping acquisition.");
e93cdf42
BV
362
363 sr_source_remove(devc->serial->fd);
364 hw_dev_close((struct sr_dev_inst *)sdi);
365
366 /* Send end packet to the session bus. */
38d326e8 367 sr_dbg("Sending SR_DF_END.");
e93cdf42
BV
368 packet.type = SR_DF_END;
369 sr_session_send(cb_data, &packet);
370
371
372 return SR_OK;
373}
374
375SR_PRIV struct sr_dev_driver agdmm_driver_info = {
376 .name = "agilent-dmm",
377 .longname = "Agilent U12xx series DMMs",
378 .api_version = 1,
379 .init = hw_init,
380 .cleanup = hw_cleanup,
381 .scan = hw_scan,
382 .dev_list = hw_dev_list,
383 .dev_clear = clear_instances,
035a1078
BV
384 .config_get = config_get,
385 .config_set = config_set,
a1c743fc 386 .config_list = config_list,
e93cdf42
BV
387 .dev_open = hw_dev_open,
388 .dev_close = hw_dev_close,
e93cdf42
BV
389 .dev_acquisition_start = hw_dev_acquisition_start,
390 .dev_acquisition_stop = hw_dev_acquisition_stop,
391 .priv = NULL,
392};