X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hwdriver.c;h=995d24fe231e5ea9f5fb21b8d3cd260198e023a1;hb=e6b2b4df9dcfaf9eb6fa10f94e0aa5e039230e21;hp=def770e993705e09f277c4b79080f13edf4035e6;hpb=bd36d826d4b9916034c6268919e2a72a0d7ea000;p=libsigrok.git diff --git a/hwdriver.c b/hwdriver.c index def770e9..995d24fe 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 @@ -61,6 +61,8 @@ static struct sr_config_info sr_config_info_data[] = { "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", @@ -79,10 +81,15 @@ static struct sr_config_info sr_config_info_data[] = { "Volts/div", NULL}, {SR_CONF_COUPLING, SR_T_CHAR, "coupling", "Coupling", NULL}, + {SR_CONF_DATALOG, SR_T_BOOL, "datalog", + "Datalog", NULL}, {0, 0, NULL, NULL, NULL}, }; /** @cond PRIVATE */ +#ifdef HAVE_HW_BRYMEN_DMM +extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info; +#endif #ifdef HAVE_HW_COLEAD_SLM extern SR_PRIV struct sr_dev_driver colead_slm_driver_info; #endif @@ -92,6 +99,10 @@ extern SR_PRIV struct sr_dev_driver demo_driver_info; #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_NEXUS_OSCIPRIME extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info; #endif @@ -145,18 +156,29 @@ 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_8060_ser_driver_info; +extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info; extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info; extern SR_PRIV struct sr_dev_driver voltcraft_vc840_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_8060_driver_info; +extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_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_vc840_driver_info; #endif /** @endcond */ static struct sr_dev_driver *drivers_list[] = { +#ifdef HAVE_HW_BRYMEN_DMM + &brymen_bm857_driver_info, +#endif #ifdef HAVE_HW_COLEAD_SLM &colead_slm_driver_info, #endif @@ -166,6 +188,10 @@ static struct sr_dev_driver *drivers_list[] = { #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_NEXUS_OSCIPRIME &nexus_osciprime_driver_info, #endif @@ -219,14 +245,22 @@ static struct sr_dev_driver *drivers_list[] = { &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_8060_ser_driver_info, + &tecpel_dmm_8061_ser_driver_info, &voltcraft_vc820_ser_driver_info, &voltcraft_vc840_ser_driver_info, + &uni_t_ut61d_ser_driver_info, &uni_t_ut61e_ser_driver_info, #endif #ifdef HAVE_HW_UNI_T_DMM + &tecpel_dmm_8060_driver_info, + &tecpel_dmm_8061_driver_info, &uni_t_ut61d_driver_info, + &uni_t_ut61e_driver_info, &voltcraft_vc820_driver_info, + &voltcraft_vc840_driver_info, #endif NULL, }; @@ -245,19 +279,38 @@ SR_API struct sr_dev_driver **sr_driver_list(void) /** * Initialize a hardware driver. * + * 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(). - * @param driver The driver to initialize. + * 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_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->init) - return driver->init(ctx); + 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; } /** @@ -270,21 +323,39 @@ SR_API int sr_driver_init(struct sr_context *ctx, 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(). + * + * @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. - * This list must be freed by the caller, but without freeing the data - * pointed to in the list. + * @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->scan) - return driver->scan(options); + if (!driver) { + sr_err("Invalid driver, can't scan for devices."); + return NULL; + } - return NULL; + 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; } /** @private */ @@ -300,26 +371,45 @@ SR_PRIV void sr_hw_cleanup_all(void) } } -SR_PRIV struct sr_config *sr_config_make(int key, const void *value) +/** 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->value = value; + 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 key The configuration key (SR_CONF_*). - * @param data Pointer where the value will be stored. Must not be NULL. - * @param sdi If the key is specific to a device, this must contain a - * pointer to the struct sr_dev_inst to be checked. + * @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 key, @@ -327,7 +417,7 @@ SR_PRIV struct sr_config *sr_config_make(int key, const void *value) * as an indication that it's not applicable. */ SR_API int sr_config_get(const struct sr_dev_driver *driver, int key, - const void **data, const struct sr_dev_inst *sdi) + GVariant **data, const struct sr_dev_inst *sdi) { int ret; @@ -337,7 +427,11 @@ SR_API int sr_config_get(const struct sr_dev_driver *driver, int key, if (!driver->config_get) return SR_ERR_ARG; - ret = driver->config_get(key, data, sdi); + 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; } @@ -347,26 +441,29 @@ SR_API int sr_config_get(const struct sr_dev_driver *driver, int key, * * @param sdi The device instance. * @param key The configuration key (SR_CONF_*). - * @param value The new value for the key, as a pointer to whatever type - * is appropriate for that key. + * @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 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 int sr_config_set(const struct sr_dev_inst *sdi, int key, - const void *value) +SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data) { int ret; - if (!sdi || !sdi->driver || !value) - return SR_ERR; + g_variant_ref_sink(data); - if (!sdi->driver->config_set) - return SR_ERR_ARG; + 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); - ret = sdi->driver->config_set(key, value, sdi); + g_variant_unref(data); return ret; } @@ -376,10 +473,13 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, * * @param driver The sr_dev_driver struct to query. * @param key The configuration key (SR_CONF_*). - * @param data A pointer to a list of values, in whatever format is - * appropriate for that key. - * @param sdi If the key is specific to a device, this must contain a - * pointer to the struct sr_dev_inst to be checked. + * @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 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, @@ -387,17 +487,16 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, * as an indication that it's not applicable. */ SR_API int sr_config_list(const struct sr_dev_driver *driver, int key, - const void **data, const struct sr_dev_inst *sdi) + GVariant **data, const struct sr_dev_inst *sdi) { int ret; if (!driver || !data) - return SR_ERR; - - if (!driver->config_list) - return SR_ERR_ARG; - - ret = driver->config_list(key, data, sdi); + 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 ret; } @@ -405,7 +504,7 @@ SR_API int sr_config_list(const struct sr_dev_driver *driver, int key, /** * Get information about a configuration key. * - * @param opt The configuration key. + * @param key The configuration key. * * @return A pointer to a struct sr_config_info, or NULL if the key * was not found.