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