X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hwdriver.c;h=f500229512d5f1e070fc81936da05ca519a190a9;hb=61a429c963fb21c3d8cb8e9166d621526724b714;hp=42932b36f641f9a7f82a2cbddff187c2b1e16a43;hpb=b159add3d9e3804f7806e82b01374fa099610668;p=libsigrok.git diff --git a/hwdriver.c b/hwdriver.c index 42932b36..f5002295 100644 --- a/hwdriver.c +++ b/hwdriver.c @@ -23,20 +23,34 @@ #include #include #include +#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. */ + +/* 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"}, - /* Device instance options. */ + {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"}, @@ -53,12 +67,22 @@ SR_API struct sr_hwcap_option sr_hwcap_options[] = { {0, 0, NULL, NULL}, }; +/** @cond PRIVATE */ +#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_LA_OLS extern SR_PRIV struct sr_dev_driver ols_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 @@ -80,17 +104,40 @@ extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info; #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_RADIOSHACK_DMM +extern SR_PRIV struct sr_dev_driver radioshackdmm_driver_info; +#endif +#ifdef HAVE_HW_TEKPOWER_DMM +extern SR_PRIV struct sr_dev_driver tekpower_dmm_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_COLEAD_SLM + &colead_slm_driver_info, +#endif #ifdef HAVE_LA_DEMO &demo_driver_info, #endif #ifdef HAVE_LA_OLS &ols_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 @@ -112,8 +159,21 @@ static struct sr_dev_driver *drivers_list[] = { #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_RADIOSHACK_DMM + &radioshackdmm_driver_info, +#endif +#ifdef HAVE_HW_TEKPOWER_DMM + &tekpower_dmm_driver_info, +#endif +#ifdef HAVE_HW_UNI_T_DMM + &uni_t_ut61d_driver_info, + &voltcraft_vc820_driver_info, #endif NULL, }; @@ -125,154 +185,90 @@ 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(); - 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; -} - -SR_PRIV void sr_hw_cleanup_all(void) -{ - int i; - struct sr_dev_driver **drivers; - - drivers = sr_driver_list(); - for (i = 0; drivers[i]; i++) { - if (drivers[i]->cleanup) - drivers[i]->cleanup(); - } -} - -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->priv = NULL; + if (driver->init) + return driver->init(); - return sdi; + return SR_OK; } -SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index) +/** + * 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) { - 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); + if (driver->scan) + return driver->scan(options); 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) +/** @private */ +SR_PRIV void sr_hw_cleanup_all(void) { - struct sr_usb_dev_inst *udi; + int i; + struct sr_dev_driver **drivers; - if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { - sr_err("hwdriver: %s: udi malloc failed", __func__); - return NULL; + drivers = sr_driver_list(); + for (i = 0; drivers[i]; i++) { + if (drivers[i]->cleanup) + drivers[i]->cleanup(); } - - 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) +/** + * 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_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; - } + int ret; - serial->port = g_strdup(port); - serial->fd = fd; + if (driver == NULL || data == NULL) + return SR_ERR; - return serial; -} + ret = driver->info_get(id, data, sdi); -SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) -{ - g_free(serial->port); + return ret; } /** @@ -295,10 +291,8 @@ SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) return FALSE; } - if (!(hwcaps = driver->hwcap_get_all())) { - sr_err("hwdriver: %s: hwcap_get_all() returned NULL", __func__); + if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK) return FALSE; - } for (i = 0; hwcaps[i]; i++) { if (hwcaps[i] == hwcap) @@ -309,20 +303,80 @@ SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) } /** - * Get a hardware driver capability option. + * Get information about a hardware driver option. * - * @param hwcap The capability to get. + * @param opt 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_get(int opt) { 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 (sr_drvopts[i].hwcap == opt) + return &sr_drvopts[i]; + } + + return NULL; +} + +/** + * 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) +{ + int 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; @@ -330,13 +384,17 @@ SR_API const 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); } + +/** @} */