[libsigrok.git] / src / hardware / hp-3478a / protocol.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2017-2018 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 <math.h>
#include <stdlib.h>
#include "scpi.h"
#include "protocol.h"

static int set_mq_volt(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
static int set_mq_amp(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
static int set_mq_ohm(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);

static const struct {
	enum sr_mq mq;
	int (*set_mode)(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
} sr_mq_to_cmd_map[] = {
	{ SR_MQ_VOLTAGE, set_mq_volt },
	{ SR_MQ_CURRENT, set_mq_amp },
	{ SR_MQ_RESISTANCE, set_mq_ohm },
};

static int set_mq_volt(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags)
{
	if ((flags & SR_MQFLAG_AC) != SR_MQFLAG_AC &&
		(flags & SR_MQFLAG_DC) != SR_MQFLAG_DC)
		return SR_ERR_NA;

	return sr_scpi_send(scpi, "%s",
		((flags & SR_MQFLAG_AC) == SR_MQFLAG_AC) ? "F2" : "F1");
}

static int set_mq_amp(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags)
{
	if ((flags & SR_MQFLAG_AC) != SR_MQFLAG_AC &&
		(flags & SR_MQFLAG_DC) != SR_MQFLAG_DC)
		return SR_ERR_NA;

	return sr_scpi_send(scpi, "%s", (flags & SR_MQFLAG_AC) ? "F6" : "F5");
}

static int set_mq_ohm(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags)
{
	return sr_scpi_send(scpi, "%s",
		(flags & SR_MQFLAG_FOUR_WIRE) ? "F4" : "F3");
}

SR_PRIV int hp_3478a_set_mq(const struct sr_dev_inst *sdi, enum sr_mq mq,
				enum sr_mqflag mq_flags)
{
	int ret;
	size_t i;
	struct sr_scpi_dev_inst *scpi = sdi->conn;
	struct dev_context *devc = sdi->priv;

	/* No need to send command if we're not changing measurement type. */
	if (devc->measurement_mq == mq &&
		((devc->measurement_mq_flags & mq_flags) == mq_flags))
		return SR_OK;

	for (i = 0; i < ARRAY_SIZE(sr_mq_to_cmd_map); i++) {
		if (sr_mq_to_cmd_map[i].mq != mq)
			continue;

		ret = sr_mq_to_cmd_map[i].set_mode(scpi, mq_flags);
		if (ret != SR_OK)
			return ret;

		ret = hp_3478a_get_status_bytes(sdi);
		return ret;
	}

	return SR_ERR_NA;
}

static int parse_range_vdc(struct dev_context *devc, uint8_t range_byte)
{
	if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_30MV) {
		devc->enc_digits = devc->spec_digits - 2;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_300MV) {
		devc->enc_digits = devc->spec_digits - 3;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_3V) {
		devc->enc_digits = devc->spec_digits - 1;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_30V) {
		devc->enc_digits = devc->spec_digits - 2;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_300V) {
		devc->enc_digits = devc->spec_digits - 3;
	} else {
		return SR_ERR_DATA;
	}

	return SR_OK;
}

static int parse_range_vac(struct dev_context *devc, uint8_t range_byte)
{
	if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_300MV) {
		devc->enc_digits = devc->spec_digits - 3;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_3V) {
		devc->enc_digits = devc->spec_digits - 1;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_30V) {
		devc->enc_digits = devc->spec_digits - 2;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_300V) {
		devc->enc_digits = devc->spec_digits - 3;
	} else {
		return SR_ERR_DATA;
	}

	return SR_OK;
}

static int parse_range_a(struct dev_context *devc, uint8_t range_byte)
{
	if ((range_byte & SB1_RANGE_BLOCK) == RANGE_A_300MA) {
		devc->enc_digits = devc->spec_digits - 3;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_A_3A) {
		devc->enc_digits = devc->spec_digits - 1;
	} else {
		return SR_ERR_DATA;
	}

	return SR_OK;
}

static int parse_range_ohm(struct dev_context *devc, uint8_t range_byte)
{
	if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30R) {
		devc->enc_digits = devc->spec_digits - 2;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_300R) {
		devc->enc_digits = devc->spec_digits - 3;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_3KR) {
		devc->enc_digits = devc->spec_digits - 1;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30KR) {
		devc->enc_digits = devc->spec_digits - 2;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_300KR) {
		devc->enc_digits = devc->spec_digits - 3;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_3MR) {
		devc->enc_digits = devc->spec_digits - 1;
	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30MR) {
		devc->enc_digits = devc->spec_digits - 2;
	} else {
		return SR_ERR_DATA;
	}

	return SR_OK;
}

static int parse_function_byte(struct dev_context *devc, uint8_t function_byte)
{
	devc->measurement_mq_flags = 0;

	/* Function + Range */
	if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_VDC) {
		devc->measurement_mq = SR_MQ_VOLTAGE;
		devc->measurement_mq_flags |= SR_MQFLAG_DC;
		devc->measurement_unit = SR_UNIT_VOLT;
		parse_range_vdc(devc, function_byte);
	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_VAC) {
		devc->measurement_mq = SR_MQ_VOLTAGE;
		devc->measurement_mq_flags |= SR_MQFLAG_AC | SR_MQFLAG_RMS;
		devc->measurement_unit = SR_UNIT_VOLT;
		parse_range_vac(devc, function_byte);
	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_2WR) {
		devc->measurement_mq = SR_MQ_RESISTANCE;
		devc->measurement_unit = SR_UNIT_OHM;
		parse_range_ohm(devc, function_byte);
	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_4WR) {
		devc->measurement_mq = SR_MQ_RESISTANCE;
		devc->measurement_mq_flags |= SR_MQFLAG_FOUR_WIRE;
		devc->measurement_unit = SR_UNIT_OHM;
		parse_range_ohm(devc, function_byte);
	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_ADC) {
		devc->measurement_mq = SR_MQ_CURRENT;
		devc->measurement_mq_flags |= SR_MQFLAG_DC;
		devc->measurement_unit = SR_UNIT_AMPERE;
		parse_range_a(devc, function_byte);
	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_AAC) {
		devc->measurement_mq = SR_MQ_CURRENT;
		devc->measurement_mq_flags |= SR_MQFLAG_AC | SR_MQFLAG_RMS;
		devc->measurement_unit = SR_UNIT_AMPERE;
		parse_range_a(devc, function_byte);
	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_EXR) {
		devc->measurement_mq = SR_MQ_RESISTANCE;
		devc->measurement_unit = SR_UNIT_OHM;
		parse_range_ohm(devc, function_byte);
	}

	/* Digits / Resolution */
	if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_5_5) {
		devc->spec_digits = 5;
	} else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_4_5) {
		devc->spec_digits = 4;
	} else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_3_5) {
		devc->spec_digits = 3;
	}

	return SR_OK;
}

static int parse_status_byte(struct dev_context *devc, uint8_t status_byte)
{
	devc->trigger = TRIGGER_UNDEFINED;

	/* External Trigger */
	if ((status_byte & STATUS_EXT_TRIGGER) == STATUS_EXT_TRIGGER)
		devc->trigger = TRIGGER_EXTERNAL;

	/* Cal RAM */
	if ((status_byte & STATUS_CAL_RAM) == STATUS_CAL_RAM)
		devc->calibration = TRUE;
	else
		devc->calibration = FALSE;

	/* Front/Rear terminals */
	if ((status_byte & STATUS_FRONT_TERMINAL) == STATUS_FRONT_TERMINAL)
		devc->terminal = TERMINAL_FRONT;
	else
		devc->terminal = TERMINAL_REAR;

	/* 50Hz / 60Hz */
	if ((status_byte & STATUS_50HZ) == STATUS_50HZ)
		devc->line = LINE_50HZ;
	else
		devc->line = LINE_60HZ;

	/* Auto-Zero */
	if ((status_byte & STATUS_AUTO_ZERO) == STATUS_AUTO_ZERO)
		devc->auto_zero = TRUE;
	else
		devc->auto_zero = FALSE;

	/* Auto-Range */
	if ((status_byte & STATUS_AUTO_RANGE) == STATUS_AUTO_RANGE)
		devc->measurement_mq_flags |= SR_MQFLAG_AUTORANGE;
	else
		devc->measurement_mq_flags &= ~SR_MQFLAG_AUTORANGE;

	/* Internal trigger */
	if ((status_byte & STATUS_INT_TRIGGER) == STATUS_INT_TRIGGER)
		devc->trigger = TRIGGER_INTERNAL;

	return SR_OK;
}

static int parse_srq_byte(uint8_t sqr_byte)
{
	(void)sqr_byte;

#if 0
	/* The ServiceReQuest register isn't used at the moment. */

	/* PON SRQ */
	if ((sqr_byte & SRQ_POWER_ON) == SRQ_POWER_ON)
		sr_spew("Power On SRQ or clear msg received");

	/* Cal failed SRQ */
	if ((sqr_byte & SRQ_CAL_FAILED) == SRQ_CAL_FAILED)
		sr_spew("CAL failed SRQ");

	/* Keyboard SRQ */
	if ((sqr_byte & SRQ_KEYBORD) == SRQ_KEYBORD)
		sr_spew("Keyboard SRQ");

	/* Hardware error SRQ */
	if ((sqr_byte & SRQ_HARDWARE_ERR) == SRQ_HARDWARE_ERR)
		sr_spew("Hardware error SRQ");

	/* Syntax error SRQ */
	if ((sqr_byte & SRQ_SYNTAX_ERR) == SRQ_SYNTAX_ERR)
		sr_spew("Syntax error SRQ");

	/* Every reading is available to the bus SRQ */
	if ((sqr_byte & SRQ_BUS_AVAIL) == SRQ_BUS_AVAIL)
		sr_spew("Every reading is available to the bus SRQ");
#endif

	return SR_OK;
}

static int parse_error_byte(uint8_t error_byte)
{
	int ret;

	ret = SR_OK;

	/* A/D link */
	if ((error_byte & ERROR_AD_LINK) == ERROR_AD_LINK) {
		sr_err("Failure in the A/D link");
		ret = SR_ERR;
	}

	/* A/D Self Test */
	if ((error_byte & ERROR_AD_SELF_TEST) == ERROR_AD_SELF_TEST) {
		sr_err("A/D has failed its internal Self Test");
		ret = SR_ERR;
	}

	/* A/D slope error */
	if ((error_byte & ERROR_AD_SLOPE) == ERROR_AD_SLOPE) {
		sr_err("There has been an A/D slope error");
		ret = SR_ERR;
	}

	/* ROM Selt Test */
	if ((error_byte & ERROR_ROM_SELF_TEST) == ERROR_ROM_SELF_TEST) {
		sr_err("The ROM Self Test has failed");
		ret = SR_ERR;
	}

	/* RAM Selt Test */
	if ((error_byte & ERROR_RAM_SELF_TEST) == ERROR_RAM_SELF_TEST) {
		sr_err("The RAM Self Test has failed");
		ret = SR_ERR;
	}

	/* Selt Test */
	if ((error_byte & ERROR_SELF_TEST) == ERROR_SELF_TEST) {
		sr_err("Self Test: Any of the CAL RAM locations have bad "
		       "checksums, or a range with a bad checksum is selected");
		ret = SR_ERR;
	}

	return ret;
}

SR_PRIV int hp_3478a_get_status_bytes(const struct sr_dev_inst *sdi)
{
	int ret;
	char *response;
	uint8_t function_byte, status_byte, srq_byte, error_byte;
	struct sr_scpi_dev_inst *scpi = sdi->conn;
	struct dev_context *devc = sdi->priv;

	ret = sr_scpi_get_string(scpi, "B", &response);
	if (ret != SR_OK)
		return ret;

	if (!response)
		return SR_ERR;

	function_byte = (uint8_t)response[0];
	status_byte = (uint8_t)response[1];
	srq_byte = (uint8_t)response[2];
	error_byte = (uint8_t)response[3];

	g_free(response);

	parse_function_byte(devc, function_byte);
	parse_status_byte(devc, status_byte);
	parse_srq_byte(srq_byte);
	ret = parse_error_byte(error_byte);

	return ret;
}

static void acq_send_measurement(struct sr_dev_inst *sdi)
{
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog analog;
	struct sr_analog_encoding encoding;
	struct sr_analog_meaning meaning;
	struct sr_analog_spec spec;
	struct dev_context *devc;
	float f;

	devc = sdi->priv;

	packet.type = SR_DF_ANALOG;
	packet.payload = &analog;

	sr_analog_init(&analog, &encoding, &meaning, &spec, devc->enc_digits);

	/* TODO: Implement NAN, depending on counts, range and value. */
	f = devc->measurement;
	analog.num_samples = 1;
	analog.data = &f;

	encoding.unitsize = sizeof(float);
	encoding.is_float = TRUE;
	encoding.digits = devc->enc_digits;

	meaning.mq = devc->measurement_mq;
	meaning.mqflags = devc->measurement_mq_flags;
	meaning.unit = devc->measurement_unit;
	meaning.channels = sdi->channels;

	spec.spec_digits = devc->spec_digits;

	sr_session_send(sdi, &packet);
}

SR_PRIV int hp_3478a_receive_data(int fd, int revents, void *cb_data)
{
	struct sr_scpi_dev_inst *scpi;
	struct sr_dev_inst *sdi;
	struct dev_context *devc;

	(void)fd;
	(void)revents;

	if (!(sdi = cb_data) || !(devc = sdi->priv))
		return TRUE;

	scpi = sdi->conn;

	/*
	 * This is necessary to get the actual range for the encoding digits.
	 * When SPoll is implemmented, this can be done via SPoll.
	 */
	if (hp_3478a_get_status_bytes(sdi) != SR_OK)
		return FALSE;

	/*
	 * TODO: Implement GPIB-SPoll, to get notified by a SRQ when a new
	 *       measurement is available. This is necessary, because when
	 *       switching ranges, there could be a timeout.
	 */
	if (sr_scpi_get_double(scpi, NULL, &devc->measurement) != SR_OK)
		return FALSE;

	acq_send_measurement(sdi);
	sr_sw_limits_update_samples_read(&devc->limits, 1);

	if (sr_sw_limits_check(&devc->limits))
		sr_dev_acquisition_stop(sdi);

	return TRUE;
}
Commit	Line	Data
1d9eebf4 FS	1	/*
	2	* This file is part of the libsigrok project.
	3	*
d2c1730a	4	* Copyright (C) 2017-2018 Frank Stettner <frank-stettner@gmx.net>
1d9eebf4 FS	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#include <config.h>
d2c1730a FS	21	#include <math.h>
	22	#include <stdlib.h>
	23	#include "scpi.h"
1d9eebf4 FS	24	#include "protocol.h"
1d9eebf4 FS	25
d2c1730a FS	26	static int set_mq_volt(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
	27	static int set_mq_amp(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
	28	static int set_mq_ohm(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags);
	29
	30	static const struct {
	31	enum sr_mq mq;
	32	int (set_mode)(struct sr_scpi_dev_inst scpi, enum sr_mqflag flags);
	33	} sr_mq_to_cmd_map[] = {
	34	{ SR_MQ_VOLTAGE, set_mq_volt },
	35	{ SR_MQ_CURRENT, set_mq_amp },
	36	{ SR_MQ_RESISTANCE, set_mq_ohm },
	37	};
	38
	39	static int set_mq_volt(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags)
	40	{
d2c1730a FS	41	if ((flags & SR_MQFLAG_AC) != SR_MQFLAG_AC &&
	42	(flags & SR_MQFLAG_DC) != SR_MQFLAG_DC)
	43	return SR_ERR_NA;
	44
04c4a677 UH	45	return sr_scpi_send(scpi, "%s",
04c4a677 UH	46	((flags & SR_MQFLAG_AC) == SR_MQFLAG_AC) ? "F2" : "F1");
d2c1730a FS	47	}
	48
	49	static int set_mq_amp(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags)
	50	{
d2c1730a FS	51	if ((flags & SR_MQFLAG_AC) != SR_MQFLAG_AC &&
	52	(flags & SR_MQFLAG_DC) != SR_MQFLAG_DC)
	53	return SR_ERR_NA;
	54
04c4a677	55	return sr_scpi_send(scpi, "%s", (flags & SR_MQFLAG_AC) ? "F6" : "F5");
d2c1730a FS	56	}
	57
	58	static int set_mq_ohm(struct sr_scpi_dev_inst *scpi, enum sr_mqflag flags)
	59	{
04c4a677 UH	60	return sr_scpi_send(scpi, "%s",
04c4a677 UH	61	(flags & SR_MQFLAG_FOUR_WIRE) ? "F4" : "F3");
d2c1730a FS	62	}
	63
	64	SR_PRIV int hp_3478a_set_mq(const struct sr_dev_inst *sdi, enum sr_mq mq,
	65	enum sr_mqflag mq_flags)
	66	{
	67	int ret;
	68	size_t i;
	69	struct sr_scpi_dev_inst *scpi = sdi->conn;
	70	struct dev_context *devc = sdi->priv;
	71
	72	/* No need to send command if we're not changing measurement type. */
	73	if (devc->measurement_mq == mq &&
	74	((devc->measurement_mq_flags & mq_flags) == mq_flags))
	75	return SR_OK;
	76
	77	for (i = 0; i < ARRAY_SIZE(sr_mq_to_cmd_map); i++) {
	78	if (sr_mq_to_cmd_map[i].mq != mq)
	79	continue;
	80
	81	ret = sr_mq_to_cmd_map[i].set_mode(scpi, mq_flags);
	82	if (ret != SR_OK)
	83	return ret;
	84
	85	ret = hp_3478a_get_status_bytes(sdi);
	86	return ret;
	87	}
	88
	89	return SR_ERR_NA;
	90	}
	91
	92	static int parse_range_vdc(struct dev_context *devc, uint8_t range_byte)
	93	{
	94	if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_30MV) {
	95	devc->enc_digits = devc->spec_digits - 2;
	96	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_300MV) {
	97	devc->enc_digits = devc->spec_digits - 3;
	98	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_3V) {
	99	devc->enc_digits = devc->spec_digits - 1;
	100	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_30V) {
	101	devc->enc_digits = devc->spec_digits - 2;
	102	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VDC_300V) {
	103	devc->enc_digits = devc->spec_digits - 3;
	104	} else {
	105	return SR_ERR_DATA;
	106	}
	107
	108	return SR_OK;
	109	}
	110
	111	static int parse_range_vac(struct dev_context *devc, uint8_t range_byte)
	112	{
	113	if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_300MV) {
	114	devc->enc_digits = devc->spec_digits - 3;
	115	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_3V) {
	116	devc->enc_digits = devc->spec_digits - 1;
	117	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_30V) {
	118	devc->enc_digits = devc->spec_digits - 2;
	119	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_VAC_300V) {
	120	devc->enc_digits = devc->spec_digits - 3;
	121	} else {
	122	return SR_ERR_DATA;
	123	}
	124
	125	return SR_OK;
126	}
127
128	static int parse_range_a(struct dev_context *devc, uint8_t range_byte)
129	{
130	if ((range_byte & SB1_RANGE_BLOCK) == RANGE_A_300MA) {
131	devc->enc_digits = devc->spec_digits - 3;
132	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_A_3A) {
133	devc->enc_digits = devc->spec_digits - 1;
134	} else {
135	return SR_ERR_DATA;
136	}
137
138	return SR_OK;
139	}
140
141	static int parse_range_ohm(struct dev_context *devc, uint8_t range_byte)
142	{
143	if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30R) {
144	devc->enc_digits = devc->spec_digits - 2;
145	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_300R) {
146	devc->enc_digits = devc->spec_digits - 3;
147	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_3KR) {
148	devc->enc_digits = devc->spec_digits - 1;
149	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30KR) {
150	devc->enc_digits = devc->spec_digits - 2;
151	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_300KR) {
152	devc->enc_digits = devc->spec_digits - 3;
153	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_3MR) {
154	devc->enc_digits = devc->spec_digits - 1;
155	} else if ((range_byte & SB1_RANGE_BLOCK) == RANGE_OHM_30MR) {
156	devc->enc_digits = devc->spec_digits - 2;
157	} else {
158	return SR_ERR_DATA;
159	}
160
161	return SR_OK;
162	}
163
164	static int parse_function_byte(struct dev_context *devc, uint8_t function_byte)
165	{
166	devc->measurement_mq_flags = 0;
167
168	/* Function + Range */
169	if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_VDC) {
170	devc->measurement_mq = SR_MQ_VOLTAGE;
171	devc->measurement_mq_flags \|= SR_MQFLAG_DC;
172	devc->measurement_unit = SR_UNIT_VOLT;
173	parse_range_vdc(devc, function_byte);
174	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_VAC) {
175	devc->measurement_mq = SR_MQ_VOLTAGE;
176	devc->measurement_mq_flags \|= SR_MQFLAG_AC \| SR_MQFLAG_RMS;
177	devc->measurement_unit = SR_UNIT_VOLT;
178	parse_range_vac(devc, function_byte);
179	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_2WR) {
180	devc->measurement_mq = SR_MQ_RESISTANCE;
181	devc->measurement_unit = SR_UNIT_OHM;
182	parse_range_ohm(devc, function_byte);
183	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_4WR) {
184	devc->measurement_mq = SR_MQ_RESISTANCE;
185	devc->measurement_mq_flags \|= SR_MQFLAG_FOUR_WIRE;
186	devc->measurement_unit = SR_UNIT_OHM;
187	parse_range_ohm(devc, function_byte);
188	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_ADC) {
189	devc->measurement_mq = SR_MQ_CURRENT;
190	devc->measurement_mq_flags \|= SR_MQFLAG_DC;
191	devc->measurement_unit = SR_UNIT_AMPERE;
192	parse_range_a(devc, function_byte);
193	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_AAC) {
194	devc->measurement_mq = SR_MQ_CURRENT;
195	devc->measurement_mq_flags \|= SR_MQFLAG_AC \| SR_MQFLAG_RMS;
196	devc->measurement_unit = SR_UNIT_AMPERE;
197	parse_range_a(devc, function_byte);
198	} else if ((function_byte & SB1_FUNCTION_BLOCK) == FUNCTION_EXR) {
199	devc->measurement_mq = SR_MQ_RESISTANCE;
200	devc->measurement_unit = SR_UNIT_OHM;
201	parse_range_ohm(devc, function_byte);
202	}
203
204	/* Digits / Resolution */
205	if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_5_5) {
206	devc->spec_digits = 5;
207	} else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_4_5) {
208	devc->spec_digits = 4;
209	} else if ((function_byte & SB1_DIGITS_BLOCK) == DIGITS_3_5) {
210	devc->spec_digits = 3;
211	}
212
213	return SR_OK;
214	}
215
216	static int parse_status_byte(struct dev_context *devc, uint8_t status_byte)
217	{
218	devc->trigger = TRIGGER_UNDEFINED;
219
220	/* External Trigger */
221	if ((status_byte & STATUS_EXT_TRIGGER) == STATUS_EXT_TRIGGER)
222	devc->trigger = TRIGGER_EXTERNAL;
223
224	/* Cal RAM */
225	if ((status_byte & STATUS_CAL_RAM) == STATUS_CAL_RAM)
226	devc->calibration = TRUE;
227	else
228	devc->calibration = FALSE;
229
230	/* Front/Rear terminals */
231	if ((status_byte & STATUS_FRONT_TERMINAL) == STATUS_FRONT_TERMINAL)
232	devc->terminal = TERMINAL_FRONT;
233	else
234	devc->terminal = TERMINAL_REAR;
235
236	/* 50Hz / 60Hz */
237	if ((status_byte & STATUS_50HZ) == STATUS_50HZ)
238	devc->line = LINE_50HZ;
239	else
240	devc->line = LINE_60HZ;
241
242	/* Auto-Zero */
243	if ((status_byte & STATUS_AUTO_ZERO) == STATUS_AUTO_ZERO)
244	devc->auto_zero = TRUE;
245	else
246	devc->auto_zero = FALSE;
247
248	/* Auto-Range */
249	if ((status_byte & STATUS_AUTO_RANGE) == STATUS_AUTO_RANGE)
250	devc->measurement_mq_flags \|= SR_MQFLAG_AUTORANGE;
251	else
252	devc->measurement_mq_flags &= ~SR_MQFLAG_AUTORANGE;
253
254	/* Internal trigger */
255	if ((status_byte & STATUS_INT_TRIGGER) == STATUS_INT_TRIGGER)
256	devc->trigger = TRIGGER_INTERNAL;
257
258	return SR_OK;
259	}
260
261	static int parse_srq_byte(uint8_t sqr_byte)
262	{
263	(void)sqr_byte;
264
265	#if 0
266	/* The ServiceReQuest register isn't used at the moment. */
267
268	/* PON SRQ */
269	if ((sqr_byte & SRQ_POWER_ON) == SRQ_POWER_ON)
6ddedf5b	270	sr_spew("Power On SRQ or clear msg received");
d2c1730a FS	271
	272	/* Cal failed SRQ */
	273	if ((sqr_byte & SRQ_CAL_FAILED) == SRQ_CAL_FAILED)
6ddedf5b	274	sr_spew("CAL failed SRQ");
d2c1730a FS	275
	276	/* Keyboard SRQ */
	277	if ((sqr_byte & SRQ_KEYBORD) == SRQ_KEYBORD)
6ddedf5b	278	sr_spew("Keyboard SRQ");
d2c1730a FS	279
	280	/* Hardware error SRQ */
	281	if ((sqr_byte & SRQ_HARDWARE_ERR) == SRQ_HARDWARE_ERR)
6ddedf5b	282	sr_spew("Hardware error SRQ");
d2c1730a FS	283
	284	/* Syntax error SRQ */
	285	if ((sqr_byte & SRQ_SYNTAX_ERR) == SRQ_SYNTAX_ERR)
6ddedf5b	286	sr_spew("Syntax error SRQ");
d2c1730a FS	287
	288	/* Every reading is available to the bus SRQ */
	289	if ((sqr_byte & SRQ_BUS_AVAIL) == SRQ_BUS_AVAIL)
6ddedf5b	290	sr_spew("Every reading is available to the bus SRQ");
d2c1730a FS	291	#endif
	292
	293	return SR_OK;
	294	}
	295
	296	static int parse_error_byte(uint8_t error_byte)
	297	{
	298	int ret;
	299
	300	ret = SR_OK;
	301
	302	/* A/D link */
	303	if ((error_byte & ERROR_AD_LINK) == ERROR_AD_LINK) {
6ddedf5b	304	sr_err("Failure in the A/D link");
d2c1730a FS	305	ret = SR_ERR;
	306	}
	307
	308	/* A/D Self Test */
	309	if ((error_byte & ERROR_AD_SELF_TEST) == ERROR_AD_SELF_TEST) {
6ddedf5b	310	sr_err("A/D has failed its internal Self Test");
d2c1730a FS	311	ret = SR_ERR;
	312	}
	313
	314	/* A/D slope error */
	315	if ((error_byte & ERROR_AD_SLOPE) == ERROR_AD_SLOPE) {
6ddedf5b	316	sr_err("There has been an A/D slope error");
d2c1730a FS	317	ret = SR_ERR;
	318	}
	319
	320	/* ROM Selt Test */
	321	if ((error_byte & ERROR_ROM_SELF_TEST) == ERROR_ROM_SELF_TEST) {
6ddedf5b	322	sr_err("The ROM Self Test has failed");
d2c1730a FS	323	ret = SR_ERR;
	324	}
	325
	326	/* RAM Selt Test */
	327	if ((error_byte & ERROR_RAM_SELF_TEST) == ERROR_RAM_SELF_TEST) {
6ddedf5b	328	sr_err("The RAM Self Test has failed");
d2c1730a FS	329	ret = SR_ERR;
	330	}
	331
	332	/* Selt Test */
	333	if ((error_byte & ERROR_SELF_TEST) == ERROR_SELF_TEST) {
6ddedf5b UH	334	sr_err("Self Test: Any of the CAL RAM locations have bad "
6ddedf5b UH	335	"checksums, or a range with a bad checksum is selected");
d2c1730a FS	336	ret = SR_ERR;
	337	}
	338
	339	return ret;
	340	}
	341
	342	SR_PRIV int hp_3478a_get_status_bytes(const struct sr_dev_inst *sdi)
	343	{
	344	int ret;
	345	char *response;
	346	uint8_t function_byte, status_byte, srq_byte, error_byte;
	347	struct sr_scpi_dev_inst *scpi = sdi->conn;
	348	struct dev_context *devc = sdi->priv;
	349
	350	ret = sr_scpi_get_string(scpi, "B", &response);
	351	if (ret != SR_OK)
	352	return ret;
	353
	354	if (!response)
	355	return SR_ERR;
	356
	357	function_byte = (uint8_t)response[0];
	358	status_byte = (uint8_t)response[1];
	359	srq_byte = (uint8_t)response[2];
	360	error_byte = (uint8_t)response[3];
	361
	362	g_free(response);
	363
	364	parse_function_byte(devc, function_byte);
	365	parse_status_byte(devc, status_byte);
	366	parse_srq_byte(srq_byte);
	367	ret = parse_error_byte(error_byte);
	368
	369	return ret;
	370	}
	371
	372	static void acq_send_measurement(struct sr_dev_inst *sdi)
	373	{
	374	struct sr_datafeed_packet packet;
	375	struct sr_datafeed_analog analog;
	376	struct sr_analog_encoding encoding;
	377	struct sr_analog_meaning meaning;
	378	struct sr_analog_spec spec;
	379	struct dev_context *devc;
	380	float f;
	381
	382	devc = sdi->priv;
	383
	384	packet.type = SR_DF_ANALOG;
	385	packet.payload = &analog;
	386
	387	sr_analog_init(&analog, &encoding, &meaning, &spec, devc->enc_digits);
	388
	389	/* TODO: Implement NAN, depending on counts, range and value. */
	390	f = devc->measurement;
	391	analog.num_samples = 1;
	392	analog.data = &f;
	393
	394	encoding.unitsize = sizeof(float);
	395	encoding.is_float = TRUE;
	396	encoding.digits = devc->enc_digits;
	397
	398	meaning.mq = devc->measurement_mq;
	399	meaning.mqflags = devc->measurement_mq_flags;
400	meaning.unit = devc->measurement_unit;
401	meaning.channels = sdi->channels;
402
403	spec.spec_digits = devc->spec_digits;
404
405	sr_session_send(sdi, &packet);
406	}
407
1d9eebf4 FS	408	SR_PRIV int hp_3478a_receive_data(int fd, int revents, void *cb_data)
1d9eebf4 FS	409	{
d2c1730a FS	410	struct sr_scpi_dev_inst *scpi;
d2c1730a FS	411	struct sr_dev_inst *sdi;
1d9eebf4 FS	412	struct dev_context *devc;
	413
	414	(void)fd;
d2c1730a	415	(void)revents;
1d9eebf4	416
d2c1730a	417	if (!(sdi = cb_data) \|\| !(devc = sdi->priv))
1d9eebf4 FS	418	return TRUE;
1d9eebf4 FS	419
d2c1730a	420	scpi = sdi->conn;
1d9eebf4	421
d2c1730a FS	422	/*
	423	* This is necessary to get the actual range for the encoding digits.
	424	* When SPoll is implemmented, this can be done via SPoll.
	425	*/
	426	if (hp_3478a_get_status_bytes(sdi) != SR_OK)
	427	return FALSE;
	428
	429	/*
	430	* TODO: Implement GPIB-SPoll, to get notified by a SRQ when a new
	431	* measurement is available. This is necessary, because when
	432	* switching ranges, there could be a timeout.
	433	*/
	434	if (sr_scpi_get_double(scpi, NULL, &devc->measurement) != SR_OK)
	435	return FALSE;
	436
	437	acq_send_measurement(sdi);
	438	sr_sw_limits_update_samples_read(&devc->limits, 1);
	439
	440	if (sr_sw_limits_check(&devc->limits))
	441	sr_dev_acquisition_stop(sdi);
1d9eebf4 FS	442
	443	return TRUE;
	444	}