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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
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 int32_t hwcaps[] = {
32 SR_CONF_LOGIC_ANALYZER,
35 SR_CONF_LIMIT_SAMPLES,
36 SR_CONF_CONTINUOUS, // TODO?
39 /* Channels are numbered 1-9. */
40 static const char *channel_names[] = {
41 "1", "2", "3", "4", "5", "6", "7", "8", "9",
45 /* Note: The IKALOGIC ScanaPLUS always samples at 100MHz. */
46 static uint64_t samplerates[1] = { SR_MHZ(100) };
48 SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
49 static struct sr_dev_driver *di = &ikalogic_scanaplus_driver_info;
51 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);
53 static void clear_helper(void *priv)
55 struct dev_context *devc;
59 ftdi_free(devc->ftdic);
60 g_free(devc->compressed_buf);
61 g_free(devc->sample_buf);
65 static int dev_clear(void)
67 return std_dev_clear(di, clear_helper);
70 static int init(struct sr_context *sr_ctx)
72 return std_init(sr_ctx, di, LOG_PREFIX);
75 static GSList *scan(GSList *options)
77 struct sr_dev_inst *sdi;
78 struct sr_channel *ch;
79 struct drv_context *drvc;
80 struct dev_context *devc;
91 /* Allocate memory for our private device context. */
92 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
93 sr_err("Device context malloc failed.");
94 goto err_free_nothing;
97 /* Allocate memory for the incoming compressed samples. */
98 if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
99 sr_err("compressed_buf malloc failed.");
103 /* Allocate memory for the uncompressed samples. */
104 if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
105 sr_err("sample_buf malloc failed.");
106 goto err_free_compressed_buf;
109 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
110 if (!(devc->ftdic = ftdi_new())) {
111 sr_err("Failed to initialize libftdi.");
112 goto err_free_sample_buf;
115 /* Check for the device and temporarily open it. */
116 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
119 /* Log errors, except for -3 ("device not found"). */
121 sr_err("Failed to open device (%d): %s", ret,
122 ftdi_get_error_string(devc->ftdic));
126 /* Register the device with libsigrok. */
127 sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
128 USB_VENDOR_NAME, USB_MODEL_NAME, NULL);
130 sr_err("Failed to create device instance.");
131 goto err_close_ftdic;
136 for (i = 0; channel_names[i]; i++) {
137 if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
140 sdi->channels = g_slist_append(sdi->channels, ch);
143 devices = g_slist_append(devices, sdi);
144 drvc->instances = g_slist_append(drvc->instances, sdi);
146 /* Close device. We'll reopen it again when we need it. */
147 scanaplus_close(devc);
152 scanaplus_close(devc);
154 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
156 g_free(devc->sample_buf);
157 err_free_compressed_buf:
158 g_free(devc->compressed_buf);
166 static GSList *dev_list(void)
168 return ((struct drv_context *)(di->priv))->instances;
171 static int dev_open(struct sr_dev_inst *sdi)
173 struct dev_context *devc;
178 /* Select interface A, otherwise communication will fail. */
179 ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
181 sr_err("Failed to set FTDI interface A (%d): %s", ret,
182 ftdi_get_error_string(devc->ftdic));
185 sr_dbg("FTDI chip interface A set successfully.");
187 /* Open the device. */
188 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
191 sr_err("Failed to open device (%d): %s", ret,
192 ftdi_get_error_string(devc->ftdic));
195 sr_dbg("FTDI device opened successfully.");
197 /* Purge RX/TX buffers in the FTDI chip. */
198 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
199 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
200 ret, ftdi_get_error_string(devc->ftdic));
201 goto err_dev_open_close_ftdic;
203 sr_dbg("FTDI chip buffers purged successfully.");
205 /* Reset the FTDI bitmode. */
206 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
208 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
209 ret, ftdi_get_error_string(devc->ftdic));
210 goto err_dev_open_close_ftdic;
212 sr_dbg("FTDI chip bitmode reset successfully.");
214 /* Set FTDI bitmode to "sync FIFO". */
215 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
217 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
218 ret, ftdi_get_error_string(devc->ftdic));
219 goto err_dev_open_close_ftdic;
221 sr_dbg("FTDI chip sync FIFO mode entered successfully.");
223 /* Set the FTDI latency timer to 2. */
224 ret = ftdi_set_latency_timer(devc->ftdic, 2);
226 sr_err("Failed to set FTDI latency timer (%d): %s.",
227 ret, ftdi_get_error_string(devc->ftdic));
228 goto err_dev_open_close_ftdic;
230 sr_dbg("FTDI chip latency timer set successfully.");
232 /* Set the FTDI read data chunk size to 64kB. */
233 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
235 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
236 ret, ftdi_get_error_string(devc->ftdic));
237 goto err_dev_open_close_ftdic;
239 sr_dbg("FTDI chip read data chunk size set successfully.");
241 /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
242 if ((ret = scanaplus_get_device_id(devc)) < 0) {
243 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
244 goto err_dev_open_close_ftdic;
246 sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
247 devc->devid[0], devc->devid[1], devc->devid[2]);
249 sdi->status = SR_ST_ACTIVE;
253 err_dev_open_close_ftdic:
254 scanaplus_close(devc);
258 static int dev_close(struct sr_dev_inst *sdi)
261 struct dev_context *devc;
266 if (sdi->status == SR_ST_ACTIVE) {
267 sr_dbg("Status ACTIVE, closing device.");
268 ret = scanaplus_close(devc);
270 sr_spew("Status not ACTIVE, nothing to do.");
273 sdi->status = SR_ST_INACTIVE;
278 static int cleanup(void)
283 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi,
284 const struct sr_channel_group *cg)
290 case SR_CONF_SAMPLERATE:
291 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
292 *data = g_variant_new_uint64(SR_MHZ(100));
301 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
302 const struct sr_channel_group *cg)
304 struct dev_context *devc;
308 if (sdi->status != SR_ST_ACTIVE)
309 return SR_ERR_DEV_CLOSED;
314 case SR_CONF_SAMPLERATE:
315 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
316 sr_err("ScanaPLUS only supports samplerate = 100MHz.");
319 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
321 case SR_CONF_LIMIT_MSEC:
322 if (g_variant_get_uint64(data) == 0)
324 devc->limit_msec = g_variant_get_uint64(data);
326 case SR_CONF_LIMIT_SAMPLES:
327 if (g_variant_get_uint64(data) == 0)
329 devc->limit_samples = g_variant_get_uint64(data);
338 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
339 const struct sr_channel_group *cg)
348 case SR_CONF_DEVICE_OPTIONS:
349 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
350 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
352 case SR_CONF_SAMPLERATE:
353 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
354 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
355 samplerates, ARRAY_SIZE(samplerates),
357 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
358 *data = g_variant_builder_end(&gvb);
367 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
370 struct dev_context *devc;
372 if (sdi->status != SR_ST_ACTIVE)
373 return SR_ERR_DEV_CLOSED;
375 if (!(devc = sdi->priv))
381 /* TODO: Configure channels later (thresholds etc.). */
383 devc->cb_data = cb_data;
385 /* Properly reset internal variables before every new acquisition. */
386 devc->compressed_bytes_ignored = 0;
387 devc->samples_sent = 0;
388 devc->bytes_received = 0;
390 if ((ret = scanaplus_init(devc)) < 0)
393 if ((ret = scanaplus_start_acquisition(devc)) < 0)
396 /* Send header packet to the session bus. */
397 std_session_send_df_header(sdi, LOG_PREFIX);
399 /* Hook up a dummy handler to receive data from the device. */
400 sr_session_source_add(sdi->session, -1, G_IO_IN, 0, scanaplus_receive_data, (void *)sdi);
405 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
407 struct sr_datafeed_packet packet;
411 sr_dbg("Stopping acquisition.");
412 sr_session_source_remove(sdi->session, -1);
414 /* Send end packet to the session bus. */
415 sr_dbg("Sending SR_DF_END.");
416 packet.type = SR_DF_END;
417 sr_session_send(sdi, &packet);
422 SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info = {
423 .name = "ikalogic-scanaplus",
424 .longname = "IKALOGIC ScanaPLUS",
429 .dev_list = dev_list,
430 .dev_clear = dev_clear,
431 .config_get = config_get,
432 .config_set = config_set,
433 .config_list = config_list,
434 .dev_open = dev_open,
435 .dev_close = dev_close,
436 .dev_acquisition_start = dev_acquisition_start,
437 .dev_acquisition_stop = dev_acquisition_stop,