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