2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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 3 of the License, or
9 * (at your option) any later version.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #define SERIALCOMM "115200/8n1"
25 static const uint32_t scanopts[] = {
30 static const uint32_t drvopts[] = {
31 SR_CONF_LOGIC_ANALYZER,
34 static const uint32_t devopts[] = {
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
36 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
37 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
38 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
39 SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
40 SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
42 SR_CONF_SWAP | SR_CONF_SET,
43 SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
46 static const int32_t trigger_matches[] = {
51 static const char *external_clock_edges[] = {
52 "rising", /* positive edge */
53 "falling" /* negative edge */
56 #define STR_PATTERN_NONE "None"
57 #define STR_PATTERN_EXTERNAL "External"
58 #define STR_PATTERN_INTERNAL "Internal"
60 /* Supported methods of test pattern outputs */
63 * Capture pins 31:16 (unbuffered wing) output a test pattern
64 * that can captured on pins 0:15.
68 /** Route test pattern internally to capture buffer. */
72 static const char *patterns[] = {
78 /* Channels are numbered 0-31 (on the PCB silkscreen). */
79 SR_PRIV const char *ols_channel_names[] = {
80 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
81 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
82 "24", "25", "26", "27", "28", "29", "30", "31",
85 /* Default supported samplerates, can be overridden by device metadata. */
86 static const uint64_t samplerates[] = {
92 #define RESPONSE_DELAY_US (20 * 1000)
94 static GSList *scan(struct sr_dev_driver *di, GSList *options)
96 struct sr_config *src;
97 struct sr_dev_inst *sdi;
98 struct sr_serial_dev_inst *serial;
102 const char *conn, *serialcomm;
103 char buf[4] = { 0, 0, 0, 0 };
105 conn = serialcomm = NULL;
106 for (l = options; l; l = l->next) {
110 conn = g_variant_get_string(src->data, NULL);
112 case SR_CONF_SERIALCOMM:
113 serialcomm = g_variant_get_string(src->data, NULL);
121 serialcomm = SERIALCOMM;
123 serial = sr_serial_dev_inst_new(conn, serialcomm);
125 /* The discovery procedure is like this: first send the Reset
126 * command (0x00) 5 times, since the device could be anywhere
127 * in a 5-byte command. Then send the ID command (0x02).
128 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
131 sr_info("Probing %s.", conn);
132 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
135 if (ols_send_reset(serial) != SR_OK) {
136 serial_close(serial);
137 sr_err("Could not use port %s. Quitting.", conn);
140 send_shortcommand(serial, CMD_ID);
142 g_usleep(RESPONSE_DELAY_US);
144 if (serial_has_receive_data(serial) == 0) {
145 sr_dbg("Didn't get any ID reply.");
150 serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
152 sr_err("Getting ID reply failed (%d).", num_read);
156 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
157 GString *id = sr_hexdump_new((uint8_t *)buf, num_read);
159 sr_err("Invalid ID reply (got %s).", id->str);
165 /* Definitely using the OLS protocol, check if it supports
166 * the metadata command.
168 send_shortcommand(serial, CMD_METADATA);
170 g_usleep(RESPONSE_DELAY_US);
172 if (serial_has_receive_data(serial) != 0) {
174 sdi = get_metadata(serial);
176 /* Not an OLS -- some other board that uses the sump protocol. */
177 sr_info("Device does not support metadata.");
178 sdi = g_malloc0(sizeof(struct sr_dev_inst));
179 sdi->status = SR_ST_INACTIVE;
180 sdi->vendor = g_strdup("Sump");
181 sdi->model = g_strdup("Logic Analyzer");
182 sdi->version = g_strdup("v1.0");
183 for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
184 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
185 ols_channel_names[i]);
186 sdi->priv = ols_dev_new();
188 /* Configure samplerate and divider. */
189 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
190 sr_dbg("Failed to set default samplerate (%" PRIu64 ").",
192 sdi->inst_type = SR_INST_SERIAL;
195 serial_close(serial);
197 return std_scan_complete(di, g_slist_append(NULL, sdi));
200 static int config_get(uint32_t key, GVariant **data,
201 const struct sr_dev_inst *sdi,
202 const struct sr_channel_group *cg)
204 struct dev_context *devc;
214 case SR_CONF_SAMPLERATE:
215 *data = g_variant_new_uint64(devc->cur_samplerate);
217 case SR_CONF_CAPTURE_RATIO:
218 *data = g_variant_new_uint64(devc->capture_ratio);
220 case SR_CONF_LIMIT_SAMPLES:
221 *data = g_variant_new_uint64(devc->limit_samples);
223 case SR_CONF_PATTERN_MODE:
224 if (devc->capture_flags & CAPTURE_FLAG_EXTERNAL_TEST_MODE)
225 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
226 else if (devc->capture_flags & CAPTURE_FLAG_INTERNAL_TEST_MODE)
227 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
229 *data = g_variant_new_string(STR_PATTERN_NONE);
232 *data = g_variant_new_boolean(
233 devc->capture_flags & CAPTURE_FLAG_RLE ? TRUE : FALSE);
235 case SR_CONF_EXTERNAL_CLOCK:
236 *data = g_variant_new_boolean(
237 devc->capture_flags & CAPTURE_FLAG_CLOCK_EXTERNAL
240 case SR_CONF_CLOCK_EDGE:
241 *data = g_variant_new_string(external_clock_edges[
242 devc->capture_flags & CAPTURE_FLAG_INVERT_EXT_CLOCK
252 static int config_set(uint32_t key, GVariant *data,
253 const struct sr_dev_inst *sdi,
254 const struct sr_channel_group *cg)
256 struct dev_context *devc;
266 case SR_CONF_SAMPLERATE:
267 tmp_u64 = g_variant_get_uint64(data);
268 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
269 return SR_ERR_SAMPLERATE;
270 return ols_set_samplerate(sdi, g_variant_get_uint64(data));
271 case SR_CONF_LIMIT_SAMPLES:
272 tmp_u64 = g_variant_get_uint64(data);
273 if (tmp_u64 < MIN_NUM_SAMPLES)
275 devc->limit_samples = tmp_u64;
277 case SR_CONF_CAPTURE_RATIO:
278 devc->capture_ratio = g_variant_get_uint64(data);
280 case SR_CONF_EXTERNAL_CLOCK:
281 if (g_variant_get_boolean(data)) {
282 sr_info("Enabling external clock.");
283 devc->capture_flags |= CAPTURE_FLAG_CLOCK_EXTERNAL;
285 sr_info("Disabled external clock.");
286 devc->capture_flags &= ~CAPTURE_FLAG_CLOCK_EXTERNAL;
289 case SR_CONF_CLOCK_EDGE:
290 stropt = g_variant_get_string(data, NULL);
291 if (!strcmp(stropt, external_clock_edges[1])) {
292 sr_info("Triggering on falling edge of external clock.");
293 devc->capture_flags |= CAPTURE_FLAG_INVERT_EXT_CLOCK;
295 sr_info("Triggering on rising edge of external clock.");
296 devc->capture_flags &= ~CAPTURE_FLAG_INVERT_EXT_CLOCK;
299 case SR_CONF_PATTERN_MODE:
300 stropt = g_variant_get_string(data, NULL);
301 if (!strcmp(stropt, STR_PATTERN_NONE)) {
302 sr_info("Disabling test modes.");
304 } else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
305 sr_info("Enabling internal test mode.");
306 flag = CAPTURE_FLAG_INTERNAL_TEST_MODE;
307 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
308 sr_info("Enabling external test mode.");
309 flag = CAPTURE_FLAG_EXTERNAL_TEST_MODE;
313 devc->capture_flags &= ~CAPTURE_FLAG_INTERNAL_TEST_MODE;
314 devc->capture_flags &= ~CAPTURE_FLAG_EXTERNAL_TEST_MODE;
315 devc->capture_flags |= flag;
318 if (g_variant_get_boolean(data)) {
319 sr_info("Enabling channel swapping.");
320 devc->capture_flags |= CAPTURE_FLAG_SWAP_CHANNELS;
322 sr_info("Disabling channel swapping.");
323 devc->capture_flags &= ~CAPTURE_FLAG_SWAP_CHANNELS;
327 if (g_variant_get_boolean(data)) {
328 sr_info("Enabling RLE.");
329 devc->capture_flags |= CAPTURE_FLAG_RLE;
331 sr_info("Disabling RLE.");
332 devc->capture_flags &= ~CAPTURE_FLAG_RLE;
342 static int config_list(uint32_t key, GVariant **data,
343 const struct sr_dev_inst *sdi,
344 const struct sr_channel_group *cg)
346 struct dev_context *devc;
347 int num_ols_changrp, i;
350 case SR_CONF_SCAN_OPTIONS:
351 case SR_CONF_DEVICE_OPTIONS:
352 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts,
354 case SR_CONF_SAMPLERATE:
355 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
357 case SR_CONF_TRIGGER_MATCH:
358 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
360 case SR_CONF_CLOCK_EDGE:
361 *data = std_gvar_array_str(ARRAY_AND_SIZE(external_clock_edges));
363 case SR_CONF_PATTERN_MODE:
364 *data = g_variant_new_strv(ARRAY_AND_SIZE(patterns));
366 case SR_CONF_LIMIT_SAMPLES:
370 if (devc->max_samples == 0)
371 /* Device didn't specify sample memory size in metadata. */
374 * Channel groups are turned off if no channels in that group are
375 * enabled, making more room for samples for the enabled group.
377 uint32_t channel_mask = ols_channel_mask(sdi);
379 for (i = 0; i < 4; i++) {
380 if (channel_mask & (0xff << (i * 8)))
384 *data = std_gvar_tuple_u64(MIN_NUM_SAMPLES, (num_ols_changrp)
385 ? devc->max_samples / num_ols_changrp : MIN_NUM_SAMPLES);
394 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
397 struct dev_context *devc;
398 struct sr_serial_dev_inst *serial;
403 ret = ols_prepare_acquisition(sdi);
407 /* Start acquisition on the device. */
408 if (send_shortcommand(serial, CMD_ARM_BASIC_TRIGGER) != SR_OK)
411 /* Reset all operational states. */
412 devc->rle_count = devc->num_transfers = 0;
413 devc->num_samples = devc->num_bytes = 0;
414 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
415 memset(devc->sample, 0, 4);
417 std_session_send_df_header(sdi);
419 /* If the device stops sending for longer than it takes to send a byte,
420 * that means it's finished. But wait at least 100 ms to be safe.
422 return serial_source_add(sdi->session, serial, G_IO_IN, 100,
423 ols_receive_data, (struct sr_dev_inst *)sdi);
426 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
428 abort_acquisition(sdi);
433 static struct sr_dev_driver ols_driver_info = {
435 .longname = "Openbench Logic Sniffer & SUMP compatibles",
438 .cleanup = std_cleanup,
440 .dev_list = std_dev_list,
441 .dev_clear = std_dev_clear,
442 .config_get = config_get,
443 .config_set = config_set,
444 .config_list = config_list,
445 .dev_open = std_serial_dev_open,
446 .dev_close = std_serial_dev_close,
447 .dev_acquisition_start = dev_acquisition_start,
448 .dev_acquisition_stop = dev_acquisition_stop,
451 SR_REGISTER_DEV_DRIVER(ols_driver_info);