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_CONN | SR_CONF_GET,
36 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
37 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
38 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
39 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
40 SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
41 SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
42 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
43 SR_CONF_SWAP | SR_CONF_SET,
44 SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
47 static const int32_t trigger_matches[] = {
52 static const char *external_clock_edges[] = {
53 "rising", /* positive edge */
54 "falling" /* negative edge */
57 #define STR_PATTERN_NONE "None"
58 #define STR_PATTERN_EXTERNAL "External"
59 #define STR_PATTERN_INTERNAL "Internal"
61 /* Supported methods of test pattern outputs */
64 * Capture pins 31:16 (unbuffered wing) output a test pattern
65 * that can captured on pins 0:15.
69 /** Route test pattern internally to capture buffer. */
73 static const char *patterns[] = {
79 /* Channels are numbered 0-31 (on the PCB silkscreen). */
80 SR_PRIV const char *ols_channel_names[] = {
81 "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
82 "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
83 "24", "25", "26", "27", "28", "29", "30", "31",
86 /* Default supported samplerates, can be overridden by device metadata. */
87 static const uint64_t samplerates[] = {
93 #define RESPONSE_DELAY_US (20 * 1000)
95 static GSList *scan(struct sr_dev_driver *di, GSList *options)
97 struct sr_config *src;
98 struct sr_dev_inst *sdi;
99 struct sr_serial_dev_inst *serial;
103 const char *conn, *serialcomm;
104 char buf[4] = { 0, 0, 0, 0 };
105 struct dev_context *devc;
107 conn = serialcomm = NULL;
108 for (l = options; l; l = l->next) {
112 conn = g_variant_get_string(src->data, NULL);
114 case SR_CONF_SERIALCOMM:
115 serialcomm = g_variant_get_string(src->data, NULL);
123 serialcomm = SERIALCOMM;
125 serial = sr_serial_dev_inst_new(conn, serialcomm);
127 /* The discovery procedure is like this: first send the Reset
128 * command (0x00) 5 times, since the device could be anywhere
129 * in a 5-byte command. Then send the ID command (0x02).
130 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
133 sr_info("Probing %s.", conn);
134 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
137 if (ols_send_reset(serial) != SR_OK) {
138 serial_close(serial);
139 sr_err("Could not use port %s. Quitting.", conn);
142 send_shortcommand(serial, CMD_ID);
144 g_usleep(RESPONSE_DELAY_US);
146 if (serial_has_receive_data(serial) == 0) {
147 sr_dbg("Didn't get any ID reply.");
152 serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
154 sr_err("Getting ID reply failed (%d).", num_read);
158 if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
159 GString *id = sr_hexdump_new((uint8_t *)buf, num_read);
161 sr_err("Invalid ID reply (got %s).", id->str);
166 sr_dbg("Successful detection, got '%c%c%c%c' (0x%02x 0x%02x 0x%02x 0x%02x).",
167 buf[0], buf[1], buf[2], buf[3],
168 buf[0], buf[1], buf[2], buf[3]);
172 * Create common data structures (sdi, devc) here in the common
173 * code path. These further get filled in either from metadata
174 * which is gathered from the device, or from open coded generic
175 * fallback data which is kept in the driver source code.
177 sdi = g_malloc0(sizeof(*sdi));
178 sdi->status = SR_ST_INACTIVE;
179 sdi->inst_type = SR_INST_SERIAL;
181 sdi->connection_id = g_strdup(serial->port);
182 devc = g_malloc0(sizeof(*devc));
184 devc->trigger_at_smpl = OLS_NO_TRIGGER;
187 * Definitely using the OLS protocol, check if it supports
188 * the metadata command.
190 send_shortcommand(serial, CMD_METADATA);
191 g_usleep(RESPONSE_DELAY_US);
192 if (serial_has_receive_data(serial) != 0) {
194 (void)ols_get_metadata(sdi);
196 /* Not an OLS -- some other board that uses the sump protocol. */
197 sr_info("Device does not support metadata.");
198 sdi->vendor = g_strdup("Sump");
199 sdi->model = g_strdup("Logic Analyzer");
200 sdi->version = g_strdup("v1.0");
201 for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
202 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
203 ols_channel_names[i]);
205 /* Configure samplerate and divider. */
206 if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
207 sr_dbg("Failed to set default samplerate (%" PRIu64 ").",
210 serial_close(serial);
212 return std_scan_complete(di, g_slist_append(NULL, sdi));
215 static int config_get(uint32_t key, GVariant **data,
216 const struct sr_dev_inst *sdi,
217 const struct sr_channel_group *cg)
219 struct dev_context *devc;
230 if (!sdi->conn || !sdi->connection_id)
232 *data = g_variant_new_string(sdi->connection_id);
234 case SR_CONF_SAMPLERATE:
235 *data = g_variant_new_uint64(devc->cur_samplerate);
237 case SR_CONF_CAPTURE_RATIO:
238 *data = g_variant_new_uint64(devc->capture_ratio);
240 case SR_CONF_LIMIT_SAMPLES:
241 *data = g_variant_new_uint64(devc->limit_samples);
243 case SR_CONF_PATTERN_MODE:
244 if (devc->capture_flags & CAPTURE_FLAG_EXTERNAL_TEST_MODE)
245 *data = g_variant_new_string(STR_PATTERN_EXTERNAL);
246 else if (devc->capture_flags & CAPTURE_FLAG_INTERNAL_TEST_MODE)
247 *data = g_variant_new_string(STR_PATTERN_INTERNAL);
249 *data = g_variant_new_string(STR_PATTERN_NONE);
252 *data = g_variant_new_boolean(
253 devc->capture_flags & CAPTURE_FLAG_RLE ? TRUE : FALSE);
255 case SR_CONF_EXTERNAL_CLOCK:
256 *data = g_variant_new_boolean(
257 devc->capture_flags & CAPTURE_FLAG_CLOCK_EXTERNAL
260 case SR_CONF_CLOCK_EDGE:
261 *data = g_variant_new_string(external_clock_edges[
262 devc->capture_flags & CAPTURE_FLAG_INVERT_EXT_CLOCK
272 static int config_set(uint32_t key, GVariant *data,
273 const struct sr_dev_inst *sdi,
274 const struct sr_channel_group *cg)
276 struct dev_context *devc;
286 case SR_CONF_SAMPLERATE:
287 tmp_u64 = g_variant_get_uint64(data);
288 if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
289 return SR_ERR_SAMPLERATE;
290 return ols_set_samplerate(sdi, g_variant_get_uint64(data));
291 case SR_CONF_LIMIT_SAMPLES:
292 tmp_u64 = g_variant_get_uint64(data);
293 if (tmp_u64 < MIN_NUM_SAMPLES)
295 devc->limit_samples = tmp_u64;
297 case SR_CONF_CAPTURE_RATIO:
298 devc->capture_ratio = g_variant_get_uint64(data);
300 case SR_CONF_EXTERNAL_CLOCK:
301 if (g_variant_get_boolean(data)) {
302 sr_info("Enabling external clock.");
303 devc->capture_flags |= CAPTURE_FLAG_CLOCK_EXTERNAL;
305 sr_info("Disabled external clock.");
306 devc->capture_flags &= ~CAPTURE_FLAG_CLOCK_EXTERNAL;
309 case SR_CONF_CLOCK_EDGE:
310 stropt = g_variant_get_string(data, NULL);
311 if (!strcmp(stropt, external_clock_edges[1])) {
312 sr_info("Triggering on falling edge of external clock.");
313 devc->capture_flags |= CAPTURE_FLAG_INVERT_EXT_CLOCK;
315 sr_info("Triggering on rising edge of external clock.");
316 devc->capture_flags &= ~CAPTURE_FLAG_INVERT_EXT_CLOCK;
319 case SR_CONF_PATTERN_MODE:
320 stropt = g_variant_get_string(data, NULL);
321 if (!strcmp(stropt, STR_PATTERN_NONE)) {
322 sr_info("Disabling test modes.");
324 } else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
325 sr_info("Enabling internal test mode.");
326 flag = CAPTURE_FLAG_INTERNAL_TEST_MODE;
327 } else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
328 sr_info("Enabling external test mode.");
329 flag = CAPTURE_FLAG_EXTERNAL_TEST_MODE;
333 devc->capture_flags &= ~CAPTURE_FLAG_INTERNAL_TEST_MODE;
334 devc->capture_flags &= ~CAPTURE_FLAG_EXTERNAL_TEST_MODE;
335 devc->capture_flags |= flag;
338 if (g_variant_get_boolean(data)) {
339 sr_info("Enabling channel swapping.");
340 devc->capture_flags |= CAPTURE_FLAG_SWAP_CHANNELS;
342 sr_info("Disabling channel swapping.");
343 devc->capture_flags &= ~CAPTURE_FLAG_SWAP_CHANNELS;
347 if (g_variant_get_boolean(data)) {
348 sr_info("Enabling RLE.");
349 devc->capture_flags |= CAPTURE_FLAG_RLE;
351 sr_info("Disabling RLE.");
352 devc->capture_flags &= ~CAPTURE_FLAG_RLE;
362 static int config_list(uint32_t key, GVariant **data,
363 const struct sr_dev_inst *sdi,
364 const struct sr_channel_group *cg)
366 struct dev_context *devc;
367 int num_ols_changrp, i;
370 case SR_CONF_SCAN_OPTIONS:
371 case SR_CONF_DEVICE_OPTIONS:
372 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts,
374 case SR_CONF_SAMPLERATE:
375 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
377 case SR_CONF_TRIGGER_MATCH:
378 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
380 case SR_CONF_CLOCK_EDGE:
381 *data = std_gvar_array_str(ARRAY_AND_SIZE(external_clock_edges));
383 case SR_CONF_PATTERN_MODE:
384 *data = g_variant_new_strv(ARRAY_AND_SIZE(patterns));
386 case SR_CONF_LIMIT_SAMPLES:
390 if (devc->max_samples == 0)
391 /* Device didn't specify sample memory size in metadata. */
394 * Channel groups are turned off if no channels in that group are
395 * enabled, making more room for samples for the enabled group.
397 uint32_t channel_mask = ols_channel_mask(sdi);
399 for (i = 0; i < 4; i++) {
400 if (channel_mask & (0xff << (i * 8)))
404 *data = std_gvar_tuple_u64(MIN_NUM_SAMPLES, (num_ols_changrp)
405 ? devc->max_samples / num_ols_changrp : MIN_NUM_SAMPLES);
414 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
417 struct dev_context *devc;
418 struct sr_serial_dev_inst *serial;
423 ret = ols_prepare_acquisition(sdi);
427 /* Start acquisition on the device. */
428 if (send_shortcommand(serial, CMD_ARM_BASIC_TRIGGER) != SR_OK)
431 /* Reset all operational states. */
432 devc->rle_count = devc->num_transfers = 0;
433 devc->num_samples = devc->num_bytes = 0;
434 devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
435 memset(devc->sample, 0, 4);
437 std_session_send_df_header(sdi);
439 /* If the device stops sending for longer than it takes to send a byte,
440 * that means it's finished. But wait at least 100 ms to be safe.
442 return serial_source_add(sdi->session, serial, G_IO_IN, 100,
443 ols_receive_data, (struct sr_dev_inst *)sdi);
446 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
448 abort_acquisition(sdi);
453 static struct sr_dev_driver ols_driver_info = {
455 .longname = "Openbench Logic Sniffer & SUMP compatibles",
458 .cleanup = std_cleanup,
460 .dev_list = std_dev_list,
461 .dev_clear = std_dev_clear,
462 .config_get = config_get,
463 .config_set = config_set,
464 .config_list = config_list,
465 .dev_open = std_serial_dev_open,
466 .dev_close = std_serial_dev_close,
467 .dev_acquisition_start = dev_acquisition_start,
468 .dev_acquisition_stop = dev_acquisition_stop,
471 SR_REGISTER_DEV_DRIVER(ols_driver_info);