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_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",
76 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
78 {SR_CONF_FILTER, SR_T_CHAR, "filter",
79 "Filter targets", NULL},
80 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
82 {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
84 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
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",
92 {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
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",
98 {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
100 {0, 0, NULL, NULL, NULL},
104 #ifdef HAVE_HW_BRYMEN_DMM
105 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
107 #ifdef HAVE_HW_CEM_DT_885X
108 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
110 #ifdef HAVE_HW_COLEAD_SLM
111 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
114 extern SR_PRIV struct sr_dev_driver demo_driver_info;
116 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
117 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
119 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
120 extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
122 #ifdef HAVE_HW_KECHENG_KC_330B
123 extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
125 #ifdef HAVE_HW_LASCAR_EL_USB
126 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
128 #ifdef HAVE_HW_MIC_985XX
129 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
130 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
132 #ifdef HAVE_HW_NEXUS_OSCIPRIME
133 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
136 extern SR_PRIV struct sr_dev_driver ols_driver_info;
138 #ifdef HAVE_HW_RIGOL_DS1XX2
139 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
141 #ifdef HAVE_HW_TONDAJ_SL_814
142 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
144 #ifdef HAVE_HW_VICTOR_DMM
145 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
147 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
148 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
150 #ifdef HAVE_HW_ASIX_SIGMA
151 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
153 #ifdef HAVE_HW_CHRONOVU_LA8
154 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
156 #ifdef HAVE_HW_LINK_MSO19
157 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
160 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
162 #ifdef HAVE_HW_FX2LAFW
163 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
165 #ifdef HAVE_HW_HANTEK_DSO
166 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
168 #ifdef HAVE_HW_AGILENT_DMM
169 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
171 #ifdef HAVE_HW_FLUKE_DMM
172 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
174 #ifdef HAVE_HW_SERIAL_DMM
175 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
176 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
177 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
178 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
179 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
180 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
181 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
182 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
183 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
184 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
185 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
186 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
187 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_ser_driver_info;
188 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
189 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
190 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
191 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
192 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
193 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
194 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
195 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
196 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
198 #ifdef HAVE_HW_UNI_T_DMM
199 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_driver_info;
200 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
201 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
202 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
203 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
204 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
205 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
206 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
207 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
211 static struct sr_dev_driver *drivers_list[] = {
212 #ifdef HAVE_HW_BRYMEN_DMM
213 &brymen_bm857_driver_info,
215 #ifdef HAVE_HW_CEM_DT_885X
216 &cem_dt_885x_driver_info,
218 #ifdef HAVE_HW_COLEAD_SLM
219 &colead_slm_driver_info,
224 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
225 &ikalogic_scanalogic2_driver_info,
227 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
228 &ikalogic_scanaplus_driver_info,
230 #ifdef HAVE_HW_KECHENG_KC_330B
231 &kecheng_kc_330b_driver_info,
233 #ifdef HAVE_HW_LASCAR_EL_USB
234 &lascar_el_usb_driver_info,
236 #ifdef HAVE_HW_MIC_985XX
237 &mic_98581_driver_info,
238 &mic_98583_driver_info,
240 #ifdef HAVE_HW_NEXUS_OSCIPRIME
241 &nexus_osciprime_driver_info,
246 #ifdef HAVE_HW_RIGOL_DS1XX2
247 &rigol_ds1xx2_driver_info,
249 #ifdef HAVE_HW_TONDAJ_SL_814
250 &tondaj_sl_814_driver_info,
252 #ifdef HAVE_HW_VICTOR_DMM
253 &victor_dmm_driver_info,
255 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
256 &zeroplus_logic_cube_driver_info,
258 #ifdef HAVE_HW_ASIX_SIGMA
259 &asix_sigma_driver_info,
261 #ifdef HAVE_HW_CHRONOVU_LA8
262 &chronovu_la8_driver_info,
264 #ifdef HAVE_HW_LINK_MSO19
265 &link_mso19_driver_info,
270 #ifdef HAVE_HW_FX2LAFW
271 &fx2lafw_driver_info,
273 #ifdef HAVE_HW_HANTEK_DSO
274 &hantek_dso_driver_info,
276 #ifdef HAVE_HW_AGILENT_DMM
279 #ifdef HAVE_HW_FLUKE_DMM
280 &flukedmm_driver_info,
282 #ifdef HAVE_HW_SERIAL_DMM
283 &digitek_dt4000zc_driver_info,
284 &tekpower_tp4000zc_driver_info,
285 &metex_me31_driver_info,
286 &peaktech_3410_driver_info,
287 &mastech_mas345_driver_info,
288 &va_va18b_driver_info,
289 &metex_m3640d_driver_info,
290 &peaktech_4370_driver_info,
291 &pce_pce_dm32_driver_info,
292 &radioshack_22_168_driver_info,
293 &radioshack_22_805_driver_info,
294 &radioshack_22_812_driver_info,
295 &tecpel_dmm_8060_ser_driver_info,
296 &tecpel_dmm_8061_ser_driver_info,
297 &voltcraft_m3650d_driver_info,
298 &voltcraft_vc820_ser_driver_info,
299 &voltcraft_vc830_ser_driver_info,
300 &voltcraft_vc840_ser_driver_info,
301 &uni_t_ut60a_ser_driver_info,
302 &uni_t_ut60e_ser_driver_info,
303 &uni_t_ut61d_ser_driver_info,
304 &uni_t_ut61e_ser_driver_info,
306 #ifdef HAVE_HW_UNI_T_DMM
307 &tecpel_dmm_8060_driver_info,
308 &tecpel_dmm_8061_driver_info,
309 &uni_t_ut60a_driver_info,
310 &uni_t_ut60e_driver_info,
311 &uni_t_ut61d_driver_info,
312 &uni_t_ut61e_driver_info,
313 &voltcraft_vc820_driver_info,
314 &voltcraft_vc830_driver_info,
315 &voltcraft_vc840_driver_info,
321 * Return the list of supported hardware drivers.
323 * @return Pointer to the NULL-terminated list of hardware driver pointers.
325 SR_API struct sr_dev_driver **sr_driver_list(void)
332 * Initialize a hardware driver.
334 * This usually involves memory allocations and variable initializations
335 * within the driver, but _not_ scanning for attached devices.
336 * The API call sr_driver_scan() is used for that.
338 * @param ctx A libsigrok context object allocated by a previous call to
339 * sr_init(). Must not be NULL.
340 * @param driver The driver to initialize. This must be a pointer to one of
341 * the entries returned by sr_driver_list(). Must not be NULL.
343 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
344 * SR_ERR_BUG upon internal errors, or another negative error code
347 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
352 sr_err("Invalid libsigrok context, can't initialize.");
357 sr_err("Invalid driver, can't initialize.");
361 sr_spew("Initializing driver '%s'.", driver->name);
362 if ((ret = driver->init(ctx)) < 0)
363 sr_err("Failed to initialize the driver: %d.", ret);
369 * Tell a hardware driver to scan for devices.
371 * In addition to the detection, the devices that are found are also
372 * initialized automatically. On some devices, this involves a firmware upload,
373 * or other such measures.
375 * The order in which the system is scanned for devices is not specified. The
376 * caller should not assume or rely on any specific order.
378 * Before calling sr_driver_scan(), the user must have previously initialized
379 * the driver by calling sr_driver_init().
381 * @param driver The driver that should scan. This must be a pointer to one of
382 * the entries returned by sr_driver_list(). Must not be NULL.
383 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
384 * scanner. Can be NULL/empty.
386 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
387 * found (or errors were encountered). This list must be freed by the
388 * caller using g_slist_free(), but without freeing the data pointed
391 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
396 sr_err("Invalid driver, can't scan for devices.");
401 sr_err("Driver not initialized, can't scan for devices.");
405 l = driver->scan(options);
407 sr_spew("Scan of '%s' found %d devices.", driver->name,
414 SR_PRIV void sr_hw_cleanup_all(void)
417 struct sr_dev_driver **drivers;
419 drivers = sr_driver_list();
420 for (i = 0; drivers[i]; i++) {
421 if (drivers[i]->cleanup)
422 drivers[i]->cleanup();
426 /** A floating reference can be passed in for data. */
427 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
429 struct sr_config *src;
431 if (!(src = g_try_malloc(sizeof(struct sr_config))))
434 src->data = g_variant_ref_sink(data);
439 SR_PRIV void sr_config_free(struct sr_config *src)
442 if (!src || !src->data) {
443 sr_err("%s: invalid data!", __func__);
447 g_variant_unref(src->data);
453 * Returns information about the given driver or device instance.
455 * @param driver The sr_dev_driver struct to query.
456 * @param key The configuration key (SR_CONF_*).
457 * @param data Pointer to a GVariant where the value will be stored. Must
458 * not be NULL. The caller is given ownership of the GVariant
459 * and must thus decrease the refcount after use. However if
460 * this function returns an error code, the field should be
461 * considered unused, and should not be unreferenced.
462 * @param sdi (optional) If the key is specific to a device, this must
463 * contain a pointer to the struct sr_dev_inst to be checked.
464 * Otherwise it must be NULL.
466 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
467 * may be returned by the driver indicating it doesn't know that key,
468 * but this is not to be flagged as an error by the caller; merely
469 * as an indication that it's not applicable.
471 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
472 GVariant **data, const struct sr_dev_inst *sdi)
476 if (!driver || !data)
479 if (!driver->config_get)
482 if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
483 /* Got a floating reference from the driver. Sink it here,
484 * caller will need to unref when done with it. */
485 g_variant_ref_sink(*data);
492 * Set a configuration key in a device instance.
494 * @param sdi The device instance.
495 * @param key The configuration key (SR_CONF_*).
496 * @param data The new value for the key, as a GVariant with GVariantType
497 * appropriate to that key. A floating reference can be passed
498 * in; its refcount will be sunk and unreferenced after use.
500 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
501 * may be returned by the driver indicating it doesn't know that key,
502 * but this is not to be flagged as an error by the caller; merely
503 * as an indication that it's not applicable.
505 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
509 g_variant_ref_sink(data);
511 if (!sdi || !sdi->driver || !data)
513 else if (!sdi->driver->config_set)
516 ret = sdi->driver->config_set(key, data, sdi);
518 g_variant_unref(data);
524 * List all possible values for a configuration key.
526 * @param driver The sr_dev_driver struct to query.
527 * @param key The configuration key (SR_CONF_*).
528 * @param data A pointer to a GVariant where the list will be stored. The
529 * caller is given ownership of the GVariant and must thus
530 * unref the GVariant after use. However if this function
531 * returns an error code, the field should be considered
532 * unused, and should not be unreferenced.
533 * @param sdi (optional) If the key is specific to a device, this must
534 * contain a pointer to the struct sr_dev_inst to be checked.
536 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
537 * may be returned by the driver indicating it doesn't know that key,
538 * but this is not to be flagged as an error by the caller; merely
539 * as an indication that it's not applicable.
541 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
542 GVariant **data, const struct sr_dev_inst *sdi)
546 if (!driver || !data)
548 else if (!driver->config_list)
550 else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
551 g_variant_ref_sink(*data);
557 * Get information about a configuration key.
559 * @param key The configuration key.
561 * @return A pointer to a struct sr_config_info, or NULL if the key
564 SR_API const struct sr_config_info *sr_config_info_get(int key)
568 for (i = 0; sr_config_info_data[i].key; i++) {
569 if (sr_config_info_data[i].key == key)
570 return &sr_config_info_data[i];
577 * Get information about an configuration key, by name.
579 * @param optname The configuration key.
581 * @return A pointer to a struct sr_config_info, or NULL if the key
584 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
588 for (i = 0; sr_config_info_data[i].key; i++) {
589 if (!strcmp(sr_config_info_data[i].id, optname))
590 return &sr_config_info_data[i];
596 /* Unnecessary level of indirection follows. */
599 SR_PRIV int sr_source_remove(int fd)
601 return sr_session_source_remove(fd);
605 SR_PRIV int sr_source_add(int fd, int events, int timeout,
606 sr_receive_data_callback_t cb, void *cb_data)
608 return sr_session_source_add(fd, events, timeout, cb, cb_data);