[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)
{
	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 i, model_id;
	unsigned int len;

	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;

	/* Get the device model. */
	len = 0;
	for (i = 0; models[i].id; i++) {
		if (strlen(models[i].id) > len)
			len = strlen(models[i].id);
	}

	/*
	 * Some models also include the serial number:
	 * RND 320-KD3005P V4.2 SN:59834414
	 */
	len += 12;

	memset(&reply, 0, sizeof(reply));
	sr_dbg("Want max %d bytes.", len);
	if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
		return NULL;

	/* i is used here for debug purposes only. */
	if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
		return NULL;
	sr_dbg("Received: %d, %s", i, reply);
	model_id = -1;

	/* Truncate before serial number. */
	char *sn = g_strrstr(reply, " SN:");
	if (sn)
		*sn = '\0';

	for (i = 0; models[i].id; i++) {
		if (!g_strcmp0(models[i].id, reply))
			model_id = i;
	}
	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);
	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	{
d7083042	96	struct dev_context *devc;
43376f33	97	GSList *l;
d7083042 HV	98	struct sr_dev_inst *sdi;
	99	struct sr_config *src;
	100	const char conn, serialcomm;
e37e301e	101	const char *force_detect;
d7083042 HV	102	struct sr_serial_dev_inst *serial;
	103	char reply[50];
	104	int i, model_id;
	105	unsigned int len;
e75ee7de	106
d7083042 HV	107	conn = NULL;
d7083042 HV	108	serialcomm = NULL;
e37e301e	109	force_detect = NULL;
e75ee7de	110
d7083042 HV	111	for (l = options; l; l = l->next) {
	112	src = l->data;
	113	switch (src->key) {
	114	case SR_CONF_CONN:
	115	conn = g_variant_get_string(src->data, NULL);
	116	break;
	117	case SR_CONF_SERIALCOMM:
	118	serialcomm = g_variant_get_string(src->data, NULL);
	119	break;
e37e301e GS	120	case SR_CONF_FORCE_DETECT:
	121	force_detect = g_variant_get_string(src->data, NULL);
	122	break;
d7083042 HV	123	default:
	124	sr_err("Unknown option %d, skipping.", src->key);
	125	break;
	126	}
	127	}
	128
	129	if (!conn)
	130	return NULL;
	131	if (!serialcomm)
	132	serialcomm = "9600/8n1";
e37e301e GS	133	if (force_detect && !*force_detect)
e37e301e GS	134	force_detect = NULL;
d7083042 HV	135
	136	serial = sr_serial_dev_inst_new(conn, serialcomm);
	137	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	138	return NULL;
	139
d7083042 HV	140	/* Get the device model. */
	141	len = 0;
	142	for (i = 0; models[i].id; i++) {
	143	if (strlen(models[i].id) > len)
	144	len = strlen(models[i].id);
	145	}
cf6beeb2 PÅ	146
	147	/*
	148	* Some models also include the serial number:
	149	* RND 320-KD3005P V4.2 SN:59834414
	150	*/
	151	len += 12;
	152
d7083042 HV	153	memset(&reply, 0, sizeof(reply));
d7083042 HV	154	sr_dbg("Want max %d bytes.", len);
16fc7ee2	155	if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
d7083042 HV	156	return NULL;
	157
	158	/* i is used here for debug purposes only. */
16fc7ee2	159	if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
d7083042 HV	160	return NULL;
	161	sr_dbg("Received: %d, %s", i, reply);
	162	model_id = -1;
cf6beeb2 PÅ	163
	164	/* Truncate before serial number. */
	165	char *sn = g_strrstr(reply, " SN:");
	166	if (sn)
	167	*sn = '\0';
	168
d7083042	169	for (i = 0; models[i].id; i++) {
1c0e1baa	170	if (!g_strcmp0(models[i].id, reply))
d7083042 HV	171	model_id = i;
d7083042 HV	172	}
e37e301e GS	173	if (model_id < 0 && force_detect) {
	174	sr_warn("Found model ID '%s' is unknown, trying '%s' spec.",
	175	reply, force_detect);
	176	for (i = 0; models[i].id; i++) {
	177	if (strcmp(models[i].id, force_detect) != 0)
	178	continue;
	179	sr_info("Found replacement, using it instead.");
	180	model_id = i;
	181	break;
	182	}
	183	}
d7083042 HV	184	if (model_id < 0) {
	185	sr_err("Unknown model ID '%s' detected, aborting.", reply);
	186	return NULL;
	187	}
a078d3ec UH	188	sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
a078d3ec UH	189	models[model_id].name, model_id, models[model_id].id);
d7083042	190
d7083042 HV	191	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	192	sdi->status = SR_ST_INACTIVE;
	193	sdi->vendor = g_strdup(models[model_id].vendor);
	194	sdi->model = g_strdup(models[model_id].name);
	195	sdi->inst_type = SR_INST_SERIAL;
	196	sdi->conn = serial;
048250d0	197	sdi->connection_id = g_strdup(conn);
d7083042	198
23165d7b FS	199	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
23165d7b FS	200	sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
d7083042 HV	201
d7083042 HV	202	devc = g_malloc0(sizeof(struct dev_context));
597deef9	203	sr_sw_limits_init(&devc->limits);
3f9b48ae	204	g_mutex_init(&devc->rw_mutex);
d7083042	205	devc->model = &models[model_id];
d7083042	206	devc->req_sent_at = 0;
2e129b8b FS	207	devc->cc_mode_1_changed = FALSE;
	208	devc->cc_mode_2_changed = FALSE;
	209	devc->output_enabled_changed = FALSE;
	210	devc->ocp_enabled_changed = FALSE;
	211	devc->ovp_enabled_changed = FALSE;
d7083042 HV	212	sdi->priv = devc;
	213
	214	/* Get current status of device. */
16fc7ee2	215	if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
d7083042	216	goto exit_err;
d7083042 HV	217
d7083042 HV	218	serial_close(serial);
e75ee7de	219
43376f33	220	return std_scan_complete(di, g_slist_append(NULL, sdi));
d7083042 HV	221
	222	exit_err:
	223	sr_dev_inst_free(sdi);
	224	g_free(devc);
	225	sr_dbg("Scan failed.");
	226
	227	return NULL;
e75ee7de HV	228	}
e75ee7de HV	229
e75ee7de HV	230	static int config_get(uint32_t key, GVariant **data,
	231	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	232	{
d7083042	233	struct dev_context *devc;
e75ee7de	234
e75ee7de HV	235	(void)cg;
e75ee7de HV	236
d7083042 HV	237	if (!sdi \|\| !data)
	238	return SR_ERR_ARG;
	239
	240	devc = sdi->priv;
	241
e75ee7de	242	switch (key) {
cd04f641 UH	243	case SR_CONF_LIMIT_SAMPLES:
cd04f641 UH	244	case SR_CONF_LIMIT_MSEC:
597deef9	245	return sr_sw_limits_config_get(&devc->limits, key, data);
048250d0 GS	246	case SR_CONF_CONN:
	247	*data = g_variant_new_string(sdi->connection_id);
	248	break;
d7083042	249	case SR_CONF_VOLTAGE:
3f9b48ae	250	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
d7083042 HV	251	*data = g_variant_new_double(devc->voltage);
	252	break;
	253	case SR_CONF_VOLTAGE_TARGET:
8da30037 FS	254	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
8da30037 FS	255	*data = g_variant_new_double(devc->voltage_target);
d7083042 HV	256	break;
d7083042 HV	257	case SR_CONF_CURRENT:
3f9b48ae	258	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
d7083042 HV	259	*data = g_variant_new_double(devc->current);
	260	break;
	261	case SR_CONF_CURRENT_LIMIT:
8da30037 FS	262	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
8da30037 FS	263	*data = g_variant_new_double(devc->current_limit);
d7083042 HV	264	break;
d7083042 HV	265	case SR_CONF_ENABLED:
3f9b48ae	266	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
d7083042 HV	267	*data = g_variant_new_boolean(devc->output_enabled);
d7083042 HV	268	break;
b16d975a HV	269	case SR_CONF_REGULATION:
b16d975a HV	270	/* Dual channel not supported. */
3f9b48ae	271	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
9e5366df	272	*data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
b16d975a	273	break;
c40ed60f	274	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
3f9b48ae	275	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
9e5366df	276	*data = g_variant_new_boolean(devc->ocp_enabled);
c40ed60f HV	277	break;
c40ed60f HV	278	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
3f9b48ae	279	korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
9e5366df	280	*data = g_variant_new_boolean(devc->ovp_enabled);
c40ed60f	281	break;
e75ee7de HV	282	default:
	283	return SR_ERR_NA;
	284	}
	285
d7083042	286	return SR_OK;
e75ee7de HV	287	}
	288
	289	static int config_set(uint32_t key, GVariant *data,
	290	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	291	{
d7083042 HV	292	struct dev_context *devc;
	293	double dval;
	294	gboolean bval;
e75ee7de	295
e75ee7de HV	296	(void)cg;
e75ee7de HV	297
d7083042 HV	298	devc = sdi->priv;
d7083042 HV	299
e75ee7de	300	switch (key) {
d7083042	301	case SR_CONF_LIMIT_MSEC:
d7083042	302	case SR_CONF_LIMIT_SAMPLES:
597deef9	303	return sr_sw_limits_config_set(&devc->limits, key, data);
d7083042 HV	304	case SR_CONF_VOLTAGE_TARGET:
	305	dval = g_variant_get_double(data);
	306	if (dval < devc->model->voltage[0] \|\| dval > devc->model->voltage[1])
	307	return SR_ERR_ARG;
8da30037 FS	308	devc->set_voltage_target = dval;
8da30037 FS	309	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
d7083042 HV	310	return SR_ERR;
	311	break;
	312	case SR_CONF_CURRENT_LIMIT:
	313	dval = g_variant_get_double(data);
	314	if (dval < devc->model->current[0] \|\| dval > devc->model->current[1])
	315	return SR_ERR_ARG;
8da30037 FS	316	devc->set_current_limit = dval;
8da30037 FS	317	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
d7083042 HV	318	return SR_ERR;
	319	break;
	320	case SR_CONF_ENABLED:
	321	bval = g_variant_get_boolean(data);
	322	/* Set always so it is possible turn off with sigrok-cli. */
8da30037	323	devc->set_output_enabled = bval;
3f9b48ae	324	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
d7083042	325	return SR_ERR;
c40ed60f HV	326	break;
	327	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
	328	bval = g_variant_get_boolean(data);
8da30037	329	devc->set_ocp_enabled = bval;
3f9b48ae	330	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
c40ed60f HV	331	return SR_ERR;
	332	break;
	333	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
	334	bval = g_variant_get_boolean(data);
8da30037	335	devc->set_ovp_enabled = bval;
3f9b48ae	336	if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
c40ed60f	337	return SR_ERR;
d7083042	338	break;
e75ee7de	339	default:
d7083042	340	return SR_ERR_NA;
e75ee7de HV	341	}
e75ee7de HV	342
d7083042	343	return SR_OK;
e75ee7de HV	344	}
	345
	346	static int config_list(uint32_t key, GVariant **data,
	347	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	348	{
d7083042	349	struct dev_context *devc;
d7083042	350
e66d1892	351	devc = (sdi) ? sdi->priv : NULL;
d7083042	352
e75ee7de	353	switch (key) {
e66d1892	354	case SR_CONF_SCAN_OPTIONS:
d7083042	355	case SR_CONF_DEVICE_OPTIONS:
e66d1892	356	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
d7083042	357	case SR_CONF_VOLTAGE_TARGET:
fc69eecc GS	358	if (!devc \|\| !devc->model)
fc69eecc GS	359	return SR_ERR_ARG;
54d471f4	360	*data = std_gvar_min_max_step_array(devc->model->voltage);
d7083042 HV	361	break;
d7083042 HV	362	case SR_CONF_CURRENT_LIMIT:
fc69eecc GS	363	if (!devc \|\| !devc->model)
fc69eecc GS	364	return SR_ERR_ARG;
54d471f4	365	*data = std_gvar_min_max_step_array(devc->model->current);
d7083042	366	break;
e75ee7de HV	367	default:
	368	return SR_ERR_NA;
	369	}
	370
d7083042	371	return SR_OK;
e75ee7de HV	372	}
e75ee7de HV	373
3f9b48ae FS	374	static int dev_close(struct sr_dev_inst *sdi)
	375	{
	376	struct dev_context *devc;
	377
	378	devc = (sdi) ? sdi->priv : NULL;
	379	if (devc)
	380	g_mutex_clear(&devc->rw_mutex);
	381
	382	return std_serial_dev_close(sdi);
	383	}
	384
695dc859	385	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e75ee7de	386	{
d7083042 HV	387	struct dev_context *devc;
d7083042 HV	388	struct sr_serial_dev_inst *serial;
e75ee7de	389
d7083042	390	devc = sdi->priv;
d7083042	391
597deef9	392	sr_sw_limits_acquisition_start(&devc->limits);
bee2b016	393	std_session_send_df_header(sdi);
d7083042	394
d7083042 HV	395	devc->req_sent_at = 0;
	396	serial = sdi->conn;
	397	serial_source_add(sdi->session, serial, G_IO_IN,
16fc7ee2 UH	398	KAXXXXP_POLL_INTERVAL_MS,
16fc7ee2 UH	399	korad_kaxxxxp_receive_data, (void *)sdi);
e75ee7de HV	400
	401	return SR_OK;
	402	}
	403
dd5c48a6	404	static struct sr_dev_driver korad_kaxxxxp_driver_info = {
16fc7ee2 UH	405	.name = "korad-kaxxxxp",
16fc7ee2 UH	406	.longname = "Korad KAxxxxP",
e75ee7de	407	.api_version = 1,
c2fdcc25	408	.init = std_init,
700d6b64	409	.cleanup = std_cleanup,
e75ee7de	410	.scan = scan,
c01bf34c	411	.dev_list = std_dev_list,
f778bf02	412	.dev_clear = std_dev_clear,
e75ee7de HV	413	.config_get = config_get,
	414	.config_set = config_set,
	415	.config_list = config_list,
d7083042	416	.dev_open = std_serial_dev_open,
3f9b48ae	417	.dev_close = dev_close,
e75ee7de	418	.dev_acquisition_start = dev_acquisition_start,
4b1a9d5d	419	.dev_acquisition_stop = std_serial_dev_acquisition_stop,
e75ee7de HV	420	.context = NULL,
e75ee7de HV	421	};
dd5c48a6	422	SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);