]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/agilent-dmm/api.c
agilent-dmm: add basic support for Agilent/Keysight U127x
[libsigrok.git] / src / hardware / agilent-dmm / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.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
20#include <config.h>
21#include <glib.h>
22#include <sys/types.h>
23#include <sys/stat.h>
24#include <fcntl.h>
25#include <string.h>
26#include <libsigrok/libsigrok.h>
27#include "libsigrok-internal.h"
28#include "protocol.h"
29
30static const uint32_t scanopts[] = {
31 SR_CONF_CONN,
32 SR_CONF_SERIALCOMM,
33};
34
35static const uint32_t drvopts[] = {
36 SR_CONF_MULTIMETER,
37};
38
39static const uint32_t devopts[] = {
40 SR_CONF_CONTINUOUS,
41 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
42 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
43 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
44 SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
45};
46
47static const uint64_t samplerates[] = {
48 SR_HZ(1),
49 SR_HZ(20),
50 SR_HZ(1),
51};
52
53static const char *data_sources[] = {
54 "Live", "Log-Hand", "Log-Trig", "Log-Auto", "Log-Export",
55};
56
57extern const struct agdmm_job agdmm_jobs_live[];
58extern const struct agdmm_job agdmm_jobs_log[];
59extern const struct agdmm_recv agdmm_recvs_u123x[];
60extern const struct agdmm_recv agdmm_recvs_u124x[];
61extern const struct agdmm_recv agdmm_recvs_u124xc[];
62extern const struct agdmm_recv agdmm_recvs_u125x[];
63extern const struct agdmm_recv agdmm_recvs_u127x[];
64extern const struct agdmm_recv agdmm_recvs_u128x[];
65
66/* This works on all the Agilent U12xxA series, although the
67 * U127xA can apparently also run at 19200/8n1. */
68#define SERIALCOMM "9600/8n1"
69
70static const struct agdmm_profile supported_agdmm[] = {
71 { AGILENT_U1231, "U1231A", 1, agdmm_jobs_live, NULL, agdmm_recvs_u123x },
72 { AGILENT_U1232, "U1232A", 1, agdmm_jobs_live, NULL, agdmm_recvs_u123x },
73 { AGILENT_U1233, "U1233A", 1, agdmm_jobs_live, NULL, agdmm_recvs_u123x },
74
75 { AGILENT_U1241, "U1241A", 2, agdmm_jobs_live, NULL, agdmm_recvs_u124x },
76 { AGILENT_U1242, "U1242A", 2, agdmm_jobs_live, NULL, agdmm_recvs_u124x },
77 { AGILENT_U1241, "U1241B", 2, agdmm_jobs_live, NULL, agdmm_recvs_u124x },
78 { AGILENT_U1242, "U1242B", 2, agdmm_jobs_live, NULL, agdmm_recvs_u124x },
79
80 { KEYSIGHT_U1241C, "U1241C", 2, agdmm_jobs_live, agdmm_jobs_log, agdmm_recvs_u124xc },
81 { KEYSIGHT_U1242C, "U1242C", 2, agdmm_jobs_live, agdmm_jobs_log, agdmm_recvs_u124xc },
82
83 { AGILENT_U1251, "U1251A", 3, agdmm_jobs_live, NULL, agdmm_recvs_u125x },
84 { AGILENT_U1252, "U1252A", 3, agdmm_jobs_live, NULL, agdmm_recvs_u125x },
85 { AGILENT_U1253, "U1253A", 3, agdmm_jobs_live, NULL, agdmm_recvs_u125x },
86 { AGILENT_U1251, "U1251B", 3, agdmm_jobs_live, NULL, agdmm_recvs_u125x },
87 { AGILENT_U1252, "U1252B", 3, agdmm_jobs_live, NULL, agdmm_recvs_u125x },
88 { AGILENT_U1253, "U1253B", 3, agdmm_jobs_live, NULL, agdmm_recvs_u125x },
89
90 { AGILENT_U1271, "U1271A", 3, agdmm_jobs_live, NULL, agdmm_recvs_u127x },
91 { AGILENT_U1272, "U1272A", 3, agdmm_jobs_live, NULL, agdmm_recvs_u127x },
92 { AGILENT_U1273, "U1273A", 3, agdmm_jobs_live, NULL, agdmm_recvs_u127x },
93
94 { KEYSIGHT_U1281, "U1281A", 3, agdmm_jobs_live, agdmm_jobs_log, agdmm_recvs_u128x },
95 { KEYSIGHT_U1282, "U1282A", 3, agdmm_jobs_live, agdmm_jobs_log, agdmm_recvs_u128x },
96 ALL_ZERO
97};
98
99static GSList *scan(struct sr_dev_driver *di, GSList *options)
100{
101 struct sr_dev_inst *sdi;
102 struct dev_context *devc;
103 struct sr_config *src;
104 struct sr_serial_dev_inst *serial;
105 GSList *l, *devices;
106 int len, i;
107 const char *conn, *serialcomm;
108 char *buf, **tokens;
109
110 devices = NULL;
111 conn = serialcomm = NULL;
112 for (l = options; l; l = l->next) {
113 src = l->data;
114 switch (src->key) {
115 case SR_CONF_CONN:
116 conn = g_variant_get_string(src->data, NULL);
117 break;
118 case SR_CONF_SERIALCOMM:
119 serialcomm = g_variant_get_string(src->data, NULL);
120 break;
121 }
122 }
123 if (!conn)
124 return NULL;
125 if (!serialcomm)
126 serialcomm = SERIALCOMM;
127
128 serial = sr_serial_dev_inst_new(conn, serialcomm);
129
130 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
131 return NULL;
132
133 serial_flush(serial);
134 if (serial_write_blocking(serial, "*IDN?\r\n", 7, SERIAL_WRITE_TIMEOUT_MS) < 7) {
135 sr_err("Unable to send identification string.");
136 return NULL;
137 }
138
139 len = 128;
140 buf = g_malloc(len);
141 serial_readline(serial, &buf, &len, 250);
142 if (!len)
143 return NULL;
144
145 tokens = g_strsplit(buf, ",", 4);
146 if ((!strcmp("Agilent Technologies", tokens[0]) ||
147 !strcmp("Keysight Technologies", tokens[0]))
148 && tokens[1] && tokens[2] && tokens[3]) {
149 for (i = 0; supported_agdmm[i].model; i++) {
150 if (strcmp(supported_agdmm[i].modelname, tokens[1]))
151 continue;
152 sdi = g_malloc0(sizeof(struct sr_dev_inst));
153 sdi->status = SR_ST_INACTIVE;
154 sdi->vendor = g_strdup(tokens[0][0] == 'A' ? "Agilent" : "Keysight");
155 sdi->model = g_strdup(tokens[1]);
156 sdi->version = g_strdup(tokens[3]);
157 devc = g_malloc0(sizeof(struct dev_context));
158 sr_sw_limits_init(&devc->limits);
159 devc->profile = &supported_agdmm[i];
160 devc->data_source = DEFAULT_DATA_SOURCE;
161 devc->cur_samplerate = 5;
162 if (supported_agdmm[i].nb_channels > 1) {
163 int temp_chan = supported_agdmm[i].nb_channels - 1;
164 devc->cur_mq[temp_chan] = SR_MQ_TEMPERATURE;
165 devc->cur_unit[temp_chan] = SR_UNIT_CELSIUS;
166 devc->cur_digits[temp_chan] = 1;
167 devc->cur_encoding[temp_chan] = 2;
168 }
169 sdi->inst_type = SR_INST_SERIAL;
170 sdi->conn = serial;
171 sdi->priv = devc;
172 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
173 if (supported_agdmm[i].nb_channels > 1)
174 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "P2");
175 if (supported_agdmm[i].nb_channels > 2)
176 sr_channel_new(sdi, 2, SR_CHANNEL_ANALOG, TRUE, "P3");
177 devices = g_slist_append(devices, sdi);
178 break;
179 }
180 }
181 g_strfreev(tokens);
182 g_free(buf);
183
184 serial_close(serial);
185 if (!devices)
186 sr_serial_dev_inst_free(serial);
187
188 return std_scan_complete(di, devices);
189}
190
191static int config_get(uint32_t key, GVariant **data,
192 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
193{
194 struct dev_context *devc;
195
196 (void)cg;
197
198 devc = sdi->priv;
199
200 switch (key) {
201 case SR_CONF_SAMPLERATE:
202 *data = g_variant_new_uint64(devc->cur_samplerate);
203 break;
204 case SR_CONF_LIMIT_SAMPLES:
205 case SR_CONF_LIMIT_MSEC:
206 return sr_sw_limits_config_get(&devc->limits, key, data);
207 case SR_CONF_DATA_SOURCE:
208 *data = g_variant_new_string(data_sources[devc->data_source]);
209 break;
210 default:
211 return SR_ERR_NA;
212 }
213
214 return SR_OK;
215}
216
217static int config_set(uint32_t key, GVariant *data,
218 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
219{
220 struct dev_context *devc;
221 uint64_t samplerate;
222 int idx;
223
224 (void)cg;
225
226 devc = sdi->priv;
227
228 switch (key) {
229 case SR_CONF_SAMPLERATE:
230 samplerate = g_variant_get_uint64(data);
231 if (samplerate < samplerates[0] || samplerate > samplerates[1])
232 return SR_ERR_ARG;
233 devc->cur_samplerate = g_variant_get_uint64(data);
234 break;
235 case SR_CONF_LIMIT_SAMPLES:
236 case SR_CONF_LIMIT_MSEC:
237 return sr_sw_limits_config_set(&devc->limits, key, data);
238 case SR_CONF_DATA_SOURCE:
239 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(data_sources))) < 0)
240 return SR_ERR_ARG;
241 devc->data_source = idx;
242 break;
243 default:
244 return SR_ERR_NA;
245 }
246
247 return SR_OK;
248}
249
250static int config_list(uint32_t key, GVariant **data,
251 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
252{
253 switch (key) {
254 case SR_CONF_SCAN_OPTIONS:
255 case SR_CONF_DEVICE_OPTIONS:
256 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
257 case SR_CONF_SAMPLERATE:
258 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
259 break;
260 case SR_CONF_DATA_SOURCE:
261 *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
262 break;
263 default:
264 return SR_ERR_NA;
265 }
266
267 return SR_OK;
268}
269
270static int dev_acquisition_start(const struct sr_dev_inst *sdi)
271{
272 struct dev_context *devc = sdi->priv;
273 struct sr_serial_dev_inst *serial;
274
275 devc->cur_channel = sr_next_enabled_channel(sdi, NULL);
276 devc->cur_conf = sr_next_enabled_channel(sdi, NULL);
277 devc->cur_sample = 1;
278 devc->cur_mq[0] = -1;
279 if (devc->profile->nb_channels > 2)
280 devc->cur_mq[1] = -1;
281
282 if (devc->data_source == DATA_SOURCE_LIVE) {
283 devc->jobs = devc->profile->jobs_live;
284 } else {
285 devc->jobs = devc->profile->jobs_log;
286 if (!devc->jobs) {
287 sr_err("Log data source is not implemented for this model.");
288 return SR_ERR_NA;
289 }
290 if (!((struct sr_channel *)sdi->channels->data)->enabled) {
291 sr_err("Log data is only available for channel P1.");
292 return SR_ERR_NA;
293 }
294 }
295
296 sr_sw_limits_acquisition_start(&devc->limits);
297 std_session_send_df_header(sdi);
298
299 serial = sdi->conn;
300 serial_source_add(sdi->session, serial, G_IO_IN, 10,
301 agdmm_receive_data, (void *)sdi);
302
303 return SR_OK;
304}
305
306static struct sr_dev_driver agdmm_driver_info = {
307 .name = "agilent-dmm",
308 .longname = "Agilent U12xx series DMMs",
309 .api_version = 1,
310 .init = std_init,
311 .cleanup = std_cleanup,
312 .scan = scan,
313 .dev_list = std_dev_list,
314 .dev_clear = std_dev_clear,
315 .config_get = config_get,
316 .config_set = config_set,
317 .config_list = config_list,
318 .dev_open = std_serial_dev_open,
319 .dev_close = std_serial_dev_close,
320 .dev_acquisition_start = dev_acquisition_start,
321 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
322 .context = NULL,
323};
324SR_REGISTER_DEV_DRIVER(agdmm_driver_info);