[libsigrok.git] / src / hardware / hp-3457a / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2016 Alexandru Gagniuc <mr.nuke.me@gmail.com>
 *
 * 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 <scpi.h>
#include <string.h>
#include "protocol.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
};

static const uint32_t drvopts[] = {
	SR_CONF_MULTIMETER,
};

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_MEASURED_QUANTITY | SR_CONF_SET,
	SR_CONF_ADC_POWERLINE_CYCLES | SR_CONF_SET | SR_CONF_GET,
};

static struct sr_dev_driver hp_3457a_driver_info;

static int create_front_channel(struct sr_dev_inst *sdi, int chan_idx)
{
	struct sr_channel *channel;
	struct sr_channel_group *front;
	struct channel_context *chanc;

	chanc = g_malloc(sizeof(*chanc));
	chanc->location = CONN_FRONT;

	channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG,
				 TRUE, "Front");
	channel->priv = chanc;

	front = g_malloc0(sizeof(*front));
	front->name = g_strdup("Front");
	front->channels = g_slist_append(front->channels, channel);

	sdi->channel_groups = g_slist_append(sdi->channel_groups, front);

	return chan_idx;
}

static int create_rear_channels(struct sr_dev_inst *sdi, int chan_idx,
				 const struct rear_card_info *card)
{
	unsigned int i;
	struct sr_channel *channel;
	struct sr_channel_group *group;
	struct channel_context *chanc;
	char name[16];

	/* When card is NULL, we couldn't identify the type of card. */
	if (!card)
		return chan_idx;

	group = g_malloc0(sizeof(*group));
	group->priv = NULL;
	group->name = g_strdup(card->cg_name);
	sdi->channel_groups = g_slist_append(sdi->channel_groups, group);

	for (i = 0; i < card->num_channels; i++) {

		chanc = g_malloc(sizeof(*chanc));
		chanc->location = CONN_REAR;

		if (card->type == REAR_TERMINALS) {
			chanc->index = -1;
			g_snprintf(name, sizeof(name), "%s", card->cg_name);
		} else {
			chanc->index = i;
			g_snprintf(name, sizeof(name), "%s%u", card->cg_name, i);
		}

		channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG,
					FALSE, name);
		channel->priv = chanc;
		group->channels = g_slist_append(group->channels, channel);
	}

	return chan_idx;
}

static gchar *get_revision(struct sr_scpi_dev_inst *scpi)
{
	int ret, major, minor;
	GArray *rev_numbers;

	/* Report a version of '0.0' if we can't parse the response. */
	major = minor = 0;

	ret = sr_scpi_get_floatv(scpi, "REV?", &rev_numbers);
	if ((ret == SR_OK) && (rev_numbers->len >= 2)) {
		major = (int)g_array_index(rev_numbers, float, 0);
		minor = (int)g_array_index(rev_numbers, float, 1);
	}

	g_array_free(rev_numbers, TRUE);

	return g_strdup_printf("%d.%d", major, minor);
}

static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
{
	int ret, idx;
	char *response;
	struct sr_dev_inst *sdi;
	struct dev_context *devc;

	/*
	 * This command ensures we receive an EOI after every response, so that
	 * we don't wait the entire timeout after the response is received.
	 */
	if (sr_scpi_send(scpi, "END ALWAYS") != SR_OK)
		return NULL;

	ret = sr_scpi_get_string(scpi, "ID?", &response);
	if ((ret != SR_OK) || !response)
		return NULL;

	if (strcmp(response, "HP3457A"))
		return NULL;

	g_free(response);

	devc = g_malloc0(sizeof(struct dev_context));
	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->vendor = g_strdup("Hewlett-Packard");
	sdi->model = g_strdup("3457A");
	sdi->version = get_revision(scpi);
	sdi->conn = scpi;
	sdi->driver = &hp_3457a_driver_info;
	sdi->inst_type = SR_INST_SCPI;
	sdi->priv = devc;

	/* There is no way to probe the measurement mode. It must be set. */
	devc->measurement_mq = 0;
	devc->measurement_unit = 0;

	/* Probe rear card option and create channels accordingly (TODO). */
	devc->rear_card = hp_3457a_probe_rear_card(scpi);
	idx = 0;
	idx = create_front_channel(sdi, idx);
	create_rear_channels(sdi, idx, devc->rear_card);

	return sdi;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	return sr_scpi_scan(di->context, options, probe_device);
}

/*
 * We need to set the HP 3457A to a known state, and there are quite a number
 * of knobs to tweak. Here's a brief explanation of what's going on. For more
 * details, print out and consult the user manual.
 *   PRESET
 *     Set the instrument to a pre-determined state. This is easier and faster
 *     than sending a few dozen commands. Some of the PRESET defaults include
 *     ASCII output format, and synchronous triggering. See user manual for
 *     more details.
 *
 * After the PRESET command, the instrument is in a known state, and only those
 * parameters for which the default is unsuitable are modified:
 *   INBUF ON
 *     Enable the HP-IB input buffer. This allows the instrument to release the
 *     HP-IB bus before processing the command, and increases throughput on
 *     GPIB buses with more than one device.
 *   TRIG HOLD
 *     Do not trigger new measurements until instructed to do so.
 */
static int dev_open(struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi = sdi->conn;
	struct dev_context *devc;

	if (sr_scpi_open(scpi) != SR_OK)
		return SR_ERR;

	devc = sdi->priv;

	sr_scpi_send(scpi, "PRESET");
	sr_scpi_send(scpi, "INBUF ON");
	sr_scpi_send(scpi, "TRIG HOLD");
	sr_scpi_get_float(scpi, "NPLC?", &devc->nplc);

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi = sdi->conn;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	/* Disable scan-advance (preserve relay life). */
	sr_scpi_send(scpi, "SADV HOLD");
	/* Switch back to auto-triggering. */
	sr_scpi_send(scpi, "TRIG AUTO");

	sr_scpi_close(scpi);

	sdi->status = SR_ST_INACTIVE;

	return SR_OK;
}

static int config_get(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	int ret;
	struct dev_context *devc;

	(void)cg;

	devc = sdi->priv;

	ret = SR_OK;
	switch (key) {
	case SR_CONF_ADC_POWERLINE_CYCLES:
		*data = g_variant_new_double(devc->nplc);
		break;
	default:
		return SR_ERR_NA;
	}

	return ret;
}

static int config_set(uint32_t key, GVariant *data,
		      const struct sr_dev_inst *sdi,
		      const struct sr_channel_group *cg)
{
	int ret;
	enum sr_mq mq;
	enum sr_mqflag mq_flags;
	struct dev_context *devc;
	GVariant *tuple_child;

	(void)cg;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	devc = sdi->priv;

	ret = SR_OK;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	case SR_CONF_MEASURED_QUANTITY:
		tuple_child = g_variant_get_child_value(data, 0);
		mq = g_variant_get_uint32(tuple_child);
		tuple_child = g_variant_get_child_value(data, 1);
		mq_flags = g_variant_get_uint64(tuple_child);
		ret = hp_3457a_set_mq(sdi, mq, mq_flags);
		g_variant_unref(tuple_child);
		break;
	case SR_CONF_ADC_POWERLINE_CYCLES:
		ret = hp_3457a_set_nplc(sdi, g_variant_get_double(data));
		break;
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	int ret;

	if (key == SR_CONF_SCAN_OPTIONS) {
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
			scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		return SR_OK;
	} else if ((key == SR_CONF_DEVICE_OPTIONS) && !sdi) {
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
			drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
		return SR_OK;
	} else if ((key == SR_CONF_DEVICE_OPTIONS) && !cg) {
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
			devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		return SR_OK;
	}

	/* From here on, we're only concerned with channel group config. */
	if (!cg)
		return SR_ERR_NA;

	/*
	 * TODO: Implement channel group configuration when adding support for
	 * plug-in cards.
	 */

	ret = SR_OK;
	switch (key) {
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

static void create_channel_index_list(GSList *channels, GArray **arr)
{
	struct sr_channel *channel;
	struct channel_context *chanc;
	GSList *list_elem;

	*arr = g_array_new(FALSE, FALSE, sizeof(unsigned int));

	for (list_elem = channels; list_elem; list_elem = list_elem->next) {
		channel = list_elem->data;
		chanc = channel->priv;
		g_array_append_val(*arr, chanc->index);
	}
}

/*
 * TRIG SGL
 *   Trigger the first measurement, then hold. We can't let the instrument
 *   auto-trigger because we read several registers to make a complete
 *   reading. If the instrument were auto-triggering, we could get the
 *   reading for sample N, but a new measurement is made and when we read the
 *   HIRES register, it contains data for sample N+1. This would produce
 *   wrong readings.
 * SADV AUTO
 *   Activate the scan-advance feature. This automatically connects the next
 *   channel in the scan list to the A/D converter. This way, we do not need to
 *   occupy the HP-IB bus to send channel select commands.
 */
static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	int ret;
	gboolean front_selected, rear_selected;
	struct sr_scpi_dev_inst *scpi;
	struct sr_channel *channel;
	struct dev_context *devc;
	struct channel_context *chanc;
	GArray *ch_list;
	GSList *channels;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	scpi = sdi->conn;
	devc = sdi->priv;

	ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100,
				 hp_3457a_receive_data, (void *)sdi);
	if (ret != SR_OK)
		return ret;

	std_session_send_df_header(sdi, LOG_PREFIX);

	front_selected = rear_selected = FALSE;
	devc->active_channels = NULL;

	for (channels = sdi->channels; channels; channels = channels->next) {
		channel = channels->data;

		if (!channel->enabled)
			continue;

		chanc = channel->priv;

		if (chanc->location == CONN_FRONT)
			front_selected = TRUE;
		if (chanc->location == CONN_REAR)
			rear_selected = TRUE;

		devc->active_channels = g_slist_append(devc->active_channels, channel);
	}

	if (front_selected && rear_selected) {
		sr_err("Can not use front and rear channels at the same time!");
		g_slist_free(devc->active_channels);
		return SR_ERR_ARG;
	}

	devc->current_channel = devc->active_channels->data;
	devc->num_active_channels = g_slist_length(devc->active_channels);

	hp_3457a_select_input(sdi, front_selected ? CONN_FRONT : CONN_REAR);

	/* For plug-in cards, use the scan-advance features to scan channels. */
	if (rear_selected && (devc->rear_card->card_id != REAR_TERMINALS)) {
		create_channel_index_list(devc->active_channels, &ch_list);
		hp_3457a_send_scan_list(sdi, (void *)ch_list->data, ch_list->len);
		sr_scpi_send(scpi, "SADV AUTO");
		g_array_free(ch_list, TRUE);
	}

	/* Start first measurement. */
	sr_scpi_send(scpi, "TRIG SGL");
	devc->acq_state = ACQ_TRIGGERED_MEASUREMENT;
	devc->num_samples = 0;

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	devc = sdi->priv;

	g_slist_free(devc->active_channels);

	return SR_OK;
}

static struct sr_dev_driver hp_3457a_driver_info = {
	.name = "hp-3457a",
	.longname = "HP 3457A",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(hp_3457a_driver_info);
Commit	Line	Data
00b2a092 AG	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2016 Alexandru Gagniuc <mr.nuke.me@gmail.com>
	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>
db23af7f AG	21	#include <scpi.h>
db23af7f AG	22	#include <string.h>
00b2a092 AG	23	#include "protocol.h"
00b2a092 AG	24
db23af7f AG	25	static const uint32_t scanopts[] = {
	26	SR_CONF_CONN,
	27	};
	28
	29	static const uint32_t drvopts[] = {
	30	SR_CONF_MULTIMETER,
	31	};
	32
	33	static const uint32_t devopts[] = {
e91bb0a6	34	SR_CONF_CONTINUOUS,
db23af7f AG	35	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	36	SR_CONF_MEASURED_QUANTITY \| SR_CONF_SET,
	37	SR_CONF_ADC_POWERLINE_CYCLES \| SR_CONF_SET \| SR_CONF_GET,
	38	};
	39
dd5c48a6	40	static struct sr_dev_driver hp_3457a_driver_info;
00b2a092	41
db23af7f	42	static int create_front_channel(struct sr_dev_inst *sdi, int chan_idx)
00b2a092	43	{
db23af7f AG	44	struct sr_channel *channel;
db23af7f AG	45	struct sr_channel_group *front;
9a093be9 AG	46	struct channel_context *chanc;
	47
	48	chanc = g_malloc(sizeof(*chanc));
	49	chanc->location = CONN_FRONT;
db23af7f AG	50
	51	channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG,
	52	TRUE, "Front");
9a093be9	53	channel->priv = chanc;
db23af7f AG	54
	55	front = g_malloc0(sizeof(*front));
	56	front->name = g_strdup("Front");
	57	front->channels = g_slist_append(front->channels, channel);
9a093be9	58
db23af7f AG	59	sdi->channel_groups = g_slist_append(sdi->channel_groups, front);
	60
	61	return chan_idx;
00b2a092 AG	62	}
00b2a092 AG	63
db23af7f AG	64	static int create_rear_channels(struct sr_dev_inst *sdi, int chan_idx,
	65	const struct rear_card_info *card)
	66	{
9a093be9 AG	67	unsigned int i;
	68	struct sr_channel *channel;
	69	struct sr_channel_group *group;
	70	struct channel_context *chanc;
	71	char name[16];
db23af7f AG	72
	73	/* When card is NULL, we couldn't identify the type of card. */
	74	if (!card)
	75	return chan_idx;
	76
9a093be9 AG	77	group = g_malloc0(sizeof(*group));
	78	group->priv = NULL;
	79	group->name = g_strdup(card->cg_name);
	80	sdi->channel_groups = g_slist_append(sdi->channel_groups, group);
	81
	82	for (i = 0; i < card->num_channels; i++) {
	83
	84	chanc = g_malloc(sizeof(*chanc));
	85	chanc->location = CONN_REAR;
	86
	87	if (card->type == REAR_TERMINALS) {
	88	chanc->index = -1;
	89	g_snprintf(name, sizeof(name), "%s", card->cg_name);
	90	} else {
	91	chanc->index = i;
	92	g_snprintf(name, sizeof(name), "%s%u", card->cg_name, i);
	93	}
	94
	95	channel = sr_channel_new(sdi, chan_idx++, SR_CHANNEL_ANALOG,
	96	FALSE, name);
	97	channel->priv = chanc;
	98	group->channels = g_slist_append(group->channels, channel);
	99	}
	100
db23af7f AG	101	return chan_idx;
	102	}
	103
	104	static gchar get_revision(struct sr_scpi_dev_inst scpi)
00b2a092	105	{
db23af7f AG	106	int ret, major, minor;
	107	GArray *rev_numbers;
	108
	109	/* Report a version of '0.0' if we can't parse the response. */
	110	major = minor = 0;
	111
	112	ret = sr_scpi_get_floatv(scpi, "REV?", &rev_numbers);
	113	if ((ret == SR_OK) && (rev_numbers->len >= 2)) {
	114	major = (int)g_array_index(rev_numbers, float, 0);
	115	minor = (int)g_array_index(rev_numbers, float, 1);
	116	}
00b2a092	117
db23af7f	118	g_array_free(rev_numbers, TRUE);
00b2a092	119
db23af7f AG	120	return g_strdup_printf("%d.%d", major, minor);
db23af7f AG	121	}
00b2a092	122
db23af7f AG	123	static struct sr_dev_inst probe_device(struct sr_scpi_dev_inst scpi)
	124	{
	125	int ret, idx;
	126	char *response;
	127	struct sr_dev_inst *sdi;
	128	struct dev_context *devc;
	129
	130	/*
	131	* This command ensures we receive an EOI after every response, so that
	132	* we don't wait the entire timeout after the response is received.
	133	*/
	134	if (sr_scpi_send(scpi, "END ALWAYS") != SR_OK)
	135	return NULL;
	136
	137	ret = sr_scpi_get_string(scpi, "ID?", &response);
	138	if ((ret != SR_OK) \|\| !response)
	139	return NULL;
	140
	141	if (strcmp(response, "HP3457A"))
	142	return NULL;
	143
	144	g_free(response);
	145
	146	devc = g_malloc0(sizeof(struct dev_context));
	147	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	148	sdi->vendor = g_strdup("Hewlett-Packard");
	149	sdi->model = g_strdup("3457A");
	150	sdi->version = get_revision(scpi);
	151	sdi->conn = scpi;
	152	sdi->driver = &hp_3457a_driver_info;
	153	sdi->inst_type = SR_INST_SCPI;
	154	sdi->priv = devc;
	155
	156	/* There is no way to probe the measurement mode. It must be set. */
	157	devc->measurement_mq = 0;
	158	devc->measurement_unit = 0;
	159
	160	/* Probe rear card option and create channels accordingly (TODO). */
	161	devc->rear_card = hp_3457a_probe_rear_card(scpi);
	162	idx = 0;
	163	idx = create_front_channel(sdi, idx);
	164	create_rear_channels(sdi, idx, devc->rear_card);
	165
	166	return sdi;
	167	}
00b2a092	168
db23af7f AG	169	static GSList scan(struct sr_dev_driver di, GSList *options)
	170	{
	171	return sr_scpi_scan(di->context, options, probe_device);
00b2a092 AG	172	}
00b2a092 AG	173
db23af7f AG	174	/*
	175	* We need to set the HP 3457A to a known state, and there are quite a number
	176	* of knobs to tweak. Here's a brief explanation of what's going on. For more
	177	* details, print out and consult the user manual.
	178	* PRESET
	179	* Set the instrument to a pre-determined state. This is easier and faster
	180	* than sending a few dozen commands. Some of the PRESET defaults include
	181	* ASCII output format, and synchronous triggering. See user manual for
	182	* more details.
	183	*
	184	* After the PRESET command, the instrument is in a known state, and only those
	185	* parameters for which the default is unsuitable are modified:
	186	* INBUF ON
	187	* Enable the HP-IB input buffer. This allows the instrument to release the
	188	* HP-IB bus before processing the command, and increases throughput on
	189	* GPIB buses with more than one device.
	190	* TRIG HOLD
	191	* Do not trigger new measurements until instructed to do so.
	192	*/
00b2a092 AG	193	static int dev_open(struct sr_dev_inst *sdi)
00b2a092 AG	194	{
db23af7f AG	195	struct sr_scpi_dev_inst *scpi = sdi->conn;
	196	struct dev_context *devc;
	197
	198	if (sr_scpi_open(scpi) != SR_OK)
	199	return SR_ERR;
00b2a092	200
61c90858	201	devc = sdi->priv;
db23af7f AG	202
	203	sr_scpi_send(scpi, "PRESET");
	204	sr_scpi_send(scpi, "INBUF ON");
	205	sr_scpi_send(scpi, "TRIG HOLD");
	206	sr_scpi_get_float(scpi, "NPLC?", &devc->nplc);
00b2a092 AG	207
	208	sdi->status = SR_ST_ACTIVE;
	209
	210	return SR_OK;
	211	}
	212
	213	static int dev_close(struct sr_dev_inst *sdi)
	214	{
db23af7f AG	215	struct sr_scpi_dev_inst *scpi = sdi->conn;
	216
	217	if (sdi->status != SR_ST_ACTIVE)
	218	return SR_ERR_DEV_CLOSED;
00b2a092	219
9a093be9 AG	220	/* Disable scan-advance (preserve relay life). */
9a093be9 AG	221	sr_scpi_send(scpi, "SADV HOLD");
db23af7f AG	222	/* Switch back to auto-triggering. */
	223	sr_scpi_send(scpi, "TRIG AUTO");
	224
	225	sr_scpi_close(scpi);
00b2a092 AG	226
	227	sdi->status = SR_ST_INACTIVE;
	228
	229	return SR_OK;
	230	}
	231
00b2a092 AG	232	static int config_get(uint32_t key, GVariant **data,
	233	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	234	{
	235	int ret;
db23af7f	236	struct dev_context *devc;
00b2a092	237
00b2a092 AG	238	(void)cg;
00b2a092 AG	239
db23af7f AG	240	devc = sdi->priv;
db23af7f AG	241
00b2a092 AG	242	ret = SR_OK;
00b2a092 AG	243	switch (key) {
db23af7f AG	244	case SR_CONF_ADC_POWERLINE_CYCLES:
	245	*data = g_variant_new_double(devc->nplc);
	246	break;
00b2a092 AG	247	default:
	248	return SR_ERR_NA;
	249	}
	250
	251	return ret;
	252	}
	253
	254	static int config_set(uint32_t key, GVariant *data,
db23af7f AG	255	const struct sr_dev_inst *sdi,
db23af7f AG	256	const struct sr_channel_group *cg)
00b2a092 AG	257	{
00b2a092 AG	258	int ret;
db23af7f	259	enum sr_mq mq;
2c04f943	260	enum sr_mqflag mq_flags;
db23af7f AG	261	struct dev_context *devc;
db23af7f AG	262	GVariant *tuple_child;
00b2a092	263
00b2a092 AG	264	(void)cg;
	265
	266	if (sdi->status != SR_ST_ACTIVE)
	267	return SR_ERR_DEV_CLOSED;
	268
db23af7f AG	269	devc = sdi->priv;
db23af7f AG	270
00b2a092 AG	271	ret = SR_OK;
00b2a092 AG	272	switch (key) {
db23af7f AG	273	case SR_CONF_LIMIT_SAMPLES:
	274	devc->limit_samples = g_variant_get_uint64(data);
	275	break;
	276	case SR_CONF_MEASURED_QUANTITY:
	277	tuple_child = g_variant_get_child_value(data, 0);
	278	mq = g_variant_get_uint32(tuple_child);
2c04f943 AG	279	tuple_child = g_variant_get_child_value(data, 1);
	280	mq_flags = g_variant_get_uint64(tuple_child);
	281	ret = hp_3457a_set_mq(sdi, mq, mq_flags);
db23af7f AG	282	g_variant_unref(tuple_child);
	283	break;
	284	case SR_CONF_ADC_POWERLINE_CYCLES:
	285	ret = hp_3457a_set_nplc(sdi, g_variant_get_double(data));
	286	break;
00b2a092 AG	287	default:
	288	ret = SR_ERR_NA;
	289	}
	290
	291	return ret;
	292	}
	293
	294	static int config_list(uint32_t key, GVariant **data,
	295	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	296	{
	297	int ret;
	298
db23af7f AG	299	if (key == SR_CONF_SCAN_OPTIONS) {
	300	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	301	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	302	return SR_OK;
	303	} else if ((key == SR_CONF_DEVICE_OPTIONS) && !sdi) {
	304	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	305	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	306	return SR_OK;
	307	} else if ((key == SR_CONF_DEVICE_OPTIONS) && !cg) {
	308	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	309	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	310	return SR_OK;
	311	}
	312
	313	/* From here on, we're only concerned with channel group config. */
	314	if (!cg)
	315	return SR_ERR_NA;
	316
	317	/*
	318	* TODO: Implement channel group configuration when adding support for
	319	* plug-in cards.
	320	*/
00b2a092 AG	321
	322	ret = SR_OK;
	323	switch (key) {
00b2a092	324	default:
db23af7f	325	ret = SR_ERR_NA;
00b2a092 AG	326	}
	327
	328	return ret;
	329	}
	330
9a093be9 AG	331	static void create_channel_index_list(GSList channels, GArray *arr)
	332	{
	333	struct sr_channel *channel;
	334	struct channel_context *chanc;
	335	GSList *list_elem;
	336
	337	*arr = g_array_new(FALSE, FALSE, sizeof(unsigned int));
	338
	339	for (list_elem = channels; list_elem; list_elem = list_elem->next) {
	340	channel = list_elem->data;
	341	chanc = channel->priv;
	342	g_array_append_val(*arr, chanc->index);
	343	}
	344	}
	345
db23af7f AG	346	/*
	347	* TRIG SGL
	348	* Trigger the first measurement, then hold. We can't let the instrument
	349	* auto-trigger because we read several registers to make a complete
	350	* reading. If the instrument were auto-triggering, we could get the
	351	* reading for sample N, but a new measurement is made and when we read the
	352	* HIRES register, it contains data for sample N+1. This would produce
	353	* wrong readings.
9a093be9 AG	354	* SADV AUTO
	355	* Activate the scan-advance feature. This automatically connects the next
	356	* channel in the scan list to the A/D converter. This way, we do not need to
	357	* occupy the HP-IB bus to send channel select commands.
db23af7f	358	*/
695dc859	359	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
00b2a092	360	{
db23af7f	361	int ret;
9a093be9	362	gboolean front_selected, rear_selected;
db23af7f	363	struct sr_scpi_dev_inst *scpi;
9a093be9	364	struct sr_channel *channel;
db23af7f	365	struct dev_context *devc;
9a093be9 AG	366	struct channel_context *chanc;
	367	GArray *ch_list;
	368	GSList *channels;
db23af7f	369
00b2a092 AG	370	if (sdi->status != SR_ST_ACTIVE)
	371	return SR_ERR_DEV_CLOSED;
	372
db23af7f AG	373	scpi = sdi->conn;
	374	devc = sdi->priv;
	375
	376	ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100,
	377	hp_3457a_receive_data, (void *)sdi);
	378	if (ret != SR_OK)
	379	return ret;
	380
	381	std_session_send_df_header(sdi, LOG_PREFIX);
	382
9a093be9 AG	383	front_selected = rear_selected = FALSE;
	384	devc->active_channels = NULL;
	385
	386	for (channels = sdi->channels; channels; channels = channels->next) {
	387	channel = channels->data;
	388
	389	if (!channel->enabled)
	390	continue;
	391
	392	chanc = channel->priv;
	393
	394	if (chanc->location == CONN_FRONT)
	395	front_selected = TRUE;
	396	if (chanc->location == CONN_REAR)
	397	rear_selected = TRUE;
	398
	399	devc->active_channels = g_slist_append(devc->active_channels, channel);
	400	}
	401
	402	if (front_selected && rear_selected) {
	403	sr_err("Can not use front and rear channels at the same time!");
	404	g_slist_free(devc->active_channels);
	405	return SR_ERR_ARG;
	406	}
	407
	408	devc->current_channel = devc->active_channels->data;
	409	devc->num_active_channels = g_slist_length(devc->active_channels);
	410
	411	hp_3457a_select_input(sdi, front_selected ? CONN_FRONT : CONN_REAR);
	412
	413	/* For plug-in cards, use the scan-advance features to scan channels. */
	414	if (rear_selected && (devc->rear_card->card_id != REAR_TERMINALS)) {
	415	create_channel_index_list(devc->active_channels, &ch_list);
	416	hp_3457a_send_scan_list(sdi, (void *)ch_list->data, ch_list->len);
	417	sr_scpi_send(scpi, "SADV AUTO");
	418	g_array_free(ch_list, TRUE);
	419	}
	420
db23af7f AG	421	/* Start first measurement. */
	422	sr_scpi_send(scpi, "TRIG SGL");
	423	devc->acq_state = ACQ_TRIGGERED_MEASUREMENT;
	424	devc->num_samples = 0;
00b2a092 AG	425
	426	return SR_OK;
	427	}
	428
695dc859	429	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
00b2a092	430	{
9a093be9	431	struct dev_context *devc;
00b2a092	432
9a093be9 AG	433	devc = sdi->priv;
9a093be9 AG	434
9a093be9 AG	435	g_slist_free(devc->active_channels);
9a093be9 AG	436
00b2a092 AG	437	return SR_OK;
	438	}
	439
dd5c48a6	440	static struct sr_dev_driver hp_3457a_driver_info = {
00b2a092 AG	441	.name = "hp-3457a",
	442	.longname = "HP 3457A",
	443	.api_version = 1,
c2fdcc25	444	.init = std_init,
700d6b64	445	.cleanup = std_cleanup,
00b2a092	446	.scan = scan,
c01bf34c	447	.dev_list = std_dev_list,
00b2a092 AG	448	.config_get = config_get,
	449	.config_set = config_set,
	450	.config_list = config_list,
	451	.dev_open = dev_open,
	452	.dev_close = dev_close,
	453	.dev_acquisition_start = dev_acquisition_start,
	454	.dev_acquisition_stop = dev_acquisition_stop,
	455	.context = NULL,
	456	};
dd5c48a6	457	SR_REGISTER_DEV_DRIVER(hp_3457a_driver_info);