src/hardware/scpi-pps/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Bert Vermeulen <bert@biot.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 #ifndef LIBSIGROK_HARDWARE_SCPI_PPS_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_SCPI_PPS_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include <glib.h>
  25 #include "libsigrok.h"
  26 #include "libsigrok-internal.h"
  27
  28 #define LOG_PREFIX "scpi-pps"
  29
  30 enum pps_scpi_cmds {
  31         SCPI_CMD_KEY_UNLOCK,
  32         SCPI_CMD_GET_MEAS_VOLTAGE,
  33         SCPI_CMD_GET_MEAS_CURRENT,
  34         SCPI_CMD_GET_MEAS_POWER,
  35         SCPI_CMD_GET_VOLTAGE_MAX,
  36         SCPI_CMD_SET_VOLTAGE_MAX,
  37         SCPI_CMD_GET_CURRENT_MAX,
  38         SCPI_CMD_SET_CURRENT_MAX,
  39         SCPI_CMD_GET_OUTPUT_ENABLED,
  40         SCPI_CMD_SET_OUTPUT_ENABLED,
  41         SCPI_CMD_GET_OUTPUT_REGULATION,
  42         SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION,
  43         SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION,
  44         SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED,
  45         SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLED,
  46         SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE,
  47         SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
  48         SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
  49         SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED,
  50         SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLED,
  51         SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE,
  52         SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD,
  53         SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD,
  54 };
  55
  56 /*
  57  * These are bit values denoting features a device can have either globally,
  58  * in scpi_pps.features, or on a per-channel-group basis in
  59  * channel_group_spec.features.
  60  */
  61 enum pps_features {
  62         PPS_OTP           = (1 << 0),
  63         PPS_OVP           = (1 << 1),
  64         PPS_OCP           = (1 << 2),
  65         PPS_INDEPENDENT   = (1 << 3),
  66         PPS_SERIES        = (1 << 4),
  67         PPS_PARALLEL      = (1 << 5),
  68 };
  69
  70 struct scpi_pps {
  71         char *vendor;
  72         char *model;
  73         uint64_t features;
  74         const uint32_t *devopts;
  75         unsigned int num_devopts;
  76         const uint32_t *devopts_cg;
  77         unsigned int num_devopts_cg;
  78         struct channel_spec *channels;
  79         unsigned int num_channels;
  80         struct channel_group_spec *channel_groups;
  81         unsigned int num_channel_groups;
  82         struct scpi_command *commands;
  83         unsigned int num_commands;
  84 };
  85
  86 struct channel_spec {
  87         char *name;
  88         /* Min, max, programming resolution. */
  89         float voltage[3];
  90         float current[3];
  91 };
  92
  93 struct scpi_command {
  94         int command;
  95         char *string;
  96 };
  97
  98 struct channel_group_spec {
  99         char *name;
 100         uint64_t channel_index_mask;
 101         uint64_t features;
 102 };
 103
 104 struct pps_channel {
 105         int mq;
 106         unsigned int hw_output_idx;
 107         char *hwname;
 108 };
 109
 110 struct pps_channel_instance {
 111         int mq;
 112         int command;
 113         char *prefix;
 114 };
 115
 116 struct pps_channel_group {
 117         uint64_t features;
 118 };
 119
 120 enum acq_states {
 121         STATE_VOLTAGE,
 122         STATE_CURRENT,
 123         STATE_STOP,
 124 };
 125
 126 /** Private, per-device-instance driver context. */
 127 struct dev_context {
 128         /* Model-specific information */
 129         const struct scpi_pps *device;
 130
 131         /* Acquisition settings */
 132         void *cb_data;
 133
 134         /* Operational state */
 135
 136         /* Temporary state across callbacks */
 137         struct sr_channel *cur_channel;
 138 };
 139
 140 const char *get_vendor(const char *raw_vendor);
 141 SR_PRIV char *scpi_cmd_get(const struct sr_dev_inst *sdi, int command);
 142 SR_PRIV int scpi_cmd(const struct sr_dev_inst *sdi, int command, ...);
 143 SR_PRIV int scpi_cmd_resp(const struct sr_dev_inst *sdi, GVariant **gvar,
 144                 const GVariantType *gvtype, int command, ...);
 145 SR_PRIV int scpi_pps_receive_data(int fd, int revents, void *cb_data);
 146
 147 #endif