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  *
   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 /**
  21  * @file
  22  * Korad KAxxxxP power supply driver
  23  * @internal
  24  */
  25
  26 #ifndef LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
  27 #define LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
  28
  29 #include <stdint.h>
  30 #include <string.h>
  31 #include <glib.h>
  32 #include <libsigrok/libsigrok.h>
  33 #include "libsigrok-internal.h"
  34
  35 #define LOG_PREFIX "korad-kaxxxxp"
  36
  37 #define KAXXXXP_POLL_INTERVAL_MS 80
  38
  39 enum {
  40         VELLEMAN_LABPS_3005D,
  41         KORAD_KA3005D,
  42         /* Support for future devices with this protocol. */
  43 };
  44
  45 /* Information on single model */
  46 struct korad_kaxxxxp_model {
  47         int model_id; /**< Model info */
  48         const char *vendor; /**< Vendor name */
  49         const char *name; /**< Model name */
  50         const char *id; /**< Model ID, as delivered by interface */
  51         int channels; /**< Number of channels */
  52         double voltage[3]; /**< Min, max, step */
  53         double current[3]; /**< Min, max, step */
  54 };
  55
  56 /* Reply targets */
  57 enum {
  58         KAXXXXP_CURRENT,
  59         KAXXXXP_CURRENT_MAX,
  60         KAXXXXP_VOLTAGE,
  61         KAXXXXP_VOLTAGE_MAX,
  62         KAXXXXP_STATUS,
  63         KAXXXXP_OUTPUT,
  64         KAXXXXP_BEEP,
  65         KAXXXXP_OCP,
  66         KAXXXXP_OVP,
  67         KAXXXXP_SAVE,
  68         KAXXXXP_RECALL,
  69 };
  70
  71 /** Private, per-device-instance driver context. */
  72 struct dev_context {
  73         /* Model-specific information */
  74         const struct korad_kaxxxxp_model *model; /**< Model information. */
  75
  76         /* Acquisition settings */
  77         uint64_t limit_samples;
  78         uint64_t limit_msec;
  79         uint64_t num_samples;
  80         int64_t starttime;
  81         int64_t req_sent_at;
  82         gboolean reply_pending;
  83
  84         void *cb_data;
  85
  86         /* Operational state */
  87         float current;          /**< Last current value [A] read from device. */
  88         float current_max;      /**< Output current set. */
  89         float voltage;          /**< Last voltage value [V] read from device. */
  90         float voltage_max;      /**< Output voltage set. */
  91         gboolean cc_mode[2];    /**< Device is in CC mode (otherwise CV). */
  92
  93         gboolean output_enabled; /**< Is the output enabled? */
  94         gboolean beep_enabled;   /**< Enable beeper. */
  95         gboolean ocp_enabled;    /**< Output current protection enabled. */
  96         gboolean ovp_enabled;    /**< Output voltage protection enabled. */
  97
  98         /* Temporary state across callbacks */
  99         int target;              /**< What reply to expect. */
 100         int program;             /**< Program to store or recall. */
 101         char reply[6];
 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                                         int count, char *buf);
 108 SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
 109                                         struct dev_context *devc);
 110 SR_PRIV int korad_kaxxxxp_query_value(struct sr_serial_dev_inst *serial,
 111                                         struct dev_context *devc);
 112 SR_PRIV int korad_kaxxxxp_get_reply(struct sr_serial_dev_inst *serial,
 113                                         struct dev_context *devc);
 114 SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
 115                                         struct dev_context *devc);
 116 SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data);
 117
 118 #endif