#include "libsigrok.h"
#include "libsigrok-internal.h"
+/* Message logging helpers with driver-specific prefix string. */
+#define DRIVER_LOG_DOMAIN "hwdriver: "
+#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
+#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
+#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+
/**
* @file
*
"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
#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
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 voltcraft_vc820_ser_driver_info;
extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
/** @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
#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
&peaktech_4370_driver_info,
&pce_pce_dm32_driver_info,
&radioshack_22_168_driver_info,
+ &radioshack_22_805_driver_info,
&radioshack_22_812_driver_info,
&voltcraft_vc820_ser_driver_info,
&voltcraft_vc840_ser_driver_info,
/**
* 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) {
+ sr_err("Invalid driver, can't initialize.");
+ return SR_ERR_ARG;
+ }
- if (driver->init)
- return driver->init(ctx);
+ 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;
}
/**
* 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 */
}
}
-SR_PRIV struct sr_config *sr_config_make(int key, const void *value)
+SR_PRIV struct sr_config *sr_config_new(int key, const void *value)
{
struct sr_config *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_CONF_* 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 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.
*
* @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_config_get(struct sr_dev_driver *driver, int id,
+SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
const void **data, const struct sr_dev_inst *sdi)
{
int ret;
- if (driver == NULL || data == NULL)
+ if (!driver || !data)
return SR_ERR;
- ret = driver->config_get(id, data, sdi);
+ ret = driver->config_get(key, data, sdi);
return ret;
}
-SR_API int sr_config_list(struct sr_dev_driver *driver, int id,
- const void **data, const struct sr_dev_inst *sdi)
+/**
+ * Set a configuration key in a device instance.
+ *
+ * @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.
+ *
+ * @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)
{
int ret;
- if (driver == NULL || data == NULL)
+ if (!sdi || !sdi->driver || !value)
return SR_ERR;
- if (!driver->config_list)
- return SR_ERR;
+ if (!sdi->driver->config_set)
+ return SR_ERR_ARG;
- ret = driver->config_list(id, data, sdi);
+ ret = sdi->driver->config_set(key, value, 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 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.
*
- * @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_list(const struct sr_dev_driver *driver, int key,
+ const void **data, const struct sr_dev_inst *sdi)
{
- const int *hwcaps;
- int i;
-
- if (!driver) {
- sr_err("hwdriver: %s: driver was NULL", __func__);
- return FALSE;
- }
+ int ret;
- if (driver->config_list(SR_CONF_DEVICE_OPTIONS, (const void **)&hwcaps, NULL) != SR_OK)
- return FALSE;
+ if (!driver || !data)
+ return SR_ERR;
- for (i = 0; hwcaps[i]; i++) {
- if (hwcaps[i] == hwcap)
- return TRUE;
- }
+ ret = driver->config_list(key, data, sdi);
- return FALSE;
+ return ret;
}
/**
- * Get information about an sr_config key.
+ * Get information about a configuration key.
*
- * @param opt The sr_config key.
+ * @param opt The configuration key.
*
* @return A pointer to a struct sr_config_info, or NULL if the key
* was not found.
}
/**
- * Get information about an sr_config key, by name.
+ * Get information about an configuration key, by name.
*
- * @param optname The sr_config key.
+ * @param optname The configuration key.
*
* @return A pointer to a struct sr_config_info, or NULL if the key
* was not found.
projects / libsigrok.git / blobdiff