scpi-pps: Add a missing "break" in config_get().
[libsigrok.git] / src / hardware / fluke-45 / api.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5  * Copyright (C) 2017 John Chajecki <subs@qcontinuum.plus.com>
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 #include <config.h>
22 #include <glib.h>
23 #include <sys/types.h>
24 #include <sys/stat.h>
25 #include <fcntl.h>
26 #include <string.h>
27 #include <stdint.h>
28 #include <stdbool.h>
29 #include <libsigrok/libsigrok.h>
30 #include "libsigrok-internal.h"
31 #include "scpi.h"
32 #include "protocol.h"
33
34 static const uint32_t scanopts[] = {
35         SR_CONF_CONN,
36         SR_CONF_SERIALCOMM,
37 };
38
39 static const uint32_t drvopts[] = {
40         SR_CONF_MULTIMETER,
41 };
42
43 static const uint32_t devopts[] = {
44         SR_CONF_CONTINUOUS,
45         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
46         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
47 };
48
49 /* Vendor, model, number of channels, poll period */
50 static const struct fluke_scpi_dmm_model supported_models[] = {
51         { "FLUKE", "45", 2, 0 },
52 };
53
54 static struct sr_dev_driver fluke_45_driver_info;
55
56 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
57 {
58         struct dev_context *devc;
59         struct sr_dev_inst *sdi;
60         struct sr_scpi_hw_info *hw_info;
61         const struct scpi_command *cmdset = fluke_45_cmdset;
62         unsigned int i;
63         const struct fluke_scpi_dmm_model *model = NULL;
64         gchar *channel_name;
65         char *response;
66
67         sdi = g_malloc0(sizeof(struct sr_dev_inst));
68         sdi->conn = scpi;
69
70         /* Test for serial port ECHO enabled. */
71         sr_scpi_get_string(scpi, "ECHO-TEST", &response);
72         if (strcmp(response, "ECHO-TEST") == 0) {
73                 sr_err("Serial port ECHO is ON. Please turn it OFF!");
74                 return NULL;
75         }
76
77         /* Get device IDN. */
78         if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
79                 sr_info("Couldn't get IDN response, retrying.");
80                 sr_scpi_close(scpi);
81                 sr_scpi_open(scpi);
82                 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
83                         sr_info("Couldn't get IDN response.");
84                         return NULL;
85                 }
86         }
87
88         /* Check IDN. */
89         for (i = 0; i < ARRAY_SIZE(supported_models); i++) {
90                 if (!g_ascii_strcasecmp(hw_info->manufacturer,
91                                         supported_models[i].vendor) &&
92                                 !strcmp(hw_info->model, supported_models[i].model)) {
93                         model = &supported_models[i];
94                         break;
95                 }
96         }
97         if (!model) {
98                 sr_scpi_hw_info_free(hw_info);
99                 return NULL;
100         }
101
102         /* Set up device parameters. */
103         sdi->vendor = g_strdup(model->vendor);
104         sdi->model = g_strdup(model->model);
105         sdi->version = g_strdup(hw_info->firmware_version);
106         sdi->serial_num = g_strdup(hw_info->serial_number);
107         sdi->conn = scpi;
108         sdi->driver = &fluke_45_driver_info;
109         sdi->inst_type = SR_INST_SCPI;
110
111         devc = g_malloc0(sizeof(struct dev_context));
112         devc->num_channels = model->num_channels;
113         devc->cmdset = cmdset;
114
115         /* Create channels. */
116         for (i = 0; i < devc->num_channels; i++) {
117                 channel_name = g_strdup_printf("P%d", i + 1);
118                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, channel_name);
119         }
120
121         sdi->priv = devc;
122
123         return sdi;
124 }
125
126 static GSList *scan(struct sr_dev_driver *di, GSList *options)
127 {
128         return sr_scpi_scan(di->context, options, probe_device);
129 }
130
131 static int dev_open(struct sr_dev_inst *sdi)
132 {
133         struct sr_scpi_dev_inst *scpi;
134         int ret;
135
136         scpi = sdi->conn;
137
138         if ((ret = sr_scpi_open(scpi) < 0)) {
139                 sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
140                 return SR_ERR;
141         }
142
143         return SR_OK;
144 }
145
146 static int dev_close(struct sr_dev_inst *sdi)
147 {
148         struct sr_scpi_dev_inst *scpi;
149
150         scpi = sdi->conn;
151
152         if (!scpi)
153                 return SR_ERR_BUG;
154
155         return sr_scpi_close(scpi);
156 }
157
158 static int config_set(uint32_t key, GVariant *data,
159         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
160 {
161         struct dev_context *devc;
162
163         (void)cg;
164
165         devc = sdi->priv;
166
167         return sr_sw_limits_config_set(&devc->limits, key, data);
168 }
169
170 static int config_list(uint32_t key, GVariant **data,
171         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
172 {
173         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
174 }
175
176 static int config_get(uint32_t key, GVariant **data,
177         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
178 {
179         struct dev_context *devc = sdi->priv;
180
181         (void)cg;
182
183         return sr_sw_limits_config_get(&devc->limits, key, data);
184 }
185
186 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
187 {
188         struct sr_scpi_dev_inst *scpi;
189         struct dev_context *devc;
190         int ret;
191
192         scpi = sdi->conn;
193         devc = sdi->priv;
194
195         sr_sw_limits_acquisition_start(&devc->limits);
196         std_session_send_df_header(sdi);
197
198         if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
199                         fl45_scpi_receive_data, (void *)sdi)) != SR_OK)
200                 return ret;
201
202         return SR_OK;
203 }
204
205 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
206 {
207         struct sr_scpi_dev_inst *scpi;
208         double d;
209
210         scpi = sdi->conn;
211
212         /*
213          * A requested value is certainly on the way. Retrieve it now,
214          * to avoid leaving the device in a state where it's not expecting
215          * commands.
216          */
217         sr_scpi_get_double(scpi, NULL, &d);
218         sr_scpi_source_remove(sdi->session, scpi);
219
220         std_session_send_df_end(sdi);
221
222         return SR_OK;
223 }
224
225 static struct sr_dev_driver fluke_45_driver_info = {
226         .name = "fluke-45",
227         .longname = "Fluke 45",
228         .api_version = 1,
229         .init = std_init,
230         .cleanup = std_cleanup,
231         .scan = scan,
232         .dev_list = std_dev_list,
233         .dev_clear = std_dev_clear,
234         .config_get = config_get,
235         .config_set = config_set,
236         .config_list = config_list,
237         .dev_open = dev_open,
238         .dev_close = dev_close,
239         .dev_acquisition_start = dev_acquisition_start,
240         .dev_acquisition_stop = dev_acquisition_stop,
241         .context = NULL,
242 };
243 SR_REGISTER_DEV_DRIVER(fluke_45_driver_info);