[libsigrok.git] / src / hardware / hung-chang-dso-2100 / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2015 Daniel Glöckner <daniel-gl@gmx.net>
 *
 * 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 <ieee1284.h>
#include <string.h>
#include "protocol.h"

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

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

static const uint32_t devopts[] = {
	SR_CONF_CONN | SR_CONF_GET,
	SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_BUFFERSIZE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static const uint32_t devopts_cg[] = {
	SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_PROBE_FACTOR | SR_CONF_GET | SR_CONF_SET,
};

static const uint64_t samplerates[] = {
	SR_MHZ(100), SR_MHZ(50),  SR_MHZ(25),   SR_MHZ(20),
	SR_MHZ(10),  SR_MHZ(5),   SR_KHZ(2500), SR_MHZ(2),
	SR_MHZ(1),   SR_KHZ(500), SR_KHZ(250),  SR_KHZ(200),
	SR_KHZ(100), SR_KHZ(50),  SR_KHZ(25),   SR_KHZ(20),
	SR_KHZ(10),  SR_KHZ(5),   SR_HZ(2500),  SR_KHZ(2),
	SR_KHZ(1),   SR_HZ(500),  SR_HZ(250),   SR_HZ(200),
	SR_HZ(100),  SR_HZ(50),   SR_HZ(25),    SR_HZ(20)
};

/* must be in sync with readout_steps[] in protocol.c */
static const uint64_t buffersizes[] = {
	2 * 500, 3 * 500, 4 * 500, 5 * 500,
	6 * 500, 7 * 500, 8 * 500, 9 * 500, 10 * 500,
	12 * 500 - 2, 14 * 500 - 2, 16 * 500 - 2,
	18 * 500 - 2, 20 * 500 - 2, 10240 - 2
};

static const uint64_t vdivs[][2] = {
	{ 10, 1000 },
	{ 20, 1000 },
	{ 50, 1000 },
	{ 100, 1000 },
	{ 200, 1000 },
	{ 500, 1000 },
	{ 1, 1 },
	{ 2, 1 },
	{ 5, 1 },
};

/* Bits 4 and 5 enable relays that add /10 filters to the chain
 * Bits 0 and 1 select an output from a resistor array */
static const uint8_t vdivs_map[] = {
	0x01, 0x02, 0x03, 0x21, 0x22, 0x23, 0x31, 0x32, 0x33
};


static const char *trigger_sources[] = {
	"A", "B", "EXT"
};

static const uint8_t trigger_sources_map[] = {
	0x00, 0x80, 0x40
};

static const char *trigger_slopes[] = {
	"f", "r"
};

static const char *coupling[] = {
	"DC", "AC", "GND"
};

static const uint8_t coupling_map[] = {
	0x00, 0x08, 0x04
};

static GSList *scan_port(GSList *devices, struct parport *port)
{
	struct sr_dev_inst *sdi;
	struct sr_channel *ch;
	struct sr_channel_group *cg;
	struct dev_context *devc;
	int i;

	if (ieee1284_open(port, 0, &i) != E1284_OK) {
		sr_err("Can't open parallel port %s", port->name);
		goto fail1;
	}

	if ((i & (CAP1284_RAW | CAP1284_BYTE)) != (CAP1284_RAW | CAP1284_BYTE)) {
		sr_err("Parallel port %s does not provide low-level bidirection access",
		       port->name);
		goto fail2;
	}

	if (ieee1284_claim(port) != E1284_OK) {
		sr_err("Parallel port %s already in use", port->name);
		goto fail2;
	}

	if (!hung_chang_dso_2100_check_id(port))
		goto fail3;

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup("Hung-Chang");
	sdi->model = g_strdup("DSO-2100");
	sdi->inst_type = 0; /* FIXME */
	sdi->conn = port;
	ieee1284_ref(port);

	for (i = 0; i < NUM_CHANNELS; i++) {
		cg = g_malloc0(sizeof(struct sr_channel_group));
		cg->name = g_strdup(trigger_sources[i]);
		ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, FALSE, trigger_sources[i]);
		cg->channels = g_slist_append(cg->channels, ch);
		sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
	}

	devc = g_malloc0(sizeof(struct dev_context));
	devc->enabled_channel = g_slist_append(NULL, NULL);
	devc->channel = 0;
	devc->rate = 0;
	devc->probe[0] = 10;
	devc->probe[1] = 10;
	devc->cctl[0] = 0x31; /* 1V/div, DC coupling, trigger on channel A*/
	devc->cctl[1] = 0x31; /* 1V/div, DC coupling, no tv sync trigger */
	devc->edge = 0;
	devc->tlevel = 0x80;
	devc->pos[0] = 0x80;
	devc->pos[1] = 0x80;
	devc->offset[0] = 0x80;
	devc->offset[1] = 0x80;
	devc->gain[0] = 0x80;
	devc->gain[1] = 0x80;
	devc->frame_limit = 0;
	devc->last_step = 0; /* buffersize = 1000 */
	sdi->priv = devc;

	devices = g_slist_append(devices, sdi);

fail3:
	ieee1284_release(port);
fail2:
	ieee1284_close(port);
fail1:
	return devices;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct parport_list ports;
	struct sr_config *src;
	const char *conn = NULL;
	GSList *devices, *option;
	gboolean port_found;
	int i;


	for (option = options; option; option = option->next) {
		src = option->data;
		if (src->key == SR_CONF_CONN) {
			conn = g_variant_get_string(src->data, NULL);
			break;
		}
	}

	if (!conn)
		return NULL;

	if (ieee1284_find_ports(&ports, 0) != E1284_OK)
		return NULL;

	devices = NULL;
	port_found = FALSE;
	for (i = 0; i < ports.portc; i++)
		if (!strcmp(ports.portv[i]->name, conn)) {
			port_found = TRUE;
			devices = scan_port(devices, ports.portv[i]);
		}

	if (!port_found) {
		sr_err("Parallel port %s not found. Valid names are:", conn);
		for (i = 0; i < ports.portc; i++)
			sr_err("\t%s", ports.portv[i]->name);
	}

	ieee1284_free_ports(&ports);

	return std_scan_complete(di, devices);
}

static void clear_helper(struct dev_context *devc)
{
	g_slist_free(devc->enabled_channel);
}

static int dev_clear(const struct sr_dev_driver *di)
{
	struct drv_context *drvc = di->context;
	struct sr_dev_inst *sdi;
	GSList *l;

	if (drvc) {
		for (l = drvc->instances; l; l = l->next) {
			sdi = l->data;
			ieee1284_unref(sdi->conn);
		}
	}

	return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc = sdi->priv;
	int i;

	if (ieee1284_open(sdi->conn, 0, &i) != E1284_OK)
		goto fail1;

	if (ieee1284_claim(sdi->conn) != E1284_OK)
		goto fail2;

	if (ieee1284_data_dir(sdi->conn, 1) != E1284_OK)
		goto fail3;

	if (hung_chang_dso_2100_move_to(sdi, 1))
		goto fail3;

	devc->samples = g_try_malloc(1000 * sizeof(*devc->samples));
	if (!devc->samples)
		goto fail3;

	return SR_OK;

fail3:
	hung_chang_dso_2100_reset_port(sdi->conn);
	ieee1284_release(sdi->conn);
fail2:
	ieee1284_close(sdi->conn);
fail1:
	return SR_ERR;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct dev_context *devc = sdi->priv;

	g_free(devc->samples);
	hung_chang_dso_2100_reset_port(sdi->conn);
	ieee1284_release(sdi->conn);
	ieee1284_close(sdi->conn);

	return SR_OK;
}

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 = sdi->priv;
	struct parport *port;
	int idx, ch = -1;

	if (cg) /* sr_config_get will validate cg using config_list */
		ch = ((struct sr_channel *)cg->channels->data)->index;

	switch (key) {
	case SR_CONF_CONN:
		port = sdi->conn;
		*data = g_variant_new_string(port->name);
		break;
	case SR_CONF_LIMIT_FRAMES:
		*data = g_variant_new_uint64(devc->frame_limit);
		break;
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(samplerates[devc->rate]);
		break;
	case SR_CONF_TRIGGER_SOURCE:
		if ((idx = std_u8_idx_s(devc->cctl[0] & 0xC0, ARRAY_AND_SIZE(trigger_sources_map))) < 0)
			return SR_ERR_BUG;
		*data = g_variant_new_string(trigger_sources[idx]);
		break;
	case SR_CONF_TRIGGER_SLOPE:
		if (devc->edge >= ARRAY_SIZE(trigger_slopes))
			return SR_ERR;
		else
			*data = g_variant_new_string(trigger_slopes[devc->edge]);
		break;
	case SR_CONF_BUFFERSIZE:
		*data = g_variant_new_uint64(buffersizes[devc->last_step]);
		break;
	case SR_CONF_VDIV:
		if (ch == -1) {
			return SR_ERR_CHANNEL_GROUP;
		} else {
			if ((idx = std_u8_idx_s(devc->cctl[ch] & 0x33, ARRAY_AND_SIZE(vdivs_map))) < 0)
				return SR_ERR_BUG;
			*data = g_variant_new("(tt)", vdivs[idx][0], vdivs[idx][1]);
		}
		break;
	case SR_CONF_COUPLING:
		if (ch == -1) {
			return SR_ERR_CHANNEL_GROUP;
		} else {
			if ((idx = std_u8_idx_s(devc->cctl[ch] & 0x0C, ARRAY_AND_SIZE(coupling_map))) < 0)
				return SR_ERR_BUG;
			*data = g_variant_new_string(coupling[idx]);
		}
		break;
	case SR_CONF_PROBE_FACTOR:
		if (ch == -1)
			return SR_ERR_CHANNEL_GROUP;
		else
			*data = g_variant_new_uint64(devc->probe[ch]);
		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 = sdi->priv;
	int idx, ch = -1;
	uint64_t u;

	if (cg) /* sr_config_set will validate cg using config_list */
		ch = ((struct sr_channel *)cg->channels->data)->index;

	switch (key) {
	case SR_CONF_LIMIT_FRAMES:
		devc->frame_limit = g_variant_get_uint64(data);
		break;
	case SR_CONF_SAMPLERATE:
		if ((idx = std_u64_idx(data, ARRAY_AND_SIZE(samplerates))) < 0)
			return SR_ERR_ARG;
		devc->rate = idx;
		break;
	case SR_CONF_TRIGGER_SOURCE:
		if ((idx = std_str_idx(data, ARRAY_AND_SIZE(trigger_sources))) < 0)
			return SR_ERR_ARG;
		devc->cctl[0] = (devc->cctl[0] & 0x3F) | trigger_sources_map[idx];
		break;
	case SR_CONF_TRIGGER_SLOPE:
		if ((idx = std_str_idx(data, ARRAY_AND_SIZE(trigger_slopes))) < 0)
			return SR_ERR_ARG;
		devc->edge = idx;
		break;
	case SR_CONF_BUFFERSIZE:
		if ((idx = std_u64_idx(data, ARRAY_AND_SIZE(buffersizes))) < 0)
			return SR_ERR_ARG;
		devc->last_step = idx;
		break;
	case SR_CONF_VDIV:
		if (ch == -1) {
			return SR_ERR_CHANNEL_GROUP;
		} else if (!g_variant_is_of_type(data, G_VARIANT_TYPE("(tt)"))) {
			return SR_ERR_ARG;
		} else {
			if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(vdivs))) < 0)
				return SR_ERR_ARG;
			devc->cctl[ch] = (devc->cctl[ch] & 0xCC) | vdivs_map[idx];
		}
		break;
	case SR_CONF_COUPLING:
		if (ch == -1) {
			return SR_ERR_CHANNEL_GROUP;
		} else {
			if ((idx = std_str_idx(data, ARRAY_AND_SIZE(coupling))) < 0)
				return SR_ERR_ARG;
			devc->cctl[ch] = (devc->cctl[ch] & 0xF3) | coupling_map[idx];
		}
		break;
	case SR_CONF_PROBE_FACTOR:
		if (ch == -1) {
			return SR_ERR_CHANNEL_GROUP;
		} else {
			u = g_variant_get_uint64(data);
			if (!u)
				return SR_ERR_ARG;
			else
				devc->probe[ch] = u;
		}
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_channel_set(const struct sr_dev_inst *sdi,
	struct sr_channel *ch, unsigned int changes)
{
	struct dev_context *devc = sdi->priv;
	uint8_t v;

	if (changes & SR_CHANNEL_SET_ENABLED) {
		if (ch->enabled) {
			v = devc->channel | (1 << ch->index);
			if (v & (v - 1))
				return SR_ERR;
			devc->channel = v;
			devc->enabled_channel->data = ch;
		} else {
			devc->channel &= ~(1 << ch->index);
		}
	}
	return SR_OK;
}

static int config_commit(const struct sr_dev_inst *sdi)
{
	uint8_t state = hung_chang_dso_2100_read_mbox(sdi->conn, 0.02);
	int ret;

	switch (state) {
	case 0x03:
	case 0x14:
	case 0x21:
		/* we will travel the complete config path on our way to state 1 */
		break;
	case 0x00:
		state = 0x01;
		/* Fallthrough */
	default:
		ret = hung_chang_dso_2100_move_to(sdi, 1);
		if (ret != SR_OK)
			return ret;
		/* Fallthrough */
	case 0x01:
		hung_chang_dso_2100_write_mbox(sdi->conn, 4);
	}
	ret = hung_chang_dso_2100_move_to(sdi, 1);
	if (ret != SR_OK)
		return ret;
	return hung_chang_dso_2100_move_to(sdi, state);
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	GSList *l;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
	case SR_CONF_DEVICE_OPTIONS:
		break;
	case SR_CONF_SAMPLERATE:
	case SR_CONF_TRIGGER_SOURCE:
	case SR_CONF_TRIGGER_SLOPE:
	case SR_CONF_BUFFERSIZE:
		if (!sdi || cg)
			return SR_ERR_NA;
		break;
	case SR_CONF_VDIV:
	case SR_CONF_COUPLING:
		if (!sdi)
			return SR_ERR_NA;
		if (!cg)
			return SR_ERR_CHANNEL_GROUP;
		l = g_slist_find(sdi->channel_groups, cg);
		if (!l)
			return SR_ERR_ARG;
		break;
	default:
		return SR_ERR_NA;
	}

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, NULL);
	case SR_CONF_DEVICE_OPTIONS:
		if (!cg)
			return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
		*data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
		break;
	case SR_CONF_SAMPLERATE:
		*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
		break;
	case SR_CONF_TRIGGER_SOURCE:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_sources));
		break;
	case SR_CONF_TRIGGER_SLOPE:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_slopes));
		break;
	case SR_CONF_BUFFERSIZE:
		*data = std_gvar_array_u64(ARRAY_AND_SIZE(buffersizes));
		break;
	case SR_CONF_VDIV:
		*data = std_gvar_tuple_array(ARRAY_AND_SIZE(vdivs));
		break;
	case SR_CONF_COUPLING:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(coupling));
		break;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc = sdi->priv;
	int ret;

	if (devc->channel) {
		static const float res_array[] = {0.5, 1, 2, 5};
		static const uint8_t relays[] = {100, 10, 10, 1};
		devc->factor = devc->probe[devc->channel - 1] / 32.0;
		devc->factor *= res_array[devc->cctl[devc->channel - 1] & 0x03];
		devc->factor /= relays[(devc->cctl[devc->channel - 1] >> 4) & 0x03];
	}
	devc->frame = 0;
	devc->state_known = TRUE;
	devc->step = 0;
	devc->adc2 = FALSE;
	devc->retries = MAX_RETRIES;

	ret = hung_chang_dso_2100_move_to(sdi, 0x21);
	if (ret != SR_OK)
		return ret;

	std_session_send_df_header(sdi);

	sr_session_source_add(sdi->session, -1, 0, 8,
			      hung_chang_dso_2100_poll, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	std_session_send_df_end(sdi);
	sr_session_source_remove(sdi->session, -1);
	hung_chang_dso_2100_move_to(sdi, 1);

	return SR_OK;
}

static struct sr_dev_driver hung_chang_dso_2100_driver_info = {
	.name = "hung-chang-dso-2100",
	.longname = "Hung-Chang DSO-2100",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = dev_clear,
	.config_get = config_get,
	.config_set = config_set,
	.config_channel_set = config_channel_set,
	.config_commit = config_commit,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(hung_chang_dso_2100_driver_info);
Commit	Line	Data
05ac4a98 DG	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2015 Daniel Glöckner <daniel-gl@gmx.net>
	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
6ec6c43b	20	#include <config.h>
c9404469 DG	21	#include <ieee1284.h>
c9404469 DG	22	#include <string.h>
05ac4a98 DG	23	#include "protocol.h"
05ac4a98 DG	24
c9404469 DG	25	static const uint32_t scanopts[] = {
	26	SR_CONF_CONN,
	27	};
	28
	29	static const uint32_t drvopts[] = {
	30	SR_CONF_OSCILLOSCOPE,
	31	};
	32
	33	static const uint32_t devopts[] = {
	34	SR_CONF_CONN \| SR_CONF_GET,
	35	SR_CONF_LIMIT_FRAMES \| SR_CONF_GET \| SR_CONF_SET,
	36	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	37	SR_CONF_TRIGGER_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	38	SR_CONF_TRIGGER_SLOPE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	39	SR_CONF_BUFFERSIZE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	40	};
	41
6b82c3e5	42	static const uint32_t devopts_cg[] = {
c9404469 DG	43	SR_CONF_VDIV \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	44	SR_CONF_COUPLING \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	45	SR_CONF_PROBE_FACTOR \| SR_CONF_GET \| SR_CONF_SET,
	46	};
	47
	48	static const uint64_t samplerates[] = {
	49	SR_MHZ(100), SR_MHZ(50), SR_MHZ(25), SR_MHZ(20),
	50	SR_MHZ(10), SR_MHZ(5), SR_KHZ(2500), SR_MHZ(2),
	51	SR_MHZ(1), SR_KHZ(500), SR_KHZ(250), SR_KHZ(200),
	52	SR_KHZ(100), SR_KHZ(50), SR_KHZ(25), SR_KHZ(20),
	53	SR_KHZ(10), SR_KHZ(5), SR_HZ(2500), SR_KHZ(2),
	54	SR_KHZ(1), SR_HZ(500), SR_HZ(250), SR_HZ(200),
	55	SR_HZ(100), SR_HZ(50), SR_HZ(25), SR_HZ(20)
	56	};
	57
	58	/* must be in sync with readout_steps[] in protocol.c */
	59	static const uint64_t buffersizes[] = {
	60	2 * 500, 3 * 500, 4 * 500, 5 * 500,
	61	6 * 500, 7 * 500, 8 * 500, 9 * 500, 10 * 500,
	62	12 * 500 - 2, 14 * 500 - 2, 16 * 500 - 2,
	63	18 * 500 - 2, 20 * 500 - 2, 10240 - 2
	64	};
	65
	66	static const uint64_t vdivs[][2] = {
	67	{ 10, 1000 },
	68	{ 20, 1000 },
	69	{ 50, 1000 },
	70	{ 100, 1000 },
	71	{ 200, 1000 },
	72	{ 500, 1000 },
	73	{ 1, 1 },
	74	{ 2, 1 },
	75	{ 5, 1 },
	76	};
	77
	78	/* Bits 4 and 5 enable relays that add /10 filters to the chain
	79	* Bits 0 and 1 select an output from a resistor array */
	80	static const uint8_t vdivs_map[] = {
	81	0x01, 0x02, 0x03, 0x21, 0x22, 0x23, 0x31, 0x32, 0x33
	82	};
	83
	84
	85	static const char *trigger_sources[] = {
	86	"A", "B", "EXT"
	87	};
	88
	89	static const uint8_t trigger_sources_map[] = {
	90	0x00, 0x80, 0x40
	91	};
	92
	93	static const char *trigger_slopes[] = {
	94	"f", "r"
	95	};
	96
	97	static const char *coupling[] = {
	98	"DC", "AC", "GND"
	99	};
	100
	101	static const uint8_t coupling_map[] = {
	102	0x00, 0x08, 0x04
	103	};
	104
15a5bfe4	105	static GSList scan_port(GSList devices, struct parport *port)
05ac4a98	106	{
c9404469 DG	107	struct sr_dev_inst *sdi;
	108	struct sr_channel *ch;
	109	struct sr_channel_group *cg;
	110	struct dev_context *devc;
c9404469	111	int i;
05ac4a98	112
c9404469 DG	113	if (ieee1284_open(port, 0, &i) != E1284_OK) {
	114	sr_err("Can't open parallel port %s", port->name);
	115	goto fail1;
	116	}
05ac4a98	117
c9404469 DG	118	if ((i & (CAP1284_RAW \| CAP1284_BYTE)) != (CAP1284_RAW \| CAP1284_BYTE)) {
	119	sr_err("Parallel port %s does not provide low-level bidirection access",
	120	port->name);
	121	goto fail2;
	122	}
	123
	124	if (ieee1284_claim(port) != E1284_OK) {
	125	sr_err("Parallel port %s already in use", port->name);
	126	goto fail2;
	127	}
	128
	129	if (!hung_chang_dso_2100_check_id(port))
	130	goto fail3;
	131
	132	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	133	sdi->status = SR_ST_INACTIVE;
	134	sdi->vendor = g_strdup("Hung-Chang");
	135	sdi->model = g_strdup("DSO-2100");
c9404469 DG	136	sdi->inst_type = 0; /* FIXME */
	137	sdi->conn = port;
	138	ieee1284_ref(port);
	139
	140	for (i = 0; i < NUM_CHANNELS; i++) {
	141	cg = g_malloc0(sizeof(struct sr_channel_group));
	142	cg->name = g_strdup(trigger_sources[i]);
	143	ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, FALSE, trigger_sources[i]);
	144	cg->channels = g_slist_append(cg->channels, ch);
	145	sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
	146	}
	147
	148	devc = g_malloc0(sizeof(struct dev_context));
	149	devc->enabled_channel = g_slist_append(NULL, NULL);
	150	devc->channel = 0;
	151	devc->rate = 0;
	152	devc->probe[0] = 10;
	153	devc->probe[1] = 10;
	154	devc->cctl[0] = 0x31; /* 1V/div, DC coupling, trigger on channel A*/
	155	devc->cctl[1] = 0x31; /* 1V/div, DC coupling, no tv sync trigger */
	156	devc->edge = 0;
	157	devc->tlevel = 0x80;
	158	devc->pos[0] = 0x80;
	159	devc->pos[1] = 0x80;
	160	devc->offset[0] = 0x80;
	161	devc->offset[1] = 0x80;
	162	devc->gain[0] = 0x80;
	163	devc->gain[1] = 0x80;
	164	devc->frame_limit = 0;
	165	devc->last_step = 0; /* buffersize = 1000 */
	166	sdi->priv = devc;
	167
c9404469 DG	168	devices = g_slist_append(devices, sdi);
	169
	170	fail3:
	171	ieee1284_release(port);
	172	fail2:
	173	ieee1284_close(port);
	174	fail1:
	175	return devices;
	176	}
	177
	178	static GSList scan(struct sr_dev_driver di, GSList *options)
	179	{
	180	struct parport_list ports;
	181	struct sr_config *src;
	182	const char *conn = NULL;
	183	GSList devices, option;
	184	gboolean port_found;
	185	int i;
	186
	187
	188	for (option = options; option; option = option->next) {
	189	src = option->data;
	190	if (src->key == SR_CONF_CONN) {
	191	conn = g_variant_get_string(src->data, NULL);
	192	break;
	193	}
	194	}
	195
	196	if (!conn)
	197	return NULL;
05ac4a98	198
c9404469 DG	199	if (ieee1284_find_ports(&ports, 0) != E1284_OK)
	200	return NULL;
	201
	202	devices = NULL;
	203	port_found = FALSE;
	204	for (i = 0; i < ports.portc; i++)
	205	if (!strcmp(ports.portv[i]->name, conn)) {
	206	port_found = TRUE;
15a5bfe4	207	devices = scan_port(devices, ports.portv[i]);
c9404469 DG	208	}
	209
	210	if (!port_found) {
	211	sr_err("Parallel port %s not found. Valid names are:", conn);
	212	for (i = 0; i < ports.portc; i++)
	213	sr_err("\t%s", ports.portv[i]->name);
	214	}
	215
	216	ieee1284_free_ports(&ports);
05ac4a98	217
15a5bfe4	218	return std_scan_complete(di, devices);
05ac4a98 DG	219	}
05ac4a98 DG	220
3553451f	221	static void clear_helper(struct dev_context *devc)
c9404469	222	{
c9404469 DG	223	g_slist_free(devc->enabled_channel);
	224	}
	225
05ac4a98 DG	226	static int dev_clear(const struct sr_dev_driver *di)
05ac4a98 DG	227	{
c9404469 DG	228	struct drv_context *drvc = di->context;
	229	struct sr_dev_inst *sdi;
	230	GSList *l;
	231
	232	if (drvc) {
	233	for (l = drvc->instances; l; l = l->next) {
	234	sdi = l->data;
	235	ieee1284_unref(sdi->conn);
	236	}
	237	}
	238
3553451f	239	return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
05ac4a98 DG	240	}
	241
	242	static int dev_open(struct sr_dev_inst *sdi)
	243	{
c9404469 DG	244	struct dev_context *devc = sdi->priv;
	245	int i;
	246
c9404469 DG	247	if (ieee1284_open(sdi->conn, 0, &i) != E1284_OK)
c9404469 DG	248	goto fail1;
05ac4a98	249
c9404469 DG	250	if (ieee1284_claim(sdi->conn) != E1284_OK)
	251	goto fail2;
	252
	253	if (ieee1284_data_dir(sdi->conn, 1) != E1284_OK)
	254	goto fail3;
	255
	256	if (hung_chang_dso_2100_move_to(sdi, 1))
	257	goto fail3;
	258
	259	devc->samples = g_try_malloc(1000 * sizeof(*devc->samples));
	260	if (!devc->samples)
	261	goto fail3;
05ac4a98	262
05ac4a98	263	return SR_OK;
c9404469 DG	264
	265	fail3:
	266	hung_chang_dso_2100_reset_port(sdi->conn);
	267	ieee1284_release(sdi->conn);
	268	fail2:
	269	ieee1284_close(sdi->conn);
	270	fail1:
	271	return SR_ERR;
05ac4a98 DG	272	}
	273
	274	static int dev_close(struct sr_dev_inst *sdi)
	275	{
c9404469	276	struct dev_context *devc = sdi->priv;
05ac4a98	277
c9404469 DG	278	g_free(devc->samples);
	279	hung_chang_dso_2100_reset_port(sdi->conn);
	280	ieee1284_release(sdi->conn);
	281	ieee1284_close(sdi->conn);
093e1cba	282
05ac4a98 DG	283	return SR_OK;
	284	}
	285
dd7a72ea UH	286	static int config_get(uint32_t key, GVariant **data,
dd7a72ea UH	287	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
05ac4a98	288	{
c9404469 DG	289	struct dev_context *devc = sdi->priv;
c9404469 DG	290	struct parport *port;
697fb6dd	291	int idx, ch = -1;
05ac4a98	292
c9404469 DG	293	if (cg) /* sr_config_get will validate cg using config_list */
c9404469 DG	294	ch = ((struct sr_channel *)cg->channels->data)->index;
05ac4a98	295
05ac4a98	296	switch (key) {
c9404469 DG	297	case SR_CONF_CONN:
	298	port = sdi->conn;
	299	*data = g_variant_new_string(port->name);
	300	break;
	301	case SR_CONF_LIMIT_FRAMES:
	302	*data = g_variant_new_uint64(devc->frame_limit);
	303	break;
	304	case SR_CONF_SAMPLERATE:
	305	*data = g_variant_new_uint64(samplerates[devc->rate]);
	306	break;
	307	case SR_CONF_TRIGGER_SOURCE:
697fb6dd UH	308	if ((idx = std_u8_idx_s(devc->cctl[0] & 0xC0, ARRAY_AND_SIZE(trigger_sources_map))) < 0)
	309	return SR_ERR_BUG;
	310	*data = g_variant_new_string(trigger_sources[idx]);
c9404469 DG	311	break;
	312	case SR_CONF_TRIGGER_SLOPE:
	313	if (devc->edge >= ARRAY_SIZE(trigger_slopes))
a9010323	314	return SR_ERR;
c9404469 DG	315	else
	316	*data = g_variant_new_string(trigger_slopes[devc->edge]);
	317	break;
	318	case SR_CONF_BUFFERSIZE:
	319	*data = g_variant_new_uint64(buffersizes[devc->last_step]);
	320	break;
	321	case SR_CONF_VDIV:
	322	if (ch == -1) {
a9010323	323	return SR_ERR_CHANNEL_GROUP;
c9404469	324	} else {
697fb6dd UH	325	if ((idx = std_u8_idx_s(devc->cctl[ch] & 0x33, ARRAY_AND_SIZE(vdivs_map))) < 0)
	326	return SR_ERR_BUG;
	327	*data = g_variant_new("(tt)", vdivs[idx][0], vdivs[idx][1]);
c9404469 DG	328	}
	329	break;
	330	case SR_CONF_COUPLING:
	331	if (ch == -1) {
a9010323	332	return SR_ERR_CHANNEL_GROUP;
c9404469	333	} else {
697fb6dd UH	334	if ((idx = std_u8_idx_s(devc->cctl[ch] & 0x0C, ARRAY_AND_SIZE(coupling_map))) < 0)
	335	return SR_ERR_BUG;
	336	*data = g_variant_new_string(coupling[idx]);
c9404469 DG	337	}
	338	break;
	339	case SR_CONF_PROBE_FACTOR:
	340	if (ch == -1)
a9010323	341	return SR_ERR_CHANNEL_GROUP;
c9404469 DG	342	else
	343	*data = g_variant_new_uint64(devc->probe[ch]);
	344	break;
05ac4a98	345	default:
a9010323	346	return SR_ERR_NA;
05ac4a98 DG	347	}
05ac4a98 DG	348
a9010323	349	return SR_OK;
05ac4a98 DG	350	}
05ac4a98 DG	351
dd7a72ea UH	352	static int config_set(uint32_t key, GVariant *data,
dd7a72ea UH	353	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
05ac4a98	354	{
c9404469	355	struct dev_context *devc = sdi->priv;
697fb6dd UH	356	int idx, ch = -1;
697fb6dd UH	357	uint64_t u;
05ac4a98	358
c9404469 DG	359	if (cg) /* sr_config_set will validate cg using config_list */
c9404469 DG	360	ch = ((struct sr_channel *)cg->channels->data)->index;
05ac4a98	361
05ac4a98	362	switch (key) {
c9404469 DG	363	case SR_CONF_LIMIT_FRAMES:
	364	devc->frame_limit = g_variant_get_uint64(data);
	365	break;
	366	case SR_CONF_SAMPLERATE:
697fb6dd	367	if ((idx = std_u64_idx(data, ARRAY_AND_SIZE(samplerates))) < 0)
a9010323	368	return SR_ERR_ARG;
697fb6dd	369	devc->rate = idx;
c9404469 DG	370	break;
c9404469 DG	371	case SR_CONF_TRIGGER_SOURCE:
697fb6dd	372	if ((idx = std_str_idx(data, ARRAY_AND_SIZE(trigger_sources))) < 0)
a9010323	373	return SR_ERR_ARG;
697fb6dd	374	devc->cctl[0] = (devc->cctl[0] & 0x3F) \| trigger_sources_map[idx];
c9404469 DG	375	break;
c9404469 DG	376	case SR_CONF_TRIGGER_SLOPE:
697fb6dd	377	if ((idx = std_str_idx(data, ARRAY_AND_SIZE(trigger_slopes))) < 0)
a9010323	378	return SR_ERR_ARG;
697fb6dd	379	devc->edge = idx;
c9404469 DG	380	break;
c9404469 DG	381	case SR_CONF_BUFFERSIZE:
697fb6dd	382	if ((idx = std_u64_idx(data, ARRAY_AND_SIZE(buffersizes))) < 0)
a9010323	383	return SR_ERR_ARG;
697fb6dd	384	devc->last_step = idx;
c9404469 DG	385	break;
	386	case SR_CONF_VDIV:
	387	if (ch == -1) {
a9010323	388	return SR_ERR_CHANNEL_GROUP;
c9404469	389	} else if (!g_variant_is_of_type(data, G_VARIANT_TYPE("(tt)"))) {
a9010323	390	return SR_ERR_ARG;
c9404469	391	} else {
697fb6dd	392	if ((idx = std_u64_tuple_idx(data, ARRAY_AND_SIZE(vdivs))) < 0)
a9010323	393	return SR_ERR_ARG;
697fb6dd	394	devc->cctl[ch] = (devc->cctl[ch] & 0xCC) \| vdivs_map[idx];
c9404469 DG	395	}
	396	break;
	397	case SR_CONF_COUPLING:
	398	if (ch == -1) {
a9010323	399	return SR_ERR_CHANNEL_GROUP;
c9404469	400	} else {
697fb6dd	401	if ((idx = std_str_idx(data, ARRAY_AND_SIZE(coupling))) < 0)
a9010323	402	return SR_ERR_ARG;
697fb6dd	403	devc->cctl[ch] = (devc->cctl[ch] & 0xF3) \| coupling_map[idx];
c9404469 DG	404	}
	405	break;
	406	case SR_CONF_PROBE_FACTOR:
	407	if (ch == -1) {
a9010323	408	return SR_ERR_CHANNEL_GROUP;
c9404469 DG	409	} else {
	410	u = g_variant_get_uint64(data);
	411	if (!u)
a9010323	412	return SR_ERR_ARG;
c9404469 DG	413	else
	414	devc->probe[ch] = u;
	415	}
	416	break;
05ac4a98	417	default:
a9010323	418	return SR_ERR_NA;
05ac4a98 DG	419	}
05ac4a98 DG	420
a9010323	421	return SR_OK;
05ac4a98 DG	422	}
05ac4a98 DG	423
c9404469	424	static int config_channel_set(const struct sr_dev_inst *sdi,
dd7a72ea	425	struct sr_channel *ch, unsigned int changes)
c9404469 DG	426	{
	427	struct dev_context *devc = sdi->priv;
	428	uint8_t v;
	429
	430	if (changes & SR_CHANNEL_SET_ENABLED) {
	431	if (ch->enabled) {
	432	v = devc->channel \| (1 << ch->index);
	433	if (v & (v - 1))
	434	return SR_ERR;
	435	devc->channel = v;
	436	devc->enabled_channel->data = ch;
	437	} else {
	438	devc->channel &= ~(1 << ch->index);
	439	}
	440	}
	441	return SR_OK;
	442	}
	443
	444	static int config_commit(const struct sr_dev_inst *sdi)
05ac4a98	445	{
c9404469	446	uint8_t state = hung_chang_dso_2100_read_mbox(sdi->conn, 0.02);
05ac4a98 DG	447	int ret;
05ac4a98 DG	448
c9404469 DG	449	switch (state) {
	450	case 0x03:
	451	case 0x14:
	452	case 0x21:
	453	/* we will travel the complete config path on our way to state 1 */
	454	break;
	455	case 0x00:
	456	state = 0x01;
276d7b18	457	/* Fallthrough */
c9404469 DG	458	default:
	459	ret = hung_chang_dso_2100_move_to(sdi, 1);
	460	if (ret != SR_OK)
	461	return ret;
276d7b18	462	/* Fallthrough */
c9404469 DG	463	case 0x01:
	464	hung_chang_dso_2100_write_mbox(sdi->conn, 4);
	465	}
	466	ret = hung_chang_dso_2100_move_to(sdi, 1);
	467	if (ret != SR_OK)
	468	return ret;
	469	return hung_chang_dso_2100_move_to(sdi, state);
	470	}
	471
dd7a72ea UH	472	static int config_list(uint32_t key, GVariant **data,
dd7a72ea UH	473	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
c9404469	474	{
c9404469	475	GSList *l;
05ac4a98	476
05ac4a98	477	switch (key) {
e66d1892	478	case SR_CONF_SCAN_OPTIONS:
c9404469 DG	479	case SR_CONF_DEVICE_OPTIONS:
	480	break;
	481	case SR_CONF_SAMPLERATE:
	482	case SR_CONF_TRIGGER_SOURCE:
	483	case SR_CONF_TRIGGER_SLOPE:
	484	case SR_CONF_BUFFERSIZE:
	485	if (!sdi \|\| cg)
	486	return SR_ERR_NA;
	487	break;
	488	case SR_CONF_VDIV:
	489	case SR_CONF_COUPLING:
	490	if (!sdi)
	491	return SR_ERR_NA;
	492	if (!cg)
	493	return SR_ERR_CHANNEL_GROUP;
	494	l = g_slist_find(sdi->channel_groups, cg);
	495	if (!l)
	496	return SR_ERR_ARG;
	497	break;
05ac4a98 DG	498	default:
	499	return SR_ERR_NA;
	500	}
	501
c9404469 DG	502	switch (key) {
c9404469 DG	503	case SR_CONF_SCAN_OPTIONS:
e66d1892	504	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, NULL);
c9404469	505	case SR_CONF_DEVICE_OPTIONS:
e66d1892 UH	506	if (!cg)
e66d1892 UH	507	return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
53012da6	508	*data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg));
c9404469 DG	509	break;
c9404469 DG	510	case SR_CONF_SAMPLERATE:
53012da6	511	*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
c9404469 DG	512	break;
c9404469 DG	513	case SR_CONF_TRIGGER_SOURCE:
53012da6	514	*data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_sources));
c9404469 DG	515	break;
c9404469 DG	516	case SR_CONF_TRIGGER_SLOPE:
53012da6	517	*data = g_variant_new_strv(ARRAY_AND_SIZE(trigger_slopes));
c9404469 DG	518	break;
c9404469 DG	519	case SR_CONF_BUFFERSIZE:
53012da6	520	*data = std_gvar_array_u64(ARRAY_AND_SIZE(buffersizes));
c9404469 DG	521	break;
c9404469 DG	522	case SR_CONF_VDIV:
58ffcf97	523	*data = std_gvar_tuple_array(ARRAY_AND_SIZE(vdivs));
c9404469 DG	524	break;
c9404469 DG	525	case SR_CONF_COUPLING:
53012da6	526	*data = g_variant_new_strv(ARRAY_AND_SIZE(coupling));
c9404469 DG	527	break;
	528	}
	529
	530	return SR_OK;
05ac4a98 DG	531	}
05ac4a98 DG	532
695dc859	533	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
05ac4a98	534	{
c9404469 DG	535	struct dev_context *devc = sdi->priv;
c9404469 DG	536	int ret;
05ac4a98	537
c9404469 DG	538	if (devc->channel) {
	539	static const float res_array[] = {0.5, 1, 2, 5};
	540	static const uint8_t relays[] = {100, 10, 10, 1};
	541	devc->factor = devc->probe[devc->channel - 1] / 32.0;
	542	devc->factor *= res_array[devc->cctl[devc->channel - 1] & 0x03];
	543	devc->factor /= relays[(devc->cctl[devc->channel - 1] >> 4) & 0x03];
	544	}
	545	devc->frame = 0;
c9404469 DG	546	devc->state_known = TRUE;
	547	devc->step = 0;
	548	devc->adc2 = FALSE;
	549	devc->retries = MAX_RETRIES;
	550
	551	ret = hung_chang_dso_2100_move_to(sdi, 0x21);
	552	if (ret != SR_OK)
	553	return ret;
	554
bee2b016	555	std_session_send_df_header(sdi);
c9404469	556
b165a242	557	sr_session_source_add(sdi->session, -1, 0, 8,
c9404469	558	hung_chang_dso_2100_poll, (void *)sdi);
05ac4a98 DG	559
	560	return SR_OK;
	561	}
	562
d2f7c417	563	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
05ac4a98	564	{
bee2b016	565	std_session_send_df_end(sdi);
b165a242	566	sr_session_source_remove(sdi->session, -1);
c9404469	567	hung_chang_dso_2100_move_to(sdi, 1);
05ac4a98 DG	568
	569	return SR_OK;
	570	}
	571
dd5c48a6	572	static struct sr_dev_driver hung_chang_dso_2100_driver_info = {
05ac4a98 DG	573	.name = "hung-chang-dso-2100",
	574	.longname = "Hung-Chang DSO-2100",
	575	.api_version = 1,
c2fdcc25	576	.init = std_init,
700d6b64	577	.cleanup = std_cleanup,
05ac4a98	578	.scan = scan,
c01bf34c	579	.dev_list = std_dev_list,
05ac4a98 DG	580	.dev_clear = dev_clear,
	581	.config_get = config_get,
	582	.config_set = config_set,
c9404469 DG	583	.config_channel_set = config_channel_set,
c9404469 DG	584	.config_commit = config_commit,
05ac4a98 DG	585	.config_list = config_list,
	586	.dev_open = dev_open,
	587	.dev_close = dev_close,
	588	.dev_acquisition_start = dev_acquisition_start,
	589	.dev_acquisition_stop = dev_acquisition_stop,
	590	.context = NULL,
	591	};
dd5c48a6	592	SR_REGISTER_DEV_DRIVER(hung_chang_dso_2100_driver_info);