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"
33 * Hardware driver handling in libsigrok.
37 * @defgroup grp_driver Hardware drivers
39 * Hardware driver handling in libsigrok.
44 /* Driver scanning options. */
45 static struct sr_hwcap_option sr_drvopts[] = {
46 {SR_HWOPT_MODEL, SR_T_KEYVALUE, "Model", "model"},
47 {SR_HWOPT_CONN, SR_T_CHAR, "Connection", "conn"},
48 {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "Serial communication", "serialcomm"},
52 /* Device instance options. */
53 static struct sr_hwcap_option sr_devopts[] = {
54 {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
55 {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
56 {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"},
57 {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
58 {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "Trigger slope", "triggerslope"},
59 {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "Trigger source", "triggersource"},
60 {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "Horizontal trigger position",
62 {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"},
63 {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"},
64 {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"},
65 {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"},
66 {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"},
71 #ifdef HAVE_HW_COLEAD_SLM
72 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
75 extern SR_PRIV struct sr_dev_driver demo_driver_info;
77 #ifdef HAVE_HW_LASCAR_EL_USB
78 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
81 extern SR_PRIV struct sr_dev_driver ols_driver_info;
83 #ifdef HAVE_HW_TONDAJ_SL_814
84 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
86 #ifdef HAVE_HW_VICTOR_DMM
87 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
89 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
90 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
92 #ifdef HAVE_LA_ASIX_SIGMA
93 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
95 #ifdef HAVE_LA_CHRONOVU_LA8
96 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
98 #ifdef HAVE_LA_LINK_MSO19
99 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
102 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
104 #ifdef HAVE_LA_FX2LAFW
105 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
107 #ifdef HAVE_HW_HANTEK_DSO
108 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
110 #ifdef HAVE_HW_AGILENT_DMM
111 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
113 #ifdef HAVE_HW_FLUKE_DMM
114 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
116 #ifdef HAVE_HW_SERIAL_DMM
117 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
118 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
119 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
120 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
121 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
122 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
123 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
124 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
125 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
126 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
127 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
128 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
129 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
131 #ifdef HAVE_HW_UNI_T_DMM
132 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
133 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
137 static struct sr_dev_driver *drivers_list[] = {
138 #ifdef HAVE_HW_COLEAD_SLM
139 &colead_slm_driver_info,
144 #ifdef HAVE_HW_LASCAR_EL_USB
145 &lascar_el_usb_driver_info,
150 #ifdef HAVE_HW_TONDAJ_SL_814
151 &tondaj_sl_814_driver_info,
153 #ifdef HAVE_HW_VICTOR_DMM
154 &victor_dmm_driver_info,
156 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
157 &zeroplus_logic_cube_driver_info,
159 #ifdef HAVE_LA_ASIX_SIGMA
160 &asix_sigma_driver_info,
162 #ifdef HAVE_LA_CHRONOVU_LA8
163 &chronovu_la8_driver_info,
165 #ifdef HAVE_LA_LINK_MSO19
166 &link_mso19_driver_info,
171 #ifdef HAVE_LA_FX2LAFW
172 &fx2lafw_driver_info,
174 #ifdef HAVE_HW_HANTEK_DSO
175 &hantek_dso_driver_info,
177 #ifdef HAVE_HW_AGILENT_DMM
180 #ifdef HAVE_HW_FLUKE_DMM
181 &flukedmm_driver_info,
183 #ifdef HAVE_HW_SERIAL_DMM
184 &digitek_dt4000zc_driver_info,
185 &tekpower_tp4000zc_driver_info,
186 &metex_me31_driver_info,
187 &peaktech_3410_driver_info,
188 &mastech_mas345_driver_info,
189 &va_va18b_driver_info,
190 &metex_m3640d_driver_info,
191 &peaktech_4370_driver_info,
192 &pce_pce_dm32_driver_info,
193 &radioshack_22_168_driver_info,
194 &radioshack_22_812_driver_info,
195 &voltcraft_vc820_ser_driver_info,
196 &voltcraft_vc840_ser_driver_info,
198 #ifdef HAVE_HW_UNI_T_DMM
199 &uni_t_ut61d_driver_info,
200 &voltcraft_vc820_driver_info,
206 * Return the list of supported hardware drivers.
208 * @return Pointer to the NULL-terminated list of hardware driver pointers.
210 SR_API struct sr_dev_driver **sr_driver_list(void)
217 * Initialize a hardware driver.
219 * @param ctx A libsigrok context object allocated by a previous call to
221 * @param driver The driver to initialize.
223 * @return SR_OK if all went well, or an error code otherwise.
225 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
229 return driver->init(ctx);
235 * Tell a hardware driver to scan for devices.
237 * In addition to the detection, the devices that are found are also
238 * initialized automatically. On some devices, this involves a firmware upload,
239 * or other such measures.
241 * The order in which the system is scanned for devices is not specified. The
242 * caller should not assume or rely on any specific order.
244 * @param driver The driver.
245 * @param options A list of struct sr_hwopt options to pass to the driver's
248 * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
249 * This list must be freed by the caller, but without freeing the data
250 * pointed to in the list.
252 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
256 return driver->scan(options);
262 SR_PRIV void sr_hw_cleanup_all(void)
265 struct sr_dev_driver **drivers;
267 drivers = sr_driver_list();
268 for (i = 0; drivers[i]; i++) {
269 if (drivers[i]->cleanup)
270 drivers[i]->cleanup();
275 * Returns information about the given driver or device instance.
277 * @param driver The sr_dev_driver struct to query.
278 * @param id The type of information, in the form of an SR_HWCAP_* option.
279 * @param data Pointer where the value. will be stored. Must not be NULL.
280 * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
282 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
283 * may be returned by the driver indicating it doesn't know that id,
284 * but this is not to be flagged as an error by the caller; merely
285 * as an indication that it's not applicable.
287 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
288 const void **data, const struct sr_dev_inst *sdi)
292 if (driver == NULL || data == NULL)
295 ret = driver->info_get(id, data, sdi);
301 * Find out if a hardware driver has a specific capability.
303 * @param driver The hardware driver in which to search for the capability.
304 * @param hwcap The capability to find in the list.
306 * @return TRUE if the specified capability exists in the specified driver,
307 * FALSE otherwise. Also, if 'driver' is NULL or the respective driver
308 * returns an invalid capability list, FALSE is returned.
310 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
316 sr_err("hwdriver: %s: driver was NULL", __func__);
320 if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
323 for (i = 0; hwcaps[i]; i++) {
324 if (hwcaps[i] == hwcap)
332 * Get information about a hardware driver option.
334 * @param opt The option to get.
336 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
339 SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt)
343 for (i = 0; sr_drvopts[i].hwcap; i++) {
344 if (sr_drvopts[i].hwcap == opt)
345 return &sr_drvopts[i];
352 * Get information about a hardware driver option, by name.
354 * @param optname The name of the option to get.
356 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
359 SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname)
363 for (i = 0; sr_drvopts[i].hwcap; i++) {
364 if (!strcmp(sr_drvopts[i].shortname, optname))
365 return &sr_drvopts[i];
372 * Get information about a device option.
374 * @param opt The option to get.
376 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
379 SR_API const struct sr_hwcap_option *sr_devopt_get(int opt)
383 for (i = 0; sr_devopts[i].hwcap; i++) {
384 if (sr_devopts[i].hwcap == opt)
385 return &sr_devopts[i];
392 * Get information about a device option, by name.
394 * @param optname The name of the option to get.
396 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
399 SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname)
403 for (i = 0; sr_devopts[i].hwcap; i++) {
404 if (!strcmp(sr_devopts[i].shortname, optname))
405 return &sr_devopts[i];
411 /* Unnecessary level of indirection follows. */
414 SR_PRIV int sr_source_remove(int fd)
416 return sr_session_source_remove(fd);
420 SR_PRIV int sr_source_add(int fd, int events, int timeout,
421 sr_receive_data_callback_t cb, void *cb_data)
423 return sr_session_source_add(fd, events, timeout, cb, cb_data);