[libsigrok.git] / src / hardware / openbench-logic-sniffer / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include "protocol.h"

#define SERIALCOMM "115200/8n1"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const uint32_t drvopts[] = {
	SR_CONF_LOGIC_ANALYZER,
};

static const uint32_t devopts[] = {
	SR_CONF_CONN | SR_CONF_GET,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
	SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_SWAP | SR_CONF_SET,
	SR_CONF_RLE | SR_CONF_GET | SR_CONF_SET,
};

static const int32_t trigger_matches[] = {
	SR_TRIGGER_ZERO,
	SR_TRIGGER_ONE,
};

static const char *external_clock_edges[] = {
	"rising", /* positive edge */
	"falling" /* negative edge */
};

#define STR_PATTERN_NONE     "None"
#define STR_PATTERN_EXTERNAL "External"
#define STR_PATTERN_INTERNAL "Internal"

/* Supported methods of test pattern outputs */
enum {
	/**
	 * Capture pins 31:16 (unbuffered wing) output a test pattern
	 * that can captured on pins 0:15.
	 */
	PATTERN_EXTERNAL,

	/** Route test pattern internally to capture buffer. */
	PATTERN_INTERNAL,
};

static const char *patterns[] = {
	STR_PATTERN_NONE,
	STR_PATTERN_EXTERNAL,
	STR_PATTERN_INTERNAL,
};

/* Channels are numbered 0-31 (on the PCB silkscreen). */
SR_PRIV const char *ols_channel_names[] = {
	"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12",
	"13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23",
	"24", "25", "26", "27", "28", "29", "30", "31",
};

/* Default supported samplerates, can be overridden by device metadata. */
static const uint64_t samplerates[] = {
	SR_HZ(10),
	SR_MHZ(200),
	SR_HZ(1),
};

#define RESPONSE_DELAY_US (20 * 1000)

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct sr_config *src;
	struct sr_dev_inst *sdi;
	struct sr_serial_dev_inst *serial;
	GSList *l;
	int num_read;
	unsigned int i;
	const char *conn, *serialcomm;
	char buf[4] = { 0, 0, 0, 0 };
	struct dev_context *devc;

	conn = serialcomm = NULL;
	for (l = options; l; l = l->next) {
		src = l->data;
		switch (src->key) {
		case SR_CONF_CONN:
			conn = g_variant_get_string(src->data, NULL);
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = g_variant_get_string(src->data, NULL);
			break;
		}
	}
	if (!conn)
		return NULL;

	if (!serialcomm)
		serialcomm = SERIALCOMM;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

	/* The discovery procedure is like this: first send the Reset
	 * command (0x00) 5 times, since the device could be anywhere
	 * in a 5-byte command. Then send the ID command (0x02).
	 * If the device responds with 4 bytes ("OLS1" or "SLA1"), we
	 * have a match.
	 */
	sr_info("Probing %s.", conn);
	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return NULL;

	if (ols_send_reset(serial) != SR_OK) {
		serial_close(serial);
		sr_err("Could not use port %s. Quitting.", conn);
		return NULL;
	}
	send_shortcommand(serial, CMD_ID);

	g_usleep(RESPONSE_DELAY_US);

	if (serial_has_receive_data(serial) == 0) {
		sr_dbg("Didn't get any ID reply.");
		return NULL;
	}

	num_read =
		serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
	if (num_read < 0) {
		sr_err("Getting ID reply failed (%d).", num_read);
		return NULL;
	}

	if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
		GString *id = sr_hexdump_new((uint8_t *)buf, num_read);

		sr_err("Invalid ID reply (got %s).", id->str);

		sr_hexdump_free(id);
		return NULL;
	} else {
		sr_dbg("Successful detection, got '%c%c%c%c' (0x%02x 0x%02x 0x%02x 0x%02x).",
		       buf[0], buf[1], buf[2], buf[3],
		       buf[0], buf[1], buf[2], buf[3]);
	}

	/*
	 * Create common data structures (sdi, devc) here in the common
	 * code path. These further get filled in either from metadata
	 * which is gathered from the device, or from open coded generic
	 * fallback data which is kept in the driver source code.
	 */
	sdi = g_malloc0(sizeof(*sdi));
	sdi->status = SR_ST_INACTIVE;
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->connection_id = g_strdup(serial->port);
	devc = g_malloc0(sizeof(*devc));
	sdi->priv = devc;
	devc->trigger_at_smpl = OLS_NO_TRIGGER;

	/*
	 * Definitely using the OLS protocol, check if it supports
	 * the metadata command.
	 */
	send_shortcommand(serial, CMD_METADATA);
	g_usleep(RESPONSE_DELAY_US);
	if (serial_has_receive_data(serial) != 0) {
		/* Got metadata. */
		(void)ols_get_metadata(sdi);
	} else {
		/* Not an OLS -- some other board that uses the sump protocol. */
		sr_info("Device does not support metadata.");
		sdi->vendor = g_strdup("Sump");
		sdi->model = g_strdup("Logic Analyzer");
		sdi->version = g_strdup("v1.0");
		for (i = 0; i < ARRAY_SIZE(ols_channel_names); i++)
			sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
				       ols_channel_names[i]);
	}
	/* Configure samplerate and divider. */
	if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
		sr_dbg("Failed to set default samplerate (%" PRIu64 ").",
		       DEFAULT_SAMPLERATE);

	serial_close(serial);

	return std_scan_complete(di, g_slist_append(NULL, sdi));
}

static int config_get(uint32_t key, GVariant **data,
		      const struct sr_dev_inst *sdi,
		      const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_CONN:
		if (!sdi->conn || !sdi->connection_id)
			return SR_ERR_NA;
		*data = g_variant_new_string(sdi->connection_id);
		break;
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->cur_samplerate);
		break;
	case SR_CONF_CAPTURE_RATIO:
		*data = g_variant_new_uint64(devc->capture_ratio);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_PATTERN_MODE:
		if (devc->capture_flags & CAPTURE_FLAG_EXTERNAL_TEST_MODE)
			*data = g_variant_new_string(STR_PATTERN_EXTERNAL);
		else if (devc->capture_flags & CAPTURE_FLAG_INTERNAL_TEST_MODE)
			*data = g_variant_new_string(STR_PATTERN_INTERNAL);
		else
			*data = g_variant_new_string(STR_PATTERN_NONE);
		break;
	case SR_CONF_RLE:
		*data = g_variant_new_boolean(
			devc->capture_flags & CAPTURE_FLAG_RLE ? TRUE : FALSE);
		break;
	case SR_CONF_EXTERNAL_CLOCK:
		*data = g_variant_new_boolean(
			devc->capture_flags & CAPTURE_FLAG_CLOCK_EXTERNAL
			? TRUE : FALSE);
		break;
	case SR_CONF_CLOCK_EDGE:
		*data = g_variant_new_string(external_clock_edges[
			devc->capture_flags & CAPTURE_FLAG_INVERT_EXT_CLOCK
			? 1 : 0]);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(uint32_t key, GVariant *data,
		      const struct sr_dev_inst *sdi,
		      const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	uint16_t flag;
	uint64_t tmp_u64;
	const char *stropt;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		tmp_u64 = g_variant_get_uint64(data);
		if (tmp_u64 < samplerates[0] || tmp_u64 > samplerates[1])
			return SR_ERR_SAMPLERATE;
		return ols_set_samplerate(sdi, g_variant_get_uint64(data));
	case SR_CONF_LIMIT_SAMPLES:
		tmp_u64 = g_variant_get_uint64(data);
		if (tmp_u64 < MIN_NUM_SAMPLES)
			return SR_ERR;
		devc->limit_samples = tmp_u64;
		break;
	case SR_CONF_CAPTURE_RATIO:
		devc->capture_ratio = g_variant_get_uint64(data);
		break;
	case SR_CONF_EXTERNAL_CLOCK:
		if (g_variant_get_boolean(data)) {
			sr_info("Enabling external clock.");
			devc->capture_flags |= CAPTURE_FLAG_CLOCK_EXTERNAL;
		} else {
			sr_info("Disabled external clock.");
			devc->capture_flags &= ~CAPTURE_FLAG_CLOCK_EXTERNAL;
		}
		break;
	case SR_CONF_CLOCK_EDGE:
		stropt = g_variant_get_string(data, NULL);
		if (!strcmp(stropt, external_clock_edges[1])) {
			sr_info("Triggering on falling edge of external clock.");
			devc->capture_flags |= CAPTURE_FLAG_INVERT_EXT_CLOCK;
		} else {
			sr_info("Triggering on rising edge of external clock.");
			devc->capture_flags &= ~CAPTURE_FLAG_INVERT_EXT_CLOCK;
		}
		break;
	case SR_CONF_PATTERN_MODE:
		stropt = g_variant_get_string(data, NULL);
		if (!strcmp(stropt, STR_PATTERN_NONE)) {
			sr_info("Disabling test modes.");
			flag = 0x0000;
		} else if (!strcmp(stropt, STR_PATTERN_INTERNAL)) {
			sr_info("Enabling internal test mode.");
			flag = CAPTURE_FLAG_INTERNAL_TEST_MODE;
		} else if (!strcmp(stropt, STR_PATTERN_EXTERNAL)) {
			sr_info("Enabling external test mode.");
			flag = CAPTURE_FLAG_EXTERNAL_TEST_MODE;
		} else {
			return SR_ERR;
		}
		devc->capture_flags &= ~CAPTURE_FLAG_INTERNAL_TEST_MODE;
		devc->capture_flags &= ~CAPTURE_FLAG_EXTERNAL_TEST_MODE;
		devc->capture_flags |= flag;
		break;
	case SR_CONF_SWAP:
		if (g_variant_get_boolean(data)) {
			sr_info("Enabling channel swapping.");
			devc->capture_flags |= CAPTURE_FLAG_SWAP_CHANNELS;
		} else {
			sr_info("Disabling channel swapping.");
			devc->capture_flags &= ~CAPTURE_FLAG_SWAP_CHANNELS;
		}
		break;
	case SR_CONF_RLE:
		if (g_variant_get_boolean(data)) {
			sr_info("Enabling RLE.");
			devc->capture_flags |= CAPTURE_FLAG_RLE;
		} else {
			sr_info("Disabling RLE.");
			devc->capture_flags &= ~CAPTURE_FLAG_RLE;
		}
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data,
		       const struct sr_dev_inst *sdi,
		       const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	int num_ols_changrp, i;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
	case SR_CONF_DEVICE_OPTIONS:
		return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts,
				       devopts);
	case SR_CONF_SAMPLERATE:
		*data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
		break;
	case SR_CONF_TRIGGER_MATCH:
		*data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
		break;
	case SR_CONF_CLOCK_EDGE:
		*data = std_gvar_array_str(ARRAY_AND_SIZE(external_clock_edges));
		break;
	case SR_CONF_PATTERN_MODE:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(patterns));
		break;
	case SR_CONF_LIMIT_SAMPLES:
		if (!sdi)
			return SR_ERR_ARG;
		devc = sdi->priv;
		if (devc->max_samples == 0)
			/* Device didn't specify sample memory size in metadata. */
			return SR_ERR_NA;
		/*
		 * Channel groups are turned off if no channels in that group are
		 * enabled, making more room for samples for the enabled group.
		*/
		uint32_t channel_mask = ols_channel_mask(sdi);
		num_ols_changrp = 0;
		for (i = 0; i < 4; i++) {
			if (channel_mask & (0xff << (i * 8)))
				num_ols_changrp++;
		}

		*data = std_gvar_tuple_u64(MIN_NUM_SAMPLES, (num_ols_changrp)
			? devc->max_samples / num_ols_changrp : MIN_NUM_SAMPLES);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	int ret;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

	devc = sdi->priv;
	serial = sdi->conn;

	ret = ols_prepare_acquisition(sdi);
	if (ret != SR_OK)
		return ret;

	/* Start acquisition on the device. */
	if (send_shortcommand(serial, CMD_ARM_BASIC_TRIGGER) != SR_OK)
		return SR_ERR;

	/* Reset all operational states. */
	devc->rle_count = devc->num_transfers = 0;
	devc->num_samples = devc->num_bytes = 0;
	devc->cnt_bytes = devc->cnt_samples = devc->cnt_samples_rle = 0;
	memset(devc->sample, 0, 4);

	std_session_send_df_header(sdi);

	/* If the device stops sending for longer than it takes to send a byte,
	 * that means it's finished. But wait at least 100 ms to be safe.
	 */
	return serial_source_add(sdi->session, serial, G_IO_IN, 100,
				 ols_receive_data, (struct sr_dev_inst *)sdi);
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	abort_acquisition(sdi);

	return SR_OK;
}

static struct sr_dev_driver ols_driver_info = {
	.name = "ols",
	.longname = "Openbench Logic Sniffer & SUMP compatibles",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = std_dev_clear,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = std_serial_dev_open,
	.dev_close = std_serial_dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(ols_driver_info);
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
	5	*
	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.
	10	*
	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.
	15	*
	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/>.
	18	*/
	19
	20	#include <config.h>
	21	#include "protocol.h"
	22
	23	#define SERIALCOMM "115200/8n1"
	24
	25	static const uint32_t scanopts[] = {
	26	SR_CONF_CONN,
	27	SR_CONF_SERIALCOMM,
	28	};
	29
	30	static const uint32_t drvopts[] = {
	31	SR_CONF_LOGIC_ANALYZER,
	32	};
	33
	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,
	45	};
	46
	47	static const int32_t trigger_matches[] = {
	48	SR_TRIGGER_ZERO,
	49	SR_TRIGGER_ONE,
	50	};
	51
	52	static const char *external_clock_edges[] = {
	53	"rising", /* positive edge */
	54	"falling" /* negative edge */
	55	};
	56
	57	#define STR_PATTERN_NONE "None"
	58	#define STR_PATTERN_EXTERNAL "External"
	59	#define STR_PATTERN_INTERNAL "Internal"
	60
	61	/* Supported methods of test pattern outputs */
	62	enum {
	63	/**
	64	* Capture pins 31:16 (unbuffered wing) output a test pattern
	65	* that can captured on pins 0:15.
	66	*/
	67	PATTERN_EXTERNAL,
	68
	69	/** Route test pattern internally to capture buffer. */
	70	PATTERN_INTERNAL,
	71	};
	72
	73	static const char *patterns[] = {
	74	STR_PATTERN_NONE,
	75	STR_PATTERN_EXTERNAL,
	76	STR_PATTERN_INTERNAL,
	77	};
	78
	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",
	84	};
	85
	86	/* Default supported samplerates, can be overridden by device metadata. */
	87	static const uint64_t samplerates[] = {
	88	SR_HZ(10),
	89	SR_MHZ(200),
	90	SR_HZ(1),
	91	};
	92
	93	#define RESPONSE_DELAY_US (20 * 1000)
	94
	95	static GSList scan(struct sr_dev_driver di, GSList *options)
	96	{
	97	struct sr_config *src;
	98	struct sr_dev_inst *sdi;
	99	struct sr_serial_dev_inst *serial;
	100	GSList *l;
	101	int num_read;
	102	unsigned int i;
	103	const char conn, serialcomm;
	104	char buf[4] = { 0, 0, 0, 0 };
	105	struct dev_context *devc;
	106
	107	conn = serialcomm = NULL;
	108	for (l = options; l; l = l->next) {
	109	src = l->data;
	110	switch (src->key) {
	111	case SR_CONF_CONN:
	112	conn = g_variant_get_string(src->data, NULL);
	113	break;
	114	case SR_CONF_SERIALCOMM:
	115	serialcomm = g_variant_get_string(src->data, NULL);
	116	break;
	117	}
	118	}
	119	if (!conn)
	120	return NULL;
	121
	122	if (!serialcomm)
	123	serialcomm = SERIALCOMM;
	124
	125	serial = sr_serial_dev_inst_new(conn, serialcomm);
	126
	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
	131	* have a match.
	132	*/
	133	sr_info("Probing %s.", conn);
	134	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	135	return NULL;
	136
	137	if (ols_send_reset(serial) != SR_OK) {
	138	serial_close(serial);
	139	sr_err("Could not use port %s. Quitting.", conn);
	140	return NULL;
	141	}
	142	send_shortcommand(serial, CMD_ID);
	143
	144	g_usleep(RESPONSE_DELAY_US);
	145
	146	if (serial_has_receive_data(serial) == 0) {
	147	sr_dbg("Didn't get any ID reply.");
	148	return NULL;
	149	}
	150
	151	num_read =
	152	serial_read_blocking(serial, buf, 4, serial_timeout(serial, 4));
	153	if (num_read < 0) {
	154	sr_err("Getting ID reply failed (%d).", num_read);
	155	return NULL;
	156	}
	157
	158	if (strncmp(buf, "1SLO", 4) && strncmp(buf, "1ALS", 4)) {
	159	GString id = sr_hexdump_new((uint8_t )buf, num_read);
	160
	161	sr_err("Invalid ID reply (got %s).", id->str);
	162
	163	sr_hexdump_free(id);
	164	return NULL;
	165	} else {
	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]);
	169	}
	170
	171	/*
	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.
	176	*/
	177	sdi = g_malloc0(sizeof(*sdi));
	178	sdi->status = SR_ST_INACTIVE;
	179	sdi->inst_type = SR_INST_SERIAL;
	180	sdi->conn = serial;
	181	sdi->connection_id = g_strdup(serial->port);
	182	devc = g_malloc0(sizeof(*devc));
	183	sdi->priv = devc;
	184	devc->trigger_at_smpl = OLS_NO_TRIGGER;
	185
	186	/*
	187	* Definitely using the OLS protocol, check if it supports
	188	* the metadata command.
	189	*/
	190	send_shortcommand(serial, CMD_METADATA);
	191	g_usleep(RESPONSE_DELAY_US);
	192	if (serial_has_receive_data(serial) != 0) {
	193	/* Got metadata. */
	194	(void)ols_get_metadata(sdi);
	195	} else {
	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]);
	204	}
	205	/* Configure samplerate and divider. */
	206	if (ols_set_samplerate(sdi, DEFAULT_SAMPLERATE) != SR_OK)
	207	sr_dbg("Failed to set default samplerate (%" PRIu64 ").",
	208	DEFAULT_SAMPLERATE);
	209
	210	serial_close(serial);
	211
	212	return std_scan_complete(di, g_slist_append(NULL, sdi));
	213	}
	214
	215	static int config_get(uint32_t key, GVariant **data,
	216	const struct sr_dev_inst *sdi,
	217	const struct sr_channel_group *cg)
	218	{
	219	struct dev_context *devc;
	220
	221	(void)cg;
	222
	223	if (!sdi)
	224	return SR_ERR_ARG;
	225
	226	devc = sdi->priv;
	227
	228	switch (key) {
	229	case SR_CONF_CONN:
	230	if (!sdi->conn \|\| !sdi->connection_id)
	231	return SR_ERR_NA;
	232	*data = g_variant_new_string(sdi->connection_id);
	233	break;
	234	case SR_CONF_SAMPLERATE:
	235	*data = g_variant_new_uint64(devc->cur_samplerate);
	236	break;
	237	case SR_CONF_CAPTURE_RATIO:
	238	*data = g_variant_new_uint64(devc->capture_ratio);
	239	break;
	240	case SR_CONF_LIMIT_SAMPLES:
	241	*data = g_variant_new_uint64(devc->limit_samples);
	242	break;
	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);
	248	else
	249	*data = g_variant_new_string(STR_PATTERN_NONE);
	250	break;
	251	case SR_CONF_RLE:
	252	*data = g_variant_new_boolean(
	253	devc->capture_flags & CAPTURE_FLAG_RLE ? TRUE : FALSE);
	254	break;
	255	case SR_CONF_EXTERNAL_CLOCK:
	256	*data = g_variant_new_boolean(
	257	devc->capture_flags & CAPTURE_FLAG_CLOCK_EXTERNAL
	258	? TRUE : FALSE);
	259	break;
	260	case SR_CONF_CLOCK_EDGE:
	261	*data = g_variant_new_string(external_clock_edges[
	262	devc->capture_flags & CAPTURE_FLAG_INVERT_EXT_CLOCK
	263	? 1 : 0]);
	264	break;
	265	default:
	266	return SR_ERR_NA;
	267	}
	268
	269	return SR_OK;
	270	}
	271
	272	static int config_set(uint32_t key, GVariant *data,
	273	const struct sr_dev_inst *sdi,
	274	const struct sr_channel_group *cg)
	275	{
	276	struct dev_context *devc;
	277	uint16_t flag;
	278	uint64_t tmp_u64;
	279	const char *stropt;
	280
	281	(void)cg;
	282
	283	devc = sdi->priv;
	284
	285	switch (key) {
	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)
	294	return SR_ERR;
	295	devc->limit_samples = tmp_u64;
	296	break;
	297	case SR_CONF_CAPTURE_RATIO:
	298	devc->capture_ratio = g_variant_get_uint64(data);
	299	break;
	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;
	304	} else {
	305	sr_info("Disabled external clock.");
	306	devc->capture_flags &= ~CAPTURE_FLAG_CLOCK_EXTERNAL;
	307	}
	308	break;
	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;
	314	} else {
	315	sr_info("Triggering on rising edge of external clock.");
	316	devc->capture_flags &= ~CAPTURE_FLAG_INVERT_EXT_CLOCK;
	317	}
	318	break;
	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.");
	323	flag = 0x0000;
	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;
	330	} else {
	331	return SR_ERR;
	332	}
	333	devc->capture_flags &= ~CAPTURE_FLAG_INTERNAL_TEST_MODE;
	334	devc->capture_flags &= ~CAPTURE_FLAG_EXTERNAL_TEST_MODE;
	335	devc->capture_flags \|= flag;
	336	break;
	337	case SR_CONF_SWAP:
	338	if (g_variant_get_boolean(data)) {
	339	sr_info("Enabling channel swapping.");
	340	devc->capture_flags \|= CAPTURE_FLAG_SWAP_CHANNELS;
	341	} else {
	342	sr_info("Disabling channel swapping.");
	343	devc->capture_flags &= ~CAPTURE_FLAG_SWAP_CHANNELS;
	344	}
	345	break;
	346	case SR_CONF_RLE:
	347	if (g_variant_get_boolean(data)) {
	348	sr_info("Enabling RLE.");
	349	devc->capture_flags \|= CAPTURE_FLAG_RLE;
	350	} else {
	351	sr_info("Disabling RLE.");
	352	devc->capture_flags &= ~CAPTURE_FLAG_RLE;
	353	}
	354	break;
	355	default:
	356	return SR_ERR_NA;
	357	}
	358
	359	return SR_OK;
	360	}
	361
	362	static int config_list(uint32_t key, GVariant **data,
	363	const struct sr_dev_inst *sdi,
	364	const struct sr_channel_group *cg)
	365	{
	366	struct dev_context *devc;
	367	int num_ols_changrp, i;
	368
	369	switch (key) {
	370	case SR_CONF_SCAN_OPTIONS:
	371	case SR_CONF_DEVICE_OPTIONS:
	372	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts,
	373	devopts);
	374	case SR_CONF_SAMPLERATE:
	375	*data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
	376	break;
	377	case SR_CONF_TRIGGER_MATCH:
	378	*data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
	379	break;
	380	case SR_CONF_CLOCK_EDGE:
	381	*data = std_gvar_array_str(ARRAY_AND_SIZE(external_clock_edges));
	382	break;
	383	case SR_CONF_PATTERN_MODE:
	384	*data = g_variant_new_strv(ARRAY_AND_SIZE(patterns));
	385	break;
	386	case SR_CONF_LIMIT_SAMPLES:
	387	if (!sdi)
	388	return SR_ERR_ARG;
	389	devc = sdi->priv;
	390	if (devc->max_samples == 0)
	391	/* Device didn't specify sample memory size in metadata. */
	392	return SR_ERR_NA;
	393	/*
	394	* Channel groups are turned off if no channels in that group are
	395	* enabled, making more room for samples for the enabled group.
	396	*/
	397	uint32_t channel_mask = ols_channel_mask(sdi);
	398	num_ols_changrp = 0;
	399	for (i = 0; i < 4; i++) {
	400	if (channel_mask & (0xff << (i * 8)))
	401	num_ols_changrp++;
	402	}
	403
	404	*data = std_gvar_tuple_u64(MIN_NUM_SAMPLES, (num_ols_changrp)
	405	? devc->max_samples / num_ols_changrp : MIN_NUM_SAMPLES);
	406	break;
	407	default:
	408	return SR_ERR_NA;
	409	}
	410
	411	return SR_OK;
	412	}
	413
	414	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	415	{
	416	int ret;
	417	struct dev_context *devc;
	418	struct sr_serial_dev_inst *serial;
	419
	420	devc = sdi->priv;
	421	serial = sdi->conn;
	422
	423	ret = ols_prepare_acquisition(sdi);
	424	if (ret != SR_OK)
	425	return ret;
	426
	427	/* Start acquisition on the device. */
	428	if (send_shortcommand(serial, CMD_ARM_BASIC_TRIGGER) != SR_OK)
	429	return SR_ERR;
	430
	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);
	436
	437	std_session_send_df_header(sdi);
	438
	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.
	441	*/
	442	return serial_source_add(sdi->session, serial, G_IO_IN, 100,
	443	ols_receive_data, (struct sr_dev_inst *)sdi);
	444	}
	445
	446	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	447	{
	448	abort_acquisition(sdi);
	449
	450	return SR_OK;
	451	}
	452
	453	static struct sr_dev_driver ols_driver_info = {
	454	.name = "ols",
	455	.longname = "Openbench Logic Sniffer & SUMP compatibles",
	456	.api_version = 1,
	457	.init = std_init,
	458	.cleanup = std_cleanup,
	459	.scan = scan,
	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,
	469	.context = NULL,
	470	};
	471	SR_REGISTER_DEV_DRIVER(ols_driver_info);