]> sigrok.org Git - libsigrok.git/blame - 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
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
21#include <stdlib.h>
22#include <string.h>
23#include "libsigrok.h"
24#include "libsigrok-internal.h"
25#include "protocol.h"
26
388f9d3e
UH
27#define UNI_T_UT_D04_NEW "1a86.e008"
28
584560f1 29static const uint32_t hwopts[] = {
431ec7ca 30 SR_CONF_CONN,
73365eae
UH
31};
32
584560f1 33static const uint32_t hwcaps[] = {
1953564a
BV
34 SR_CONF_MULTIMETER,
35 SR_CONF_LIMIT_SAMPLES,
36 SR_CONF_LIMIT_MSEC,
37 SR_CONF_CONTINUOUS,
79081ec8
UH
38};
39
b6bad47c 40SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
a7a163a7
FK
41SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
42SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
4104ef81 43SR_PRIV struct sr_dev_driver uni_t_ut60g_driver_info;
7cb69b18 44SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info;
5f985df2 45SR_PRIV struct sr_dev_driver uni_t_ut61c_driver_info;
fdbcb86d 46SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
bbef5e32 47SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
fdbcb86d 48SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
c1345749 49SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
695d0e1e 50SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
5e1f7c89 51SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info;
d9e79c51 52SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info;
6ac5f892 53
c8852687 54SR_PRIV struct dmm_info udmms[] = {
b6bad47c
UH
55 {
56 "Tecpel", "DMM-8061", 2400,
26e0361c 57 FS9721_PACKET_SIZE,
b6bad47c
UH
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 },
a7a163a7
FK
62 {
63 "UNI-T", "UT60A", 2400,
26e0361c 64 FS9721_PACKET_SIZE,
a7a163a7
FK
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,
26e0361c 71 FS9721_PACKET_SIZE,
a7a163a7
FK
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 },
4104ef81 76 {
d9e79c51 77 /* The baudrate is actually 19230, see "Note 1" below. */
4104ef81
UH
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 },
5f985df2 84 {
79bc9924 85 "UNI-T", "UT61B", 2400,
5f985df2
UH
86 FS9922_PACKET_SIZE,
87 sr_fs9922_packet_valid, sr_fs9922_parse,
88 NULL,
79bc9924 89 &uni_t_ut61b_driver_info, receive_data_UNI_T_UT61B,
5f985df2 90 },
7cb69b18 91 {
79bc9924 92 "UNI-T", "UT61C", 2400,
7cb69b18
UH
93 FS9922_PACKET_SIZE,
94 sr_fs9922_packet_valid, sr_fs9922_parse,
95 NULL,
79bc9924 96 &uni_t_ut61c_driver_info, receive_data_UNI_T_UT61C,
7cb69b18 97 },
c8852687 98 {
767aae30 99 "UNI-T", "UT61D", 2400,
26e0361c 100 FS9922_PACKET_SIZE,
c8852687
UH
101 sr_fs9922_packet_valid, sr_fs9922_parse,
102 NULL,
103 &uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
104 },
bbef5e32 105 {
d9e79c51 106 /* The baudrate is actually 19230, see "Note 1" below. */
4d7ddff7 107 "UNI-T", "UT61E", 19200,
d97824e5
AJ
108 ES519XX_14B_PACKET_SIZE,
109 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse,
bbef5e32
UH
110 NULL,
111 &uni_t_ut61e_driver_info, receive_data_UNI_T_UT61E,
112 },
c8852687 113 {
bc653a56 114 "Voltcraft", "VC-820", 2400,
26e0361c 115 FS9721_PACKET_SIZE,
c8852687
UH
116 sr_fs9721_packet_valid, sr_fs9721_parse,
117 NULL,
118 &voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
119 },
c1345749 120 {
e52bb9be
UH
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 */
c1345749 126 "Voltcraft", "VC-830", 2400,
26e0361c 127 FS9922_PACKET_SIZE,
c1345749 128 sr_fs9922_packet_valid, sr_fs9922_parse,
e52bb9be 129 &sr_fs9922_z1_diode,
c1345749
UH
130 &voltcraft_vc830_driver_info, receive_data_VOLTCRAFT_VC830,
131 },
695d0e1e
UH
132 {
133 "Voltcraft", "VC-840", 2400,
26e0361c 134 FS9721_PACKET_SIZE,
695d0e1e 135 sr_fs9721_packet_valid, sr_fs9721_parse,
2451a20f 136 sr_fs9721_00_temp_c,
695d0e1e
UH
137 &voltcraft_vc840_driver_info, receive_data_VOLTCRAFT_VC840,
138 },
5e1f7c89
BV
139 {
140 "Tenma", "72-7745", 2400,
141 FS9721_PACKET_SIZE,
142 sr_fs9721_packet_valid, sr_fs9721_parse,
143 sr_fs9721_00_temp_c,
d9e79c51
UH
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,
5e1f7c89 153 },
c8852687 154};
6ac5f892 155
d9e79c51
UH
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
3b412e3a 164static int dev_clear(int dmm)
79081ec8 165{
8dca646e 166 return std_dev_clear(udmms[dmm].di, NULL);
79081ec8
UH
167}
168
6078d2c9 169static int init(struct sr_context *sr_ctx, int dmm)
79081ec8 170{
f6beaac5 171 return std_init(sr_ctx, udmms[dmm].di, LOG_PREFIX);
fdbcb86d
UH
172}
173
6078d2c9 174static GSList *scan(GSList *options, int dmm)
79081ec8 175{
388f9d3e 176 GSList *usb_devices, *devices, *l;
79081ec8 177 struct sr_dev_inst *sdi;
41d9427f 178 struct dev_context *devc;
79081ec8 179 struct drv_context *drvc;
388f9d3e 180 struct sr_usb_dev_inst *usb;
431ec7ca 181 struct sr_config *src;
ba7dd8bb 182 struct sr_channel *ch;
388f9d3e 183 const char *conn;
79081ec8 184
c8852687 185 drvc = udmms[dmm].di->priv;
79081ec8 186
388f9d3e
UH
187 conn = NULL;
188 for (l = options; l; l = l->next) {
431ec7ca
BV
189 src = l->data;
190 switch (src->key) {
191 case SR_CONF_CONN:
7d93a62e 192 conn = g_variant_get_string(src->data, NULL);
388f9d3e
UH
193 break;
194 }
195 }
196 if (!conn)
56e76981 197 return NULL;
41d9427f 198
388f9d3e
UH
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);
79081ec8 202 return NULL;
388f9d3e 203 }
79081ec8 204
388f9d3e
UH
205 for (l = usb_devices; l; l = l->next) {
206 usb = l->data;
41d9427f
UH
207
208 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
209 sr_err("Device context malloc failed.");
210 return NULL;
211 }
212
bc653a56
UH
213 devc->first_run = TRUE;
214
388f9d3e 215 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
c8852687 216 udmms[dmm].vendor, udmms[dmm].device, NULL))) {
41d9427f
UH
217 sr_err("sr_dev_inst_new returned NULL.");
218 return NULL;
219 }
220 sdi->priv = devc;
c8852687 221 sdi->driver = udmms[dmm].di;
3f239f08 222 if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
41d9427f 223 return NULL;
ba7dd8bb 224 sdi->channels = g_slist_append(sdi->channels, ch);
388f9d3e 225
3ece1dff
UH
226 sdi->inst_type = SR_INST_USB;
227 sdi->conn = usb;
388f9d3e
UH
228
229 drvc->instances = g_slist_append(drvc->instances, sdi);
41d9427f 230 devices = g_slist_append(devices, sdi);
79081ec8
UH
231 }
232
233 return devices;
234}
235
6078d2c9 236static GSList *dev_list(int dmm)
79081ec8 237{
bc653a56 238 return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
79081ec8
UH
239}
240
6078d2c9 241static int dev_open(struct sr_dev_inst *sdi, int dmm)
79081ec8 242{
388f9d3e 243 struct drv_context *drvc;
3ece1dff 244 struct sr_usb_dev_inst *usb;
bc653a56 245 int ret;
41d9427f 246
c8852687 247 drvc = udmms[dmm].di->priv;
3ece1dff 248 usb = sdi->conn;
41d9427f 249
3ece1dff 250 if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb)) == SR_OK)
bc653a56 251 sdi->status = SR_ST_ACTIVE;
e73ffd42 252
bc653a56 253 return ret;
79081ec8
UH
254}
255
6078d2c9 256static int dev_close(struct sr_dev_inst *sdi)
79081ec8 257{
79081ec8
UH
258 /* TODO */
259
bc653a56 260 sdi->status = SR_ST_INACTIVE;
e73ffd42 261
79081ec8
UH
262 return SR_OK;
263}
264
6078d2c9 265static int cleanup(int dmm)
79081ec8 266{
3b412e3a 267 return dev_clear(dmm);
79081ec8
UH
268}
269
584560f1 270static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
53b4680f 271 const struct sr_channel_group *cg)
79081ec8
UH
272{
273 struct dev_context *devc;
274
53b4680f 275 (void)cg;
8f996b89 276
79081ec8
UH
277 devc = sdi->priv;
278
584560f1 279 switch (key) {
1953564a 280 case SR_CONF_LIMIT_MSEC:
7d93a62e 281 if (g_variant_get_uint64(data) == 0) {
79081ec8
UH
282 sr_err("Time limit cannot be 0.");
283 return SR_ERR;
284 }
7d93a62e 285 devc->limit_msec = g_variant_get_uint64(data);
79081ec8
UH
286 sr_dbg("Setting time limit to %" PRIu64 "ms.",
287 devc->limit_msec);
288 break;
1953564a 289 case SR_CONF_LIMIT_SAMPLES:
7d93a62e 290 if (g_variant_get_uint64(data) == 0) {
79081ec8
UH
291 sr_err("Sample limit cannot be 0.");
292 return SR_ERR;
293 }
7d93a62e 294 devc->limit_samples = g_variant_get_uint64(data);
79081ec8
UH
295 sr_dbg("Setting sample limit to %" PRIu64 ".",
296 devc->limit_samples);
297 break;
298 default:
bd6fbf62 299 return SR_ERR_NA;
79081ec8
UH
300 }
301
302 return SR_OK;
303}
304
584560f1 305static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
53b4680f 306 const struct sr_channel_group *cg)
a1c743fc 307{
a1c743fc 308 (void)sdi;
53b4680f 309 (void)cg;
a1c743fc
BV
310
311 switch (key) {
0d485e30 312 case SR_CONF_SCAN_OPTIONS:
584560f1
BV
313 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
314 hwopts, ARRAY_SIZE(hwopts), sizeof(uint32_t));
0d485e30 315 break;
9a6517d1 316 case SR_CONF_DEVICE_OPTIONS:
584560f1
BV
317 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
318 hwcaps, ARRAY_SIZE(hwcaps), sizeof(uint32_t));
9a6517d1 319 break;
a1c743fc 320 default:
bd6fbf62 321 return SR_ERR_NA;
a1c743fc
BV
322 }
323
324 return SR_OK;
325}
326
6078d2c9 327static int dev_acquisition_start(const struct sr_dev_inst *sdi,
c8852687 328 void *cb_data, int dmm)
79081ec8 329{
79081ec8
UH
330 struct dev_context *devc;
331
332 devc = sdi->priv;
333
79081ec8
UH
334 devc->cb_data = cb_data;
335
c5ffac41
UH
336 devc->starttime = g_get_monotonic_time();
337
79081ec8 338 /* Send header packet to the session bus. */
102f1239 339 std_session_send_df_header(sdi, LOG_PREFIX);
79081ec8 340
102f1239 341 sr_session_source_add(sdi->session, 0, 0, 10 /* poll_timeout */,
c8852687 342 udmms[dmm].receive_data, (void *)sdi);
79081ec8
UH
343
344 return SR_OK;
345}
346
6078d2c9 347static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
79081ec8
UH
348{
349 struct sr_datafeed_packet packet;
350
102f1239 351 (void)cb_data;
79081ec8
UH
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;
102f1239 358 sr_session_send(sdi, &packet);
79081ec8 359
102f1239 360 sr_session_source_remove(sdi->session, 0);
79081ec8
UH
361
362 return SR_OK;
363}
364
c8852687
UH
365/* Driver-specific API function wrappers */
366#define HW_INIT(X) \
6078d2c9 367static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
c8852687 368#define HW_CLEANUP(X) \
6078d2c9 369static int cleanup_##X(void) { return cleanup(X); }
c8852687 370#define HW_SCAN(X) \
6078d2c9 371static GSList *scan_##X(GSList *options) { return scan(options, X); }
c8852687 372#define HW_DEV_LIST(X) \
6078d2c9 373static GSList *dev_list_##X(void) { return dev_list(X); }
3b412e3a
UH
374#define HW_DEV_CLEAR(X) \
375static int dev_clear_##X(void) { return dev_clear(X); }
c8852687 376#define HW_DEV_ACQUISITION_START(X) \
6078d2c9
UH
377static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
378void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
c8852687 379#define HW_DEV_OPEN(X) \
6078d2c9 380static int dev_open_##X(struct sr_dev_inst *sdi) { return dev_open(sdi, X); }
c8852687
UH
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) \
3b412e3a 388HW_DEV_CLEAR(ID_UPPER) \
c8852687
UH
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, \
6078d2c9
UH
395 .init = init_##ID_UPPER, \
396 .cleanup = cleanup_##ID_UPPER, \
397 .scan = scan_##ID_UPPER, \
398 .dev_list = dev_list_##ID_UPPER, \
3b412e3a 399 .dev_clear = dev_clear_##ID_UPPER, \
c8852687
UH
400 .config_get = NULL, \
401 .config_set = config_set, \
402 .config_list = config_list, \
6078d2c9
UH
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, \
c8852687 407 .priv = NULL, \
fdbcb86d
UH
408};
409
b6bad47c 410DRV(tecpel_dmm_8061, TECPEL_DMM_8061, "tecpel-dmm-8061", "Tecpel DMM-8061")
a7a163a7
FK
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")
4104ef81 413DRV(uni_t_ut60g, UNI_T_UT60G, "uni-t-ut60g", "UNI-T UT60G")
7cb69b18 414DRV(uni_t_ut61b, UNI_T_UT61B, "uni-t-ut61b", "UNI-T UT61B")
5f985df2 415DRV(uni_t_ut61c, UNI_T_UT61C, "uni-t-ut61c", "UNI-T UT61C")
c8852687 416DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
bbef5e32 417DRV(uni_t_ut61e, UNI_T_UT61E, "uni-t-ut61e", "UNI-T UT61E")
c8852687 418DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")
c1345749 419DRV(voltcraft_vc830, VOLTCRAFT_VC830, "voltcraft-vc830", "Voltcraft VC-830")
695d0e1e 420DRV(voltcraft_vc840, VOLTCRAFT_VC840, "voltcraft-vc840", "Voltcraft VC-840")
5e1f7c89 421DRV(tenma_72_7745, TENMA_72_7745, "tenma-72-7745", "Tenma 72-7745")
d9e79c51 422DRV(tenma_72_7750, TENMA_72_7750, "tenma-72-7750", "Tenma 72-7750")