]>
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 | ||
4f7fdcdd | 27 | static const uint32_t scanopts[] = { |
cee6d3fa | 28 | SR_CONF_CONN, |
4f7fdcdd SA |
29 | }; |
30 | ||
8cd15dd4 | 31 | static const uint32_t drvopts[] = { |
4f7fdcdd | 32 | SR_CONF_LOGIC_ANALYZER, |
8cd15dd4 UH |
33 | }; |
34 | ||
35 | static const uint32_t devopts[] = { | |
e91bb0a6 | 36 | SR_CONF_CONTINUOUS, |
4f7fdcdd SA |
37 | SR_CONF_LIMIT_SAMPLES | SR_CONF_SET, |
38 | SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST, | |
cee6d3fa | 39 | SR_CONF_CONN | SR_CONF_GET, |
4f7fdcdd SA |
40 | }; |
41 | ||
42 | static const uint64_t samplerates[] = { | |
43 | SR_HZ(3600), | |
44 | SR_MHZ(10), | |
45 | SR_HZ(1), | |
46 | }; | |
47 | ||
48 | static const struct ftdi_chip_desc ft2232h_desc = { | |
49 | .vendor = 0x0403, | |
50 | .product = 0x6010, | |
51 | .samplerate_div = 20, | |
52 | .channel_names = { | |
8cd15dd4 UH |
53 | "ADBUS0", "ADBUS1", "ADBUS2", "ADBUS3", |
54 | "ADBUS4", "ADBUS5", "ADBUS6", "ADBUS7", | |
4f7fdcdd SA |
55 | /* TODO: BDBUS[0..7] channels. */ |
56 | NULL | |
57 | } | |
58 | }; | |
59 | ||
60 | static const struct ftdi_chip_desc ft232r_desc = { | |
61 | .vendor = 0x0403, | |
62 | .product = 0x6001, | |
63 | .samplerate_div = 30, | |
64 | .channel_names = { | |
8cd15dd4 | 65 | "TXD", "RXD", "RTS#", "CTS#", "DTR#", "DSR#", "DCD#", "RI#", |
4f7fdcdd SA |
66 | NULL |
67 | } | |
68 | }; | |
69 | ||
70 | static const struct ftdi_chip_desc *chip_descs[] = { | |
71 | &ft2232h_desc, | |
72 | &ft232r_desc, | |
73 | }; | |
74 | ||
15a5bfe4 | 75 | static void scan_device(struct ftdi_context *ftdic, |
07a91752 | 76 | struct libusb_device *dev, GSList **devices) |
4f7fdcdd | 77 | { |
4f7fdcdd SA |
78 | struct libusb_device_descriptor usb_desc; |
79 | const struct ftdi_chip_desc *desc; | |
cee6d3fa | 80 | struct dev_context *devc; |
4f7fdcdd | 81 | char *vendor, *model, *serial_num; |
cee6d3fa | 82 | struct sr_dev_inst *sdi; |
cee6d3fa | 83 | int rv; |
4f7fdcdd | 84 | |
cee6d3fa SA |
85 | libusb_get_device_descriptor(dev, &usb_desc); |
86 | ||
87 | desc = NULL; | |
88 | for (unsigned long i = 0; i < ARRAY_SIZE(chip_descs); i++) { | |
89 | desc = chip_descs[i]; | |
90 | if (desc->vendor == usb_desc.idVendor && | |
91 | desc->product == usb_desc.idProduct) | |
92 | break; | |
93 | } | |
94 | ||
95 | if (!desc) { | |
96 | sr_spew("Unsupported FTDI device 0x%4x:0x%4x.", | |
97 | usb_desc.idVendor, usb_desc.idProduct); | |
98 | return; | |
99 | } | |
4f7fdcdd | 100 | |
4f7fdcdd SA |
101 | devc = g_malloc0(sizeof(struct dev_context)); |
102 | ||
103 | /* Allocate memory for the incoming data. */ | |
104 | devc->data_buf = g_malloc0(DATA_BUF_SIZE); | |
105 | ||
cee6d3fa SA |
106 | devc->desc = desc; |
107 | ||
108 | vendor = g_malloc(32); | |
109 | model = g_malloc(32); | |
110 | serial_num = g_malloc(32); | |
07a91752 | 111 | rv = ftdi_usb_get_strings(ftdic, dev, vendor, 32, |
d9251a2c | 112 | model, 32, serial_num, 32); |
cee6d3fa SA |
113 | switch (rv) { |
114 | case 0: | |
115 | break; | |
116 | case -9: | |
117 | sr_dbg("The device lacks a serial number."); | |
118 | g_free(serial_num); | |
119 | serial_num = NULL; | |
120 | break; | |
121 | default: | |
122 | sr_err("Failed to get the FTDI strings: %d", rv); | |
123 | goto err_free_strings; | |
124 | } | |
125 | sr_dbg("Found an FTDI device: %s.", model); | |
126 | ||
cee6d3fa | 127 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); |
45884333 | 128 | sdi->status = SR_ST_INACTIVE; |
cee6d3fa SA |
129 | sdi->vendor = vendor; |
130 | sdi->model = model; | |
131 | sdi->serial_num = serial_num; | |
cee6d3fa | 132 | sdi->priv = devc; |
634d7299 LPC |
133 | sdi->connection_id = g_strdup_printf("d:%u/%u", |
134 | libusb_get_bus_number(dev), libusb_get_device_address(dev)); | |
cee6d3fa SA |
135 | |
136 | for (char *const *chan = &(desc->channel_names[0]); *chan; chan++) | |
137 | sr_channel_new(sdi, chan - &(desc->channel_names[0]), | |
138 | SR_CHANNEL_LOGIC, TRUE, *chan); | |
139 | ||
140 | *devices = g_slist_append(*devices, sdi); | |
cee6d3fa SA |
141 | return; |
142 | ||
143 | err_free_strings: | |
144 | g_free(vendor); | |
145 | g_free(model); | |
146 | g_free(serial_num); | |
cee6d3fa SA |
147 | g_free(devc->data_buf); |
148 | g_free(devc); | |
149 | } | |
150 | ||
15a5bfe4 | 151 | static GSList *scan_all(struct ftdi_context *ftdic, GSList *options) |
cee6d3fa SA |
152 | { |
153 | GSList *devices; | |
154 | struct ftdi_device_list *devlist = 0; | |
155 | struct ftdi_device_list *curdev; | |
cee6d3fa SA |
156 | int ret; |
157 | ||
158 | (void)options; | |
159 | ||
160 | devices = NULL; | |
161 | ||
cee6d3fa | 162 | ret = ftdi_usb_find_all(ftdic, &devlist, 0, 0); |
4f7fdcdd SA |
163 | if (ret < 0) { |
164 | sr_err("Failed to list devices (%d): %s", ret, | |
cee6d3fa | 165 | ftdi_get_error_string(ftdic)); |
07a91752 | 166 | return NULL; |
4f7fdcdd SA |
167 | } |
168 | ||
4f7fdcdd SA |
169 | curdev = devlist; |
170 | while (curdev) { | |
15a5bfe4 | 171 | scan_device(ftdic, curdev->dev, &devices); |
4f7fdcdd SA |
172 | curdev = curdev->next; |
173 | } | |
174 | ||
7b6072d3 | 175 | ftdi_list_free(&devlist); |
7b6072d3 | 176 | |
4f7fdcdd | 177 | return devices; |
4f7fdcdd SA |
178 | } |
179 | ||
cee6d3fa SA |
180 | static GSList *scan(struct sr_dev_driver *di, GSList *options) |
181 | { | |
07a91752 | 182 | struct ftdi_context *ftdic; |
cee6d3fa SA |
183 | struct sr_config *src; |
184 | struct sr_usb_dev_inst *usb; | |
185 | const char *conn; | |
186 | GSList *l, *conn_devices; | |
187 | GSList *devices; | |
188 | struct drv_context *drvc; | |
189 | libusb_device **devlist; | |
190 | int i; | |
191 | ||
192 | drvc = di->context; | |
cee6d3fa SA |
193 | conn = NULL; |
194 | for (l = options; l; l = l->next) { | |
195 | src = l->data; | |
196 | if (src->key == SR_CONF_CONN) { | |
197 | conn = g_variant_get_string(src->data, NULL); | |
198 | break; | |
199 | } | |
200 | } | |
07a91752 | 201 | |
07a91752 LPC |
202 | ftdic = ftdi_new(); |
203 | if (!ftdic) { | |
204 | sr_err("Failed to initialize libftdi."); | |
205 | return NULL; | |
206 | } | |
207 | ||
cee6d3fa SA |
208 | if (conn) { |
209 | devices = NULL; | |
210 | libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); | |
211 | for (i = 0; devlist[i]; i++) { | |
212 | conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn); | |
213 | for (l = conn_devices; l; l = l->next) { | |
214 | usb = l->data; | |
215 | if (usb->bus == libusb_get_bus_number(devlist[i]) | |
216 | && usb->address == libusb_get_device_address(devlist[i])) { | |
15a5bfe4 | 217 | scan_device(ftdic, devlist[i], &devices); |
cee6d3fa SA |
218 | } |
219 | } | |
220 | } | |
221 | libusb_free_device_list(devlist, 1); | |
cee6d3fa | 222 | } else |
15a5bfe4 | 223 | devices = scan_all(ftdic, options); |
07a91752 LPC |
224 | |
225 | ftdi_free(ftdic); | |
226 | ||
15a5bfe4 | 227 | return std_scan_complete(di, devices); |
cee6d3fa SA |
228 | } |
229 | ||
8cd15dd4 | 230 | static void clear_helper(struct dev_context *devc) |
4f7fdcdd | 231 | { |
4f7fdcdd | 232 | g_free(devc->data_buf); |
4f7fdcdd SA |
233 | } |
234 | ||
235 | static int dev_clear(const struct sr_dev_driver *di) | |
236 | { | |
8cd15dd4 | 237 | return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper); |
4f7fdcdd SA |
238 | } |
239 | ||
240 | static int dev_open(struct sr_dev_inst *sdi) | |
241 | { | |
242 | struct dev_context *devc; | |
243 | int ret = SR_OK; | |
244 | ||
245 | devc = sdi->priv; | |
246 | ||
07a91752 LPC |
247 | devc->ftdic = ftdi_new(); |
248 | if (!devc->ftdic) | |
249 | return SR_ERR; | |
250 | ||
634d7299 | 251 | ret = ftdi_usb_open_string(devc->ftdic, sdi->connection_id); |
4f7fdcdd SA |
252 | if (ret < 0) { |
253 | /* Log errors, except for -3 ("device not found"). */ | |
254 | if (ret != -3) | |
255 | sr_err("Failed to open device (%d): %s", ret, | |
256 | ftdi_get_error_string(devc->ftdic)); | |
07a91752 | 257 | goto err_ftdi_free; |
4f7fdcdd SA |
258 | } |
259 | ||
4f7fdcdd SA |
260 | ret = ftdi_usb_purge_buffers(devc->ftdic); |
261 | if (ret < 0) { | |
262 | sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.", | |
263 | ret, ftdi_get_error_string(devc->ftdic)); | |
264 | goto err_dev_open_close_ftdic; | |
265 | } | |
4f7fdcdd | 266 | |
4f7fdcdd SA |
267 | ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_RESET); |
268 | if (ret < 0) { | |
269 | sr_err("Failed to reset the FTDI chip bitmode (%d): %s.", | |
270 | ret, ftdi_get_error_string(devc->ftdic)); | |
271 | goto err_dev_open_close_ftdic; | |
272 | } | |
4f7fdcdd SA |
273 | |
274 | ret = ftdi_set_bitmode(devc->ftdic, 0x00, BITMODE_BITBANG); | |
275 | if (ret < 0) { | |
276 | sr_err("Failed to put FTDI chip into bitbang mode (%d): %s.", | |
277 | ret, ftdi_get_error_string(devc->ftdic)); | |
278 | goto err_dev_open_close_ftdic; | |
279 | } | |
4f7fdcdd SA |
280 | |
281 | return SR_OK; | |
8cd15dd4 | 282 | |
4f7fdcdd SA |
283 | err_dev_open_close_ftdic: |
284 | ftdi_usb_close(devc->ftdic); | |
8cd15dd4 | 285 | |
07a91752 LPC |
286 | err_ftdi_free: |
287 | ftdi_free(devc->ftdic); | |
8cd15dd4 | 288 | |
4f7fdcdd SA |
289 | return SR_ERR; |
290 | } | |
291 | ||
292 | static int dev_close(struct sr_dev_inst *sdi) | |
293 | { | |
294 | struct dev_context *devc; | |
295 | ||
296 | devc = sdi->priv; | |
297 | ||
8cd15dd4 UH |
298 | if (!devc->ftdic) |
299 | return SR_ERR_BUG; | |
4f7fdcdd | 300 | |
8cd15dd4 UH |
301 | ftdi_usb_close(devc->ftdic); |
302 | ftdi_free(devc->ftdic); | |
303 | devc->ftdic = NULL; | |
4f7fdcdd SA |
304 | |
305 | return SR_OK; | |
306 | } | |
307 | ||
4f7fdcdd SA |
308 | static int config_get(uint32_t key, GVariant **data, |
309 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
310 | { | |
4f7fdcdd | 311 | struct dev_context *devc; |
cee6d3fa | 312 | struct sr_usb_dev_inst *usb; |
4f7fdcdd SA |
313 | |
314 | (void)cg; | |
315 | ||
316 | devc = sdi->priv; | |
317 | ||
4f7fdcdd SA |
318 | switch (key) { |
319 | case SR_CONF_SAMPLERATE: | |
320 | *data = g_variant_new_uint64(devc->cur_samplerate); | |
321 | break; | |
cee6d3fa SA |
322 | case SR_CONF_CONN: |
323 | if (!sdi || !sdi->conn) | |
324 | return SR_ERR_ARG; | |
325 | usb = sdi->conn; | |
8cd15dd4 | 326 | *data = g_variant_new_printf("%d.%d", usb->bus, usb->address); |
cee6d3fa | 327 | break; |
4f7fdcdd SA |
328 | default: |
329 | return SR_ERR_NA; | |
330 | } | |
331 | ||
8cd15dd4 | 332 | return SR_OK; |
4f7fdcdd SA |
333 | } |
334 | ||
4f7fdcdd SA |
335 | static int config_set(uint32_t key, GVariant *data, |
336 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
337 | { | |
4f7fdcdd SA |
338 | struct dev_context *devc; |
339 | uint64_t value; | |
340 | ||
341 | (void)cg; | |
342 | ||
4f7fdcdd SA |
343 | devc = sdi->priv; |
344 | ||
4f7fdcdd SA |
345 | switch (key) { |
346 | case SR_CONF_LIMIT_MSEC: | |
347 | value = g_variant_get_uint64(data); | |
348 | /* TODO: Implement. */ | |
8cd15dd4 UH |
349 | (void)value; |
350 | return SR_ERR_NA; | |
4f7fdcdd | 351 | case SR_CONF_LIMIT_SAMPLES: |
4f7fdcdd SA |
352 | devc->limit_samples = g_variant_get_uint64(data); |
353 | break; | |
354 | case SR_CONF_SAMPLERATE: | |
355 | value = g_variant_get_uint64(data); | |
356 | if (value < 3600) | |
357 | return SR_ERR_SAMPLERATE; | |
358 | devc->cur_samplerate = value; | |
f2273382 | 359 | return ftdi_la_set_samplerate(devc); |
4f7fdcdd | 360 | default: |
8cd15dd4 | 361 | return SR_ERR_NA; |
4f7fdcdd SA |
362 | } |
363 | ||
8cd15dd4 | 364 | return SR_OK; |
4f7fdcdd SA |
365 | } |
366 | ||
367 | static int config_list(uint32_t key, GVariant **data, | |
368 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
369 | { | |
4f7fdcdd SA |
370 | switch (key) { |
371 | case SR_CONF_SCAN_OPTIONS: | |
4f7fdcdd | 372 | case SR_CONF_DEVICE_OPTIONS: |
8cd15dd4 | 373 | return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts); |
4f7fdcdd | 374 | case SR_CONF_SAMPLERATE: |
8cd15dd4 | 375 | *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates)); |
4f7fdcdd SA |
376 | break; |
377 | default: | |
378 | return SR_ERR_NA; | |
379 | } | |
380 | ||
8cd15dd4 | 381 | return SR_OK; |
4f7fdcdd SA |
382 | } |
383 | ||
695dc859 | 384 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) |
4f7fdcdd SA |
385 | { |
386 | struct dev_context *devc; | |
387 | ||
4f7fdcdd SA |
388 | devc = sdi->priv; |
389 | ||
4f7fdcdd SA |
390 | if (!devc->ftdic) |
391 | return SR_ERR_BUG; | |
392 | ||
393 | ftdi_set_bitmode(devc->ftdic, 0, BITMODE_BITBANG); | |
394 | ||
4f7fdcdd SA |
395 | /* Properly reset internal variables before every new acquisition. */ |
396 | devc->samples_sent = 0; | |
397 | devc->bytes_received = 0; | |
398 | ||
bee2b016 | 399 | std_session_send_df_header(sdi); |
4f7fdcdd SA |
400 | |
401 | /* Hook up a dummy handler to receive data from the device. */ | |
402 | sr_session_source_add(sdi->session, -1, G_IO_IN, 0, | |
f2273382 | 403 | ftdi_la_receive_data, (void *)sdi); |
4f7fdcdd SA |
404 | |
405 | return SR_OK; | |
406 | } | |
407 | ||
695dc859 | 408 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) |
4f7fdcdd | 409 | { |
4f7fdcdd SA |
410 | sr_session_source_remove(sdi->session, -1); |
411 | ||
bee2b016 | 412 | std_session_send_df_end(sdi); |
4f7fdcdd SA |
413 | |
414 | return SR_OK; | |
415 | } | |
416 | ||
dd5c48a6 | 417 | static struct sr_dev_driver ftdi_la_driver_info = { |
f2273382 UH |
418 | .name = "ftdi-la", |
419 | .longname = "FTDI LA", | |
4f7fdcdd | 420 | .api_version = 1, |
c2fdcc25 | 421 | .init = std_init, |
700d6b64 | 422 | .cleanup = std_cleanup, |
4f7fdcdd | 423 | .scan = scan, |
c01bf34c | 424 | .dev_list = std_dev_list, |
4f7fdcdd SA |
425 | .dev_clear = dev_clear, |
426 | .config_get = config_get, | |
427 | .config_set = config_set, | |
428 | .config_list = config_list, | |
429 | .dev_open = dev_open, | |
430 | .dev_close = dev_close, | |
431 | .dev_acquisition_start = dev_acquisition_start, | |
432 | .dev_acquisition_stop = dev_acquisition_stop, | |
433 | .context = NULL, | |
434 | }; | |
dd5c48a6 | 435 | SR_REGISTER_DEV_DRIVER(ftdi_la_driver_info); |