]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/protocol.h
korad-kaxxxxp: add quirks flags to table of supported models
[libsigrok.git] / src / hardware / korad-kaxxxxp / protocol.h
CommitLineData
e75ee7de
HV
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
2e129b8b 5 * Copyright (C) 2018-2019 Frank Stettner <frank-stettner@gmx.net>
e75ee7de
HV
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
16fc7ee2
UH
21#ifndef LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
22#define LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
e75ee7de
HV
23
24#include <stdint.h>
d7083042 25#include <string.h>
e75ee7de
HV
26#include <glib.h>
27#include <libsigrok/libsigrok.h>
28#include "libsigrok-internal.h"
29
16fc7ee2 30#define LOG_PREFIX "korad-kaxxxxp"
e75ee7de 31
16fc7ee2 32#define KAXXXXP_POLL_INTERVAL_MS 80
d7083042
HV
33
34enum {
bcf9384d 35 KORAD_KA3005P,
a078d3ec 36 KORAD_KA3005P_0X01,
1c0e1baa 37 KORAD_KA3005P_0XBC,
7415217e 38 KORAD_KA3005P_V42,
8b58a519 39 KORAD_KA3005P_V55,
d154c6b6 40 KORAD_KD3005P_V20,
76f712a7 41 KORAD_KD3005P_V20_NOSP,
051d85f2 42 KORAD_KD3005P_V21_NOSP,
d154c6b6 43 KORAD_KD3005P_V41,
d8aad728 44 KORAD_KD3005P_V68,
1c88133c 45 KORAD_KD6005P,
c8dcd3ab 46 RND_320_KA3005P,
1c88133c 47 RND_320_KD3005P,
e843992d 48 RND_320K30PV,
1c88133c
GS
49 STAMOS_SLS31_V20,
50 TENMA_72_2535_V21,
0540954d
UH
51 TENMA_72_2540_V20,
52 TENMA_72_2540_V21,
082ca8d8 53 TENMA_72_2540_V52,
1c88133c 54 TENMA_72_2550_V2,
909a41c5 55 TENMA_72_2710_V66,
1c88133c
GS
56 VELLEMAN_LABPS3005D,
57 VELLEMAN_PS3005D,
d7083042
HV
58 /* Support for future devices with this protocol. */
59};
60
c7275098
GS
61enum korad_quirks_flag {
62 KORAD_QUIRK_NONE = 0,
63 KORAD_QUIRK_LABPS_OVP_EN = 1UL << 0,
64 KORAD_QUIRK_ALL = (1UL << 1) - 1,
65};
66
d7083042 67/* Information on single model */
16fc7ee2 68struct korad_kaxxxxp_model {
d7083042 69 int model_id; /**< Model info */
2c240774
UH
70 const char *vendor; /**< Vendor name */
71 const char *name; /**< Model name */
72 const char *id; /**< Model ID, as delivered by interface */
d7083042 73 int channels; /**< Number of channels */
ecd4600b
GS
74 const double *voltage; /**< References: Min, max, step */
75 const double *current; /**< References: Min, max, step */
c7275098 76 enum korad_quirks_flag quirks;
d7083042
HV
77};
78
79/* Reply targets */
80enum {
16fc7ee2 81 KAXXXXP_CURRENT,
8da30037 82 KAXXXXP_CURRENT_LIMIT,
16fc7ee2 83 KAXXXXP_VOLTAGE,
8da30037 84 KAXXXXP_VOLTAGE_TARGET,
16fc7ee2
UH
85 KAXXXXP_STATUS,
86 KAXXXXP_OUTPUT,
87 KAXXXXP_BEEP,
88 KAXXXXP_OCP,
89 KAXXXXP_OVP,
90 KAXXXXP_SAVE,
91 KAXXXXP_RECALL,
d7083042
HV
92};
93
e75ee7de 94struct dev_context {
16fc7ee2 95 const struct korad_kaxxxxp_model *model; /**< Model information. */
e75ee7de 96
597deef9 97 struct sr_sw_limits limits;
d7083042 98 int64_t req_sent_at;
3f9b48ae 99 GMutex rw_mutex;
d7083042 100
d7083042 101 float current; /**< Last current value [A] read from device. */
8da30037 102 float current_limit; /**< Output current set. */
d7083042 103 float voltage; /**< Last voltage value [V] read from device. */
8da30037 104 float voltage_target; /**< Output voltage set. */
d7083042 105 gboolean cc_mode[2]; /**< Device is in CC mode (otherwise CV). */
e75ee7de 106
d7083042
HV
107 gboolean output_enabled; /**< Is the output enabled? */
108 gboolean beep_enabled; /**< Enable beeper. */
9e5366df
UH
109 gboolean ocp_enabled; /**< Output current protection enabled. */
110 gboolean ovp_enabled; /**< Output voltage protection enabled. */
e75ee7de 111
2e129b8b
FS
112 gboolean cc_mode_1_changed; /**< CC mode of channel 1 has changed. */
113 gboolean cc_mode_2_changed; /**< CC mode of channel 2 has changed. */
114 gboolean output_enabled_changed; /**< Output enabled state has changed. */
115 gboolean ocp_enabled_changed; /**< OCP enabled state has changed. */
116 gboolean ovp_enabled_changed; /**< OVP enabled state has changed. */
117
3f9b48ae 118 int acquisition_target; /**< What reply to expect. */
d7083042 119 int program; /**< Program to store or recall. */
8da30037
FS
120
121 float set_current_limit; /**< New output current to set. */
122 float set_voltage_target; /**< New output voltage to set. */
123 gboolean set_output_enabled; /**< New output enabled to set. */
124 gboolean set_beep_enabled; /**< New enable beeper to set. */
125 gboolean set_ocp_enabled; /**< New OCP enabled to set. */
126 gboolean set_ovp_enabled; /**< New OVP enabled to set. */
e75ee7de
HV
127};
128
16fc7ee2 129SR_PRIV int korad_kaxxxxp_send_cmd(struct sr_serial_dev_inst *serial,
d7083042 130 const char *cmd);
16fc7ee2 131SR_PRIV int korad_kaxxxxp_read_chars(struct sr_serial_dev_inst *serial,
d2cc60bd 132 size_t count, char *buf);
16fc7ee2 133SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
3f9b48ae
FS
134 int target, struct dev_context *devc);
135SR_PRIV int korad_kaxxxxp_get_value(struct sr_serial_dev_inst *serial,
136 int target, struct dev_context *devc);
16fc7ee2 137SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
d7083042 138 struct dev_context *devc);
16fc7ee2 139SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data);
e75ee7de
HV
140
141#endif