]> sigrok.org Git - libsigrok.git/blob - src/hardware/korad-kaxxxxp/protocol.h
korad-kaxxxxp: support for Stamos S-LS-31 power supply
[libsigrok.git] / 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 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_KD3005P,
40         KORAD_KD3005P_V20_NOSP,
41         RND_320K30PV,
42         TENMA_72_2540_V20,
43         TENMA_72_2540_V21,
44         STAMOS_SLS31_V20,
45         /* Support for future devices with this protocol. */
46 };
47
48 /* Information on single model */
49 struct korad_kaxxxxp_model {
50         int model_id; /**< Model info */
51         const char *vendor; /**< Vendor name */
52         const char *name; /**< Model name */
53         const char *id; /**< Model ID, as delivered by interface */
54         int channels; /**< Number of channels */
55         double voltage[3]; /**< Min, max, step */
56         double current[3]; /**< Min, max, step */
57 };
58
59 /* Reply targets */
60 enum {
61         KAXXXXP_CURRENT,
62         KAXXXXP_CURRENT_MAX,
63         KAXXXXP_VOLTAGE,
64         KAXXXXP_VOLTAGE_MAX,
65         KAXXXXP_STATUS,
66         KAXXXXP_OUTPUT,
67         KAXXXXP_BEEP,
68         KAXXXXP_OCP,
69         KAXXXXP_OVP,
70         KAXXXXP_SAVE,
71         KAXXXXP_RECALL,
72 };
73
74 struct dev_context {
75         const struct korad_kaxxxxp_model *model; /**< Model information. */
76
77         struct sr_sw_limits limits;
78         int64_t req_sent_at;
79         GMutex rw_mutex;
80
81         float current;          /**< Last current value [A] read from device. */
82         float current_max;      /**< Output current set. */
83         float voltage;          /**< Last voltage value [V] read from device. */
84         float voltage_max;      /**< Output voltage set. */
85         gboolean cc_mode[2];    /**< Device is in CC mode (otherwise CV). */
86
87         gboolean output_enabled; /**< Is the output enabled? */
88         gboolean beep_enabled;   /**< Enable beeper. */
89         gboolean ocp_enabled;    /**< Output current protection enabled. */
90         gboolean ovp_enabled;    /**< Output voltage protection enabled. */
91
92         int acquisition_target;  /**< What reply to expect. */
93         int program;             /**< Program to store or recall. */
94 };
95
96 SR_PRIV int korad_kaxxxxp_send_cmd(struct sr_serial_dev_inst *serial,
97                                         const char *cmd);
98 SR_PRIV int korad_kaxxxxp_read_chars(struct sr_serial_dev_inst *serial,
99                                         int count, char *buf);
100 SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
101                                         int target, struct dev_context *devc);
102 SR_PRIV int korad_kaxxxxp_get_value(struct sr_serial_dev_inst *serial,
103                                         int target, struct dev_context *devc);
104 SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
105                                         struct dev_context *devc);
106 SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data);
107
108 #endif