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 /* Probes are numbered 1-9. */
40 static const char *probe_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);
64 static int dev_clear(void)
66 return std_dev_clear(di, clear_helper);
69 static int init(struct sr_context *sr_ctx)
71 return std_init(sr_ctx, di, LOG_PREFIX);
74 static GSList *scan(GSList *options)
76 struct sr_dev_inst *sdi;
77 struct sr_probe *probe;
78 struct drv_context *drvc;
79 struct dev_context *devc;
90 /* Allocate memory for our private device context. */
91 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
92 sr_err("Device context malloc failed.");
93 goto err_free_nothing;
96 /* Allocate memory for the incoming compressed samples. */
97 if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
98 sr_err("compressed_buf malloc failed.");
102 /* Allocate memory for the uncompressed samples. */
103 if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
104 sr_err("sample_buf malloc failed.");
105 goto err_free_compressed_buf;
108 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
109 if (!(devc->ftdic = ftdi_new())) {
110 sr_err("Failed to initialize libftdi.");
111 goto err_free_sample_buf;
114 /* Check for the device and temporarily open it. */
115 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
118 /* Log errors, except for -3 ("device not found"). */
120 sr_err("Failed to open device (%d): %s", ret,
121 ftdi_get_error_string(devc->ftdic));
125 /* Register the device with libsigrok. */
126 sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
127 USB_VENDOR_NAME, USB_MODEL_NAME, NULL);
129 sr_err("Failed to create device instance.");
130 goto err_close_ftdic;
135 for (i = 0; probe_names[i]; i++) {
136 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
139 sdi->probes = g_slist_append(sdi->probes, probe);
142 devices = g_slist_append(devices, sdi);
143 drvc->instances = g_slist_append(drvc->instances, sdi);
145 /* Close device. We'll reopen it again when we need it. */
146 scanaplus_close(devc);
151 scanaplus_close(devc);
153 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
155 g_free(devc->sample_buf);
156 err_free_compressed_buf:
157 g_free(devc->compressed_buf);
165 static GSList *dev_list(void)
167 return ((struct drv_context *)(di->priv))->instances;
170 static int dev_open(struct sr_dev_inst *sdi)
172 struct dev_context *devc;
177 /* Select interface A, otherwise communication will fail. */
178 ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
180 sr_err("Failed to set FTDI interface A (%d): %s", ret,
181 ftdi_get_error_string(devc->ftdic));
184 sr_dbg("FTDI chip interface A set successfully.");
186 /* Open the device. */
187 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
190 sr_err("Failed to open device (%d): %s", ret,
191 ftdi_get_error_string(devc->ftdic));
194 sr_dbg("FTDI device opened successfully.");
196 /* Purge RX/TX buffers in the FTDI chip. */
197 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
198 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
199 ret, ftdi_get_error_string(devc->ftdic));
200 goto err_dev_open_close_ftdic;
202 sr_dbg("FTDI chip buffers purged successfully.");
204 /* Reset the FTDI bitmode. */
205 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
207 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
208 ret, ftdi_get_error_string(devc->ftdic));
209 goto err_dev_open_close_ftdic;
211 sr_dbg("FTDI chip bitmode reset successfully.");
213 /* Set FTDI bitmode to "sync FIFO". */
214 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
216 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
217 ret, ftdi_get_error_string(devc->ftdic));
218 goto err_dev_open_close_ftdic;
220 sr_dbg("FTDI chip sync FIFO mode entered successfully.");
222 /* Set the FTDI latency timer to 2. */
223 ret = ftdi_set_latency_timer(devc->ftdic, 2);
225 sr_err("Failed to set FTDI latency timer (%d): %s.",
226 ret, ftdi_get_error_string(devc->ftdic));
227 goto err_dev_open_close_ftdic;
229 sr_dbg("FTDI chip latency timer set successfully.");
231 /* Set the FTDI read data chunk size to 64kB. */
232 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
234 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
235 ret, ftdi_get_error_string(devc->ftdic));
236 goto err_dev_open_close_ftdic;
238 sr_dbg("FTDI chip read data chunk size set successfully.");
240 /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
241 if ((ret = scanaplus_get_device_id(devc)) < 0) {
242 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
243 goto err_dev_open_close_ftdic;
245 sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
246 devc->devid[0], devc->devid[1], devc->devid[2]);
248 sdi->status = SR_ST_ACTIVE;
252 err_dev_open_close_ftdic:
253 scanaplus_close(devc);
257 static int dev_close(struct sr_dev_inst *sdi)
260 struct dev_context *devc;
265 if (sdi->status == SR_ST_ACTIVE) {
266 sr_dbg("Status ACTIVE, closing device.");
267 ret = scanaplus_close(devc);
269 sr_spew("Status not ACTIVE, nothing to do.");
272 sdi->status = SR_ST_INACTIVE;
277 static int cleanup(void)
282 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
287 case SR_CONF_SAMPLERATE:
288 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
289 *data = g_variant_new_uint64(SR_MHZ(100));
298 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
300 struct dev_context *devc;
302 if (sdi->status != SR_ST_ACTIVE)
303 return SR_ERR_DEV_CLOSED;
308 case SR_CONF_SAMPLERATE:
309 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
310 sr_err("ScanaPLUS only supports samplerate = 100MHz.");
313 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
315 case SR_CONF_LIMIT_MSEC:
316 if (g_variant_get_uint64(data) == 0)
318 devc->limit_msec = g_variant_get_uint64(data);
320 case SR_CONF_LIMIT_SAMPLES:
321 if (g_variant_get_uint64(data) == 0)
323 devc->limit_samples = g_variant_get_uint64(data);
332 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
340 case SR_CONF_DEVICE_OPTIONS:
341 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
342 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
344 case SR_CONF_SAMPLERATE:
345 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
346 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
347 samplerates, ARRAY_SIZE(samplerates),
349 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
350 *data = g_variant_builder_end(&gvb);
359 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
362 struct dev_context *devc;
364 if (sdi->status != SR_ST_ACTIVE)
365 return SR_ERR_DEV_CLOSED;
367 if (!(devc = sdi->priv))
373 /* TODO: Configure probes later (thresholds etc.). */
375 devc->cb_data = cb_data;
377 /* Properly reset internal variables before every new acquisition. */
378 devc->compressed_bytes_ignored = 0;
379 devc->samples_sent = 0;
380 devc->bytes_received = 0;
382 if ((ret = scanaplus_init(devc)) < 0)
385 if ((ret = scanaplus_start_acquisition(devc)) < 0)
388 /* Send header packet to the session bus. */
389 std_session_send_df_header(cb_data, LOG_PREFIX);
391 /* Hook up a dummy handler to receive data from the device. */
392 sr_source_add(-1, G_IO_IN, 0, scanaplus_receive_data, (void *)sdi);
397 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
399 struct sr_datafeed_packet packet;
403 sr_dbg("Stopping acquisition.");
404 sr_source_remove(-1);
406 /* Send end packet to the session bus. */
407 sr_dbg("Sending SR_DF_END.");
408 packet.type = SR_DF_END;
409 sr_session_send(cb_data, &packet);
414 SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info = {
415 .name = "ikalogic-scanaplus",
416 .longname = "Ikalogic ScanaPLUS",
421 .dev_list = dev_list,
422 .dev_clear = dev_clear,
423 .config_get = config_get,
424 .config_set = config_set,
425 .config_list = config_list,
426 .dev_open = dev_open,
427 .dev_close = dev_close,
428 .dev_acquisition_start = dev_acquisition_start,
429 .dev_acquisition_stop = dev_acquisition_stop,