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 int dev_acquisition_stop(struct sr_dev_inst *sdi);
48 static void clear_helper(void *priv)
50 struct dev_context *devc;
54 ftdi_free(devc->ftdic);
55 g_free(devc->compressed_buf);
56 g_free(devc->sample_buf);
60 static int dev_clear(const struct sr_dev_driver *di)
62 return std_dev_clear(di, clear_helper);
65 static GSList *scan(struct sr_dev_driver *di, GSList *options)
67 struct sr_dev_inst *sdi;
68 struct dev_context *devc;
74 /* Allocate memory for our private device context. */
75 devc = g_malloc0(sizeof(struct dev_context));
77 /* Allocate memory for the incoming compressed samples. */
78 if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
79 sr_err("compressed_buf malloc failed.");
83 /* Allocate memory for the uncompressed samples. */
84 if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
85 sr_err("sample_buf malloc failed.");
86 goto err_free_compressed_buf;
89 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
90 if (!(devc->ftdic = ftdi_new())) {
91 sr_err("Failed to initialize libftdi.");
92 goto err_free_sample_buf;
95 /* Check for the device and temporarily open it. */
96 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
99 /* Log errors, except for -3 ("device not found"). */
101 sr_err("Failed to open device (%d): %s", ret,
102 ftdi_get_error_string(devc->ftdic));
106 /* Register the device with libsigrok. */
107 sdi = g_malloc0(sizeof(struct sr_dev_inst));
108 sdi->status = SR_ST_INACTIVE;
109 sdi->vendor = g_strdup(USB_VENDOR_NAME);
110 sdi->model = g_strdup(USB_MODEL_NAME);
113 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
114 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
116 /* Close device. We'll reopen it again when we need it. */
117 scanaplus_close(devc);
119 return std_scan_complete(di, g_slist_append(NULL, sdi));
121 scanaplus_close(devc);
123 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
125 g_free(devc->sample_buf);
126 err_free_compressed_buf:
127 g_free(devc->compressed_buf);
134 static int dev_open(struct sr_dev_inst *sdi)
136 struct dev_context *devc;
141 /* Select interface A, otherwise communication will fail. */
142 ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
144 sr_err("Failed to set FTDI interface A (%d): %s", ret,
145 ftdi_get_error_string(devc->ftdic));
148 sr_dbg("FTDI chip interface A set successfully.");
150 /* Open the device. */
151 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
154 sr_err("Failed to open device (%d): %s", ret,
155 ftdi_get_error_string(devc->ftdic));
158 sr_dbg("FTDI device opened successfully.");
160 /* Purge RX/TX buffers in the FTDI chip. */
161 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
162 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
163 ret, ftdi_get_error_string(devc->ftdic));
164 goto err_dev_open_close_ftdic;
166 sr_dbg("FTDI chip buffers purged successfully.");
168 /* Reset the FTDI bitmode. */
169 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
171 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
172 ret, ftdi_get_error_string(devc->ftdic));
173 goto err_dev_open_close_ftdic;
175 sr_dbg("FTDI chip bitmode reset successfully.");
177 /* Set FTDI bitmode to "sync FIFO". */
178 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
180 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
181 ret, ftdi_get_error_string(devc->ftdic));
182 goto err_dev_open_close_ftdic;
184 sr_dbg("FTDI chip sync FIFO mode entered successfully.");
186 /* Set the FTDI latency timer to 2. */
187 ret = ftdi_set_latency_timer(devc->ftdic, 2);
189 sr_err("Failed to set FTDI latency timer (%d): %s.",
190 ret, ftdi_get_error_string(devc->ftdic));
191 goto err_dev_open_close_ftdic;
193 sr_dbg("FTDI chip latency timer set successfully.");
195 /* Set the FTDI read data chunk size to 64kB. */
196 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
198 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
199 ret, ftdi_get_error_string(devc->ftdic));
200 goto err_dev_open_close_ftdic;
202 sr_dbg("FTDI chip read data chunk size set successfully.");
204 /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
205 if ((ret = scanaplus_get_device_id(devc)) < 0) {
206 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
207 goto err_dev_open_close_ftdic;
209 sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
210 devc->devid[0], devc->devid[1], devc->devid[2]);
212 sdi->status = SR_ST_ACTIVE;
216 err_dev_open_close_ftdic:
217 scanaplus_close(devc);
221 static int dev_close(struct sr_dev_inst *sdi)
224 struct dev_context *devc;
229 if (sdi->status == SR_ST_ACTIVE) {
230 sr_dbg("Status ACTIVE, closing device.");
231 ret = scanaplus_close(devc);
233 sr_spew("Status not ACTIVE, nothing to do.");
236 sdi->status = SR_ST_INACTIVE;
241 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
242 const struct sr_channel_group *cg)
248 case SR_CONF_SAMPLERATE:
249 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
250 *data = g_variant_new_uint64(SR_MHZ(100));
259 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
260 const struct sr_channel_group *cg)
262 struct dev_context *devc;
266 if (sdi->status != SR_ST_ACTIVE)
267 return SR_ERR_DEV_CLOSED;
272 case SR_CONF_SAMPLERATE:
273 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
274 sr_err("ScanaPLUS only supports samplerate = 100MHz.");
277 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
279 case SR_CONF_LIMIT_MSEC:
280 if (g_variant_get_uint64(data) == 0)
282 devc->limit_msec = g_variant_get_uint64(data);
284 case SR_CONF_LIMIT_SAMPLES:
285 if (g_variant_get_uint64(data) == 0)
287 devc->limit_samples = g_variant_get_uint64(data);
296 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
297 const struct sr_channel_group *cg)
306 case SR_CONF_DEVICE_OPTIONS:
307 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
308 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
310 case SR_CONF_SAMPLERATE:
311 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
312 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
313 samplerates, ARRAY_SIZE(samplerates),
315 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
316 *data = g_variant_builder_end(&gvb);
325 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
328 struct dev_context *devc;
330 if (sdi->status != SR_ST_ACTIVE)
331 return SR_ERR_DEV_CLOSED;
338 /* TODO: Configure channels later (thresholds etc.). */
340 /* Properly reset internal variables before every new acquisition. */
341 devc->compressed_bytes_ignored = 0;
342 devc->samples_sent = 0;
343 devc->bytes_received = 0;
345 if ((ret = scanaplus_init(devc)) < 0)
348 if ((ret = scanaplus_start_acquisition(devc)) < 0)
351 std_session_send_df_header(sdi);
353 /* Hook up a dummy handler to receive data from the device. */
354 sr_session_source_add(sdi->session, -1, 0, 0, scanaplus_receive_data, (void *)sdi);
359 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
361 sr_dbg("Stopping acquisition.");
362 sr_session_source_remove(sdi->session, -1);
363 std_session_send_df_end(sdi);
368 static struct sr_dev_driver ikalogic_scanaplus_driver_info = {
369 .name = "ikalogic-scanaplus",
370 .longname = "IKALOGIC ScanaPLUS",
373 .cleanup = std_cleanup,
375 .dev_list = std_dev_list,
376 .dev_clear = dev_clear,
377 .config_get = config_get,
378 .config_set = config_set,
379 .config_list = config_list,
380 .dev_open = dev_open,
381 .dev_close = dev_close,
382 .dev_acquisition_start = dev_acquisition_start,
383 .dev_acquisition_stop = dev_acquisition_stop,
386 SR_REGISTER_DEV_DRIVER(ikalogic_scanaplus_driver_info);