X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=hwdriver.c;h=4c2ae142b622595b9e5914ab93b86c456409db27;hb=4c961f5ed5e127aae75e48cd4369dc25439f24d4;hp=a740a8a622106685d58c9341eeaf870506ae6509;hpb=083d64f94f6c619ca427c2544b2c08b2929a8051;p=libsigrok.git diff --git a/hwdriver.c b/hwdriver.c index a740a8a6..4c2ae142 100644 --- a/hwdriver.c +++ b/hwdriver.c @@ -41,40 +41,34 @@ * @{ */ -/* Driver scanning options. */ -static struct sr_config_info sr_drvopts[] = { - {SR_HWOPT_CONN, SR_T_CHAR, "conn", +static struct sr_config_info sr_config_info_data[] = { + {SR_CONF_CONN, SR_T_CHAR, "conn", "Connection", NULL}, - {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "serialcomm", + {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm", "Serial communication", NULL}, - {0, 0, NULL, NULL, NULL}, -}; - -/* Device instance options. */ -static struct sr_config_info sr_devopts[] = { - {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "samplerate", + {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate", "Sample rate", NULL}, - {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "captureratio", + {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", "Pre-trigger capture ratio", NULL}, - {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "pattern", + {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern", "Pattern generator mode", NULL}, - {SR_HWCAP_RLE, SR_T_BOOL, "rle", + {SR_CONF_RLE, SR_T_BOOL, "rle", "Run Length Encoding", NULL}, - {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope", + {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope", "Trigger slope", NULL}, - {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "triggersource", + {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource", "Trigger source", NULL}, - {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", + {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", "Horizontal trigger position", NULL}, - {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "buffersize", + {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize", "Buffer size", NULL}, - {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", + {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", "Time base", NULL}, - {SR_HWCAP_FILTER, SR_T_CHAR, "filter", + {SR_CONF_FILTER, SR_T_CHAR, "filter", "Filter targets", NULL}, - {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "vdiv", + {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv", "Volts/div", NULL}, - {SR_HWCAP_COUPLING, SR_T_CHAR, "coupling", + {SR_CONF_COUPLING, SR_T_CHAR, "coupling", "Coupling", NULL}, {0, 0, NULL, NULL, NULL}, }; @@ -313,134 +307,127 @@ SR_PRIV struct sr_config *sr_config_make(int key, const void *value) * 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. + * @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 id, + * 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_info_get(struct sr_dev_driver *driver, int id, +SR_API int sr_config_get(const struct sr_dev_driver *driver, int key, const void **data, const struct sr_dev_inst *sdi) { int ret; - if (driver == NULL || data == NULL) + if (!driver || !data) return SR_ERR; - ret = driver->info_get(id, data, sdi); + if (!driver->config_get) + return SR_ERR_ARG; + + ret = driver->config_get(key, data, sdi); return ret; } /** - * Find out if a hardware driver has a specific capability. + * Set a configuration key in a device instance. * - * @param driver The hardware driver in which to search for the capability. - * @param hwcap The capability to find in the list. + * @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 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_set(const struct sr_dev_inst *sdi, int key, + const void *value) { - const int *hwcaps; - int i; + int ret; - if (!driver) { - sr_err("hwdriver: %s: driver was NULL", __func__); - return FALSE; - } + if (!sdi || !sdi->driver) + return SR_ERR; - if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK) - return FALSE; + if (!sdi->driver->config_set) + return SR_ERR_ARG; - for (i = 0; hwcaps[i]; i++) { - if (hwcaps[i] == hwcap) - return TRUE; - } + ret = sdi->driver->config_set(key, value, sdi); - return FALSE; + return ret; } /** - * Get information about a hardware driver option. + * List all possible values for a configuration key. * - * @param opt The option to get. + * @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 A pointer to a struct sr_hwcap_option, or NULL if the option - * was not found. + * @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 const struct sr_config_info *sr_drvopt_get(int opt) +SR_API int sr_config_list(const struct sr_dev_driver *driver, int key, + const void **data, const struct sr_dev_inst *sdi) { - int i; - - for (i = 0; sr_drvopts[i].key; i++) { - if (sr_drvopts[i].key == opt) - return &sr_drvopts[i]; - } + int ret; - return NULL; -} + if (!driver || !data) + return SR_ERR; -/** - * 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_config_info *sr_drvopt_name_get(const char *optname) -{ - int i; + if (!driver->config_list) + return SR_ERR_ARG; - for (i = 0; sr_drvopts[i].key; i++) { - if (!strcmp(sr_drvopts[i].id, optname)) - return &sr_drvopts[i]; - } + ret = driver->config_list(key, data, sdi); - return NULL; + return ret; } /** - * Get information about a device option. + * Get information about a configuration key. * - * @param opt The option to get. + * @param opt The configuration key. * - * @return A pointer to a struct sr_hwcap_option, or NULL if the option + * @return A pointer to a struct sr_config_info, or NULL if the key * was not found. */ -SR_API const struct sr_config_info *sr_devopt_get(int opt) +SR_API const struct sr_config_info *sr_config_info_get(int key) { int i; - for (i = 0; sr_devopts[i].key; i++) { - if (sr_devopts[i].key == opt) - return &sr_devopts[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 information about a device option, by name. + * Get information about an configuration key, by name. * - * @param optname The name of the option to get. + * @param optname The configuration key. * - * @return A pointer to a struct sr_hwcap_option, or NULL if the option + * @return A pointer to a struct sr_config_info, or NULL if the key * was not found. */ -SR_API const struct sr_config_info *sr_devopt_name_get(const char *optname) +SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) { int i; - for (i = 0; sr_devopts[i].key; i++) { - if (!strcmp(sr_devopts[i].id, optname)) - return &sr_devopts[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;