]>
Commit | Line | Data |
---|---|---|
f302a082 JH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
4 | * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk> | |
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 <stdio.h> | |
21 | #include <stdlib.h> | |
b1eeb67e | 22 | #include <stdbool.h> |
8b35f474 | 23 | #include <inttypes.h> |
187b3582 JH |
24 | #include <glib.h> |
25 | #include <libusb.h> | |
f302a082 JH |
26 | |
27 | #include "config.h" | |
28 | #include "sigrok.h" | |
29 | #include "sigrok-internal.h" | |
30 | #include "fx2lafw.h" | |
31 | ||
187b3582 JH |
32 | static struct fx2lafw_profile supported_fx2[] = { |
33 | /* USBee AX */ | |
34 | { 0x08a9, 0x0014, "CWAV", "USBee AX", NULL, 8 }, | |
35 | { 0, 0, 0, 0, 0, 0 } | |
36 | }; | |
37 | ||
8b35f474 JH |
38 | static int fx2lafw_capabilities[] = { |
39 | SR_HWCAP_LOGIC_ANALYZER, | |
40 | SR_HWCAP_SAMPLERATE, | |
41 | ||
42 | /* These are really implemented in the driver, not the hardware. */ | |
43 | SR_HWCAP_LIMIT_SAMPLES, | |
44 | SR_HWCAP_CONTINUOUS, | |
45 | 0 | |
46 | }; | |
47 | ||
48 | static const char *fx2lafw_probe_names[] = { | |
49 | "D0", | |
50 | "D1", | |
51 | "D2", | |
52 | "D3", | |
53 | "D4", | |
54 | "D5", | |
55 | "D6", | |
56 | "D7", | |
57 | NULL | |
58 | }; | |
59 | ||
60 | static uint64_t fx2lafw_supported_samplerates[] = { | |
61 | SR_MHZ(1), | |
62 | SR_MHZ(2), | |
63 | SR_MHZ(3), | |
64 | SR_MHZ(4), | |
65 | SR_MHZ(6), | |
66 | SR_MHZ(8), | |
67 | SR_MHZ(12), | |
68 | SR_MHZ(16), | |
69 | SR_MHZ(24) | |
70 | }; | |
71 | ||
72 | static struct sr_samplerates fx2lafw_samplerates = { | |
73 | SR_MHZ(1), | |
74 | SR_MHZ(24), | |
75 | SR_HZ(0), | |
76 | fx2lafw_supported_samplerates | |
77 | }; | |
78 | ||
cac0bbaa | 79 | static GSList *dev_insts = NULL; |
187b3582 JH |
80 | static libusb_context *usb_context = NULL; |
81 | ||
b1eeb67e JH |
82 | /** |
83 | * Check the USB configuration to determine if this is an fx2lafw device. | |
84 | * | |
85 | * @return true if the device's configuration profile match fx2lafw | |
86 | * configuration, flase otherwise. | |
87 | */ | |
88 | static bool check_conf_profile(libusb_device *dev) | |
89 | { | |
90 | struct libusb_device_descriptor des; | |
91 | struct libusb_config_descriptor *conf_dsc = NULL; | |
92 | const struct libusb_interface_descriptor *intf_dsc; | |
93 | bool ret = false; | |
94 | ||
95 | while (!ret) { | |
96 | /* Assume it's not a Saleae Logic unless proven wrong. */ | |
97 | ret = 0; | |
98 | ||
99 | if (libusb_get_device_descriptor(dev, &des) != 0) | |
100 | break; | |
101 | ||
102 | if (des.bNumConfigurations != 1) | |
103 | /* Need exactly 1 configuration. */ | |
104 | break; | |
105 | ||
106 | if (libusb_get_config_descriptor(dev, 0, &conf_dsc) != 0) | |
107 | break; | |
108 | ||
109 | if (conf_dsc->bNumInterfaces != 1) | |
110 | /* Need exactly 1 interface. */ | |
111 | break; | |
112 | ||
113 | if (conf_dsc->interface[0].num_altsetting != 1) | |
114 | /* Need just one alternate setting. */ | |
115 | break; | |
116 | ||
117 | intf_dsc = &(conf_dsc->interface[0].altsetting[0]); | |
118 | if (intf_dsc->bNumEndpoints != 3) | |
119 | /* Need exactly 3 end points. */ | |
120 | break; | |
121 | ||
122 | if ((intf_dsc->endpoint[0].bEndpointAddress & 0x8f) != | |
123 | (1 | LIBUSB_ENDPOINT_OUT)) | |
124 | /* The first endpoint should be 1 (outbound). */ | |
125 | break; | |
126 | ||
127 | if ((intf_dsc->endpoint[1].bEndpointAddress & 0x8f) != | |
128 | (2 | LIBUSB_ENDPOINT_IN)) | |
129 | /* The second endpoint should be 2 (inbound). */ | |
130 | break; | |
131 | ||
132 | /* TODO: Check the debug channel... */ | |
133 | ||
134 | /* If we made it here, it must be an fx2lafw. */ | |
135 | ret = true; | |
136 | } | |
137 | ||
138 | if (conf_dsc) | |
139 | libusb_free_config_descriptor(conf_dsc); | |
140 | ||
141 | return ret; | |
142 | } | |
143 | ||
43125c69 JH |
144 | static int fx2lafw_open_dev(int dev_index) |
145 | { | |
146 | libusb_device **devlist; | |
147 | struct libusb_device_descriptor des; | |
148 | struct sr_dev_inst *sdi; | |
149 | struct fx2lafw_device *ctx; | |
150 | int err, skip, i; | |
151 | ||
152 | if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) | |
153 | return SR_ERR; | |
154 | ctx = sdi->priv; | |
155 | ||
156 | if (sdi->status == SR_ST_ACTIVE) | |
157 | /* already in use */ | |
158 | return SR_ERR; | |
159 | ||
160 | skip = 0; | |
161 | libusb_get_device_list(usb_context, &devlist); | |
162 | for (i = 0; devlist[i]; i++) { | |
163 | if ((err = libusb_get_device_descriptor(devlist[i], &des))) { | |
164 | sr_err("fx2lafw: failed to get device descriptor: %d", err); | |
165 | continue; | |
166 | } | |
167 | ||
168 | if (des.idVendor != FIRMWARE_VID | |
169 | || des.idProduct != FIRMWARE_PID) | |
170 | continue; | |
171 | ||
172 | if (sdi->status == SR_ST_INITIALIZING) { | |
173 | if (skip != dev_index) { | |
174 | /* Skip devices of this type that aren't the one we want. */ | |
175 | skip += 1; | |
176 | continue; | |
177 | } | |
178 | } else if (sdi->status == SR_ST_INACTIVE) { | |
179 | /* | |
180 | * This device is fully enumerated, so we need to find | |
181 | * this device by vendor, product, bus and address. | |
182 | */ | |
183 | if (libusb_get_bus_number(devlist[i]) != ctx->usb->bus | |
184 | || libusb_get_device_address(devlist[i]) != ctx->usb->address) | |
185 | /* this is not the one */ | |
186 | continue; | |
187 | } | |
188 | ||
189 | if (!(err = libusb_open(devlist[i], &ctx->usb->devhdl))) { | |
190 | if (ctx->usb->address == 0xff) | |
191 | /* | |
192 | * first time we touch this device after firmware upload, | |
193 | * so we don't know the address yet. | |
194 | */ | |
195 | ctx->usb->address = libusb_get_device_address(devlist[i]); | |
196 | ||
197 | sdi->status = SR_ST_ACTIVE; | |
198 | sr_info("fx2lafw: opened device %d on %d.%d interface %d", | |
199 | sdi->index, ctx->usb->bus, | |
200 | ctx->usb->address, USB_INTERFACE); | |
201 | } else { | |
202 | sr_err("fx2lafw: failed to open device: %d", err); | |
203 | } | |
204 | ||
205 | /* if we made it here, we handled the device one way or another */ | |
206 | break; | |
207 | } | |
208 | libusb_free_device_list(devlist, 1); | |
209 | ||
210 | if (sdi->status != SR_ST_ACTIVE) | |
211 | return SR_ERR; | |
212 | ||
213 | return SR_OK; | |
214 | } | |
215 | ||
f1898235 JH |
216 | static void close_dev(struct sr_dev_inst *sdi) |
217 | { | |
218 | struct fx2lafw_device *ctx; | |
219 | ||
220 | ctx = sdi->priv; | |
221 | ||
222 | if (ctx->usb->devhdl == NULL) | |
223 | return; | |
224 | ||
225 | sr_info("fx2lafw: closing device %d on %d.%d interface %d", sdi->index, | |
226 | ctx->usb->bus, ctx->usb->address, USB_INTERFACE); | |
227 | libusb_release_interface(ctx->usb->devhdl, USB_INTERFACE); | |
228 | libusb_close(ctx->usb->devhdl); | |
229 | ctx->usb->devhdl = NULL; | |
230 | sdi->status = SR_ST_INACTIVE; | |
231 | } | |
232 | ||
187b3582 JH |
233 | static struct fx2lafw_device* fx2lafw_device_new(void) |
234 | { | |
235 | struct fx2lafw_device *fx2lafw; | |
236 | ||
237 | if (!(fx2lafw = g_try_malloc0(sizeof(struct fx2lafw_device)))) { | |
238 | sr_err("fx2lafw: %s: fx2lafw_device malloc failed", __func__); | |
239 | return NULL; | |
240 | } | |
241 | ||
242 | return fx2lafw; | |
243 | } | |
f302a082 JH |
244 | |
245 | /* | |
246 | * API callbacks | |
247 | */ | |
248 | ||
249 | static int hw_init(const char *deviceinfo) | |
250 | { | |
187b3582 JH |
251 | struct sr_dev_inst *sdi; |
252 | struct libusb_device_descriptor des; | |
253 | struct fx2lafw_profile *fx2lafw_prof; | |
90282c82 | 254 | struct fx2lafw_device *ctx; |
187b3582 JH |
255 | libusb_device **devlist; |
256 | int err; | |
257 | int devcnt = 0; | |
258 | int i, j; | |
259 | ||
260 | /* Avoid compiler warnings. */ | |
f302a082 | 261 | (void)deviceinfo; |
187b3582 JH |
262 | |
263 | if (libusb_init(&usb_context) != 0) { | |
264 | sr_warn("Failed to initialize USB."); | |
265 | return 0; | |
266 | } | |
267 | ||
268 | /* Find all fx2lafw compatible devices and upload firware to all of them. */ | |
269 | libusb_get_device_list(usb_context, &devlist); | |
270 | for (i = 0; devlist[i]; i++) { | |
271 | ||
272 | if ((err = libusb_get_device_descriptor( | |
273 | devlist[i], &des)) != 0) { | |
274 | sr_warn("failed to get device descriptor: %d", err); | |
275 | continue; | |
276 | } | |
277 | ||
278 | fx2lafw_prof = NULL; | |
279 | for (j = 0; supported_fx2[j].vid; j++) { | |
280 | if (des.idVendor == supported_fx2[j].vid && | |
281 | des.idProduct == supported_fx2[j].pid) { | |
282 | fx2lafw_prof = &supported_fx2[j]; | |
283 | } | |
284 | } | |
285 | ||
286 | /* Skip if the device was not found */ | |
287 | if(!fx2lafw_prof) | |
288 | continue; | |
289 | ||
290 | sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING, | |
291 | fx2lafw_prof->vendor, fx2lafw_prof->model, | |
292 | fx2lafw_prof->model_version); | |
293 | if(!sdi) | |
294 | return 0; | |
295 | ||
90282c82 JH |
296 | ctx = fx2lafw_device_new(); |
297 | ctx->profile = fx2lafw_prof; | |
298 | sdi->priv = ctx; | |
cac0bbaa | 299 | device_instances = g_slist_append(dev_insts, sdi); |
187b3582 | 300 | |
b1eeb67e JH |
301 | if (check_conf_profile(devlist[i])) { |
302 | /* Already has the firmware, so fix the new address. */ | |
303 | sr_dbg("fx2lafw: Found a fx2lafw device."); | |
304 | sdi->status = SR_ST_INACTIVE; | |
305 | ctx->usb = sr_usb_dev_inst_new | |
306 | (libusb_get_bus_number(devlist[i]), | |
307 | libusb_get_device_address(devlist[i]), NULL); | |
308 | } else { | |
309 | if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION, FIRMWARE) == SR_OK) | |
310 | /* Remember when the firmware on this device was updated */ | |
311 | g_get_current_time(&ctx->fw_updated); | |
312 | else | |
313 | sr_err("fx2lafw: firmware upload failed for " | |
314 | "device %d", devcnt); | |
315 | ctx->usb = sr_usb_dev_inst_new | |
316 | (libusb_get_bus_number(devlist[i]), 0xff, NULL); | |
317 | } | |
318 | ||
187b3582 JH |
319 | devcnt++; |
320 | } | |
321 | libusb_free_device_list(devlist, 1); | |
322 | ||
323 | return devcnt; | |
f302a082 JH |
324 | } |
325 | ||
326 | static int hw_dev_open(int device_index) | |
327 | { | |
43125c69 JH |
328 | GTimeVal cur_time; |
329 | struct sr_dev_inst *sdi; | |
330 | struct fx2lafw_device *ctx; | |
331 | int timediff, err; | |
332 | ||
333 | if (!(sdi = sr_dev_inst_get(dev_insts, device_index))) | |
334 | return SR_ERR; | |
335 | ctx = sdi->priv; | |
336 | ||
337 | /* | |
338 | * if the firmware was recently uploaded, wait up to MAX_RENUM_DELAY ms | |
339 | * for the FX2 to renumerate | |
340 | */ | |
341 | err = 0; | |
342 | if (GTV_TO_MSEC(ctx->fw_updated) > 0) { | |
343 | sr_info("fx2lafw: waiting for device to reset"); | |
344 | /* takes at least 300ms for the FX2 to be gone from the USB bus */ | |
345 | g_usleep(300 * 1000); | |
346 | timediff = 0; | |
347 | while (timediff < MAX_RENUM_DELAY) { | |
348 | if ((err = fx2lafw_open_dev(device_index)) == SR_OK) | |
349 | break; | |
350 | g_usleep(100 * 1000); | |
351 | g_get_current_time(&cur_time); | |
352 | timediff = GTV_TO_MSEC(cur_time) - GTV_TO_MSEC(ctx->fw_updated); | |
353 | } | |
354 | sr_info("fx2lafw: device came back after %d ms", timediff); | |
355 | } else { | |
356 | err = fx2lafw_open_dev(device_index); | |
357 | } | |
358 | ||
359 | if (err != SR_OK) { | |
360 | sr_err("fx2lafw: unable to open device"); | |
361 | return SR_ERR; | |
362 | } | |
363 | ctx = sdi->priv; | |
364 | ||
365 | err = libusb_claim_interface(ctx->usb->devhdl, USB_INTERFACE); | |
366 | if (err != 0) { | |
367 | sr_err("fx2lafw: Unable to claim interface: %d", err); | |
368 | return SR_ERR; | |
369 | } | |
370 | ||
f302a082 JH |
371 | return SR_OK; |
372 | } | |
373 | ||
f1898235 | 374 | static int hw_dev_close(int dev_index) |
f302a082 | 375 | { |
f1898235 JH |
376 | struct sr_dev_inst *sdi; |
377 | ||
378 | if (!(sdi = sr_dev_inst_get(dev_insts, dev_index))) { | |
379 | sr_err("fx2lafw: %s: sdi was NULL", __func__); | |
380 | return SR_ERR; /* TODO: SR_ERR_ARG? */ | |
381 | } | |
382 | ||
383 | /* TODO */ | |
384 | close_dev(sdi); | |
385 | ||
f302a082 JH |
386 | return SR_OK; |
387 | } | |
388 | ||
389 | static int hw_cleanup(void) | |
390 | { | |
187b3582 JH |
391 | GSList *l; |
392 | struct sr_dev_inst *sdi; | |
393 | ||
394 | for(l = device_instances; l; l = l->next) { | |
395 | sdi = l->data; | |
396 | sr_dev_inst_free(sdi); | |
397 | } | |
398 | ||
399 | g_slist_free(device_instances); | |
400 | device_instances = NULL; | |
401 | ||
402 | if(usb_context) | |
403 | libusb_exit(usb_context); | |
404 | usb_context = NULL; | |
405 | ||
f302a082 JH |
406 | return SR_OK; |
407 | } | |
408 | ||
409 | static void *hw_dev_info_get(int device_index, int device_info_id) | |
410 | { | |
8b35f474 | 411 | struct sr_dev_inst *sdi; |
cdfdd711 | 412 | struct fx2lafw_device *ctx; |
8b35f474 | 413 | |
cac0bbaa | 414 | if (!(sdi = sr_dev_inst_get(dev_insts, device_index))) |
8b35f474 | 415 | return NULL; |
cdfdd711 | 416 | ctx = sdi->priv; |
8b35f474 JH |
417 | |
418 | switch (device_info_id) { | |
419 | case SR_DI_INST: | |
420 | return sdi; | |
421 | case SR_DI_NUM_PROBES: | |
cdfdd711 | 422 | return GINT_TO_POINTER(ctx->profile->num_probes); |
8b35f474 JH |
423 | case SR_DI_PROBE_NAMES: |
424 | return fx2lafw_probe_names; | |
425 | case SR_DI_SAMPLERATES: | |
426 | return &fx2lafw_samplerates; | |
427 | case SR_DI_TRIGGER_TYPES: | |
428 | return TRIGGER_TYPES; | |
429 | } | |
430 | ||
f302a082 JH |
431 | return NULL; |
432 | } | |
433 | ||
434 | static int hw_dev_status_get(int device_index) | |
435 | { | |
aae2fed6 | 436 | const struct sr_dev_inst *const sdi = |
cac0bbaa | 437 | sr_dev_inst_get(dev_insts, device_index); |
aae2fed6 JH |
438 | |
439 | if (!sdi) | |
440 | return SR_ST_NOT_FOUND; | |
441 | ||
442 | return sdi->status; | |
f302a082 JH |
443 | } |
444 | ||
445 | static int *hw_hwcap_get_all(void) | |
446 | { | |
8b35f474 | 447 | return fx2lafw_capabilities; |
f302a082 JH |
448 | } |
449 | ||
450 | static int hw_dev_config_set(int dev_index, int capability, void *value) | |
451 | { | |
452 | (void)dev_index; | |
453 | (void)capability; | |
454 | (void)value; | |
455 | return SR_OK; | |
456 | } | |
457 | ||
458 | static int hw_dev_acquisition_start(int dev_index, gpointer session_data) | |
459 | { | |
460 | (void)dev_index; | |
461 | (void)session_data; | |
462 | return SR_OK; | |
463 | } | |
464 | ||
465 | /* This stops acquisition on ALL devices, ignoring device_index. */ | |
466 | static int hw_dev_acquisition_stop(int dev_index, gpointer session_data) | |
467 | { | |
468 | (void)dev_index; | |
469 | (void)session_data; | |
470 | return SR_OK; | |
471 | } | |
472 | ||
473 | SR_PRIV struct sr_dev_plugin fx2lafw_plugin_info = { | |
474 | .name = "fx2lafw", | |
475 | .longname = "fx2lafw", | |
476 | .api_version = 1, | |
477 | .init = hw_init, | |
478 | .cleanup = hw_cleanup, | |
479 | .dev_open = hw_dev_open, | |
480 | .dev_close = hw_dev_close, | |
481 | .dev_info_get = hw_dev_info_get, | |
482 | .dev_status_get = hw_dev_status_get, | |
483 | .hwcap_get_all = hw_hwcap_get_all, | |
484 | .dev_config_set = hw_dev_config_set, | |
485 | .dev_acquisition_start = hw_dev_acquisition_start, | |
486 | .dev_acquisition_stop = hw_dev_acquisition_stop, | |
487 | }; |