5fa0ba6f84c91910aea089164f783e426b936fe6
[libsigrok.git] / src / hardware / scpi-dmm / protocol.h
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2018 Gerhard Sittig <gerhard.sittig@gmx.net>
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 #ifndef LIBSIGROK_HARDWARE_SCPI_DMM_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_SCPI_DMM_PROTOCOL_H
22
23 #include <config.h>
24 #include <glib.h>
25 #include <stdint.h>
26 #include <stdlib.h>
27 #include <libsigrok/libsigrok.h>
28 #include "libsigrok-internal.h"
29 #include "scpi.h"
30
31 #define LOG_PREFIX "scpi-dmm"
32
33 #define SCPI_DMM_MAX_CHANNELS   1
34
35 enum scpi_dmm_cmdcode {
36         DMM_CMD_SETUP_REMOTE,
37         DMM_CMD_SETUP_FUNC,
38         DMM_CMD_QUERY_FUNC,
39         DMM_CMD_START_ACQ,
40         DMM_CMD_STOP_ACQ,
41         DMM_CMD_QUERY_VALUE,
42         DMM_CMD_QUERY_PREC,
43         DMM_CMD_SETUP_LOCAL,
44         DMM_CMD_QUERY_RANGE_AUTO,
45         DMM_CMD_QUERY_RANGE,
46         DMM_CMD_SETUP_RANGE_AUTO,
47         DMM_CMD_SETUP_RANGE,
48 };
49
50 struct mqopt_item {
51         enum sr_mq mq;
52         enum sr_mqflag mqflag;
53         const char *scpi_func_setup;
54         const char *scpi_func_query;
55         int default_precision;
56         uint32_t drv_flags;
57 };
58 #define NO_DFLT_PREC    -99
59 #define FLAGS_NONE      0
60
61 struct scpi_dmm_model {
62         const char *vendor;
63         const char *model;
64         size_t num_channels;
65         ssize_t digits;
66         const struct scpi_command *cmdset;
67         const struct mqopt_item *mqopts;
68         size_t mqopt_size;
69         int (*get_measurement)(const struct sr_dev_inst *sdi, size_t ch);
70         const uint32_t *devopts;
71         size_t devopts_size;
72         unsigned int read_timeout_us; /* If zero, use default from src/scpi/scpi.c. */
73         float infinity_limit; /* If zero, use default from protocol.c */
74         gboolean check_opc;
75         const char *(*get_range_text)(const struct sr_dev_inst *sdi);
76         int (*set_range_from_text)(const struct sr_dev_inst *sdi,
77                 const char *range);
78         GVariant *(*get_range_text_list)(const struct sr_dev_inst *sdi);
79 };
80
81 struct dev_context {
82         size_t num_channels;
83         const struct scpi_command *cmdset;
84         const struct scpi_dmm_model *model;
85         struct sr_sw_limits limits;
86         struct {
87                 enum sr_mq curr_mq;
88                 enum sr_mqflag curr_mqflag;
89         } start_acq_mq;
90         struct scpi_dmm_acq_info {
91                 float f_value;
92                 double d_value;
93                 struct sr_datafeed_packet packet;
94                 struct sr_datafeed_analog analog[SCPI_DMM_MAX_CHANNELS];
95                 struct sr_analog_encoding encoding[SCPI_DMM_MAX_CHANNELS];
96                 struct sr_analog_meaning meaning[SCPI_DMM_MAX_CHANNELS];
97                 struct sr_analog_spec spec[SCPI_DMM_MAX_CHANNELS];
98         } run_acq_info;
99         gchar *precision;
100         char range_text[32];
101 };
102
103 SR_PRIV void scpi_dmm_cmd_delay(struct sr_scpi_dev_inst *scpi);
104 SR_PRIV const struct mqopt_item *scpi_dmm_lookup_mq_number(
105         const struct sr_dev_inst *sdi, enum sr_mq mq, enum sr_mqflag flag);
106 SR_PRIV const struct mqopt_item *scpi_dmm_lookup_mq_text(
107         const struct sr_dev_inst *sdi, const char *text);
108 SR_PRIV int scpi_dmm_get_mq(const struct sr_dev_inst *sdi,
109         enum sr_mq *mq, enum sr_mqflag *flag, char **rsp,
110         const struct mqopt_item **mqitem);
111 SR_PRIV int scpi_dmm_set_mq(const struct sr_dev_inst *sdi,
112         enum sr_mq mq, enum sr_mqflag flag);
113 SR_PRIV const char *scpi_dmm_get_range_text(const struct sr_dev_inst *sdi);
114 SR_PRIV int scpi_dmm_set_range_from_text(const struct sr_dev_inst *sdi,
115         const char *range);
116 SR_PRIV GVariant *scpi_dmm_get_range_text_list(const struct sr_dev_inst *sdi);
117 SR_PRIV int scpi_dmm_get_meas_agilent(const struct sr_dev_inst *sdi, size_t ch);
118 SR_PRIV int scpi_dmm_get_meas_gwinstek(const struct sr_dev_inst *sdi, size_t ch);
119 SR_PRIV int scpi_dmm_receive_data(int fd, int revents, void *cb_data);
120
121 #endif