X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hwdriver.c;h=7effb6aa978d81b92341fab39d14c3f07a8aab61;hb=be34a1c74688351fdeb7482fda28f49aa762a831;hp=dc314823999089fd7842f645ea4468d024ae27ad;hpb=c496ac97a83aa33dd2add8074c454b7dc1b08fe6;p=libsigrok.git diff --git a/hwdriver.c b/hwdriver.c index dc314823..7effb6aa 100644 --- a/hwdriver.c +++ b/hwdriver.c @@ -23,28 +23,39 @@ #include #include #include -#include "sigrok.h" -#include "sigrok-internal.h" +#include "libsigrok.h" +#include "libsigrok-internal.h" -/* - * This enumerates which driver capabilities correspond to user-settable - * options. - */ -/* TODO: This shouldn't be a global. */ + +/* 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}, +}; + +/* 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", "patternmode"}, + {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}, }; #ifdef HAVE_LA_DEMO extern SR_PRIV struct sr_dev_driver demo_driver_info; #endif -#ifdef HAVE_LA_SALEAE_LOGIC -extern SR_PRIV struct sr_dev_driver saleae_logic_driver_info; -#endif #ifdef HAVE_LA_OLS extern SR_PRIV struct sr_dev_driver ols_driver_info; #endif @@ -66,14 +77,17 @@ extern SR_PRIV struct sr_dev_driver alsa_driver_info; #ifdef HAVE_LA_FX2LAFW 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_driver_info; +#endif +#ifdef HAVE_HW_GENERICDMM +extern SR_PRIV struct sr_dev_driver genericdmm_driver_info; +#endif static struct sr_dev_driver *drivers_list[] = { #ifdef HAVE_LA_DEMO &demo_driver_info, #endif -#ifdef HAVE_LA_SALEAE_LOGIC - &saleae_logic_driver_info, -#endif #ifdef HAVE_LA_OLS &ols_driver_info, #endif @@ -94,61 +108,61 @@ static struct sr_dev_driver *drivers_list[] = { #endif #ifdef HAVE_LA_FX2LAFW &fx2lafw_driver_info, +#endif +#ifdef HAVE_HW_HANTEK_DSO + &hantek_dso_driver_info, +#endif +#ifdef HAVE_HW_GENERICDMM + &genericdmm_driver_info, #endif NULL, }; /** - * Return the list of loaded hardware drivers. - * - * The list of drivers is initialized from sr_init(), and can only be reset - * by calling sr_exit(). + * Return the list of supported hardware drivers. * * @return Pointer to the NULL-terminated list of hardware driver pointers. */ -SR_API struct sr_dev_driver **sr_hw_list(void) +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_hw_init(struct sr_dev_driver *driver) +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. + * + * @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; } SR_PRIV void sr_hw_cleanup_all(void) @@ -156,13 +170,39 @@ SR_PRIV void sr_hw_cleanup_all(void) int i; struct sr_dev_driver **drivers; - drivers = sr_hw_list(); + drivers = sr_driver_list(); for (i = 0; drivers[i]; i++) { if (drivers[i]->cleanup) drivers[i]->cleanup(); } } +/** + * 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) +{ + int ret; + + if (driver == NULL || data == NULL) + return SR_ERR; + + ret = driver->info_get(id, data, sdi); + + 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) { @@ -179,6 +219,7 @@ SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, 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; @@ -208,6 +249,25 @@ SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) 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, @@ -222,7 +282,7 @@ SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, udi->bus = bus; udi->address = address; - udi->devhdl = hdl; /* TODO: Check if this is NULL? */ + udi->devhdl = hdl; return udi; } @@ -268,19 +328,18 @@ SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) * FALSE otherwise. Also, if 'driver' is NULL or the respective driver * returns an invalid capability list, FALSE is returned. */ -SR_API gboolean sr_hw_has_hwcap(struct sr_dev_driver *driver, int hwcap) +SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) { - int *hwcaps, i; + const int *hwcaps; + int 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__); + 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) @@ -290,6 +349,26 @@ SR_API gboolean sr_hw_has_hwcap(struct sr_dev_driver *driver, int hwcap) return FALSE; } +/** + * Get a hardware driver option. + * + * @param hwopt The option to get. + * + * @return A pointer to a struct with information about the parameter, or NULL + * if the option was not found. + */ +SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt) +{ + int i; + + for (i = 0; sr_drvopts[i].hwcap; i++) { + if (sr_drvopts[i].hwcap == hwopt) + return &sr_drvopts[i]; + } + + return NULL; +} + /** * Get a hardware driver capability option. * @@ -298,7 +377,7 @@ SR_API gboolean sr_hw_has_hwcap(struct sr_dev_driver *driver, int hwcap) * @return A pointer to a struct with information about the parameter, or NULL * if the capability was not found. */ -SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap) +SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap) { int i; @@ -310,15 +389,15 @@ SR_API struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap) return NULL; } -/* unnecessary level of indirection follows. */ +/* Unnecessary level of indirection follows. */ -SR_PRIV void sr_source_remove(int fd) +SR_PRIV int sr_source_remove(int fd) { - sr_session_source_remove(fd); + return sr_session_source_remove(fd); } -SR_PRIV void sr_source_add(int fd, int events, int timeout, - sr_receive_data_callback rcv_cb, void *user_data) +SR_PRIV int sr_source_add(int fd, int events, int timeout, + sr_receive_data_callback_t cb, void *cb_data) { - sr_session_source_add(fd, events, timeout, rcv_cb, user_data); + return sr_session_source_add(fd, events, timeout, cb, cb_data); }