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