X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hwdriver.c;h=8b23aea388eff40935fb853fb3fa5b0bac557e86;hb=c51bbdec345b0d7e1c9013e0a1bea2586cf6daa7;hp=3b1718d31adc00bf1be7f7539440582b509ce5cc;hpb=d375b3c3ec01c246dbf6f0827c33aafc0953431b;p=libsigrok.git diff --git a/hwdriver.c b/hwdriver.c index 3b1718d3..8b23aea3 100644 --- a/hwdriver.c +++ b/hwdriver.c @@ -1,7 +1,7 @@ /* - * This file is part of the sigrok project. + * This file is part of the libsigrok project. * - * Copyright (C) 2010-2012 Bert Vermeulen + * Copyright (C) 2013 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 @@ -23,115 +23,286 @@ #include #include #include +#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ #include "libsigrok.h" #include "libsigrok-internal.h" +/* Message logging helpers with subsystem-specific prefix string. */ +#define LOG_PREFIX "hwdriver: " +#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args) +#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args) +#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args) +#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args) +#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args) +#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args) -/* 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}, -}; +/** + * @file + * + * Hardware driver handling in libsigrok. + */ -/* 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}, +/** + * @defgroup grp_driver Hardware drivers + * + * Hardware driver handling in libsigrok. + * + * @{ + */ + +static struct sr_config_info sr_config_info_data[] = { + {SR_CONF_CONN, SR_T_CHAR, "conn", + "Connection", NULL}, + {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm", + "Serial communication", NULL}, + {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate", + "Sample rate", NULL}, + {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", + "Pre-trigger capture ratio", NULL}, + {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern", + "Pattern generator mode", NULL}, + {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype", + "Trigger types", NULL}, + {SR_CONF_RLE, SR_T_BOOL, "rle", + "Run Length Encoding", NULL}, + {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope", + "Trigger slope", NULL}, + {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource", + "Trigger source", NULL}, + {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", + "Horizontal trigger position", NULL}, + {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize", + "Buffer size", NULL}, + {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", + "Time base", NULL}, + {SR_CONF_FILTER, SR_T_CHAR, "filter", + "Filter targets", NULL}, + {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv", + "Volts/div", NULL}, + {SR_CONF_COUPLING, SR_T_CHAR, "coupling", + "Coupling", NULL}, + {SR_CONF_DATALOG, SR_T_BOOL, "datalog", + "Datalog", NULL}, + {SR_CONF_SPL_WEIGHT_FREQ, SR_T_CHAR, "spl_weight_freq", + "Sound pressure level frequency weighting", NULL}, + {SR_CONF_SPL_WEIGHT_TIME, SR_T_CHAR, "spl_weight_time", + "Sound pressure level time weighting", NULL}, + {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max", + "Hold max", NULL}, + {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min", + "Hold min", NULL}, + {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range", + "Sound pressure level measurement range", NULL}, + {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off", + "Power off", NULL}, + {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source", + "Data source", NULL}, + {0, 0, NULL, NULL, NULL}, }; -#ifdef HAVE_LA_DEMO +/** @cond PRIVATE */ +#ifdef HAVE_HW_BRYMEN_DMM +extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info; +#endif +#ifdef HAVE_HW_CEM_DT_885X +extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info; +#endif +#ifdef HAVE_HW_COLEAD_SLM +extern SR_PRIV struct sr_dev_driver colead_slm_driver_info; +#endif +#ifdef HAVE_HW_DEMO extern SR_PRIV struct sr_dev_driver demo_driver_info; #endif -#ifdef HAVE_LA_OLS +#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2 +extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info; +#endif +#ifdef HAVE_HW_IKALOGIC_SCANAPLUS +extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info; +#endif +#ifdef HAVE_HW_KECHENG_KC_330B +extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info; +#endif +#ifdef HAVE_HW_LASCAR_EL_USB +extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info; +#endif +#ifdef HAVE_HW_MIC_985XX +extern SR_PRIV struct sr_dev_driver mic_98581_driver_info; +extern SR_PRIV struct sr_dev_driver mic_98583_driver_info; +#endif +#ifdef HAVE_HW_OLS extern SR_PRIV struct sr_dev_driver ols_driver_info; #endif -#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE +#ifdef HAVE_HW_RIGOL_DS1XX2 +extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info; +#endif +#ifdef HAVE_HW_TONDAJ_SL_814 +extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info; +#endif +#ifdef HAVE_HW_VICTOR_DMM +extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info; +#endif +#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info; #endif -#ifdef HAVE_LA_ASIX_SIGMA +#ifdef HAVE_HW_ASIX_SIGMA extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info; #endif -#ifdef HAVE_LA_CHRONOVU_LA8 +#ifdef HAVE_HW_CHRONOVU_LA8 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; #endif -#ifdef HAVE_LA_LINK_MSO19 +#ifdef HAVE_HW_LINK_MSO19 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info; #endif -#ifdef HAVE_LA_ALSA +#ifdef HAVE_HW_ALSA extern SR_PRIV struct sr_dev_driver alsa_driver_info; #endif -#ifdef HAVE_LA_FX2LAFW +#ifdef HAVE_HW_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; +#ifdef HAVE_HW_SERIAL_DMM +extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info; +extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info; +extern SR_PRIV struct sr_dev_driver metex_me31_driver_info; +extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info; +extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info; +extern SR_PRIV struct sr_dev_driver va_va18b_driver_info; +extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info; +extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info; +extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info; +extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info; +extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info; +extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info; +extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info; +#endif +#ifdef HAVE_HW_UNI_T_DMM +extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info; #endif +/** @endcond */ static struct sr_dev_driver *drivers_list[] = { -#ifdef HAVE_LA_DEMO +#ifdef HAVE_HW_BRYMEN_DMM + &brymen_bm857_driver_info, +#endif +#ifdef HAVE_HW_CEM_DT_885X + &cem_dt_885x_driver_info, +#endif +#ifdef HAVE_HW_COLEAD_SLM + &colead_slm_driver_info, +#endif +#ifdef HAVE_HW_DEMO &demo_driver_info, #endif -#ifdef HAVE_LA_OLS +#ifdef HAVE_HW_IKALOGIC_SCANALOGIC2 + &ikalogic_scanalogic2_driver_info, +#endif +#ifdef HAVE_HW_IKALOGIC_SCANAPLUS + &ikalogic_scanaplus_driver_info, +#endif +#ifdef HAVE_HW_KECHENG_KC_330B + &kecheng_kc_330b_driver_info, +#endif +#ifdef HAVE_HW_LASCAR_EL_USB + &lascar_el_usb_driver_info, +#endif +#ifdef HAVE_HW_MIC_985XX + &mic_98581_driver_info, + &mic_98583_driver_info, +#endif +#ifdef HAVE_HW_OLS &ols_driver_info, #endif -#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE +#ifdef HAVE_HW_RIGOL_DS1XX2 + &rigol_ds1xx2_driver_info, +#endif +#ifdef HAVE_HW_TONDAJ_SL_814 + &tondaj_sl_814_driver_info, +#endif +#ifdef HAVE_HW_VICTOR_DMM + &victor_dmm_driver_info, +#endif +#ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE &zeroplus_logic_cube_driver_info, #endif -#ifdef HAVE_LA_ASIX_SIGMA +#ifdef HAVE_HW_ASIX_SIGMA &asix_sigma_driver_info, #endif -#ifdef HAVE_LA_CHRONOVU_LA8 +#ifdef HAVE_HW_CHRONOVU_LA8 &chronovu_la8_driver_info, #endif -#ifdef HAVE_LA_LINK_MSO19 +#ifdef HAVE_HW_LINK_MSO19 &link_mso19_driver_info, #endif -#ifdef HAVE_LA_ALSA +#ifdef HAVE_HW_ALSA &alsa_driver_info, #endif -#ifdef HAVE_LA_FX2LAFW +#ifdef HAVE_HW_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, +#ifdef HAVE_HW_SERIAL_DMM + &digitek_dt4000zc_driver_info, + &tekpower_tp4000zc_driver_info, + &metex_me31_driver_info, + &peaktech_3410_driver_info, + &mastech_mas345_driver_info, + &va_va18b_driver_info, + &metex_m3640d_driver_info, + &peaktech_4370_driver_info, + &pce_pce_dm32_driver_info, + &radioshack_22_168_driver_info, + &radioshack_22_805_driver_info, + &radioshack_22_812_driver_info, + &tecpel_dmm_8061_ser_driver_info, + &voltcraft_m3650d_driver_info, + &voltcraft_vc820_ser_driver_info, + &voltcraft_vc830_ser_driver_info, + &voltcraft_vc840_ser_driver_info, + &uni_t_ut60a_ser_driver_info, + &uni_t_ut60e_ser_driver_info, + &uni_t_ut61d_ser_driver_info, + &uni_t_ut61e_ser_driver_info, +#endif +#ifdef HAVE_HW_UNI_T_DMM + &tecpel_dmm_8061_driver_info, + &uni_t_ut60a_driver_info, + &uni_t_ut60e_driver_info, + &uni_t_ut61d_driver_info, + &uni_t_ut61e_driver_info, + &voltcraft_vc820_driver_info, + &voltcraft_vc830_driver_info, + &voltcraft_vc840_driver_info, #endif NULL, }; @@ -150,17 +321,38 @@ SR_API struct sr_dev_driver **sr_driver_list(void) /** * Initialize a hardware driver. * - * @param driver The driver to initialize. + * This usually involves memory allocations and variable initializations + * within the driver, but _not_ scanning for attached devices. + * The API call sr_driver_scan() is used for that. + * + * @param ctx A libsigrok context object allocated by a previous call to + * sr_init(). Must not be NULL. + * @param driver The driver to initialize. This must be a pointer to one of + * the entries returned by sr_driver_list(). Must not be NULL. * - * @return SR_OK if all went well, or an error code otherwise. + * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters, + * SR_ERR_BUG upon internal errors, or another negative error code + * upon other errors. */ -SR_API int sr_driver_init(struct sr_dev_driver *driver) +SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) { + int ret; - if (driver->init) - return driver->init(); + if (!ctx) { + sr_err("Invalid libsigrok context, can't initialize."); + return SR_ERR_ARG; + } + + if (!driver) { + sr_err("Invalid driver, can't initialize."); + return SR_ERR_ARG; + } + + sr_spew("Initializing driver '%s'.", driver->name); + if ((ret = driver->init(ctx)) < 0) + sr_err("Failed to initialize the driver: %d.", ret); - return SR_OK; + return ret; } /** @@ -173,23 +365,42 @@ SR_API int sr_driver_init(struct sr_dev_driver *driver) * 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. + * Before calling sr_driver_scan(), the user must have previously initialized + * the driver by calling sr_driver_init(). * - * @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. + * @param driver The driver that should scan. This must be a pointer to one of + * the entries returned by sr_driver_list(). Must not be NULL. + * @param options A list of 'struct sr_hwopt' options to pass to the driver's + * scanner. Can be NULL/empty. + * + * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were + * found (or errors were encountered). This list must be freed by the + * caller using g_slist_free(), but without freeing the data pointed + * to in the list. */ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) { + GSList *l; + + if (!driver) { + sr_err("Invalid driver, can't scan for devices."); + return NULL; + } - if (driver->scan) - return driver->scan(options); + if (!driver->priv) { + sr_err("Driver not initialized, can't scan for devices."); + return NULL; + } - return NULL; + l = driver->scan(options); + + sr_spew("Scan of '%s' found %d devices.", driver->name, + g_slist_length(l)); + + return l; } +/** @private */ SR_PRIV void sr_hw_cleanup_all(void) { int i; @@ -202,138 +413,171 @@ SR_PRIV void sr_hw_cleanup_all(void) } } +/** A floating reference can be passed in for data. */ +SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data) +{ + struct sr_config *src; + + if (!(src = g_try_malloc(sizeof(struct sr_config)))) + return NULL; + src->key = key; + src->data = g_variant_ref_sink(data); + + return src; +} + +SR_PRIV void sr_config_free(struct sr_config *src) +{ + + if (!src || !src->data) { + sr_err("%s: invalid data!", __func__); + return; + } + + g_variant_unref(src->data); + g_free(src); + +} + /** * 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. + * @param key The configuration key (SR_CONF_*). + * @param data Pointer to a GVariant where the value will be stored. Must + * not be NULL. The caller is given ownership of the GVariant + * and must thus decrease the refcount after use. However if + * this function returns an error code, the field should be + * considered unused, and should not be unreferenced. + * @param sdi (optional) If the key is specific to a device, this must + * contain a pointer to the struct sr_dev_inst to be checked. + * Otherwise it must 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, + * may be returned by the driver indicating it doesn't know that key, * 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) +SR_API int sr_config_get(const struct sr_dev_driver *driver, int key, + GVariant **data, const struct sr_dev_inst *sdi) { int ret; - if (driver == NULL || data == NULL) + if (!driver || !data) return SR_ERR; - ret = driver->info_get(id, data, sdi); + if (!driver->config_get) + return SR_ERR_ARG; + + if ((ret = driver->config_get(key, data, sdi)) == SR_OK) { + /* Got a floating reference from the driver. Sink it here, + * caller will need to unref when done with it. */ + g_variant_ref_sink(*data); + } return ret; } /** - * Find out if a hardware driver has a specific capability. + * Set a configuration key in a device instance. * - * @param driver The hardware driver in which to search for the capability. - * @param hwcap The capability to find in the list. + * @param sdi The device instance. + * @param key The configuration key (SR_CONF_*). + * @param data The new value for the key, as a GVariant with GVariantType + * appropriate to that key. A floating reference can be passed + * in; its refcount will be sunk and unreferenced after use. * - * @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. + * @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 key, + * but this is not to be flagged as an error by the caller; merely + * as an indication that it's not applicable. */ -SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) +SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data) { - 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; - } + int ret; - return FALSE; -} + g_variant_ref_sink(data); -/** - * 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; + if (!sdi || !sdi->driver || !data) + ret = SR_ERR; + else if (!sdi->driver->config_set) + ret = SR_ERR_ARG; + else + ret = sdi->driver->config_set(key, data, sdi); - for (i = 0; sr_drvopts[i].hwcap; i++) { - if (sr_drvopts[i].hwcap == opt) - return &sr_drvopts[i]; - } + g_variant_unref(data); - return NULL; + return ret; } /** - * Get information about a hardware driver option, by name. + * List all possible values for a configuration key. * - * @param optname The name of the option to get. + * @param driver The sr_dev_driver struct to query. + * @param key The configuration key (SR_CONF_*). + * @param data A pointer to a GVariant where the list will be stored. The + * caller is given ownership of the GVariant and must thus + * unref the GVariant after use. However if this function + * returns an error code, the field should be considered + * unused, and should not be unreferenced. + * @param sdi (optional) If the key is specific to a device, this must + * contain a pointer to the struct sr_dev_inst to be checked. * - * @return A pointer to a struct sr_hwcap_option, or NULL if the option - * was not found. + * @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 key, + * but this is not to be flagged as an error by the caller; merely + * as an indication that it's not applicable. */ -SR_API const struct sr_hwcap_option *sr_drvopt_name_get(const char *optname) +SR_API int sr_config_list(const struct sr_dev_driver *driver, int key, + GVariant **data, const struct sr_dev_inst *sdi) { - int i; + int ret; - for (i = 0; sr_drvopts[i].hwcap; i++) { - if (!strcmp(sr_drvopts[i].shortname, optname)) - return &sr_drvopts[i]; - } + if (!driver || !data) + ret = SR_ERR; + else if (!driver->config_list) + ret = SR_ERR_ARG; + else if ((ret = driver->config_list(key, data, sdi)) == SR_OK) + g_variant_ref_sink(*data); - return NULL; + return ret; } /** - * Get information about a device option. + * Get information about a configuration key. * - * @param opt The option to get. + * @param key The configuration key. * - * @return A pointer to a struct sr_hwcap_option, or NULL if the option + * @return A pointer to a struct sr_config_info, or NULL if the key * was not found. */ -SR_API const struct sr_hwcap_option *sr_devopt_get(int opt) +SR_API const struct sr_config_info *sr_config_info_get(int key) { int i; - for (i = 0; sr_devopts[i].hwcap; i++) { - if (sr_devopts[i].hwcap == opt) - return &sr_devopts[i]; + for (i = 0; sr_config_info_data[i].key; i++) { + if (sr_config_info_data[i].key == key) + return &sr_config_info_data[i]; } return NULL; } /** - * Get information about a device option, by name. + * Get information about an configuration key, by name. * - * @param optname The name of the option to get. + * @param optname The configuration key. * - * @return A pointer to a struct sr_hwcap_option, or NULL if the option + * @return A pointer to a struct sr_config_info, or NULL if the key * was not found. */ -SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname) +SR_API const struct sr_config_info *sr_config_info_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]; + for (i = 0; sr_config_info_data[i].key; i++) { + if (!strcmp(sr_config_info_data[i].id, optname)) + return &sr_config_info_data[i]; } return NULL; @@ -341,13 +585,17 @@ SR_API const struct sr_hwcap_option *sr_devopt_name_get(const char *optname) /* 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); } + +/** @} */