]>
Commit | Line | Data |
---|---|---|
4f7fdcdd SA |
1 | /* |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2015 Sergey Alirzaev <zl29ah@gmail.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 | ||
cee6d3fa | 20 | #include <config.h> |
4f7fdcdd SA |
21 | #include <ftdi.h> |
22 | #include <libusb.h> | |
cee6d3fa SA |
23 | #include <libsigrok/libsigrok.h> |
24 | #include "libsigrok-internal.h" | |
4f7fdcdd SA |
25 | #include "protocol.h" |
26 | ||
f2273382 | 27 | SR_PRIV struct sr_dev_driver ftdi_la_driver_info; |
4f7fdcdd SA |
28 | |
29 | static const uint32_t scanopts[] = { | |
cee6d3fa | 30 | SR_CONF_CONN, |
4f7fdcdd SA |
31 | }; |
32 | ||
33 | static const uint32_t devopts[] = { | |
34 | SR_CONF_LOGIC_ANALYZER, | |
cee6d3fa | 35 | SR_CONF_CONTINUOUS | SR_CONF_SET, |
4f7fdcdd SA |
36 | SR_CONF_LIMIT_SAMPLES | SR_CONF_SET, |
37 | SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
cee6d3fa | 38 | SR_CONF_CONN | SR_CONF_GET, |
4f7fdcdd SA |
39 | }; |
40 | ||
41 | static const uint64_t samplerates[] = { | |
42 | SR_HZ(3600), | |
43 | SR_MHZ(10), | |
44 | SR_HZ(1), | |
45 | }; | |
46 | ||
47 | static const struct ftdi_chip_desc ft2232h_desc = { | |
48 | .vendor = 0x0403, | |
49 | .product = 0x6010, | |
50 | .samplerate_div = 20, | |
51 | .channel_names = { | |
52 | "ADBUS0", | |
53 | "ADBUS1", | |
54 | "ADBUS2", | |
55 | "ADBUS3", | |
56 | "ADBUS4", | |
57 | "ADBUS5", | |
58 | "ADBUS6", | |
59 | "ADBUS7", | |
60 | /* TODO: BDBUS[0..7] channels. */ | |
61 | NULL | |
62 | } | |
63 | }; | |
64 | ||
65 | static const struct ftdi_chip_desc ft232r_desc = { | |
66 | .vendor = 0x0403, | |
67 | .product = 0x6001, | |
68 | .samplerate_div = 30, | |
69 | .channel_names = { | |
70 | "TXD", | |
4f7fdcdd | 71 | "RXD", |
cee6d3fa SA |
72 | "RTS#", |
73 | "CTS#", | |
74 | "DTR#", | |
75 | "DSR#", | |
76 | "DCD#", | |
77 | "RI#", | |
4f7fdcdd SA |
78 | NULL |
79 | } | |
80 | }; | |
81 | ||
82 | static const struct ftdi_chip_desc *chip_descs[] = { | |
83 | &ft2232h_desc, | |
84 | &ft232r_desc, | |
85 | }; | |
86 | ||
87 | static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx) | |
88 | { | |
89 | return std_init(sr_ctx, di, LOG_PREFIX); | |
90 | } | |
91 | ||
cee6d3fa | 92 | static void scan_device(struct sr_dev_driver *di, struct libusb_device *dev, GSList **devices) |
4f7fdcdd | 93 | { |
4f7fdcdd SA |
94 | struct libusb_device_descriptor usb_desc; |
95 | const struct ftdi_chip_desc *desc; | |
cee6d3fa | 96 | struct dev_context *devc; |
4f7fdcdd | 97 | char *vendor, *model, *serial_num; |
cee6d3fa SA |
98 | struct sr_dev_inst *sdi; |
99 | struct drv_context *drvc; | |
100 | int rv; | |
4f7fdcdd | 101 | |
4f7fdcdd | 102 | drvc = di->context; |
cee6d3fa SA |
103 | libusb_get_device_descriptor(dev, &usb_desc); |
104 | ||
105 | desc = NULL; | |
106 | for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) { | |
107 | desc = chip_descs[i]; | |
108 | if (desc->vendor == usb_desc.idVendor && | |
109 | desc->product == usb_desc.idProduct) | |
110 | break; | |
111 | } | |
112 | ||
113 | if (!desc) { | |
114 | sr_spew("Unsupported FTDI device 0x%4x:0x%4x.", | |
115 | usb_desc.idVendor, usb_desc.idProduct); | |
116 | return; | |
117 | } | |
4f7fdcdd SA |
118 | |
119 | /* Allocate memory for our private device context. */ | |
120 | devc = g_malloc0(sizeof(struct dev_context)); | |
121 | ||
122 | /* Allocate memory for the incoming data. */ | |
123 | devc->data_buf = g_malloc0(DATA_BUF_SIZE); | |
124 | ||
125 | /* Allocate memory for the FTDI context (ftdic) and initialize it. */ | |
126 | devc->ftdic = ftdi_new(); | |
127 | if (!devc->ftdic) { | |
128 | sr_err("Failed to initialize libftdi."); | |
129 | goto err_free_data_buf; | |
130 | } | |
131 | ||
cee6d3fa SA |
132 | devc->usbdev = dev; |
133 | devc->desc = desc; | |
134 | ||
135 | vendor = g_malloc(32); | |
136 | model = g_malloc(32); | |
137 | serial_num = g_malloc(32); | |
138 | rv = ftdi_usb_get_strings(devc->ftdic, dev, vendor, 32, | |
139 | model, 32, serial_num, 32); | |
140 | switch (rv) { | |
141 | case 0: | |
142 | break; | |
143 | case -9: | |
144 | sr_dbg("The device lacks a serial number."); | |
145 | g_free(serial_num); | |
146 | serial_num = NULL; | |
147 | break; | |
148 | default: | |
149 | sr_err("Failed to get the FTDI strings: %d", rv); | |
150 | goto err_free_strings; | |
151 | } | |
152 | sr_dbg("Found an FTDI device: %s.", model); | |
153 | ||
154 | /* Register the device with libsigrok. */ | |
155 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); | |
156 | sdi->status = SR_ST_INITIALIZING; | |
157 | sdi->vendor = vendor; | |
158 | sdi->model = model; | |
159 | sdi->serial_num = serial_num; | |
160 | sdi->driver = di; | |
161 | sdi->priv = devc; | |
162 | ||
163 | for (char *const *chan = &(desc->channel_names[0]); *chan; chan++) | |
164 | sr_channel_new(sdi, chan - &(desc->channel_names[0]), | |
165 | SR_CHANNEL_LOGIC, TRUE, *chan); | |
166 | ||
167 | *devices = g_slist_append(*devices, sdi); | |
168 | drvc->instances = g_slist_append(drvc->instances, sdi); | |
169 | return; | |
170 | ||
171 | err_free_strings: | |
172 | g_free(vendor); | |
173 | g_free(model); | |
174 | g_free(serial_num); | |
7b6072d3 | 175 | ftdi_free(devc->ftdic); |
cee6d3fa SA |
176 | err_free_data_buf: |
177 | g_free(devc->data_buf); | |
178 | g_free(devc); | |
179 | } | |
180 | ||
181 | static GSList *scan_all(struct sr_dev_driver *di, GSList *options) | |
182 | { | |
183 | GSList *devices; | |
184 | struct ftdi_device_list *devlist = 0; | |
185 | struct ftdi_device_list *curdev; | |
186 | struct ftdi_context *ftdic; | |
187 | int ret; | |
188 | ||
189 | (void)options; | |
190 | ||
191 | devices = NULL; | |
192 | ||
193 | /* Allocate memory for the FTDI context (ftdic) and initialize it. */ | |
194 | ftdic = ftdi_new(); | |
195 | if (!ftdic) { | |
196 | sr_err("Failed to initialize libftdi."); | |
197 | return NULL; | |
198 | } | |
199 | ||
200 | ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0); | |
4f7fdcdd SA |
201 | if (ret < 0) { |
202 | sr_err("Failed to list devices (%d): %s", ret, | |
cee6d3fa | 203 | ftdi_get_error_string(ftdic)); |
4f7fdcdd SA |
204 | goto err_free_ftdic; |
205 | } | |
206 | ||
207 | sr_dbg("Number of FTDI devices found: %d", ret); | |
208 | ||
209 | curdev = devlist; | |
210 | while (curdev) { | |
cee6d3fa | 211 | scan_device(di, curdev->dev, &devices); |
4f7fdcdd SA |
212 | curdev = curdev->next; |
213 | } | |
214 | ||
7b6072d3 LPC |
215 | ftdi_list_free(&devlist); |
216 | ftdi_free(ftdic); | |
217 | ||
4f7fdcdd SA |
218 | return devices; |
219 | ||
220 | err_free_ftdic: | |
cee6d3fa | 221 | ftdi_free(ftdic); /* NOT free() or g_free()! */ |
4f7fdcdd SA |
222 | |
223 | return NULL; | |
224 | } | |
225 | ||
cee6d3fa SA |
226 | static GSList *scan(struct sr_dev_driver *di, GSList *options) |
227 | { | |
228 | struct sr_config *src; | |
229 | struct sr_usb_dev_inst *usb; | |
230 | const char *conn; | |
231 | GSList *l, *conn_devices; | |
232 | GSList *devices; | |
233 | struct drv_context *drvc; | |
234 | libusb_device **devlist; | |
235 | int i; | |
236 | ||
237 | drvc = di->context; | |
238 | drvc->instances = NULL; | |
239 | conn = NULL; | |
240 | for (l = options; l; l = l->next) { | |
241 | src = l->data; | |
242 | if (src->key == SR_CONF_CONN) { | |
243 | conn = g_variant_get_string(src->data, NULL); | |
244 | break; | |
245 | } | |
246 | } | |
247 | if (conn) { | |
248 | devices = NULL; | |
249 | libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); | |
250 | for (i = 0; devlist[i]; i++) { | |
251 | conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn); | |
252 | for (l = conn_devices; l; l = l->next) { | |
253 | usb = l->data; | |
254 | if (usb->bus == libusb_get_bus_number(devlist[i]) | |
255 | && usb->address == libusb_get_device_address(devlist[i])) { | |
256 | scan_device(di, devlist[i], &devices); | |
257 | } | |
258 | } | |
259 | } | |
260 | libusb_free_device_list(devlist, 1); | |
261 | return devices; | |
262 | } else | |
263 | return scan_all(di, options); | |
264 | } | |
265 | ||
4f7fdcdd SA |
266 | static GSList *dev_list(const struct sr_dev_driver *di) |
267 | { | |
268 | return ((struct drv_context *)(di->context))->instances; | |
269 | } | |
270 | ||
271 | static void clear_helper(void *priv) | |
272 | { | |
273 | struct dev_context *devc; | |
274 | ||
275 | devc = priv; | |
276 | ||
277 | ftdi_free(devc->ftdic); | |
278 | g_free(devc->data_buf); | |
279 | g_free(devc); | |
280 | } | |
281 | ||
282 | static int dev_clear(const struct sr_dev_driver *di) | |
283 | { | |
284 | return std_dev_clear(di, clear_helper); | |
285 | } | |
286 | ||
287 | static int dev_open(struct sr_dev_inst *sdi) | |
288 | { | |
289 | struct dev_context *devc; | |
290 | int ret = SR_OK; | |
291 | ||
292 | devc = sdi->priv; | |
293 | ||
294 | ret = ftdi_usb_open_dev(devc->ftdic, devc->usbdev); | |
295 | if (ret < 0) { | |
296 | /* Log errors, except for -3 ("device not found"). */ | |
297 | if (ret != -3) | |
298 | sr_err("Failed to open device (%d): %s", ret, | |
299 | ftdi_get_error_string(devc->ftdic)); | |
300 | return SR_ERR; | |
301 | } | |
302 | ||
303 | /* Purge RX/TX buffers in the FTDI chip. */ | |
304 | ret = ftdi_usb_purge_buffers(devc->ftdic); | |
305 | if (ret < 0) { | |
306 | sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.", | |
307 | ret, ftdi_get_error_string(devc->ftdic)); | |
308 | goto err_dev_open_close_ftdic; | |
309 | } | |
310 | sr_dbg("FTDI chip buffers purged successfully."); | |
311 | ||
312 | /* Reset the FTDI bitmode. */ | |
313 | ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET); | |
314 | if (ret < 0) { | |
315 | sr_err("Failed to reset the FTDI chip bitmode (%d): %s.", | |
316 | ret, ftdi_get_error_string(devc->ftdic)); | |
317 | goto err_dev_open_close_ftdic; | |
318 | } | |
319 | sr_dbg("FTDI chip bitmode reset successfully."); | |
320 | ||
321 | ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG); | |
322 | if (ret < 0) { | |
323 | sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.", | |
324 | ret, ftdi_get_error_string(devc->ftdic)); | |
325 | goto err_dev_open_close_ftdic; | |
326 | } | |
327 | sr_dbg("FTDI chip bitbang mode entered successfully."); | |
328 | ||
329 | sdi->status = SR_ST_ACTIVE; | |
330 | ||
331 | return SR_OK; | |
332 | ||
333 | err_dev_open_close_ftdic: | |
334 | ftdi_usb_close(devc->ftdic); | |
335 | return SR_ERR; | |
336 | } | |
337 | ||
338 | static int dev_close(struct sr_dev_inst *sdi) | |
339 | { | |
340 | struct dev_context *devc; | |
341 | ||
342 | devc = sdi->priv; | |
343 | ||
344 | ftdi_usb_close(devc->ftdic); | |
345 | ||
346 | sdi->status = SR_ST_INACTIVE; | |
347 | ||
348 | return SR_OK; | |
349 | } | |
350 | ||
351 | static int cleanup(const struct sr_dev_driver *di) | |
352 | { | |
353 | dev_clear(di); | |
354 | ||
355 | /* TODO: Free other driver resources, if any. */ | |
356 | ||
357 | return SR_OK; | |
358 | } | |
359 | ||
360 | static int config_get(uint32_t key, GVariant **data, | |
361 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
362 | { | |
363 | int ret; | |
364 | struct dev_context *devc; | |
cee6d3fa SA |
365 | struct sr_usb_dev_inst *usb; |
366 | char str[128]; | |
4f7fdcdd SA |
367 | |
368 | (void)cg; | |
369 | ||
370 | devc = sdi->priv; | |
371 | ||
372 | ret = SR_OK; | |
373 | switch (key) { | |
374 | case SR_CONF_SAMPLERATE: | |
375 | *data = g_variant_new_uint64(devc->cur_samplerate); | |
376 | break; | |
cee6d3fa SA |
377 | case SR_CONF_CONN: |
378 | if (!sdi || !sdi->conn) | |
379 | return SR_ERR_ARG; | |
380 | usb = sdi->conn; | |
381 | snprintf(str, 128, "%d.%d", usb->bus, usb->address); | |
382 | *data = g_variant_new_string(str); | |
383 | break; | |
4f7fdcdd SA |
384 | default: |
385 | return SR_ERR_NA; | |
386 | } | |
387 | ||
388 | return ret; | |
389 | } | |
390 | ||
4f7fdcdd SA |
391 | static int config_set(uint32_t key, GVariant *data, |
392 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
393 | { | |
394 | int ret; | |
395 | struct dev_context *devc; | |
396 | uint64_t value; | |
397 | ||
398 | (void)cg; | |
399 | ||
400 | if (sdi->status != SR_ST_ACTIVE) | |
401 | return SR_ERR_DEV_CLOSED; | |
402 | ||
403 | devc = sdi->priv; | |
404 | ||
405 | ret = SR_OK; | |
406 | switch (key) { | |
407 | case SR_CONF_LIMIT_MSEC: | |
408 | value = g_variant_get_uint64(data); | |
409 | /* TODO: Implement. */ | |
410 | ret = SR_ERR_NA; | |
411 | break; | |
412 | case SR_CONF_LIMIT_SAMPLES: | |
413 | if (g_variant_get_uint64(data) == 0) | |
414 | return SR_ERR_ARG; | |
415 | devc->limit_samples = g_variant_get_uint64(data); | |
416 | break; | |
417 | case SR_CONF_SAMPLERATE: | |
418 | value = g_variant_get_uint64(data); | |
419 | if (value < 3600) | |
420 | return SR_ERR_SAMPLERATE; | |
421 | devc->cur_samplerate = value; | |
f2273382 | 422 | return ftdi_la_set_samplerate(devc); |
4f7fdcdd SA |
423 | default: |
424 | ret = SR_ERR_NA; | |
425 | } | |
426 | ||
427 | return ret; | |
428 | } | |
429 | ||
430 | static int config_list(uint32_t key, GVariant **data, | |
431 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
432 | { | |
433 | int ret; | |
434 | GVariant *gvar; | |
435 | GVariantBuilder gvb; | |
436 | ||
437 | (void)sdi; | |
438 | (void)cg; | |
439 | ||
440 | ret = SR_OK; | |
441 | switch (key) { | |
442 | case SR_CONF_SCAN_OPTIONS: | |
443 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
444 | scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t)); | |
445 | break; | |
446 | case SR_CONF_DEVICE_OPTIONS: | |
447 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
448 | devopts, ARRAY_SIZE(devopts), sizeof(uint32_t)); | |
449 | break; | |
450 | case SR_CONF_SAMPLERATE: | |
451 | g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}")); | |
452 | gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), | |
453 | samplerates, ARRAY_SIZE(samplerates), sizeof(uint64_t)); | |
454 | g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar); | |
455 | *data = g_variant_builder_end(&gvb); | |
456 | break; | |
457 | default: | |
458 | return SR_ERR_NA; | |
459 | } | |
460 | ||
461 | return ret; | |
462 | } | |
463 | ||
695dc859 | 464 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) |
4f7fdcdd SA |
465 | { |
466 | struct dev_context *devc; | |
467 | ||
4f7fdcdd SA |
468 | devc = sdi->priv; |
469 | ||
470 | if (sdi->status != SR_ST_ACTIVE) | |
471 | return SR_ERR_DEV_CLOSED; | |
472 | ||
473 | if (!devc->ftdic) | |
474 | return SR_ERR_BUG; | |
475 | ||
476 | ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG); | |
477 | ||
4f7fdcdd SA |
478 | /* Properly reset internal variables before every new acquisition. */ |
479 | devc->samples_sent = 0; | |
480 | devc->bytes_received = 0; | |
481 | ||
4f7fdcdd SA |
482 | std_session_send_df_header(sdi, LOG_PREFIX); |
483 | ||
484 | /* Hook up a dummy handler to receive data from the device. */ | |
485 | sr_session_source_add(sdi->session, -1, G_IO_IN, 0, | |
f2273382 | 486 | ftdi_la_receive_data, (void *)sdi); |
4f7fdcdd SA |
487 | |
488 | return SR_OK; | |
489 | } | |
490 | ||
695dc859 | 491 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) |
4f7fdcdd | 492 | { |
4f7fdcdd SA |
493 | if (sdi->status != SR_ST_ACTIVE) |
494 | return SR_ERR_DEV_CLOSED; | |
495 | ||
496 | sr_dbg("Stopping acquisition."); | |
497 | sr_session_source_remove(sdi->session, -1); | |
498 | ||
3be42bc2 | 499 | std_session_send_df_end(sdi, LOG_PREFIX); |
4f7fdcdd SA |
500 | |
501 | return SR_OK; | |
502 | } | |
503 | ||
f2273382 UH |
504 | SR_PRIV struct sr_dev_driver ftdi_la_driver_info = { |
505 | .name = "ftdi-la", | |
506 | .longname = "FTDI LA", | |
4f7fdcdd SA |
507 | .api_version = 1, |
508 | .init = init, | |
509 | .cleanup = cleanup, | |
510 | .scan = scan, | |
511 | .dev_list = dev_list, | |
512 | .dev_clear = dev_clear, | |
513 | .config_get = config_get, | |
514 | .config_set = config_set, | |
515 | .config_list = config_list, | |
516 | .dev_open = dev_open, | |
517 | .dev_close = dev_close, | |
518 | .dev_acquisition_start = dev_acquisition_start, | |
519 | .dev_acquisition_stop = dev_acquisition_stop, | |
520 | .context = NULL, | |
521 | }; |