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