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