X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hwdriver.c;h=ef7f3efeff3a6a53a02753036e7fac3e8d0e92f0;hb=545f9786390a89b8bb6868907afa555fc0a6ece4;hp=43f0762f0ec8b4e61cb3a0b4b8f5a02eb8049585;hpb=0fe11789961861a68d2de45136a7869f9b8c1717;p=libsigrok.git diff --git a/hwdriver.c b/hwdriver.c index 43f0762f..ef7f3efe 100644 --- a/hwdriver.c +++ b/hwdriver.c @@ -23,15 +23,34 @@ #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. +/** + * @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[] = { + +/* Driver scanning options. */ +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"}, + {0, 0, NULL, NULL}, +}; + +/* Device instance 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"}, @@ -41,10 +60,14 @@ SR_API struct sr_hwcap_option sr_hwcap_options[] = { {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, "Time base", "timebase"}, + {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}, }; +/** @cond PRIVATE */ #ifdef HAVE_LA_DEMO extern SR_PRIV struct sr_dev_driver demo_driver_info; #endif @@ -70,8 +93,21 @@ extern SR_PRIV struct sr_dev_driver alsa_driver_info; 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_plugin_info; +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; +#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 @@ -99,7 +135,19 @@ static struct sr_dev_driver *drivers_list[] = { &fx2lafw_driver_info, #endif #ifdef HAVE_HW_HANTEK_DSO - &hantek_dso_plugin_info, + &hantek_dso_driver_info, +#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, }; @@ -111,49 +159,54 @@ 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. - * * @param driver The driver to initialize. * - * @return The number of devices found and instantiated by the driver. + * @return SR_OK if all went well, or an error code otherwise. */ SR_API int sr_driver_init(struct sr_dev_driver *driver) { - 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++; - } - return num_initialized_devs; + if (driver->init) + return driver->init(); + + return SR_OK; +} + +/** + * 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 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. + */ +SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) +{ + + if (driver->scan) + return driver->scan(options); + + return NULL; } +/** @private */ SR_PRIV void sr_hw_cleanup_all(void) { int i; @@ -166,148 +219,138 @@ 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) +/** + * 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_HWCAP_* 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. + * + * @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, + * 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_info_get(struct sr_dev_driver *driver, int id, + const void **data, const struct sr_dev_inst *sdi) { - struct sr_dev_inst *sdi; + int ret; - if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) { - sr_err("hwdriver: %s: sdi malloc failed", __func__); - return NULL; - } + if (driver == NULL || data == NULL) + return SR_ERR; - 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; + ret = driver->info_get(id, data, sdi); - return sdi; + return ret; } -SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index) +/** + * Find out if a hardware driver has a specific capability. + * + * @param driver The hardware driver in which to search for the capability. + * @param hwcap The capability to find in the list. + * + * @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. + */ +SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) { - struct sr_dev_inst *sdi; - GSList *l; + const int *hwcaps; + int i; - for (l = dev_insts; l; l = l->next) { - sdi = (struct sr_dev_inst *)(l->data); - if (sdi->index == dev_index) - return sdi; + if (!driver) { + sr_err("hwdriver: %s: driver was NULL", __func__); + return FALSE; } - 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); -} - -#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 (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK) + return FALSE; - if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { - sr_err("hwdriver: %s: udi malloc failed", __func__); - return NULL; + for (i = 0; hwcaps[i]; i++) { + if (hwcaps[i] == hwcap) + return TRUE; } - udi->bus = bus; - udi->address = address; - udi->devhdl = hdl; /* TODO: Check if this is NULL? */ - - return udi; + return FALSE; } -SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) +/** + * Get information about a hardware driver 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_drvopt_get(int opt) { - /* Avoid compiler warnings. */ - (void)usb; + int i; - /* Nothing to do for this device instance type. */ -} + for (i = 0; sr_drvopts[i].hwcap; i++) { + if (sr_drvopts[i].hwcap == opt) + return &sr_drvopts[i]; + } -#endif + return NULL; +} -SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, - int fd) +/** + * Get information about a hardware driver 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_drvopt_name_get(const char *optname) { - struct sr_serial_dev_inst *serial; + int i; - if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) { - sr_err("hwdriver: %s: serial malloc failed", __func__); - return NULL; + for (i = 0; sr_drvopts[i].hwcap; i++) { + if (!strcmp(sr_drvopts[i].shortname, optname)) + return &sr_drvopts[i]; } - 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); + return NULL; } /** - * Find out if a hardware driver has a specific capability. + * Get information about a device option. * - * @param driver The hardware driver in which to search for the capability. - * @param hwcap The capability to find in the list. + * @param opt The option to get. * - * @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 A pointer to a struct sr_hwcap_option, or NULL if the option + * was not found. */ -SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) +SR_API const struct sr_hwcap_option *sr_devopt_get(int opt) { - int *hwcaps, i; - - 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; - } + int i; - for (i = 0; hwcaps[i]; i++) { - if (hwcaps[i] == hwcap) - return TRUE; + for (i = 0; sr_devopts[i].hwcap; i++) { + if (sr_devopts[i].hwcap == opt) + return &sr_devopts[i]; } - return FALSE; + return NULL; } /** - * Get a hardware driver capability option. + * Get information about a device 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 struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap) +SR_API const struct sr_hwcap_option *sr_devopt_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_devopts[i].hwcap; i++) { + if (!strcmp(sr_devopts[i].shortname, optname)) + return &sr_devopts[i]; } return NULL; @@ -315,13 +358,17 @@ SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap) /* 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); } + +/** @} */