2 * This file is part of the libsigrok project.
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>
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.
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.
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/>.
23 * ASIX SIGMA/SIGMA2 logic analyzer driver
29 SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
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)
36 static const char *channel_names[] = {
37 "1", "2", "3", "4", "5", "6", "7", "8",
38 "9", "10", "11", "12", "13", "14", "15", "16",
41 static const uint32_t drvopts[] = {
42 SR_CONF_LOGIC_ANALYZER,
45 static 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,
53 static const int32_t trigger_matches[] = {
61 static int dev_clear(const struct sr_dev_driver *di)
63 return std_dev_clear(di, sigma_clear_helper);
66 static GSList *scan(struct sr_dev_driver *di, GSList *options)
68 struct sr_dev_inst *sdi;
69 struct drv_context *drvc;
70 struct dev_context *devc;
72 struct ftdi_device_list *devlist;
84 devc = g_malloc0(sizeof(struct dev_context));
86 ftdi_init(&devc->ftdic);
88 /* Look for SIGMAs. */
90 if ((ret = ftdi_usb_find_all(&devc->ftdic, &devlist,
91 USB_VENDOR, USB_PRODUCT)) <= 0) {
93 sr_err("ftdi_usb_find_all(): %d", ret);
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);
102 if (serial < 0xa6010000 || serial > 0xa602ffff) {
103 sr_err("Only SIGMA and SIGMA2 are supported "
104 "in this version of libsigrok.");
108 sr_info("Found ASIX SIGMA - Serial: %s", serial_txt);
110 devc->cur_samplerate = samplerates[0];
112 devc->limit_msec = 0;
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;
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);
126 for (i = 0; i < ARRAY_SIZE(channel_names); i++)
127 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_names[i]);
129 devices = g_slist_append(devices, sdi);
130 drvc->instances = g_slist_append(drvc->instances, sdi);
133 /* We will open the device again when we need it. */
134 ftdi_list_free(&devlist);
139 ftdi_deinit(&devc->ftdic);
144 static int dev_open(struct sr_dev_inst *sdi)
146 struct dev_context *devc;
151 /* Make sure it's an ASIX SIGMA. */
152 if ((ret = ftdi_usb_open_desc(&devc->ftdic,
153 USB_VENDOR, USB_PRODUCT, USB_DESCRIPTION, NULL)) < 0) {
155 sr_err("ftdi_usb_open failed: %s",
156 ftdi_get_error_string(&devc->ftdic));
161 sdi->status = SR_ST_ACTIVE;
166 static int dev_close(struct sr_dev_inst *sdi)
168 struct dev_context *devc;
173 if (sdi->status == SR_ST_ACTIVE)
174 ftdi_usb_close(&devc->ftdic);
176 sdi->status = SR_ST_INACTIVE;
181 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
182 const struct sr_channel_group *cg)
184 struct dev_context *devc;
193 case SR_CONF_SAMPLERATE:
194 *data = g_variant_new_uint64(devc->cur_samplerate);
196 case SR_CONF_LIMIT_MSEC:
197 *data = g_variant_new_uint64(devc->limit_msec);
199 case SR_CONF_CAPTURE_RATIO:
200 *data = g_variant_new_uint64(devc->capture_ratio);
209 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
210 const struct sr_channel_group *cg)
212 struct dev_context *devc;
218 if (sdi->status != SR_ST_ACTIVE)
219 return SR_ERR_DEV_CLOSED;
225 case SR_CONF_SAMPLERATE:
226 ret = sigma_set_samplerate(sdi, g_variant_get_uint64(data));
228 case SR_CONF_LIMIT_MSEC:
229 tmp = g_variant_get_uint64(data);
231 devc->limit_msec = g_variant_get_uint64(data);
235 case SR_CONF_LIMIT_SAMPLES:
236 tmp = g_variant_get_uint64(data);
237 devc->limit_msec = tmp * 1000 / devc->cur_samplerate;
239 case SR_CONF_CAPTURE_RATIO:
240 tmp = g_variant_get_uint64(data);
242 devc->capture_ratio = tmp;
253 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
254 const struct sr_channel_group *cg)
262 case SR_CONF_DEVICE_OPTIONS:
264 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
265 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
267 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
268 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
270 case SR_CONF_SAMPLERATE:
271 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
272 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
273 SAMPLERATES_COUNT, sizeof(uint64_t));
274 g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
275 *data = g_variant_builder_end(&gvb);
277 case SR_CONF_TRIGGER_MATCH:
278 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
279 trigger_matches, ARRAY_SIZE(trigger_matches),
289 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
291 struct dev_context *devc;
292 struct clockselect_50 clockselect;
293 int frac, triggerpin, ret;
294 uint8_t triggerselect = 0;
295 struct triggerinout triggerinout_conf;
296 struct triggerlut lut;
298 if (sdi->status != SR_ST_ACTIVE)
299 return SR_ERR_DEV_CLOSED;
303 if (sigma_convert_trigger(sdi) != SR_OK) {
304 sr_err("Failed to configure triggers.");
308 /* If the samplerate has not been set, default to 200 kHz. */
309 if (devc->cur_firmware == -1) {
310 if ((ret = sigma_set_samplerate(sdi, SR_KHZ(200))) != SR_OK)
314 /* Enter trigger programming mode. */
315 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x20, devc);
317 /* 100 and 200 MHz mode. */
318 if (devc->cur_samplerate >= SR_MHZ(100)) {
319 sigma_set_register(WRITE_TRIGGER_SELECT1, 0x81, devc);
321 /* Find which pin to trigger on from mask. */
322 for (triggerpin = 0; triggerpin < 8; triggerpin++)
323 if ((devc->trigger.risingmask | devc->trigger.fallingmask) &
327 /* Set trigger pin and light LED on trigger. */
328 triggerselect = (1 << LEDSEL1) | (triggerpin & 0x7);
330 /* Default rising edge. */
331 if (devc->trigger.fallingmask)
332 triggerselect |= 1 << 3;
334 /* All other modes. */
335 } else if (devc->cur_samplerate <= SR_MHZ(50)) {
336 sigma_build_basic_trigger(&lut, devc);
338 sigma_write_trigger_lut(&lut, devc);
340 triggerselect = (1 << LEDSEL1) | (1 << LEDSEL0);
343 /* Setup trigger in and out pins to default values. */
344 memset(&triggerinout_conf, 0, sizeof(struct triggerinout));
345 triggerinout_conf.trgout_bytrigger = 1;
346 triggerinout_conf.trgout_enable = 1;
348 sigma_write_register(WRITE_TRIGGER_OPTION,
349 (uint8_t *) &triggerinout_conf,
350 sizeof(struct triggerinout), devc);
352 /* Go back to normal mode. */
353 sigma_set_register(WRITE_TRIGGER_SELECT1, triggerselect, devc);
355 /* Set clock select register. */
356 if (devc->cur_samplerate == SR_MHZ(200))
357 /* Enable 4 channels. */
358 sigma_set_register(WRITE_CLOCK_SELECT, 0xf0, devc);
359 else if (devc->cur_samplerate == SR_MHZ(100))
360 /* Enable 8 channels. */
361 sigma_set_register(WRITE_CLOCK_SELECT, 0x00, devc);
364 * 50 MHz mode (or fraction thereof). Any fraction down to
365 * 50 MHz / 256 can be used, but is not supported by sigrok API.
367 frac = SR_MHZ(50) / devc->cur_samplerate - 1;
369 clockselect.async = 0;
370 clockselect.fraction = frac;
371 clockselect.disabled_channels = 0;
373 sigma_write_register(WRITE_CLOCK_SELECT,
374 (uint8_t *) &clockselect,
375 sizeof(clockselect), devc);
378 /* Setup maximum post trigger time. */
379 sigma_set_register(WRITE_POST_TRIGGER,
380 (devc->capture_ratio * 255) / 100, devc);
382 /* Start acqusition. */
383 gettimeofday(&devc->start_tv, 0);
384 sigma_set_register(WRITE_MODE, 0x0d, devc);
386 std_session_send_df_header(sdi, LOG_PREFIX);
388 /* Add capture source. */
389 sr_session_source_add(sdi->session, -1, 0, 10, sigma_receive_data, (void *)sdi);
391 devc->state.state = SIGMA_CAPTURE;
396 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
398 struct dev_context *devc;
401 devc->state.state = SIGMA_IDLE;
403 sr_session_source_remove(sdi->session, -1);
408 SR_PRIV struct sr_dev_driver asix_sigma_driver_info = {
409 .name = "asix-sigma",
410 .longname = "ASIX SIGMA/SIGMA2",
413 .cleanup = std_cleanup,
415 .dev_list = std_dev_list,
416 .dev_clear = dev_clear,
417 .config_get = config_get,
418 .config_set = config_set,
419 .config_list = config_list,
420 .dev_open = dev_open,
421 .dev_close = dev_close,
422 .dev_acquisition_start = dev_acquisition_start,
423 .dev_acquisition_stop = dev_acquisition_stop,