]> sigrok.org Git - libsigrok.git/blame - hardware/rigol-ds1xx2/api.c
drivers: implement config_list()
[libsigrok.git] / hardware / rigol-ds1xx2 / api.c
CommitLineData
f4816ac6
ML
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
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
e0b7d23c
ML
20#include <fcntl.h>
21#include <unistd.h>
22#include <stdlib.h>
23#include <string.h>
f4816ac6
ML
24#include <glib.h>
25#include "libsigrok.h"
26#include "libsigrok-internal.h"
27#include "protocol.h"
28
e0b7d23c 29static const int hwcaps[] = {
1953564a
BV
30 SR_CONF_OSCILLOSCOPE,
31 SR_CONF_LIMIT_SAMPLES,
32 SR_CONF_TIMEBASE,
33 SR_CONF_TRIGGER_SOURCE,
34 SR_CONF_TRIGGER_SLOPE,
35 SR_CONF_HORIZ_TRIGGERPOS,
36 SR_CONF_VDIV,
37 SR_CONF_COUPLING,
e0b7d23c
ML
38 0,
39};
40
e0b7d23c
ML
41static const struct sr_rational timebases[] = {
42 /* nanoseconds */
43 { 2, 1000000000 },
44 { 5, 1000000000 },
45 { 10, 1000000000 },
46 { 20, 1000000000 },
47 { 50, 1000000000 },
48 { 100, 1000000000 },
49 { 500, 1000000000 },
50 /* microseconds */
51 { 1, 1000000 },
52 { 2, 1000000 },
53 { 5, 1000000 },
54 { 10, 1000000 },
55 { 20, 1000000 },
56 { 50, 1000000 },
57 { 100, 1000000 },
58 { 200, 1000000 },
59 { 500, 1000000 },
60 /* milliseconds */
61 { 1, 1000 },
62 { 2, 1000 },
63 { 5, 1000 },
64 { 10, 1000 },
65 { 20, 1000 },
66 { 50, 1000 },
67 { 100, 1000 },
68 { 200, 1000 },
69 { 500, 1000 },
70 /* seconds */
71 { 1, 1 },
72 { 2, 1 },
73 { 5, 1 },
74 { 10, 1 },
75 { 20, 1 },
76 { 50, 1 },
77 { 0, 0},
78};
79
80static const struct sr_rational vdivs[] = {
81 /* millivolts */
82 { 2, 1000 },
83 { 5, 1000 },
84 { 10, 1000 },
85 { 20, 1000 },
86 { 50, 1000 },
87 { 100, 1000 },
88 { 200, 1000 },
89 { 500, 1000 },
90 /* volts */
91 { 1, 1 },
92 { 2, 1 },
93 { 5, 1 },
94 { 10, 1 },
95 { 0, 0 },
96};
97
98static const char *trigger_sources[] = {
99 "CH1",
100 "CH2",
101 "EXT",
102 "AC Line",
103 NULL,
104};
105
106static const char *coupling[] = {
107 "AC",
108 "DC",
109 "GND",
110 NULL,
111};
112
512bb890
BV
113static const char *supported_models[] = {
114 "DS1052E",
115 "DS1102E",
116 "DS1052D",
117 "DS1102D"
118};
119
f4816ac6
ML
120SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
121static struct sr_dev_driver *di = &rigol_ds1xx2_driver_info;
122
123/* Properly close and free all devices. */
124static int clear_instances(void)
125{
126 struct sr_dev_inst *sdi;
127 struct drv_context *drvc;
128 struct dev_context *devc;
129 GSList *l;
130
131 if (!(drvc = di->priv))
132 return SR_OK;
133
134 for (l = drvc->instances; l; l = l->next) {
135 if (!(sdi = l->data))
136 continue;
137 if (!(devc = sdi->priv))
138 continue;
139
fb6e5ba8 140 g_free(devc->device);
69e19dd7 141 g_slist_free(devc->enabled_probes);
e0b7d23c 142 close(devc->fd);
f4816ac6
ML
143
144 sr_dev_inst_free(sdi);
145 }
146
147 g_slist_free(drvc->instances);
148 drvc->instances = NULL;
149
150 return SR_OK;
151}
152
e0b7d23c 153static int hw_init(struct sr_context *sr_ctx)
f4816ac6
ML
154{
155 struct drv_context *drvc;
e0b7d23c 156 (void)sr_ctx;
f4816ac6
ML
157
158 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
159 sr_err("Driver context malloc failed.");
160 return SR_ERR_MALLOC;
161 }
162
f4816ac6
ML
163 di->priv = drvc;
164
165 return SR_OK;
166}
167
168static GSList *hw_scan(GSList *options)
169{
170 struct drv_context *drvc;
e0b7d23c
ML
171 struct sr_dev_inst *sdi;
172 struct dev_context *devc;
173 struct sr_probe *probe;
f4816ac6 174 GSList *devices;
fb6e5ba8
ML
175 GDir *dir;
176 const gchar *dev_name;
177 const gchar *dev_dir = "/dev/";
178 const gchar *prefix = "usbtmc";
179 gchar *device;
180 const gchar *idn_query = "*IDN?";
29d957ce 181 int len, num_tokens, fd, i;
fb6e5ba8
ML
182 const gchar *delimiter = ",";
183 gchar **tokens;
512bb890
BV
184 const char *manufacturer, *model, *version;
185 int num_models;
186 gboolean matched = FALSE;
fb6e5ba8
ML
187 char buf[256];
188
f4816ac6
ML
189 (void)options;
190
191 devices = NULL;
192 drvc = di->priv;
193 drvc->instances = NULL;
194
fb6e5ba8 195 dir = g_dir_open("/sys/class/usb/", 0, NULL);
e0b7d23c 196
fb6e5ba8
ML
197 if (dir == NULL)
198 return NULL;
e0b7d23c 199
29d957ce 200 while ((dev_name = g_dir_read_name(dir)) != NULL) {
fb6e5ba8
ML
201 if (strncmp(dev_name, prefix, strlen(prefix)))
202 continue;
203
204 device = g_strconcat(dev_dir, dev_name, NULL);
205
206 fd = open(device, O_RDWR);
207 len = write(fd, idn_query, strlen(idn_query));
208 len = read(fd, buf, sizeof(buf));
209 close(fd);
29d957ce 210 if (len == 0) {
fb6e5ba8
ML
211 g_free(device);
212 return NULL;
213 }
214
215 buf[len] = 0;
216 tokens = g_strsplit(buf, delimiter, 0);
217 close(fd);
512bb890 218 sr_dbg("response: %s %d [%s]", device, len, buf);
fb6e5ba8
ML
219
220 for (num_tokens = 0; tokens[num_tokens] != NULL; num_tokens++);
221
512bb890 222 if (num_tokens < 4) {
fb6e5ba8
ML
223 g_strfreev(tokens);
224 g_free(device);
e0b7d23c 225 return NULL;
fb6e5ba8 226 }
512bb890
BV
227
228 manufacturer = tokens[0];
229 model = tokens[1];
230 version = tokens[3];
231
232 if (strcmp(manufacturer, "Rigol Technologies")) {
233 g_strfreev(tokens);
234 g_free(device);
235 return NULL;
236 }
237
238 num_models = sizeof(supported_models) / sizeof(supported_models[0]);
239
240 for (i = 0; i < num_models; i++) {
241 if (!strcmp(model, supported_models[i])) {
242 matched = 1;
243 break;
244 }
245 }
246
247 if (!matched || !(sdi = sr_dev_inst_new(0, SR_ST_ACTIVE,
248 manufacturer, model, version))) {
249 g_strfreev(tokens);
250 g_free(device);
251 return NULL;
252 }
253
fb6e5ba8
ML
254 g_strfreev(tokens);
255
29d957ce
UH
256 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
257 sr_err("Device context malloc failed.");
fb6e5ba8
ML
258 g_free(device);
259 return NULL;
260 }
261
262 devc->device = device;
263
264 sdi->priv = devc;
265 sdi->driver = di;
266
29d957ce
UH
267 for (i = 0; i < 2; i++) {
268 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE,
269 i == 0 ? "CH1" : "CH2")))
fb6e5ba8
ML
270 return NULL;
271 sdi->probes = g_slist_append(sdi->probes, probe);
272 }
273
274 drvc->instances = g_slist_append(drvc->instances, sdi);
275 devices = g_slist_append(devices, sdi);
e0b7d23c 276 }
fb6e5ba8
ML
277
278 g_dir_close(dir);
f4816ac6
ML
279
280 return devices;
281}
282
283static GSList *hw_dev_list(void)
284{
285 struct drv_context *drvc;
286
287 drvc = di->priv;
288
289 return drvc->instances;
290}
291
292static int hw_dev_open(struct sr_dev_inst *sdi)
293{
29d957ce
UH
294 struct dev_context *devc;
295 int fd;
fb6e5ba8 296
29d957ce 297 devc = sdi->priv;
e0b7d23c 298
29d957ce 299 if ((fd = open(devc->device, O_RDWR)) == -1)
e0b7d23c
ML
300 return SR_ERR;
301
e0b7d23c
ML
302 devc->fd = fd;
303
304 devc->scale = 1;
f4816ac6
ML
305
306 return SR_OK;
307}
308
309static int hw_dev_close(struct sr_dev_inst *sdi)
310{
29d957ce
UH
311 struct dev_context *devc;
312
313 devc = sdi->priv;
e0b7d23c
ML
314
315 close(devc->fd);
f4816ac6
ML
316
317 return SR_OK;
318}
319
320static int hw_cleanup(void)
321{
322 clear_instances();
323
f4816ac6
ML
324 return SR_OK;
325}
326
035a1078 327static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
f4816ac6 328{
e0b7d23c
ML
329 (void)sdi;
330
035a1078 331 switch (id) {
e0b7d23c
ML
332 case SR_DI_HWCAPS:
333 *data = hwcaps;
334 break;
e0b7d23c
ML
335 case SR_DI_TIMEBASES:
336 *data = timebases;
337 break;
338 case SR_DI_TRIGGER_SOURCES:
339 *data = trigger_sources;
340 break;
341 case SR_DI_VDIVS:
342 *data = vdivs;
343 break;
344 case SR_DI_COUPLING:
345 *data = coupling;
346 break;
f4816ac6 347 default:
f4816ac6
ML
348 return SR_ERR_ARG;
349 }
350
351 return SR_OK;
352}
353
035a1078 354static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
f4816ac6 355{
29d957ce 356 struct dev_context *devc;
e0b7d23c
ML
357 uint64_t tmp_u64;
358 float tmp_float;
359 struct sr_rational tmp_rat;
360 int ret, i, j;
361 char *channel;
f4816ac6 362
29d957ce
UH
363 devc = sdi->priv;
364
f4816ac6
ML
365 if (sdi->status != SR_ST_ACTIVE) {
366 sr_err("Device inactive, can't set config options.");
367 return SR_ERR;
368 }
369
370 ret = SR_OK;
035a1078 371 switch (id) {
1953564a 372 case SR_CONF_LIMIT_FRAMES:
e0b7d23c
ML
373 devc->limit_frames = *(const uint64_t *)value;
374 break;
1953564a 375 case SR_CONF_TRIGGER_SLOPE:
e0b7d23c 376 tmp_u64 = *(const int *)value;
29d957ce
UH
377 rigol_ds1xx2_send_data(devc->fd, ":TRIG:EDGE:SLOP %s\n",
378 tmp_u64 ? "POS" : "NEG");
e0b7d23c 379 break;
1953564a 380 case SR_CONF_HORIZ_TRIGGERPOS:
e0b7d23c 381 tmp_float = *(const float *)value;
542843f7 382 rigol_ds1xx2_send_data(devc->fd, ":TIM:OFFS %.9f\n", tmp_float);
e0b7d23c 383 break;
1953564a 384 case SR_CONF_TIMEBASE:
e0b7d23c 385 tmp_rat = *(const struct sr_rational *)value;
29d957ce
UH
386 rigol_ds1xx2_send_data(devc->fd, ":TIM:SCAL %.9f\n",
387 (float)tmp_rat.p / tmp_rat.q);
e0b7d23c 388 break;
1953564a 389 case SR_CONF_TRIGGER_SOURCE:
e0b7d23c
ML
390 if (!strcmp(value, "CH1"))
391 channel = "CHAN1";
392 else if (!strcmp(value, "CH2"))
393 channel = "CHAN2";
394 else if (!strcmp(value, "EXT"))
395 channel = "EXT";
396 else if (!strcmp(value, "AC Line"))
397 channel = "ACL";
29d957ce 398 else {
e0b7d23c
ML
399 ret = SR_ERR_ARG;
400 break;
4e108ace
ML
401 }
402 rigol_ds1xx2_send_data(devc->fd, ":TRIG:EDGE:SOUR %s\n", channel);
e0b7d23c 403 break;
1953564a 404 case SR_CONF_VDIV:
e0b7d23c
ML
405 /* TODO: Not supporting vdiv per channel yet. */
406 tmp_rat = *(const struct sr_rational *)value;
407 for (i = 0; vdivs[i].p && vdivs[i].q; i++) {
408 if (vdivs[i].p == tmp_rat.p
409 && vdivs[i].q == tmp_rat.q) {
29d957ce 410 devc->scale = (float)tmp_rat.p / tmp_rat.q;
e0b7d23c 411 for (j = 0; j < 2; j++)
29d957ce
UH
412 rigol_ds1xx2_send_data(devc->fd,
413 ":CHAN%d:SCAL %.3f\n", j, devc->scale);
e0b7d23c
ML
414 break;
415 }
416 }
417 if (vdivs[i].p == 0 && vdivs[i].q == 0)
418 ret = SR_ERR_ARG;
419 break;
1953564a 420 case SR_CONF_COUPLING:
e0b7d23c
ML
421 /* TODO: Not supporting coupling per channel yet. */
422 for (i = 0; coupling[i]; i++) {
423 if (!strcmp(value, coupling[i])) {
424 for (j = 0; j < 2; j++)
29d957ce
UH
425 rigol_ds1xx2_send_data(devc->fd,
426 ":CHAN%d:COUP %s\n", j, coupling[i]);
e0b7d23c
ML
427 break;
428 }
429 }
430 if (coupling[i] == 0)
431 ret = SR_ERR_ARG;
432 break;
f4816ac6 433 default:
035a1078 434 sr_err("Unknown hardware capability: %d.", id);
f4816ac6 435 ret = SR_ERR_ARG;
29d957ce 436 break;
f4816ac6
ML
437 }
438
439 return ret;
440}
441
a1c743fc
BV
442static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
443{
444
445 (void)sdi;
446
447 switch (key) {
448 default:
449 return SR_ERR_ARG;
450 }
451
452 return SR_OK;
453}
454
f4816ac6
ML
455static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
456 void *cb_data)
457{
29d957ce 458 struct dev_context *devc;
e0b7d23c
ML
459 struct sr_datafeed_packet packet;
460 struct sr_datafeed_header header;
e0b7d23c
ML
461 char buf[256];
462 int len;
29d957ce 463
e0b7d23c
ML
464 (void)cb_data;
465
29d957ce
UH
466 devc = sdi->priv;
467
e0b7d23c
ML
468 devc->num_frames = 0;
469
470 sr_source_add(devc->fd, G_IO_IN, 50, rigol_ds1xx2_receive_data, (void *)sdi);
471
472 /* Send header packet to the session bus. */
473 packet.type = SR_DF_HEADER;
474 packet.payload = (unsigned char *)&header;
475 header.feed_version = 1;
476 gettimeofday(&header.starttime, NULL);
477 sr_session_send(cb_data, &packet);
478
69e19dd7
BV
479 /* Hardcoded to CH1 only. */
480 devc->enabled_probes = g_slist_append(NULL, sdi->probes->data);
e0b7d23c
ML
481 rigol_ds1xx2_send_data(devc->fd, ":CHAN1:SCAL?\n");
482 len = read(devc->fd, buf, sizeof(buf));
483 buf[len] = 0;
484 devc->scale = atof(buf);
29d957ce 485 sr_dbg("Scale is %.3f.", devc->scale);
e0b7d23c
ML
486 rigol_ds1xx2_send_data(devc->fd, ":CHAN1:OFFS?\n");
487 len = read(devc->fd, buf, sizeof(buf));
488 buf[len] = 0;
489 devc->offset = atof(buf);
29d957ce 490 sr_dbg("Offset is %.6f.", devc->offset);
e0b7d23c 491 rigol_ds1xx2_send_data(devc->fd, ":WAV:DATA?\n");
f4816ac6
ML
492
493 return SR_OK;
494}
495
496static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
497{
29d957ce
UH
498 struct dev_context *devc;
499
f4816ac6
ML
500 (void)cb_data;
501
29d957ce
UH
502 devc = sdi->priv;
503
f4816ac6
ML
504 if (sdi->status != SR_ST_ACTIVE) {
505 sr_err("Device inactive, can't stop acquisition.");
506 return SR_ERR;
507 }
508
e0b7d23c 509 sr_source_remove(devc->fd);
f4816ac6
ML
510
511 return SR_OK;
512}
513
514SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info = {
515 .name = "rigol-ds1xx2",
516 .longname = "Rigol DS1xx2",
517 .api_version = 1,
518 .init = hw_init,
519 .cleanup = hw_cleanup,
520 .scan = hw_scan,
521 .dev_list = hw_dev_list,
522 .dev_clear = clear_instances,
035a1078
BV
523 .config_get = config_get,
524 .config_set = config_set,
a1c743fc 525 .config_list = config_list,
f4816ac6
ML
526 .dev_open = hw_dev_open,
527 .dev_close = hw_dev_close,
f4816ac6
ML
528 .dev_acquisition_start = hw_dev_acquisition_start,
529 .dev_acquisition_stop = hw_dev_acquisition_stop,
530 .priv = NULL,
531};