[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,
};

static const struct korad_kaxxxxp_model models[] = {
	/* Device enum, vendor, model, ID reply, channels, voltage, current */
	{KORAD_KA3005P, "Korad", "KA3005P", "KORADKA3005PV2.0",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	/* Sometimes the KA3005P has an extra 0x01 after the ID. */
	{KORAD_KA3005P_0X01, "Korad", "KA3005P", "KORADKA3005PV2.0\x01",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	/* Sometimes the KA3005P has an extra 0xBC after the ID. */
	{KORAD_KA3005P_0XBC, "Korad", "KA3005P", "KORADKA3005PV2.0\xBC",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{KORAD_KA3005P_V42, "Korad", "KA3005P", "KORAD KA3005P V4.2",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{KORAD_KA3005P_V55, "Korad", "KA3005P", "KORAD KA3005P V5.5",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{KORAD_KD3005P_V20, "Korad", "KD3005P", "KORAD KD3005P V2.0",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P", "KORADKD3005PV2.0",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{KORAD_KD3005P_V21_NOSP, "Korad", "KD3005P", "KORADKD3005PV2.1",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{KORAD_KD3005P_V41, "Korad", "KD3005P", "KORAD KD3005P V4.1",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{KORAD_KD3005P_V68, "Korad", "KD3005P", "KORAD KD3005P V6.8",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{KORAD_KD6005P, "Korad", "KD6005P", "KORAD KD6005P V2.2",
		1, {0, 61, 0.01}, {0, 5.1, 0.001}},
	{RND_320_KA3005P, "RND", "KA3005P", "RND 320-KA3005P V5.5",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{RND_320_KD3005P, "RND", "KD3005P", "RND 320-KD3005P V4.2",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{RND_320K30PV, "RND", "KA3005P", "RND 320-KA3005P V2.0",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{STAMOS_SLS31_V20, "Stamos Soldering", "S-LS-31", "S-LS-31 V2.0",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{TENMA_72_2535_V21, "Tenma", "72-2535", "TENMA 72-2535 V2.1",
		1, {0, 31, 0.01}, {0, 3.1, 0.001}},
	{TENMA_72_2540_V20, "Tenma", "72-2540", "TENMA72-2540V2.0",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{TENMA_72_2540_V21, "Tenma", "72-2540", "TENMA 72-2540 V2.1",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{TENMA_72_2540_V52, "Tenma", "72-2540", "TENMA 72-2540 V5.2",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{TENMA_72_2550_V2, "Tenma", "72-2550", "TENMA72-2550V2.0",
		1, {0, 61, 0.01}, {0, 3.1, 0.001}},
	{TENMA_72_2710_V66, "Tenma", "72-2710", "TENMA 72-2710 V6.6",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	{VELLEMAN_PS3005D, "Velleman", "PS3005D", "VELLEMANPS3005DV2.0",
		1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	ALL_ZERO
};

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, i, model_id;
	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;

	/*
	 * Prepare a receive buffer for the identification response that
	 * is large enough to hold the longest known model name, and an
	 * optional serial number. Communicate the identification request.
	 */
	len = 0;
	for (i = 0; models[i].id; i++) {
		if (len < strlen(models[i].id))
			len = strlen(models[i].id);
	}
	len += strlen(serno_prefix) + 12;
	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_id = -1;
	for (i = 0; models[i].id; i++) {
		if (g_strcmp0(models[i].id, reply) != 0)
			continue;
		model_id = i;
		break;
	}
	if (model_id < 0 && force_detect) {
		sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
			reply, force_detect);
		for (i = 0; models[i].id; i++) {
			if (strcmp(models[i].id, force_detect) != 0)
				continue;
			sr_info("Found replacement, using it instead.");
			model_id = i;
			break;
		}
	}
	if (model_id < 0) {
		sr_err("Unknown model ID '%s' detected, aborting.", reply);
		return NULL;
	}
	sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
		models[model_id].name, model_id, models[model_id].id);

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup(models[model_id].vendor);
	sdi->model = g_strdup(models[model_id].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 = &models[model_id];
	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
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
	5	* Copyright (C) 2018-2019 Frank Stettner <frank-stettner@gmx.net>
	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
	24	static const uint32_t scanopts[] = {
	25	SR_CONF_CONN,
	26	SR_CONF_SERIALCOMM,
	27	SR_CONF_FORCE_DETECT,
	28	};
	29
	30	static const uint32_t drvopts[] = {
	31	SR_CONF_POWER_SUPPLY,
	32	};
	33
	34	static const uint32_t devopts[] = {
	35	SR_CONF_CONN \| SR_CONF_GET,
	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,
	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,
	44	SR_CONF_REGULATION \| SR_CONF_GET,
	45	SR_CONF_OVER_CURRENT_PROTECTION_ENABLED \| SR_CONF_GET \| SR_CONF_SET,
	46	SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED \| SR_CONF_GET \| SR_CONF_SET,
	47	};
	48
	49	static const struct korad_kaxxxxp_model models[] = {
	50	/* Device enum, vendor, model, ID reply, channels, voltage, current */
	51	{KORAD_KA3005P, "Korad", "KA3005P", "KORADKA3005PV2.0",
	52	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	53	/* Sometimes the KA3005P has an extra 0x01 after the ID. */
	54	{KORAD_KA3005P_0X01, "Korad", "KA3005P", "KORADKA3005PV2.0\x01",
	55	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	56	/* Sometimes the KA3005P has an extra 0xBC after the ID. */
	57	{KORAD_KA3005P_0XBC, "Korad", "KA3005P", "KORADKA3005PV2.0\xBC",
	58	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	59	{KORAD_KA3005P_V42, "Korad", "KA3005P", "KORAD KA3005P V4.2",
	60	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	61	{KORAD_KA3005P_V55, "Korad", "KA3005P", "KORAD KA3005P V5.5",
	62	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	63	{KORAD_KD3005P_V20, "Korad", "KD3005P", "KORAD KD3005P V2.0",
	64	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	65	{KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P", "KORADKD3005PV2.0",
	66	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	67	{KORAD_KD3005P_V21_NOSP, "Korad", "KD3005P", "KORADKD3005PV2.1",
	68	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	69	{KORAD_KD3005P_V41, "Korad", "KD3005P", "KORAD KD3005P V4.1",
	70	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	71	{KORAD_KD3005P_V68, "Korad", "KD3005P", "KORAD KD3005P V6.8",
	72	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	73	{KORAD_KD6005P, "Korad", "KD6005P", "KORAD KD6005P V2.2",
	74	1, {0, 61, 0.01}, {0, 5.1, 0.001}},
	75	{RND_320_KA3005P, "RND", "KA3005P", "RND 320-KA3005P V5.5",
	76	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	77	{RND_320_KD3005P, "RND", "KD3005P", "RND 320-KD3005P V4.2",
	78	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	79	{RND_320K30PV, "RND", "KA3005P", "RND 320-KA3005P V2.0",
	80	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	81	{STAMOS_SLS31_V20, "Stamos Soldering", "S-LS-31", "S-LS-31 V2.0",
	82	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	83	{TENMA_72_2535_V21, "Tenma", "72-2535", "TENMA 72-2535 V2.1",
	84	1, {0, 31, 0.01}, {0, 3.1, 0.001}},
	85	{TENMA_72_2540_V20, "Tenma", "72-2540", "TENMA72-2540V2.0",
	86	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	87	{TENMA_72_2540_V21, "Tenma", "72-2540", "TENMA 72-2540 V2.1",
	88	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	89	{TENMA_72_2540_V52, "Tenma", "72-2540", "TENMA 72-2540 V5.2",
	90	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	91	{TENMA_72_2550_V2, "Tenma", "72-2550", "TENMA72-2550V2.0",
	92	1, {0, 61, 0.01}, {0, 3.1, 0.001}},
	93	{TENMA_72_2710_V66, "Tenma", "72-2710", "TENMA 72-2710 V6.6",
	94	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	95	{VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0",
	96	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	97	{VELLEMAN_PS3005D, "Velleman", "PS3005D", "VELLEMANPS3005DV2.0",
	98	1, {0, 31, 0.01}, {0, 5.1, 0.001}},
	99	ALL_ZERO
	100	};
	101
	102	static GSList scan(struct sr_dev_driver di, GSList *options)
	103	{
	104	static const char *serno_prefix = " SN:";
	105
	106	struct dev_context *devc;
	107	GSList *l;
	108	struct sr_dev_inst *sdi;
	109	struct sr_config *src;
	110	const char conn, serialcomm;
	111	const char *force_detect;
	112	struct sr_serial_dev_inst *serial;
	113	char reply[50];
	114	int ret, i, model_id;
	115	size_t len;
	116	char *serno;
	117
	118	conn = NULL;
	119	serialcomm = NULL;
	120	force_detect = NULL;
	121
	122	for (l = options; l; l = l->next) {
	123	src = l->data;
	124	switch (src->key) {
	125	case SR_CONF_CONN:
	126	conn = g_variant_get_string(src->data, NULL);
	127	break;
	128	case SR_CONF_SERIALCOMM:
	129	serialcomm = g_variant_get_string(src->data, NULL);
	130	break;
	131	case SR_CONF_FORCE_DETECT:
	132	force_detect = g_variant_get_string(src->data, NULL);
	133	break;
	134	default:
	135	sr_err("Unknown option %d, skipping.", src->key);
	136	break;
	137	}
	138	}
	139
	140	if (!conn)
	141	return NULL;
	142	if (!serialcomm)
	143	serialcomm = "9600/8n1";
	144	if (force_detect && !*force_detect)
	145	force_detect = NULL;
	146
	147	serial = sr_serial_dev_inst_new(conn, serialcomm);
	148	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	149	return NULL;
	150
	151	/*
	152	* Prepare a receive buffer for the identification response that
	153	* is large enough to hold the longest known model name, and an
	154	* optional serial number. Communicate the identification request.
	155	*/
	156	len = 0;
	157	for (i = 0; models[i].id; i++) {
	158	if (len < strlen(models[i].id))
	159	len = strlen(models[i].id);
	160	}
	161	len += strlen(serno_prefix) + 12;
	162	if (len > sizeof(reply) - 1)
	163	len = sizeof(reply) - 1;
	164	sr_dbg("Want max %zu bytes.", len);
	165
	166	ret = korad_kaxxxxp_send_cmd(serial, "*IDN?");
	167	if (ret < 0)
	168	return NULL;
	169
	170	ret = korad_kaxxxxp_read_chars(serial, len, reply);
	171	if (ret < 0)
	172	return NULL;
	173	sr_dbg("Received: %d, %s", ret, reply);
	174
	175	/*
	176	* Isolate the optional serial number at the response's end.
	177	* Lookup the response's model ID in the list of known models.
	178	*/
	179	serno = g_strrstr(reply, serno_prefix);
	180	if (serno) {
	181	*serno = '\0';
	182	serno += strlen(serno_prefix);
	183	}
	184
	185	model_id = -1;
	186	for (i = 0; models[i].id; i++) {
	187	if (g_strcmp0(models[i].id, reply) != 0)
	188	continue;
	189	model_id = i;
	190	break;
	191	}
	192	if (model_id < 0 && force_detect) {
	193	sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
	194	reply, force_detect);
	195	for (i = 0; models[i].id; i++) {
	196	if (strcmp(models[i].id, force_detect) != 0)
	197	continue;
	198	sr_info("Found replacement, using it instead.");
	199	model_id = i;
	200	break;
	201	}
	202	}
	203	if (model_id < 0) {
	204	sr_err("Unknown model ID '%s' detected, aborting.", reply);
	205	return NULL;
	206	}
	207	sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
	208	models[model_id].name, model_id, models[model_id].id);
	209
	210	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	211	sdi->status = SR_ST_INACTIVE;
	212	sdi->vendor = g_strdup(models[model_id].vendor);
	213	sdi->model = g_strdup(models[model_id].name);
	214	if (serno)
	215	sdi->serial_num = g_strdup(serno);
	216	sdi->inst_type = SR_INST_SERIAL;
	217	sdi->conn = serial;
	218	sdi->connection_id = g_strdup(conn);
	219
	220	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
	221	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
	222
	223	devc = g_malloc0(sizeof(struct dev_context));
	224	sr_sw_limits_init(&devc->limits);
	225	g_mutex_init(&devc->rw_mutex);
	226	devc->model = &models[model_id];
	227	devc->req_sent_at = 0;
	228	devc->cc_mode_1_changed = FALSE;
	229	devc->cc_mode_2_changed = FALSE;
	230	devc->output_enabled_changed = FALSE;
	231	devc->ocp_enabled_changed = FALSE;
	232	devc->ovp_enabled_changed = FALSE;
	233	sdi->priv = devc;
	234
	235	/* Get current status of device. */
	236	if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
	237	goto exit_err;
	238
	239	serial_close(serial);
	240
	241	return std_scan_complete(di, g_slist_append(NULL, sdi));
	242
	243	exit_err:
	244	sr_dev_inst_free(sdi);
	245	g_free(devc);
	246	sr_dbg("Scan failed.");
	247
	248	return NULL;
	249	}
	250
	251	static int config_get(uint32_t key, GVariant **data,
	252	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	253	{
	254	struct dev_context *devc;
	255
	256	(void)cg;
	257
	258	if (!sdi \|\| !data)
	259	return SR_ERR_ARG;
	260
	261	devc = sdi->priv;
	262
	263	switch (key) {
	264	case SR_CONF_LIMIT_SAMPLES:
	265	case SR_CONF_LIMIT_MSEC:
	266	return sr_sw_limits_config_get(&devc->limits, key, data);
	267	case SR_CONF_CONN:
	268	*data = g_variant_new_string(sdi->connection_id);
	269	break;
	270	case SR_CONF_VOLTAGE:
	271	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
	272	*data = g_variant_new_double(devc->voltage);
	273	break;
	274	case SR_CONF_VOLTAGE_TARGET:
	275	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
	276	*data = g_variant_new_double(devc->voltage_target);
	277	break;
	278	case SR_CONF_CURRENT:
	279	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
	280	*data = g_variant_new_double(devc->current);
	281	break;
	282	case SR_CONF_CURRENT_LIMIT:
	283	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
	284	*data = g_variant_new_double(devc->current_limit);
	285	break;
	286	case SR_CONF_ENABLED:
	287	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
	288	*data = g_variant_new_boolean(devc->output_enabled);
	289	break;
	290	case SR_CONF_REGULATION:
	291	/* Dual channel not supported. */
	292	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
	293	*data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
	294	break;
	295	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
	296	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
	297	*data = g_variant_new_boolean(devc->ocp_enabled);
	298	break;
	299	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
	300	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
	301	*data = g_variant_new_boolean(devc->ovp_enabled);
	302	break;
	303	default:
	304	return SR_ERR_NA;
	305	}
	306
	307	return SR_OK;
	308	}
	309
	310	static int config_set(uint32_t key, GVariant *data,
	311	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	312	{
	313	struct dev_context *devc;
	314	double dval;
	315	gboolean bval;
	316
	317	(void)cg;
	318
	319	devc = sdi->priv;
	320
	321	switch (key) {
	322	case SR_CONF_LIMIT_MSEC:
	323	case SR_CONF_LIMIT_SAMPLES:
	324	return sr_sw_limits_config_set(&devc->limits, key, data);
	325	case SR_CONF_VOLTAGE_TARGET:
	326	dval = g_variant_get_double(data);
	327	if (dval < devc->model->voltage[0] \|\| dval > devc->model->voltage[1])
	328	return SR_ERR_ARG;
	329	devc->set_voltage_target = dval;
	330	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
	331	return SR_ERR;
	332	break;
	333	case SR_CONF_CURRENT_LIMIT:
	334	dval = g_variant_get_double(data);
	335	if (dval < devc->model->current[0] \|\| dval > devc->model->current[1])
	336	return SR_ERR_ARG;
	337	devc->set_current_limit = dval;
	338	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
	339	return SR_ERR;
	340	break;
	341	case SR_CONF_ENABLED:
	342	bval = g_variant_get_boolean(data);
	343	/* Set always so it is possible turn off with sigrok-cli. */
	344	devc->set_output_enabled = bval;
	345	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
	346	return SR_ERR;
	347	break;
	348	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
	349	bval = g_variant_get_boolean(data);
	350	devc->set_ocp_enabled = bval;
	351	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
	352	return SR_ERR;
	353	break;
	354	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
	355	bval = g_variant_get_boolean(data);
	356	devc->set_ovp_enabled = bval;
	357	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
	358	return SR_ERR;
	359	break;
	360	default:
	361	return SR_ERR_NA;
	362	}
	363
	364	return SR_OK;
	365	}
	366
	367	static int config_list(uint32_t key, GVariant **data,
	368	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	369	{
	370	struct dev_context *devc;
	371
	372	devc = (sdi) ? sdi->priv : NULL;
	373
	374	switch (key) {
	375	case SR_CONF_SCAN_OPTIONS:
	376	case SR_CONF_DEVICE_OPTIONS:
	377	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	378	case SR_CONF_VOLTAGE_TARGET:
	379	if (!devc \|\| !devc->model)
	380	return SR_ERR_ARG;
	381	*data = std_gvar_min_max_step_array(devc->model->voltage);
	382	break;
	383	case SR_CONF_CURRENT_LIMIT:
	384	if (!devc \|\| !devc->model)
	385	return SR_ERR_ARG;
	386	*data = std_gvar_min_max_step_array(devc->model->current);
	387	break;
	388	default:
	389	return SR_ERR_NA;
	390	}
	391
	392	return SR_OK;
	393	}
	394
	395	static int dev_close(struct sr_dev_inst *sdi)
	396	{
	397	struct dev_context *devc;
	398
	399	devc = (sdi) ? sdi->priv : NULL;
	400	if (devc)
	401	g_mutex_clear(&devc->rw_mutex);
	402
	403	return std_serial_dev_close(sdi);
	404	}
	405
	406	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	407	{
	408	struct dev_context *devc;
	409	struct sr_serial_dev_inst *serial;
	410
	411	devc = sdi->priv;
	412
	413	sr_sw_limits_acquisition_start(&devc->limits);
	414	std_session_send_df_header(sdi);
	415
	416	devc->req_sent_at = 0;
	417	serial = sdi->conn;
	418	serial_source_add(sdi->session, serial, G_IO_IN,
	419	KAXXXXP_POLL_INTERVAL_MS,
	420	korad_kaxxxxp_receive_data, (void *)sdi);
	421
	422	return SR_OK;
	423	}
	424
	425	static struct sr_dev_driver korad_kaxxxxp_driver_info = {
	426	.name = "korad-kaxxxxp",
	427	.longname = "Korad KAxxxxP",
	428	.api_version = 1,
	429	.init = std_init,
	430	.cleanup = std_cleanup,
	431	.scan = scan,
	432	.dev_list = std_dev_list,
	433	.dev_clear = std_dev_clear,
	434	.config_get = config_get,
	435	.config_set = config_set,
	436	.config_list = config_list,
	437	.dev_open = std_serial_dev_open,
	438	.dev_close = dev_close,
	439	.dev_acquisition_start = dev_acquisition_start,
	440	.dev_acquisition_stop = std_serial_dev_acquisition_stop,
	441	.context = NULL,
	442	};
	443	SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);