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 korad_quirks_flag {
  35         KORAD_QUIRK_NONE = 0,
  36         KORAD_QUIRK_LABPS_OVP_EN = 1UL << 0,
  37         KORAD_QUIRK_ID_NO_VENDOR = 1UL << 1,
  38         KORAD_QUIRK_ID_TRAILING = 1UL << 2,
  39         KORAD_QUIRK_ID_OPT_VERSION = 1UL << 3,
  40         KORAD_QUIRK_ALL = (1UL << 4) - 1,
  41 };
  42
  43 /* Information on single model */
  44 struct korad_kaxxxxp_model {
  45         const char *vendor; /**< Vendor name */
  46         const char *name; /**< Model name */
  47         const char *id; /**< Model ID, as delivered by interface */
  48         int channels; /**< Number of channels */
  49         const double *voltage; /**< References: Min, max, step */
  50         const double *current; /**< References: Min, max, step */
  51         enum korad_quirks_flag quirks;
  52 };
  53
  54 /* Reply targets */
  55 enum {
  56         KAXXXXP_CURRENT,
  57         KAXXXXP_CURRENT_LIMIT,
  58         KAXXXXP_VOLTAGE,
  59         KAXXXXP_VOLTAGE_TARGET,
  60         KAXXXXP_STATUS,
  61         KAXXXXP_OUTPUT,
  62         KAXXXXP_BEEP,
  63         KAXXXXP_OCP,
  64         KAXXXXP_OVP,
  65         KAXXXXP_SAVE,
  66         KAXXXXP_RECALL,
  67 };
  68
  69 struct dev_context {
  70         const struct korad_kaxxxxp_model *model; /**< Model information. */
  71
  72         struct sr_sw_limits limits;
  73         int64_t req_sent_at;
  74         GMutex rw_mutex;
  75
  76         float current;          /**< Last current value [A] read from device. */
  77         float current_limit;    /**< Output current set. */
  78         float voltage;          /**< Last voltage value [V] read from device. */
  79         float voltage_target;   /**< Output voltage set. */
  80         gboolean cc_mode[2];    /**< Device is in CC mode (otherwise CV). */
  81
  82         gboolean output_enabled; /**< Is the output enabled? */
  83         gboolean beep_enabled;   /**< Enable beeper. */
  84         gboolean ocp_enabled;    /**< Output current protection enabled. */
  85         gboolean ovp_enabled;    /**< Output voltage protection enabled. */
  86
  87         gboolean cc_mode_1_changed;      /**< CC mode of channel 1 has changed. */
  88         gboolean cc_mode_2_changed;      /**< CC mode of channel 2 has changed. */
  89         gboolean output_enabled_changed; /**< Output enabled state has changed. */
  90         gboolean ocp_enabled_changed;    /**< OCP enabled state has changed. */
  91         gboolean ovp_enabled_changed;    /**< OVP enabled state has changed. */
  92
  93         int acquisition_target;  /**< What reply to expect. */
  94         int program;             /**< Program to store or recall. */
  95
  96         float set_current_limit;     /**< New output current to set. */
  97         float set_voltage_target;    /**< New output voltage to set. */
  98         gboolean set_output_enabled; /**< New output enabled to set. */
  99         gboolean set_beep_enabled;   /**< New enable beeper to set. */
 100         gboolean set_ocp_enabled;    /**< New OCP enabled to set. */
 101         gboolean set_ovp_enabled;    /**< New OVP enabled to set. */
 102 };
 103
 104 SR_PRIV int korad_kaxxxxp_send_cmd(struct sr_serial_dev_inst *serial,
 105                                         const char *cmd);
 106 SR_PRIV int korad_kaxxxxp_read_chars(struct sr_serial_dev_inst *serial,
 107                                         size_t count, char *buf);
 108 SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
 109                                         int target, struct dev_context *devc);
 110 SR_PRIV int korad_kaxxxxp_get_value(struct sr_serial_dev_inst *serial,
 111                                         int target, struct dev_context *devc);
 112 SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
 113                                         struct dev_context *devc);
 114 SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data);
 115
 116 #endif