src/hardware/korad-kaxxxxp/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
   5  * Copyright (C) 2018-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_KORAD_KAXXXXP_PROTOCOL_H
  22 #define LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
  23
  24 #include <stdint.h>
  25 #include <string.h>
  26 #include <glib.h>
  27 #include <libsigrok/libsigrok.h>
  28 #include "libsigrok-internal.h"
  29
  30 #define LOG_PREFIX "korad-kaxxxxp"
  31
  32 #define KAXXXXP_POLL_INTERVAL_MS 80
  33
  34 enum {
  35         VELLEMAN_PS3005D,
  36         VELLEMAN_LABPS3005D,
  37         KORAD_KA3005P,
  38         KORAD_KA3005P_0X01,
  39         KORAD_KA3005P_0XBC,
  40         KORAD_KD3005P,
  41         KORAD_KD3005P_V20_NOSP,
  42         RND_320_KD3005P,
  43         RND_320K30PV,
  44         TENMA_72_2540_V20,
  45         TENMA_72_2540_V21,
  46         TENMA_72_2535_V21,
  47         STAMOS_SLS31_V20,
  48         KORAD_KD6005P,
  49         /* Support for future devices with this protocol. */
  50 };
  51
  52 /* Information on single model */
  53 struct korad_kaxxxxp_model {
  54         int model_id; /**< Model info */
  55         const char *vendor; /**< Vendor name */
  56         const char *name; /**< Model name */
  57         const char *id; /**< Model ID, as delivered by interface */
  58         int channels; /**< Number of channels */
  59         double voltage[3]; /**< Min, max, step */
  60         double current[3]; /**< Min, max, step */
  61 };
  62
  63 /* Reply targets */
  64 enum {
  65         KAXXXXP_CURRENT,
  66         KAXXXXP_CURRENT_LIMIT,
  67         KAXXXXP_VOLTAGE,
  68         KAXXXXP_VOLTAGE_TARGET,
  69         KAXXXXP_STATUS,
  70         KAXXXXP_OUTPUT,
  71         KAXXXXP_BEEP,
  72         KAXXXXP_OCP,
  73         KAXXXXP_OVP,
  74         KAXXXXP_SAVE,
  75         KAXXXXP_RECALL,
  76 };
  77
  78 struct dev_context {
  79         const struct korad_kaxxxxp_model *model; /**< Model information. */
  80
  81         struct sr_sw_limits limits;
  82         int64_t req_sent_at;
  83         GMutex rw_mutex;
  84
  85         float current;          /**< Last current value [A] read from device. */
  86         float current_limit;    /**< Output current set. */
  87         float voltage;          /**< Last voltage value [V] read from device. */
  88         float voltage_target;   /**< Output voltage set. */
  89         gboolean cc_mode[2];    /**< Device is in CC mode (otherwise CV). */
  90
  91         gboolean output_enabled; /**< Is the output enabled? */
  92         gboolean beep_enabled;   /**< Enable beeper. */
  93         gboolean ocp_enabled;    /**< Output current protection enabled. */
  94         gboolean ovp_enabled;    /**< Output voltage protection enabled. */
  95
  96         gboolean cc_mode_1_changed;      /**< CC mode of channel 1 has changed. */
  97         gboolean cc_mode_2_changed;      /**< CC mode of channel 2 has changed. */
  98         gboolean output_enabled_changed; /**< Output enabled state has changed. */
  99         gboolean ocp_enabled_changed;    /**< OCP enabled state has changed. */
 100         gboolean ovp_enabled_changed;    /**< OVP enabled state has changed. */
 101
 102         int acquisition_target;  /**< What reply to expect. */
 103         int program;             /**< Program to store or recall. */
 104
 105         float set_current_limit;     /**< New output current to set. */
 106         float set_voltage_target;    /**< New output voltage to set. */
 107         gboolean set_output_enabled; /**< New output enabled to set. */
 108         gboolean set_beep_enabled;   /**< New enable beeper to set. */
 109         gboolean set_ocp_enabled;    /**< New OCP enabled to set. */
 110         gboolean set_ovp_enabled;    /**< New OVP enabled to set. */
 111 };
 112
 113 SR_PRIV int korad_kaxxxxp_send_cmd(struct sr_serial_dev_inst *serial,
 114                                         const char *cmd);
 115 SR_PRIV int korad_kaxxxxp_read_chars(struct sr_serial_dev_inst *serial,
 116                                         int count, char *buf);
 117 SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
 118                                         int target, struct dev_context *devc);
 119 SR_PRIV int korad_kaxxxxp_get_value(struct sr_serial_dev_inst *serial,
 120                                         int target, struct dev_context *devc);
 121 SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
 122                                         struct dev_context *devc);
 123 SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data);
 124
 125 #endif