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