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"},
72 extern SR_PRIV struct sr_dev_driver demo_driver_info;
75 extern SR_PRIV struct sr_dev_driver ols_driver_info;
77 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
78 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
80 #ifdef HAVE_LA_ASIX_SIGMA
81 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
83 #ifdef HAVE_LA_CHRONOVU_LA8
84 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
86 #ifdef HAVE_LA_LINK_MSO19
87 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
90 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
92 #ifdef HAVE_LA_FX2LAFW
93 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
95 #ifdef HAVE_HW_HANTEK_DSO
96 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
98 #ifdef HAVE_HW_GENERICDMM
99 extern SR_PRIV struct sr_dev_driver genericdmm_driver_info;
101 #ifdef HAVE_HW_AGILENT_DMM
102 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
104 #ifdef HAVE_HW_FLUKE_DMM
105 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
107 #ifdef HAVE_HW_RADIOSHACK_DMM
108 extern SR_PRIV struct sr_dev_driver radioshackdmm_driver_info;
110 #ifdef HAVE_HW_TEKPOWER_DMM
111 extern SR_PRIV struct sr_dev_driver tekpower_driver_info;
115 static struct sr_dev_driver *drivers_list[] = {
122 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
123 &zeroplus_logic_cube_driver_info,
125 #ifdef HAVE_LA_ASIX_SIGMA
126 &asix_sigma_driver_info,
128 #ifdef HAVE_LA_CHRONOVU_LA8
129 &chronovu_la8_driver_info,
131 #ifdef HAVE_LA_LINK_MSO19
132 &link_mso19_driver_info,
137 #ifdef HAVE_LA_FX2LAFW
138 &fx2lafw_driver_info,
140 #ifdef HAVE_HW_HANTEK_DSO
141 &hantek_dso_driver_info,
143 #ifdef HAVE_HW_GENERICDMM
144 &genericdmm_driver_info,
146 #ifdef HAVE_HW_AGILENT_DMM
149 #ifdef HAVE_HW_FLUKE_DMM
150 &flukedmm_driver_info,
152 #ifdef HAVE_HW_RADIOSHACK_DMM
153 &radioshackdmm_driver_info,
155 #ifdef HAVE_HW_TEKPOWER_DMM
156 &tekpower_driver_info,
162 * Return the list of supported hardware drivers.
164 * @return Pointer to the NULL-terminated list of hardware driver pointers.
166 SR_API struct sr_dev_driver **sr_driver_list(void)
173 * Initialize a hardware driver.
175 * @param driver The driver to initialize.
177 * @return SR_OK if all went well, or an error code otherwise.
179 SR_API int sr_driver_init(struct sr_dev_driver *driver)
183 return driver->init();
189 * Tell a hardware driver to scan for devices.
191 * In addition to the detection, the devices that are found are also
192 * initialized automatically. On some devices, this involves a firmware upload,
193 * or other such measures.
195 * The order in which the system is scanned for devices is not specified. The
196 * caller should not assume or rely on any specific order.
198 * @param driver The driver.
199 * @param options A list of struct sr_hwopt options to pass to the driver's
202 * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
203 * This list must be freed by the caller, but without freeing the data
204 * pointed to in the list.
206 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
210 return driver->scan(options);
216 SR_PRIV void sr_hw_cleanup_all(void)
219 struct sr_dev_driver **drivers;
221 drivers = sr_driver_list();
222 for (i = 0; drivers[i]; i++) {
223 if (drivers[i]->cleanup)
224 drivers[i]->cleanup();
229 * Returns information about the given driver or device instance.
231 * @param driver The sr_dev_driver struct to query.
232 * @param id The type of information, in the form of an SR_HWCAP_* option.
233 * @param data Pointer where the value. will be stored. Must not be NULL.
234 * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
236 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
237 * may be returned by the driver indicating it doesn't know that id,
238 * but this is not to be flagged as an error by the caller; merely
239 * as an indication that it's not applicable.
241 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
242 const void **data, const struct sr_dev_inst *sdi)
246 if (driver == NULL || data == NULL)
249 ret = driver->info_get(id, data, sdi);
255 * Find out if a hardware driver has a specific capability.
257 * @param driver The hardware driver in which to search for the capability.
258 * @param hwcap The capability to find in the list.
260 * @return TRUE if the specified capability exists in the specified driver,
261 * FALSE otherwise. Also, if 'driver' is NULL or the respective driver
262 * returns an invalid capability list, FALSE is returned.
264 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
270 sr_err("hwdriver: %s: driver was NULL", __func__);
274 if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
277 for (i = 0; hwcaps[i]; i++) {
278 if (hwcaps[i] == hwcap)
286 * Get information about a hardware driver option.
288 * @param opt The option to get.
290 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
293 SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt)
297 for (i = 0; sr_drvopts[i].hwcap; i++) {
298 if (sr_drvopts[i].hwcap == opt)
299 return &sr_drvopts[i];
306 * Get information about a hardware driver option, by name.
308 * @param optname The name of the option to get.
310 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
313 SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname)
317 for (i = 0; sr_drvopts[i].hwcap; i++) {
318 if (!strcmp(sr_drvopts[i].shortname, optname))
319 return &sr_drvopts[i];
326 * Get information about a device option.
328 * @param opt The option to get.
330 * @return A pointer to a struct sr_hwcap_option, or NULL if the option
333 SR_API const struct sr_hwcap_option *sr_devopt_get(int opt)
337 for (i = 0; sr_devopts[i].hwcap; i++) {
338 if (sr_devopts[i].hwcap == opt)
339 return &sr_devopts[i];
346 * Get information about a device option, by name.
348 * @param optname The name of 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_hwcap_option *sr_devopt_name_get(const char *optname)
357 for (i = 0; sr_devopts[i].hwcap; i++) {
358 if (!strcmp(sr_devopts[i].shortname, optname))
359 return &sr_devopts[i];
365 /* Unnecessary level of indirection follows. */
368 SR_PRIV int sr_source_remove(int fd)
370 return sr_session_source_remove(fd);
374 SR_PRIV int sr_source_add(int fd, int events, int timeout,
375 sr_receive_data_callback_t cb, void *cb_data)
377 return sr_session_source_add(fd, events, timeout, cb, cb_data);