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