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_VENDOR_NAME "IKALOGIC"
26 #define USB_MODEL_NAME "ScanaPLUS"
27 #define USB_IPRODUCT "SCANAPLUS"
29 #define SAMPLE_BUF_SIZE (8 * 1024 * 1024)
31 static const uint32_t devopts[] = {
32 SR_CONF_LOGIC_ANALYZER,
33 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
34 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
35 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38 /* Channels are numbered 1-9. */
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(void *priv)
48 struct dev_context *devc;
52 ftdi_free(devc->ftdic);
53 g_free(devc->compressed_buf);
54 g_free(devc->sample_buf);
58 static int dev_clear(const struct sr_dev_driver *di)
60 return std_dev_clear(di, clear_helper);
63 static GSList *scan(struct sr_dev_driver *di, GSList *options)
65 struct sr_dev_inst *sdi;
66 struct dev_context *devc;
72 /* Allocate memory for our private device context. */
73 devc = g_malloc0(sizeof(struct dev_context));
75 /* Allocate memory for the incoming compressed samples. */
76 if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
77 sr_err("compressed_buf malloc failed.");
81 /* Allocate memory for the uncompressed samples. */
82 if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
83 sr_err("sample_buf malloc failed.");
84 goto err_free_compressed_buf;
87 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
88 if (!(devc->ftdic = ftdi_new())) {
89 sr_err("Failed to initialize libftdi.");
90 goto err_free_sample_buf;
93 /* Check for the device and temporarily open it. */
94 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
97 /* Log errors, except for -3 ("device not found"). */
99 sr_err("Failed to open device (%d): %s", ret,
100 ftdi_get_error_string(devc->ftdic));
104 /* Register the device with libsigrok. */
105 sdi = g_malloc0(sizeof(struct sr_dev_inst));
106 sdi->status = SR_ST_INACTIVE;
107 sdi->vendor = g_strdup(USB_VENDOR_NAME);
108 sdi->model = g_strdup(USB_MODEL_NAME);
111 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
112 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
114 /* Close device. We'll reopen it again when we need it. */
115 scanaplus_close(devc);
117 return std_scan_complete(di, g_slist_append(NULL, sdi));
119 scanaplus_close(devc);
121 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
123 g_free(devc->sample_buf);
124 err_free_compressed_buf:
125 g_free(devc->compressed_buf);
132 static int dev_open(struct sr_dev_inst *sdi)
134 struct dev_context *devc;
139 /* Select interface A, otherwise communication will fail. */
140 ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
142 sr_err("Failed to set FTDI interface A (%d): %s", ret,
143 ftdi_get_error_string(devc->ftdic));
146 sr_dbg("FTDI chip interface A set successfully.");
148 /* Open the device. */
149 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
152 sr_err("Failed to open device (%d): %s", ret,
153 ftdi_get_error_string(devc->ftdic));
156 sr_dbg("FTDI device opened successfully.");
158 /* Purge RX/TX buffers in the FTDI chip. */
159 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
160 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
161 ret, ftdi_get_error_string(devc->ftdic));
162 goto err_dev_open_close_ftdic;
164 sr_dbg("FTDI chip buffers purged successfully.");
166 /* Reset the FTDI bitmode. */
167 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
169 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
170 ret, ftdi_get_error_string(devc->ftdic));
171 goto err_dev_open_close_ftdic;
173 sr_dbg("FTDI chip bitmode reset successfully.");
175 /* Set FTDI bitmode to "sync FIFO". */
176 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
178 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
179 ret, ftdi_get_error_string(devc->ftdic));
180 goto err_dev_open_close_ftdic;
182 sr_dbg("FTDI chip sync FIFO mode entered successfully.");
184 /* Set the FTDI latency timer to 2. */
185 ret = ftdi_set_latency_timer(devc->ftdic, 2);
187 sr_err("Failed to set FTDI latency timer (%d): %s.",
188 ret, ftdi_get_error_string(devc->ftdic));
189 goto err_dev_open_close_ftdic;
191 sr_dbg("FTDI chip latency timer set successfully.");
193 /* Set the FTDI read data chunk size to 64kB. */
194 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
196 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
197 ret, ftdi_get_error_string(devc->ftdic));
198 goto err_dev_open_close_ftdic;
200 sr_dbg("FTDI chip read data chunk size set successfully.");
202 /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
203 if ((ret = scanaplus_get_device_id(devc)) < 0) {
204 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
205 goto err_dev_open_close_ftdic;
207 sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
208 devc->devid[0], devc->devid[1], devc->devid[2]);
210 sdi->status = SR_ST_ACTIVE;
214 err_dev_open_close_ftdic:
215 scanaplus_close(devc);
219 static int dev_close(struct sr_dev_inst *sdi)
222 struct dev_context *devc;
227 if (sdi->status == SR_ST_ACTIVE) {
228 sr_dbg("Status ACTIVE, closing device.");
229 ret = scanaplus_close(devc);
231 sr_spew("Status not ACTIVE, nothing to do.");
234 sdi->status = SR_ST_INACTIVE;
239 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
240 const struct sr_channel_group *cg)
246 case SR_CONF_SAMPLERATE:
247 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
248 *data = g_variant_new_uint64(SR_MHZ(100));
257 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
258 const struct sr_channel_group *cg)
260 struct dev_context *devc;
264 if (sdi->status != SR_ST_ACTIVE)
265 return SR_ERR_DEV_CLOSED;
270 case SR_CONF_SAMPLERATE:
271 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
272 sr_err("ScanaPLUS only supports samplerate = 100MHz.");
275 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
277 case SR_CONF_LIMIT_MSEC:
278 if (g_variant_get_uint64(data) == 0)
280 devc->limit_msec = g_variant_get_uint64(data);
282 case SR_CONF_LIMIT_SAMPLES:
283 if (g_variant_get_uint64(data) == 0)
285 devc->limit_samples = g_variant_get_uint64(data);
294 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
295 const struct sr_channel_group *cg)
304 case SR_CONF_DEVICE_OPTIONS:
305 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
306 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
308 case SR_CONF_SAMPLERATE:
309 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
310 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
311 samplerates, ARRAY_SIZE(samplerates),
313 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
314 *data = g_variant_builder_end(&gvb);
323 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
326 struct dev_context *devc;
333 /* TODO: Configure channels later (thresholds etc.). */
335 /* Properly reset internal variables before every new acquisition. */
336 devc->compressed_bytes_ignored = 0;
337 devc->samples_sent = 0;
338 devc->bytes_received = 0;
340 if ((ret = scanaplus_init(devc)) < 0)
343 if ((ret = scanaplus_start_acquisition(devc)) < 0)
346 std_session_send_df_header(sdi);
348 /* Hook up a dummy handler to receive data from the device. */
349 sr_session_source_add(sdi->session, -1, 0, 0, scanaplus_receive_data, (void *)sdi);
354 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
356 sr_session_source_remove(sdi->session, -1);
357 std_session_send_df_end(sdi);
362 static struct sr_dev_driver ikalogic_scanaplus_driver_info = {
363 .name = "ikalogic-scanaplus",
364 .longname = "IKALOGIC ScanaPLUS",
367 .cleanup = std_cleanup,
369 .dev_list = std_dev_list,
370 .dev_clear = dev_clear,
371 .config_get = config_get,
372 .config_set = config_set,
373 .config_list = config_list,
374 .dev_open = dev_open,
375 .dev_close = dev_close,
376 .dev_acquisition_start = dev_acquisition_start,
377 .dev_acquisition_stop = dev_acquisition_stop,
380 SR_REGISTER_DEV_DRIVER(ikalogic_scanaplus_driver_info);