]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> | |
5 | * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk> | |
6 | * | |
7 | * This program is free software: you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation, either version 3 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 | */ | |
20 | ||
21 | #include <config.h> | |
22 | #include <glib.h> | |
23 | #include <glib/gstdio.h> | |
24 | #include "protocol.h" | |
25 | #include "dslogic.h" | |
26 | ||
27 | #pragma pack(push, 1) | |
28 | ||
29 | struct version_info { | |
30 | uint8_t major; | |
31 | uint8_t minor; | |
32 | }; | |
33 | ||
34 | struct cmd_start_acquisition { | |
35 | uint8_t flags; | |
36 | uint8_t sample_delay_h; | |
37 | uint8_t sample_delay_l; | |
38 | }; | |
39 | ||
40 | #pragma pack(pop) | |
41 | ||
42 | #define USB_TIMEOUT 100 | |
43 | ||
44 | static int command_get_fw_version(libusb_device_handle *devhdl, | |
45 | struct version_info *vi) | |
46 | { | |
47 | int ret; | |
48 | ||
49 | ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR | | |
50 | LIBUSB_ENDPOINT_IN, CMD_GET_FW_VERSION, 0x0000, 0x0000, | |
51 | (unsigned char *)vi, sizeof(struct version_info), USB_TIMEOUT); | |
52 | ||
53 | if (ret < 0) { | |
54 | sr_err("Unable to get version info: %s.", | |
55 | libusb_error_name(ret)); | |
56 | return SR_ERR; | |
57 | } | |
58 | ||
59 | return SR_OK; | |
60 | } | |
61 | ||
62 | static int command_get_revid_version(struct sr_dev_inst *sdi, uint8_t *revid) | |
63 | { | |
64 | struct dev_context *devc = sdi->priv; | |
65 | struct sr_usb_dev_inst *usb = sdi->conn; | |
66 | libusb_device_handle *devhdl = usb->devhdl; | |
67 | int cmd, ret; | |
68 | ||
69 | cmd = devc->dslogic ? DS_CMD_GET_REVID_VERSION : CMD_GET_REVID_VERSION; | |
70 | ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR | | |
71 | LIBUSB_ENDPOINT_IN, cmd, 0x0000, 0x0000, revid, 1, USB_TIMEOUT); | |
72 | ||
73 | if (ret < 0) { | |
74 | sr_err("Unable to get REVID: %s.", libusb_error_name(ret)); | |
75 | return SR_ERR; | |
76 | } | |
77 | ||
78 | return SR_OK; | |
79 | } | |
80 | ||
81 | SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi) | |
82 | { | |
83 | struct dev_context *devc; | |
84 | struct sr_usb_dev_inst *usb; | |
85 | uint64_t samplerate; | |
86 | struct cmd_start_acquisition cmd; | |
87 | int delay, ret; | |
88 | ||
89 | devc = sdi->priv; | |
90 | usb = sdi->conn; | |
91 | samplerate = devc->cur_samplerate; | |
92 | ||
93 | /* Compute the sample rate. */ | |
94 | if (devc->sample_wide && samplerate > MAX_16BIT_SAMPLE_RATE) { | |
95 | sr_err("Unable to sample at %" PRIu64 "Hz " | |
96 | "when collecting 16-bit samples.", samplerate); | |
97 | return SR_ERR; | |
98 | } | |
99 | ||
100 | delay = 0; | |
101 | cmd.flags = cmd.sample_delay_h = cmd.sample_delay_l = 0; | |
102 | if ((SR_MHZ(48) % samplerate) == 0) { | |
103 | cmd.flags = CMD_START_FLAGS_CLK_48MHZ; | |
104 | delay = SR_MHZ(48) / samplerate - 1; | |
105 | if (delay > MAX_SAMPLE_DELAY) | |
106 | delay = 0; | |
107 | } | |
108 | ||
109 | if (delay == 0 && (SR_MHZ(30) % samplerate) == 0) { | |
110 | cmd.flags = CMD_START_FLAGS_CLK_30MHZ; | |
111 | delay = SR_MHZ(30) / samplerate - 1; | |
112 | } | |
113 | ||
114 | sr_dbg("GPIF delay = %d, clocksource = %sMHz.", delay, | |
115 | (cmd.flags & CMD_START_FLAGS_CLK_48MHZ) ? "48" : "30"); | |
116 | ||
117 | if (delay <= 0 || delay > MAX_SAMPLE_DELAY) { | |
118 | sr_err("Unable to sample at %" PRIu64 "Hz.", samplerate); | |
119 | return SR_ERR; | |
120 | } | |
121 | ||
122 | cmd.sample_delay_h = (delay >> 8) & 0xff; | |
123 | cmd.sample_delay_l = delay & 0xff; | |
124 | ||
125 | /* Select the sampling width. */ | |
126 | cmd.flags |= devc->sample_wide ? CMD_START_FLAGS_SAMPLE_16BIT : | |
127 | CMD_START_FLAGS_SAMPLE_8BIT; | |
128 | ||
129 | /* Send the control message. */ | |
130 | ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR | | |
131 | LIBUSB_ENDPOINT_OUT, CMD_START, 0x0000, 0x0000, | |
132 | (unsigned char *)&cmd, sizeof(cmd), USB_TIMEOUT); | |
133 | if (ret < 0) { | |
134 | sr_err("Unable to send start command: %s.", | |
135 | libusb_error_name(ret)); | |
136 | return SR_ERR; | |
137 | } | |
138 | ||
139 | return SR_OK; | |
140 | } | |
141 | ||
142 | /** | |
143 | * Check the USB configuration to determine if this is an fx2lafw device. | |
144 | * | |
145 | * @return TRUE if the device's configuration profile matches fx2lafw | |
146 | * configuration, FALSE otherwise. | |
147 | */ | |
148 | SR_PRIV gboolean match_manuf_prod(libusb_device *dev, const char *manufacturer, | |
149 | const char *product) | |
150 | { | |
151 | struct libusb_device_descriptor des; | |
152 | struct libusb_device_handle *hdl; | |
153 | gboolean ret; | |
154 | unsigned char strdesc[64]; | |
155 | ||
156 | hdl = NULL; | |
157 | ret = FALSE; | |
158 | while (!ret) { | |
159 | /* Assume the FW has not been loaded, unless proven wrong. */ | |
160 | libusb_get_device_descriptor(dev, &des); | |
161 | ||
162 | if (libusb_open(dev, &hdl) != 0) | |
163 | break; | |
164 | ||
165 | if (libusb_get_string_descriptor_ascii(hdl, | |
166 | des.iManufacturer, strdesc, sizeof(strdesc)) < 0) | |
167 | break; | |
168 | if (strcmp((const char *)strdesc, manufacturer)) | |
169 | break; | |
170 | ||
171 | if (libusb_get_string_descriptor_ascii(hdl, | |
172 | des.iProduct, strdesc, sizeof(strdesc)) < 0) | |
173 | break; | |
174 | if (strcmp((const char *)strdesc, product)) | |
175 | break; | |
176 | ||
177 | ret = TRUE; | |
178 | } | |
179 | if (hdl) | |
180 | libusb_close(hdl); | |
181 | ||
182 | return ret; | |
183 | } | |
184 | ||
185 | SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di) | |
186 | { | |
187 | libusb_device **devlist; | |
188 | struct sr_usb_dev_inst *usb; | |
189 | struct libusb_device_descriptor des; | |
190 | struct dev_context *devc; | |
191 | struct drv_context *drvc; | |
192 | struct version_info vi; | |
193 | int ret, i, device_count; | |
194 | uint8_t revid; | |
195 | char connection_id[64]; | |
196 | ||
197 | drvc = di->context; | |
198 | devc = sdi->priv; | |
199 | usb = sdi->conn; | |
200 | ||
201 | if (sdi->status == SR_ST_ACTIVE) | |
202 | /* Device is already in use. */ | |
203 | return SR_ERR; | |
204 | ||
205 | device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); | |
206 | if (device_count < 0) { | |
207 | sr_err("Failed to get device list: %s.", | |
208 | libusb_error_name(device_count)); | |
209 | return SR_ERR; | |
210 | } | |
211 | ||
212 | for (i = 0; i < device_count; i++) { | |
213 | libusb_get_device_descriptor(devlist[i], &des); | |
214 | ||
215 | if (des.idVendor != devc->profile->vid | |
216 | || des.idProduct != devc->profile->pid) | |
217 | continue; | |
218 | ||
219 | if ((sdi->status == SR_ST_INITIALIZING) || | |
220 | (sdi->status == SR_ST_INACTIVE)) { | |
221 | /* | |
222 | * Check device by its physical USB bus/port address. | |
223 | */ | |
224 | usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)); | |
225 | if (strcmp(sdi->connection_id, connection_id)) | |
226 | /* This is not the one. */ | |
227 | continue; | |
228 | } | |
229 | ||
230 | if (!(ret = libusb_open(devlist[i], &usb->devhdl))) { | |
231 | if (usb->address == 0xff) | |
232 | /* | |
233 | * First time we touch this device after FW | |
234 | * upload, so we don't know the address yet. | |
235 | */ | |
236 | usb->address = libusb_get_device_address(devlist[i]); | |
237 | } else { | |
238 | sr_err("Failed to open device: %s.", | |
239 | libusb_error_name(ret)); | |
240 | break; | |
241 | } | |
242 | ||
243 | if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) { | |
244 | if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) { | |
245 | if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) { | |
246 | sr_err("Failed to detach kernel driver: %s.", | |
247 | libusb_error_name(ret)); | |
248 | return SR_ERR; | |
249 | } | |
250 | } | |
251 | } | |
252 | ||
253 | ret = command_get_fw_version(usb->devhdl, &vi); | |
254 | if (ret != SR_OK) { | |
255 | sr_err("Failed to get firmware version."); | |
256 | break; | |
257 | } | |
258 | ||
259 | ret = command_get_revid_version(sdi, &revid); | |
260 | if (ret != SR_OK) { | |
261 | sr_err("Failed to get REVID."); | |
262 | break; | |
263 | } | |
264 | ||
265 | /* | |
266 | * Changes in major version mean incompatible/API changes, so | |
267 | * bail out if we encounter an incompatible version. | |
268 | * Different minor versions are OK, they should be compatible. | |
269 | */ | |
270 | if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) { | |
271 | sr_err("Expected firmware version %d.x, " | |
272 | "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR, | |
273 | vi.major, vi.minor); | |
274 | break; | |
275 | } | |
276 | ||
277 | sdi->status = SR_ST_ACTIVE; | |
278 | sr_info("Opened device on %d.%d (logical) / %s (physical), " | |
279 | "interface %d, firmware %d.%d.", | |
280 | usb->bus, usb->address, connection_id, | |
281 | USB_INTERFACE, vi.major, vi.minor); | |
282 | ||
283 | sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.", | |
284 | revid, (revid != 1) ? " (FX2)" : "A (FX2LP)"); | |
285 | ||
286 | break; | |
287 | } | |
288 | libusb_free_device_list(devlist, 1); | |
289 | ||
290 | if (sdi->status != SR_ST_ACTIVE) | |
291 | return SR_ERR; | |
292 | ||
293 | return SR_OK; | |
294 | } | |
295 | ||
296 | SR_PRIV struct dev_context *fx2lafw_dev_new(void) | |
297 | { | |
298 | struct dev_context *devc; | |
299 | ||
300 | devc = g_malloc0(sizeof(struct dev_context)); | |
301 | devc->profile = NULL; | |
302 | devc->fw_updated = 0; | |
303 | devc->cur_samplerate = 0; | |
304 | devc->limit_samples = 0; | |
305 | devc->capture_ratio = 0; | |
306 | devc->sample_wide = FALSE; | |
307 | devc->stl = NULL; | |
308 | ||
309 | return devc; | |
310 | } | |
311 | ||
312 | SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc) | |
313 | { | |
314 | int i; | |
315 | ||
316 | devc->acq_aborted = TRUE; | |
317 | ||
318 | for (i = devc->num_transfers - 1; i >= 0; i--) { | |
319 | if (devc->transfers[i]) | |
320 | libusb_cancel_transfer(devc->transfers[i]); | |
321 | } | |
322 | } | |
323 | ||
324 | static void finish_acquisition(struct sr_dev_inst *sdi) | |
325 | { | |
326 | struct sr_datafeed_packet packet; | |
327 | struct dev_context *devc; | |
328 | ||
329 | devc = sdi->priv; | |
330 | ||
331 | /* Terminate session. */ | |
332 | packet.type = SR_DF_END; | |
333 | sr_session_send(sdi, &packet); | |
334 | ||
335 | /* Remove fds from polling. */ | |
336 | usb_source_remove(sdi->session, devc->ctx); | |
337 | ||
338 | devc->num_transfers = 0; | |
339 | g_free(devc->transfers); | |
340 | ||
341 | if (devc->stl) { | |
342 | soft_trigger_logic_free(devc->stl); | |
343 | devc->stl = NULL; | |
344 | } | |
345 | } | |
346 | ||
347 | static void free_transfer(struct libusb_transfer *transfer) | |
348 | { | |
349 | struct sr_dev_inst *sdi; | |
350 | struct dev_context *devc; | |
351 | unsigned int i; | |
352 | ||
353 | sdi = transfer->user_data; | |
354 | devc = sdi->priv; | |
355 | ||
356 | g_free(transfer->buffer); | |
357 | transfer->buffer = NULL; | |
358 | libusb_free_transfer(transfer); | |
359 | ||
360 | for (i = 0; i < devc->num_transfers; i++) { | |
361 | if (devc->transfers[i] == transfer) { | |
362 | devc->transfers[i] = NULL; | |
363 | break; | |
364 | } | |
365 | } | |
366 | ||
367 | devc->submitted_transfers--; | |
368 | if (devc->submitted_transfers == 0) | |
369 | finish_acquisition(sdi); | |
370 | } | |
371 | ||
372 | static void resubmit_transfer(struct libusb_transfer *transfer) | |
373 | { | |
374 | int ret; | |
375 | ||
376 | if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS) | |
377 | return; | |
378 | ||
379 | sr_err("%s: %s", __func__, libusb_error_name(ret)); | |
380 | free_transfer(transfer); | |
381 | ||
382 | } | |
383 | ||
384 | SR_PRIV void LIBUSB_CALL fx2lafw_receive_transfer(struct libusb_transfer *transfer) | |
385 | { | |
386 | struct sr_dev_inst *sdi; | |
387 | struct dev_context *devc; | |
388 | gboolean packet_has_error = FALSE; | |
389 | struct sr_datafeed_packet packet; | |
390 | struct sr_datafeed_logic logic; | |
391 | unsigned int num_samples; | |
392 | int trigger_offset, cur_sample_count, unitsize; | |
393 | int pre_trigger_samples; | |
394 | ||
395 | sdi = transfer->user_data; | |
396 | devc = sdi->priv; | |
397 | ||
398 | /* | |
399 | * If acquisition has already ended, just free any queued up | |
400 | * transfer that come in. | |
401 | */ | |
402 | if (devc->acq_aborted) { | |
403 | free_transfer(transfer); | |
404 | return; | |
405 | } | |
406 | ||
407 | sr_dbg("receive_transfer(): status %s received %d bytes.", | |
408 | libusb_error_name(transfer->status), transfer->actual_length); | |
409 | ||
410 | /* Save incoming transfer before reusing the transfer struct. */ | |
411 | unitsize = devc->sample_wide ? 2 : 1; | |
412 | cur_sample_count = transfer->actual_length / unitsize; | |
413 | ||
414 | switch (transfer->status) { | |
415 | case LIBUSB_TRANSFER_NO_DEVICE: | |
416 | fx2lafw_abort_acquisition(devc); | |
417 | free_transfer(transfer); | |
418 | return; | |
419 | case LIBUSB_TRANSFER_COMPLETED: | |
420 | case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */ | |
421 | break; | |
422 | default: | |
423 | packet_has_error = TRUE; | |
424 | break; | |
425 | } | |
426 | ||
427 | if (transfer->actual_length == 0 || packet_has_error) { | |
428 | devc->empty_transfer_count++; | |
429 | if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) { | |
430 | /* | |
431 | * The FX2 gave up. End the acquisition, the frontend | |
432 | * will work out that the samplecount is short. | |
433 | */ | |
434 | fx2lafw_abort_acquisition(devc); | |
435 | free_transfer(transfer); | |
436 | } else { | |
437 | resubmit_transfer(transfer); | |
438 | } | |
439 | return; | |
440 | } else { | |
441 | devc->empty_transfer_count = 0; | |
442 | } | |
443 | ||
444 | if (devc->trigger_fired) { | |
445 | if (!devc->limit_samples || devc->sent_samples < devc->limit_samples) { | |
446 | /* Send the incoming transfer to the session bus. */ | |
447 | packet.type = SR_DF_LOGIC; | |
448 | packet.payload = &logic; | |
449 | if (devc->limit_samples && devc->sent_samples + cur_sample_count > devc->limit_samples) | |
450 | num_samples = devc->limit_samples - devc->sent_samples; | |
451 | else | |
452 | num_samples = cur_sample_count; | |
453 | logic.length = num_samples * unitsize; | |
454 | logic.unitsize = unitsize; | |
455 | logic.data = transfer->buffer; | |
456 | sr_session_send(devc->cb_data, &packet); | |
457 | devc->sent_samples += num_samples; | |
458 | } | |
459 | } else { | |
460 | trigger_offset = soft_trigger_logic_check(devc->stl, | |
461 | transfer->buffer, transfer->actual_length, &pre_trigger_samples); | |
462 | if (trigger_offset > -1) { | |
463 | devc->sent_samples += pre_trigger_samples; | |
464 | packet.type = SR_DF_LOGIC; | |
465 | packet.payload = &logic; | |
466 | num_samples = cur_sample_count - trigger_offset; | |
467 | if (devc->limit_samples && | |
468 | num_samples > devc->limit_samples - devc->sent_samples) | |
469 | num_samples = devc->limit_samples - devc->sent_samples; | |
470 | logic.length = num_samples * unitsize; | |
471 | logic.unitsize = unitsize; | |
472 | logic.data = transfer->buffer + trigger_offset * unitsize; | |
473 | sr_session_send(devc->cb_data, &packet); | |
474 | devc->sent_samples += num_samples; | |
475 | ||
476 | devc->trigger_fired = TRUE; | |
477 | } | |
478 | } | |
479 | ||
480 | if (devc->limit_samples && devc->sent_samples >= devc->limit_samples) { | |
481 | fx2lafw_abort_acquisition(devc); | |
482 | free_transfer(transfer); | |
483 | } else | |
484 | resubmit_transfer(transfer); | |
485 | } | |
486 | ||
487 | static unsigned int to_bytes_per_ms(unsigned int samplerate) | |
488 | { | |
489 | return samplerate / 1000; | |
490 | } | |
491 | ||
492 | SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc) | |
493 | { | |
494 | size_t s; | |
495 | ||
496 | /* | |
497 | * The buffer should be large enough to hold 10ms of data and | |
498 | * a multiple of 512. | |
499 | */ | |
500 | s = 10 * to_bytes_per_ms(devc->cur_samplerate); | |
501 | return (s + 511) & ~511; | |
502 | } | |
503 | ||
504 | SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc) | |
505 | { | |
506 | unsigned int n; | |
507 | ||
508 | /* Total buffer size should be able to hold about 500ms of data. */ | |
509 | n = (500 * to_bytes_per_ms(devc->cur_samplerate) / | |
510 | fx2lafw_get_buffer_size(devc)); | |
511 | ||
512 | if (n > NUM_SIMUL_TRANSFERS) | |
513 | return NUM_SIMUL_TRANSFERS; | |
514 | ||
515 | return n; | |
516 | } | |
517 | ||
518 | SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc) | |
519 | { | |
520 | size_t total_size; | |
521 | unsigned int timeout; | |
522 | ||
523 | total_size = fx2lafw_get_buffer_size(devc) * | |
524 | fx2lafw_get_number_of_transfers(devc); | |
525 | timeout = total_size / to_bytes_per_ms(devc->cur_samplerate); | |
526 | return timeout + timeout / 4; /* Leave a headroom of 25% percent. */ | |
527 | } |