]> sigrok.org Git - libsigrok.git/blame - src/hardware/uni-t-dmm/api.c
Factor out std_session_send_df_end() 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
f0540611 142static int cleanup(const struct sr_dev_driver *di)
79081ec8 143{
f0540611 144 return dev_clear(di);
79081ec8
UH
145}
146
584560f1 147static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 148 const struct sr_channel_group *cg)
79081ec8
UH
149{
150 struct dev_context *devc;
151
53b4680f 152 (void)cg;
8f996b89 153
79081ec8
UH
154 devc = sdi->priv;
155
584560f1 156 switch (key) {
1953564a 157 case SR_CONF_LIMIT_MSEC:
7d93a62e 158 devc->limit_msec = g_variant_get_uint64(data);
79081ec8 159 break;
1953564a 160 case SR_CONF_LIMIT_SAMPLES:
7d93a62e 161 devc->limit_samples = g_variant_get_uint64(data);
79081ec8
UH
162 break;
163 default:
bd6fbf62 164 return SR_ERR_NA;
79081ec8
UH
165 }
166
167 return SR_OK;
168}
169
584560f1 170static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 171 const struct sr_channel_group *cg)
a1c743fc 172{
a1c743fc 173 (void)sdi;
53b4680f 174 (void)cg;
a1c743fc
BV
175
176 switch (key) {
0d485e30 177 case SR_CONF_SCAN_OPTIONS:
584560f1 178 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41 179 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0d485e30 180 break;
9a6517d1 181 case SR_CONF_DEVICE_OPTIONS:
584560f1 182 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b 183 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1 184 break;
a1c743fc 185 default:
bd6fbf62 186 return SR_ERR_NA;
a1c743fc
BV
187 }
188
189 return SR_OK;
190}
191
f0540611 192static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
79081ec8 193{
79081ec8
UH
194 struct dev_context *devc;
195
196 devc = sdi->priv;
197
79081ec8
UH
198 devc->cb_data = cb_data;
199
c5ffac41
UH
200 devc->starttime = g_get_monotonic_time();
201
79081ec8 202 /* Send header packet to the session bus. */
102f1239 203 std_session_send_df_header(sdi, LOG_PREFIX);
79081ec8 204
c650d3ec 205 sr_session_source_add(sdi->session, -1, 0, 10 /* poll_timeout */,
f0540611 206 uni_t_dmm_receive_data, (void *)sdi);
79081ec8
UH
207
208 return SR_OK;
209}
210
6078d2c9 211static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
79081ec8 212{
102f1239 213 (void)cb_data;
79081ec8
UH
214
215 sr_dbg("Stopping acquisition.");
3be42bc2 216 std_session_send_df_end(sdi, LOG_PREFIX);
dd7a4a71 217 sr_session_source_remove(sdi->session, -1);
79081ec8
UH
218
219 return SR_OK;
220}
221
f0540611
ML
222#define DMM(ID, CHIPSET, VENDOR, MODEL, BAUDRATE, PACKETSIZE, \
223 VALID, PARSE, DETAILS) \
224 &(struct dmm_info) { \
225 { \
226 .name = ID, \
227 .longname = VENDOR " " MODEL, \
228 .api_version = 1, \
229 .init = init, \
230 .cleanup = cleanup, \
231 .scan = scan, \
232 .dev_list = dev_list, \
233 .dev_clear = dev_clear, \
234 .config_get = NULL, \
235 .config_set = config_set, \
236 .config_list = config_list, \
237 .dev_open = dev_open, \
238 .dev_close = dev_close, \
239 .dev_acquisition_start = dev_acquisition_start, \
240 .dev_acquisition_stop = dev_acquisition_stop, \
41812aca 241 .context = NULL, \
f0540611
ML
242 }, \
243 VENDOR, MODEL, BAUDRATE, PACKETSIZE, \
244 VALID, PARSE, DETAILS, sizeof(struct CHIPSET##_info) \
245 }
fdbcb86d 246
f0540611
ML
247SR_PRIV const struct dmm_info *uni_t_dmm_drivers[] = {
248 DMM(
249 "tecpel-dmm-8061", fs9721,
250 "Tecpel", "DMM-8061", 2400,
251 FS9721_PACKET_SIZE,
252 sr_fs9721_packet_valid, sr_fs9721_parse,
253 sr_fs9721_00_temp_c
254 ),
255 DMM(
256 "uni-t-ut372", ut372,
257 "UNI-T", "UT372", 2400,
258 UT372_PACKET_SIZE,
259 sr_ut372_packet_valid, sr_ut372_parse,
260 NULL
261 ),
262 DMM(
263 "uni-t-ut60a", fs9721,
264 "UNI-T", "UT60A", 2400,
265 FS9721_PACKET_SIZE,
266 sr_fs9721_packet_valid, sr_fs9721_parse,
267 NULL
268 ),
269 DMM(
270 "uni-t-ut60e", fs9721,
271 "UNI-T", "UT60E", 2400,
272 FS9721_PACKET_SIZE,
273 sr_fs9721_packet_valid, sr_fs9721_parse,
274 sr_fs9721_00_temp_c
275 ),
276 DMM(
277 "uni-t-ut60g", es519xx,
278 /* The baudrate is actually 19230, see "Note 1" below. */
279 "UNI-T", "UT60G", 19200,
280 ES519XX_11B_PACKET_SIZE,
281 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
282 NULL
283 ),
284 DMM(
285 "uni-t-ut61b", fs9922,
286 "UNI-T", "UT61B", 2400,
287 FS9922_PACKET_SIZE,
288 sr_fs9922_packet_valid, sr_fs9922_parse,
289 NULL
290 ),
291 DMM(
292 "uni-t-ut61c", fs9922,
293 "UNI-T", "UT61C", 2400,
294 FS9922_PACKET_SIZE,
295 sr_fs9922_packet_valid, sr_fs9922_parse,
296 NULL
297 ),
298 DMM(
299 "uni-t-ut61d", fs9922,
300 "UNI-T", "UT61D", 2400,
301 FS9922_PACKET_SIZE,
302 sr_fs9922_packet_valid, sr_fs9922_parse,
303 NULL
304 ),
305 DMM(
306 "uni-t-ut61e", es519xx,
307 /* The baudrate is actually 19230, see "Note 1" below. */
308 "UNI-T", "UT61E", 19200,
309 ES519XX_14B_PACKET_SIZE,
310 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
311 NULL
312 ),
313 DMM(
314 "uni-t-ut71a", ut71x,
315 "UNI-T", "UT71A", 2400, UT71X_PACKET_SIZE,
316 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
317 ),
318 DMM(
319 "uni-t-ut71b", ut71x,
320 "UNI-T", "UT71B", 2400, UT71X_PACKET_SIZE,
321 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
322 ),
323 DMM(
324 "uni-t-ut71c", ut71x,
325 "UNI-T", "UT71C", 2400, UT71X_PACKET_SIZE,
326 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
327 ),
328 DMM(
329 "uni-t-ut71d", ut71x,
330 "UNI-T", "UT71D", 2400, UT71X_PACKET_SIZE,
331 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
332 ),
333 DMM(
334 "uni-t-ut71e", ut71x,
335 "UNI-T", "UT71E", 2400, UT71X_PACKET_SIZE,
336 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
337 ),
338 DMM(
339 "voltcraft-vc820", fs9721,
340 "Voltcraft", "VC-820", 2400,
341 FS9721_PACKET_SIZE,
342 sr_fs9721_packet_valid, sr_fs9721_parse,
343 NULL
344 ),
345 DMM(
346 "voltcraft-vc830", fs9922,
347 /*
348 * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
349 * the FS9922 protocol. Instead, it only sets the user-defined
350 * bit "z1" to indicate "diode mode" and "voltage".
351 */
352 "Voltcraft", "VC-830", 2400,
353 FS9922_PACKET_SIZE,
354 sr_fs9922_packet_valid, sr_fs9922_parse,
355 &sr_fs9922_z1_diode
356 ),
357 DMM(
358 "voltcraft-vc840", fs9721,
359 "Voltcraft", "VC-840", 2400,
360 FS9721_PACKET_SIZE,
361 sr_fs9721_packet_valid, sr_fs9721_parse,
362 sr_fs9721_00_temp_c
363 ),
364 DMM(
365 "voltcraft-vc870", vc870,
366 "Voltcraft", "VC-870", 9600, VC870_PACKET_SIZE,
367 sr_vc870_packet_valid, sr_vc870_parse, NULL
368 ),
369 DMM(
370 "voltcraft-vc920", ut71x,
371 "Voltcraft", "VC-920", 2400, UT71X_PACKET_SIZE,
372 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
373 ),
374 DMM(
375 "voltcraft-vc940", ut71x,
376 "Voltcraft", "VC-940", 2400, UT71X_PACKET_SIZE,
377 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
378 ),
379 DMM(
380 "voltcraft-vc960", ut71x,
381 "Voltcraft", "VC-960", 2400, UT71X_PACKET_SIZE,
382 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
383 ),
b1cadcfb
KP
384 DMM(
385 "tenma-72-7730", ut71x,
386 "Tenma", "72-7730", 2400,
387 UT71X_PACKET_SIZE,
388 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
389 ),
0a4549ff
UH
390 DMM(
391 "tenma-72-7732", ut71x,
392 "Tenma", "72-7732", 2400,
393 UT71X_PACKET_SIZE,
394 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
395 ),
20f9f1fb
UH
396 DMM(
397 "tenma-72-9380a", ut71x,
398 "Tenma", "72-9380A", 2400,
399 UT71X_PACKET_SIZE,
400 sr_ut71x_packet_valid, sr_ut71x_parse, NULL
401 ),
f0540611
ML
402 DMM(
403 "tenma-72-7745", es519xx,
404 "Tenma", "72-7745", 2400,
405 FS9721_PACKET_SIZE,
406 sr_fs9721_packet_valid, sr_fs9721_parse,
407 sr_fs9721_00_temp_c
408 ),
409 DMM(
410 "tenma-72-7750", es519xx,
411 /* The baudrate is actually 19230, see "Note 1" below. */
412 "Tenma", "72-7750", 19200,
413 ES519XX_11B_PACKET_SIZE,
414 sr_es519xx_19200_11b_packet_valid, sr_es519xx_19200_11b_parse,
415 NULL
416 ),
b65630f7 417 NULL
f0540611 418};