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