]> sigrok.org Git - libsigrok.git/blame_incremental - hardware/uni-t-dmm/api.c
zeroplus: Major rework of sample buffer processing
[libsigrok.git] / hardware / uni-t-dmm / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
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
21#include <stdlib.h>
22#include <string.h>
23#include "libsigrok.h"
24#include "libsigrok-internal.h"
25#include "protocol.h"
26
27#define UNI_T_UT_D04_NEW "1a86.e008"
28
29static const int32_t hwopts[] = {
30 SR_CONF_CONN,
31};
32
33static const int32_t hwcaps[] = {
34 SR_CONF_MULTIMETER,
35 SR_CONF_LIMIT_SAMPLES,
36 SR_CONF_LIMIT_MSEC,
37 SR_CONF_CONTINUOUS,
38};
39
40SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
41SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
42SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
43SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
44SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
45SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
46SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
47SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
48SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
49SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
50SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
51
52SR_PRIV struct dmm_info udmms[] = {
53 {
54 "Tecpel", "DMM-8061", 2400,
55 FS9721_PACKET_SIZE,
56 sr_fs9721_packet_valid, sr_fs9721_parse,
57 sr_fs9721_00_temp_c,
58 &tecpel_dmm_8061_driver_info, receive_data_TECPEL_DMM_8061,
59 },
60 {
61 "UNI-T", "UT60A", 2400,
62 FS9721_PACKET_SIZE,
63 sr_fs9721_packet_valid, sr_fs9721_parse,
64 NULL,
65 &uni_t_ut60a_driver_info, receive_data_UNI_T_UT60A,
66 },
67 {
68 "UNI-T", "UT60E", 2400,
69 FS9721_PACKET_SIZE,
70 sr_fs9721_packet_valid, sr_fs9721_parse,
71 sr_fs9721_00_temp_c,
72 &uni_t_ut60e_driver_info, receive_data_UNI_T_UT60E,
73 },
74 {
75 "UNI-T", "UT61B", 2400,
76 FS9922_PACKET_SIZE,
77 sr_fs9922_packet_valid, sr_fs9922_parse,
78 NULL,
79 &uni_t_ut61b_driver_info, receive_data_UNI_T_UT61B,
80 },
81 {
82 "UNI-T", "UT61C", 2400,
83 FS9922_PACKET_SIZE,
84 sr_fs9922_packet_valid, sr_fs9922_parse,
85 NULL,
86 &uni_t_ut61c_driver_info, receive_data_UNI_T_UT61C,
87 },
88 {
89 "UNI-T", "UT61D", 2400,
90 FS9922_PACKET_SIZE,
91 sr_fs9922_packet_valid, sr_fs9922_parse,
92 NULL,
93 &uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
94 },
95 {
96 /*
97 * Important: The actual baudrate of the Cyrustek ES51922 chip
98 * used in this DMM is 19230. However, the WCH CH9325 chip
99 * (UART to USB/HID) used in (some versions of) the UNI-T
100 * UT-D04 cable doesn't support 19230 baud. It only supports
101 * 19200, and setting an unsupported baudrate will result in
102 * the default of 2400 being used (which will not work with
103 * this DMM, of course).
104 */
105 "UNI-T", "UT61E", 19200,
106 ES519XX_14B_PACKET_SIZE,
107 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
108 NULL,
109 &uni_t_ut61e_driver_info, receive_data_UNI_T_UT61E,
110 },
111 {
112 "Voltcraft", "VC-820", 2400,
113 FS9721_PACKET_SIZE,
114 sr_fs9721_packet_valid, sr_fs9721_parse,
115 NULL,
116 &voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
117 },
118 {
119 /*
120 * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
121 * the FS9922 protocol. Instead, it only sets the user-defined
122 * bit "z1" to indicate "diode mode" and "voltage".
123 */
124 "Voltcraft", "VC-830", 2400,
125 FS9922_PACKET_SIZE,
126 sr_fs9922_packet_valid, sr_fs9922_parse,
127 &sr_fs9922_z1_diode,
128 &voltcraft_vc830_driver_info, receive_data_VOLTCRAFT_VC830,
129 },
130 {
131 "Voltcraft", "VC-840", 2400,
132 FS9721_PACKET_SIZE,
133 sr_fs9721_packet_valid, sr_fs9721_parse,
134 sr_fs9721_00_temp_c,
135 &voltcraft_vc840_driver_info, receive_data_VOLTCRAFT_VC840,
136 },
137 {
138 "Tenma", "72-7745", 2400,
139 FS9721_PACKET_SIZE,
140 sr_fs9721_packet_valid, sr_fs9721_parse,
141 sr_fs9721_00_temp_c,
142 &tenma_72_7745_driver_info,
143 /* This is a basic rebadge of the UT60E. */
144 receive_data_UNI_T_UT60E,
145 },
146};
147
148static int dev_clear(int dmm)
149{
150 return std_dev_clear(udmms[dmm].di, NULL);
151}
152
153static int init(struct sr_context *sr_ctx, int dmm)
154{
155 sr_dbg("Selected '%s' subdriver.", udmms[dmm].di->name);
156
157 return std_init(sr_ctx, udmms[dmm].di, LOG_PREFIX);
158}
159
160static GSList *scan(GSList *options, int dmm)
161{
162 GSList *usb_devices, *devices, *l;
163 struct sr_dev_inst *sdi;
164 struct dev_context *devc;
165 struct drv_context *drvc;
166 struct sr_usb_dev_inst *usb;
167 struct sr_config *src;
168 struct sr_probe *probe;
169 const char *conn;
170
171 drvc = udmms[dmm].di->priv;
172
173 conn = NULL;
174 for (l = options; l; l = l->next) {
175 src = l->data;
176 switch (src->key) {
177 case SR_CONF_CONN:
178 conn = g_variant_get_string(src->data, NULL);
179 break;
180 }
181 }
182 if (!conn)
183 return NULL;
184
185 devices = NULL;
186 if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
187 g_slist_free_full(usb_devices, g_free);
188 return NULL;
189 }
190
191 for (l = usb_devices; l; l = l->next) {
192 usb = l->data;
193
194 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
195 sr_err("Device context malloc failed.");
196 return NULL;
197 }
198
199 devc->first_run = TRUE;
200
201 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
202 udmms[dmm].vendor, udmms[dmm].device, NULL))) {
203 sr_err("sr_dev_inst_new returned NULL.");
204 return NULL;
205 }
206 sdi->priv = devc;
207 sdi->driver = udmms[dmm].di;
208 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
209 return NULL;
210 sdi->probes = g_slist_append(sdi->probes, probe);
211
212 sdi->inst_type = SR_INST_USB;
213 sdi->conn = usb;
214
215 drvc->instances = g_slist_append(drvc->instances, sdi);
216 devices = g_slist_append(devices, sdi);
217 }
218
219 return devices;
220}
221
222static GSList *dev_list(int dmm)
223{
224 return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
225}
226
227static int dev_open(struct sr_dev_inst *sdi, int dmm)
228{
229 struct drv_context *drvc;
230 struct sr_usb_dev_inst *usb;
231 int ret;
232
233 drvc = udmms[dmm].di->priv;
234 usb = sdi->conn;
235
236 if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
237 sdi->status = SR_ST_ACTIVE;
238
239 return ret;
240}
241
242static int dev_close(struct sr_dev_inst *sdi)
243{
244 (void)sdi;
245
246 /* TODO */
247
248 sdi->status = SR_ST_INACTIVE;
249
250 return SR_OK;
251}
252
253static int cleanup(int dmm)
254{
255 return dev_clear(dmm);
256}
257
258static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
259 const struct sr_probe_group *probe_group)
260{
261 struct dev_context *devc;
262
263 (void)probe_group;
264
265 devc = sdi->priv;
266
267 switch (id) {
268 case SR_CONF_LIMIT_MSEC:
269 if (g_variant_get_uint64(data) == 0) {
270 sr_err("Time limit cannot be 0.");
271 return SR_ERR;
272 }
273 devc->limit_msec = g_variant_get_uint64(data);
274 sr_dbg("Setting time limit to %" PRIu64 "ms.",
275 devc->limit_msec);
276 break;
277 case SR_CONF_LIMIT_SAMPLES:
278 if (g_variant_get_uint64(data) == 0) {
279 sr_err("Sample limit cannot be 0.");
280 return SR_ERR;
281 }
282 devc->limit_samples = g_variant_get_uint64(data);
283 sr_dbg("Setting sample limit to %" PRIu64 ".",
284 devc->limit_samples);
285 break;
286 default:
287 return SR_ERR_NA;
288 }
289
290 return SR_OK;
291}
292
293static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
294 const struct sr_probe_group *probe_group)
295{
296 (void)sdi;
297 (void)probe_group;
298
299 switch (key) {
300 case SR_CONF_SCAN_OPTIONS:
301 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
302 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
303 break;
304 case SR_CONF_DEVICE_OPTIONS:
305 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
306 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
307 break;
308 default:
309 return SR_ERR_NA;
310 }
311
312 return SR_OK;
313}
314
315static int dev_acquisition_start(const struct sr_dev_inst *sdi,
316 void *cb_data, int dmm)
317{
318 struct dev_context *devc;
319
320 devc = sdi->priv;
321
322 devc->cb_data = cb_data;
323
324 devc->starttime = g_get_monotonic_time();
325
326 /* Send header packet to the session bus. */
327 std_session_send_df_header(cb_data, LOG_PREFIX);
328
329 sr_source_add(0, 0, 10 /* poll_timeout */,
330 udmms[dmm].receive_data, (void *)sdi);
331
332 return SR_OK;
333}
334
335static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
336{
337 struct sr_datafeed_packet packet;
338
339 (void)sdi;
340
341 sr_dbg("Stopping acquisition.");
342
343 /* Send end packet to the session bus. */
344 sr_dbg("Sending SR_DF_END.");
345 packet.type = SR_DF_END;
346 sr_session_send(cb_data, &packet);
347
348 /* TODO? */
349 sr_source_remove(0);
350
351 return SR_OK;
352}
353
354/* Driver-specific API function wrappers */
355#define HW_INIT(X) \
356static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
357#define HW_CLEANUP(X) \
358static int cleanup_##X(void) { return cleanup(X); }
359#define HW_SCAN(X) \
360static GSList *scan_##X(GSList *options) { return scan(options, X); }
361#define HW_DEV_LIST(X) \
362static GSList *dev_list_##X(void) { return dev_list(X); }
363#define HW_DEV_CLEAR(X) \
364static int dev_clear_##X(void) { return dev_clear(X); }
365#define HW_DEV_ACQUISITION_START(X) \
366static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
367void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
368#define HW_DEV_OPEN(X) \
369static int dev_open_##X(struct sr_dev_inst *sdi) { return dev_open(sdi, X); }
370
371/* Driver structs and API function wrappers */
372#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
373HW_INIT(ID_UPPER) \
374HW_CLEANUP(ID_UPPER) \
375HW_SCAN(ID_UPPER) \
376HW_DEV_LIST(ID_UPPER) \
377HW_DEV_CLEAR(ID_UPPER) \
378HW_DEV_ACQUISITION_START(ID_UPPER) \
379HW_DEV_OPEN(ID_UPPER) \
380SR_PRIV struct sr_dev_driver ID##_driver_info = { \
381 .name = NAME, \
382 .longname = LONGNAME, \
383 .api_version = 1, \
384 .init = init_##ID_UPPER, \
385 .cleanup = cleanup_##ID_UPPER, \
386 .scan = scan_##ID_UPPER, \
387 .dev_list = dev_list_##ID_UPPER, \
388 .dev_clear = dev_clear_##ID_UPPER, \
389 .config_get = NULL, \
390 .config_set = config_set, \
391 .config_list = config_list, \
392 .dev_open = dev_open_##ID_UPPER, \
393 .dev_close = dev_close, \
394 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
395 .dev_acquisition_stop = dev_acquisition_stop, \
396 .priv = NULL, \
397};
398
399DRV(tecpel_dmm_8061, TECPEL_DMM_8061, "tecpel-dmm-8061", "Tecpel DMM-8061")
400DRV(uni_t_ut60a, UNI_T_UT60A, "uni-t-ut60a", "UNI-T UT60A")
401DRV(uni_t_ut60e, UNI_T_UT60E, "uni-t-ut60e", "UNI-T UT60E")
402DRV(uni_t_ut61b, UNI_T_UT61B, "uni-t-ut61b", "UNI-T UT61B")
403DRV(uni_t_ut61c, UNI_T_UT61C, "uni-t-ut61c", "UNI-T UT61C")
404DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
405DRV(uni_t_ut61e, UNI_T_UT61E, "uni-t-ut61e", "UNI-T UT61E")
406DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")
407DRV(voltcraft_vc830, VOLTCRAFT_VC830, "voltcraft-vc830", "Voltcraft VC-830")
408DRV(voltcraft_vc840, VOLTCRAFT_VC840, "voltcraft-vc840", "Voltcraft VC-840")
409DRV(tenma_72_7745, TENMA_72_7745, "tenma-72-7745", "Tenma 72-7745")