]> sigrok.org Git - libsigrok.git/blame - src/hardware/ikalogic-scanaplus/api.c
sr_dev_close(): Factor out SR_ERR_DEV_CLOSED check.
[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 }
146 sr_dbg("FTDI chip interface A set successfully.");
147
148 /* Open the device. */
149 ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
150 USB_IPRODUCT, NULL);
151 if (ret < 0) {
152 sr_err("Failed to open device (%d): %s", ret,
153 ftdi_get_error_string(devc->ftdic));
154 return SR_ERR;
155 }
156 sr_dbg("FTDI device opened successfully.");
157
158 /* Purge RX/TX buffers in the FTDI chip. */
159 if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
160 sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
161 ret, ftdi_get_error_string(devc->ftdic));
162 goto err_dev_open_close_ftdic;
163 }
164 sr_dbg("FTDI chip buffers purged successfully.");
165
166 /* Reset the FTDI bitmode. */
167 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
168 if (ret < 0) {
169 sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
170 ret, ftdi_get_error_string(devc->ftdic));
171 goto err_dev_open_close_ftdic;
172 }
173 sr_dbg("FTDI chip bitmode reset successfully.");
174
175 /* Set FTDI bitmode to "sync FIFO". */
176 ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
177 if (ret < 0) {
178 sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
179 ret, ftdi_get_error_string(devc->ftdic));
180 goto err_dev_open_close_ftdic;
181 }
182 sr_dbg("FTDI chip sync FIFO mode entered successfully.");
183
184 /* Set the FTDI latency timer to 2. */
185 ret = ftdi_set_latency_timer(devc->ftdic, 2);
186 if (ret < 0) {
187 sr_err("Failed to set FTDI latency timer (%d): %s.",
188 ret, ftdi_get_error_string(devc->ftdic));
189 goto err_dev_open_close_ftdic;
190 }
191 sr_dbg("FTDI chip latency timer set successfully.");
192
193 /* Set the FTDI read data chunk size to 64kB. */
194 ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
195 if (ret < 0) {
196 sr_err("Failed to set FTDI read data chunk size (%d): %s.",
197 ret, ftdi_get_error_string(devc->ftdic));
198 goto err_dev_open_close_ftdic;
199 }
200 sr_dbg("FTDI chip read data chunk size set successfully.");
201
202 /* Get the ScanaPLUS device ID from the FTDI EEPROM. */
203 if ((ret = scanaplus_get_device_id(devc)) < 0) {
204 sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
205 goto err_dev_open_close_ftdic;
206 }
207 sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
208 devc->devid[0], devc->devid[1], devc->devid[2]);
fdf4a1f5
UH
209
210 sdi->status = SR_ST_ACTIVE;
211
212 return SR_OK;
ab4bb6eb
UH
213
214err_dev_open_close_ftdic:
215 scanaplus_close(devc);
216 return SR_ERR;
fdf4a1f5
UH
217}
218
219static int dev_close(struct sr_dev_inst *sdi)
220{
ab4bb6eb
UH
221 struct dev_context *devc;
222
ab4bb6eb
UH
223 devc = sdi->priv;
224
fdf4a1f5
UH
225 sdi->status = SR_ST_INACTIVE;
226
093e1cba 227 return scanaplus_close(devc);
fdf4a1f5
UH
228}
229
584560f1 230static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 231 const struct sr_channel_group *cg)
fdf4a1f5 232{
fdf4a1f5 233 (void)sdi;
53b4680f 234 (void)cg;
fdf4a1f5 235
584560f1 236 switch (key) {
ab4bb6eb
UH
237 case SR_CONF_SAMPLERATE:
238 /* The ScanaPLUS samplerate is 100MHz and can't be changed. */
239 *data = g_variant_new_uint64(SR_MHZ(100));
240 break;
fdf4a1f5
UH
241 default:
242 return SR_ERR_NA;
243 }
244
ab4bb6eb 245 return SR_OK;
fdf4a1f5
UH
246}
247
584560f1 248static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 249 const struct sr_channel_group *cg)
fdf4a1f5 250{
ab4bb6eb 251 struct dev_context *devc;
fdf4a1f5 252
53b4680f 253 (void)cg;
d3c74a6f 254
ab4bb6eb
UH
255 devc = sdi->priv;
256
584560f1 257 switch (key) {
ab4bb6eb
UH
258 case SR_CONF_SAMPLERATE:
259 if (g_variant_get_uint64(data) != SR_MHZ(100)) {
260 sr_err("ScanaPLUS only supports samplerate = 100MHz.");
261 return SR_ERR_ARG;
262 }
263 /* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
264 break;
265 case SR_CONF_LIMIT_MSEC:
266 if (g_variant_get_uint64(data) == 0)
267 return SR_ERR_ARG;
268 devc->limit_msec = g_variant_get_uint64(data);
269 break;
270 case SR_CONF_LIMIT_SAMPLES:
271 if (g_variant_get_uint64(data) == 0)
272 return SR_ERR_ARG;
273 devc->limit_samples = g_variant_get_uint64(data);
274 break;
fdf4a1f5 275 default:
ab4bb6eb 276 return SR_ERR_NA;
fdf4a1f5
UH
277 }
278
ab4bb6eb 279 return SR_OK;
fdf4a1f5
UH
280}
281
584560f1 282static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 283 const struct sr_channel_group *cg)
fdf4a1f5 284{
ab4bb6eb
UH
285 GVariant *gvar;
286 GVariantBuilder gvb;
fdf4a1f5
UH
287
288 (void)sdi;
53b4680f 289 (void)cg;
fdf4a1f5 290
fdf4a1f5 291 switch (key) {
ab4bb6eb 292 case SR_CONF_DEVICE_OPTIONS:
584560f1 293 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 294 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
ab4bb6eb
UH
295 break;
296 case SR_CONF_SAMPLERATE:
297 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
298 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
299 samplerates, ARRAY_SIZE(samplerates),
300 sizeof(uint64_t));
301 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
302 *data = g_variant_builder_end(&gvb);
303 break;
fdf4a1f5
UH
304 default:
305 return SR_ERR_NA;
306 }
307
ab4bb6eb 308 return SR_OK;
fdf4a1f5
UH
309}
310
695dc859 311static int dev_acquisition_start(const struct sr_dev_inst *sdi)
fdf4a1f5 312{
ab4bb6eb
UH
313 int ret;
314 struct dev_context *devc;
fdf4a1f5 315
208c1d35 316 devc = sdi->priv;
ab4bb6eb
UH
317
318 if (!devc->ftdic)
319 return SR_ERR_BUG;
320
ba7dd8bb 321 /* TODO: Configure channels later (thresholds etc.). */
ab4bb6eb 322
ab4bb6eb
UH
323 /* Properly reset internal variables before every new acquisition. */
324 devc->compressed_bytes_ignored = 0;
325 devc->samples_sent = 0;
326 devc->bytes_received = 0;
327
328 if ((ret = scanaplus_init(devc)) < 0)
329 return ret;
330
331 if ((ret = scanaplus_start_acquisition(devc)) < 0)
332 return ret;
333
bee2b016 334 std_session_send_df_header(sdi);
ab4bb6eb
UH
335
336 /* Hook up a dummy handler to receive data from the device. */
c650d3ec 337 sr_session_source_add(sdi->session, -1, 0, 0, scanaplus_receive_data, (void *)sdi);
ab4bb6eb 338
fdf4a1f5
UH
339 return SR_OK;
340}
341
695dc859 342static int dev_acquisition_stop(struct sr_dev_inst *sdi)
fdf4a1f5 343{
102f1239 344 sr_session_source_remove(sdi->session, -1);
bee2b016 345 std_session_send_df_end(sdi);
fdf4a1f5
UH
346
347 return SR_OK;
348}
349
dd5c48a6 350static struct sr_dev_driver ikalogic_scanaplus_driver_info = {
fdf4a1f5 351 .name = "ikalogic-scanaplus",
ce95428c 352 .longname = "IKALOGIC ScanaPLUS",
fdf4a1f5 353 .api_version = 1,
c2fdcc25 354 .init = std_init,
700d6b64 355 .cleanup = std_cleanup,
fdf4a1f5 356 .scan = scan,
c01bf34c 357 .dev_list = std_dev_list,
fdf4a1f5
UH
358 .dev_clear = dev_clear,
359 .config_get = config_get,
360 .config_set = config_set,
361 .config_list = config_list,
362 .dev_open = dev_open,
363 .dev_close = dev_close,
364 .dev_acquisition_start = dev_acquisition_start,
365 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 366 .context = NULL,
fdf4a1f5 367};
dd5c48a6 368SR_REGISTER_DEV_DRIVER(ikalogic_scanaplus_driver_info);