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