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 driver-specific prefix string. */
31 #define DRIVER_LOG_DOMAIN "hwdriver: "
32 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
33 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
34 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
35 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
36 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
37 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN 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 {0, 0, NULL, NULL, NULL},
90 #ifdef HAVE_HW_BRYMEN_DMM
91 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
93 #ifdef HAVE_HW_COLEAD_SLM
94 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
97 extern SR_PRIV struct sr_dev_driver demo_driver_info;
99 #ifdef HAVE_HW_LASCAR_EL_USB
100 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
102 #ifdef HAVE_HW_MIC_985XX
103 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
104 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
106 #ifdef HAVE_HW_NEXUS_OSCIPRIME
107 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
110 extern SR_PRIV struct sr_dev_driver ols_driver_info;
112 #ifdef HAVE_HW_RIGOL_DS1XX2
113 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
115 #ifdef HAVE_HW_TONDAJ_SL_814
116 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
118 #ifdef HAVE_HW_VICTOR_DMM
119 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
121 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
122 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
124 #ifdef HAVE_LA_ASIX_SIGMA
125 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
127 #ifdef HAVE_LA_CHRONOVU_LA8
128 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
130 #ifdef HAVE_LA_LINK_MSO19
131 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
134 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
136 #ifdef HAVE_LA_FX2LAFW
137 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
139 #ifdef HAVE_HW_HANTEK_DSO
140 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
142 #ifdef HAVE_HW_AGILENT_DMM
143 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
145 #ifdef HAVE_HW_FLUKE_DMM
146 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
148 #ifdef HAVE_HW_SERIAL_DMM
149 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
150 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
151 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
152 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
153 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
154 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
155 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
156 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
157 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
158 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
159 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
160 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
161 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
162 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
163 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
164 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
166 #ifdef HAVE_HW_UNI_T_DMM
167 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
168 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
169 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
170 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
174 static struct sr_dev_driver *drivers_list[] = {
175 #ifdef HAVE_HW_BRYMEN_DMM
176 &brymen_bm857_driver_info,
178 #ifdef HAVE_HW_COLEAD_SLM
179 &colead_slm_driver_info,
184 #ifdef HAVE_HW_LASCAR_EL_USB
185 &lascar_el_usb_driver_info,
187 #ifdef HAVE_HW_MIC_985XX
188 &mic_98581_driver_info,
189 &mic_98583_driver_info,
191 #ifdef HAVE_HW_NEXUS_OSCIPRIME
192 &nexus_osciprime_driver_info,
197 #ifdef HAVE_HW_RIGOL_DS1XX2
198 &rigol_ds1xx2_driver_info,
200 #ifdef HAVE_HW_TONDAJ_SL_814
201 &tondaj_sl_814_driver_info,
203 #ifdef HAVE_HW_VICTOR_DMM
204 &victor_dmm_driver_info,
206 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
207 &zeroplus_logic_cube_driver_info,
209 #ifdef HAVE_LA_ASIX_SIGMA
210 &asix_sigma_driver_info,
212 #ifdef HAVE_LA_CHRONOVU_LA8
213 &chronovu_la8_driver_info,
215 #ifdef HAVE_LA_LINK_MSO19
216 &link_mso19_driver_info,
221 #ifdef HAVE_LA_FX2LAFW
222 &fx2lafw_driver_info,
224 #ifdef HAVE_HW_HANTEK_DSO
225 &hantek_dso_driver_info,
227 #ifdef HAVE_HW_AGILENT_DMM
230 #ifdef HAVE_HW_FLUKE_DMM
231 &flukedmm_driver_info,
233 #ifdef HAVE_HW_SERIAL_DMM
234 &digitek_dt4000zc_driver_info,
235 &tekpower_tp4000zc_driver_info,
236 &metex_me31_driver_info,
237 &peaktech_3410_driver_info,
238 &mastech_mas345_driver_info,
239 &va_va18b_driver_info,
240 &metex_m3640d_driver_info,
241 &peaktech_4370_driver_info,
242 &pce_pce_dm32_driver_info,
243 &radioshack_22_168_driver_info,
244 &radioshack_22_805_driver_info,
245 &radioshack_22_812_driver_info,
246 &voltcraft_vc820_ser_driver_info,
247 &voltcraft_vc840_ser_driver_info,
248 &uni_t_ut61d_ser_driver_info,
249 &uni_t_ut61e_ser_driver_info,
251 #ifdef HAVE_HW_UNI_T_DMM
252 &uni_t_ut61d_driver_info,
253 &uni_t_ut61e_driver_info,
254 &voltcraft_vc820_driver_info,
255 &voltcraft_vc840_driver_info,
261 * Return the list of supported hardware drivers.
263 * @return Pointer to the NULL-terminated list of hardware driver pointers.
265 SR_API struct sr_dev_driver **sr_driver_list(void)
272 * Initialize a hardware driver.
274 * This usually involves memory allocations and variable initializations
275 * within the driver, but _not_ scanning for attached devices.
276 * The API call sr_driver_scan() is used for that.
278 * @param ctx A libsigrok context object allocated by a previous call to
279 * sr_init(). Must not be NULL.
280 * @param driver The driver to initialize. This must be a pointer to one of
281 * the entries returned by sr_driver_list(). Must not be NULL.
283 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
284 * SR_ERR_BUG upon internal errors, or another negative error code
287 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
292 sr_err("Invalid libsigrok context, can't initialize.");
297 sr_err("Invalid driver, can't initialize.");
301 sr_spew("Initializing driver '%s'.", driver->name);
302 if ((ret = driver->init(ctx)) < 0)
303 sr_err("Failed to initialize the driver: %d.", ret);
309 * Tell a hardware driver to scan for devices.
311 * In addition to the detection, the devices that are found are also
312 * initialized automatically. On some devices, this involves a firmware upload,
313 * or other such measures.
315 * The order in which the system is scanned for devices is not specified. The
316 * caller should not assume or rely on any specific order.
318 * Before calling sr_driver_scan(), the user must have previously initialized
319 * the driver by calling sr_driver_init().
321 * @param driver The driver that should scan. This must be a pointer to one of
322 * the entries returned by sr_driver_list(). Must not be NULL.
323 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
324 * scanner. Can be NULL/empty.
326 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
327 * found (or errors were encountered). This list must be freed by the
328 * caller using g_slist_free(), but without freeing the data pointed
331 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
336 sr_err("Invalid driver, can't scan for devices.");
341 sr_err("Driver not initialized, can't scan for devices.");
345 l = driver->scan(options);
347 sr_spew("Scan of '%s' found %d devices.", driver->name,
354 SR_PRIV void sr_hw_cleanup_all(void)
357 struct sr_dev_driver **drivers;
359 drivers = sr_driver_list();
360 for (i = 0; drivers[i]; i++) {
361 if (drivers[i]->cleanup)
362 drivers[i]->cleanup();
366 /** A floating reference can be passed in for data. */
367 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
369 struct sr_config *src;
371 if (!(src = g_try_malloc(sizeof(struct sr_config))))
374 src->data = g_variant_ref_sink(data);
379 SR_PRIV void sr_config_free(struct sr_config *src)
382 if (!src || !src->data) {
383 sr_err("%s: invalid data!", __func__);
387 g_variant_unref(src->data);
393 * Returns information about the given driver or device instance.
395 * @param driver The sr_dev_driver struct to query.
396 * @param key The configuration key (SR_CONF_*).
397 * @param data Pointer to a GVariant where the value will be stored. Must
398 * not be NULL. The caller is given ownership of the GVariant
399 * and must thus decrease the refcount after use. However if
400 * this function returns an error code, the field should be
401 * considered unused, and should not be unreferenced.
402 * @param sdi (optional) If the key is specific to a device, this must
403 * contain a pointer to the struct sr_dev_inst to be checked.
404 * Otherwise it must be NULL.
406 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
407 * may be returned by the driver indicating it doesn't know that key,
408 * but this is not to be flagged as an error by the caller; merely
409 * as an indication that it's not applicable.
411 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
412 GVariant **data, const struct sr_dev_inst *sdi)
416 if (!driver || !data)
419 if (!driver->config_get)
422 if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
423 /* Got a floating reference from the driver. Sink it here,
424 * caller will need to unref when done with it. */
425 g_variant_ref_sink(*data);
432 * Set a configuration key in a device instance.
434 * @param sdi The device instance.
435 * @param key The configuration key (SR_CONF_*).
436 * @param data The new value for the key, as a GVariant with GVariantType
437 * appropriate to that key. A floating reference can be passed
438 * in; its refcount will be sunk and unreferenced after use.
440 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
441 * may be returned by the driver indicating it doesn't know that key,
442 * but this is not to be flagged as an error by the caller; merely
443 * as an indication that it's not applicable.
445 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
449 g_variant_ref_sink(data);
451 if (!sdi || !sdi->driver || !data)
453 else if (!sdi->driver->config_set)
456 ret = sdi->driver->config_set(key, data, sdi);
458 g_variant_unref(data);
464 * List all possible values for a configuration key.
466 * @param driver The sr_dev_driver struct to query.
467 * @param key The configuration key (SR_CONF_*).
468 * @param data A pointer to a GVariant where the list will be stored. The
469 * caller is given ownership of the GVariant and must thus
470 * unref the GVariant after use. However if this function
471 * returns an error code, the field should be considered
472 * unused, and should not be unreferenced.
473 * @param sdi (optional) If the key is specific to a device, this must
474 * contain a pointer to the struct sr_dev_inst to be checked.
476 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
477 * may be returned by the driver indicating it doesn't know that key,
478 * but this is not to be flagged as an error by the caller; merely
479 * as an indication that it's not applicable.
481 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
482 GVariant **data, const struct sr_dev_inst *sdi)
486 if (!driver || !data)
488 else if (!driver->config_list)
490 else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
491 g_variant_ref_sink(*data);
497 * Get information about a configuration key.
499 * @param key The configuration key.
501 * @return A pointer to a struct sr_config_info, or NULL if the key
504 SR_API const struct sr_config_info *sr_config_info_get(int key)
508 for (i = 0; sr_config_info_data[i].key; i++) {
509 if (sr_config_info_data[i].key == key)
510 return &sr_config_info_data[i];
517 * Get information about an configuration key, by name.
519 * @param optname The configuration key.
521 * @return A pointer to a struct sr_config_info, or NULL if the key
524 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
528 for (i = 0; sr_config_info_data[i].key; i++) {
529 if (!strcmp(sr_config_info_data[i].id, optname))
530 return &sr_config_info_data[i];
536 /* Unnecessary level of indirection follows. */
539 SR_PRIV int sr_source_remove(int fd)
541 return sr_session_source_remove(fd);
545 SR_PRIV int sr_source_add(int fd, int events, int timeout,
546 sr_receive_data_callback_t cb, void *cb_data)
548 return sr_session_source_add(fd, events, timeout, cb, cb_data);