2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
22 #include <sys/types.h>
26 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
27 #include "libsigrok.h"
28 #include "libsigrok-internal.h"
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)
42 * Hardware driver handling in libsigrok.
46 * @defgroup grp_driver Hardware drivers
48 * Hardware driver handling in libsigrok.
53 static struct sr_config_info sr_config_info_data[] = {
54 {SR_CONF_CONN, SR_T_CHAR, "conn",
56 {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
57 "Serial communication", NULL},
58 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
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_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
67 "External clock mode", NULL},
68 {SR_CONF_RLE, SR_T_BOOL, "rle",
69 "Run Length Encoding", NULL},
70 {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
71 "Trigger slope", NULL},
72 {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
73 "Trigger source", NULL},
74 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
75 "Horizontal trigger position", NULL},
76 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
78 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
80 {SR_CONF_FILTER, SR_T_CHAR, "filter",
81 "Filter targets", NULL},
82 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
84 {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
86 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
88 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_CHAR, "spl_weight_freq",
89 "Sound pressure level frequency weighting", NULL},
90 {SR_CONF_SPL_WEIGHT_TIME, SR_T_CHAR, "spl_weight_time",
91 "Sound pressure level time weighting", NULL},
92 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
94 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
96 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
97 "Sound pressure level measurement range", NULL},
98 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
99 "Voltage threshold", NULL },
100 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
102 {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
103 "Data source", NULL},
104 {0, 0, NULL, NULL, NULL},
108 #ifdef HAVE_HW_BRYMEN_DMM
109 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
111 #ifdef HAVE_HW_CEM_DT_885X
112 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
114 #ifdef HAVE_HW_CENTER_3XX
115 extern SR_PRIV struct sr_dev_driver center_309_driver_info;
116 extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
118 #ifdef HAVE_HW_COLEAD_SLM
119 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
122 extern SR_PRIV struct sr_dev_driver demo_driver_info;
124 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
125 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
127 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
128 extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
130 #ifdef HAVE_HW_KECHENG_KC_330B
131 extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
133 #ifdef HAVE_HW_LASCAR_EL_USB
134 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
136 #ifdef HAVE_HW_MIC_985XX
137 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
138 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
141 extern SR_PRIV struct sr_dev_driver ols_driver_info;
143 #ifdef HAVE_HW_RIGOL_DS1XX2
144 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
146 #ifdef HAVE_HW_SALEAE_LOGIC16
147 extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
149 #ifdef HAVE_HW_TONDAJ_SL_814
150 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
152 #ifdef HAVE_HW_UNI_T_UT32X
153 extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
155 #ifdef HAVE_HW_VICTOR_DMM
156 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
158 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
159 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
161 #ifdef HAVE_HW_ASIX_SIGMA
162 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
164 #ifdef HAVE_HW_CHRONOVU_LA8
165 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
167 #ifdef HAVE_HW_LINK_MSO19
168 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
171 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
173 #ifdef HAVE_HW_FX2LAFW
174 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
176 #ifdef HAVE_HW_HANTEK_DSO
177 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
179 #ifdef HAVE_HW_AGILENT_DMM
180 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
182 #ifdef HAVE_HW_FLUKE_DMM
183 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
185 #ifdef HAVE_HW_SERIAL_DMM
186 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
187 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
188 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
189 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
190 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
191 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
192 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
193 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
194 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
195 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
196 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
197 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
198 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
199 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
200 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
201 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
202 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
203 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
204 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
205 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
206 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
208 #ifdef HAVE_HW_UNI_T_DMM
209 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
210 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
211 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
212 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
213 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
214 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
215 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
216 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
220 static struct sr_dev_driver *drivers_list[] = {
221 #ifdef HAVE_HW_BRYMEN_DMM
222 &brymen_bm857_driver_info,
224 #ifdef HAVE_HW_CEM_DT_885X
225 &cem_dt_885x_driver_info,
227 #ifdef HAVE_HW_CENTER_3XX
228 ¢er_309_driver_info,
229 &voltcraft_k204_driver_info,
231 #ifdef HAVE_HW_COLEAD_SLM
232 &colead_slm_driver_info,
237 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
238 &ikalogic_scanalogic2_driver_info,
240 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
241 &ikalogic_scanaplus_driver_info,
243 #ifdef HAVE_HW_KECHENG_KC_330B
244 &kecheng_kc_330b_driver_info,
246 #ifdef HAVE_HW_LASCAR_EL_USB
247 &lascar_el_usb_driver_info,
249 #ifdef HAVE_HW_MIC_985XX
250 &mic_98581_driver_info,
251 &mic_98583_driver_info,
256 #ifdef HAVE_HW_RIGOL_DS1XX2
257 &rigol_ds1xx2_driver_info,
259 #ifdef HAVE_HW_SALEAE_LOGIC16
260 &saleae_logic16_driver_info,
262 #ifdef HAVE_HW_TONDAJ_SL_814
263 &tondaj_sl_814_driver_info,
265 #ifdef HAVE_HW_UNI_T_UT32X
266 &uni_t_ut32x_driver_info,
268 #ifdef HAVE_HW_VICTOR_DMM
269 &victor_dmm_driver_info,
271 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
272 &zeroplus_logic_cube_driver_info,
274 #ifdef HAVE_HW_ASIX_SIGMA
275 &asix_sigma_driver_info,
277 #ifdef HAVE_HW_CHRONOVU_LA8
278 &chronovu_la8_driver_info,
280 #ifdef HAVE_HW_LINK_MSO19
281 &link_mso19_driver_info,
286 #ifdef HAVE_HW_FX2LAFW
287 &fx2lafw_driver_info,
289 #ifdef HAVE_HW_HANTEK_DSO
290 &hantek_dso_driver_info,
292 #ifdef HAVE_HW_AGILENT_DMM
295 #ifdef HAVE_HW_FLUKE_DMM
296 &flukedmm_driver_info,
298 #ifdef HAVE_HW_SERIAL_DMM
299 &digitek_dt4000zc_driver_info,
300 &tekpower_tp4000zc_driver_info,
301 &metex_me31_driver_info,
302 &peaktech_3410_driver_info,
303 &mastech_mas345_driver_info,
304 &va_va18b_driver_info,
305 &metex_m3640d_driver_info,
306 &peaktech_4370_driver_info,
307 &pce_pce_dm32_driver_info,
308 &radioshack_22_168_driver_info,
309 &radioshack_22_805_driver_info,
310 &radioshack_22_812_driver_info,
311 &tecpel_dmm_8061_ser_driver_info,
312 &voltcraft_m3650d_driver_info,
313 &voltcraft_vc820_ser_driver_info,
314 &voltcraft_vc830_ser_driver_info,
315 &voltcraft_vc840_ser_driver_info,
316 &uni_t_ut60a_ser_driver_info,
317 &uni_t_ut60e_ser_driver_info,
318 &uni_t_ut61d_ser_driver_info,
319 &uni_t_ut61e_ser_driver_info,
321 #ifdef HAVE_HW_UNI_T_DMM
322 &tecpel_dmm_8061_driver_info,
323 &uni_t_ut60a_driver_info,
324 &uni_t_ut60e_driver_info,
325 &uni_t_ut61d_driver_info,
326 &uni_t_ut61e_driver_info,
327 &voltcraft_vc820_driver_info,
328 &voltcraft_vc830_driver_info,
329 &voltcraft_vc840_driver_info,
335 * Return the list of supported hardware drivers.
337 * @return Pointer to the NULL-terminated list of hardware driver pointers.
339 SR_API struct sr_dev_driver **sr_driver_list(void)
346 * Initialize a hardware driver.
348 * This usually involves memory allocations and variable initializations
349 * within the driver, but _not_ scanning for attached devices.
350 * The API call sr_driver_scan() is used for that.
352 * @param ctx A libsigrok context object allocated by a previous call to
353 * sr_init(). Must not be NULL.
354 * @param driver The driver to initialize. This must be a pointer to one of
355 * the entries returned by sr_driver_list(). Must not be NULL.
357 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
358 * SR_ERR_BUG upon internal errors, or another negative error code
361 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
366 sr_err("Invalid libsigrok context, can't initialize.");
371 sr_err("Invalid driver, can't initialize.");
375 sr_spew("Initializing driver '%s'.", driver->name);
376 if ((ret = driver->init(ctx)) < 0)
377 sr_err("Failed to initialize the driver: %d.", ret);
383 * Tell a hardware driver to scan for devices.
385 * In addition to the detection, the devices that are found are also
386 * initialized automatically. On some devices, this involves a firmware upload,
387 * or other such measures.
389 * The order in which the system is scanned for devices is not specified. The
390 * caller should not assume or rely on any specific order.
392 * Before calling sr_driver_scan(), the user must have previously initialized
393 * the driver by calling sr_driver_init().
395 * @param driver The driver that should scan. This must be a pointer to one of
396 * the entries returned by sr_driver_list(). Must not be NULL.
397 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
398 * scanner. Can be NULL/empty.
400 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
401 * found (or errors were encountered). This list must be freed by the
402 * caller using g_slist_free(), but without freeing the data pointed
405 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
410 sr_err("Invalid driver, can't scan for devices.");
415 sr_err("Driver not initialized, can't scan for devices.");
419 l = driver->scan(options);
421 sr_spew("Scan of '%s' found %d devices.", driver->name,
428 SR_PRIV void sr_hw_cleanup_all(void)
431 struct sr_dev_driver **drivers;
433 drivers = sr_driver_list();
434 for (i = 0; drivers[i]; i++) {
435 if (drivers[i]->cleanup)
436 drivers[i]->cleanup();
440 /** A floating reference can be passed in for data. */
441 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
443 struct sr_config *src;
445 if (!(src = g_try_malloc(sizeof(struct sr_config))))
448 src->data = g_variant_ref_sink(data);
453 SR_PRIV void sr_config_free(struct sr_config *src)
456 if (!src || !src->data) {
457 sr_err("%s: invalid data!", __func__);
461 g_variant_unref(src->data);
467 * Returns information about the given driver or device instance.
469 * @param driver The sr_dev_driver struct to query.
470 * @param key The configuration key (SR_CONF_*).
471 * @param data Pointer to a GVariant where the value will be stored. Must
472 * not be NULL. The caller is given ownership of the GVariant
473 * and must thus decrease the refcount after use. However if
474 * this function returns an error code, the field should be
475 * considered unused, and should not be unreferenced.
476 * @param sdi (optional) If the key is specific to a device, this must
477 * contain a pointer to the struct sr_dev_inst to be checked.
478 * Otherwise it must be NULL.
480 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
481 * may be returned by the driver indicating it doesn't know that key,
482 * but this is not to be flagged as an error by the caller; merely
483 * as an indication that it's not applicable.
485 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
486 GVariant **data, const struct sr_dev_inst *sdi)
490 if (!driver || !data)
493 if (!driver->config_get)
496 if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
497 /* Got a floating reference from the driver. Sink it here,
498 * caller will need to unref when done with it. */
499 g_variant_ref_sink(*data);
506 * Set a configuration key in a device instance.
508 * @param sdi The device instance.
509 * @param key The configuration key (SR_CONF_*).
510 * @param data The new value for the key, as a GVariant with GVariantType
511 * appropriate to that key. A floating reference can be passed
512 * in; its refcount will be sunk and unreferenced after use.
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.
519 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
523 g_variant_ref_sink(data);
525 if (!sdi || !sdi->driver || !data)
527 else if (!sdi->driver->config_set)
530 ret = sdi->driver->config_set(key, data, sdi);
532 g_variant_unref(data);
538 * List all possible values for a configuration key.
540 * @param driver The sr_dev_driver struct to query.
541 * @param key The configuration key (SR_CONF_*).
542 * @param data A pointer to a GVariant where the list will be stored. The
543 * caller is given ownership of the GVariant and must thus
544 * unref the GVariant after use. However if this function
545 * returns an error code, the field should be considered
546 * unused, and should not be unreferenced.
547 * @param sdi (optional) If the key is specific to a device, this must
548 * contain a pointer to the struct sr_dev_inst to be checked.
550 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
551 * may be returned by the driver indicating it doesn't know that key,
552 * but this is not to be flagged as an error by the caller; merely
553 * as an indication that it's not applicable.
555 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
556 GVariant **data, const struct sr_dev_inst *sdi)
560 if (!driver || !data)
562 else if (!driver->config_list)
564 else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
565 g_variant_ref_sink(*data);
571 * Get information about a configuration key.
573 * @param key The configuration key.
575 * @return A pointer to a struct sr_config_info, or NULL if the key
578 SR_API const struct sr_config_info *sr_config_info_get(int key)
582 for (i = 0; sr_config_info_data[i].key; i++) {
583 if (sr_config_info_data[i].key == key)
584 return &sr_config_info_data[i];
591 * Get information about an configuration key, by name.
593 * @param optname The configuration key.
595 * @return A pointer to a struct sr_config_info, or NULL if the key
598 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
602 for (i = 0; sr_config_info_data[i].key; i++) {
603 if (!strcmp(sr_config_info_data[i].id, optname))
604 return &sr_config_info_data[i];
610 /* Unnecessary level of indirection follows. */
613 SR_PRIV int sr_source_remove(int fd)
615 return sr_session_source_remove(fd);
619 SR_PRIV int sr_source_add(int fd, int events, int timeout,
620 sr_receive_data_callback_t cb, void *cb_data)
622 return sr_session_source_add(fd, events, timeout, cb, cb_data);