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_SWAP, SR_T_BOOL, "swap",
69 "Swap channel order", NULL},
70 {SR_CONF_RLE, SR_T_BOOL, "rle",
71 "Run Length Encoding", NULL},
72 {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
73 "Trigger slope", NULL},
74 {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
75 "Trigger source", NULL},
76 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
77 "Horizontal trigger position", NULL},
78 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
80 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
82 {SR_CONF_FILTER, SR_T_CHAR, "filter",
83 "Filter targets", NULL},
84 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
86 {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
88 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
90 {SR_CONF_SPL_WEIGHT_FREQ, SR_T_CHAR, "spl_weight_freq",
91 "Sound pressure level frequency weighting", NULL},
92 {SR_CONF_SPL_WEIGHT_TIME, SR_T_CHAR, "spl_weight_time",
93 "Sound pressure level time weighting", NULL},
94 {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
96 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
98 {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
99 "Sound pressure level measurement range", NULL},
100 {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
101 "Voltage threshold", NULL },
102 {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
104 {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
105 "Data source", NULL},
106 {0, 0, NULL, NULL, NULL},
110 #ifdef HAVE_HW_BRYMEN_DMM
111 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
113 #ifdef HAVE_HW_CEM_DT_885X
114 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
116 #ifdef HAVE_HW_CENTER_3XX
117 extern SR_PRIV struct sr_dev_driver center_309_driver_info;
118 extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
120 #ifdef HAVE_HW_COLEAD_SLM
121 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
124 extern SR_PRIV struct sr_dev_driver demo_driver_info;
126 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
127 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
129 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
130 extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
132 #ifdef HAVE_HW_KECHENG_KC_330B
133 extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
135 #ifdef HAVE_HW_LASCAR_EL_USB
136 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
138 #ifdef HAVE_HW_MIC_985XX
139 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
140 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
142 #ifdef HAVE_HW_NORMA_DMM
143 extern SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
146 extern SR_PRIV struct sr_dev_driver ols_driver_info;
148 #ifdef HAVE_HW_RIGOL_DS1XX2
149 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
151 #ifdef HAVE_HW_SALEAE_LOGIC16
152 extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
154 #ifdef HAVE_HW_TELEINFO
155 extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
157 #ifdef HAVE_HW_TONDAJ_SL_814
158 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
160 #ifdef HAVE_HW_UNI_T_UT32X
161 extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
163 #ifdef HAVE_HW_VICTOR_DMM
164 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
166 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
167 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
169 #ifdef HAVE_HW_ASIX_SIGMA
170 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
172 #ifdef HAVE_HW_CHRONOVU_LA8
173 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
175 #ifdef HAVE_HW_LINK_MSO19
176 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
179 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
181 #ifdef HAVE_HW_FX2LAFW
182 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
184 #ifdef HAVE_HW_HANTEK_DSO
185 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
187 #ifdef HAVE_HW_AGILENT_DMM
188 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
190 #ifdef HAVE_HW_FLUKE_DMM
191 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
193 #ifdef HAVE_HW_SERIAL_DMM
194 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
195 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
196 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
197 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
198 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
199 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
200 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
201 extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
202 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
203 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
204 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
205 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
206 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
207 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
208 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
209 extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
210 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
211 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
212 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
213 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
214 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
215 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
216 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
217 extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
219 #ifdef HAVE_HW_UNI_T_DMM
220 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
221 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
222 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
223 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
224 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
225 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
226 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
227 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
231 static struct sr_dev_driver *drivers_list[] = {
232 #ifdef HAVE_HW_BRYMEN_DMM
233 &brymen_bm857_driver_info,
235 #ifdef HAVE_HW_CEM_DT_885X
236 &cem_dt_885x_driver_info,
238 #ifdef HAVE_HW_CENTER_3XX
239 ¢er_309_driver_info,
240 &voltcraft_k204_driver_info,
242 #ifdef HAVE_HW_COLEAD_SLM
243 &colead_slm_driver_info,
248 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
249 &ikalogic_scanalogic2_driver_info,
251 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
252 &ikalogic_scanaplus_driver_info,
254 #ifdef HAVE_HW_KECHENG_KC_330B
255 &kecheng_kc_330b_driver_info,
257 #ifdef HAVE_HW_LASCAR_EL_USB
258 &lascar_el_usb_driver_info,
260 #ifdef HAVE_HW_MIC_985XX
261 &mic_98581_driver_info,
262 &mic_98583_driver_info,
264 #ifdef HAVE_HW_NORMA_DMM
265 &norma_dmm_driver_info,
270 #ifdef HAVE_HW_RIGOL_DS1XX2
271 &rigol_ds1xx2_driver_info,
273 #ifdef HAVE_HW_SALEAE_LOGIC16
274 &saleae_logic16_driver_info,
276 #ifdef HAVE_HW_TELEINFO
277 &teleinfo_driver_info,
279 #ifdef HAVE_HW_TONDAJ_SL_814
280 &tondaj_sl_814_driver_info,
282 #ifdef HAVE_HW_UNI_T_UT32X
283 &uni_t_ut32x_driver_info,
285 #ifdef HAVE_HW_VICTOR_DMM
286 &victor_dmm_driver_info,
288 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
289 &zeroplus_logic_cube_driver_info,
291 #ifdef HAVE_HW_ASIX_SIGMA
292 &asix_sigma_driver_info,
294 #ifdef HAVE_HW_CHRONOVU_LA8
295 &chronovu_la8_driver_info,
297 #ifdef HAVE_HW_LINK_MSO19
298 &link_mso19_driver_info,
303 #ifdef HAVE_HW_FX2LAFW
304 &fx2lafw_driver_info,
306 #ifdef HAVE_HW_HANTEK_DSO
307 &hantek_dso_driver_info,
309 #ifdef HAVE_HW_AGILENT_DMM
312 #ifdef HAVE_HW_FLUKE_DMM
313 &flukedmm_driver_info,
315 #ifdef HAVE_HW_SERIAL_DMM
316 &digitek_dt4000zc_driver_info,
317 &tekpower_tp4000zc_driver_info,
318 &metex_me31_driver_info,
319 &peaktech_3410_driver_info,
320 &mastech_mas345_driver_info,
321 &va_va18b_driver_info,
322 &metex_m3640d_driver_info,
323 &metex_m4650cr_driver_info,
324 &peaktech_4370_driver_info,
325 &pce_pce_dm32_driver_info,
326 &radioshack_22_168_driver_info,
327 &radioshack_22_805_driver_info,
328 &radioshack_22_812_driver_info,
329 &tecpel_dmm_8061_ser_driver_info,
330 &voltcraft_m3650d_driver_info,
331 &voltcraft_m4650cr_driver_info,
332 &voltcraft_vc820_ser_driver_info,
333 &voltcraft_vc830_ser_driver_info,
334 &voltcraft_vc840_ser_driver_info,
335 &uni_t_ut60a_ser_driver_info,
336 &uni_t_ut60e_ser_driver_info,
337 &uni_t_ut61d_ser_driver_info,
338 &uni_t_ut61e_ser_driver_info,
339 &iso_tech_idm103n_driver_info,
341 #ifdef HAVE_HW_UNI_T_DMM
342 &tecpel_dmm_8061_driver_info,
343 &uni_t_ut60a_driver_info,
344 &uni_t_ut60e_driver_info,
345 &uni_t_ut61d_driver_info,
346 &uni_t_ut61e_driver_info,
347 &voltcraft_vc820_driver_info,
348 &voltcraft_vc830_driver_info,
349 &voltcraft_vc840_driver_info,
355 * Return the list of supported hardware drivers.
357 * @return Pointer to the NULL-terminated list of hardware driver pointers.
359 SR_API struct sr_dev_driver **sr_driver_list(void)
366 * Initialize a hardware driver.
368 * This usually involves memory allocations and variable initializations
369 * within the driver, but _not_ scanning for attached devices.
370 * The API call sr_driver_scan() is used for that.
372 * @param ctx A libsigrok context object allocated by a previous call to
373 * sr_init(). Must not be NULL.
374 * @param driver The driver to initialize. This must be a pointer to one of
375 * the entries returned by sr_driver_list(). Must not be NULL.
377 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
378 * SR_ERR_BUG upon internal errors, or another negative error code
381 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
386 sr_err("Invalid libsigrok context, can't initialize.");
391 sr_err("Invalid driver, can't initialize.");
395 sr_spew("Initializing driver '%s'.", driver->name);
396 if ((ret = driver->init(ctx)) < 0)
397 sr_err("Failed to initialize the driver: %d.", ret);
403 * Tell a hardware driver to scan for devices.
405 * In addition to the detection, the devices that are found are also
406 * initialized automatically. On some devices, this involves a firmware upload,
407 * or other such measures.
409 * The order in which the system is scanned for devices is not specified. The
410 * caller should not assume or rely on any specific order.
412 * Before calling sr_driver_scan(), the user must have previously initialized
413 * the driver by calling sr_driver_init().
415 * @param driver The driver that should scan. This must be a pointer to one of
416 * the entries returned by sr_driver_list(). Must not be NULL.
417 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
418 * scanner. Can be NULL/empty.
420 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
421 * found (or errors were encountered). This list must be freed by the
422 * caller using g_slist_free(), but without freeing the data pointed
425 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
430 sr_err("Invalid driver, can't scan for devices.");
435 sr_err("Driver not initialized, can't scan for devices.");
439 l = driver->scan(options);
441 sr_spew("Scan of '%s' found %d devices.", driver->name,
448 SR_PRIV void sr_hw_cleanup_all(void)
451 struct sr_dev_driver **drivers;
453 drivers = sr_driver_list();
454 for (i = 0; drivers[i]; i++) {
455 if (drivers[i]->cleanup)
456 drivers[i]->cleanup();
460 /** A floating reference can be passed in for data.
462 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
464 struct sr_config *src;
466 if (!(src = g_try_malloc(sizeof(struct sr_config))))
469 src->data = g_variant_ref_sink(data);
475 SR_PRIV void sr_config_free(struct sr_config *src)
478 if (!src || !src->data) {
479 sr_err("%s: invalid data!", __func__);
483 g_variant_unref(src->data);
489 * Returns information about the given driver or device instance.
491 * @param driver The sr_dev_driver struct to query.
492 * @param sdi (optional) If the key is specific to a device, this must
493 * contain a pointer to the struct sr_dev_inst to be checked.
494 * Otherwise it must be NULL.
495 * @param probe_group The probe group on the device for which to list the
497 * @param key The configuration key (SR_CONF_*).
498 * @param data Pointer to a GVariant where the value will be stored. Must
499 * not be NULL. The caller is given ownership of the GVariant
500 * and must thus decrease the refcount after use. However if
501 * this function returns an error code, the field should be
502 * considered unused, and should not be unreferenced.
504 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
505 * may be returned by the driver indicating it doesn't know that key,
506 * but this is not to be flagged as an error by the caller; merely
507 * as an indication that it's not applicable.
509 SR_API int sr_config_get(const struct sr_dev_driver *driver,
510 const struct sr_dev_inst *sdi,
511 const struct sr_probe_group *probe_group,
512 int key, GVariant **data)
516 if (!driver || !data)
519 if (!driver->config_get)
522 if ((ret = driver->config_get(key, data, sdi, probe_group)) == SR_OK) {
523 /* Got a floating reference from the driver. Sink it here,
524 * caller will need to unref when done with it. */
525 g_variant_ref_sink(*data);
532 * Set a configuration key in a device instance.
534 * @param sdi The device instance.
535 * @param probe_group The probe group on the device for which to list the
537 * @param key The configuration key (SR_CONF_*).
538 * @param data The new value for the key, as a GVariant with GVariantType
539 * appropriate to that key. A floating reference can be passed
540 * in; its refcount will be sunk and unreferenced after use.
542 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
543 * may be returned by the driver indicating it doesn't know that key,
544 * but this is not to be flagged as an error by the caller; merely
545 * as an indication that it's not applicable.
547 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
548 const struct sr_probe_group *probe_group,
549 int key, GVariant *data)
553 g_variant_ref_sink(data);
555 if (!sdi || !sdi->driver || !data)
557 else if (!sdi->driver->config_set)
560 ret = sdi->driver->config_set(key, data, sdi, probe_group);
562 g_variant_unref(data);
568 * List all possible values for a configuration key.
570 * @param driver The sr_dev_driver struct to query.
571 * @param sdi (optional) If the key is specific to a device, this must
572 * contain a pointer to the struct sr_dev_inst to be checked.
573 * @param probe_group The probe group on the device for which to list the
575 * @param key The configuration key (SR_CONF_*).
576 * @param data A pointer to a GVariant where the list will be stored. The
577 * caller is given ownership of the GVariant and must thus
578 * unref the GVariant after use. However if this function
579 * returns an error code, the field should be considered
580 * unused, and should not be unreferenced.
582 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
583 * may be returned by the driver indicating it doesn't know that key,
584 * but this is not to be flagged as an error by the caller; merely
585 * as an indication that it's not applicable.
587 SR_API int sr_config_list(const struct sr_dev_driver *driver,
588 const struct sr_dev_inst *sdi,
589 const struct sr_probe_group *probe_group,
590 int key, GVariant **data)
594 if (!driver || !data)
596 else if (!driver->config_list)
598 else if ((ret = driver->config_list(key, data, sdi, probe_group)) == SR_OK)
599 g_variant_ref_sink(*data);
605 * Get information about a configuration key.
607 * @param key The configuration key.
609 * @return A pointer to a struct sr_config_info, or NULL if the key
612 SR_API const struct sr_config_info *sr_config_info_get(int key)
616 for (i = 0; sr_config_info_data[i].key; i++) {
617 if (sr_config_info_data[i].key == key)
618 return &sr_config_info_data[i];
625 * Get information about an configuration key, by name.
627 * @param optname The configuration key.
629 * @return A pointer to a struct sr_config_info, or NULL if the key
632 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
636 for (i = 0; sr_config_info_data[i].key; i++) {
637 if (!strcmp(sr_config_info_data[i].id, optname))
638 return &sr_config_info_data[i];
644 /* Unnecessary level of indirection follows. */
647 SR_PRIV int sr_source_remove(int fd)
649 return sr_session_source_remove(fd);
653 SR_PRIV int sr_source_add(int fd, int events, int timeout,
654 sr_receive_data_callback_t cb, void *cb_data)
656 return sr_session_source_add(fd, events, timeout, cb, cb_data);