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