Constify a few arrays and variables.

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

diff --git a/src/hardware/scpi-pps/protocol.h b/src/hardware/scpi-pps/protocol.h
index ee434473a4acfd109af6fc8f75dae6fb4cceb4ed..bd0dc9332c8169f7e0ac550eea3ef60db4bdedad 100644 (file)
--- a/src/hardware/scpi-pps/protocol.h
+++ b/src/hardware/scpi-pps/protocol.h
@@ -27,18 +27,139 @@
 
 #define LOG_PREFIX "scpi-pps"
 
+enum pps_scpi_cmds {
+       SCPI_CMD_REMOTE,
+       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_VOLTAGE_TARGET,
+       SCPI_CMD_SET_VOLTAGE_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_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,
+};
+
+/*
+ * 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;
+       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;
+       unsigned int num_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);
+};
+
+struct channel_spec {
+       const char *name;
+       /* Min, max, programming resolution. */
+       float voltage[3];
+       float current[3];
+};
+
+struct scpi_command {
+       int command;
+       const char *string;
+};
+
+struct channel_group_spec {
+       const char *name;
+       uint64_t channel_index_mask;
+       uint64_t features;
+};
+
+struct pps_channel {
+       int mq;
+       unsigned int hw_output_idx;
+       const char *hwname;
+};
+
+struct pps_channel_instance {
+       int mq;
+       int command;
+       const char *prefix;
+};
+
+struct pps_channel_group {
+       uint64_t features;
+};
+
+enum acq_states {
+       STATE_VOLTAGE,
+       STATE_CURRENT,
+       STATE_STOP,
+};
+
 /** Private, per-device-instance driver context. */
 struct dev_context {
        /* Model-specific information */
+       const struct scpi_pps *device;
 
        /* Acquisition settings */
+       void *cb_data;
 
        /* Operational state */
+       gboolean beeper_was_set;
+       struct channel_spec *channels;
+       struct channel_group_spec *channel_groups;
 
        /* Temporary state across callbacks */
-
+       struct sr_channel *cur_channel;
 };
 
+const char *get_vendor(const char *raw_vendor);
+SR_PRIV const char *scpi_cmd_get(const struct sr_dev_inst *sdi, int command);
+SR_PRIV int scpi_cmd(const struct sr_dev_inst *sdi, int command, ...);
+SR_PRIV int scpi_cmd_resp(const struct sr_dev_inst *sdi, GVariant **gvar,
+               const GVariantType *gvtype, int command, ...);
+SR_PRIV int select_channel(const struct sr_dev_inst *sdi, struct sr_channel *ch);
+SR_PRIV struct sr_channel *next_enabled_channel(const struct sr_dev_inst *sdi,
+               struct sr_channel *cur_channel);
 SR_PRIV int scpi_pps_receive_data(int fd, int revents, void *cb_data);
 
 #endif