/* * This file is part of the sigrok project. * * Copyright (C) 2010-2012 Bert Vermeulen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ #include "libsigrok.h" #include "libsigrok-internal.h" /** * @file * * Hardware driver handling in libsigrok. */ /** * @defgroup grp_driver Hardware drivers * * Hardware driver handling in libsigrok. * * @{ */ /* Driver scanning options. */ static struct sr_hwcap_option sr_drvopts[] = { {SR_HWOPT_MODEL, SR_T_KEYVALUE, "Model", "model"}, {SR_HWOPT_CONN, SR_T_CHAR, "Connection", "conn"}, {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "Serial communication", "serialcomm"}, {0, 0, NULL, NULL}, }; /* Device instance options. */ static struct sr_hwcap_option sr_devopts[] = { {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"}, {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"}, {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"}, {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"}, {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "Trigger slope", "triggerslope"}, {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "Trigger source", "triggersource"}, {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "Horizontal trigger position", "horiz_triggerpos"}, {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"}, {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"}, {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"}, {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"}, {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"}, {0, 0, NULL, NULL}, }; /** @cond PRIVATE */ #ifdef HAVE_LA_DEMO extern SR_PRIV struct sr_dev_driver demo_driver_info; #endif #ifdef HAVE_LA_OLS extern SR_PRIV struct sr_dev_driver ols_driver_info; #endif #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info; #endif #ifdef HAVE_LA_ASIX_SIGMA extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info; #endif #ifdef HAVE_LA_CHRONOVU_LA8 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; #endif #ifdef HAVE_LA_LINK_MSO19 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info; #endif #ifdef HAVE_LA_ALSA extern SR_PRIV struct sr_dev_driver alsa_driver_info; #endif #ifdef HAVE_LA_FX2LAFW extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info; #endif #ifdef HAVE_HW_HANTEK_DSO extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info; #endif #ifdef HAVE_HW_GENERICDMM extern SR_PRIV struct sr_dev_driver genericdmm_driver_info; #endif #ifdef HAVE_HW_AGILENT_DMM extern SR_PRIV struct sr_dev_driver agdmm_driver_info; #endif #ifdef HAVE_HW_FLUKE_DMM extern SR_PRIV struct sr_dev_driver flukedmm_driver_info; #endif #ifdef HAVE_HW_RADIOSHACK_DMM extern SR_PRIV struct sr_dev_driver radioshackdmm_driver_info; #endif #ifdef HAVE_HW_TEKPOWER_DMM extern SR_PRIV struct sr_dev_driver tekpower_dmm_driver_info; #endif #ifdef HAVE_HW_UNI_T_DMM extern SR_PRIV struct sr_dev_driver uni_t_dmm_driver_info; #endif /** @endcond */ static struct sr_dev_driver *drivers_list[] = { #ifdef HAVE_LA_DEMO &demo_driver_info, #endif #ifdef HAVE_LA_OLS &ols_driver_info, #endif #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE &zeroplus_logic_cube_driver_info, #endif #ifdef HAVE_LA_ASIX_SIGMA &asix_sigma_driver_info, #endif #ifdef HAVE_LA_CHRONOVU_LA8 &chronovu_la8_driver_info, #endif #ifdef HAVE_LA_LINK_MSO19 &link_mso19_driver_info, #endif #ifdef HAVE_LA_ALSA &alsa_driver_info, #endif #ifdef HAVE_LA_FX2LAFW &fx2lafw_driver_info, #endif #ifdef HAVE_HW_HANTEK_DSO &hantek_dso_driver_info, #endif #ifdef HAVE_HW_GENERICDMM &genericdmm_driver_info, #endif #ifdef HAVE_HW_AGILENT_DMM &agdmm_driver_info, #endif #ifdef HAVE_HW_FLUKE_DMM &flukedmm_driver_info, #endif #ifdef HAVE_HW_RADIOSHACK_DMM &radioshackdmm_driver_info, #endif #ifdef HAVE_HW_TEKPOWER_DMM &tekpower_dmm_driver_info, #endif #ifdef HAVE_HW_UNI_T_DMM &uni_t_dmm_driver_info, #endif NULL, }; /** * Return the list of supported hardware drivers. * * @return Pointer to the NULL-terminated list of hardware driver pointers. */ SR_API struct sr_dev_driver **sr_driver_list(void) { return drivers_list; } /** * Initialize a hardware driver. * * @param driver The driver to initialize. * * @return SR_OK if all went well, or an error code otherwise. */ SR_API int sr_driver_init(struct sr_dev_driver *driver) { if (driver->init) return driver->init(); return SR_OK; } /** * Tell a hardware driver to scan for devices. * * In addition to the detection, the devices that are found are also * initialized automatically. On some devices, this involves a firmware upload, * or other such measures. * * The order in which the system is scanned for devices is not specified. The * caller should not assume or rely on any specific order. * * @param driver The driver. * @param options A list of struct sr_hwopt options to pass to the driver's * scanner. * * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found. * This list must be freed by the caller, but without freeing the data * pointed to in the list. */ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) { if (driver->scan) return driver->scan(options); return NULL; } /** @private */ SR_PRIV void sr_hw_cleanup_all(void) { int i; struct sr_dev_driver **drivers; drivers = sr_driver_list(); for (i = 0; drivers[i]; i++) { if (drivers[i]->cleanup) drivers[i]->cleanup(); } } /** * Returns information about the given driver or device instance. * * @param driver The sr_dev_driver struct to query. * @param id The type of information, in the form of an SR_HWCAP_* option. * @param data Pointer where the value. will be stored. Must not be NULL. * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL. * * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG * may be returned by the driver indicating it doesn't know that id, * but this is not to be flagged as an error by the caller; merely * as an indication that it's not applicable. */ SR_API int sr_info_get(struct sr_dev_driver *driver, int id, const void **data, const struct sr_dev_inst *sdi) { int ret; if (driver == NULL || data == NULL) return SR_ERR; ret = driver->info_get(id, data, sdi); return ret; } /** * Find out if a hardware driver has a specific capability. * * @param driver The hardware driver in which to search for the capability. * @param hwcap The capability to find in the list. * * @return TRUE if the specified capability exists in the specified driver, * FALSE otherwise. Also, if 'driver' is NULL or the respective driver * returns an invalid capability list, FALSE is returned. */ SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) { const int *hwcaps; int i; if (!driver) { sr_err("hwdriver: %s: driver was NULL", __func__); return FALSE; } if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK) return FALSE; for (i = 0; hwcaps[i]; i++) { if (hwcaps[i] == hwcap) return TRUE; } return FALSE; } /** * Get information about a hardware driver option. * * @param opt The option to get. * * @return A pointer to a struct sr_hwcap_option, or NULL if the option * was not found. */ SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt) { int i; for (i = 0; sr_drvopts[i].hwcap; i++) { if (sr_drvopts[i].hwcap == opt) return &sr_drvopts[i]; } return NULL; } /** * Get information about a hardware driver option, by name. * * @param optname The name of the option to get. * * @return A pointer to a struct sr_hwcap_option, or NULL if the option * was not found. */ SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname) { int i; for (i = 0; sr_drvopts[i].hwcap; i++) { if (!strcmp(sr_drvopts[i].shortname, optname)) return &sr_drvopts[i]; } return NULL; } /** * Get information about a device option. * * @param opt The option to get. * * @return A pointer to a struct sr_hwcap_option, or NULL if the option * was not found. */ SR_API const struct sr_hwcap_option *sr_devopt_get(int opt) { int i; for (i = 0; sr_devopts[i].hwcap; i++) { if (sr_devopts[i].hwcap == opt) return &sr_devopts[i]; } return NULL; } /** * Get information about a device option, by name. * * @param optname The name of the option to get. * * @return A pointer to a struct sr_hwcap_option, or NULL if the option * was not found. */ SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname) { int i; for (i = 0; sr_devopts[i].hwcap; i++) { if (!strcmp(sr_devopts[i].shortname, optname)) return &sr_devopts[i]; } return NULL; } /* Unnecessary level of indirection follows. */ /** @private */ SR_PRIV int sr_source_remove(int fd) { return sr_session_source_remove(fd); } /** @private */ SR_PRIV int sr_source_add(int fd, int events, int timeout, sr_receive_data_callback_t cb, void *cb_data) { return sr_session_source_add(fd, events, timeout, cb, cb_data); } /** @} */