[libsigrok.git] / src / hardware / korad-kaxxxxp / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
 * Copyright (C) 2018-2019 Frank Stettner <frank-stettner@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 <ctype.h>

#include "protocol.h"

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

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

static const uint32_t devopts[] = {
	SR_CONF_CONN | SR_CONF_GET,
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_VOLTAGE | SR_CONF_GET,
	SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_CURRENT | SR_CONF_GET,
	SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_REGULATION | SR_CONF_GET,
	SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
};

/* Voltage and current ranges. Values are: Min, max, step. */
static const double volts_30[] = { 0, 31, 0.01, };
static const double volts_60[] = { 0, 61, 0.01, };
static const double amps_3[] = { 0, 3.1, 0.001, };
static const double amps_5[] = { 0, 5.1, 0.001, };

static const struct korad_kaxxxxp_model models[] = {
	/* Vendor, model name, ID reply, channels, voltage, current, quirks. */
	{"Korad", "KA3005P", "", 1, volts_30, amps_5,
		KORAD_QUIRK_ID_TRAILING},
	{"Korad", "KD3005P", "", 1, volts_30, amps_5, 0},
	{"Korad", "KD6005P", "", 1, volts_60, amps_5, 0},
	{"RND", "KA3005P", "RND 320-KA3005P", 1, volts_30, amps_5,
		KORAD_QUIRK_ID_OPT_VERSION},
	{"RND", "KD3005P", "RND 320-KD3005P", 1, volts_30, amps_5,
		KORAD_QUIRK_ID_OPT_VERSION},
	{"Stamos Soldering", "S-LS-31", "", 1, volts_30, amps_5,
		KORAD_QUIRK_ID_NO_VENDOR},
	{"Tenma", "72-2535", "", 1, volts_30, amps_3, 0},
	{"Tenma", "72-2540", "", 1, volts_30, amps_5, 0},
	{"Tenma", "72-2550", "", 1, volts_60, amps_3, 0},
	{"Tenma", "72-2710", "", 1, volts_30, amps_5, 0},
	{"Velleman", "LABPS3005D", "", 1, volts_30, amps_5,
		KORAD_QUIRK_LABPS_OVP_EN},
	{"Velleman", "PS3005D", "", 1, volts_30, amps_5, 0},
	ALL_ZERO
};

/*
 * Bump this when adding new models[] above. Make sure the text buffer
 * for the ID response can hold the longest sequence that we expect in
 * the field which consists of: vendor + model [ + version ][ + serno ].
 * Don't be too generous here, the maximum receive buffer size affects
 * the timeout within which the first response character is expected.
 */
static const size_t id_text_buffer_size = 48;

/*
 * Check whether the device's "*IDN?" response matches a supported model.
 * The caller already stripped off the optional serial number.
 */
static gboolean model_matches(const struct korad_kaxxxxp_model *model,
	const char *id_text)
{
	gboolean matches;
	gboolean opt_version, skip_vendor, accept_trail;
	const char *want;

	if (!model)
		return FALSE;

	/*
	 * When the models[] entry contains a specific response text,
	 * then expect to see this very text in literal form. This
	 * lets the driver map weird and untypical responses to a
	 * specific set of display texts for vendor and model names.
	 * Accept an optionally trailing version if models[] says so.
	 */
	if (model->id && model->id[0]) {
		opt_version = model->quirks & KORAD_QUIRK_ID_OPT_VERSION;
		if (!opt_version) {
			matches = g_strcmp0(id_text, model->id) == 0;
			if (!matches)
				return FALSE;
			sr_dbg("Matches expected ID text: '%s'.", model->id);
			return TRUE;
		}
		matches = g_str_has_prefix(id_text, model->id);
		if (!matches)
			return FALSE;
		id_text += strlen(model->id);
		while (isspace((int)*id_text))
			id_text++;
		if (*id_text == 'V') {
			id_text++;
			while (*id_text == '.' || isdigit((int)*id_text))
				id_text++;
			while (isspace((int)*id_text))
				id_text++;
		}
		if (*id_text)
			return FALSE;
		sr_dbg("Matches expected ID text [vers]: '%s'.", model->id);
		return TRUE;
	}

	/*
	 * A more generic approach which covers most devices: Check
	 * for the very vendor and model names which also are shown
	 * to users (the display texts). Weakened to match responses
	 * more widely: Case insensitive checks, optional whitespace
	 * in responses, optional version details. Optional trailing
	 * garbage. Optional omission of the vendor name. Shall match
	 * all the devices which were individually listed in earlier
	 * implementations of the driver, and shall also match firmware
	 * versions that were not listed before.
	 */
	skip_vendor = model->quirks & KORAD_QUIRK_ID_NO_VENDOR;
	accept_trail = model->quirks & KORAD_QUIRK_ID_TRAILING;
	if (!skip_vendor) {
		want = model->vendor;
		matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
		if (!matches)
			return FALSE;
		id_text += strlen(want);
		while (isspace((int)*id_text))
			id_text++;
	}
	want = model->name;
	matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
	if (!matches)
		return FALSE;
	id_text += strlen(want);
	while (isspace((int)*id_text))
		id_text++;
	if (*id_text == 'V') {
		/* TODO Isolate and (also) return version details? */
		id_text++;
		while (*id_text == '.' || isdigit((int)*id_text))
			id_text++;
		while (isspace((int)*id_text))
			id_text++;
	}
	if (accept_trail) {
		/*
		 * TODO Determine how many non-printables to accept here
		 * and how strict to check for "known" garbage variants.
		 */
		switch (*id_text) {
		case '\x01':
		case '\xbc':
			id_text++;
			break;
		case '\x00':
			/* EMPTY */
			break;
		default:
			return FALSE;
		}
	}
	if (*id_text)
		return FALSE;
	sr_dbg("Matches generic '[vendor] model [vers] [trail]' pattern.");
	return TRUE;
}

/* Lookup a model from an ID response text. */
static const struct korad_kaxxxxp_model *model_lookup(const char *id_text)
{
	size_t idx;
	const struct korad_kaxxxxp_model *check;

	if (!id_text || !*id_text)
		return NULL;
	sr_dbg("Looking up: [%s].", id_text);

	for (idx = 0; idx < ARRAY_SIZE(models); idx++) {
		check = &models[idx];
		if (!check->name || !check->name[0])
			continue;
		if (!model_matches(check, id_text))
			continue;
		sr_dbg("Found: [%s] [%s]", check->vendor, check->name);
		return check;
	}
	sr_dbg("Not found");

	return NULL;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	static const char *serno_prefix = " SN:";

	struct dev_context *devc;
	GSList *l;
	struct sr_dev_inst *sdi;
	struct sr_config *src;
	const char *conn, *serialcomm;
	const char *force_detect;
	struct sr_serial_dev_inst *serial;
	char reply[50];
	int ret;
	const struct korad_kaxxxxp_model *model;
	size_t len;
	char *serno;

	conn = NULL;
	serialcomm = NULL;
	force_detect = 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;
		case SR_CONF_FORCE_DETECT:
			force_detect = g_variant_get_string(src->data, NULL);
			break;
		default:
			sr_err("Unknown option %d, skipping.", src->key);
			break;
		}
	}

	if (!conn)
		return NULL;
	if (!serialcomm)
		serialcomm = "9600/8n1";
	if (force_detect && !*force_detect)
		force_detect = NULL;

	serial = sr_serial_dev_inst_new(conn, serialcomm);
	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return NULL;

	/* Communicate the identification request. */
	len = id_text_buffer_size;
	if (len > sizeof(reply) - 1)
		len = sizeof(reply) - 1;
	sr_dbg("Want max %zu bytes.", len);

	ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
	if (ret < 0)
		return NULL;

	ret = korad_kaxxxxp_read_chars(serial, len, reply);
	if (ret < 0)
		return NULL;
	sr_dbg("Received: %d, %s", ret, reply);

	/*
	 * Isolate the optional serial number at the response's end.
	 * Lookup the response's model ID in the list of known models.
	 */
	serno = g_strrstr(reply, serno_prefix);
	if (serno) {
		*serno = '\0';
		serno += strlen(serno_prefix);
	}

	model = model_lookup(reply);
	if (!model && force_detect) {
		sr_warn("Could not find model ID '%s', trying '%s'.",
			reply, force_detect);
		model = model_lookup(force_detect);
		if (model)
			sr_info("Found replacement, using it instead.");
	}
	if (!model) {
		sr_err("Unsupported model ID '%s', aborting.", reply);
		return NULL;
	}
	sr_dbg("Found: %s %s (idx %zu).", model->vendor, model->name,
		model - &models[0]);

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup(model->vendor);
	sdi->model = g_strdup(model->name);
	if (serno)
		sdi->serial_num = g_strdup(serno);
	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = serial;
	sdi->connection_id = g_strdup(conn);

	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");

	devc = g_malloc0(sizeof(struct dev_context));
	sr_sw_limits_init(&devc->limits);
	g_mutex_init(&devc->rw_mutex);
	devc->model = model;
	devc->req_sent_at = 0;
	devc->cc_mode_1_changed = FALSE;
	devc->cc_mode_2_changed = FALSE;
	devc->output_enabled_changed = FALSE;
	devc->ocp_enabled_changed = FALSE;
	devc->ovp_enabled_changed = FALSE;
	sdi->priv = devc;

	/* Get current status of device. */
	if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
		goto exit_err;

	serial_close(serial);

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

exit_err:
	sr_dev_inst_free(sdi);
	g_free(devc);
	sr_dbg("Scan failed.");

	return NULL;
}

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 || !data)
		return SR_ERR_ARG;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
	case SR_CONF_LIMIT_MSEC:
		return sr_sw_limits_config_get(&devc->limits, key, data);
	case SR_CONF_CONN:
		*data = g_variant_new_string(sdi->connection_id);
		break;
	case SR_CONF_VOLTAGE:
		korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
		*data = g_variant_new_double(devc->voltage);
		break;
	case SR_CONF_VOLTAGE_TARGET:
		korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
		*data = g_variant_new_double(devc->voltage_target);
		break;
	case SR_CONF_CURRENT:
		korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
		*data = g_variant_new_double(devc->current);
		break;
	case SR_CONF_CURRENT_LIMIT:
		korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
		*data = g_variant_new_double(devc->current_limit);
		break;
	case SR_CONF_ENABLED:
		korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
		*data = g_variant_new_boolean(devc->output_enabled);
		break;
	case SR_CONF_REGULATION:
		/* Dual channel not supported. */
		korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
		*data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
		break;
	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
		korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
		*data = g_variant_new_boolean(devc->ocp_enabled);
		break;
	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
		korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
		*data = g_variant_new_boolean(devc->ovp_enabled);
		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;
	double dval;
	gboolean bval;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_MSEC:
	case SR_CONF_LIMIT_SAMPLES:
		return sr_sw_limits_config_set(&devc->limits, key, data);
	case SR_CONF_VOLTAGE_TARGET:
		dval = g_variant_get_double(data);
		if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
			return SR_ERR_ARG;
		devc->set_voltage_target = dval;
		if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
			return SR_ERR;
		break;
	case SR_CONF_CURRENT_LIMIT:
		dval = g_variant_get_double(data);
		if (dval < devc->model->current[0] || dval > devc->model->current[1])
			return SR_ERR_ARG;
		devc->set_current_limit = dval;
		if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
			return SR_ERR;
		break;
	case SR_CONF_ENABLED:
		bval = g_variant_get_boolean(data);
		/* Set always so it is possible turn off with sigrok-cli. */
		devc->set_output_enabled = bval;
		if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
			return SR_ERR;
		break;
	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
		bval = g_variant_get_boolean(data);
		devc->set_ocp_enabled = bval;
		if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
			return SR_ERR;
		break;
	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
		bval = g_variant_get_boolean(data);
		devc->set_ovp_enabled = bval;
		if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
			return SR_ERR;
		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;

	devc = (sdi) ? sdi->priv : NULL;

	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_VOLTAGE_TARGET:
		if (!devc || !devc->model)
			return SR_ERR_ARG;
		*data = std_gvar_min_max_step_array(devc->model->voltage);
		break;
	case SR_CONF_CURRENT_LIMIT:
		if (!devc || !devc->model)
			return SR_ERR_ARG;
		*data = std_gvar_min_max_step_array(devc->model->current);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	devc = (sdi) ? sdi->priv : NULL;
	if (devc)
		g_mutex_clear(&devc->rw_mutex);

	return std_serial_dev_close(sdi);
}

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

	devc = sdi->priv;

	sr_sw_limits_acquisition_start(&devc->limits);
	std_session_send_df_header(sdi);

	devc->req_sent_at = 0;
	serial = sdi->conn;
	serial_source_add(sdi->session, serial, G_IO_IN,
			KAXXXXP_POLL_INTERVAL_MS,
			korad_kaxxxxp_receive_data, (void *)sdi);

	return SR_OK;
}

static struct sr_dev_driver korad_kaxxxxp_driver_info = {
	.name = "korad-kaxxxxp",
	.longname = "Korad KAxxxxP",
	.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 = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = std_serial_dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);
Commit	Line	Data
e75ee7de HV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
2e129b8b	5	* Copyright (C) 2018-2019 Frank Stettner <frank-stettner@gmx.net>
e75ee7de HV	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 3 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
	21	#include <config.h>
349803b6 GS	22
	23	#include <ctype.h>
	24
e75ee7de HV	25	#include "protocol.h"
e75ee7de HV	26
d7083042 HV	27	static const uint32_t scanopts[] = {
	28	SR_CONF_CONN,
	29	SR_CONF_SERIALCOMM,
e37e301e	30	SR_CONF_FORCE_DETECT,
d7083042 HV	31	};
d7083042 HV	32
55fb76b3	33	static const uint32_t drvopts[] = {
55fb76b3 UH	34	SR_CONF_POWER_SUPPLY,
	35	};
	36
d7083042	37	static const uint32_t devopts[] = {
048250d0	38	SR_CONF_CONN \| SR_CONF_GET,
d7083042 HV	39	SR_CONF_CONTINUOUS,
	40	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	41	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
d7083042 HV	42	SR_CONF_VOLTAGE \| SR_CONF_GET,
	43	SR_CONF_VOLTAGE_TARGET \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	44	SR_CONF_CURRENT \| SR_CONF_GET,
	45	SR_CONF_CURRENT_LIMIT \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	46	SR_CONF_ENABLED \| SR_CONF_GET \| SR_CONF_SET,
b16d975a	47	SR_CONF_REGULATION \| SR_CONF_GET,
c40ed60f HV	48	SR_CONF_OVER_CURRENT_PROTECTION_ENABLED \| SR_CONF_GET \| SR_CONF_SET,
c40ed60f HV	49	SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED \| SR_CONF_GET \| SR_CONF_SET,
d7083042 HV	50	};
d7083042 HV	51
ecd4600b GS	52	/* Voltage and current ranges. Values are: Min, max, step. */
	53	static const double volts_30[] = { 0, 31, 0.01, };
	54	static const double volts_60[] = { 0, 61, 0.01, };
	55	static const double amps_3[] = { 0, 3.1, 0.001, };
	56	static const double amps_5[] = { 0, 5.1, 0.001, };
	57
16fc7ee2	58	static const struct korad_kaxxxxp_model models[] = {
c55adfa1	59	/* Vendor, model name, ID reply, channels, voltage, current, quirks. */
d241cc20 GS	60	{"Korad", "KA3005P", "", 1, volts_30, amps_5,
	61	KORAD_QUIRK_ID_TRAILING},
	62	{"Korad", "KD3005P", "", 1, volts_30, amps_5, 0},
	63	{"Korad", "KD6005P", "", 1, volts_60, amps_5, 0},
d32120c4 GS	64	{"RND", "KA3005P", "RND 320-KA3005P", 1, volts_30, amps_5,
	65	KORAD_QUIRK_ID_OPT_VERSION},
	66	{"RND", "KD3005P", "RND 320-KD3005P", 1, volts_30, amps_5,
	67	KORAD_QUIRK_ID_OPT_VERSION},
d241cc20 GS	68	{"Stamos Soldering", "S-LS-31", "", 1, volts_30, amps_5,
	69	KORAD_QUIRK_ID_NO_VENDOR},
	70	{"Tenma", "72-2535", "", 1, volts_30, amps_3, 0},
	71	{"Tenma", "72-2540", "", 1, volts_30, amps_5, 0},
	72	{"Tenma", "72-2550", "", 1, volts_60, amps_3, 0},
	73	{"Tenma", "72-2710", "", 1, volts_30, amps_5, 0},
	74	{"Velleman", "LABPS3005D", "", 1, volts_30, amps_5,
	75	KORAD_QUIRK_LABPS_OVP_EN},
	76	{"Velleman", "PS3005D", "", 1, volts_30, amps_5, 0},
9e9dba7b	77	ALL_ZERO
d7083042 HV	78	};
d7083042 HV	79
551024f2 GS	80	/*
	81	* Bump this when adding new models[] above. Make sure the text buffer
	82	* for the ID response can hold the longest sequence that we expect in
	83	* the field which consists of: vendor + model [ + version ][ + serno ].
	84	* Don't be too generous here, the maximum receive buffer size affects
	85	* the timeout within which the first response character is expected.
	86	*/
	87	static const size_t id_text_buffer_size = 48;
	88
	89	/*
	90	* Check whether the device's "*IDN?" response matches a supported model.
	91	* The caller already stripped off the optional serial number.
	92	*/
	93	static gboolean model_matches(const struct korad_kaxxxxp_model *model,
	94	const char *id_text)
	95	{
349803b6	96	gboolean matches;
0f96d9bc	97	gboolean opt_version, skip_vendor, accept_trail;
349803b6 GS	98	const char *want;
	99
	100	if (!model)
	101	return FALSE;
	102
	103	/*
	104	* When the models[] entry contains a specific response text,
	105	* then expect to see this very text in literal form. This
	106	* lets the driver map weird and untypical responses to a
	107	* specific set of display texts for vendor and model names.
0f96d9bc	108	* Accept an optionally trailing version if models[] says so.
349803b6 GS	109	*/
349803b6 GS	110	if (model->id && model->id[0]) {
0f96d9bc GS	111	opt_version = model->quirks & KORAD_QUIRK_ID_OPT_VERSION;
	112	if (!opt_version) {
	113	matches = g_strcmp0(id_text, model->id) == 0;
	114	if (!matches)
	115	return FALSE;
349803b6	116	sr_dbg("Matches expected ID text: '%s'.", model->id);
0f96d9bc GS	117	return TRUE;
	118	}
	119	matches = g_str_has_prefix(id_text, model->id);
	120	if (!matches)
	121	return FALSE;
	122	id_text += strlen(model->id);
	123	while (isspace((int)*id_text))
	124	id_text++;
	125	if (*id_text == 'V') {
	126	id_text++;
	127	while (id_text == '.' \|\| isdigit((int)id_text))
	128	id_text++;
	129	while (isspace((int)*id_text))
	130	id_text++;
	131	}
	132	if (*id_text)
	133	return FALSE;
	134	sr_dbg("Matches expected ID text [vers]: '%s'.", model->id);
	135	return TRUE;
349803b6 GS	136	}
	137
	138	/*
	139	* A more generic approach which covers most devices: Check
	140	* for the very vendor and model names which also are shown
	141	* to users (the display texts). Weakened to match responses
	142	* more widely: Case insensitive checks, optional whitespace
	143	* in responses, optional version details. Optional trailing
	144	* garbage. Optional omission of the vendor name. Shall match
	145	* all the devices which were individually listed in earlier
	146	* implementations of the driver, and shall also match firmware
	147	* versions that were not listed before.
	148	*/
	149	skip_vendor = model->quirks & KORAD_QUIRK_ID_NO_VENDOR;
	150	accept_trail = model->quirks & KORAD_QUIRK_ID_TRAILING;
	151	if (!skip_vendor) {
	152	want = model->vendor;
	153	matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
	154	if (!matches)
	155	return FALSE;
	156	id_text += strlen(want);
	157	while (isspace((int)*id_text))
	158	id_text++;
	159	}
	160	want = model->name;
	161	matches = g_ascii_strncasecmp(id_text, want, strlen(want)) == 0;
	162	if (!matches)
	163	return FALSE;
	164	id_text += strlen(want);
	165	while (isspace((int)*id_text))
	166	id_text++;
	167	if (*id_text == 'V') {
	168	/* TODO Isolate and (also) return version details? */
	169	id_text++;
	170	while (id_text == '.' \|\| isdigit((int)id_text))
	171	id_text++;
	172	while (isspace((int)*id_text))
	173	id_text++;
	174	}
	175	if (accept_trail) {
	176	/*
	177	* TODO Determine how many non-printables to accept here
	178	* and how strict to check for "known" garbage variants.
	179	*/
	180	switch (*id_text) {
	181	case '\x01':
	182	case '\xbc':
	183	id_text++;
	184	break;
	185	case '\x00':
	186	/* EMPTY */
	187	break;
	188	default:
	189	return FALSE;
	190	}
	191	}
	192	if (*id_text)
	193	return FALSE;
	194	sr_dbg("Matches generic '[vendor] model [vers] [trail]' pattern.");
	195	return TRUE;
551024f2 GS	196	}
551024f2 GS	197
68321f73 GS	198	/* Lookup a model from an ID response text. */
	199	static const struct korad_kaxxxxp_model model_lookup(const char id_text)
	200	{
	201	size_t idx;
	202	const struct korad_kaxxxxp_model *check;
	203
	204	if (!id_text \|\| !*id_text)
	205	return NULL;
	206	sr_dbg("Looking up: [%s].", id_text);
	207
	208	for (idx = 0; idx < ARRAY_SIZE(models); idx++) {
	209	check = &models[idx];
	210	if (!check->name \|\| !check->name[0])
	211	continue;
	212	if (!model_matches(check, id_text))
	213	continue;
	214	sr_dbg("Found: [%s] [%s]", check->vendor, check->name);
	215	return check;
	216	}
	217	sr_dbg("Not found");
	218
	219	return NULL;
	220	}
	221
e75ee7de HV	222	static GSList scan(struct sr_dev_driver di, GSList *options)
e75ee7de HV	223	{
fcacf532 GS	224	static const char *serno_prefix = " SN:";
fcacf532 GS	225
d7083042	226	struct dev_context *devc;
43376f33	227	GSList *l;
d7083042 HV	228	struct sr_dev_inst *sdi;
	229	struct sr_config *src;
	230	const char conn, serialcomm;
e37e301e	231	const char *force_detect;
d7083042 HV	232	struct sr_serial_dev_inst *serial;
d7083042 HV	233	char reply[50];
5255f856 GS	234	int ret;
5255f856 GS	235	const struct korad_kaxxxxp_model *model;
fcacf532 GS	236	size_t len;
fcacf532 GS	237	char *serno;
e75ee7de	238
d7083042 HV	239	conn = NULL;
d7083042 HV	240	serialcomm = NULL;
e37e301e	241	force_detect = NULL;
e75ee7de	242
d7083042 HV	243	for (l = options; l; l = l->next) {
	244	src = l->data;
	245	switch (src->key) {
	246	case SR_CONF_CONN:
	247	conn = g_variant_get_string(src->data, NULL);
	248	break;
	249	case SR_CONF_SERIALCOMM:
	250	serialcomm = g_variant_get_string(src->data, NULL);
	251	break;
e37e301e GS	252	case SR_CONF_FORCE_DETECT:
	253	force_detect = g_variant_get_string(src->data, NULL);
	254	break;
d7083042 HV	255	default:
	256	sr_err("Unknown option %d, skipping.", src->key);
	257	break;
	258	}
	259	}
	260
	261	if (!conn)
	262	return NULL;
	263	if (!serialcomm)
	264	serialcomm = "9600/8n1";
e37e301e GS	265	if (force_detect && !*force_detect)
e37e301e GS	266	force_detect = NULL;
d7083042 HV	267
	268	serial = sr_serial_dev_inst_new(conn, serialcomm);
	269	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	270	return NULL;
	271
551024f2 GS	272	/* Communicate the identification request. */
551024f2 GS	273	len = id_text_buffer_size;
fcacf532 GS	274	if (len > sizeof(reply) - 1)
	275	len = sizeof(reply) - 1;
	276	sr_dbg("Want max %zu bytes.", len);
cf6beeb2	277
fcacf532 GS	278	ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
fcacf532 GS	279	if (ret < 0)
d7083042 HV	280	return NULL;
d7083042 HV	281
fcacf532 GS	282	ret = korad_kaxxxxp_read_chars(serial, len, reply);
fcacf532 GS	283	if (ret < 0)
d7083042	284	return NULL;
fcacf532	285	sr_dbg("Received: %d, %s", ret, reply);
cf6beeb2	286
fcacf532 GS	287	/*
	288	* Isolate the optional serial number at the response's end.
	289	* Lookup the response's model ID in the list of known models.
	290	*/
	291	serno = g_strrstr(reply, serno_prefix);
	292	if (serno) {
	293	*serno = '\0';
	294	serno += strlen(serno_prefix);
	295	}
cf6beeb2	296
68321f73	297	model = model_lookup(reply);
5255f856	298	if (!model && force_detect) {
68321f73	299	sr_warn("Could not find model ID '%s', trying '%s'.",
e37e301e	300	reply, force_detect);
68321f73 GS	301	model = model_lookup(force_detect);
68321f73 GS	302	if (model)
e37e301e	303	sr_info("Found replacement, using it instead.");
e37e301e	304	}
5255f856	305	if (!model) {
68321f73	306	sr_err("Unsupported model ID '%s', aborting.", reply);
d7083042 HV	307	return NULL;
d7083042 HV	308	}
349803b6 GS	309	sr_dbg("Found: %s %s (idx %zu).", model->vendor, model->name,
349803b6 GS	310	model - &models[0]);
d7083042	311
d7083042 HV	312	sdi = g_malloc0(sizeof(struct sr_dev_inst));
d7083042 HV	313	sdi->status = SR_ST_INACTIVE;
5255f856 GS	314	sdi->vendor = g_strdup(model->vendor);
5255f856 GS	315	sdi->model = g_strdup(model->name);
fcacf532 GS	316	if (serno)
fcacf532 GS	317	sdi->serial_num = g_strdup(serno);
d7083042 HV	318	sdi->inst_type = SR_INST_SERIAL;
d7083042 HV	319	sdi->conn = serial;
048250d0	320	sdi->connection_id = g_strdup(conn);
d7083042	321
23165d7b FS	322	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
23165d7b FS	323	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
d7083042 HV	324
d7083042 HV	325	devc = g_malloc0(sizeof(struct dev_context));
597deef9	326	sr_sw_limits_init(&devc->limits);
3f9b48ae	327	g_mutex_init(&devc->rw_mutex);
5255f856	328	devc->model = model;
d7083042	329	devc->req_sent_at = 0;
2e129b8b FS	330	devc->cc_mode_1_changed = FALSE;
	331	devc->cc_mode_2_changed = FALSE;
	332	devc->output_enabled_changed = FALSE;
	333	devc->ocp_enabled_changed = FALSE;
	334	devc->ovp_enabled_changed = FALSE;
d7083042 HV	335	sdi->priv = devc;
	336
	337	/* Get current status of device. */
16fc7ee2	338	if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042	339	goto exit_err;
d7083042 HV	340
d7083042 HV	341	serial_close(serial);
e75ee7de	342
43376f33	343	return std_scan_complete(di, g_slist_append(NULL, sdi));
d7083042 HV	344
	345	exit_err:
	346	sr_dev_inst_free(sdi);
	347	g_free(devc);
	348	sr_dbg("Scan failed.");
	349
	350	return NULL;
e75ee7de HV	351	}
e75ee7de HV	352
e75ee7de HV	353	static int config_get(uint32_t key, GVariant **data,
	354	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	355	{
d7083042	356	struct dev_context *devc;
e75ee7de	357
e75ee7de HV	358	(void)cg;
e75ee7de HV	359
d7083042 HV	360	if (!sdi \|\| !data)
	361	return SR_ERR_ARG;
	362
	363	devc = sdi->priv;
	364
e75ee7de	365	switch (key) {
cd04f641 UH	366	case SR_CONF_LIMIT_SAMPLES:
cd04f641 UH	367	case SR_CONF_LIMIT_MSEC:
597deef9	368	return sr_sw_limits_config_get(&devc->limits, key, data);
048250d0 GS	369	case SR_CONF_CONN:
	370	*data = g_variant_new_string(sdi->connection_id);
	371	break;
d7083042	372	case SR_CONF_VOLTAGE:
3f9b48ae	373	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
d7083042 HV	374	*data = g_variant_new_double(devc->voltage);
	375	break;
	376	case SR_CONF_VOLTAGE_TARGET:
8da30037 FS	377	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
8da30037 FS	378	*data = g_variant_new_double(devc->voltage_target);
d7083042 HV	379	break;
d7083042 HV	380	case SR_CONF_CURRENT:
3f9b48ae	381	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
d7083042 HV	382	*data = g_variant_new_double(devc->current);
	383	break;
	384	case SR_CONF_CURRENT_LIMIT:
8da30037 FS	385	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
8da30037 FS	386	*data = g_variant_new_double(devc->current_limit);
d7083042 HV	387	break;
d7083042 HV	388	case SR_CONF_ENABLED:
3f9b48ae	389	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
d7083042 HV	390	*data = g_variant_new_boolean(devc->output_enabled);
d7083042 HV	391	break;
b16d975a HV	392	case SR_CONF_REGULATION:
b16d975a HV	393	/* Dual channel not supported. */
3f9b48ae	394	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
9e5366df	395	*data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a	396	break;
c40ed60f	397	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
3f9b48ae	398	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
9e5366df	399	*data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f HV	400	break;
c40ed60f HV	401	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
3f9b48ae	402	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
9e5366df	403	*data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f	404	break;
e75ee7de HV	405	default:
	406	return SR_ERR_NA;
	407	}
	408
d7083042	409	return SR_OK;
e75ee7de HV	410	}
	411
	412	static int config_set(uint32_t key, GVariant *data,
	413	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	414	{
d7083042 HV	415	struct dev_context *devc;
	416	double dval;
	417	gboolean bval;
e75ee7de	418
e75ee7de HV	419	(void)cg;
e75ee7de HV	420
d7083042 HV	421	devc = sdi->priv;
d7083042 HV	422
e75ee7de	423	switch (key) {
d7083042	424	case SR_CONF_LIMIT_MSEC:
d7083042	425	case SR_CONF_LIMIT_SAMPLES:
597deef9	426	return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042 HV	427	case SR_CONF_VOLTAGE_TARGET:
	428	dval = g_variant_get_double(data);
	429	if (dval < devc->model->voltage[0] \|\| dval > devc->model->voltage[1])
	430	return SR_ERR_ARG;
8da30037 FS	431	devc->set_voltage_target = dval;
8da30037 FS	432	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
d7083042 HV	433	return SR_ERR;
	434	break;
	435	case SR_CONF_CURRENT_LIMIT:
	436	dval = g_variant_get_double(data);
	437	if (dval < devc->model->current[0] \|\| dval > devc->model->current[1])
	438	return SR_ERR_ARG;
8da30037 FS	439	devc->set_current_limit = dval;
8da30037 FS	440	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
d7083042 HV	441	return SR_ERR;
	442	break;
	443	case SR_CONF_ENABLED:
	444	bval = g_variant_get_boolean(data);
	445	/* Set always so it is possible turn off with sigrok-cli. */
8da30037	446	devc->set_output_enabled = bval;
3f9b48ae	447	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
d7083042	448	return SR_ERR;
c40ed60f HV	449	break;
	450	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
	451	bval = g_variant_get_boolean(data);
8da30037	452	devc->set_ocp_enabled = bval;
3f9b48ae	453	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
c40ed60f HV	454	return SR_ERR;
	455	break;
	456	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
	457	bval = g_variant_get_boolean(data);
8da30037	458	devc->set_ovp_enabled = bval;
3f9b48ae	459	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
c40ed60f	460	return SR_ERR;
d7083042	461	break;
e75ee7de	462	default:
d7083042	463	return SR_ERR_NA;
e75ee7de HV	464	}
e75ee7de HV	465
d7083042	466	return SR_OK;
e75ee7de HV	467	}
	468
	469	static int config_list(uint32_t key, GVariant **data,
	470	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	471	{
d7083042	472	struct dev_context *devc;
d7083042	473
e66d1892	474	devc = (sdi) ? sdi->priv : NULL;
d7083042	475
e75ee7de	476	switch (key) {
e66d1892	477	case SR_CONF_SCAN_OPTIONS:
d7083042	478	case SR_CONF_DEVICE_OPTIONS:
e66d1892	479	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
d7083042	480	case SR_CONF_VOLTAGE_TARGET:
fc69eecc GS	481	if (!devc \|\| !devc->model)
fc69eecc GS	482	return SR_ERR_ARG;
54d471f4	483	*data = std_gvar_min_max_step_array(devc->model->voltage);
d7083042 HV	484	break;
d7083042 HV	485	case SR_CONF_CURRENT_LIMIT:
fc69eecc GS	486	if (!devc \|\| !devc->model)
fc69eecc GS	487	return SR_ERR_ARG;
54d471f4	488	*data = std_gvar_min_max_step_array(devc->model->current);
d7083042	489	break;
e75ee7de HV	490	default:
	491	return SR_ERR_NA;
	492	}
	493
d7083042	494	return SR_OK;
e75ee7de HV	495	}
e75ee7de HV	496
3f9b48ae FS	497	static int dev_close(struct sr_dev_inst *sdi)
	498	{
	499	struct dev_context *devc;
	500
	501	devc = (sdi) ? sdi->priv : NULL;
	502	if (devc)
	503	g_mutex_clear(&devc->rw_mutex);
	504
	505	return std_serial_dev_close(sdi);
	506	}
	507
695dc859	508	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de	509	{
d7083042 HV	510	struct dev_context *devc;
d7083042 HV	511	struct sr_serial_dev_inst *serial;
e75ee7de	512
d7083042	513	devc = sdi->priv;
d7083042	514
597deef9	515	sr_sw_limits_acquisition_start(&devc->limits);
bee2b016	516	std_session_send_df_header(sdi);
d7083042	517
d7083042 HV	518	devc->req_sent_at = 0;
	519	serial = sdi->conn;
	520	serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2 UH	521	KAXXXXP_POLL_INTERVAL_MS,
16fc7ee2 UH	522	korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de HV	523
	524	return SR_OK;
	525	}
	526
dd5c48a6	527	static struct sr_dev_driver korad_kaxxxxp_driver_info = {
16fc7ee2 UH	528	.name = "korad-kaxxxxp",
16fc7ee2 UH	529	.longname = "Korad KAxxxxP",
e75ee7de	530	.api_version = 1,
c2fdcc25	531	.init = std_init,
700d6b64	532	.cleanup = std_cleanup,
e75ee7de	533	.scan = scan,
c01bf34c	534	.dev_list = std_dev_list,
f778bf02	535	.dev_clear = std_dev_clear,
e75ee7de HV	536	.config_get = config_get,
	537	.config_set = config_set,
	538	.config_list = config_list,
d7083042	539	.dev_open = std_serial_dev_open,
3f9b48ae	540	.dev_close = dev_close,
e75ee7de	541	.dev_acquisition_start = dev_acquisition_start,
4b1a9d5d	542	.dev_acquisition_stop = std_serial_dev_acquisition_stop,
e75ee7de HV	543	.context = NULL,
e75ee7de HV	544	};
dd5c48a6	545	SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);