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
24 #define USB_VENDOR_ID 0x0403
25 #define USB_DEVICE_ID 0x6014
26 #define USB_VENDOR_NAME "IKALOGIC"
27 #define USB_MODEL_NAME "ScanaPLUS"
28 #define USB_IPRODUCT "SCANAPLUS"
30 #define SAMPLE_BUF_SIZE (8 * 1024 * 1024)
32 static const uint32_t devopts[] = {
33 SR_CONF_LOGIC_ANALYZER,
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 /* Channels are numbered 1-9. */
40 static const char *channel_names[] = {
41 "1", "2", "3", "4", "5", "6", "7", "8", "9",
44 /* Note: The IKALOGIC ScanaPLUS always samples at 100MHz. */
45 static const uint64_t samplerates[1] = { SR_MHZ(100) };
47 SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
49 static int dev_acquisition_stop(struct sr_dev_inst *sdi);
51 static void clear_helper(void *priv)
53 struct dev_context *devc;
57 ftdi_free(devc->ftdic);
58 g_free(devc->compressed_buf);
59 g_free(devc->sample_buf);
63 static int dev_clear(const struct sr_dev_driver *di)
65 return std_dev_clear(di, clear_helper);
68 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
70 return std_init(sr_ctx, di, LOG_PREFIX);
73 static GSList *scan(struct sr_dev_driver *di, GSList *options)
75 struct sr_dev_inst *sdi;
76 struct drv_context *drvc;
77 struct dev_context *devc;
88 /* Allocate memory for our private device context. */
89 devc = g_malloc0(sizeof(struct dev_context));
91 /* Allocate memory for the incoming compressed samples. */
92 if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
93 sr_err("compressed_buf malloc failed.");
97 /* Allocate memory for the uncompressed samples. */
98 if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
99 sr_err("sample_buf malloc failed.");
100 goto err_free_compressed_buf;
103 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
104 if (!(devc->ftdic = ftdi_new())) {
105 sr_err("Failed to initialize libftdi.");
106 goto err_free_sample_buf;
109 /* Check for the device and temporarily open it. */
110 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
113 /* Log errors, except for -3 ("device not found"). */
115 sr_err("Failed to open device (%d): %s", ret,
116 ftdi_get_error_string(devc->ftdic));
120 /* Register the device with libsigrok. */
121 sdi = g_malloc0(sizeof(struct sr_dev_inst));
122 sdi->status = SR_ST_INITIALIZING;
123 sdi->vendor = g_strdup(USB_VENDOR_NAME);
124 sdi->model = g_strdup(USB_MODEL_NAME);
128 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
129 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
131 devices = g_slist_append(devices, sdi);
132 drvc->instances = g_slist_append(drvc->instances, sdi);
134 /* Close device. We'll reopen it again when we need it. */
135 scanaplus_close(devc);
139 scanaplus_close(devc);
141 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
143 g_free(devc->sample_buf);
144 err_free_compressed_buf:
145 g_free(devc->compressed_buf);
152 static GSList *dev_list(const struct sr_dev_driver *di)
154 return ((struct drv_context *)(di->context))->instances;
157 static int dev_open(struct sr_dev_inst *sdi)
159 struct dev_context *devc;
164 /* Select interface A, otherwise communication will fail. */
165 ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
167 sr_err("Failed to set FTDI interface A (%d): %s", ret,
168 ftdi_get_error_string(devc->ftdic));
171 sr_dbg("FTDI chip interface A set successfully.");
173 /* Open the device. */
174 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
177 sr_err("Failed to open device (%d): %s", ret,
178 ftdi_get_error_string(devc->ftdic));
181 sr_dbg("FTDI device opened successfully.");
183 /* Purge RX/TX buffers in the FTDI chip. */
184 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
185 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
186 ret, ftdi_get_error_string(devc->ftdic));
187 goto err_dev_open_close_ftdic;
189 sr_dbg("FTDI chip buffers purged successfully.");
191 /* Reset the FTDI bitmode. */
192 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
194 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
195 ret, ftdi_get_error_string(devc->ftdic));
196 goto err_dev_open_close_ftdic;
198 sr_dbg("FTDI chip bitmode reset successfully.");
200 /* Set FTDI bitmode to "sync FIFO". */
201 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
203 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
204 ret, ftdi_get_error_string(devc->ftdic));
205 goto err_dev_open_close_ftdic;
207 sr_dbg("FTDI chip sync FIFO mode entered successfully.");
209 /* Set the FTDI latency timer to 2. */
210 ret = ftdi_set_latency_timer(devc->ftdic, 2);
212 sr_err("Failed to set FTDI latency timer (%d): %s.",
213 ret, ftdi_get_error_string(devc->ftdic));
214 goto err_dev_open_close_ftdic;
216 sr_dbg("FTDI chip latency timer set successfully.");
218 /* Set the FTDI read data chunk size to 64kB. */
219 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
221 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
222 ret, ftdi_get_error_string(devc->ftdic));
223 goto err_dev_open_close_ftdic;
225 sr_dbg("FTDI chip read data chunk size set successfully.");
227 /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
228 if ((ret = scanaplus_get_device_id(devc)) < 0) {
229 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
230 goto err_dev_open_close_ftdic;
232 sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
233 devc->devid[0], devc->devid[1], devc->devid[2]);
235 sdi->status = SR_ST_ACTIVE;
239 err_dev_open_close_ftdic:
240 scanaplus_close(devc);
244 static int dev_close(struct sr_dev_inst *sdi)
247 struct dev_context *devc;
252 if (sdi->status == SR_ST_ACTIVE) {
253 sr_dbg("Status ACTIVE, closing device.");
254 ret = scanaplus_close(devc);
256 sr_spew("Status not ACTIVE, nothing to do.");
259 sdi->status = SR_ST_INACTIVE;
264 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
265 const struct sr_channel_group *cg)
271 case SR_CONF_SAMPLERATE:
272 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
273 *data = g_variant_new_uint64(SR_MHZ(100));
282 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
283 const struct sr_channel_group *cg)
285 struct dev_context *devc;
289 if (sdi->status != SR_ST_ACTIVE)
290 return SR_ERR_DEV_CLOSED;
295 case SR_CONF_SAMPLERATE:
296 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
297 sr_err("ScanaPLUS only supports samplerate = 100MHz.");
300 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
302 case SR_CONF_LIMIT_MSEC:
303 if (g_variant_get_uint64(data) == 0)
305 devc->limit_msec = g_variant_get_uint64(data);
307 case SR_CONF_LIMIT_SAMPLES:
308 if (g_variant_get_uint64(data) == 0)
310 devc->limit_samples = g_variant_get_uint64(data);
319 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
320 const struct sr_channel_group *cg)
329 case SR_CONF_DEVICE_OPTIONS:
330 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
331 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
333 case SR_CONF_SAMPLERATE:
334 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
335 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
336 samplerates, ARRAY_SIZE(samplerates),
338 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
339 *data = g_variant_builder_end(&gvb);
348 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
351 struct dev_context *devc;
353 if (sdi->status != SR_ST_ACTIVE)
354 return SR_ERR_DEV_CLOSED;
361 /* TODO: Configure channels later (thresholds etc.). */
363 /* Properly reset internal variables before every new acquisition. */
364 devc->compressed_bytes_ignored = 0;
365 devc->samples_sent = 0;
366 devc->bytes_received = 0;
368 if ((ret = scanaplus_init(devc)) < 0)
371 if ((ret = scanaplus_start_acquisition(devc)) < 0)
374 std_session_send_df_header(sdi, LOG_PREFIX);
376 /* Hook up a dummy handler to receive data from the device. */
377 sr_session_source_add(sdi->session, -1, 0, 0, scanaplus_receive_data, (void *)sdi);
382 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
384 sr_dbg("Stopping acquisition.");
385 sr_session_source_remove(sdi->session, -1);
386 std_session_send_df_end(sdi, LOG_PREFIX);
391 SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info = {
392 .name = "ikalogic-scanaplus",
393 .longname = "IKALOGIC ScanaPLUS",
396 .cleanup = std_cleanup,
398 .dev_list = dev_list,
399 .dev_clear = dev_clear,
400 .config_get = config_get,
401 .config_set = config_set,
402 .config_list = config_list,
403 .dev_open = dev_open,
404 .dev_close = dev_close,
405 .dev_acquisition_start = dev_acquisition_start,
406 .dev_acquisition_stop = dev_acquisition_stop,