2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
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 2 of the License, or
9 * (at your option) any later version.
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.
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/>.
23 #define USB_VENDOR_ID 0x0403
24 #define USB_DEVICE_ID 0x6014
25 #define USB_IPRODUCT "SCANAPLUS"
27 #define SAMPLE_BUF_SIZE (8 * 1024 * 1024)
29 static const uint32_t drvopts[] = {
30 SR_CONF_LOGIC_ANALYZER,
33 static const uint32_t devopts[] = {
34 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
35 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
36 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 static const char *channel_names[] = {
40 "1", "2", "3", "4", "5", "6", "7", "8", "9",
43 /* Note: The IKALOGIC ScanaPLUS always samples at 100MHz. */
44 static const uint64_t samplerates[1] = { SR_MHZ(100) };
46 static void clear_helper(struct dev_context *devc)
48 ftdi_free(devc->ftdic);
49 g_free(devc->compressed_buf);
50 g_free(devc->sample_buf);
53 static int dev_clear(const struct sr_dev_driver *di)
55 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
58 static GSList *scan(struct sr_dev_driver *di, GSList *options)
60 struct sr_dev_inst *sdi;
61 struct dev_context *devc;
67 devc = g_malloc0(sizeof(struct dev_context));
69 /* Allocate memory for the incoming compressed samples. */
70 if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
71 sr_err("compressed_buf malloc failed.");
75 /* Allocate memory for the uncompressed samples. */
76 if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
77 sr_err("sample_buf malloc failed.");
78 goto err_free_compressed_buf;
81 if (!(devc->ftdic = ftdi_new())) {
82 sr_err("Failed to initialize libftdi.");
83 goto err_free_sample_buf;
86 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
89 /* Log errors, except for -3 ("device not found"). */
91 sr_err("Failed to open device (%d): %s", ret,
92 ftdi_get_error_string(devc->ftdic));
96 sdi = g_malloc0(sizeof(struct sr_dev_inst));
97 sdi->status = SR_ST_INACTIVE;
98 sdi->vendor = g_strdup("IKALOGIC");
99 sdi->model = g_strdup("ScanaPLUS");
102 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
103 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
105 scanaplus_close(devc);
107 return std_scan_complete(di, g_slist_append(NULL, sdi));
109 scanaplus_close(devc);
111 ftdi_free(devc->ftdic);
113 g_free(devc->sample_buf);
114 err_free_compressed_buf:
115 g_free(devc->compressed_buf);
122 static int dev_open(struct sr_dev_inst *sdi)
124 struct dev_context *devc;
129 ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
131 sr_err("Failed to set FTDI interface A (%d): %s", ret,
132 ftdi_get_error_string(devc->ftdic));
136 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
139 sr_err("Failed to open device (%d): %s", ret,
140 ftdi_get_error_string(devc->ftdic));
144 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
145 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
146 ret, ftdi_get_error_string(devc->ftdic));
147 goto err_dev_open_close_ftdic;
150 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
152 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
153 ret, ftdi_get_error_string(devc->ftdic));
154 goto err_dev_open_close_ftdic;
157 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
159 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
160 ret, ftdi_get_error_string(devc->ftdic));
161 goto err_dev_open_close_ftdic;
164 ret = ftdi_set_latency_timer(devc->ftdic, 2);
166 sr_err("Failed to set FTDI latency timer (%d): %s.",
167 ret, ftdi_get_error_string(devc->ftdic));
168 goto err_dev_open_close_ftdic;
171 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
173 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
174 ret, ftdi_get_error_string(devc->ftdic));
175 goto err_dev_open_close_ftdic;
178 /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
179 if ((ret = scanaplus_get_device_id(devc)) < 0) {
180 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
181 goto err_dev_open_close_ftdic;
183 sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
184 devc->devid[0], devc->devid[1], devc->devid[2]);
188 err_dev_open_close_ftdic:
189 scanaplus_close(devc);
194 static int dev_close(struct sr_dev_inst *sdi)
196 struct dev_context *devc;
200 return scanaplus_close(devc);
203 static int config_get(uint32_t key, GVariant **data,
204 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
210 case SR_CONF_SAMPLERATE:
211 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
212 *data = g_variant_new_uint64(SR_MHZ(100));
221 static int config_set(uint32_t key, GVariant *data,
222 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
224 struct dev_context *devc;
231 case SR_CONF_SAMPLERATE:
232 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
233 sr_err("ScanaPLUS only supports samplerate = 100MHz.");
236 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
238 case SR_CONF_LIMIT_MSEC:
239 devc->limit_msec = g_variant_get_uint64(data);
241 case SR_CONF_LIMIT_SAMPLES:
242 devc->limit_samples = g_variant_get_uint64(data);
251 static int config_list(uint32_t key, GVariant **data,
252 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
255 case SR_CONF_DEVICE_OPTIONS:
256 return STD_CONFIG_LIST(key, data, sdi, cg, NO_OPTS, drvopts, devopts);
257 case SR_CONF_SAMPLERATE:
258 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
267 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
270 struct dev_context *devc;
277 /* TODO: Configure channels later (thresholds etc.). */
279 /* Properly reset internal variables before every new acquisition. */
280 devc->compressed_bytes_ignored = 0;
281 devc->samples_sent = 0;
282 devc->bytes_received = 0;
284 if ((ret = scanaplus_init(devc)) < 0)
287 if ((ret = scanaplus_start_acquisition(devc)) < 0)
290 std_session_send_df_header(sdi);
292 /* Hook up a dummy handler to receive data from the device. */
293 sr_session_source_add(sdi->session, -1, 0, 0, scanaplus_receive_data, (void *)sdi);
298 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
300 sr_session_source_remove(sdi->session, -1);
301 std_session_send_df_end(sdi);
306 static struct sr_dev_driver ikalogic_scanaplus_driver_info = {
307 .name = "ikalogic-scanaplus",
308 .longname = "IKALOGIC ScanaPLUS",
311 .cleanup = std_cleanup,
313 .dev_list = std_dev_list,
314 .dev_clear = dev_clear,
315 .config_get = config_get,
316 .config_set = config_set,
317 .config_list = config_list,
318 .dev_open = dev_open,
319 .dev_close = dev_close,
320 .dev_acquisition_start = dev_acquisition_start,
321 .dev_acquisition_stop = dev_acquisition_stop,
324 SR_REGISTER_DEV_DRIVER(ikalogic_scanaplus_driver_info);