]> sigrok.org Git - libsigrok.git/blame - src/hardware/norma-dmm/api.c
Build: Include <config.h> first in all source files
[libsigrok.git] / src / hardware / norma-dmm / api.c
CommitLineData
bfd48770
MH
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
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
a4e435eb
MH
20/** @file
21 * Norma DM9x0/Siemens B102x DMMs driver.
22 * @internal
23 */
24
6ec6c43b 25#include <config.h>
bfd48770
MH
26#include "protocol.h"
27
a0e0bb41 28static const uint32_t scanopts[] = {
f8e76e2e
MH
29 SR_CONF_CONN,
30 SR_CONF_SERIALCOMM,
31};
32
f254bc4b 33static const uint32_t devopts[] = {
f8e76e2e 34 SR_CONF_MULTIMETER,
f8e76e2e 35 SR_CONF_CONTINUOUS,
5827f61b
BV
36 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
37 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
f8e76e2e
MH
38};
39
e790bd5c 40#define BUF_MAX 50
f8e76e2e
MH
41
42#define SERIALCOMM "4800/8n1/dtr=1/rts=0/flow=1"
43
bfd48770 44SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
49c06128 45SR_PRIV struct sr_dev_driver siemens_b102x_driver_info;
bfd48770 46
c442ffda 47static const char *get_brandstr(struct sr_dev_driver *drv)
bfd48770 48{
49c06128
MH
49 if (drv == &norma_dmm_driver_info)
50 return "Norma";
51 else
52 return "Siemens";
bfd48770
MH
53}
54
c442ffda 55static const char *get_typestr(int type, struct sr_dev_driver *drv)
49c06128 56{
c442ffda 57 static const char *nameref[5][2] = {
49c06128
MH
58 {"DM910", "B1024"},
59 {"DM920", "B1025"},
60 {"DM930", "B1026"},
61 {"DM940", "B1027"},
62 {"DM950", "B1028"}};
63
64 if ((type < 1) || (type > 5))
65 return "Unknown type!";
66
67 return nameref[type-1][(drv == &siemens_b102x_driver_info)];
68}
69
4f840ce9 70static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
49c06128 71{
4f840ce9 72 return std_init(sr_ctx, di, LOG_PREFIX);
49c06128
MH
73}
74
c442ffda 75static GSList *scan(struct sr_dev_driver *drv, GSList *options)
bfd48770 76{
f8e76e2e 77 struct sr_dev_inst *sdi;
bfd48770 78 struct drv_context *drvc;
f8e76e2e
MH
79 struct dev_context *devc;
80 struct sr_config *src;
f8e76e2e
MH
81 struct sr_serial_dev_inst *serial;
82 GSList *l, *devices;
83 int len, cnt;
84 const char *conn, *serialcomm;
85 char *buf;
f8e76e2e
MH
86 char req[10];
87 int auxtype;
88
bfd48770 89 devices = NULL;
338143ea 90 drvc = drv->context;
bfd48770 91 drvc->instances = NULL;
f8e76e2e
MH
92 conn = serialcomm = NULL;
93
94 for (l = options; l; l = l->next) {
95 src = l->data;
96 switch (src->key) {
97 case SR_CONF_CONN:
98 conn = g_variant_get_string(src->data, NULL);
99 break;
100 case SR_CONF_SERIALCOMM:
101 serialcomm = g_variant_get_string(src->data, NULL);
102 break;
103 }
104 }
105 if (!conn)
106 return NULL;
107 if (!serialcomm)
108 serialcomm = SERIALCOMM;
109
91219afc 110 serial = sr_serial_dev_inst_new(conn, serialcomm);
f8e76e2e 111
d12ef776 112 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
f8e76e2e
MH
113 return NULL;
114
115 serial_flush(serial);
bfd48770 116
a95f142e 117 buf = g_malloc(BUF_MAX);
f8e76e2e
MH
118
119 snprintf(req, sizeof(req), "%s\r\n",
e790bd5c 120 nmadmm_requests[NMADMM_REQ_IDN].req_str);
a4e435eb 121 g_usleep(150 * 1000); /* Wait a little to allow serial port to settle. */
f8e76e2e 122 for (cnt = 0; cnt < 7; cnt++) {
eead2782 123 if (serial_write_blocking(serial, req, strlen(req), 0) < 0) {
8849f45a 124 sr_err("Unable to send identification request.");
f8e76e2e
MH
125 return NULL;
126 }
127 len = BUF_MAX;
a4e435eb 128 serial_readline(serial, &buf, &len, NMADMM_TIMEOUT_MS);
f8e76e2e
MH
129 if (!len)
130 continue;
e790bd5c 131 buf[BUF_MAX - 1] = '\0';
f8e76e2e 132
e790bd5c
UH
133 /* Match ID string, e.g. "1834 065 V1.06,IF V1.02" (DM950) */
134 if (g_regex_match_simple("^1834 [^,]*,IF V*", (char *)buf, 0, 0)) {
f8e76e2e 135 auxtype = xgittoint(buf[7]);
49c06128 136 sr_spew("%s %s DMM %s detected!", get_brandstr(drv), get_typestr(auxtype, drv), buf + 9);
f8e76e2e 137
aac29cc1 138 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be
UH
139 sdi->status = SR_ST_INACTIVE;
140 sdi->vendor = g_strdup(get_brandstr(drv));
141 sdi->model = g_strdup(get_typestr(auxtype, drv));
142 sdi->version = g_strdup(buf + 9);
f57d8ffe 143 devc = g_malloc0(sizeof(struct dev_context));
f8e76e2e
MH
144 devc->type = auxtype;
145 devc->version = g_strdup(&buf[9]);
146 devc->elapsed_msec = g_timer_new();
f8e76e2e
MH
147 sdi->conn = serial;
148 sdi->priv = devc;
49c06128 149 sdi->driver = drv;
5e23fcab 150 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
f8e76e2e
MH
151 drvc->instances = g_slist_append(drvc->instances, sdi);
152 devices = g_slist_append(devices, sdi);
153 break;
154 }
e790bd5c
UH
155
156 /*
157 * The interface of the DM9x0 contains a cap that needs to
158 * charge for up to 10s before the interface works, if not
159 * powered externally. Therefore wait a little to improve
160 * chances.
161 */
f8e76e2e
MH
162 if (cnt == 3) {
163 sr_info("Waiting 5s to allow interface to settle.");
164 g_usleep(5 * 1000 * 1000);
165 }
166 }
167
168 g_free(buf);
169
170 serial_close(serial);
171 if (!devices)
172 sr_serial_dev_inst_free(serial);
bfd48770
MH
173
174 return devices;
175}
176
4f840ce9 177static GSList *dev_list(const struct sr_dev_driver *di)
49c06128 178{
41812aca 179 return ((struct drv_context *)(di->context))->instances;
bfd48770
MH
180}
181
bfd48770
MH
182static int dev_close(struct sr_dev_inst *sdi)
183{
f8e76e2e 184 struct dev_context *devc;
bfd48770 185
bf2c987f 186 std_serial_dev_close(sdi);
bfd48770 187
e790bd5c 188 /* Free dynamically allocated resources. */
f8e76e2e
MH
189 if ((devc = sdi->priv) && devc->version) {
190 g_free(devc->version);
191 devc->version = NULL;
192 g_timer_destroy(devc->elapsed_msec);
193 }
bfd48770
MH
194
195 return SR_OK;
196}
197
4f840ce9 198static int cleanup(const struct sr_dev_driver *di)
bfd48770 199{
4f840ce9 200 return std_dev_clear(di, NULL);
bfd48770
MH
201}
202
584560f1 203static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 204 const struct sr_channel_group *cg)
bfd48770 205{
f8e76e2e 206 struct dev_context *devc;
bfd48770 207
53b4680f 208 (void)cg;
d3c74a6f 209
bfd48770
MH
210 if (sdi->status != SR_ST_ACTIVE)
211 return SR_ERR_DEV_CLOSED;
212
f8e76e2e
MH
213 if (!(devc = sdi->priv)) {
214 sr_err("sdi->priv was NULL.");
215 return SR_ERR_BUG;
216 }
217
bfd48770 218 switch (key) {
f8e76e2e 219 case SR_CONF_LIMIT_MSEC:
f8e76e2e 220 devc->limit_msec = g_variant_get_uint64(data);
f8e76e2e
MH
221 break;
222 case SR_CONF_LIMIT_SAMPLES:
223 devc->limit_samples = g_variant_get_uint64(data);
f8e76e2e 224 break;
bfd48770 225 default:
f8e76e2e 226 return SR_ERR_NA;
bfd48770
MH
227 }
228
f8e76e2e 229 return SR_OK;
bfd48770
MH
230}
231
584560f1 232static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 233 const struct sr_channel_group *cg)
bfd48770 234{
bfd48770 235 (void)sdi;
53b4680f 236 (void)cg;
bfd48770 237
bfd48770 238 switch (key) {
f8e76e2e 239 case SR_CONF_SCAN_OPTIONS:
584560f1 240 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 241 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
f8e76e2e
MH
242 break;
243 case SR_CONF_DEVICE_OPTIONS:
584560f1 244 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 245 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
f8e76e2e 246 break;
bfd48770
MH
247 default:
248 return SR_ERR_NA;
249 }
250
f8e76e2e 251 return SR_OK;
bfd48770
MH
252}
253
c442ffda 254static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
bfd48770 255{
f8e76e2e
MH
256 struct dev_context *devc;
257 struct sr_serial_dev_inst *serial;
258
f8e76e2e
MH
259 if (!sdi || !cb_data || !(devc = sdi->priv))
260 return SR_ERR_BUG;
261
bfd48770
MH
262 if (sdi->status != SR_ST_ACTIVE)
263 return SR_ERR_DEV_CLOSED;
264
f8e76e2e
MH
265 devc->cb_data = cb_data;
266
267 /* Send header packet to the session bus. */
268 std_session_send_df_header(cb_data, LOG_PREFIX);
269
270 /* Start timer, if required. */
271 if (devc->limit_msec)
272 g_timer_start(devc->elapsed_msec);
273
274 /* Poll every 100ms, or whenever some data comes in. */
275 serial = sdi->conn;
102f1239
BV
276 serial_source_add(sdi->session, serial, G_IO_IN, 100,
277 norma_dmm_receive_data, (void *)sdi);
bfd48770
MH
278
279 return SR_OK;
280}
281
282static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
283{
f8e76e2e 284 struct dev_context *devc;
bfd48770 285
f8e76e2e
MH
286 /* Stop timer, if required. */
287 if (sdi && (devc = sdi->priv) && devc->limit_msec)
288 g_timer_stop(devc->elapsed_msec);
bfd48770 289
d43b0908 290 return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
f8e76e2e 291 sdi->conn, LOG_PREFIX);
bfd48770
MH
292}
293
294SR_PRIV struct sr_dev_driver norma_dmm_driver_info = {
295 .name = "norma-dmm",
49c06128
MH
296 .longname = "Norma DM9x0 DMMs",
297 .api_version = 1,
4f840ce9
ML
298 .init = init,
299 .cleanup = cleanup,
300 .scan = scan,
301 .dev_list = dev_list,
49c06128
MH
302 .dev_clear = NULL,
303 .config_get = NULL,
304 .config_set = config_set,
305 .config_list = config_list,
306 .dev_open = std_serial_dev_open,
307 .dev_close = dev_close,
308 .dev_acquisition_start = dev_acquisition_start,
309 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 310 .context = NULL,
49c06128
MH
311};
312
49c06128
MH
313SR_PRIV struct sr_dev_driver siemens_b102x_driver_info = {
314 .name = "siemens-b102x",
315 .longname = "Siemens B102x DMMs",
bfd48770 316 .api_version = 1,
4f840ce9
ML
317 .init = init,
318 .cleanup = cleanup,
319 .scan = scan,
320 .dev_list = dev_list,
a6630742 321 .dev_clear = NULL,
f8e76e2e 322 .config_get = NULL,
bfd48770
MH
323 .config_set = config_set,
324 .config_list = config_list,
854434de 325 .dev_open = std_serial_dev_open,
bfd48770
MH
326 .dev_close = dev_close,
327 .dev_acquisition_start = dev_acquisition_start,
328 .dev_acquisition_stop = dev_acquisition_stop,
41812aca 329 .context = NULL,
bfd48770 330};