]> sigrok.org Git - libsigrok.git/blob - hwdriver.c
serial-dmm: Add support for the Voltcraft VC-830.
[libsigrok.git] / hwdriver.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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 3 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, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <stdlib.h>
21 #include <stdio.h>
22 #include <sys/types.h>
23 #include <dirent.h>
24 #include <string.h>
25 #include <glib.h>
26 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
27 #include "libsigrok.h"
28 #include "libsigrok-internal.h"
29
30 /* Message logging helpers with subsystem-specific prefix string. */
31 #define LOG_PREFIX "hwdriver: "
32 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
33 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
34 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
35 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
36 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
37 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
38
39 /**
40  * @file
41  *
42  * Hardware driver handling in libsigrok.
43  */
44
45 /**
46  * @defgroup grp_driver Hardware drivers
47  *
48  * Hardware driver handling in libsigrok.
49  *
50  * @{
51  */
52
53 static struct sr_config_info sr_config_info_data[] = {
54         {SR_CONF_CONN, SR_T_CHAR, "conn",
55                 "Connection", NULL},
56         {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
57                 "Serial communication", NULL},
58         {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
59                 "Sample rate", NULL},
60         {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
61                 "Pre-trigger capture ratio", NULL},
62         {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
63                 "Pattern generator mode", NULL},
64         {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
65                 "Trigger types", NULL},
66         {SR_CONF_RLE, SR_T_BOOL, "rle",
67                 "Run Length Encoding", NULL},
68         {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
69                 "Trigger slope", NULL},
70         {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
71                 "Trigger source", NULL},
72         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
73                 "Horizontal trigger position", NULL},
74         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
75                 "Buffer size", NULL},
76         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
77                 "Time base", NULL},
78         {SR_CONF_FILTER, SR_T_CHAR, "filter",
79                 "Filter targets", NULL},
80         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
81                 "Volts/div", NULL},
82         {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
83                 "Coupling", NULL},
84         {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
85                 "Datalog", NULL},
86         {SR_CONF_SPL_WEIGHT_FREQ, SR_T_CHAR, "spl_weight_freq",
87                 "Sound pressure level frequency weighting", NULL},
88         {SR_CONF_SPL_WEIGHT_TIME, SR_T_CHAR, "spl_weight_time",
89                 "Sound pressure level time weighting", NULL},
90         {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
91                 "Hold max", NULL},
92         {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
93                 "Hold min", NULL},
94         {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
95                 "Sound pressure level measurement range", NULL},
96         {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
97                 "Power off", NULL},
98         {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
99                 "Data source", NULL},
100         {0, 0, NULL, NULL, NULL},
101 };
102
103 /** @cond PRIVATE */
104 #ifdef HAVE_HW_BRYMEN_DMM
105 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
106 #endif
107 #ifdef HAVE_HW_CEM_DT_885X
108 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
109 #endif
110 #ifdef HAVE_HW_COLEAD_SLM
111 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
112 #endif
113 #ifdef HAVE_HW_DEMO
114 extern SR_PRIV struct sr_dev_driver demo_driver_info;
115 #endif
116 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
117 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
118 #endif
119 #ifdef HAVE_HW_LASCAR_EL_USB
120 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
121 #endif
122 #ifdef HAVE_HW_MIC_985XX
123 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
124 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
125 #endif
126 #ifdef HAVE_HW_NEXUS_OSCIPRIME
127 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
128 #endif
129 #ifdef HAVE_HW_OLS
130 extern SR_PRIV struct sr_dev_driver ols_driver_info;
131 #endif
132 #ifdef HAVE_HW_RIGOL_DS1XX2
133 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
134 #endif
135 #ifdef HAVE_HW_TONDAJ_SL_814
136 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
137 #endif
138 #ifdef HAVE_HW_VICTOR_DMM
139 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
140 #endif
141 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
142 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
143 #endif
144 #ifdef HAVE_HW_ASIX_SIGMA
145 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
146 #endif
147 #ifdef HAVE_HW_CHRONOVU_LA8
148 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
149 #endif
150 #ifdef HAVE_HW_LINK_MSO19
151 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
152 #endif
153 #ifdef HAVE_HW_ALSA
154 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
155 #endif
156 #ifdef HAVE_HW_FX2LAFW
157 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
158 #endif
159 #ifdef HAVE_HW_HANTEK_DSO
160 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
161 #endif
162 #ifdef HAVE_HW_AGILENT_DMM
163 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
164 #endif
165 #ifdef HAVE_HW_FLUKE_DMM
166 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
167 #endif
168 #ifdef HAVE_HW_SERIAL_DMM
169 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
170 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
171 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
172 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
173 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
174 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
175 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
176 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
177 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
178 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
179 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
180 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
181 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_ser_driver_info;
182 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
183 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
184 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
185 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
186 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
187 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
188 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
189 #endif
190 #ifdef HAVE_HW_UNI_T_DMM
191 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_driver_info;
192 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
193 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
194 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
195 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
196 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
197 #endif
198 /** @endcond */
199
200 static struct sr_dev_driver *drivers_list[] = {
201 #ifdef HAVE_HW_BRYMEN_DMM
202         &brymen_bm857_driver_info,
203 #endif
204 #ifdef HAVE_HW_CEM_DT_885X
205         &cem_dt_885x_driver_info,
206 #endif
207 #ifdef HAVE_HW_COLEAD_SLM
208         &colead_slm_driver_info,
209 #endif
210 #ifdef HAVE_HW_DEMO
211         &demo_driver_info,
212 #endif
213 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
214         &ikalogic_scanalogic2_driver_info,
215 #endif
216 #ifdef HAVE_HW_LASCAR_EL_USB
217         &lascar_el_usb_driver_info,
218 #endif
219 #ifdef HAVE_HW_MIC_985XX
220         &mic_98581_driver_info,
221         &mic_98583_driver_info,
222 #endif
223 #ifdef HAVE_HW_NEXUS_OSCIPRIME
224         &nexus_osciprime_driver_info,
225 #endif
226 #ifdef HAVE_HW_OLS
227         &ols_driver_info,
228 #endif
229 #ifdef HAVE_HW_RIGOL_DS1XX2
230         &rigol_ds1xx2_driver_info,
231 #endif
232 #ifdef HAVE_HW_TONDAJ_SL_814
233         &tondaj_sl_814_driver_info,
234 #endif
235 #ifdef HAVE_HW_VICTOR_DMM
236         &victor_dmm_driver_info,
237 #endif
238 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
239         &zeroplus_logic_cube_driver_info,
240 #endif
241 #ifdef HAVE_HW_ASIX_SIGMA
242         &asix_sigma_driver_info,
243 #endif
244 #ifdef HAVE_HW_CHRONOVU_LA8
245         &chronovu_la8_driver_info,
246 #endif
247 #ifdef HAVE_HW_LINK_MSO19
248         &link_mso19_driver_info,
249 #endif
250 #ifdef HAVE_HW_ALSA
251         &alsa_driver_info,
252 #endif
253 #ifdef HAVE_HW_FX2LAFW
254         &fx2lafw_driver_info,
255 #endif
256 #ifdef HAVE_HW_HANTEK_DSO
257         &hantek_dso_driver_info,
258 #endif
259 #ifdef HAVE_HW_AGILENT_DMM
260         &agdmm_driver_info,
261 #endif
262 #ifdef HAVE_HW_FLUKE_DMM
263         &flukedmm_driver_info,
264 #endif
265 #ifdef HAVE_HW_SERIAL_DMM
266         &digitek_dt4000zc_driver_info,
267         &tekpower_tp4000zc_driver_info,
268         &metex_me31_driver_info,
269         &peaktech_3410_driver_info,
270         &mastech_mas345_driver_info,
271         &va_va18b_driver_info,
272         &metex_m3640d_driver_info,
273         &peaktech_4370_driver_info,
274         &pce_pce_dm32_driver_info,
275         &radioshack_22_168_driver_info,
276         &radioshack_22_805_driver_info,
277         &radioshack_22_812_driver_info,
278         &tecpel_dmm_8060_ser_driver_info,
279         &tecpel_dmm_8061_ser_driver_info,
280         &voltcraft_m3650d_driver_info,
281         &voltcraft_vc820_ser_driver_info,
282         &voltcraft_vc830_ser_driver_info,
283         &voltcraft_vc840_ser_driver_info,
284         &uni_t_ut61d_ser_driver_info,
285         &uni_t_ut61e_ser_driver_info,
286 #endif
287 #ifdef HAVE_HW_UNI_T_DMM
288         &tecpel_dmm_8060_driver_info,
289         &tecpel_dmm_8061_driver_info,
290         &uni_t_ut61d_driver_info,
291         &uni_t_ut61e_driver_info,
292         &voltcraft_vc820_driver_info,
293         &voltcraft_vc840_driver_info,
294 #endif
295         NULL,
296 };
297
298 /**
299  * Return the list of supported hardware drivers.
300  *
301  * @return Pointer to the NULL-terminated list of hardware driver pointers.
302  */
303 SR_API struct sr_dev_driver **sr_driver_list(void)
304 {
305
306         return drivers_list;
307 }
308
309 /**
310  * Initialize a hardware driver.
311  *
312  * This usually involves memory allocations and variable initializations
313  * within the driver, but _not_ scanning for attached devices.
314  * The API call sr_driver_scan() is used for that.
315  *
316  * @param ctx A libsigrok context object allocated by a previous call to
317  *            sr_init(). Must not be NULL.
318  * @param driver The driver to initialize. This must be a pointer to one of
319  *               the entries returned by sr_driver_list(). Must not be NULL.
320  *
321  * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
322  *         SR_ERR_BUG upon internal errors, or another negative error code
323  *         upon other errors.
324  */
325 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
326 {
327         int ret;
328
329         if (!ctx) {
330                 sr_err("Invalid libsigrok context, can't initialize.");
331                 return SR_ERR_ARG;
332         }
333
334         if (!driver) {
335                 sr_err("Invalid driver, can't initialize.");
336                 return SR_ERR_ARG;
337         }
338
339         sr_spew("Initializing driver '%s'.", driver->name);
340         if ((ret = driver->init(ctx)) < 0)
341                 sr_err("Failed to initialize the driver: %d.", ret);
342
343         return ret;
344 }
345
346 /**
347  * Tell a hardware driver to scan for devices.
348  *
349  * In addition to the detection, the devices that are found are also
350  * initialized automatically. On some devices, this involves a firmware upload,
351  * or other such measures.
352  *
353  * The order in which the system is scanned for devices is not specified. The
354  * caller should not assume or rely on any specific order.
355  *
356  * Before calling sr_driver_scan(), the user must have previously initialized
357  * the driver by calling sr_driver_init().
358  *
359  * @param driver The driver that should scan. This must be a pointer to one of
360  *               the entries returned by sr_driver_list(). Must not be NULL.
361  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
362  *                scanner. Can be NULL/empty.
363  *
364  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
365  *         found (or errors were encountered). This list must be freed by the
366  *         caller using g_slist_free(), but without freeing the data pointed
367  *         to in the list.
368  */
369 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
370 {
371         GSList *l;
372
373         if (!driver) {
374                 sr_err("Invalid driver, can't scan for devices.");
375                 return NULL;
376         }
377
378         if (!driver->priv) {
379                 sr_err("Driver not initialized, can't scan for devices.");
380                 return NULL;
381         }
382
383         l = driver->scan(options);
384
385         sr_spew("Scan of '%s' found %d devices.", driver->name,
386                 g_slist_length(l));
387
388         return l;
389 }
390
391 /** @private */
392 SR_PRIV void sr_hw_cleanup_all(void)
393 {
394         int i;
395         struct sr_dev_driver **drivers;
396
397         drivers = sr_driver_list();
398         for (i = 0; drivers[i]; i++) {
399                 if (drivers[i]->cleanup)
400                         drivers[i]->cleanup();
401         }
402 }
403
404 /** A floating reference can be passed in for data. */
405 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
406 {
407         struct sr_config *src;
408
409         if (!(src = g_try_malloc(sizeof(struct sr_config))))
410                 return NULL;
411         src->key = key;
412         src->data = g_variant_ref_sink(data);
413
414         return src;
415 }
416
417 SR_PRIV void sr_config_free(struct sr_config *src)
418 {
419
420         if (!src || !src->data) {
421                 sr_err("%s: invalid data!", __func__);
422                 return;
423         }
424
425         g_variant_unref(src->data);
426         g_free(src);
427
428 }
429
430 /**
431  * Returns information about the given driver or device instance.
432  *
433  * @param driver The sr_dev_driver struct to query.
434  * @param key The configuration key (SR_CONF_*).
435  * @param data Pointer to a GVariant where the value will be stored. Must
436  *             not be NULL. The caller is given ownership of the GVariant
437  *             and must thus decrease the refcount after use. However if
438  *             this function returns an error code, the field should be
439  *             considered unused, and should not be unreferenced.
440  * @param sdi (optional) If the key is specific to a device, this must
441  *            contain a pointer to the struct sr_dev_inst to be checked.
442  *            Otherwise it must be NULL.
443  *
444  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
445  *         may be returned by the driver indicating it doesn't know that key,
446  *         but this is not to be flagged as an error by the caller; merely
447  *         as an indication that it's not applicable.
448  */
449 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
450                 GVariant **data, const struct sr_dev_inst *sdi)
451 {
452         int ret;
453
454         if (!driver || !data)
455                 return SR_ERR;
456
457         if (!driver->config_get)
458                 return SR_ERR_ARG;
459
460         if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
461                 /* Got a floating reference from the driver. Sink it here,
462                  * caller will need to unref when done with it. */
463                 g_variant_ref_sink(*data);
464         }
465
466         return ret;
467 }
468
469 /**
470  * Set a configuration key in a device instance.
471  *
472  * @param sdi The device instance.
473  * @param key The configuration key (SR_CONF_*).
474  * @param data The new value for the key, as a GVariant with GVariantType
475  *        appropriate to that key. A floating reference can be passed
476  *        in; its refcount will be sunk and unreferenced after use.
477  *
478  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
479  *         may be returned by the driver indicating it doesn't know that key,
480  *         but this is not to be flagged as an error by the caller; merely
481  *         as an indication that it's not applicable.
482  */
483 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
484 {
485         int ret;
486
487         g_variant_ref_sink(data);
488
489         if (!sdi || !sdi->driver || !data)
490                 ret = SR_ERR;
491         else if (!sdi->driver->config_set)
492                 ret = SR_ERR_ARG;
493         else
494                 ret = sdi->driver->config_set(key, data, sdi);
495
496         g_variant_unref(data);
497
498         return ret;
499 }
500
501 /**
502  * List all possible values for a configuration key.
503  *
504  * @param driver The sr_dev_driver struct to query.
505  * @param key The configuration key (SR_CONF_*).
506  * @param data A pointer to a GVariant where the list will be stored. The
507  *             caller is given ownership of the GVariant and must thus
508  *             unref the GVariant after use. However if this function
509  *             returns an error code, the field should be considered
510  *             unused, and should not be unreferenced.
511  * @param sdi (optional) If the key is specific to a device, this must
512  *            contain a pointer to the struct sr_dev_inst to be checked.
513  *
514  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
515  *         may be returned by the driver indicating it doesn't know that key,
516  *         but this is not to be flagged as an error by the caller; merely
517  *         as an indication that it's not applicable.
518  */
519 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
520                 GVariant **data, const struct sr_dev_inst *sdi)
521 {
522         int ret;
523
524         if (!driver || !data)
525                 ret = SR_ERR;
526         else if (!driver->config_list)
527                 ret = SR_ERR_ARG;
528         else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
529                 g_variant_ref_sink(*data);
530
531         return ret;
532 }
533
534 /**
535  * Get information about a configuration key.
536  *
537  * @param key The configuration key.
538  *
539  * @return A pointer to a struct sr_config_info, or NULL if the key
540  *         was not found.
541  */
542 SR_API const struct sr_config_info *sr_config_info_get(int key)
543 {
544         int i;
545
546         for (i = 0; sr_config_info_data[i].key; i++) {
547                 if (sr_config_info_data[i].key == key)
548                         return &sr_config_info_data[i];
549         }
550
551         return NULL;
552 }
553
554 /**
555  * Get information about an configuration key, by name.
556  *
557  * @param optname The configuration key.
558  *
559  * @return A pointer to a struct sr_config_info, or NULL if the key
560  *         was not found.
561  */
562 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
563 {
564         int i;
565
566         for (i = 0; sr_config_info_data[i].key; i++) {
567                 if (!strcmp(sr_config_info_data[i].id, optname))
568                         return &sr_config_info_data[i];
569         }
570
571         return NULL;
572 }
573
574 /* Unnecessary level of indirection follows. */
575
576 /** @private */
577 SR_PRIV int sr_source_remove(int fd)
578 {
579         return sr_session_source_remove(fd);
580 }
581
582 /** @private */
583 SR_PRIV int sr_source_add(int fd, int events, int timeout,
584                           sr_receive_data_callback_t cb, void *cb_data)
585 {
586         return sr_session_source_add(fd, events, timeout, cb, cb_data);
587 }
588
589 /** @} */