#include <dirent.h>
#include <string.h>
#include <glib.h>
+#include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
#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)
-/* Driver scanning options. */
-SR_API 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. */
-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", "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_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},
+ {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_LA_DEMO
extern SR_PRIV struct sr_dev_driver demo_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
#ifdef HAVE_LA_OLS
extern SR_PRIV struct sr_dev_driver ols_driver_info;
#endif
+#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_LA_ZEROPLUS_LOGIC_CUBE
extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
#endif
#ifdef HAVE_LA_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_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;
+#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 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_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;
+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 uni_t_ut61d_driver_info;
+extern SR_PRIV struct sr_dev_driver voltcraft_vc820_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
#ifdef HAVE_LA_DEMO
&demo_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
#ifdef HAVE_LA_OLS
&ols_driver_info,
#endif
+#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_LA_ZEROPLUS_LOGIC_CUBE
&zeroplus_logic_cube_driver_info,
#endif
#ifdef HAVE_LA_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_HANTEK_DSO
&hantek_dso_driver_info,
#endif
-#ifdef HAVE_HW_GENERICDMM
- &genericdmm_driver_info,
+#ifdef HAVE_HW_AGILENT_DMM
+ &agdmm_driver_info,
+#endif
+#ifdef HAVE_HW_FLUKE_DMM
+ &flukedmm_driver_info,
+#endif
+#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_812_driver_info,
+ &voltcraft_vc820_ser_driver_info,
+ &voltcraft_vc840_ser_driver_info,
+ &uni_t_ut61e_ser_driver_info,
+#endif
+#ifdef HAVE_HW_UNI_T_DMM
+ &uni_t_ut61d_driver_info,
+ &voltcraft_vc820_driver_info,
#endif
NULL,
};
/**
* 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;
}
/**
* Tell a hardware driver to scan for devices.
*
- * @param driver The driver.
- * @param options A list of struct sr_hwopt options to pass to the driver's
- * scanner.
+ * 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.
*
- * @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.
+ * 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 (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->priv) {
+ sr_err("Driver not initialized, can't scan for devices.");
+ return NULL;
+ }
- if (driver->scan)
- return driver->scan(options);
+ l = driver->scan(options);
- return NULL;
+ 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;
}
}
-SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
- const char *vendor, const char *model, const char *version)
+SR_PRIV struct sr_config *sr_config_make(int key, const void *value)
{
- 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->probes = NULL;
- sdi->priv = NULL;
-
- return sdi;
-}
-
-SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index)
-{
- struct sr_dev_inst *sdi;
- GSList *l;
+ src->key = key;
+ src->value = value;
- for (l = dev_insts; l; l = l->next) {
- sdi = (struct sr_dev_inst *)(l->data);
- if (sdi->index == dev_index)
- return sdi;
- }
- sr_warn("could not find device index %d instance", dev_index);
-
- return NULL;
-}
-
-SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
-{
- g_free(sdi->priv);
- g_free(sdi->vendor);
- g_free(sdi->model);
- g_free(sdi->version);
- g_free(sdi);
+ return src;
}
-SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
- gboolean enabled, const char *name)
-{
- struct sr_probe *probe;
-
- if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) {
- sr_err("hwdriver: probe malloc failed");
- return NULL;
- }
-
- probe->index = index;
- probe->type = type;
- probe->enabled = enabled;
- if (name)
- probe->name = g_strdup(name);
-
- return probe;
-}
-
-#ifdef HAVE_LIBUSB_1_0
-
-SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
- uint8_t address, struct libusb_device_handle *hdl)
+/**
+ * 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.
+ *
+ * @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_get(const struct sr_dev_driver *driver, int key,
+ const void **data, const struct sr_dev_inst *sdi)
{
- struct sr_usb_dev_inst *udi;
-
- if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
- sr_err("hwdriver: %s: udi malloc failed", __func__);
- return NULL;
- }
-
- udi->bus = bus;
- udi->address = address;
- udi->devhdl = hdl;
+ int ret;
- return udi;
-}
+ if (!driver || !data)
+ return SR_ERR;
-SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
-{
- /* Avoid compiler warnings. */
- (void)usb;
+ ret = driver->config_get(key, data, sdi);
- /* Nothing to do for this device instance type. */
+ return ret;
}
-#endif
-
-SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
- int fd)
+/**
+ * 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)
{
- struct sr_serial_dev_inst *serial;
+ int ret;
- if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
- sr_err("hwdriver: %s: serial malloc failed", __func__);
- return NULL;
- }
+ if (!sdi || !sdi->driver || !value)
+ return SR_ERR;
- serial->port = g_strdup(port);
- serial->fd = fd;
+ if (!sdi->driver->config_set)
+ return SR_ERR_ARG;
- return serial;
-}
+ ret = sdi->driver->config_set(key, value, sdi);
-SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
-{
- g_free(serial->port);
+ 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;
+ int ret;
- if (!driver) {
- sr_err("hwdriver: %s: driver was NULL", __func__);
- return FALSE;
- }
-
- if (!(hwcaps = driver->hwcap_get_all())) {
- sr_err("hwdriver: %s: hwcap_get_all() returned NULL", __func__);
- 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 a hardware driver option.
+ * Get information about a configuration key.
*
- * @param hwopt The option to get.
+ * @param opt The configuration key.
*
- * @return A pointer to a struct with information about the parameter, or NULL
- * if the option was not found.
+ * @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_drvopt_get(int hwopt)
+SR_API const struct sr_config_info *sr_config_info_get(int key)
{
int i;
- for (i = 0; sr_drvopts[i].hwcap; i++) {
- if (sr_drvopts[i].hwcap == hwopt)
- return &sr_drvopts[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 a hardware driver capability option.
+ * Get information about an configuration key, by name.
*
- * @param hwcap The capability to get.
+ * @param 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 const 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. */
+/** @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);
}
+
+/** @} */
projects / libsigrok.git / blobdiff