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