[libsigrok.git] / src / hardware / scpi-pps / protocol.h

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
 * Copyright (C) 2017,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/>.
 */

#ifndef LIBSIGROK_HARDWARE_SCPI_PPS_PROTOCOL_H
#define LIBSIGROK_HARDWARE_SCPI_PPS_PROTOCOL_H

#include <stdint.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "scpi.h"

#define LOG_PREFIX "scpi-pps"

enum pps_scpi_cmds {
	SCPI_CMD_REMOTE = 1,
	SCPI_CMD_LOCAL,
	SCPI_CMD_BEEPER,
	SCPI_CMD_BEEPER_ENABLE,
	SCPI_CMD_BEEPER_DISABLE,
	SCPI_CMD_SELECT_CHANNEL,
	SCPI_CMD_GET_MEAS_VOLTAGE,
	SCPI_CMD_GET_MEAS_CURRENT,
	SCPI_CMD_GET_MEAS_POWER,
	SCPI_CMD_GET_MEAS_FREQUENCY,
	SCPI_CMD_GET_VOLTAGE_TARGET,
	SCPI_CMD_SET_VOLTAGE_TARGET,
	SCPI_CMD_GET_FREQUENCY_TARGET,
	SCPI_CMD_SET_FREQUENCY_TARGET,
	SCPI_CMD_GET_CURRENT_LIMIT,
	SCPI_CMD_SET_CURRENT_LIMIT,
	SCPI_CMD_GET_OUTPUT_ENABLED,
	SCPI_CMD_SET_OUTPUT_ENABLE,
	SCPI_CMD_SET_OUTPUT_DISABLE,
	SCPI_CMD_GET_OUTPUT_REGULATION,
	SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION,
	SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE,
	SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE,
	SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION_ACTIVE,
	SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED,
	SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE,
	SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE,
	SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE,
	SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
	SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
	SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED,
	SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE,
	SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE,
	SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE,
	SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD,
	SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD,
};

/* Defines the SCPI dialect */
enum pps_scpi_dialect {
	SCPI_DIALECT_UNKNOWN = 1,
	SCPI_DIALECT_HP_COMP,
	SCPI_DIALECT_HP_66XXB,
	SCPI_DIALECT_PHILIPS,
	SCPI_DIALECT_HMP,
};

/*
 * These are bit values denoting features a device can have either globally,
 * in scpi_pps.features, or on a per-channel-group basis in
 * channel_group_spec.features.
 */
enum pps_features {
	PPS_OTP           = (1 << 0),
	PPS_OVP           = (1 << 1),
	PPS_OCP           = (1 << 2),
	PPS_INDEPENDENT   = (1 << 3),
	PPS_SERIES        = (1 << 4),
	PPS_PARALLEL      = (1 << 5),
};

struct scpi_pps {
	const char *vendor;
	const char *model;
	const enum pps_scpi_dialect dialect;
	uint64_t features;
	const uint32_t *devopts;
	unsigned int num_devopts;
	const uint32_t *devopts_cg;
	unsigned int num_devopts_cg;
	const struct channel_spec *channels;
	unsigned int num_channels;
	const struct channel_group_spec *channel_groups;
	unsigned int num_channel_groups;
	const struct scpi_command *commands;
	int (*probe_channels) (struct sr_dev_inst *sdi, struct sr_scpi_hw_info *hwinfo,
		struct channel_spec **channels, unsigned int *num_channels,
		struct channel_group_spec **channel_groups, unsigned int *num_channel_groups);
	int (*init_acquisition) (const struct sr_dev_inst *sdi);
	int (*update_status) (const struct sr_dev_inst *sdi);
};

struct channel_spec {
	const char *name;
	/* Min, max, programming resolution, spec digits, encoding digits. */
	double voltage[5];
	double current[5];
	double power[5];
	double frequency[5];
	double ovp[5];
	double ocp[5];
};

struct channel_group_spec {
	const char *name;
	uint64_t channel_index_mask;
	uint64_t features;
	/* The mqflags will only be applied to voltage and current channels! */
	enum sr_mqflag mqflags;
};

struct pps_channel {
	enum sr_mq mq;
	enum sr_mqflag mqflags;
	unsigned int hw_output_idx;
	const char *hwname;
	int digits;
};

struct pps_channel_instance {
	enum sr_mq mq;
	int command;
	const char *prefix;
};

struct pps_channel_group {
	uint64_t features;
};

enum acq_states {
	STATE_VOLTAGE,
	STATE_CURRENT,
	STATE_STOP,
};

struct dev_context {
	const struct scpi_pps *device;

	gboolean beeper_was_set;
	struct channel_spec *channels;
	struct channel_group_spec *channel_groups;

	struct sr_channel *cur_acquisition_channel;
	struct sr_sw_limits limits;
};

SR_PRIV extern unsigned int num_pps_profiles;
SR_PRIV extern const struct scpi_pps pps_profiles[];

SR_PRIV int select_channel(const struct sr_dev_inst *sdi, struct sr_channel *ch);
SR_PRIV int scpi_pps_receive_data(int fd, int revents, void *cb_data);

#endif
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
	5	* Copyright (C) 2017,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	#ifndef LIBSIGROK_HARDWARE_SCPI_PPS_PROTOCOL_H
	22	#define LIBSIGROK_HARDWARE_SCPI_PPS_PROTOCOL_H
	23
	24	#include <stdint.h>
	25	#include <glib.h>
	26	#include <libsigrok/libsigrok.h>
	27	#include "libsigrok-internal.h"
	28	#include "scpi.h"
	29
	30	#define LOG_PREFIX "scpi-pps"
	31
	32	enum pps_scpi_cmds {
	33	SCPI_CMD_REMOTE = 1,
	34	SCPI_CMD_LOCAL,
	35	SCPI_CMD_BEEPER,
	36	SCPI_CMD_BEEPER_ENABLE,
	37	SCPI_CMD_BEEPER_DISABLE,
	38	SCPI_CMD_SELECT_CHANNEL,
	39	SCPI_CMD_GET_MEAS_VOLTAGE,
	40	SCPI_CMD_GET_MEAS_CURRENT,
	41	SCPI_CMD_GET_MEAS_POWER,
	42	SCPI_CMD_GET_MEAS_FREQUENCY,
	43	SCPI_CMD_GET_VOLTAGE_TARGET,
	44	SCPI_CMD_SET_VOLTAGE_TARGET,
	45	SCPI_CMD_GET_FREQUENCY_TARGET,
	46	SCPI_CMD_SET_FREQUENCY_TARGET,
	47	SCPI_CMD_GET_CURRENT_LIMIT,
	48	SCPI_CMD_SET_CURRENT_LIMIT,
	49	SCPI_CMD_GET_OUTPUT_ENABLED,
	50	SCPI_CMD_SET_OUTPUT_ENABLE,
	51	SCPI_CMD_SET_OUTPUT_DISABLE,
	52	SCPI_CMD_GET_OUTPUT_REGULATION,
	53	SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION,
	54	SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE,
	55	SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE,
	56	SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION_ACTIVE,
	57	SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED,
	58	SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE,
	59	SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE,
	60	SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE,
	61	SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
	62	SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
	63	SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED,
	64	SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE,
	65	SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE,
	66	SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE,
	67	SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD,
	68	SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD,
	69	};
	70
	71	/* Defines the SCPI dialect */
	72	enum pps_scpi_dialect {
	73	SCPI_DIALECT_UNKNOWN = 1,
	74	SCPI_DIALECT_HP_COMP,
	75	SCPI_DIALECT_HP_66XXB,
	76	SCPI_DIALECT_PHILIPS,
	77	SCPI_DIALECT_HMP,
	78	};
	79
	80	/*
	81	* These are bit values denoting features a device can have either globally,
	82	* in scpi_pps.features, or on a per-channel-group basis in
	83	* channel_group_spec.features.
	84	*/
	85	enum pps_features {
	86	PPS_OTP = (1 << 0),
	87	PPS_OVP = (1 << 1),
	88	PPS_OCP = (1 << 2),
	89	PPS_INDEPENDENT = (1 << 3),
	90	PPS_SERIES = (1 << 4),
	91	PPS_PARALLEL = (1 << 5),
	92	};
	93
	94	struct scpi_pps {
	95	const char *vendor;
	96	const char *model;
	97	const enum pps_scpi_dialect dialect;
	98	uint64_t features;
	99	const uint32_t *devopts;
	100	unsigned int num_devopts;
	101	const uint32_t *devopts_cg;
	102	unsigned int num_devopts_cg;
	103	const struct channel_spec *channels;
	104	unsigned int num_channels;
	105	const struct channel_group_spec *channel_groups;
	106	unsigned int num_channel_groups;
	107	const struct scpi_command *commands;
	108	int (probe_channels) (struct sr_dev_inst sdi, struct sr_scpi_hw_info *hwinfo,
	109	struct channel_spec *channels, unsigned int num_channels,
	110	struct channel_group_spec *channel_groups, unsigned int num_channel_groups);
	111	int (init_acquisition) (const struct sr_dev_inst sdi);
	112	int (update_status) (const struct sr_dev_inst sdi);
	113	};
	114
	115	struct channel_spec {
	116	const char *name;
	117	/* Min, max, programming resolution, spec digits, encoding digits. */
	118	double voltage[5];
	119	double current[5];
	120	double power[5];
	121	double frequency[5];
	122	double ovp[5];
	123	double ocp[5];
	124	};
	125
	126	struct channel_group_spec {
	127	const char *name;
	128	uint64_t channel_index_mask;
	129	uint64_t features;
	130	/* The mqflags will only be applied to voltage and current channels! */
	131	enum sr_mqflag mqflags;
	132	};
	133
	134	struct pps_channel {
	135	enum sr_mq mq;
	136	enum sr_mqflag mqflags;
	137	unsigned int hw_output_idx;
	138	const char *hwname;
	139	int digits;
	140	};
	141
	142	struct pps_channel_instance {
	143	enum sr_mq mq;
	144	int command;
	145	const char *prefix;
	146	};
	147
	148	struct pps_channel_group {
	149	uint64_t features;
	150	};
	151
	152	enum acq_states {
	153	STATE_VOLTAGE,
	154	STATE_CURRENT,
	155	STATE_STOP,
	156	};
	157
	158	struct dev_context {
	159	const struct scpi_pps *device;
	160
	161	gboolean beeper_was_set;
	162	struct channel_spec *channels;
	163	struct channel_group_spec *channel_groups;
	164
	165	struct sr_channel *cur_acquisition_channel;
	166	struct sr_sw_limits limits;
	167	};
	168
	169	SR_PRIV extern unsigned int num_pps_profiles;
	170	SR_PRIV extern const struct scpi_pps pps_profiles[];
	171
	172	SR_PRIV int select_channel(const struct sr_dev_inst sdi, struct sr_channel ch);
	173	SR_PRIV int scpi_pps_receive_data(int fd, int revents, void *cb_data);
	174
	175	#endif