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;
80 #ifdef HAVE_HW_NEXUS_OSCIPRIME
81 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
84 extern SR_PRIV struct sr_dev_driver ols_driver_info;
86 #ifdef HAVE_HW_RIGOL_DS1XX2
87 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
89 #ifdef HAVE_HW_TONDAJ_SL_814
90 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
92 #ifdef HAVE_HW_VICTOR_DMM
93 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
95 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
96 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
98 #ifdef HAVE_LA_ASIX_SIGMA
99 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
101 #ifdef HAVE_LA_CHRONOVU_LA8
102 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
104 #ifdef HAVE_LA_LINK_MSO19
105 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
108 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
110 #ifdef HAVE_LA_FX2LAFW
111 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
113 #ifdef HAVE_HW_HANTEK_DSO
114 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
116 #ifdef HAVE_HW_AGILENT_DMM
117 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
119 #ifdef HAVE_HW_FLUKE_DMM
120 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
122 #ifdef HAVE_HW_SERIAL_DMM
123 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
124 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
125 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
126 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
127 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
128 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
129 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
130 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
131 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
132 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
133 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
134 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
135 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
136 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
138 #ifdef HAVE_HW_UNI_T_DMM
139 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
140 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
144 static struct sr_dev_driver *drivers_list[] = {
145 #ifdef HAVE_HW_COLEAD_SLM
146 &colead_slm_driver_info,
151 #ifdef HAVE_HW_LASCAR_EL_USB
152 &lascar_el_usb_driver_info,
154 #ifdef HAVE_HW_NEXUS_OSCIPRIME
155 &nexus_osciprime_driver_info,
160 #ifdef HAVE_HW_RIGOL_DS1XX2
161 &rigol_ds1xx2_driver_info,
163 #ifdef HAVE_HW_TONDAJ_SL_814
164 &tondaj_sl_814_driver_info,
166 #ifdef HAVE_HW_VICTOR_DMM
167 &victor_dmm_driver_info,
169 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
170 &zeroplus_logic_cube_driver_info,
172 #ifdef HAVE_LA_ASIX_SIGMA
173 &asix_sigma_driver_info,
175 #ifdef HAVE_LA_CHRONOVU_LA8
176 &chronovu_la8_driver_info,
178 #ifdef HAVE_LA_LINK_MSO19
179 &link_mso19_driver_info,
184 #ifdef HAVE_LA_FX2LAFW
185 &fx2lafw_driver_info,
187 #ifdef HAVE_HW_HANTEK_DSO
188 &hantek_dso_driver_info,
190 #ifdef HAVE_HW_AGILENT_DMM
193 #ifdef HAVE_HW_FLUKE_DMM
194 &flukedmm_driver_info,
196 #ifdef HAVE_HW_SERIAL_DMM
197 &digitek_dt4000zc_driver_info,
198 &tekpower_tp4000zc_driver_info,
199 &metex_me31_driver_info,
200 &peaktech_3410_driver_info,
201 &mastech_mas345_driver_info,
202 &va_va18b_driver_info,
203 &metex_m3640d_driver_info,
204 &peaktech_4370_driver_info,
205 &pce_pce_dm32_driver_info,
206 &radioshack_22_168_driver_info,
207 &radioshack_22_812_driver_info,
208 &voltcraft_vc820_ser_driver_info,
209 &voltcraft_vc840_ser_driver_info,
210 &uni_t_ut61e_ser_driver_info,
212 #ifdef HAVE_HW_UNI_T_DMM
213 &uni_t_ut61d_driver_info,
214 &voltcraft_vc820_driver_info,
220 * Return the list of supported hardware drivers.
222 * @return Pointer to the NULL-terminated list of hardware driver pointers.
224 SR_API struct sr_dev_driver **sr_driver_list(void)
231 * Initialize a hardware driver.
233 * @param ctx A libsigrok context object allocated by a previous call to
235 * @param driver The driver to initialize.
237 * @return SR_OK if all went well, or an error code otherwise.
239 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
243 return driver->init(ctx);
249 * Tell a hardware driver to scan for devices.
251 * In addition to the detection, the devices that are found are also
252 * initialized automatically. On some devices, this involves a firmware upload,
253 * or other such measures.
255 * The order in which the system is scanned for devices is not specified. The
256 * caller should not assume or rely on any specific order.
258 * @param driver The driver.
259 * @param options A list of struct sr_hwopt options to pass to the driver's
262 * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
263 * This list must be freed by the caller, but without freeing the data
264 * pointed to in the list.
266 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
270 return driver->scan(options);
276 SR_PRIV void sr_hw_cleanup_all(void)
279 struct sr_dev_driver **drivers;
281 drivers = sr_driver_list();
282 for (i = 0; drivers[i]; i++) {
283 if (drivers[i]->cleanup)
284 drivers[i]->cleanup();
289 * Returns information about the given driver or device instance.
291 * @param driver The sr_dev_driver struct to query.
292 * @param id The type of information, in the form of an SR_HWCAP_* option.
293 * @param data Pointer where the value. will be stored. Must not be NULL.
294 * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
296 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
297 * may be returned by the driver indicating it doesn't know that id,
298 * but this is not to be flagged as an error by the caller; merely
299 * as an indication that it's not applicable.
301 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
302 const void **data, const struct sr_dev_inst *sdi)
306 if (driver == NULL || data == NULL)
309 ret = driver->info_get(id, data, sdi);
315 * Find out if a hardware driver has a specific capability.
317 * @param driver The hardware driver in which to search for the capability.
318 * @param hwcap The capability to find in the list.
320 * @return TRUE if the specified capability exists in the specified driver,
321 * FALSE otherwise. Also, if 'driver' is NULL or the respective driver
322 * returns an invalid capability list, FALSE is returned.
324 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
330 sr_err("hwdriver: %s: driver was NULL", __func__);
334 if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
337 for (i = 0; hwcaps[i]; i++) {
338 if (hwcaps[i] == hwcap)
346 * Get information about a hardware driver option.
348 * @param opt The option to get.
350 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
353 SR_API const struct sr_config_info *sr_drvopt_get(int opt)
357 for (i = 0; sr_drvopts[i].key; i++) {
358 if (sr_drvopts[i].key == opt)
359 return &sr_drvopts[i];
366 * Get information about a hardware driver option, by name.
368 * @param optname The name of the option to get.
370 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
373 SR_API const struct sr_config_info *sr_drvopt_name_get(const char *optname)
377 for (i = 0; sr_drvopts[i].key; i++) {
378 if (!strcmp(sr_drvopts[i].id, optname))
379 return &sr_drvopts[i];
386 * Get information about a device option.
388 * @param opt The option to get.
390 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
393 SR_API const struct sr_config_info *sr_devopt_get(int opt)
397 for (i = 0; sr_devopts[i].key; i++) {
398 if (sr_devopts[i].key == opt)
399 return &sr_devopts[i];
406 * Get information about a device option, by name.
408 * @param optname The name of the option to get.
410 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
413 SR_API const struct sr_config_info *sr_devopt_name_get(const char *optname)
417 for (i = 0; sr_devopts[i].key; i++) {
418 if (!strcmp(sr_devopts[i].id, optname))
419 return &sr_devopts[i];
425 /* Unnecessary level of indirection follows. */
428 SR_PRIV int sr_source_remove(int fd)
430 return sr_session_source_remove(fd);
434 SR_PRIV int sr_source_add(int fd, int events, int timeout,
435 sr_receive_data_callback_t cb, void *cb_data)
437 return sr_session_source_add(fd, events, timeout, cb, cb_data);