]> sigrok.org Git - libsigrok.git/blame - src/hardware/agilent-dmm/api.c
agilent-dmm: Add Agilent U1237AX (completely untested).
[libsigrok.git] / src / hardware / agilent-dmm / api.c
CommitLineData
e93cdf42 1/*
50985c20 2 * This file is part of the libsigrok project.
e93cdf42
BV
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
6ec6c43b 20#include <config.h>
e93cdf42 21#include <glib.h>
e93cdf42
BV
22#include <sys/types.h>
23#include <sys/stat.h>
24#include <fcntl.h>
25#include <string.h>
c1aae900 26#include <libsigrok/libsigrok.h>
6f22a8ef 27#include "libsigrok-internal.h"
6cf1a87b 28#include "protocol.h"
e93cdf42 29
a0e0bb41 30static const uint32_t scanopts[] = {
1953564a
BV
31 SR_CONF_CONN,
32 SR_CONF_SERIALCOMM,
e93cdf42
BV
33};
34
f9dada0b 35static const uint32_t drvopts[] = {
1953564a 36 SR_CONF_MULTIMETER,
f9dada0b
BV
37};
38
39static const uint32_t devopts[] = {
e91bb0a6 40 SR_CONF_CONTINUOUS,
6ace179e
AJ
41 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
42 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
b907d62f 43 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
63bb11ba 44 SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
b907d62f
AJ
45};
46
47static const uint64_t samplerates[] = {
48 SR_HZ(1),
49 SR_HZ(20),
50 SR_HZ(1),
e93cdf42
BV
51};
52
63bb11ba 53static const char *data_sources[] = {
f8195cb2 54 "Live", "Log-Hand", "Log-Trig", "Log-Auto", "Log-Export",
63bb11ba
AJ
55};
56
57extern const struct agdmm_job agdmm_jobs_live[];
58extern const struct agdmm_job agdmm_jobs_log[];
8c0152f2 59extern const struct agdmm_recv agdmm_recvs_u123x[];
4edba404 60extern const struct agdmm_recv agdmm_recvs_u124x[];
0ceb7038 61extern const struct agdmm_recv agdmm_recvs_u124xc[];
8c0152f2 62extern const struct agdmm_recv agdmm_recvs_u125x[];
16a8e580 63extern const struct agdmm_recv agdmm_recvs_u127x[];
43185ed3 64extern const struct agdmm_recv agdmm_recvs_u128x[];
e93cdf42 65
74ac7d7f
BV
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
e93cdf42 70static const struct agdmm_profile supported_agdmm[] = {
63bb11ba
AJ
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
0ceb7038
AJ
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
63bb11ba
AJ
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
16a8e580
GE
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 },
f0362f59 93 { AGILENT_U1273AX, "U1273AX", 3, agdmm_jobs_live, NULL, agdmm_recvs_u127x },
e24e74ed 94
63bb11ba
AJ
95 { KEYSIGHT_U1281, "U1281A", 3, agdmm_jobs_live, agdmm_jobs_log, agdmm_recvs_u128x },
96 { KEYSIGHT_U1282, "U1282A", 3, agdmm_jobs_live, agdmm_jobs_log, agdmm_recvs_u128x },
f857bd92 97 ALL_ZERO
e93cdf42
BV
98};
99
4f840ce9 100static GSList *scan(struct sr_dev_driver *di, GSList *options)
e93cdf42
BV
101{
102 struct sr_dev_inst *sdi;
e93cdf42 103 struct dev_context *devc;
1987b8d6 104 struct sr_config *src;
109a3ba4 105 struct sr_serial_dev_inst *serial;
e93cdf42 106 GSList *l, *devices;
109a3ba4 107 int len, i;
e93cdf42
BV
108 const char *conn, *serialcomm;
109 char *buf, **tokens;
110
e93cdf42
BV
111 devices = NULL;
112 conn = serialcomm = NULL;
113 for (l = options; l; l = l->next) {
1987b8d6
BV
114 src = l->data;
115 switch (src->key) {
1953564a 116 case SR_CONF_CONN:
e44ac12a 117 conn = g_variant_get_string(src->data, NULL);
e93cdf42 118 break;
1953564a 119 case SR_CONF_SERIALCOMM:
e44ac12a 120 serialcomm = g_variant_get_string(src->data, NULL);
e93cdf42
BV
121 break;
122 }
123 }
74ac7d7f 124 if (!conn)
e93cdf42 125 return NULL;
109a3ba4
BV
126 if (!serialcomm)
127 serialcomm = SERIALCOMM;
e93cdf42 128
91219afc 129 serial = sr_serial_dev_inst_new(conn, serialcomm);
e93cdf42 130
64c536be 131 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
e93cdf42 132 return NULL;
e93cdf42 133
109a3ba4 134 serial_flush(serial);
95779b43 135 if (serial_write_blocking(serial, "*IDN?\r\n", 7, SERIAL_WRITE_TIMEOUT_MS) < 7) {
081c214e 136 sr_err("Unable to send identification string.");
e93cdf42
BV
137 return NULL;
138 }
139
140 len = 128;
a95f142e 141 buf = g_malloc(len);
ee2bcdfc 142 serial_readline(serial, &buf, &len, 250);
e93cdf42
BV
143 if (!len)
144 return NULL;
145
146 tokens = g_strsplit(buf, ",", 4);
9ae544b6
AJ
147 if ((!strcmp("Agilent Technologies", tokens[0]) ||
148 !strcmp("Keysight Technologies", tokens[0]))
fbf07e02 149 && tokens[1] && tokens[2] && tokens[3]) {
e93cdf42
BV
150 for (i = 0; supported_agdmm[i].model; i++) {
151 if (strcmp(supported_agdmm[i].modelname, tokens[1]))
152 continue;
aac29cc1 153 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be 154 sdi->status = SR_ST_INACTIVE;
9ae544b6 155 sdi->vendor = g_strdup(tokens[0][0] == 'A' ? "Agilent" : "Keysight");
0af636be
UH
156 sdi->model = g_strdup(tokens[1]);
157 sdi->version = g_strdup(tokens[3]);
f57d8ffe 158 devc = g_malloc0(sizeof(struct dev_context));
5b6829ea 159 sr_sw_limits_init(&devc->limits);
e93cdf42 160 devc->profile = &supported_agdmm[i];
63bb11ba 161 devc->data_source = DEFAULT_DATA_SOURCE;
b907d62f 162 devc->cur_samplerate = 5;
d822726d
AJ
163 if (supported_agdmm[i].nb_channels > 1) {
164 int temp_chan = supported_agdmm[i].nb_channels - 1;
165 devc->cur_mq[temp_chan] = SR_MQ_TEMPERATURE;
166 devc->cur_unit[temp_chan] = SR_UNIT_CELSIUS;
167 devc->cur_digits[temp_chan] = 1;
168 devc->cur_encoding[temp_chan] = 2;
169 }
fb3a1505
BV
170 sdi->inst_type = SR_INST_SERIAL;
171 sdi->conn = serial;
e93cdf42 172 sdi->priv = devc;
5e23fcab 173 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
d822726d
AJ
174 if (supported_agdmm[i].nb_channels > 1)
175 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "P2");
176 if (supported_agdmm[i].nb_channels > 2)
177 sr_channel_new(sdi, 2, SR_CHANNEL_ANALOG, TRUE, "P3");
e93cdf42
BV
178 devices = g_slist_append(devices, sdi);
179 break;
180 }
181 }
182 g_strfreev(tokens);
183 g_free(buf);
184
109a3ba4
BV
185 serial_close(serial);
186 if (!devices)
187 sr_serial_dev_inst_free(serial);
e93cdf42 188
15a5bfe4 189 return std_scan_complete(di, devices);
e93cdf42
BV
190}
191
dd7a72ea
UH
192static int config_get(uint32_t key, GVariant **data,
193 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
6ace179e
AJ
194{
195 struct dev_context *devc;
6ace179e
AJ
196
197 (void)cg;
198
199 devc = sdi->priv;
200
6ace179e 201 switch (key) {
b907d62f
AJ
202 case SR_CONF_SAMPLERATE:
203 *data = g_variant_new_uint64(devc->cur_samplerate);
204 break;
6ace179e
AJ
205 case SR_CONF_LIMIT_SAMPLES:
206 case SR_CONF_LIMIT_MSEC:
758906aa 207 return sr_sw_limits_config_get(&devc->limits, key, data);
63bb11ba
AJ
208 case SR_CONF_DATA_SOURCE:
209 *data = g_variant_new_string(data_sources[devc->data_source]);
210 break;
6ace179e
AJ
211 default:
212 return SR_ERR_NA;
213 }
214
758906aa 215 return SR_OK;
6ace179e
AJ
216}
217
dd7a72ea
UH
218static int config_set(uint32_t key, GVariant *data,
219 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
e93cdf42
BV
220{
221 struct dev_context *devc;
b907d62f 222 uint64_t samplerate;
758906aa 223 int idx;
e93cdf42 224
53b4680f 225 (void)cg;
8f996b89 226
b0baddef 227 devc = sdi->priv;
e93cdf42 228
6ace179e 229 switch (key) {
b907d62f
AJ
230 case SR_CONF_SAMPLERATE:
231 samplerate = g_variant_get_uint64(data);
232 if (samplerate < samplerates[0] || samplerate > samplerates[1])
758906aa
UH
233 return SR_ERR_ARG;
234 devc->cur_samplerate = g_variant_get_uint64(data);
b907d62f 235 break;
6ace179e
AJ
236 case SR_CONF_LIMIT_SAMPLES:
237 case SR_CONF_LIMIT_MSEC:
758906aa 238 return sr_sw_limits_config_set(&devc->limits, key, data);
697fb6dd
UH
239 case SR_CONF_DATA_SOURCE:
240 if ((idx = std_str_idx(data, ARRAY_AND_SIZE(data_sources))) < 0)
241 return SR_ERR_ARG;
242 devc->data_source = idx;
63bb11ba 243 break;
6ace179e 244 default:
758906aa 245 return SR_ERR_NA;
6ace179e
AJ
246 }
247
758906aa 248 return SR_OK;
e93cdf42
BV
249}
250
dd7a72ea
UH
251static int config_list(uint32_t key, GVariant **data,
252 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
a1c743fc 253{
6ace179e 254 switch (key) {
e66d1892 255 case SR_CONF_SCAN_OPTIONS:
9a6517d1 256 case SR_CONF_DEVICE_OPTIONS:
e66d1892 257 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
b907d62f 258 case SR_CONF_SAMPLERATE:
53012da6 259 *data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
b907d62f 260 break;
63bb11ba 261 case SR_CONF_DATA_SOURCE:
53012da6 262 *data = g_variant_new_strv(ARRAY_AND_SIZE(data_sources));
63bb11ba 263 break;
a1c743fc 264 default:
bd6fbf62 265 return SR_ERR_NA;
a1c743fc
BV
266 }
267
268 return SR_OK;
269}
270
695dc859 271static int dev_acquisition_start(const struct sr_dev_inst *sdi)
e93cdf42 272{
5b6829ea 273 struct dev_context *devc = sdi->priv;
fb3a1505 274 struct sr_serial_dev_inst *serial;
e93cdf42 275
d822726d
AJ
276 devc->cur_channel = sr_next_enabled_channel(sdi, NULL);
277 devc->cur_conf = sr_next_enabled_channel(sdi, NULL);
63bb11ba 278 devc->cur_sample = 1;
d822726d
AJ
279 devc->cur_mq[0] = -1;
280 if (devc->profile->nb_channels > 2)
281 devc->cur_mq[1] = -1;
282
63bb11ba
AJ
283 if (devc->data_source == DATA_SOURCE_LIVE) {
284 devc->jobs = devc->profile->jobs_live;
285 } else {
286 devc->jobs = devc->profile->jobs_log;
287 if (!devc->jobs) {
288 sr_err("Log data source is not implemented for this model.");
289 return SR_ERR_NA;
290 }
291 if (!((struct sr_channel *)sdi->channels->data)->enabled) {
292 sr_err("Log data is only available for channel P1.");
293 return SR_ERR_NA;
294 }
295 }
296
5b6829ea 297 sr_sw_limits_acquisition_start(&devc->limits);
bee2b016 298 std_session_send_df_header(sdi);
e93cdf42 299
fb3a1505 300 serial = sdi->conn;
b907d62f 301 serial_source_add(sdi->session, serial, G_IO_IN, 10,
102f1239 302 agdmm_receive_data, (void *)sdi);
e93cdf42
BV
303
304 return SR_OK;
305}
306
dd5c48a6 307static struct sr_dev_driver agdmm_driver_info = {
e93cdf42
BV
308 .name = "agilent-dmm",
309 .longname = "Agilent U12xx series DMMs",
310 .api_version = 1,
c2fdcc25 311 .init = std_init,
700d6b64 312 .cleanup = std_cleanup,
6078d2c9 313 .scan = scan,
c01bf34c 314 .dev_list = std_dev_list,
f778bf02 315 .dev_clear = std_dev_clear,
6ace179e 316 .config_get = config_get,
035a1078 317 .config_set = config_set,
a1c743fc 318 .config_list = config_list,
854434de 319 .dev_open = std_serial_dev_open,
bf2c987f 320 .dev_close = std_serial_dev_close,
6078d2c9 321 .dev_acquisition_start = dev_acquisition_start,
4b1a9d5d 322 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
41812aca 323 .context = NULL,
e93cdf42 324};
dd5c48a6 325SR_REGISTER_DEV_DRIVER(agdmm_driver_info);