X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=hwdriver.c;h=364d97bd471a72141a0de46ec11c882e88d1b12c;hb=144f6660d004d60264a57db7150ed90e5f68ea77;hp=9b0df152b9d3e38bb3a002e8b497a855a6011d24;hpb=cfe064d8e74d86ab6a65779663ca1fb82e36260a;p=libsigrok.git diff --git a/hwdriver.c b/hwdriver.c index 9b0df152..fee0dd08 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,77 +23,421 @@ #include #include #include -#include "sigrok.h" -#include "sigrok-internal.h" +#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ +#include "libsigrok.h" +#include "libsigrok-internal.h" -/* - * This enumerates which driver capabilities correspond to user-settable - * options. +/** @cond PRIVATE */ +#define LOG_PREFIX "hwdriver" +/** @endcond */ + +/** + * @file + * + * Hardware driver handling in libsigrok. + */ + +/** + * @defgroup grp_driver Hardware drivers + * + * Hardware driver handling in libsigrok. + * + * @{ */ -/* TODO: This shouldn't be a global. */ -SR_API struct sr_hwcap_option sr_hwcap_options[] = { - {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", "patternmode"}, - {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"}, - {0, 0, NULL, NULL}, + +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", NULL}, + {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype", + "Trigger types", NULL}, + {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock", + "External clock mode", NULL}, + {SR_CONF_SWAP, SR_T_BOOL, "swap", + "Swap channel order", NULL}, + {SR_CONF_RLE, SR_T_BOOL, "rle", + "Run Length Encoding", NULL}, + {SR_CONF_TRIGGER_SLOPE, SR_T_CHAR, "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_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold", + "Voltage threshold", 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}, + {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels", + "Number of logic channels", NULL}, + {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels", + "Number of analog channels", NULL}, + {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage", + "Current output voltage", NULL}, + {SR_CONF_OUTPUT_VOLTAGE_MAX, SR_T_FLOAT, "output_voltage_max", + "Maximum output voltage", NULL}, + {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current", + "Current output current", NULL}, + {SR_CONF_OUTPUT_CURRENT_MAX, SR_T_FLOAT, "output_current_max", + "Maximum output current", NULL}, + {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled", + "Output enabled", NULL}, + {SR_CONF_OUTPUT_CHANNEL, SR_T_CHAR, "output_channel", + "Output channel modes", NULL}, + {SR_CONF_OVER_VOLTAGE_PROTECTION, SR_T_BOOL, "ovp", + "Over-voltage protection", NULL}, + {SR_CONF_OVER_CURRENT_PROTECTION, SR_T_BOOL, "ocp", + "Over-current protection", NULL}, + {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples", + "Sample limit", NULL}, + {SR_CONF_CLOCK_EDGE, SR_T_CHAR, "clock_edge", + "Clock edge", NULL}, + {0, 0, NULL, NULL, NULL}, }; -#ifdef HAVE_LA_DEMO +/** @cond PRIVATE */ +#ifdef HAVE_HW_APPA_55II +extern SR_PRIV struct sr_dev_driver appa_55ii_driver_info; +#endif +#ifdef HAVE_HW_ATTEN_PPS3XXX +extern SR_PRIV struct sr_dev_driver atten_pps3203_driver_info; +#endif +#ifdef HAVE_HW_BRYMEN_BM86X +extern SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info; +#endif +#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_CENTER_3XX +extern SR_PRIV struct sr_dev_driver center_309_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info; +#endif +#ifdef HAVE_HW_COLEAD_SLM +extern SR_PRIV struct sr_dev_driver colead_slm_driver_info; +#endif +#ifdef HAVE_HW_CONRAD_DIGI_35_CPU +extern SR_PRIV struct sr_dev_driver conrad_digi_35_cpu_driver_info; +#endif +#ifdef HAVE_HW_DEMO extern SR_PRIV struct sr_dev_driver demo_driver_info; #endif -#ifdef HAVE_LA_SALEAE_LOGIC -extern SR_PRIV struct sr_dev_driver saleae_logic_driver_info; +#ifdef HAVE_HW_GMC_MH_1X_2X +extern SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info; +extern SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info; #endif -#ifdef HAVE_LA_OLS +#ifdef HAVE_HW_HAMEG_HMO +extern SR_PRIV struct sr_dev_driver hameg_hmo_driver_info; +#endif +#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_NORMA_DMM +extern SR_PRIV struct sr_dev_driver norma_dmm_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_DS +extern SR_PRIV struct sr_dev_driver rigol_ds_driver_info; +#endif +#ifdef HAVE_HW_SALEAE_LOGIC16 +extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info; +#endif +#ifdef HAVE_HW_SYSCLK_LWLA +extern SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info; +#endif +#ifdef HAVE_HW_TELEINFO +extern SR_PRIV struct sr_dev_driver teleinfo_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_UNI_T_UT32X +extern SR_PRIV struct sr_dev_driver uni_t_ut32x_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 -extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; +#ifdef HAVE_HW_CHRONOVU_LA +extern SR_PRIV struct sr_dev_driver chronovu_la_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_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_SERIAL_DMM +extern SR_PRIV struct sr_dev_driver bbcgm_m2110_driver_info; +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 va_va40b_driver_info; +extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info; +extern SR_PRIV struct sr_dev_driver metex_m4650cr_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_m3650cr_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_me42_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_ut60g_ser_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut61b_ser_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut61c_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; +extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info; +extern SR_PRIV struct sr_dev_driver tenma_72_7745_ser_driver_info; +extern SR_PRIV struct sr_dev_driver tenma_72_7750_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_ut60g_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut61b_driver_info; +extern SR_PRIV struct sr_dev_driver uni_t_ut61c_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; +extern SR_PRIV struct sr_dev_driver tenma_72_7745_driver_info; +extern SR_PRIV struct sr_dev_driver tenma_72_7750_driver_info; +#endif +/** @endcond */ static struct sr_dev_driver *drivers_list[] = { -#ifdef HAVE_LA_DEMO +#ifdef HAVE_HW_APPA_55II + &appa_55ii_driver_info, +#endif +#ifdef HAVE_HW_ATTEN_PPS3XXX + &atten_pps3203_driver_info, +#endif +#ifdef HAVE_HW_BRYMEN_BM86X + &brymen_bm86x_driver_info, +#endif +#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_CENTER_3XX + ¢er_309_driver_info, + &voltcraft_k204_driver_info, +#endif +#ifdef HAVE_HW_COLEAD_SLM + &colead_slm_driver_info, +#endif +#ifdef HAVE_HW_CONRAD_DIGI_35_CPU + &conrad_digi_35_cpu_driver_info, +#endif +#ifdef HAVE_HW_DEMO &demo_driver_info, #endif -#ifdef HAVE_LA_SALEAE_LOGIC - &saleae_logic_driver_info, +#ifdef HAVE_HW_GMC_MH_1X_2X + &gmc_mh_1x_2x_rs232_driver_info, + &gmc_mh_2x_bd232_driver_info, +#endif +#ifdef HAVE_HW_HAMEG_HMO + &hameg_hmo_driver_info, +#endif +#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_NORMA_DMM + &norma_dmm_driver_info, #endif -#ifdef HAVE_LA_OLS +#ifdef HAVE_HW_OLS &ols_driver_info, #endif -#ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE +#ifdef HAVE_HW_RIGOL_DS + &rigol_ds_driver_info, +#endif +#ifdef HAVE_HW_SALEAE_LOGIC16 + &saleae_logic16_driver_info, +#endif +#ifdef HAVE_HW_SYSCLK_LWLA + &sysclk_lwla_driver_info, +#endif +#ifdef HAVE_HW_TELEINFO + &teleinfo_driver_info, +#endif +#ifdef HAVE_HW_TONDAJ_SL_814 + &tondaj_sl_814_driver_info, +#endif +#ifdef HAVE_HW_UNI_T_UT32X + &uni_t_ut32x_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 - &chronovu_la8_driver_info, +#ifdef HAVE_HW_CHRONOVU_LA + &chronovu_la_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_AGILENT_DMM + &agdmm_driver_info, +#endif +#ifdef HAVE_HW_FLUKE_DMM + &flukedmm_driver_info, +#endif +#ifdef HAVE_HW_SERIAL_DMM + &bbcgm_m2110_driver_info, + &digitek_dt4000zc_driver_info, + &tekpower_tp4000zc_driver_info, + &metex_me31_driver_info, + &peaktech_3410_driver_info, + &mastech_mas345_driver_info, + &va_va18b_driver_info, + &va_va40b_driver_info, + &metex_m3640d_driver_info, + &metex_m4650cr_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_m3650cr_driver_info, + &voltcraft_m3650d_driver_info, + &voltcraft_m4650cr_driver_info, + &voltcraft_me42_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_ut60g_ser_driver_info, + &uni_t_ut61b_ser_driver_info, + &uni_t_ut61c_ser_driver_info, + &uni_t_ut61d_ser_driver_info, + &uni_t_ut61e_ser_driver_info, + &iso_tech_idm103n_driver_info, + &tenma_72_7745_ser_driver_info, + &tenma_72_7750_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_ut60g_driver_info, + &uni_t_ut61b_driver_info, + &uni_t_ut61c_driver_info, + &uni_t_ut61d_driver_info, + &uni_t_ut61e_driver_info, + &voltcraft_vc820_driver_info, + &voltcraft_vc830_driver_info, + &voltcraft_vc840_driver_info, + &tenma_72_7745_driver_info, + &tenma_72_7750_driver_info, #endif NULL, }; @@ -105,49 +449,95 @@ static struct sr_dev_driver *drivers_list[] = { */ SR_API struct sr_dev_driver **sr_driver_list(void) { + return drivers_list; } /** * Initialize a hardware driver. * - * The specified driver is initialized, and all devices discovered by the - * driver are instantiated. + * 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. + * + * @retval SR_OK Success + * @retval SR_ERR_ARG Invalid parameter(s). + * @retval SR_ERR_BUG Internal errors. + * @retval other Another negative error code upon other errors. + */ +SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) +{ + int ret; + + 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 ret; +} + +/** + * 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 to initialize. + * Before calling sr_driver_scan(), the user must have previously initialized + * the driver by calling sr_driver_init(). * - * @return The number of devices found and instantiated by the driver. + * @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 int sr_driver_init(struct sr_dev_driver *driver) +SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) { - int num_devs, num_probes, i, j; - int num_initialized_devs = 0; - struct sr_dev *dev; - char **probe_names; - - sr_dbg("initializing %s driver", driver->name); - num_devs = driver->init(NULL); - for (i = 0; i < num_devs; i++) { - num_probes = GPOINTER_TO_INT( - driver->dev_info_get(i, SR_DI_NUM_PROBES)); - probe_names = (char **)driver->dev_info_get(i, - SR_DI_PROBE_NAMES); - - if (!probe_names) { - sr_warn("hwdriver: %s: driver %s does not return a " - "list of probe names", __func__, driver->name); - continue; - } - - dev = sr_dev_new(driver, i); - for (j = 0; j < num_probes; j++) - sr_dev_probe_add(dev, probe_names[j]); - num_initialized_devs++; + GSList *l; + + if (!driver) { + sr_err("Invalid driver, can't scan for devices."); + return NULL; } - return num_initialized_devs; + if (!driver->priv) { + sr_err("Driver not initialized, can't scan for devices."); + return NULL; + } + + l = driver->scan(options); + + sr_spew("Scan of '%s' found %d devices.", driver->name, + g_slist_length(l)); + + return l; } +/** Call driver cleanup function for all drivers. + * @private */ SR_PRIV void sr_hw_cleanup_all(void) { int i; @@ -160,162 +550,235 @@ SR_PRIV void sr_hw_cleanup_all(void) } } -SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, - const char *vendor, const char *model, const char *version) +/** Allocate struct sr_config. + * A floating reference can be passed in for data. + * @private + */ +SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data) { - struct sr_dev_inst *sdi; + struct sr_config *src; - if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) { - sr_err("hwdriver: %s: sdi malloc failed", __func__); + if (!(src = g_try_malloc(sizeof(struct sr_config)))) return NULL; - } - - sdi->index = index; - sdi->status = status; - sdi->inst_type = -1; - sdi->vendor = vendor ? g_strdup(vendor) : NULL; - sdi->model = model ? g_strdup(model) : NULL; - sdi->version = version ? g_strdup(version) : NULL; - sdi->priv = NULL; + src->key = key; + src->data = g_variant_ref_sink(data); - return sdi; + return src; } -SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index) +/** Free struct sr_config. + * @private + */ +SR_PRIV void sr_config_free(struct sr_config *src) { - struct sr_dev_inst *sdi; - GSList *l; - for (l = dev_insts; l; l = l->next) { - sdi = (struct sr_dev_inst *)(l->data); - if (sdi->index == dev_index) - return sdi; + if (!src || !src->data) { + sr_err("%s: invalid data!", __func__); + return; } - sr_warn("could not find device index %d instance", dev_index); - return NULL; + g_variant_unref(src->data); + g_free(src); + } -SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) +/** + * Query value of a configuration key at the given driver or device instance. + * + * @param[in] driver The sr_dev_driver struct to query. + * @param[in] 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. + * @param[in] cg The channel group on the device for which to list the + * values, or NULL. + * @param[in] key The configuration key (SR_CONF_*). + * @param[in,out] 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. + * + * @retval SR_OK Success. + * @retval SR_ERR Error. + * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be + * interpreted as an error by the caller; merely as an indication + * that it's not applicable. + */ +SR_API int sr_config_get(const struct sr_dev_driver *driver, + const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg, + int key, GVariant **data) { - g_free(sdi->priv); - g_free(sdi->vendor); - g_free(sdi->model); - g_free(sdi->version); - g_free(sdi); -} + int ret; -#ifdef HAVE_LIBUSB_1_0 + if (!driver || !data) + return SR_ERR; -SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, - uint8_t address, struct libusb_device_handle *hdl) -{ - struct sr_usb_dev_inst *udi; + if (!driver->config_get) + return SR_ERR_ARG; - if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { - sr_err("hwdriver: %s: udi malloc failed", __func__); - return NULL; + if ((ret = driver->config_get(key, data, sdi, cg)) == 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); } - udi->bus = bus; - udi->address = address; - udi->devhdl = hdl; /* TODO: Check if this is NULL? */ - - return udi; + return ret; } -SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) +/** + * Set value of a configuration key in a device instance. + * + * @param[in] sdi The device instance. + * @param[in] cg The channel group on the device for which to list the + * values, or NULL. + * @param[in] 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. + * + * @retval SR_OK Success. + * @retval SR_ERR Error. + * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be + * interpreted as an error by the caller; merely as an indication + * that it's not applicable. + */ +SR_API int sr_config_set(const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg, + int key, GVariant *data) { - /* Avoid compiler warnings. */ - (void)usb; + int ret; - /* Nothing to do for this device instance type. */ -} + g_variant_ref_sink(data); -#endif + 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, cg); -SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, - int fd) -{ - struct sr_serial_dev_inst *serial; + g_variant_unref(data); - if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) { - sr_err("hwdriver: %s: serial malloc failed", __func__); - return NULL; - } - - serial->port = g_strdup(port); - serial->fd = fd; - - return serial; + return ret; } -SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) +/** + * Apply configuration settings to the device hardware. + * + * @param sdi The device instance. + * + * @return SR_OK upon success or SR_ERR in case of error. + */ +SR_API int sr_config_commit(const struct sr_dev_inst *sdi) { - g_free(serial->port); + int ret; + + if (!sdi || !sdi->driver) + ret = SR_ERR; + else if (!sdi->driver->config_commit) + ret = SR_OK; + else + ret = sdi->driver->config_commit(sdi); + + return ret; } /** - * Find out if a hardware driver has a specific capability. + * List all possible values for a configuration key. * - * @param driver The hardware driver in which to search for the capability. - * @param hwcap The capability to find in the list. + * @param[in] driver The sr_dev_driver struct to query. + * @param[in] sdi (optional) If the key is specific to a device, this must + * contain a pointer to the struct sr_dev_inst to be checked. + * @param[in] cg The channel group on the device for which to list the + * values, or NULL. + * @param[in] key The configuration key (SR_CONF_*). + * @param[in,out] 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. * - * @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. + * @retval SR_OK Success. + * @retval SR_ERR Error. + * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be + * interpreted 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_list(const struct sr_dev_driver *driver, + const struct sr_dev_inst *sdi, + const struct sr_channel_group *cg, + int key, GVariant **data) { - int *hwcaps, i; + int ret; - if (!driver) { - sr_err("hwdriver: %s: driver was NULL", __func__); - return FALSE; - } + if (!driver || !data) + ret = SR_ERR; + else if (!driver->config_list) + ret = SR_ERR_ARG; + else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) + g_variant_ref_sink(*data); - if (!(hwcaps = driver->hwcap_get_all())) { - sr_err("hwdriver: %s: hwcap_get_all() returned NULL", __func__); - return FALSE; - } + return ret; +} - for (i = 0; hwcaps[i]; i++) { - if (hwcaps[i] == hwcap) - return TRUE; +/** + * Get information about a configuration key, by key. + * + * @param[in] key The configuration key. + * + * @return A pointer to a struct sr_config_info, or NULL if the key + * was not found. + */ +SR_API const struct sr_config_info *sr_config_info_get(int key) +{ + int 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 FALSE; + return NULL; } /** - * Get a hardware driver capability option. + * Get information about a configuration key, by name. * - * @param hwcap The capability to get. + * @param[in] optname The configuration key. * - * @return A pointer to a struct with information about the parameter, or NULL - * if the capability was not found. + * @return A pointer to a struct sr_config_info, or NULL if the key + * was not found. */ -SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap) +SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) { int i; - for (i = 0; sr_hwcap_options[i].hwcap; i++) { - if (sr_hwcap_options[i].hwcap == hwcap) - return &sr_hwcap_options[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; } -/* unnecessary level of indirection follows. */ +/* Unnecessary level of indirection follows. */ -SR_PRIV void sr_source_remove(int fd) +/** @private + * @see sr_session_source_remove() + */ +SR_PRIV int sr_source_remove(int fd) { - sr_session_source_remove(fd); + return sr_session_source_remove(fd); } -SR_PRIV void sr_source_add(int fd, int events, int timeout, - sr_receive_data_callback rcv_cb, void *user_data) +/** @private + * @see sr_session_source_add() + */ +SR_PRIV int sr_source_add(int fd, int events, int timeout, + sr_receive_data_callback cb, void *cb_data) { - sr_session_source_add(fd, events, timeout, rcv_cb, user_data); + return sr_session_source_add(fd, events, timeout, cb, cb_data); } + +/** @} */