]> sigrok.org Git - libsigrok.git/blame - src/hardware/korad-kaxxxxp/protocol.h
Support for Korad KA3005P
[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>
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
d7083042
HV
20/**
21 * @file
16fc7ee2 22 * Korad KAxxxxP power supply driver
d7083042
HV
23 * @internal
24 */
25
16fc7ee2
UH
26#ifndef LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
27#define LIBSIGROK_HARDWARE_KORAD_KAXXXXP_PROTOCOL_H
e75ee7de
HV
28
29#include <stdint.h>
d7083042 30#include <string.h>
e75ee7de
HV
31#include <glib.h>
32#include <libsigrok/libsigrok.h>
33#include "libsigrok-internal.h"
34
16fc7ee2 35#define LOG_PREFIX "korad-kaxxxxp"
e75ee7de 36
16fc7ee2 37#define KAXXXXP_POLL_INTERVAL_MS 80
d7083042
HV
38
39enum {
40 VELLEMAN_LABPS_3005D,
2c5bdf1b 41 KORAD_KA3005D,
d7083042
HV
42 /* Support for future devices with this protocol. */
43};
44
45/* Information on single model */
16fc7ee2 46struct korad_kaxxxxp_model {
d7083042 47 int model_id; /**< Model info */
2c240774
UH
48 const char *vendor; /**< Vendor name */
49 const char *name; /**< Model name */
50 const char *id; /**< Model ID, as delivered by interface */
d7083042
HV
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 */
57enum {
16fc7ee2
UH
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,
d7083042
HV
69};
70
e75ee7de
HV
71/** Private, per-device-instance driver context. */
72struct dev_context {
73 /* Model-specific information */
16fc7ee2 74 const struct korad_kaxxxxp_model *model; /**< Model information. */
e75ee7de
HV
75
76 /* Acquisition settings */
d7083042
HV
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;
e75ee7de
HV
85
86 /* Operational state */
d7083042
HV
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). */
e75ee7de 92
d7083042
HV
93 gboolean output_enabled; /**< Is the output enabled? */
94 gboolean beep_enabled; /**< Enable beeper. */
9e5366df
UH
95 gboolean ocp_enabled; /**< Output current protection enabled. */
96 gboolean ovp_enabled; /**< Output voltage protection enabled. */
e75ee7de 97
d7083042 98 /* Temporary state across callbacks */
9e5366df 99 int target; /**< What reply to expect. */
d7083042
HV
100 int program; /**< Program to store or recall. */
101 char reply[6];
e75ee7de
HV
102};
103
16fc7ee2 104SR_PRIV int korad_kaxxxxp_send_cmd(struct sr_serial_dev_inst *serial,
d7083042 105 const char *cmd);
16fc7ee2 106SR_PRIV int korad_kaxxxxp_read_chars(struct sr_serial_dev_inst *serial,
d7083042 107 int count, char *buf);
16fc7ee2 108SR_PRIV int korad_kaxxxxp_set_value(struct sr_serial_dev_inst *serial,
d7083042 109 struct dev_context *devc);
16fc7ee2 110SR_PRIV int korad_kaxxxxp_query_value(struct sr_serial_dev_inst *serial,
d7083042 111 struct dev_context *devc);
16fc7ee2 112SR_PRIV int korad_kaxxxxp_get_reply(struct sr_serial_dev_inst *serial,
d7083042 113 struct dev_context *devc);
16fc7ee2 114SR_PRIV int korad_kaxxxxp_get_all_values(struct sr_serial_dev_inst *serial,
d7083042 115 struct dev_context *devc);
16fc7ee2 116SR_PRIV int korad_kaxxxxp_receive_data(int fd, int revents, void *cb_data);
e75ee7de
HV
117
118#endif