]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/chronovu-la/api.c
beaglelogic: fixup use of uninitialized data in TCP routines
[libsigrok.git] / src / hardware / chronovu-la / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2011-2015 Uwe Hermann <uwe@hermann-uwe.de>
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 2 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 <config.h>
21#include "protocol.h"
22
23static const uint32_t scanopts[] = {
24 SR_CONF_CONN,
25};
26
27static const uint32_t drvopts[] = {
28 SR_CONF_LOGIC_ANALYZER,
29};
30
31static const uint32_t devopts[] = {
32 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
33 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_LIST,
34 SR_CONF_CONN | SR_CONF_GET,
35 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
37};
38
39static const int32_t trigger_matches[] = {
40 SR_TRIGGER_ZERO,
41 SR_TRIGGER_ONE,
42 SR_TRIGGER_RISING,
43 SR_TRIGGER_FALLING,
44};
45
46static void clear_helper(struct dev_context *devc)
47{
48 ftdi_free(devc->ftdic);
49 g_free(devc->final_buf);
50}
51
52static int dev_clear(const struct sr_dev_driver *di)
53{
54 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
55}
56
57static int add_device(int model, struct libusb_device_descriptor *des,
58 const char *serial_num, const char *connection_id, libusb_device *usbdev,
59 GSList **devices)
60{
61 int ret;
62 unsigned int i;
63 struct sr_dev_inst *sdi;
64 struct dev_context *devc;
65
66 ret = SR_OK;
67
68 devc = g_malloc0(sizeof(struct dev_context));
69
70 /* Set some sane defaults. */
71 devc->prof = &cv_profiles[model];
72 devc->ftdic = NULL; /* Will be set in the open() API call. */
73 devc->cur_samplerate = 0; /* Set later (different for LA8/LA16). */
74 devc->limit_msec = 0;
75 devc->limit_samples = 0;
76 memset(devc->mangled_buf, 0, BS);
77 devc->final_buf = NULL;
78 devc->trigger_pattern = 0x0000; /* Irrelevant, see trigger_mask. */
79 devc->trigger_mask = 0x0000; /* All channels: "don't care". */
80 devc->trigger_edgemask = 0x0000; /* All channels: "state triggered". */
81 devc->trigger_found = 0;
82 devc->done = 0;
83 devc->block_counter = 0;
84 devc->divcount = 0;
85 devc->usb_vid = des->idVendor;
86 devc->usb_pid = des->idProduct;
87 memset(devc->samplerates, 0, sizeof(uint64_t) * 255);
88
89 /* Allocate memory where we'll store the de-mangled data. */
90 if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
91 sr_err("Failed to allocate memory for sample buffer.");
92 ret = SR_ERR_MALLOC;
93 goto err_free_devc;
94 }
95
96 /* We now know the device, set its max. samplerate as default. */
97 devc->cur_samplerate = devc->prof->max_samplerate;
98
99 sdi = g_malloc0(sizeof(struct sr_dev_inst));
100 sdi->status = SR_ST_INACTIVE;
101 sdi->vendor = g_strdup("ChronoVu");
102 sdi->model = g_strdup(devc->prof->modelname);
103 sdi->serial_num = g_strdup(serial_num);
104 sdi->connection_id = g_strdup(connection_id);
105 sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(usbdev),
106 libusb_get_device_address(usbdev), NULL);
107 sdi->priv = devc;
108
109 for (i = 0; i < devc->prof->num_channels; i++)
110 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
111 cv_channel_names[i]);
112
113 *devices = g_slist_append(*devices, sdi);
114
115 if (ret == SR_OK)
116 return SR_OK;
117
118err_free_devc:
119 g_free(devc);
120
121 return ret;
122}
123
124static GSList *scan(struct sr_dev_driver *di, GSList *options)
125{
126 int i, ret, model;
127 struct drv_context *drvc;
128 GSList *devices, *conn_devices, *l;
129 struct sr_usb_dev_inst *usb;
130 struct sr_config *src;
131 struct libusb_device_descriptor des;
132 libusb_device **devlist;
133 struct libusb_device_handle *hdl;
134 const char *conn;
135 char product[64], serial_num[64], connection_id[64];
136
137 drvc = di->context;
138
139 conn = NULL;
140 for (l = options; l; l = l->next) {
141 src = l->data;
142 switch (src->key) {
143 case SR_CONF_CONN:
144 conn = g_variant_get_string(src->data, NULL);
145 break;
146 }
147 }
148 if (conn)
149 conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
150 else
151 conn_devices = NULL;
152
153 devices = NULL;
154 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
155
156 for (i = 0; devlist[i]; i++) {
157 if (conn) {
158 for (l = conn_devices; l; l = l->next) {
159 usb = l->data;
160 if (usb->bus == libusb_get_bus_number(devlist[i])
161 && usb->address == libusb_get_device_address(devlist[i]))
162 break;
163 }
164 if (!l)
165 /* This device matched none of the ones that
166 * matched the conn specification. */
167 continue;
168 }
169
170 libusb_get_device_descriptor(devlist[i], &des);
171
172 if ((ret = libusb_open(devlist[i], &hdl)) < 0)
173 continue;
174
175 if (des.iProduct == 0) {
176 product[0] = '\0';
177 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
178 des.iProduct, (unsigned char *)product,
179 sizeof(product))) < 0) {
180 sr_warn("Failed to get product string descriptor: %s.",
181 libusb_error_name(ret));
182 continue;
183 }
184
185 if (des.iSerialNumber == 0) {
186 serial_num[0] = '\0';
187 } else if ((ret = libusb_get_string_descriptor_ascii(hdl,
188 des.iSerialNumber, (unsigned char *)serial_num,
189 sizeof(serial_num))) < 0) {
190 sr_warn("Failed to get serial number string descriptor: %s.",
191 libusb_error_name(ret));
192 continue;
193 }
194
195 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
196
197 libusb_close(hdl);
198
199 if (!strcmp(product, "ChronoVu LA8"))
200 model = 0;
201 else if (!strcmp(product, "ChronoVu LA16"))
202 model = 1;
203 else
204 continue; /* Unknown iProduct string, ignore. */
205
206 sr_dbg("Found %s (%04x:%04x, %d.%d, %s).",
207 product, des.idVendor, des.idProduct,
208 libusb_get_bus_number(devlist[i]),
209 libusb_get_device_address(devlist[i]), connection_id);
210
211 if ((ret = add_device(model, &des, serial_num, connection_id,
212 devlist[i], &devices)) < 0) {
213 sr_dbg("Failed to add device: %d.", ret);
214 }
215 }
216
217 libusb_free_device_list(devlist, 1);
218 g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
219
220 return std_scan_complete(di, devices);
221}
222
223static int dev_open(struct sr_dev_inst *sdi)
224{
225 struct dev_context *devc;
226 int ret;
227
228 devc = sdi->priv;
229
230 if (!(devc->ftdic = ftdi_new())) {
231 sr_err("Failed to initialize libftdi.");
232 return SR_ERR;
233 }
234
235 sr_dbg("Opening %s device (%04x:%04x).", devc->prof->modelname,
236 devc->usb_vid, devc->usb_pid);
237
238 if ((ret = ftdi_usb_open_desc(devc->ftdic, devc->usb_vid,
239 devc->usb_pid, devc->prof->iproduct, NULL)) < 0) {
240 sr_err("Failed to open FTDI device (%d): %s.",
241 ret, ftdi_get_error_string(devc->ftdic));
242 goto err_ftdi_free;
243 }
244
245 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
246 sr_err("Failed to purge FTDI buffers (%d): %s.",
247 ret, ftdi_get_error_string(devc->ftdic));
248 goto err_ftdi_free;
249 }
250
251 if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
252 sr_err("Failed to enable FTDI flow control (%d): %s.",
253 ret, ftdi_get_error_string(devc->ftdic));
254 goto err_ftdi_free;
255 }
256
257 g_usleep(100 * 1000);
258
259 return SR_OK;
260
261err_ftdi_free:
262 ftdi_free(devc->ftdic); /* Close device (if open), free FTDI context. */
263 devc->ftdic = NULL;
264 return SR_ERR;
265}
266
267static int dev_close(struct sr_dev_inst *sdi)
268{
269 int ret;
270 struct dev_context *devc;
271
272 devc = sdi->priv;
273
274 if (!devc->ftdic)
275 return SR_ERR_BUG;
276
277 if ((ret = ftdi_usb_close(devc->ftdic)) < 0)
278 sr_err("Failed to close FTDI device (%d): %s.",
279 ret, ftdi_get_error_string(devc->ftdic));
280
281 return (ret == 0) ? SR_OK : SR_ERR;
282}
283
284static int config_get(uint32_t key, GVariant **data,
285 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
286{
287 struct dev_context *devc;
288 struct sr_usb_dev_inst *usb;
289
290 (void)cg;
291
292 switch (key) {
293 case SR_CONF_CONN:
294 if (!sdi || !(usb = sdi->conn))
295 return SR_ERR_ARG;
296 *data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
297 break;
298 case SR_CONF_SAMPLERATE:
299 if (!sdi)
300 return SR_ERR_BUG;
301 devc = sdi->priv;
302 *data = g_variant_new_uint64(devc->cur_samplerate);
303 break;
304 default:
305 return SR_ERR_NA;
306 }
307
308 return SR_OK;
309}
310
311static int config_set(uint32_t key, GVariant *data,
312 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
313{
314 struct dev_context *devc;
315
316 (void)cg;
317
318 devc = sdi->priv;
319
320 switch (key) {
321 case SR_CONF_SAMPLERATE:
322 if (cv_set_samplerate(sdi, g_variant_get_uint64(data)) < 0)
323 return SR_ERR;
324 break;
325 case SR_CONF_LIMIT_MSEC:
326 devc->limit_msec = g_variant_get_uint64(data);
327 break;
328 case SR_CONF_LIMIT_SAMPLES:
329 devc->limit_samples = g_variant_get_uint64(data);
330 break;
331 default:
332 return SR_ERR_NA;
333 }
334
335 return SR_OK;
336}
337
338static int config_list(uint32_t key, GVariant **data,
339 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
340{
341 struct dev_context *devc;
342
343 devc = (sdi) ? sdi->priv : NULL;
344
345 switch (key) {
346 case SR_CONF_SCAN_OPTIONS:
347 case SR_CONF_DEVICE_OPTIONS:
348 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
349 case SR_CONF_SAMPLERATE:
350 cv_fill_samplerates_if_needed(sdi);
351 *data = std_gvar_samplerates(ARRAY_AND_SIZE(devc->samplerates));
352 break;
353 case SR_CONF_LIMIT_SAMPLES:
354 if (!devc->prof)
355 return SR_ERR_BUG;
356 *data = std_gvar_tuple_u64(0, (devc->prof->model == CHRONOVU_LA8) ? MAX_NUM_SAMPLES : MAX_NUM_SAMPLES / 2);
357 break;
358 case SR_CONF_TRIGGER_MATCH:
359 if (!devc->prof)
360 return SR_ERR_BUG;
361 *data = std_gvar_array_i32(trigger_matches, devc->prof->num_trigger_matches);
362 break;
363 default:
364 return SR_ERR_NA;
365 }
366
367 return SR_OK;
368}
369
370static int receive_data(int fd, int revents, void *cb_data)
371{
372 int i, ret;
373 struct sr_dev_inst *sdi;
374 struct dev_context *devc;
375
376 (void)fd;
377 (void)revents;
378
379 if (!(sdi = cb_data)) {
380 sr_err("cb_data was NULL.");
381 return FALSE;
382 }
383
384 if (!(devc = sdi->priv)) {
385 sr_err("sdi->priv was NULL.");
386 return FALSE;
387 }
388
389 if (!devc->ftdic) {
390 sr_err("devc->ftdic was NULL.");
391 return FALSE;
392 }
393
394 /* Get one block of data. */
395 if ((ret = cv_read_block(devc)) < 0) {
396 sr_err("Failed to read data block: %d.", ret);
397 sr_dev_acquisition_stop(sdi);
398 return FALSE;
399 }
400
401 /* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
402 if (devc->block_counter != (NUM_BLOCKS - 1)) {
403 devc->block_counter++;
404 return TRUE;
405 }
406
407 sr_dbg("Sampling finished, sending data to session bus now.");
408
409 /*
410 * All data was received and demangled, send it to the session bus.
411 *
412 * Note: Due to the method how data is spread across the 8MByte of
413 * SDRAM, we can _not_ send it to the session bus in a streaming
414 * manner while we receive it. We have to receive and de-mangle the
415 * full 8MByte first, only then the whole buffer contains valid data.
416 */
417 for (i = 0; i < NUM_BLOCKS; i++)
418 cv_send_block_to_session_bus(sdi, i);
419
420 sr_dev_acquisition_stop(sdi);
421
422 return TRUE;
423}
424
425static int dev_acquisition_start(const struct sr_dev_inst *sdi)
426{
427 struct dev_context *devc;
428 uint8_t buf[8];
429 int bytes_to_write, bytes_written;
430
431 devc = sdi->priv;
432
433 if (!devc->ftdic) {
434 sr_err("devc->ftdic was NULL.");
435 return SR_ERR_BUG;
436 }
437
438 devc->divcount = cv_samplerate_to_divcount(sdi, devc->cur_samplerate);
439 if (devc->divcount == 0xff) {
440 sr_err("Invalid divcount/samplerate.");
441 return SR_ERR;
442 }
443
444 if (cv_convert_trigger(sdi) != SR_OK) {
445 sr_err("Failed to configure trigger.");
446 return SR_ERR;
447 }
448
449 /* Fill acquisition parameters into buf[]. */
450 if (devc->prof->model == CHRONOVU_LA8) {
451 buf[0] = devc->divcount;
452 buf[1] = 0xff; /* This byte must always be 0xff. */
453 buf[2] = devc->trigger_pattern & 0xff;
454 buf[3] = devc->trigger_mask & 0xff;
455 bytes_to_write = 4;
456 } else {
457 buf[0] = devc->divcount;
458 buf[1] = 0xff; /* This byte must always be 0xff. */
459 buf[2] = (devc->trigger_pattern & 0xff00) >> 8; /* LSB */
460 buf[3] = (devc->trigger_pattern & 0x00ff) >> 0; /* MSB */
461 buf[4] = (devc->trigger_mask & 0xff00) >> 8; /* LSB */
462 buf[5] = (devc->trigger_mask & 0x00ff) >> 0; /* MSB */
463 buf[6] = (devc->trigger_edgemask & 0xff00) >> 8; /* LSB */
464 buf[7] = (devc->trigger_edgemask & 0x00ff) >> 0; /* MSB */
465 bytes_to_write = 8;
466 }
467
468 /* Start acquisition. */
469 bytes_written = cv_write(devc, buf, bytes_to_write);
470
471 if (bytes_written < 0 || bytes_written != bytes_to_write) {
472 sr_err("Acquisition failed to start.");
473 return SR_ERR;
474 }
475
476 std_session_send_df_header(sdi);
477
478 /* Time when we should be done (for detecting trigger timeouts). */
479 devc->done = (devc->divcount + 1) * devc->prof->trigger_constant +
480 g_get_monotonic_time() + (10 * G_TIME_SPAN_SECOND);
481 devc->block_counter = 0;
482 devc->trigger_found = 0;
483
484 /* Hook up a dummy handler to receive data from the device. */
485 sr_session_source_add(sdi->session, -1, 0, 0, receive_data, (void *)sdi);
486
487 return SR_OK;
488}
489
490static int dev_acquisition_stop(struct sr_dev_inst *sdi)
491{
492 sr_session_source_remove(sdi->session, -1);
493 std_session_send_df_end(sdi);
494
495 return SR_OK;
496}
497
498static struct sr_dev_driver chronovu_la_driver_info = {
499 .name = "chronovu-la",
500 .longname = "ChronoVu LA8/LA16",
501 .api_version = 1,
502 .init = std_init,
503 .cleanup = std_cleanup,
504 .scan = scan,
505 .dev_list = std_dev_list,
506 .dev_clear = dev_clear,
507 .config_get = config_get,
508 .config_set = config_set,
509 .config_list = config_list,
510 .dev_open = dev_open,
511 .dev_close = dev_close,
512 .dev_acquisition_start = dev_acquisition_start,
513 .dev_acquisition_stop = dev_acquisition_stop,
514 .context = NULL,
515};
516SR_REGISTER_DEV_DRIVER(chronovu_la_driver_info);