]> sigrok.org Git - libsigrok.git/blame - src/hardware/asix-sigma/api.c
clear_helper(): Use a cast to shorten all implementations.
[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
3ba56876 29/*
30 * Channel numbers seem to go from 1-16, according to this image:
31 * http://tools.asix.net/img/sigma_sigmacab_pins_720.jpg
32 * (the cable has two additional GND pins, and a TI and TO pin)
33 */
34static const char *channel_names[] = {
35 "1", "2", "3", "4", "5", "6", "7", "8",
36 "9", "10", "11", "12", "13", "14", "15", "16",
37};
38
39static const uint32_t drvopts[] = {
40 SR_CONF_LOGIC_ANALYZER,
41};
42
43static const uint32_t devopts[] = {
44 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
2f7e529c 45 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
3ba56876 46 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
de3f7acb 47#if ASIX_SIGMA_WITH_TRIGGER
3ba56876 48 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
49 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
de3f7acb 50#endif
3ba56876 51};
52
eac48b34 53#if ASIX_SIGMA_WITH_TRIGGER
3ba56876 54static const int32_t trigger_matches[] = {
55 SR_TRIGGER_ZERO,
56 SR_TRIGGER_ONE,
57 SR_TRIGGER_RISING,
58 SR_TRIGGER_FALLING,
59};
eac48b34 60#endif
3ba56876 61
3553451f 62static void clear_helper(struct dev_context *devc)
53279f13 63{
53279f13
UH
64 ftdi_deinit(&devc->ftdic);
65}
66
3ba56876 67static int dev_clear(const struct sr_dev_driver *di)
68{
3553451f 69 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
3ba56876 70}
71
3ba56876 72static GSList *scan(struct sr_dev_driver *di, GSList *options)
73{
74 struct sr_dev_inst *sdi;
3ba56876 75 struct dev_context *devc;
3ba56876 76 struct ftdi_device_list *devlist;
77 char serial_txt[10];
78 uint32_t serial;
79 int ret;
80 unsigned int i;
81
82 (void)options;
83
3ba56876 84 devc = g_malloc0(sizeof(struct dev_context));
85
86 ftdi_init(&devc->ftdic);
87
88 /* Look for SIGMAs. */
89
90 if ((ret = ftdi_usb_find_all(&devc->ftdic, &devlist,
91 USB_VENDOR, USB_PRODUCT)) <= 0) {
92 if (ret < 0)
93 sr_err("ftdi_usb_find_all(): %d", ret);
94 goto free;
95 }
96
97 /* Make sure it's a version 1 or 2 SIGMA. */
98 ftdi_usb_get_strings(&devc->ftdic, devlist->dev, NULL, 0, NULL, 0,
99 serial_txt, sizeof(serial_txt));
100 sscanf(serial_txt, "%x", &serial);
101
102 if (serial < 0xa6010000 || serial > 0xa602ffff) {
103 sr_err("Only SIGMA and SIGMA2 are supported "
104 "in this version of libsigrok.");
105 goto free;
106 }
107
108 sr_info("Found ASIX SIGMA - Serial: %s", serial_txt);
109
110 devc->cur_samplerate = samplerates[0];
3ba56876 111 devc->limit_msec = 0;
2f7e529c 112 devc->limit_samples = 0;
3ba56876 113 devc->cur_firmware = -1;
114 devc->num_channels = 0;
115 devc->samples_per_event = 0;
116 devc->capture_ratio = 50;
117 devc->use_triggers = 0;
118
119 /* Register SIGMA device. */
120 sdi = g_malloc0(sizeof(struct sr_dev_inst));
121 sdi->status = SR_ST_INITIALIZING;
122 sdi->vendor = g_strdup(USB_VENDOR_NAME);
123 sdi->model = g_strdup(USB_MODEL_NAME);
3ba56876 124
125 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
126 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
127
3ba56876 128 sdi->priv = devc;
129
130 /* We will open the device again when we need it. */
131 ftdi_list_free(&devlist);
132
43376f33 133 return std_scan_complete(di, g_slist_append(NULL, sdi));
3ba56876 134
135free:
136 ftdi_deinit(&devc->ftdic);
137 g_free(devc);
138 return NULL;
139}
140
3ba56876 141static int dev_open(struct sr_dev_inst *sdi)
142{
143 struct dev_context *devc;
144 int ret;
145
146 devc = sdi->priv;
147
3ba56876 148 if ((ret = ftdi_usb_open_desc(&devc->ftdic,
7e463623
UH
149 USB_VENDOR, USB_PRODUCT, USB_DESCRIPTION, NULL)) < 0) {
150 sr_err("Failed to open device (%d): %s.",
151 ret, ftdi_get_error_string(&devc->ftdic));
152 return SR_ERR;
3ba56876 153 }
154
3ba56876 155 return SR_OK;
156}
157
158static int dev_close(struct sr_dev_inst *sdi)
159{
160 struct dev_context *devc;
161
162 devc = sdi->priv;
163
f1ba6b4b 164 return (ftdi_usb_close(&devc->ftdic) == 0) ? SR_OK : SR_ERR;
3ba56876 165}
166
3ba56876 167static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
168 const struct sr_channel_group *cg)
169{
170 struct dev_context *devc;
171
172 (void)cg;
173
174 if (!sdi)
175 return SR_ERR;
176 devc = sdi->priv;
177
178 switch (key) {
179 case SR_CONF_SAMPLERATE:
180 *data = g_variant_new_uint64(devc->cur_samplerate);
181 break;
182 case SR_CONF_LIMIT_MSEC:
183 *data = g_variant_new_uint64(devc->limit_msec);
184 break;
2f7e529c
GS
185 case SR_CONF_LIMIT_SAMPLES:
186 *data = g_variant_new_uint64(devc->limit_samples);
187 break;
de3f7acb 188#if ASIX_SIGMA_WITH_TRIGGER
3ba56876 189 case SR_CONF_CAPTURE_RATIO:
190 *data = g_variant_new_uint64(devc->capture_ratio);
191 break;
de3f7acb 192#endif
3ba56876 193 default:
194 return SR_ERR_NA;
195 }
196
197 return SR_OK;
198}
199
200static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
201 const struct sr_channel_group *cg)
202{
203 struct dev_context *devc;
204 uint64_t tmp;
205 int ret;
206
207 (void)cg;
208
3ba56876 209 devc = sdi->priv;
210
211 ret = SR_OK;
212 switch (key) {
213 case SR_CONF_SAMPLERATE:
214 ret = sigma_set_samplerate(sdi, g_variant_get_uint64(data));
215 break;
216 case SR_CONF_LIMIT_MSEC:
217 tmp = g_variant_get_uint64(data);
218 if (tmp > 0)
219 devc->limit_msec = g_variant_get_uint64(data);
220 else
221 ret = SR_ERR;
222 break;
223 case SR_CONF_LIMIT_SAMPLES:
224 tmp = g_variant_get_uint64(data);
2f7e529c 225 devc->limit_samples = tmp;
9a0a606a 226 devc->limit_msec = sigma_limit_samples_to_msec(devc, tmp);
3ba56876 227 break;
de3f7acb 228#if ASIX_SIGMA_WITH_TRIGGER
3ba56876 229 case SR_CONF_CAPTURE_RATIO:
230 tmp = g_variant_get_uint64(data);
de3f7acb
GS
231 if (tmp > 100)
232 return SR_ERR;
233 devc->capture_ratio = tmp;
3ba56876 234 break;
de3f7acb 235#endif
3ba56876 236 default:
237 ret = SR_ERR_NA;
238 }
239
240 return ret;
241}
242
243static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
244 const struct sr_channel_group *cg)
245{
246 GVariant *gvar;
247 GVariantBuilder gvb;
248
249 (void)cg;
250
251 switch (key) {
252 case SR_CONF_DEVICE_OPTIONS:
253 if (!sdi)
254 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
255 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
256 else
257 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
258 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
259 break;
260 case SR_CONF_SAMPLERATE:
261 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
262 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
4154a516 263 samplerates_count, sizeof(samplerates[0]));
3ba56876 264 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
265 *data = g_variant_builder_end(&gvb);
266 break;
de3f7acb 267#if ASIX_SIGMA_WITH_TRIGGER
3ba56876 268 case SR_CONF_TRIGGER_MATCH:
269 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
270 trigger_matches, ARRAY_SIZE(trigger_matches),
271 sizeof(int32_t));
272 break;
de3f7acb 273#endif
3ba56876 274 default:
275 return SR_ERR_NA;
276 }
277
278 return SR_OK;
279}
280
695dc859 281static int dev_acquisition_start(const struct sr_dev_inst *sdi)
3ba56876 282{
283 struct dev_context *devc;
284 struct clockselect_50 clockselect;
8256ed15 285 int triggerpin, ret;
f06fb3e9 286 uint8_t triggerselect;
3ba56876 287 struct triggerinout triggerinout_conf;
288 struct triggerlut lut;
22f64ed8 289 uint8_t regval;
8256ed15
GS
290 uint8_t clock_bytes[sizeof(clockselect)];
291 size_t clock_idx;
3ba56876 292
3ba56876 293 devc = sdi->priv;
294
295 if (sigma_convert_trigger(sdi) != SR_OK) {
296 sr_err("Failed to configure triggers.");
297 return SR_ERR;
298 }
299
300 /* If the samplerate has not been set, default to 200 kHz. */
301 if (devc->cur_firmware == -1) {
302 if ((ret = sigma_set_samplerate(sdi, SR_KHZ(200))) != SR_OK)
303 return ret;
304 }
305
306 /* Enter trigger programming mode. */
307 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x20, devc);
308
f06fb3e9 309 triggerselect = 0;
3ba56876 310 if (devc->cur_samplerate >= SR_MHZ(100)) {
f06fb3e9 311 /* 100 and 200 MHz mode. */
3ba56876 312 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x81, devc);
313
314 /* Find which pin to trigger on from mask. */
0a1f7b09 315 for (triggerpin = 0; triggerpin < 8; triggerpin++)
3ba56876 316 if ((devc->trigger.risingmask | devc->trigger.fallingmask) &
317 (1 << triggerpin))
318 break;
319
320 /* Set trigger pin and light LED on trigger. */
321 triggerselect = (1 << LEDSEL1) | (triggerpin & 0x7);
322
323 /* Default rising edge. */
324 if (devc->trigger.fallingmask)
325 triggerselect |= 1 << 3;
326
3ba56876 327 } else if (devc->cur_samplerate <= SR_MHZ(50)) {
f06fb3e9 328 /* All other modes. */
3ba56876 329 sigma_build_basic_trigger(&lut, devc);
330
331 sigma_write_trigger_lut(&lut, devc);
332
333 triggerselect = (1 << LEDSEL1) | (1 << LEDSEL0);
334 }
335
336 /* Setup trigger in and out pins to default values. */
337 memset(&triggerinout_conf, 0, sizeof(struct triggerinout));
338 triggerinout_conf.trgout_bytrigger = 1;
339 triggerinout_conf.trgout_enable = 1;
340
341 sigma_write_register(WRITE_TRIGGER_OPTION,
342 (uint8_t *) &triggerinout_conf,
343 sizeof(struct triggerinout), devc);
344
345 /* Go back to normal mode. */
346 sigma_set_register(WRITE_TRIGGER_SELECT1, triggerselect, devc);
347
348 /* Set clock select register. */
8256ed15
GS
349 clockselect.async = 0;
350 clockselect.fraction = 1 - 1; /* Divider 1. */
351 clockselect.disabled_channels = 0x0000; /* All channels enabled. */
352 if (devc->cur_samplerate == SR_MHZ(200)) {
3ba56876 353 /* Enable 4 channels. */
8256ed15
GS
354 clockselect.disabled_channels = 0xf0ff;
355 } else if (devc->cur_samplerate == SR_MHZ(100)) {
3ba56876 356 /* Enable 8 channels. */
8256ed15
GS
357 clockselect.disabled_channels = 0x00ff;
358 } else {
3ba56876 359 /*
8256ed15
GS
360 * 50 MHz mode, or fraction thereof. The 50MHz reference
361 * can get divided by any integer in the range 1 to 256.
362 * Divider minus 1 gets written to the hardware.
363 * (The driver lists a discrete set of sample rates, but
364 * all of them fit the above description.)
3ba56876 365 */
8256ed15 366 clockselect.fraction = SR_MHZ(50) / devc->cur_samplerate - 1;
3ba56876 367 }
8256ed15
GS
368 clock_idx = 0;
369 clock_bytes[clock_idx++] = clockselect.async;
370 clock_bytes[clock_idx++] = clockselect.fraction;
371 clock_bytes[clock_idx++] = clockselect.disabled_channels & 0xff;
372 clock_bytes[clock_idx++] = clockselect.disabled_channels >> 8;
373 sigma_write_register(WRITE_CLOCK_SELECT, clock_bytes, clock_idx, devc);
3ba56876 374
375 /* Setup maximum post trigger time. */
376 sigma_set_register(WRITE_POST_TRIGGER,
377 (devc->capture_ratio * 255) / 100, devc);
378
379 /* Start acqusition. */
2f425a56 380 devc->start_time = g_get_monotonic_time();
22f64ed8
GS
381 regval = WMR_TRGRES | WMR_SDRAMWRITEEN;
382#if ASIX_SIGMA_WITH_TRIGGER
383 regval |= WMR_TRGEN;
384#endif
385 sigma_set_register(WRITE_MODE, regval, devc);
3ba56876 386
bee2b016 387 std_session_send_df_header(sdi);
3ba56876 388
389 /* Add capture source. */
390 sr_session_source_add(sdi->session, -1, 0, 10, sigma_receive_data, (void *)sdi);
391
392 devc->state.state = SIGMA_CAPTURE;
393
394 return SR_OK;
395}
396
695dc859 397static int dev_acquisition_stop(struct sr_dev_inst *sdi)
3ba56876 398{
399 struct dev_context *devc;
400
3ba56876 401 devc = sdi->priv;
402 devc->state.state = SIGMA_IDLE;
403
404 sr_session_source_remove(sdi->session, -1);
405
406 return SR_OK;
407}
408
dd5c48a6 409static struct sr_dev_driver asix_sigma_driver_info = {
3ba56876 410 .name = "asix-sigma",
411 .longname = "ASIX SIGMA/SIGMA2",
412 .api_version = 1,
c2fdcc25 413 .init = std_init,
700d6b64 414 .cleanup = std_cleanup,
3ba56876 415 .scan = scan,
c01bf34c 416 .dev_list = std_dev_list,
3ba56876 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 .context = NULL,
426};
dd5c48a6 427SR_REGISTER_DEV_DRIVER(asix_sigma_driver_info);