[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 "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", "KORADKA3005PV2.0",
		1, volts_30, amps_5, KORAD_QUIRK_ID_TRAILING},
	/* Some KA3005P have extra bytes after the ID text. */
	{"Korad", "KA3005P", "KORADKA3005PV2.0\x01", 1, volts_30, amps_5, 0},
	{"Korad", "KA3005P", "KORADKA3005PV2.0\xBC", 1, volts_30, amps_5, 0},
	{"Korad", "KA3005P", "KORAD KA3005P V4.2", 1, volts_30, amps_5, 0},
	{"Korad", "KA3005P", "KORAD KA3005P V5.5", 1, volts_30, amps_5, 0},
	{"Korad", "KD3005P", "KORAD KD3005P V2.0", 1, volts_30, amps_5, 0},
	{"Korad", "KD3005P", "KORADKD3005PV2.0", 1, volts_30, amps_5, 0},
	{"Korad", "KD3005P", "KORADKD3005PV2.1", 1, volts_30, amps_5, 0},
	{"Korad", "KD3005P", "KORAD KD3005P V4.1", 1, volts_30, amps_5, 0},
	{"Korad", "KD3005P", "KORAD KD3005P V6.8", 1, volts_30, amps_5, 0},
	{"Korad", "KD6005P", "KORAD KD6005P V2.2", 1, volts_60, amps_5, 0},
	{"RND", "KA3005P", "RND 320-KA3005P V5.5", 1, volts_30, amps_5, 0},
	{"RND", "KD3005P", "RND 320-KD3005P V4.2", 1, volts_30, amps_5, 0},
	{"RND", "KA3005P", "RND 320-KA3005P V2.0", 1, volts_30, amps_5, 0},
	{"Stamos Soldering", "S-LS-31", "S-LS-31 V2.0",
		1, volts_30, amps_5, KORAD_QUIRK_ID_NO_VENDOR},
	{"Tenma", "72-2535", "TENMA 72-2535 V2.1", 1, volts_30, amps_3, 0},
	{"Tenma", "72-2540", "TENMA72-2540V2.0", 1, volts_30, amps_5, 0},
	{"Tenma", "72-2540", "TENMA 72-2540 V2.1", 1, volts_30, amps_5, 0},
	{"Tenma", "72-2540", "TENMA 72-2540 V5.2", 1, volts_30, amps_5, 0},
	{"Tenma", "72-2550", "TENMA72-2550V2.0", 1, volts_60, amps_3, 0},
	{"Tenma", "72-2710", "TENMA 72-2710 V6.6", 1, volts_30, amps_5, 0},
	{"Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0",
		1, volts_30, amps_5, KORAD_QUIRK_LABPS_OVP_EN},
	{"Velleman", "PS3005D", "VELLEMANPS3005DV2.0",
		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)
{
	/* TODO Implement more versatile ID response text checks. */
	return g_strcmp0(model->id, id_text) == 0;
}

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;
	size_t i;
	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 = NULL;
	for (i = 0; models[i].id; i++) {
		if (!model_matches(&models[i], reply))
			continue;
		model = &models[i];
		break;
	}
	if (!model && force_detect) {
		sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
			reply, force_detect);
		for (i = 0; models[i].id; i++) {
			if (!model_matches(&models[i], force_detect))
				continue;
			sr_info("Found replacement, using it instead.");
			model = &models[i];
			break;
		}
	}
	if (!model) {
		sr_err("Unknown model ID '%s' detected, aborting.", reply);
		return NULL;
	}
	sr_dbg("Found: %s %s (idx %zu, ID '%s').", model->vendor, model->name,
		model - &models[0], model->id);

	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>
	22	#include "protocol.h"
	23
d7083042 HV	24	static const uint32_t scanopts[] = {
	25	SR_CONF_CONN,
	26	SR_CONF_SERIALCOMM,
e37e301e	27	SR_CONF_FORCE_DETECT,
d7083042 HV	28	};
d7083042 HV	29
55fb76b3	30	static const uint32_t drvopts[] = {
55fb76b3 UH	31	SR_CONF_POWER_SUPPLY,
	32	};
	33
d7083042	34	static const uint32_t devopts[] = {
048250d0	35	SR_CONF_CONN \| SR_CONF_GET,
d7083042 HV	36	SR_CONF_CONTINUOUS,
	37	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	38	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
d7083042 HV	39	SR_CONF_VOLTAGE \| SR_CONF_GET,
	40	SR_CONF_VOLTAGE_TARGET \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	41	SR_CONF_CURRENT \| SR_CONF_GET,
	42	SR_CONF_CURRENT_LIMIT \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	43	SR_CONF_ENABLED \| SR_CONF_GET \| SR_CONF_SET,
b16d975a	44	SR_CONF_REGULATION \| SR_CONF_GET,
c40ed60f HV	45	SR_CONF_OVER_CURRENT_PROTECTION_ENABLED \| SR_CONF_GET \| SR_CONF_SET,
c40ed60f HV	46	SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED \| SR_CONF_GET \| SR_CONF_SET,
d7083042 HV	47	};
d7083042 HV	48
ecd4600b GS	49	/* Voltage and current ranges. Values are: Min, max, step. */
	50	static const double volts_30[] = { 0, 31, 0.01, };
	51	static const double volts_60[] = { 0, 61, 0.01, };
	52	static const double amps_3[] = { 0, 3.1, 0.001, };
	53	static const double amps_5[] = { 0, 5.1, 0.001, };
	54
16fc7ee2	55	static const struct korad_kaxxxxp_model models[] = {
c55adfa1	56	/* Vendor, model name, ID reply, channels, voltage, current, quirks. */
551024f2 GS	57	{"Korad", "KA3005P", "KORADKA3005PV2.0",
551024f2 GS	58	1, volts_30, amps_5, KORAD_QUIRK_ID_TRAILING},
942afb5a GS	59	/* Some KA3005P have extra bytes after the ID text. */
	60	{"Korad", "KA3005P", "KORADKA3005PV2.0\x01", 1, volts_30, amps_5, 0},
	61	{"Korad", "KA3005P", "KORADKA3005PV2.0\xBC", 1, volts_30, amps_5, 0},
	62	{"Korad", "KA3005P", "KORAD KA3005P V4.2", 1, volts_30, amps_5, 0},
	63	{"Korad", "KA3005P", "KORAD KA3005P V5.5", 1, volts_30, amps_5, 0},
	64	{"Korad", "KD3005P", "KORAD KD3005P V2.0", 1, volts_30, amps_5, 0},
	65	{"Korad", "KD3005P", "KORADKD3005PV2.0", 1, volts_30, amps_5, 0},
	66	{"Korad", "KD3005P", "KORADKD3005PV2.1", 1, volts_30, amps_5, 0},
	67	{"Korad", "KD3005P", "KORAD KD3005P V4.1", 1, volts_30, amps_5, 0},
	68	{"Korad", "KD3005P", "KORAD KD3005P V6.8", 1, volts_30, amps_5, 0},
	69	{"Korad", "KD6005P", "KORAD KD6005P V2.2", 1, volts_60, amps_5, 0},
	70	{"RND", "KA3005P", "RND 320-KA3005P V5.5", 1, volts_30, amps_5, 0},
	71	{"RND", "KD3005P", "RND 320-KD3005P V4.2", 1, volts_30, amps_5, 0},
	72	{"RND", "KA3005P", "RND 320-KA3005P V2.0", 1, volts_30, amps_5, 0},
551024f2 GS	73	{"Stamos Soldering", "S-LS-31", "S-LS-31 V2.0",
551024f2 GS	74	1, volts_30, amps_5, KORAD_QUIRK_ID_NO_VENDOR},
942afb5a GS	75	{"Tenma", "72-2535", "TENMA 72-2535 V2.1", 1, volts_30, amps_3, 0},
	76	{"Tenma", "72-2540", "TENMA72-2540V2.0", 1, volts_30, amps_5, 0},
	77	{"Tenma", "72-2540", "TENMA 72-2540 V2.1", 1, volts_30, amps_5, 0},
	78	{"Tenma", "72-2540", "TENMA 72-2540 V5.2", 1, volts_30, amps_5, 0},
	79	{"Tenma", "72-2550", "TENMA72-2550V2.0", 1, volts_60, amps_3, 0},
	80	{"Tenma", "72-2710", "TENMA 72-2710 V6.6", 1, volts_30, amps_5, 0},
c55adfa1	81	{"Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0",
c7275098	82	1, volts_30, amps_5, KORAD_QUIRK_LABPS_OVP_EN},
c55adfa1	83	{"Velleman", "PS3005D", "VELLEMANPS3005DV2.0",
c7275098	84	1, volts_30, amps_5, 0},
9e9dba7b	85	ALL_ZERO
d7083042 HV	86	};
d7083042 HV	87
551024f2 GS	88	/*
	89	* Bump this when adding new models[] above. Make sure the text buffer
	90	* for the ID response can hold the longest sequence that we expect in
	91	* the field which consists of: vendor + model [ + version ][ + serno ].
	92	* Don't be too generous here, the maximum receive buffer size affects
	93	* the timeout within which the first response character is expected.
	94	*/
	95	static const size_t id_text_buffer_size = 48;
	96
	97	/*
	98	* Check whether the device's "*IDN?" response matches a supported model.
	99	* The caller already stripped off the optional serial number.
	100	*/
	101	static gboolean model_matches(const struct korad_kaxxxxp_model *model,
	102	const char *id_text)
	103	{
	104	/* TODO Implement more versatile ID response text checks. */
	105	return g_strcmp0(model->id, id_text) == 0;
	106	}
	107
e75ee7de HV	108	static GSList scan(struct sr_dev_driver di, GSList *options)
e75ee7de HV	109	{
fcacf532 GS	110	static const char *serno_prefix = " SN:";
fcacf532 GS	111
d7083042	112	struct dev_context *devc;
43376f33	113	GSList *l;
d7083042 HV	114	struct sr_dev_inst *sdi;
	115	struct sr_config *src;
	116	const char conn, serialcomm;
e37e301e	117	const char *force_detect;
d7083042	118	struct sr_serial_dev_inst *serial;
5255f856	119	size_t i;
d7083042	120	char reply[50];
5255f856 GS	121	int ret;
5255f856 GS	122	const struct korad_kaxxxxp_model *model;
fcacf532 GS	123	size_t len;
fcacf532 GS	124	char *serno;
e75ee7de	125
d7083042 HV	126	conn = NULL;
d7083042 HV	127	serialcomm = NULL;
e37e301e	128	force_detect = NULL;
e75ee7de	129
d7083042 HV	130	for (l = options; l; l = l->next) {
	131	src = l->data;
	132	switch (src->key) {
	133	case SR_CONF_CONN:
	134	conn = g_variant_get_string(src->data, NULL);
	135	break;
	136	case SR_CONF_SERIALCOMM:
	137	serialcomm = g_variant_get_string(src->data, NULL);
	138	break;
e37e301e GS	139	case SR_CONF_FORCE_DETECT:
	140	force_detect = g_variant_get_string(src->data, NULL);
	141	break;
d7083042 HV	142	default:
	143	sr_err("Unknown option %d, skipping.", src->key);
	144	break;
	145	}
	146	}
	147
	148	if (!conn)
	149	return NULL;
	150	if (!serialcomm)
	151	serialcomm = "9600/8n1";
e37e301e GS	152	if (force_detect && !*force_detect)
e37e301e GS	153	force_detect = NULL;
d7083042 HV	154
	155	serial = sr_serial_dev_inst_new(conn, serialcomm);
	156	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	157	return NULL;
	158
551024f2 GS	159	/* Communicate the identification request. */
551024f2 GS	160	len = id_text_buffer_size;
fcacf532 GS	161	if (len > sizeof(reply) - 1)
	162	len = sizeof(reply) - 1;
	163	sr_dbg("Want max %zu bytes.", len);
cf6beeb2	164
fcacf532 GS	165	ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
fcacf532 GS	166	if (ret < 0)
d7083042 HV	167	return NULL;
d7083042 HV	168
fcacf532 GS	169	ret = korad_kaxxxxp_read_chars(serial, len, reply);
fcacf532 GS	170	if (ret < 0)
d7083042	171	return NULL;
fcacf532	172	sr_dbg("Received: %d, %s", ret, reply);
cf6beeb2	173
fcacf532 GS	174	/*
	175	* Isolate the optional serial number at the response's end.
	176	* Lookup the response's model ID in the list of known models.
	177	*/
	178	serno = g_strrstr(reply, serno_prefix);
	179	if (serno) {
	180	*serno = '\0';
	181	serno += strlen(serno_prefix);
	182	}
cf6beeb2	183
5255f856	184	model = NULL;
d7083042	185	for (i = 0; models[i].id; i++) {
551024f2	186	if (!model_matches(&models[i], reply))
fcacf532	187	continue;
5255f856	188	model = &models[i];
fcacf532	189	break;
d7083042	190	}
5255f856	191	if (!model && force_detect) {
e37e301e GS	192	sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
	193	reply, force_detect);
	194	for (i = 0; models[i].id; i++) {
551024f2	195	if (!model_matches(&models[i], force_detect))
e37e301e GS	196	continue;
e37e301e GS	197	sr_info("Found replacement, using it instead.");
5255f856	198	model = &models[i];
e37e301e GS	199	break;
	200	}
	201	}
5255f856	202	if (!model) {
d7083042 HV	203	sr_err("Unknown model ID '%s' detected, aborting.", reply);
	204	return NULL;
	205	}
5255f856 GS	206	sr_dbg("Found: %s %s (idx %zu, ID '%s').", model->vendor, model->name,
5255f856 GS	207	model - &models[0], model->id);
d7083042	208
d7083042 HV	209	sdi = g_malloc0(sizeof(struct sr_dev_inst));
d7083042 HV	210	sdi->status = SR_ST_INACTIVE;
5255f856 GS	211	sdi->vendor = g_strdup(model->vendor);
5255f856 GS	212	sdi->model = g_strdup(model->name);
fcacf532 GS	213	if (serno)
fcacf532 GS	214	sdi->serial_num = g_strdup(serno);
d7083042 HV	215	sdi->inst_type = SR_INST_SERIAL;
d7083042 HV	216	sdi->conn = serial;
048250d0	217	sdi->connection_id = g_strdup(conn);
d7083042	218
23165d7b FS	219	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
23165d7b FS	220	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
d7083042 HV	221
d7083042 HV	222	devc = g_malloc0(sizeof(struct dev_context));
597deef9	223	sr_sw_limits_init(&devc->limits);
3f9b48ae	224	g_mutex_init(&devc->rw_mutex);
5255f856	225	devc->model = model;
d7083042	226	devc->req_sent_at = 0;
2e129b8b FS	227	devc->cc_mode_1_changed = FALSE;
	228	devc->cc_mode_2_changed = FALSE;
	229	devc->output_enabled_changed = FALSE;
	230	devc->ocp_enabled_changed = FALSE;
	231	devc->ovp_enabled_changed = FALSE;
d7083042 HV	232	sdi->priv = devc;
	233
	234	/* Get current status of device. */
16fc7ee2	235	if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042	236	goto exit_err;
d7083042 HV	237
d7083042 HV	238	serial_close(serial);
e75ee7de	239
43376f33	240	return std_scan_complete(di, g_slist_append(NULL, sdi));
d7083042 HV	241
	242	exit_err:
	243	sr_dev_inst_free(sdi);
	244	g_free(devc);
	245	sr_dbg("Scan failed.");
	246
	247	return NULL;
e75ee7de HV	248	}
e75ee7de HV	249
e75ee7de HV	250	static int config_get(uint32_t key, GVariant **data,
	251	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	252	{
d7083042	253	struct dev_context *devc;
e75ee7de	254
e75ee7de HV	255	(void)cg;
e75ee7de HV	256
d7083042 HV	257	if (!sdi \|\| !data)
	258	return SR_ERR_ARG;
	259
	260	devc = sdi->priv;
	261
e75ee7de	262	switch (key) {
cd04f641 UH	263	case SR_CONF_LIMIT_SAMPLES:
cd04f641 UH	264	case SR_CONF_LIMIT_MSEC:
597deef9	265	return sr_sw_limits_config_get(&devc->limits, key, data);
048250d0 GS	266	case SR_CONF_CONN:
	267	*data = g_variant_new_string(sdi->connection_id);
	268	break;
d7083042	269	case SR_CONF_VOLTAGE:
3f9b48ae	270	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
d7083042 HV	271	*data = g_variant_new_double(devc->voltage);
	272	break;
	273	case SR_CONF_VOLTAGE_TARGET:
8da30037 FS	274	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
8da30037 FS	275	*data = g_variant_new_double(devc->voltage_target);
d7083042 HV	276	break;
d7083042 HV	277	case SR_CONF_CURRENT:
3f9b48ae	278	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
d7083042 HV	279	*data = g_variant_new_double(devc->current);
	280	break;
	281	case SR_CONF_CURRENT_LIMIT:
8da30037 FS	282	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
8da30037 FS	283	*data = g_variant_new_double(devc->current_limit);
d7083042 HV	284	break;
d7083042 HV	285	case SR_CONF_ENABLED:
3f9b48ae	286	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
d7083042 HV	287	*data = g_variant_new_boolean(devc->output_enabled);
d7083042 HV	288	break;
b16d975a HV	289	case SR_CONF_REGULATION:
b16d975a HV	290	/* Dual channel not supported. */
3f9b48ae	291	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
9e5366df	292	*data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a	293	break;
c40ed60f	294	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
3f9b48ae	295	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
9e5366df	296	*data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f HV	297	break;
c40ed60f HV	298	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
3f9b48ae	299	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
9e5366df	300	*data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f	301	break;
e75ee7de HV	302	default:
	303	return SR_ERR_NA;
	304	}
	305
d7083042	306	return SR_OK;
e75ee7de HV	307	}
	308
	309	static int config_set(uint32_t key, GVariant *data,
	310	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	311	{
d7083042 HV	312	struct dev_context *devc;
	313	double dval;
	314	gboolean bval;
e75ee7de	315
e75ee7de HV	316	(void)cg;
e75ee7de HV	317
d7083042 HV	318	devc = sdi->priv;
d7083042 HV	319
e75ee7de	320	switch (key) {
d7083042	321	case SR_CONF_LIMIT_MSEC:
d7083042	322	case SR_CONF_LIMIT_SAMPLES:
597deef9	323	return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042 HV	324	case SR_CONF_VOLTAGE_TARGET:
	325	dval = g_variant_get_double(data);
	326	if (dval < devc->model->voltage[0] \|\| dval > devc->model->voltage[1])
	327	return SR_ERR_ARG;
8da30037 FS	328	devc->set_voltage_target = dval;
8da30037 FS	329	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
d7083042 HV	330	return SR_ERR;
	331	break;
	332	case SR_CONF_CURRENT_LIMIT:
	333	dval = g_variant_get_double(data);
	334	if (dval < devc->model->current[0] \|\| dval > devc->model->current[1])
	335	return SR_ERR_ARG;
8da30037 FS	336	devc->set_current_limit = dval;
8da30037 FS	337	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
d7083042 HV	338	return SR_ERR;
	339	break;
	340	case SR_CONF_ENABLED:
	341	bval = g_variant_get_boolean(data);
	342	/* Set always so it is possible turn off with sigrok-cli. */
8da30037	343	devc->set_output_enabled = bval;
3f9b48ae	344	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
d7083042	345	return SR_ERR;
c40ed60f HV	346	break;
	347	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
	348	bval = g_variant_get_boolean(data);
8da30037	349	devc->set_ocp_enabled = bval;
3f9b48ae	350	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
c40ed60f HV	351	return SR_ERR;
	352	break;
	353	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
	354	bval = g_variant_get_boolean(data);
8da30037	355	devc->set_ovp_enabled = bval;
3f9b48ae	356	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
c40ed60f	357	return SR_ERR;
d7083042	358	break;
e75ee7de	359	default:
d7083042	360	return SR_ERR_NA;
e75ee7de HV	361	}
e75ee7de HV	362
d7083042	363	return SR_OK;
e75ee7de HV	364	}
	365
	366	static int config_list(uint32_t key, GVariant **data,
	367	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	368	{
d7083042	369	struct dev_context *devc;
d7083042	370
e66d1892	371	devc = (sdi) ? sdi->priv : NULL;
d7083042	372
e75ee7de	373	switch (key) {
e66d1892	374	case SR_CONF_SCAN_OPTIONS:
d7083042	375	case SR_CONF_DEVICE_OPTIONS:
e66d1892	376	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
d7083042	377	case SR_CONF_VOLTAGE_TARGET:
fc69eecc GS	378	if (!devc \|\| !devc->model)
fc69eecc GS	379	return SR_ERR_ARG;
54d471f4	380	*data = std_gvar_min_max_step_array(devc->model->voltage);
d7083042 HV	381	break;
d7083042 HV	382	case SR_CONF_CURRENT_LIMIT:
fc69eecc GS	383	if (!devc \|\| !devc->model)
fc69eecc GS	384	return SR_ERR_ARG;
54d471f4	385	*data = std_gvar_min_max_step_array(devc->model->current);
d7083042	386	break;
e75ee7de HV	387	default:
	388	return SR_ERR_NA;
	389	}
	390
d7083042	391	return SR_OK;
e75ee7de HV	392	}
e75ee7de HV	393
3f9b48ae FS	394	static int dev_close(struct sr_dev_inst *sdi)
	395	{
	396	struct dev_context *devc;
	397
	398	devc = (sdi) ? sdi->priv : NULL;
	399	if (devc)
	400	g_mutex_clear(&devc->rw_mutex);
	401
	402	return std_serial_dev_close(sdi);
	403	}
	404
695dc859	405	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de	406	{
d7083042 HV	407	struct dev_context *devc;
d7083042 HV	408	struct sr_serial_dev_inst *serial;
e75ee7de	409
d7083042	410	devc = sdi->priv;
d7083042	411
597deef9	412	sr_sw_limits_acquisition_start(&devc->limits);
bee2b016	413	std_session_send_df_header(sdi);
d7083042	414
d7083042 HV	415	devc->req_sent_at = 0;
	416	serial = sdi->conn;
	417	serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2 UH	418	KAXXXXP_POLL_INTERVAL_MS,
16fc7ee2 UH	419	korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de HV	420
	421	return SR_OK;
	422	}
	423
dd5c48a6	424	static struct sr_dev_driver korad_kaxxxxp_driver_info = {
16fc7ee2 UH	425	.name = "korad-kaxxxxp",
16fc7ee2 UH	426	.longname = "Korad KAxxxxP",
e75ee7de	427	.api_version = 1,
c2fdcc25	428	.init = std_init,
700d6b64	429	.cleanup = std_cleanup,
e75ee7de	430	.scan = scan,
c01bf34c	431	.dev_list = std_dev_list,
f778bf02	432	.dev_clear = std_dev_clear,
e75ee7de HV	433	.config_get = config_get,
	434	.config_set = config_set,
	435	.config_list = config_list,
d7083042	436	.dev_open = std_serial_dev_open,
3f9b48ae	437	.dev_close = dev_close,
e75ee7de	438	.dev_acquisition_start = dev_acquisition_start,
4b1a9d5d	439	.dev_acquisition_stop = std_serial_dev_acquisition_stop,
e75ee7de HV	440	.context = NULL,
e75ee7de HV	441	};
dd5c48a6	442	SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);