#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"
+/**
+ * @file
+ *
+ * Hardware driver handling in libsigrok.
+ */
+
+/**
+ * @defgroup grp_driver Hardware drivers
+ *
+ * Hardware driver handling in libsigrok.
+ *
+ * @{
+ */
/* Driver scanning options. */
-SR_API struct sr_hwcap_option sr_drvopts[] = {
+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"},
};
/* Device instance options. */
-SR_API struct sr_hwcap_option sr_hwcap_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"},
{0, 0, NULL, NULL},
};
+/** @cond PRIVATE */
#ifdef HAVE_LA_DEMO
extern SR_PRIV struct sr_dev_driver demo_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;
+#endif
+/** @endcond */
static struct sr_dev_driver *drivers_list[] = {
#ifdef HAVE_LA_DEMO
#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,
#endif
NULL,
};
/**
* 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.
* @param options A list of struct sr_hwopt options to pass to the driver's
* scanner.
return NULL;
}
+/** @private */
SR_PRIV void sr_hw_cleanup_all(void)
{
int i;
return ret;
}
-SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
- const char *vendor, const char *model, const char *version)
-{
- struct sr_dev_inst *sdi;
-
- if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
- sr_err("hwdriver: %s: sdi malloc failed", __func__);
- 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;
-
- 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);
-}
-
-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)
-{
- 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;
-
- return udi;
-}
-
-SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
-{
- /* Avoid compiler warnings. */
- (void)usb;
-
- /* Nothing to do for this device instance type. */
-}
-
-#endif
-
-SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
- int fd)
-{
- struct sr_serial_dev_inst *serial;
-
- 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;
-}
-
-SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
-{
- g_free(serial->port);
-}
-
/**
* Find out if a hardware driver has a specific capability.
*
}
/**
- * Get a hardware driver option.
+ * Get information about a hardware driver option.
*
- * @param hwopt The option to get.
+ * @param opt The option to get.
*
- * @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_hwcap_option, or NULL if the option
+ * was not found.
*/
-SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt)
+SR_API const struct sr_hwcap_option *sr_drvopt_get(int opt)
{
int i;
for (i = 0; sr_drvopts[i].hwcap; i++) {
- if (sr_drvopts[i].hwcap == hwopt)
+ if (sr_drvopts[i].hwcap == opt)
return &sr_drvopts[i];
}
}
/**
- * Get a hardware driver capability option.
+ * Get information about a hardware driver option, by name.
*
- * @param hwcap The capability to get.
+ * @param optname The name of the option to get.
*
- * @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_hwcap_option, or NULL if the option
+ * was not found.
*/
-SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
+SR_API const struct sr_hwcap_option *sr_drvopt_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_drvopts[i].hwcap; i++) {
+ if (!strcmp(sr_drvopts[i].shortname, optname))
+ return &sr_drvopts[i];
+ }
+
+ return NULL;
+}
+
+/**
+ * Get information about a device 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_devopt_get(int opt)
+{
+ int i;
+
+ for (i = 0; sr_devopts[i].hwcap; i++) {
+ if (sr_devopts[i].hwcap == opt)
+ return &sr_devopts[i];
+ }
+
+ return NULL;
+}
+
+/**
+ * Get information about a device option, by name.
+ *
+ * @param optname The name of 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_devopt_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];
}
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