]> sigrok.org Git - libsigrok.git/blame - src/hardware/ikalogic-scanaplus/api.c
Add helper function for scan completion
[libsigrok.git] / src / hardware / ikalogic-scanaplus / api.c
CommitLineData
fdf4a1f5
UH
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
5 *
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.
10 *
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.
15 *
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
19 */
20
6ec6c43b 21#include <config.h>
fdf4a1f5
UH
22#include "protocol.h"
23
ab4bb6eb
UH
24#define USB_VENDOR_ID 0x0403
25#define USB_DEVICE_ID 0x6014
ce95428c 26#define USB_VENDOR_NAME "IKALOGIC"
ab4bb6eb
UH
27#define USB_MODEL_NAME "ScanaPLUS"
28#define USB_IPRODUCT "SCANAPLUS"
29
30#define SAMPLE_BUF_SIZE (8 * 1024 * 1024)
31
f254bc4b 32static const uint32_t devopts[] = {
ab4bb6eb 33 SR_CONF_LOGIC_ANALYZER,
5827f61b
BV
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,
ab4bb6eb
UH
37};
38
ba7dd8bb
UH
39/* Channels are numbered 1-9. */
40static const char *channel_names[] = {
ab4bb6eb 41 "1", "2", "3", "4", "5", "6", "7", "8", "9",
ab4bb6eb
UH
42};
43
ce95428c 44/* Note: The IKALOGIC ScanaPLUS always samples at 100MHz. */
329733d9 45static const uint64_t samplerates[1] = { SR_MHZ(100) };
ab4bb6eb 46
695dc859 47static int dev_acquisition_stop(struct sr_dev_inst *sdi);
ab4bb6eb
UH
48
49static void clear_helper(void *priv)
50{
51 struct dev_context *devc;
52
53 devc = priv;
54
55 ftdi_free(devc->ftdic);
56 g_free(devc->compressed_buf);
57 g_free(devc->sample_buf);
f817f05a 58 g_free(devc);
ab4bb6eb
UH
59}
60
4f840ce9 61static int dev_clear(const struct sr_dev_driver *di)
ab4bb6eb
UH
62{
63 return std_dev_clear(di, clear_helper);
64}
65
4f840ce9 66static GSList *scan(struct sr_dev_driver *di, GSList *options)
fdf4a1f5 67{
ab4bb6eb 68 struct sr_dev_inst *sdi;
fdf4a1f5 69 struct drv_context *drvc;
ab4bb6eb 70 struct dev_context *devc;
fdf4a1f5 71 GSList *devices;
ab4bb6eb
UH
72 unsigned int i;
73 int ret;
fdf4a1f5
UH
74
75 (void)options;
76
41812aca 77 drvc = di->context;
ab4bb6eb
UH
78
79 devices = NULL;
80
81 /* Allocate memory for our private device context. */
f57d8ffe 82 devc = g_malloc0(sizeof(struct dev_context));
ab4bb6eb
UH
83
84 /* Allocate memory for the incoming compressed samples. */
85 if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
86 sr_err("compressed_buf malloc failed.");
87 goto err_free_devc;
88 }
89
90 /* Allocate memory for the uncompressed samples. */
91 if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
92 sr_err("sample_buf malloc failed.");
93 goto err_free_compressed_buf;
94 }
95
96 /* Allocate memory for the FTDI context (ftdic) and initialize it. */
97 if (!(devc->ftdic = ftdi_new())) {
98 sr_err("Failed to initialize libftdi.");
99 goto err_free_sample_buf;
100 }
101
102 /* Check for the device and temporarily open it. */
103 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
104 USB_IPRODUCT, NULL);
105 if (ret < 0) {
106 /* Log errors, except for -3 ("device not found"). */
107 if (ret != -3)
108 sr_err("Failed to open device (%d): %s", ret,
109 ftdi_get_error_string(devc->ftdic));
110 goto err_free_ftdic;
111 }
112
113 /* Register the device with libsigrok. */
aac29cc1 114 sdi = g_malloc0(sizeof(struct sr_dev_inst));
45884333 115 sdi->status = SR_ST_INACTIVE;
0af636be
UH
116 sdi->vendor = g_strdup(USB_VENDOR_NAME);
117 sdi->model = g_strdup(USB_MODEL_NAME);
ab4bb6eb
UH
118 sdi->priv = devc;
119
0f34cb47
UH
120 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
121 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
ab4bb6eb
UH
122
123 devices = g_slist_append(devices, sdi);
ab4bb6eb
UH
124
125 /* Close device. We'll reopen it again when we need it. */
126 scanaplus_close(devc);
fdf4a1f5 127
15a5bfe4 128 return std_scan_complete(di, devices);
ab4bb6eb 129
ab4bb6eb
UH
130 scanaplus_close(devc);
131err_free_ftdic:
132 ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
133err_free_sample_buf:
134 g_free(devc->sample_buf);
135err_free_compressed_buf:
136 g_free(devc->compressed_buf);
137err_free_devc:
138 g_free(devc);
ab4bb6eb
UH
139
140 return NULL;
fdf4a1f5
UH
141}
142
fdf4a1f5
UH
143static int dev_open(struct sr_dev_inst *sdi)
144{
ab4bb6eb
UH
145 struct dev_context *devc;
146 int ret;
147
148 devc = sdi->priv;
149
150 /* Select interface A, otherwise communication will fail. */
151 ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
152 if (ret < 0) {
153 sr_err("Failed to set FTDI interface A (%d): %s", ret,
154 ftdi_get_error_string(devc->ftdic));
155 return SR_ERR;
156 }
157 sr_dbg("FTDI chip interface A set successfully.");
158
159 /* Open the device. */
160 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
161 USB_IPRODUCT, NULL);
162 if (ret < 0) {
163 sr_err("Failed to open device (%d): %s", ret,
164 ftdi_get_error_string(devc->ftdic));
165 return SR_ERR;
166 }
167 sr_dbg("FTDI device opened successfully.");
168
169 /* Purge RX/TX buffers in the FTDI chip. */
170 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
171 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
172 ret, ftdi_get_error_string(devc->ftdic));
173 goto err_dev_open_close_ftdic;
174 }
175 sr_dbg("FTDI chip buffers purged successfully.");
176
177 /* Reset the FTDI bitmode. */
178 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
179 if (ret < 0) {
180 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
181 ret, ftdi_get_error_string(devc->ftdic));
182 goto err_dev_open_close_ftdic;
183 }
184 sr_dbg("FTDI chip bitmode reset successfully.");
185
186 /* Set FTDI bitmode to "sync FIFO". */
187 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
188 if (ret < 0) {
189 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
190 ret, ftdi_get_error_string(devc->ftdic));
191 goto err_dev_open_close_ftdic;
192 }
193 sr_dbg("FTDI chip sync FIFO mode entered successfully.");
194
195 /* Set the FTDI latency timer to 2. */
196 ret = ftdi_set_latency_timer(devc->ftdic, 2);
197 if (ret < 0) {
198 sr_err("Failed to set FTDI latency timer (%d): %s.",
199 ret, ftdi_get_error_string(devc->ftdic));
200 goto err_dev_open_close_ftdic;
201 }
202 sr_dbg("FTDI chip latency timer set successfully.");
203
204 /* Set the FTDI read data chunk size to 64kB. */
205 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
206 if (ret < 0) {
207 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
208 ret, ftdi_get_error_string(devc->ftdic));
209 goto err_dev_open_close_ftdic;
210 }
211 sr_dbg("FTDI chip read data chunk size set successfully.");
212
213 /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
214 if ((ret = scanaplus_get_device_id(devc)) < 0) {
215 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
216 goto err_dev_open_close_ftdic;
217 }
218 sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
219 devc->devid[0], devc->devid[1], devc->devid[2]);
fdf4a1f5
UH
220
221 sdi->status = SR_ST_ACTIVE;
222
223 return SR_OK;
ab4bb6eb
UH
224
225err_dev_open_close_ftdic:
226 scanaplus_close(devc);
227 return SR_ERR;
fdf4a1f5
UH
228}
229
230static int dev_close(struct sr_dev_inst *sdi)
231{
ab4bb6eb
UH
232 int ret;
233 struct dev_context *devc;
234
235 ret = SR_OK;
236 devc = sdi->priv;
237
238 if (sdi->status == SR_ST_ACTIVE) {
239 sr_dbg("Status ACTIVE, closing device.");
240 ret = scanaplus_close(devc);
241 } else {
242 sr_spew("Status not ACTIVE, nothing to do.");
243 }
fdf4a1f5
UH
244
245 sdi->status = SR_ST_INACTIVE;
246
ab4bb6eb 247 return ret;
fdf4a1f5
UH
248}
249
584560f1 250static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 251 const struct sr_channel_group *cg)
fdf4a1f5 252{
fdf4a1f5 253 (void)sdi;
53b4680f 254 (void)cg;
fdf4a1f5 255
584560f1 256 switch (key) {
ab4bb6eb
UH
257 case SR_CONF_SAMPLERATE:
258 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
259 *data = g_variant_new_uint64(SR_MHZ(100));
260 break;
fdf4a1f5
UH
261 default:
262 return SR_ERR_NA;
263 }
264
ab4bb6eb 265 return SR_OK;
fdf4a1f5
UH
266}
267
584560f1 268static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 269 const struct sr_channel_group *cg)
fdf4a1f5 270{
ab4bb6eb 271 struct dev_context *devc;
fdf4a1f5 272
53b4680f 273 (void)cg;
d3c74a6f 274
fdf4a1f5
UH
275 if (sdi->status != SR_ST_ACTIVE)
276 return SR_ERR_DEV_CLOSED;
277
ab4bb6eb
UH
278 devc = sdi->priv;
279
584560f1 280 switch (key) {
ab4bb6eb
UH
281 case SR_CONF_SAMPLERATE:
282 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
283 sr_err("ScanaPLUS only supports samplerate = 100MHz.");
284 return SR_ERR_ARG;
285 }
286 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
287 break;
288 case SR_CONF_LIMIT_MSEC:
289 if (g_variant_get_uint64(data) == 0)
290 return SR_ERR_ARG;
291 devc->limit_msec = g_variant_get_uint64(data);
292 break;
293 case SR_CONF_LIMIT_SAMPLES:
294 if (g_variant_get_uint64(data) == 0)
295 return SR_ERR_ARG;
296 devc->limit_samples = g_variant_get_uint64(data);
297 break;
fdf4a1f5 298 default:
ab4bb6eb 299 return SR_ERR_NA;
fdf4a1f5
UH
300 }
301
ab4bb6eb 302 return SR_OK;
fdf4a1f5
UH
303}
304
584560f1 305static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 306 const struct sr_channel_group *cg)
fdf4a1f5 307{
ab4bb6eb
UH
308 GVariant *gvar;
309 GVariantBuilder gvb;
fdf4a1f5
UH
310
311 (void)sdi;
53b4680f 312 (void)cg;
fdf4a1f5 313
fdf4a1f5 314 switch (key) {
ab4bb6eb 315 case SR_CONF_DEVICE_OPTIONS:
584560f1 316 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 317 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
ab4bb6eb
UH
318 break;
319 case SR_CONF_SAMPLERATE:
320 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
321 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
322 samplerates, ARRAY_SIZE(samplerates),
323 sizeof(uint64_t));
324 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
325 *data = g_variant_builder_end(&gvb);
326 break;
fdf4a1f5
UH
327 default:
328 return SR_ERR_NA;
329 }
330
ab4bb6eb 331 return SR_OK;
fdf4a1f5
UH
332}
333
695dc859 334static int dev_acquisition_start(const struct sr_dev_inst *sdi)
fdf4a1f5 335{
ab4bb6eb
UH
336 int ret;
337 struct dev_context *devc;
fdf4a1f5
UH
338
339 if (sdi->status != SR_ST_ACTIVE)
340 return SR_ERR_DEV_CLOSED;
341
208c1d35 342 devc = sdi->priv;
ab4bb6eb
UH
343
344 if (!devc->ftdic)
345 return SR_ERR_BUG;
346
ba7dd8bb 347 /* TODO: Configure channels later (thresholds etc.). */
ab4bb6eb 348
ab4bb6eb
UH
349 /* Properly reset internal variables before every new acquisition. */
350 devc->compressed_bytes_ignored = 0;
351 devc->samples_sent = 0;
352 devc->bytes_received = 0;
353
354 if ((ret = scanaplus_init(devc)) < 0)
355 return ret;
356
357 if ((ret = scanaplus_start_acquisition(devc)) < 0)
358 return ret;
359
102f1239 360 std_session_send_df_header(sdi, LOG_PREFIX);
ab4bb6eb
UH
361
362 /* Hook up a dummy handler to receive data from the device. */
c650d3ec 363 sr_session_source_add(sdi->session, -1, 0, 0, scanaplus_receive_data, (void *)sdi);
ab4bb6eb 364
fdf4a1f5
UH
365 return SR_OK;
366}
367
695dc859 368static int dev_acquisition_stop(struct sr_dev_inst *sdi)
fdf4a1f5 369{
ab4bb6eb 370 sr_dbg("Stopping acquisition.");
102f1239 371 sr_session_source_remove(sdi->session, -1);
3be42bc2 372 std_session_send_df_end(sdi, LOG_PREFIX);
fdf4a1f5
UH
373
374 return SR_OK;
375}
376
dd5c48a6 377static struct sr_dev_driver ikalogic_scanaplus_driver_info = {
fdf4a1f5 378 .name = "ikalogic-scanaplus",
ce95428c 379 .longname = "IKALOGIC ScanaPLUS",
fdf4a1f5 380 .api_version = 1,
c2fdcc25 381 .init = std_init,
700d6b64 382 .cleanup = std_cleanup,
fdf4a1f5 383 .scan = scan,
c01bf34c 384 .dev_list = std_dev_list,
fdf4a1f5
UH
385 .dev_clear = dev_clear,
386 .config_get = config_get,
387 .config_set = config_set,
388 .config_list = config_list,
389 .dev_open = dev_open,
390 .dev_close = dev_close,
391 .dev_acquisition_start = dev_acquisition_start,
392 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 393 .context = NULL,
fdf4a1f5 394};
dd5c48a6 395SR_REGISTER_DEV_DRIVER(ikalogic_scanaplus_driver_info);