2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 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_RLE, SR_T_BOOL, "rle",
65 "Run Length Encoding", NULL},
66 {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
67 "Trigger slope", NULL},
68 {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
69 "Trigger source", NULL},
70 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
71 "Horizontal trigger position", NULL},
72 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
74 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
76 {SR_CONF_FILTER, SR_T_CHAR, "filter",
77 "Filter targets", NULL},
78 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
80 {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
82 {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
84 {0, 0, NULL, NULL, NULL},
88 #ifdef HAVE_HW_BRYMEN_DMM
89 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
91 #ifdef HAVE_HW_COLEAD_SLM
92 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
95 extern SR_PRIV struct sr_dev_driver demo_driver_info;
97 #ifdef HAVE_HW_LASCAR_EL_USB
98 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
100 #ifdef HAVE_HW_MIC_985XX
101 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
102 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
104 #ifdef HAVE_HW_NEXUS_OSCIPRIME
105 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
108 extern SR_PRIV struct sr_dev_driver ols_driver_info;
110 #ifdef HAVE_HW_RIGOL_DS1XX2
111 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
113 #ifdef HAVE_HW_TONDAJ_SL_814
114 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
116 #ifdef HAVE_HW_VICTOR_DMM
117 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
119 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
120 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
122 #ifdef HAVE_LA_ASIX_SIGMA
123 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
125 #ifdef HAVE_LA_CHRONOVU_LA8
126 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
128 #ifdef HAVE_LA_LINK_MSO19
129 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
132 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
134 #ifdef HAVE_LA_FX2LAFW
135 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
137 #ifdef HAVE_HW_HANTEK_DSO
138 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
140 #ifdef HAVE_HW_AGILENT_DMM
141 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
143 #ifdef HAVE_HW_FLUKE_DMM
144 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
146 #ifdef HAVE_HW_SERIAL_DMM
147 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
148 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
149 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
150 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
151 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
152 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
153 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
154 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
155 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
156 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
157 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
158 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
159 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
160 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
161 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
163 #ifdef HAVE_HW_UNI_T_DMM
164 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
165 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
169 static struct sr_dev_driver *drivers_list[] = {
170 #ifdef HAVE_HW_BRYMEN_DMM
171 &brymen_bm857_driver_info,
173 #ifdef HAVE_HW_COLEAD_SLM
174 &colead_slm_driver_info,
179 #ifdef HAVE_HW_LASCAR_EL_USB
180 &lascar_el_usb_driver_info,
182 #ifdef HAVE_HW_MIC_985XX
183 &mic_98581_driver_info,
184 &mic_98583_driver_info,
186 #ifdef HAVE_HW_NEXUS_OSCIPRIME
187 &nexus_osciprime_driver_info,
192 #ifdef HAVE_HW_RIGOL_DS1XX2
193 &rigol_ds1xx2_driver_info,
195 #ifdef HAVE_HW_TONDAJ_SL_814
196 &tondaj_sl_814_driver_info,
198 #ifdef HAVE_HW_VICTOR_DMM
199 &victor_dmm_driver_info,
201 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
202 &zeroplus_logic_cube_driver_info,
204 #ifdef HAVE_LA_ASIX_SIGMA
205 &asix_sigma_driver_info,
207 #ifdef HAVE_LA_CHRONOVU_LA8
208 &chronovu_la8_driver_info,
210 #ifdef HAVE_LA_LINK_MSO19
211 &link_mso19_driver_info,
216 #ifdef HAVE_LA_FX2LAFW
217 &fx2lafw_driver_info,
219 #ifdef HAVE_HW_HANTEK_DSO
220 &hantek_dso_driver_info,
222 #ifdef HAVE_HW_AGILENT_DMM
225 #ifdef HAVE_HW_FLUKE_DMM
226 &flukedmm_driver_info,
228 #ifdef HAVE_HW_SERIAL_DMM
229 &digitek_dt4000zc_driver_info,
230 &tekpower_tp4000zc_driver_info,
231 &metex_me31_driver_info,
232 &peaktech_3410_driver_info,
233 &mastech_mas345_driver_info,
234 &va_va18b_driver_info,
235 &metex_m3640d_driver_info,
236 &peaktech_4370_driver_info,
237 &pce_pce_dm32_driver_info,
238 &radioshack_22_168_driver_info,
239 &radioshack_22_805_driver_info,
240 &radioshack_22_812_driver_info,
241 &voltcraft_vc820_ser_driver_info,
242 &voltcraft_vc840_ser_driver_info,
243 &uni_t_ut61e_ser_driver_info,
245 #ifdef HAVE_HW_UNI_T_DMM
246 &uni_t_ut61d_driver_info,
247 &voltcraft_vc820_driver_info,
253 * Return the list of supported hardware drivers.
255 * @return Pointer to the NULL-terminated list of hardware driver pointers.
257 SR_API struct sr_dev_driver **sr_driver_list(void)
264 * Initialize a hardware driver.
266 * This usually involves memory allocations and variable initializations
267 * within the driver, but _not_ scanning for attached devices.
268 * The API call sr_driver_scan() is used for that.
270 * @param ctx A libsigrok context object allocated by a previous call to
271 * sr_init(). Must not be NULL.
272 * @param driver The driver to initialize. This must be a pointer to one of
273 * the entries returned by sr_driver_list(). Must not be NULL.
275 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
276 * SR_ERR_BUG upon internal errors, or another negative error code
279 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
284 sr_err("Invalid libsigrok context, can't initialize.");
289 sr_err("Invalid driver, can't initialize.");
293 sr_spew("Initializing driver '%s'.", driver->name);
294 if ((ret = driver->init(ctx)) < 0)
295 sr_err("Failed to initialize the driver: %d.", ret);
301 * Tell a hardware driver to scan for devices.
303 * In addition to the detection, the devices that are found are also
304 * initialized automatically. On some devices, this involves a firmware upload,
305 * or other such measures.
307 * The order in which the system is scanned for devices is not specified. The
308 * caller should not assume or rely on any specific order.
310 * Before calling sr_driver_scan(), the user must have previously initialized
311 * the driver by calling sr_driver_init().
313 * @param driver The driver that should scan. This must be a pointer to one of
314 * the entries returned by sr_driver_list(). Must not be NULL.
315 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
316 * scanner. Can be NULL/empty.
318 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
319 * found (or errors were encountered). This list must be freed by the
320 * caller using g_slist_free(), but without freeing the data pointed
323 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
328 sr_err("Invalid driver, can't scan for devices.");
333 sr_err("Driver not initialized, can't scan for devices.");
337 l = driver->scan(options);
339 sr_spew("Scan of '%s' found %d devices.", driver->name,
346 SR_PRIV void sr_hw_cleanup_all(void)
349 struct sr_dev_driver **drivers;
351 drivers = sr_driver_list();
352 for (i = 0; drivers[i]; i++) {
353 if (drivers[i]->cleanup)
354 drivers[i]->cleanup();
358 SR_PRIV struct sr_config *sr_config_new(int key, const void *value)
360 struct sr_config *src;
362 if (!(src = g_try_malloc(sizeof(struct sr_config))))
371 * Returns information about the given driver or device instance.
373 * @param driver The sr_dev_driver struct to query.
374 * @param key The configuration key (SR_CONF_*).
375 * @param data Pointer where the value will be stored. Must not be NULL.
376 * @param sdi If the key is specific to a device, this must contain a
377 * pointer to the struct sr_dev_inst to be checked.
379 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
380 * may be returned by the driver indicating it doesn't know that key,
381 * but this is not to be flagged as an error by the caller; merely
382 * as an indication that it's not applicable.
384 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
385 const void **data, const struct sr_dev_inst *sdi)
389 if (!driver || !data)
392 ret = driver->config_get(key, data, sdi);
398 * Set a configuration key in a device instance.
400 * @param sdi The device instance.
401 * @param key The configuration key (SR_CONF_*).
402 * @param value The new value for the key, as a pointer to whatever type
403 * is appropriate for that key.
405 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
406 * may be returned by the driver indicating it doesn't know that key,
407 * but this is not to be flagged as an error by the caller; merely
408 * as an indication that it's not applicable.
410 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key,
415 if (!sdi || !sdi->driver || !value)
418 if (!sdi->driver->config_set)
421 ret = sdi->driver->config_set(key, value, sdi);
427 * List all possible values for a configuration key.
429 * @param driver The sr_dev_driver struct to query.
430 * @param key The configuration key (SR_CONF_*).
431 * @param data A pointer to a list of values, in whatever format is
432 * appropriate for that key.
433 * @param sdi If the key is specific to a device, this must contain a
434 * pointer to the struct sr_dev_inst to be checked.
436 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
437 * may be returned by the driver indicating it doesn't know that key,
438 * but this is not to be flagged as an error by the caller; merely
439 * as an indication that it's not applicable.
441 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
442 const void **data, const struct sr_dev_inst *sdi)
446 if (!driver || !data)
449 ret = driver->config_list(key, data, sdi);
455 * Get information about a configuration key.
457 * @param opt The configuration key.
459 * @return A pointer to a struct sr_config_info, or NULL if the key
462 SR_API const struct sr_config_info *sr_config_info_get(int key)
466 for (i = 0; sr_config_info_data[i].key; i++) {
467 if (sr_config_info_data[i].key == key)
468 return &sr_config_info_data[i];
475 * Get information about an configuration key, by name.
477 * @param optname The configuration key.
479 * @return A pointer to a struct sr_config_info, or NULL if the key
482 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
486 for (i = 0; sr_config_info_data[i].key; i++) {
487 if (!strcmp(sr_config_info_data[i].id, optname))
488 return &sr_config_info_data[i];
494 /* Unnecessary level of indirection follows. */
497 SR_PRIV int sr_source_remove(int fd)
499 return sr_session_source_remove(fd);
503 SR_PRIV int sr_source_add(int fd, int events, int timeout,
504 sr_receive_data_callback_t cb, void *cb_data)
506 return sr_session_source_add(fd, events, timeout, cb, cb_data);