]> sigrok.org Git - libsigrok.git/blame - src/hardware/asix-sigma/api.c
Introduce standard cleanup helper
[libsigrok.git] / src / hardware / asix-sigma / api.c
CommitLineData
3ba56876 1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2010-2012 Håvard Espeland <gus@ping.uio.no>,
5 * Copyright (C) 2010 Martin Stensgård <mastensg@ping.uio.no>
6 * Copyright (C) 2010 Carl Henrik Lunde <chlunde@ping.uio.no>
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22/*
23 * ASIX SIGMA/SIGMA2 logic analyzer driver
24 */
25
26#include <config.h>
27#include "protocol.h"
28
29SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
30
31/*
32 * Channel numbers seem to go from 1-16, according to this image:
33 * http://tools.asix.net/img/sigma_sigmacab_pins_720.jpg
34 * (the cable has two additional GND pins, and a TI and TO pin)
35 */
36static const char *channel_names[] = {
37 "1", "2", "3", "4", "5", "6", "7", "8",
38 "9", "10", "11", "12", "13", "14", "15", "16",
39};
40
41static const uint32_t drvopts[] = {
42 SR_CONF_LOGIC_ANALYZER,
43};
44
45static const uint32_t devopts[] = {
46 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
47 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
48 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
49 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
50 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
51};
52
53static const int32_t trigger_matches[] = {
54 SR_TRIGGER_ZERO,
55 SR_TRIGGER_ONE,
56 SR_TRIGGER_RISING,
57 SR_TRIGGER_FALLING,
58};
59
60
61static int dev_clear(const struct sr_dev_driver *di)
62{
63 return std_dev_clear(di, sigma_clear_helper);
64}
65
66static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
67{
68 return std_init(sr_ctx, di, LOG_PREFIX);
69}
70
71static GSList *scan(struct sr_dev_driver *di, GSList *options)
72{
73 struct sr_dev_inst *sdi;
74 struct drv_context *drvc;
75 struct dev_context *devc;
76 GSList *devices;
77 struct ftdi_device_list *devlist;
78 char serial_txt[10];
79 uint32_t serial;
80 int ret;
81 unsigned int i;
82
83 (void)options;
84
85 drvc = di->context;
86
87 devices = NULL;
88
89 devc = g_malloc0(sizeof(struct dev_context));
90
91 ftdi_init(&devc->ftdic);
92
93 /* Look for SIGMAs. */
94
95 if ((ret = ftdi_usb_find_all(&devc->ftdic, &devlist,
96 USB_VENDOR, USB_PRODUCT)) <= 0) {
97 if (ret < 0)
98 sr_err("ftdi_usb_find_all(): %d", ret);
99 goto free;
100 }
101
102 /* Make sure it's a version 1 or 2 SIGMA. */
103 ftdi_usb_get_strings(&devc->ftdic, devlist->dev, NULL, 0, NULL, 0,
104 serial_txt, sizeof(serial_txt));
105 sscanf(serial_txt, "%x", &serial);
106
107 if (serial < 0xa6010000 || serial > 0xa602ffff) {
108 sr_err("Only SIGMA and SIGMA2 are supported "
109 "in this version of libsigrok.");
110 goto free;
111 }
112
113 sr_info("Found ASIX SIGMA - Serial: %s", serial_txt);
114
115 devc->cur_samplerate = samplerates[0];
116 devc->period_ps = 0;
117 devc->limit_msec = 0;
118 devc->cur_firmware = -1;
119 devc->num_channels = 0;
120 devc->samples_per_event = 0;
121 devc->capture_ratio = 50;
122 devc->use_triggers = 0;
123
124 /* Register SIGMA device. */
125 sdi = g_malloc0(sizeof(struct sr_dev_inst));
126 sdi->status = SR_ST_INITIALIZING;
127 sdi->vendor = g_strdup(USB_VENDOR_NAME);
128 sdi->model = g_strdup(USB_MODEL_NAME);
129 sdi->driver = di;
130
131 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
132 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
133
134 devices = g_slist_append(devices, sdi);
135 drvc->instances = g_slist_append(drvc->instances, sdi);
136 sdi->priv = devc;
137
138 /* We will open the device again when we need it. */
139 ftdi_list_free(&devlist);
140
141 return devices;
142
143free:
144 ftdi_deinit(&devc->ftdic);
145 g_free(devc);
146 return NULL;
147}
148
149static GSList *dev_list(const struct sr_dev_driver *di)
150{
151 return ((struct drv_context *)(di->context))->instances;
152}
153
154static int dev_open(struct sr_dev_inst *sdi)
155{
156 struct dev_context *devc;
157 int ret;
158
159 devc = sdi->priv;
160
161 /* Make sure it's an ASIX SIGMA. */
162 if ((ret = ftdi_usb_open_desc(&devc->ftdic,
163 USB_VENDOR, USB_PRODUCT, USB_DESCRIPTION, NULL)) < 0) {
164
165 sr_err("ftdi_usb_open failed: %s",
166 ftdi_get_error_string(&devc->ftdic));
167
168 return 0;
169 }
170
171 sdi->status = SR_ST_ACTIVE;
172
173 return SR_OK;
174}
175
176static int dev_close(struct sr_dev_inst *sdi)
177{
178 struct dev_context *devc;
179
180 devc = sdi->priv;
181
182 /* TODO */
183 if (sdi->status == SR_ST_ACTIVE)
184 ftdi_usb_close(&devc->ftdic);
185
186 sdi->status = SR_ST_INACTIVE;
187
188 return SR_OK;
189}
190
3ba56876 191static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
192 const struct sr_channel_group *cg)
193{
194 struct dev_context *devc;
195
196 (void)cg;
197
198 if (!sdi)
199 return SR_ERR;
200 devc = sdi->priv;
201
202 switch (key) {
203 case SR_CONF_SAMPLERATE:
204 *data = g_variant_new_uint64(devc->cur_samplerate);
205 break;
206 case SR_CONF_LIMIT_MSEC:
207 *data = g_variant_new_uint64(devc->limit_msec);
208 break;
209 case SR_CONF_CAPTURE_RATIO:
210 *data = g_variant_new_uint64(devc->capture_ratio);
211 break;
212 default:
213 return SR_ERR_NA;
214 }
215
216 return SR_OK;
217}
218
219static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
220 const struct sr_channel_group *cg)
221{
222 struct dev_context *devc;
223 uint64_t tmp;
224 int ret;
225
226 (void)cg;
227
228 if (sdi->status != SR_ST_ACTIVE)
229 return SR_ERR_DEV_CLOSED;
230
231 devc = sdi->priv;
232
233 ret = SR_OK;
234 switch (key) {
235 case SR_CONF_SAMPLERATE:
236 ret = sigma_set_samplerate(sdi, g_variant_get_uint64(data));
237 break;
238 case SR_CONF_LIMIT_MSEC:
239 tmp = g_variant_get_uint64(data);
240 if (tmp > 0)
241 devc->limit_msec = g_variant_get_uint64(data);
242 else
243 ret = SR_ERR;
244 break;
245 case SR_CONF_LIMIT_SAMPLES:
246 tmp = g_variant_get_uint64(data);
247 devc->limit_msec = tmp * 1000 / devc->cur_samplerate;
248 break;
249 case SR_CONF_CAPTURE_RATIO:
250 tmp = g_variant_get_uint64(data);
251 if (tmp <= 100)
252 devc->capture_ratio = tmp;
253 else
254 ret = SR_ERR;
255 break;
256 default:
257 ret = SR_ERR_NA;
258 }
259
260 return ret;
261}
262
263static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
264 const struct sr_channel_group *cg)
265{
266 GVariant *gvar;
267 GVariantBuilder gvb;
268
269 (void)cg;
270
271 switch (key) {
272 case SR_CONF_DEVICE_OPTIONS:
273 if (!sdi)
274 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
275 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
276 else
277 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
278 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
279 break;
280 case SR_CONF_SAMPLERATE:
281 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
282 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
283 SAMPLERATES_COUNT, sizeof(uint64_t));
284 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
285 *data = g_variant_builder_end(&gvb);
286 break;
287 case SR_CONF_TRIGGER_MATCH:
288 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
289 trigger_matches, ARRAY_SIZE(trigger_matches),
290 sizeof(int32_t));
291 break;
292 default:
293 return SR_ERR_NA;
294 }
295
296 return SR_OK;
297}
298
695dc859 299static int dev_acquisition_start(const struct sr_dev_inst *sdi)
3ba56876 300{
301 struct dev_context *devc;
302 struct clockselect_50 clockselect;
303 int frac, triggerpin, ret;
304 uint8_t triggerselect = 0;
305 struct triggerinout triggerinout_conf;
306 struct triggerlut lut;
307
308 if (sdi->status != SR_ST_ACTIVE)
309 return SR_ERR_DEV_CLOSED;
310
311 devc = sdi->priv;
312
313 if (sigma_convert_trigger(sdi) != SR_OK) {
314 sr_err("Failed to configure triggers.");
315 return SR_ERR;
316 }
317
318 /* If the samplerate has not been set, default to 200 kHz. */
319 if (devc->cur_firmware == -1) {
320 if ((ret = sigma_set_samplerate(sdi, SR_KHZ(200))) != SR_OK)
321 return ret;
322 }
323
324 /* Enter trigger programming mode. */
325 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x20, devc);
326
327 /* 100 and 200 MHz mode. */
328 if (devc->cur_samplerate >= SR_MHZ(100)) {
329 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x81, devc);
330
331 /* Find which pin to trigger on from mask. */
0a1f7b09 332 for (triggerpin = 0; triggerpin < 8; triggerpin++)
3ba56876 333 if ((devc->trigger.risingmask | devc->trigger.fallingmask) &
334 (1 << triggerpin))
335 break;
336
337 /* Set trigger pin and light LED on trigger. */
338 triggerselect = (1 << LEDSEL1) | (triggerpin & 0x7);
339
340 /* Default rising edge. */
341 if (devc->trigger.fallingmask)
342 triggerselect |= 1 << 3;
343
344 /* All other modes. */
345 } else if (devc->cur_samplerate <= SR_MHZ(50)) {
346 sigma_build_basic_trigger(&lut, devc);
347
348 sigma_write_trigger_lut(&lut, devc);
349
350 triggerselect = (1 << LEDSEL1) | (1 << LEDSEL0);
351 }
352
353 /* Setup trigger in and out pins to default values. */
354 memset(&triggerinout_conf, 0, sizeof(struct triggerinout));
355 triggerinout_conf.trgout_bytrigger = 1;
356 triggerinout_conf.trgout_enable = 1;
357
358 sigma_write_register(WRITE_TRIGGER_OPTION,
359 (uint8_t *) &triggerinout_conf,
360 sizeof(struct triggerinout), devc);
361
362 /* Go back to normal mode. */
363 sigma_set_register(WRITE_TRIGGER_SELECT1, triggerselect, devc);
364
365 /* Set clock select register. */
366 if (devc->cur_samplerate == SR_MHZ(200))
367 /* Enable 4 channels. */
368 sigma_set_register(WRITE_CLOCK_SELECT, 0xf0, devc);
369 else if (devc->cur_samplerate == SR_MHZ(100))
370 /* Enable 8 channels. */
371 sigma_set_register(WRITE_CLOCK_SELECT, 0x00, devc);
372 else {
373 /*
374 * 50 MHz mode (or fraction thereof). Any fraction down to
375 * 50 MHz / 256 can be used, but is not supported by sigrok API.
376 */
377 frac = SR_MHZ(50) / devc->cur_samplerate - 1;
378
379 clockselect.async = 0;
380 clockselect.fraction = frac;
381 clockselect.disabled_channels = 0;
382
383 sigma_write_register(WRITE_CLOCK_SELECT,
384 (uint8_t *) &clockselect,
385 sizeof(clockselect), devc);
386 }
387
388 /* Setup maximum post trigger time. */
389 sigma_set_register(WRITE_POST_TRIGGER,
390 (devc->capture_ratio * 255) / 100, devc);
391
392 /* Start acqusition. */
393 gettimeofday(&devc->start_tv, 0);
394 sigma_set_register(WRITE_MODE, 0x0d, devc);
395
3ba56876 396 std_session_send_df_header(sdi, LOG_PREFIX);
397
398 /* Add capture source. */
399 sr_session_source_add(sdi->session, -1, 0, 10, sigma_receive_data, (void *)sdi);
400
401 devc->state.state = SIGMA_CAPTURE;
402
403 return SR_OK;
404}
405
695dc859 406static int dev_acquisition_stop(struct sr_dev_inst *sdi)
3ba56876 407{
408 struct dev_context *devc;
409
3ba56876 410 devc = sdi->priv;
411 devc->state.state = SIGMA_IDLE;
412
413 sr_session_source_remove(sdi->session, -1);
414
415 return SR_OK;
416}
417
418SR_PRIV struct sr_dev_driver asix_sigma_driver_info = {
419 .name = "asix-sigma",
420 .longname = "ASIX SIGMA/SIGMA2",
421 .api_version = 1,
422 .init = init,
700d6b64 423 .cleanup = std_cleanup,
3ba56876 424 .scan = scan,
425 .dev_list = dev_list,
426 .dev_clear = dev_clear,
427 .config_get = config_get,
428 .config_set = config_set,
429 .config_list = config_list,
430 .dev_open = dev_open,
431 .dev_close = dev_close,
432 .dev_acquisition_start = dev_acquisition_start,
433 .dev_acquisition_stop = dev_acquisition_stop,
434 .context = NULL,
435};