]> sigrok.org Git - libsigrok.git/blame - src/hardware/uni-t-dmm/api.c
Introduce standard cleanup helper
[libsigrok.git] / src / hardware / uni-t-dmm / api.c
CommitLineData
79081ec8 1/*
50985c20 2 * This file is part of the libsigrok project.
79081ec8 3 *
bc653a56 4 * Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
79081ec8
UH
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 2 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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
6ec6c43b 21#include <config.h>
79081ec8
UH
22#include <stdlib.h>
23#include <string.h>
c1aae900 24#include <libsigrok/libsigrok.h>
79081ec8
UH
25#include "libsigrok-internal.h"
26#include "protocol.h"
27
388f9d3e
UH
28#define UNI_T_UT_D04_NEW "1a86.e008"
29
a0e0bb41 30static const uint32_t scanopts[] = {
431ec7ca 31 SR_CONF_CONN,
73365eae
UH
32};
33
f254bc4b 34static const uint32_t devopts[] = {
1953564a 35 SR_CONF_MULTIMETER,
1953564a 36 SR_CONF_CONTINUOUS,
5827f61b
BV
37 SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
38 SR_CONF_LIMIT_MSEC | SR_CONF_SET,
79081ec8
UH
39};
40
d9e79c51
UH
41/*
42 * Note 1: The actual baudrate of the Cyrustek ES519xx chip used in this DMM
43 * is 19230. However, the WCH CH9325 chip (UART to USB/HID) used in (some
44 * versions of) the UNI-T UT-D04 cable doesn't support 19230 baud. It only
45 * supports 19200, and setting an unsupported baudrate will result in the
46 * default of 2400 being used (which will not work with this DMM, of course).
47 */
48
f0540611 49static int dev_clear(const struct sr_dev_driver *di)
79081ec8 50{
f0540611 51 return std_dev_clear(di, NULL);
79081ec8
UH
52}
53
f0540611 54static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
79081ec8 55{
f0540611 56 return std_init(sr_ctx, di, LOG_PREFIX);
fdbcb86d
UH
57}
58
f0540611 59static GSList *scan(struct sr_dev_driver *di, GSList *options)
79081ec8 60{
388f9d3e 61 GSList *usb_devices, *devices, *l;
79081ec8 62 struct sr_dev_inst *sdi;
41d9427f 63 struct dev_context *devc;
79081ec8 64 struct drv_context *drvc;
f0540611 65 struct dmm_info *dmm;
388f9d3e 66 struct sr_usb_dev_inst *usb;
431ec7ca 67 struct sr_config *src;
388f9d3e 68 const char *conn;
79081ec8 69
41812aca 70 drvc = di->context;
f0540611 71 dmm = (struct dmm_info *)di;
79081ec8 72
388f9d3e
UH
73 conn = NULL;
74 for (l = options; l; l = l->next) {
431ec7ca
BV
75 src = l->data;
76 switch (src->key) {
77 case SR_CONF_CONN:
7d93a62e 78 conn = g_variant_get_string(src->data, NULL);
388f9d3e
UH
79 break;
80 }
81 }
82 if (!conn)
56e76981 83 return NULL;
41d9427f 84
388f9d3e
UH
85 devices = NULL;
86 if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
87 g_slist_free_full(usb_devices, g_free);
79081ec8 88 return NULL;
388f9d3e 89 }
79081ec8 90
388f9d3e
UH
91 for (l = usb_devices; l; l = l->next) {
92 usb = l->data;
f57d8ffe 93 devc = g_malloc0(sizeof(struct dev_context));
bc653a56 94 devc->first_run = TRUE;
aac29cc1 95 sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be 96 sdi->status = SR_ST_INACTIVE;
f0540611
ML
97 sdi->vendor = g_strdup(dmm->vendor);
98 sdi->model = g_strdup(dmm->device);
41d9427f 99 sdi->priv = devc;
f0540611 100 sdi->driver = di;
5e23fcab 101 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
3ece1dff
UH
102 sdi->inst_type = SR_INST_USB;
103 sdi->conn = usb;
388f9d3e 104 drvc->instances = g_slist_append(drvc->instances, sdi);
41d9427f 105 devices = g_slist_append(devices, sdi);
79081ec8
UH
106 }
107
108 return devices;
109}
110
f0540611 111static GSList *dev_list(const struct sr_dev_driver *di)
79081ec8 112{
41812aca 113 return ((struct drv_context *)(di->context))->instances;
79081ec8
UH
114}
115
f0540611 116static int dev_open(struct sr_dev_inst *sdi)
79081ec8 117{
f0540611 118 struct sr_dev_driver *di;
388f9d3e 119 struct drv_context *drvc;
3ece1dff 120 struct sr_usb_dev_inst *usb;
bc653a56 121 int ret;
41d9427f 122
f0540611 123 di = sdi->driver;
41812aca 124 drvc = di->context;
3ece1dff 125 usb = sdi->conn;
41d9427f 126
3ece1dff 127 if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
bc653a56 128 sdi->status = SR_ST_ACTIVE;
e73ffd42 129
bc653a56 130 return ret;
79081ec8
UH
131}
132
6078d2c9 133static int dev_close(struct sr_dev_inst *sdi)
79081ec8 134{
79081ec8
UH
135 /* TODO */
136
bc653a56 137 sdi->status = SR_ST_INACTIVE;
e73ffd42 138
79081ec8
UH
139 return SR_OK;
140}
141
584560f1 142static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 143 const struct sr_channel_group *cg)
79081ec8
UH
144{
145 struct dev_context *devc;
146
53b4680f 147 (void)cg;
8f996b89 148
79081ec8
UH
149 devc = sdi->priv;
150
584560f1 151 switch (key) {
1953564a 152 case SR_CONF_LIMIT_MSEC:
7d93a62e 153 devc->limit_msec = g_variant_get_uint64(data);
79081ec8 154 break;
1953564a 155 case SR_CONF_LIMIT_SAMPLES:
7d93a62e 156 devc->limit_samples = g_variant_get_uint64(data);
79081ec8
UH
157 break;
158 default:
bd6fbf62 159 return SR_ERR_NA;
79081ec8
UH
160 }
161
162 return SR_OK;
163}
164
584560f1 165static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 166 const struct sr_channel_group *cg)
a1c743fc 167{
a1c743fc 168 (void)sdi;
53b4680f 169 (void)cg;
a1c743fc
BV
170
171 switch (key) {
0d485e30 172 case SR_CONF_SCAN_OPTIONS:
584560f1 173 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 174 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0d485e30 175 break;
9a6517d1 176 case SR_CONF_DEVICE_OPTIONS:
584560f1 177 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 178 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1 179 break;
a1c743fc 180 default:
bd6fbf62 181 return SR_ERR_NA;
a1c743fc
BV
182 }
183
184 return SR_OK;
185}
186
695dc859 187static int dev_acquisition_start(const struct sr_dev_inst *sdi)
79081ec8 188{
79081ec8
UH
189 struct dev_context *devc;
190
191 devc = sdi->priv;
c5ffac41
UH
192 devc->starttime = g_get_monotonic_time();
193
102f1239 194 std_session_send_df_header(sdi, LOG_PREFIX);
79081ec8 195
c650d3ec 196 sr_session_source_add(sdi->session, -1, 0, 10 /* poll_timeout */,
f0540611 197 uni_t_dmm_receive_data, (void *)sdi);
79081ec8
UH
198
199 return SR_OK;
200}
201
695dc859 202static int dev_acquisition_stop(struct sr_dev_inst *sdi)
79081ec8 203{
79081ec8 204 sr_dbg("Stopping acquisition.");
3be42bc2 205 std_session_send_df_end(sdi, LOG_PREFIX);
dd7a4a71 206 sr_session_source_remove(sdi->session, -1);
79081ec8
UH
207
208 return SR_OK;
209}
210
f0540611
ML
211#define DMM(ID, CHIPSET, VENDOR, MODEL, BAUDRATE, PACKETSIZE, \
212 VALID, PARSE, DETAILS) \
213 &(struct dmm_info) { \
214 { \
215 .name = ID, \
216 .longname = VENDOR " " MODEL, \
217 .api_version = 1, \
218 .init = init, \
700d6b64 219 .cleanup = std_cleanup, \
f0540611
ML
220 .scan = scan, \
221 .dev_list = dev_list, \
222 .dev_clear = dev_clear, \
223 .config_get = NULL, \
224 .config_set = config_set, \
225 .config_list = config_list, \
226 .dev_open = dev_open, \
227 .dev_close = dev_close, \
228 .dev_acquisition_start = dev_acquisition_start, \
229 .dev_acquisition_stop = dev_acquisition_stop, \
41812aca 230 .context = NULL, \
f0540611
ML
231 }, \
232 VENDOR, MODEL, BAUDRATE, PACKETSIZE, \
233 VALID, PARSE, DETAILS, sizeof(struct CHIPSET##_info) \
234 }
fdbcb86d 235
f0540611
ML
236SR_PRIV const struct dmm_info *uni_t_dmm_drivers[] = {
237 DMM(
238 "tecpel-dmm-8061", fs9721,
239 "Tecpel", "DMM-8061", 2400,
240 FS9721_PACKET_SIZE,
241 sr_fs9721_packet_valid, sr_fs9721_parse,
242 sr_fs9721_00_temp_c
243 ),
244 DMM(
245 "uni-t-ut372", ut372,
246 "UNI-T", "UT372", 2400,
247 UT372_PACKET_SIZE,
248 sr_ut372_packet_valid, sr_ut372_parse,
249 NULL
250 ),
251 DMM(
252 "uni-t-ut60a", fs9721,
253 "UNI-T", "UT60A", 2400,
254 FS9721_PACKET_SIZE,
255 sr_fs9721_packet_valid, sr_fs9721_parse,
256 NULL
257 ),
258 DMM(
259 "uni-t-ut60e", fs9721,
260 "UNI-T", "UT60E", 2400,
261 FS9721_PACKET_SIZE,
262 sr_fs9721_packet_valid, sr_fs9721_parse,
263 sr_fs9721_00_temp_c
264 ),
265 DMM(
266 "uni-t-ut60g", es519xx,
267 /* The baudrate is actually 19230, see "Note 1" below. */
268 "UNI-T", "UT60G", 19200,
269 ES519XX_11B_PACKET_SIZE,
270 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
271 NULL
272 ),
273 DMM(
274 "uni-t-ut61b", fs9922,
275 "UNI-T", "UT61B", 2400,
276 FS9922_PACKET_SIZE,
277 sr_fs9922_packet_valid, sr_fs9922_parse,
278 NULL
279 ),
280 DMM(
281 "uni-t-ut61c", fs9922,
282 "UNI-T", "UT61C", 2400,
283 FS9922_PACKET_SIZE,
284 sr_fs9922_packet_valid, sr_fs9922_parse,
285 NULL
286 ),
287 DMM(
288 "uni-t-ut61d", fs9922,
289 "UNI-T", "UT61D", 2400,
290 FS9922_PACKET_SIZE,
291 sr_fs9922_packet_valid, sr_fs9922_parse,
292 NULL
293 ),
294 DMM(
295 "uni-t-ut61e", es519xx,
296 /* The baudrate is actually 19230, see "Note 1" below. */
297 "UNI-T", "UT61E", 19200,
298 ES519XX_14B_PACKET_SIZE,
299 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
300 NULL
301 ),
302 DMM(
303 "uni-t-ut71a", ut71x,
304 "UNI-T", "UT71A", 2400, UT71X_PACKET_SIZE,
305 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
306 ),
307 DMM(
308 "uni-t-ut71b", ut71x,
309 "UNI-T", "UT71B", 2400, UT71X_PACKET_SIZE,
310 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
311 ),
312 DMM(
313 "uni-t-ut71c", ut71x,
314 "UNI-T", "UT71C", 2400, UT71X_PACKET_SIZE,
315 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
316 ),
317 DMM(
318 "uni-t-ut71d", ut71x,
319 "UNI-T", "UT71D", 2400, UT71X_PACKET_SIZE,
320 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
321 ),
322 DMM(
323 "uni-t-ut71e", ut71x,
324 "UNI-T", "UT71E", 2400, UT71X_PACKET_SIZE,
325 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
326 ),
327 DMM(
328 "voltcraft-vc820", fs9721,
329 "Voltcraft", "VC-820", 2400,
330 FS9721_PACKET_SIZE,
331 sr_fs9721_packet_valid, sr_fs9721_parse,
332 NULL
333 ),
334 DMM(
335 "voltcraft-vc830", fs9922,
336 /*
337 * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
338 * the FS9922 protocol. Instead, it only sets the user-defined
339 * bit "z1" to indicate "diode mode" and "voltage".
340 */
341 "Voltcraft", "VC-830", 2400,
342 FS9922_PACKET_SIZE,
343 sr_fs9922_packet_valid, sr_fs9922_parse,
344 &sr_fs9922_z1_diode
345 ),
346 DMM(
347 "voltcraft-vc840", fs9721,
348 "Voltcraft", "VC-840", 2400,
349 FS9721_PACKET_SIZE,
350 sr_fs9721_packet_valid, sr_fs9721_parse,
351 sr_fs9721_00_temp_c
352 ),
353 DMM(
354 "voltcraft-vc870", vc870,
355 "Voltcraft", "VC-870", 9600, VC870_PACKET_SIZE,
356 sr_vc870_packet_valid, sr_vc870_parse, NULL
357 ),
358 DMM(
359 "voltcraft-vc920", ut71x,
360 "Voltcraft", "VC-920", 2400, UT71X_PACKET_SIZE,
361 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
362 ),
363 DMM(
364 "voltcraft-vc940", ut71x,
365 "Voltcraft", "VC-940", 2400, UT71X_PACKET_SIZE,
366 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
367 ),
368 DMM(
369 "voltcraft-vc960", ut71x,
370 "Voltcraft", "VC-960", 2400, UT71X_PACKET_SIZE,
371 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
372 ),
b1cadcfb
KP
373 DMM(
374 "tenma-72-7730", ut71x,
375 "Tenma", "72-7730", 2400,
376 UT71X_PACKET_SIZE,
377 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
378 ),
0a4549ff
UH
379 DMM(
380 "tenma-72-7732", ut71x,
381 "Tenma", "72-7732", 2400,
382 UT71X_PACKET_SIZE,
383 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
384 ),
20f9f1fb
UH
385 DMM(
386 "tenma-72-9380a", ut71x,
387 "Tenma", "72-9380A", 2400,
388 UT71X_PACKET_SIZE,
389 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
390 ),
f0540611
ML
391 DMM(
392 "tenma-72-7745", es519xx,
393 "Tenma", "72-7745", 2400,
394 FS9721_PACKET_SIZE,
395 sr_fs9721_packet_valid, sr_fs9721_parse,
396 sr_fs9721_00_temp_c
397 ),
398 DMM(
399 "tenma-72-7750", es519xx,
400 /* The baudrate is actually 19230, see "Note 1" below. */
401 "Tenma", "72-7750", 19200,
402 ES519XX_11B_PACKET_SIZE,
403 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
404 NULL
405 ),
b65630f7 406 NULL
f0540611 407};