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