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