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