X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=hwdriver.c;h=4728cb074ba9abbde76e56cedbdbcf0118997a02;hp=557181176009bce2c2265f9b95011ba37ea618ad;hb=fca75cbb741ae756bf50eaf1cdc6d4d53fcc60cd;hpb=aeaad0b0b5db53f3d600359834b2738422feaeaf diff --git a/hwdriver.c b/hwdriver.c index 55718117..4728cb07 100644 --- a/hwdriver.c +++ b/hwdriver.c @@ -53,7 +53,7 @@ static struct sr_config_info sr_config_info_data[] = { {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", "Pre-trigger capture ratio", NULL}, {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern", - "Pattern generator mode", NULL}, + "Pattern", NULL}, {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype", "Trigger types", NULL}, {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock", @@ -62,7 +62,7 @@ static struct sr_config_info sr_config_info_data[] = { "Swap channel order", NULL}, {SR_CONF_RLE, SR_T_BOOL, "rle", "Run Length Encoding", NULL}, - {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope", + {SR_CONF_TRIGGER_SLOPE, SR_T_CHAR, "triggerslope", "Trigger slope", NULL}, {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource", "Trigger source", NULL}, @@ -96,12 +96,10 @@ static struct sr_config_info sr_config_info_data[] = { "Power off", NULL}, {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source", "Data source", NULL}, - {SR_CONF_NUM_LOGIC_PROBES, SR_T_INT32, "logic_probes", - "Number of logic probes", NULL}, - {SR_CONF_NUM_ANALOG_PROBES, SR_T_INT32, "analog_probes", - "Number of analog probes", NULL}, - {SR_CONF_MAX_UNCOMPRESSED_SAMPLES, SR_T_UINT64, "max_uncompressed_samples", - "Maximum number of uncompressed samples", NULL}, + {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels", + "Number of logic channels", NULL}, + {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels", + "Number of analog channels", NULL}, {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage", "Current output voltage", NULL}, {SR_CONF_OUTPUT_VOLTAGE_MAX, SR_T_FLOAT, "output_voltage_max", @@ -118,6 +116,10 @@ static struct sr_config_info sr_config_info_data[] = { "Over-voltage protection", NULL}, {SR_CONF_OVER_CURRENT_PROTECTION, SR_T_BOOL, "ocp", "Over-current protection", NULL}, + {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples", + "Sample limit", NULL}, + {SR_CONF_CLOCK_EDGE, SR_T_CHAR, "clock_edge", + "Clock edge", NULL}, {0, 0, NULL, NULL, NULL}, }; @@ -128,6 +130,9 @@ extern SR_PRIV struct sr_dev_driver appa_55ii_driver_info; #ifdef HAVE_HW_ATTEN_PPS3XXX extern SR_PRIV struct sr_dev_driver atten_pps3203_driver_info; #endif +#ifdef HAVE_HW_BRYMEN_BM86X +extern SR_PRIV struct sr_dev_driver brymen_bm86x_driver_info; +#endif #ifdef HAVE_HW_BRYMEN_DMM extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info; #endif @@ -141,11 +146,15 @@ extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info; #ifdef HAVE_HW_COLEAD_SLM extern SR_PRIV struct sr_dev_driver colead_slm_driver_info; #endif +#ifdef HAVE_HW_CONRAD_DIGI_35_CPU +extern SR_PRIV struct sr_dev_driver conrad_digi_35_cpu_driver_info; +#endif #ifdef HAVE_HW_DEMO extern SR_PRIV struct sr_dev_driver demo_driver_info; #endif #ifdef HAVE_HW_GMC_MH_1X_2X extern SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info; +extern SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info; #endif #ifdef HAVE_HW_HAMEG_HMO extern SR_PRIV struct sr_dev_driver hameg_hmo_driver_info; @@ -237,8 +246,10 @@ extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info; extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info; extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info; extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_m3650cr_driver_info; extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info; extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info; +extern SR_PRIV struct sr_dev_driver voltcraft_me42_driver_info; extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info; extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info; extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info; @@ -277,6 +288,9 @@ static struct sr_dev_driver *drivers_list[] = { #ifdef HAVE_HW_ATTEN_PPS3XXX &atten_pps3203_driver_info, #endif +#ifdef HAVE_HW_BRYMEN_BM86X + &brymen_bm86x_driver_info, +#endif #ifdef HAVE_HW_BRYMEN_DMM &brymen_bm857_driver_info, #endif @@ -290,11 +304,15 @@ static struct sr_dev_driver *drivers_list[] = { #ifdef HAVE_HW_COLEAD_SLM &colead_slm_driver_info, #endif +#ifdef HAVE_HW_CONRAD_DIGI_35_CPU + &conrad_digi_35_cpu_driver_info, +#endif #ifdef HAVE_HW_DEMO &demo_driver_info, #endif #ifdef HAVE_HW_GMC_MH_1X_2X &gmc_mh_1x_2x_rs232_driver_info, + &gmc_mh_2x_bd232_driver_info, #endif #ifdef HAVE_HW_HAMEG_HMO &hameg_hmo_driver_info, @@ -386,8 +404,10 @@ static struct sr_dev_driver *drivers_list[] = { &radioshack_22_805_driver_info, &radioshack_22_812_driver_info, &tecpel_dmm_8061_ser_driver_info, + &voltcraft_m3650cr_driver_info, &voltcraft_m3650d_driver_info, &voltcraft_m4650cr_driver_info, + &voltcraft_me42_driver_info, &voltcraft_vc820_ser_driver_info, &voltcraft_vc830_ser_driver_info, &voltcraft_vc840_ser_driver_info, @@ -443,9 +463,10 @@ SR_API struct sr_dev_driver **sr_driver_list(void) * @param driver The driver to initialize. This must be a pointer to one of * the entries returned by sr_driver_list(). Must not be NULL. * - * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters, - * SR_ERR_BUG upon internal errors, or another negative error code - * upon other errors. + * @retval SR_OK Success + * @retval SR_ERR_ARG Invalid parameter(s). + * @retval SR_ERR_BUG Internal errors. + * @retval other Another negative error code upon other errors. */ SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) { @@ -513,7 +534,8 @@ SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) return l; } -/** @private */ +/** Call driver cleanup function for all drivers. + * @private */ SR_PRIV void sr_hw_cleanup_all(void) { int i; @@ -526,8 +548,10 @@ SR_PRIV void sr_hw_cleanup_all(void) } } -/** A floating reference can be passed in for data. - * @private */ +/** Allocate struct sr_config. + * A floating reference can be passed in for data. + * @private + */ SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data) { struct sr_config *src; @@ -540,7 +564,9 @@ SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data) return src; } -/** @private */ +/** Free struct sr_config. + * @private + */ SR_PRIV void sr_config_free(struct sr_config *src) { @@ -555,29 +581,30 @@ SR_PRIV void sr_config_free(struct sr_config *src) } /** - * Returns information about the given driver or device instance. + * Query value of a configuration key at the given driver or device instance. * - * @param driver The sr_dev_driver struct to query. - * @param sdi (optional) If the key is specific to a device, this must + * @param[in] driver The sr_dev_driver struct to query. + * @param[in] sdi (optional) If the key is specific to a device, this must * contain a pointer to the struct sr_dev_inst to be checked. * Otherwise it must be NULL. - * @param probe_group The probe group on the device for which to list the + * @param[in] cg The channel group on the device for which to list the * values, or NULL. - * @param key The configuration key (SR_CONF_*). - * @param data Pointer to a GVariant where the value will be stored. Must - * not be NULL. The caller is given ownership of the GVariant + * @param[in] key The configuration key (SR_CONF_*). + * @param[in,out] data Pointer to a GVariant where the value will be stored. + * Must not be NULL. The caller is given ownership of the GVariant * and must thus decrease the refcount after use. However if * this function returns an error code, the field should be * considered unused, and should not be unreferenced. * - * @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. + * @retval SR_OK Success. + * @retval SR_ERR Error. + * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be + * interpreted as an error by the caller; merely as an indication + * that it's not applicable. */ SR_API int sr_config_get(const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, - const struct sr_probe_group *probe_group, + const struct sr_channel_group *cg, int key, GVariant **data) { int ret; @@ -588,7 +615,7 @@ SR_API int sr_config_get(const struct sr_dev_driver *driver, if (!driver->config_get) return SR_ERR_ARG; - if ((ret = driver->config_get(key, data, sdi, probe_group)) == SR_OK) { + if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) { /* Got a floating reference from the driver. Sink it here, * caller will need to unref when done with it. */ g_variant_ref_sink(*data); @@ -598,23 +625,24 @@ SR_API int sr_config_get(const struct sr_dev_driver *driver, } /** - * Set a configuration key in a device instance. + * Set value of a configuration key in a device instance. * - * @param sdi The device instance. - * @param probe_group The probe group on the device for which to list the + * @param[in] sdi The device instance. + * @param[in] cg The channel group on the device for which to list the * values, or NULL. - * @param key The configuration key (SR_CONF_*). + * @param[in] key The configuration key (SR_CONF_*). * @param data The new value for the key, as a GVariant with GVariantType * appropriate to that key. A floating reference can be passed * in; its refcount will be sunk and unreferenced after use. * - * @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. + * @retval SR_OK Success. + * @retval SR_ERR Error. + * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be + * interpreted as an error by the caller; merely as an indication + * that it's not applicable. */ SR_API int sr_config_set(const struct sr_dev_inst *sdi, - const struct sr_probe_group *probe_group, + const struct sr_channel_group *cg, int key, GVariant *data) { int ret; @@ -626,36 +654,58 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi, else if (!sdi->driver->config_set) ret = SR_ERR_ARG; else - ret = sdi->driver->config_set(key, data, sdi, probe_group); + ret = sdi->driver->config_set(key, data, sdi, cg); g_variant_unref(data); return ret; } +/** + * Apply configuration settings to the device hardware. + * + * @param sdi The device instance. + * + * @return SR_OK upon success or SR_ERR in case of error. + */ +SR_API int sr_config_commit(const struct sr_dev_inst *sdi) +{ + int ret; + + if (!sdi || !sdi->driver) + ret = SR_ERR; + else if (!sdi->driver->config_commit) + ret = SR_OK; + else + ret = sdi->driver->config_commit(sdi); + + return ret; +} + /** * List all possible values for a configuration key. * - * @param driver The sr_dev_driver struct to query. - * @param sdi (optional) If the key is specific to a device, this must + * @param[in] driver The sr_dev_driver struct to query. + * @param[in] sdi (optional) If the key is specific to a device, this must * contain a pointer to the struct sr_dev_inst to be checked. - * @param probe_group The probe group on the device for which to list the + * @param[in] cg The channel group on the device for which to list the * values, or NULL. - * @param key The configuration key (SR_CONF_*). - * @param data A pointer to a GVariant where the list will be stored. The - * caller is given ownership of the GVariant and must thus + * @param[in] key The configuration key (SR_CONF_*). + * @param[in,out] data A pointer to a GVariant where the list will be stored. + * The caller is given ownership of the GVariant and must thus * unref the GVariant after use. However if this function * returns an error code, the field should be considered * unused, and should not be unreferenced. * - * @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. + * @retval SR_OK Success. + * @retval SR_ERR Error. + * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be + * interpreted as an error by the caller; merely as an indication + * that it's not applicable. */ SR_API int sr_config_list(const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi, - const struct sr_probe_group *probe_group, + const struct sr_channel_group *cg, int key, GVariant **data) { int ret; @@ -664,16 +714,16 @@ SR_API int sr_config_list(const struct sr_dev_driver *driver, ret = SR_ERR; else if (!driver->config_list) ret = SR_ERR_ARG; - else if ((ret = driver->config_list(key, data, sdi, probe_group)) == SR_OK) + else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) g_variant_ref_sink(*data); return ret; } /** - * Get information about a configuration key. + * Get information about a configuration key, by key. * - * @param key The configuration key. + * @param[in] key The configuration key. * * @return A pointer to a struct sr_config_info, or NULL if the key * was not found. @@ -691,9 +741,9 @@ SR_API const struct sr_config_info *sr_config_info_get(int key) } /** - * Get information about an configuration key, by name. + * Get information about a configuration key, by name. * - * @param optname The configuration key. + * @param[in] optname The configuration key. * * @return A pointer to a struct sr_config_info, or NULL if the key * was not found. @@ -712,13 +762,17 @@ SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) /* Unnecessary level of indirection follows. */ -/** @private */ +/** @private + * @see sr_session_source_remove() + */ SR_PRIV int sr_source_remove(int fd) { return sr_session_source_remove(fd); } -/** @private */ +/** @private + * @see sr_session_source_add() + */ SR_PRIV int sr_source_add(int fd, int events, int timeout, sr_receive_data_callback_t cb, void *cb_data) {