]> sigrok.org Git - libsigrok.git/blame - src/hardware/norma-dmm/api.c
Removal of sdi->index, step 4: fix trivial sr_dev_inst_new() calls
[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
a0e0bb41 27static const uint32_t scanopts[] = {
f8e76e2e
MH
28 SR_CONF_CONN,
29 SR_CONF_SERIALCOMM,
30};
31
f254bc4b 32static const uint32_t devopts[] = {
f8e76e2e 33 SR_CONF_MULTIMETER,
f8e76e2e 34 SR_CONF_CONTINUOUS,
5827f61b
BV
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
36 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
f8e76e2e
MH
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
d12ef776 118 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
f8e76e2e
MH
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 131 for (cnt = 0; cnt < 7; cnt++) {
8849f45a
ML
132 if (serial_write_blocking(serial, req, strlen(req)) < 0) {
133 sr_err("Unable to send identification request.");
f8e76e2e
MH
134 return NULL;
135 }
136 len = BUF_MAX;
a4e435eb 137 serial_readline(serial, &buf, &len, NMADMM_TIMEOUT_MS);
f8e76e2e
MH
138 if (!len)
139 continue;
e790bd5c 140 buf[BUF_MAX - 1] = '\0';
f8e76e2e 141
e790bd5c
UH
142 /* Match ID string, e.g. "1834 065 V1.06,IF V1.02" (DM950) */
143 if (g_regex_match_simple("^1834 [^,]*,IF V*", (char *)buf, 0, 0)) {
f8e76e2e 144 auxtype = xgittoint(buf[7]);
49c06128 145 sr_spew("%s %s DMM %s detected!", get_brandstr(drv), get_typestr(auxtype, drv), buf + 9);
f8e76e2e 146
aed4ad0b 147 if (!(sdi = sr_dev_inst_new(SR_ST_INACTIVE,
49c06128 148 get_brandstr(drv), get_typestr(auxtype, drv), buf + 9)))
f8e76e2e 149 return NULL;
e790bd5c 150 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
f8e76e2e
MH
151 sr_err("Device context malloc failed.");
152 return NULL;
153 }
154 devc->type = auxtype;
155 devc->version = g_strdup(&buf[9]);
156 devc->elapsed_msec = g_timer_new();
157
158 sdi->conn = serial;
159 sdi->priv = devc;
49c06128 160 sdi->driver = drv;
3f239f08 161 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE,
f8e76e2e
MH
162 "P1")))
163 return NULL;
ba7dd8bb 164 sdi->channels = g_slist_append(sdi->channels, ch);
f8e76e2e
MH
165 drvc->instances = g_slist_append(drvc->instances, sdi);
166 devices = g_slist_append(devices, sdi);
167 break;
168 }
e790bd5c
UH
169
170 /*
171 * The interface of the DM9x0 contains a cap that needs to
172 * charge for up to 10s before the interface works, if not
173 * powered externally. Therefore wait a little to improve
174 * chances.
175 */
f8e76e2e
MH
176 if (cnt == 3) {
177 sr_info("Waiting 5s to allow interface to settle.");
178 g_usleep(5 * 1000 * 1000);
179 }
180 }
181
182 g_free(buf);
183
184 serial_close(serial);
185 if (!devices)
186 sr_serial_dev_inst_free(serial);
bfd48770
MH
187
188 return devices;
189}
190
49c06128
MH
191static GSList *scan_norma_dmm(GSList *options)
192{
193 return do_scan(&norma_dmm_driver_info, options);
194}
195
196static GSList *scan_siemens_b102x(GSList *options)
197{
198 return do_scan(&siemens_b102x_driver_info, options);
199}
200
201static GSList *dev_list_norma_dmm(void)
202{
203 return ((struct drv_context *)(norma_dmm_driver_info.priv))->instances;
204}
205
206static GSList *dev_list_siemens_b102x(void)
bfd48770 207{
49c06128 208 return ((struct drv_context *)(siemens_b102x_driver_info.priv))->instances;
bfd48770
MH
209}
210
bfd48770
MH
211static int dev_close(struct sr_dev_inst *sdi)
212{
f8e76e2e 213 struct dev_context *devc;
bfd48770 214
bf2c987f 215 std_serial_dev_close(sdi);
bfd48770 216
e790bd5c 217 /* Free dynamically allocated resources. */
f8e76e2e
MH
218 if ((devc = sdi->priv) && devc->version) {
219 g_free(devc->version);
220 devc->version = NULL;
221 g_timer_destroy(devc->elapsed_msec);
222 }
bfd48770
MH
223
224 return SR_OK;
225}
226
49c06128
MH
227static int cleanup_norma_dmm(void)
228{
229 return std_dev_clear(&norma_dmm_driver_info, NULL);
230}
231
232static int cleanup_siemens_b102x(void)
bfd48770 233{
49c06128 234 return std_dev_clear(&siemens_b102x_driver_info, NULL);
bfd48770
MH
235}
236
584560f1 237static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 238 const struct sr_channel_group *cg)
bfd48770 239{
f8e76e2e 240 struct dev_context *devc;
bfd48770 241
53b4680f 242 (void)cg;
d3c74a6f 243
bfd48770
MH
244 if (sdi->status != SR_ST_ACTIVE)
245 return SR_ERR_DEV_CLOSED;
246
f8e76e2e
MH
247 if (!(devc = sdi->priv)) {
248 sr_err("sdi->priv was NULL.");
249 return SR_ERR_BUG;
250 }
251
bfd48770 252 switch (key) {
f8e76e2e 253 case SR_CONF_LIMIT_MSEC:
f8e76e2e
MH
254 if (g_variant_get_uint64(data) == 0) {
255 sr_err("LIMIT_MSEC can't be 0.");
256 return SR_ERR;
257 }
258 devc->limit_msec = g_variant_get_uint64(data);
259 sr_dbg("Setting time limit to %" PRIu64 "ms.",
260 devc->limit_msec);
261 break;
262 case SR_CONF_LIMIT_SAMPLES:
263 devc->limit_samples = g_variant_get_uint64(data);
264 sr_dbg("Setting sample limit to %" PRIu64 ".",
265 devc->limit_samples);
266 break;
bfd48770 267 default:
f8e76e2e 268 return SR_ERR_NA;
bfd48770
MH
269 }
270
f8e76e2e 271 return SR_OK;
bfd48770
MH
272}
273
584560f1 274static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 275 const struct sr_channel_group *cg)
bfd48770 276{
bfd48770 277 (void)sdi;
53b4680f 278 (void)cg;
bfd48770 279
bfd48770 280 switch (key) {
f8e76e2e 281 case SR_CONF_SCAN_OPTIONS:
584560f1 282 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 283 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
f8e76e2e
MH
284 break;
285 case SR_CONF_DEVICE_OPTIONS:
584560f1 286 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 287 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
f8e76e2e 288 break;
bfd48770
MH
289 default:
290 return SR_ERR_NA;
291 }
292
f8e76e2e 293 return SR_OK;
bfd48770
MH
294}
295
296static int dev_acquisition_start(const struct sr_dev_inst *sdi,
297 void *cb_data)
298{
f8e76e2e
MH
299 struct dev_context *devc;
300 struct sr_serial_dev_inst *serial;
301
f8e76e2e
MH
302 if (!sdi || !cb_data || !(devc = sdi->priv))
303 return SR_ERR_BUG;
304
bfd48770
MH
305 if (sdi->status != SR_ST_ACTIVE)
306 return SR_ERR_DEV_CLOSED;
307
f8e76e2e
MH
308 devc->cb_data = cb_data;
309
310 /* Send header packet to the session bus. */
311 std_session_send_df_header(cb_data, LOG_PREFIX);
312
313 /* Start timer, if required. */
314 if (devc->limit_msec)
315 g_timer_start(devc->elapsed_msec);
316
317 /* Poll every 100ms, or whenever some data comes in. */
318 serial = sdi->conn;
102f1239
BV
319 serial_source_add(sdi->session, serial, G_IO_IN, 100,
320 norma_dmm_receive_data, (void *)sdi);
bfd48770
MH
321
322 return SR_OK;
323}
324
325static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
326{
f8e76e2e 327 struct dev_context *devc;
bfd48770 328
f8e76e2e
MH
329 /* Stop timer, if required. */
330 if (sdi && (devc = sdi->priv) && devc->limit_msec)
331 g_timer_stop(devc->elapsed_msec);
bfd48770 332
d43b0908 333 return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
f8e76e2e 334 sdi->conn, LOG_PREFIX);
bfd48770
MH
335}
336
337SR_PRIV struct sr_dev_driver norma_dmm_driver_info = {
338 .name = "norma-dmm",
49c06128
MH
339 .longname = "Norma DM9x0 DMMs",
340 .api_version = 1,
341 .init = init_norma_dmm,
342 .cleanup = cleanup_norma_dmm,
343 .scan = scan_norma_dmm,
344 .dev_list = dev_list_norma_dmm,
345 .dev_clear = NULL,
346 .config_get = NULL,
347 .config_set = config_set,
348 .config_list = config_list,
349 .dev_open = std_serial_dev_open,
350 .dev_close = dev_close,
351 .dev_acquisition_start = dev_acquisition_start,
352 .dev_acquisition_stop = dev_acquisition_stop,
353 .priv = NULL,
354};
355
356
357SR_PRIV struct sr_dev_driver siemens_b102x_driver_info = {
358 .name = "siemens-b102x",
359 .longname = "Siemens B102x DMMs",
bfd48770 360 .api_version = 1,
49c06128
MH
361 .init = init_siemens_b102x,
362 .cleanup = cleanup_siemens_b102x,
363 .scan = scan_siemens_b102x,
364 .dev_list = dev_list_siemens_b102x,
a6630742 365 .dev_clear = NULL,
f8e76e2e 366 .config_get = NULL,
bfd48770
MH
367 .config_set = config_set,
368 .config_list = config_list,
854434de 369 .dev_open = std_serial_dev_open,
bfd48770
MH
370 .dev_close = dev_close,
371 .dev_acquisition_start = dev_acquisition_start,
372 .dev_acquisition_stop = dev_acquisition_stop,
373 .priv = NULL,
374};