[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[] = {
	/* Device enum, vendor, model, ID reply, channels, voltage, current, quirks. */
	{KORAD_KA3005P, "Korad", "KA3005P", "KORADKA3005PV2.0",
		1, volts_30, amps_5, 0},
	/* Sometimes the KA3005P has an extra 0x01 after the ID. */
	{KORAD_KA3005P_0X01, "Korad", "KA3005P", "KORADKA3005PV2.0\x01",
		1, volts_30, amps_5, 0},
	/* Sometimes the KA3005P has an extra 0xBC after the ID. */
	{KORAD_KA3005P_0XBC, "Korad", "KA3005P", "KORADKA3005PV2.0\xBC",
		1, volts_30, amps_5, 0},
	{KORAD_KA3005P_V42, "Korad", "KA3005P", "KORAD KA3005P V4.2",
		1, volts_30, amps_5, 0},
	{KORAD_KA3005P_V55, "Korad", "KA3005P", "KORAD KA3005P V5.5",
		1, volts_30, amps_5, 0},
	{KORAD_KD3005P_V20, "Korad", "KD3005P", "KORAD KD3005P V2.0",
		1, volts_30, amps_5, 0},
	{KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P", "KORADKD3005PV2.0",
		1, volts_30, amps_5, 0},
	{KORAD_KD3005P_V21_NOSP, "Korad", "KD3005P", "KORADKD3005PV2.1",
		1, volts_30, amps_5, 0},
	{KORAD_KD3005P_V41, "Korad", "KD3005P", "KORAD KD3005P V4.1",
		1, volts_30, amps_5, 0},
	{KORAD_KD3005P_V68, "Korad", "KD3005P", "KORAD KD3005P V6.8",
		1, volts_30, amps_5, 0},
	{KORAD_KD6005P, "Korad", "KD6005P", "KORAD KD6005P V2.2",
		1, volts_60, amps_5, 0},
	{RND_320_KA3005P, "RND", "KA3005P", "RND 320-KA3005P V5.5",
		1, volts_30, amps_5, 0},
	{RND_320_KD3005P, "RND", "KD3005P", "RND 320-KD3005P V4.2",
		1, volts_30, amps_5, 0},
	{RND_320K30PV, "RND", "KA3005P", "RND 320-KA3005P V2.0",
		1, volts_30, amps_5, 0},
	{STAMOS_SLS31_V20, "Stamos Soldering", "S-LS-31", "S-LS-31 V2.0",
		1, volts_30, amps_5, 0},
	{TENMA_72_2535_V21, "Tenma", "72-2535", "TENMA 72-2535 V2.1",
		1, volts_30, amps_3, 0},
	{TENMA_72_2540_V20, "Tenma", "72-2540", "TENMA72-2540V2.0",
		1, volts_30, amps_5, 0},
	{TENMA_72_2540_V21, "Tenma", "72-2540", "TENMA 72-2540 V2.1",
		1, volts_30, amps_5, 0},
	{TENMA_72_2540_V52, "Tenma", "72-2540", "TENMA 72-2540 V5.2",
		1, volts_30, amps_5, 0},
	{TENMA_72_2550_V2, "Tenma", "72-2550", "TENMA72-2550V2.0",
		1, volts_60, amps_3, 0},
	{TENMA_72_2710_V66, "Tenma", "72-2710", "TENMA 72-2710 V6.6",
		1, volts_30, amps_5, 0},
	{VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D", "VELLEMANLABPS3005DV2.0",
		1, volts_30, amps_5, KORAD_QUIRK_LABPS_OVP_EN},
	{VELLEMAN_PS3005D, "Velleman", "PS3005D", "VELLEMANPS3005DV2.0",
		1, volts_30, amps_5, 0},
	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;
	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;

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