Add/update Doxygen @since tags.

[libsigrok.git] / hwdriver.c

diff --git a/hwdriver.c b/hwdriver.c
index f198e86325d8a581236255216e25a6d9c9ff2271..aca6d1e1bc32a0a927177cc886bd656be2d4e850 100644 (file)
--- a/hwdriver.c
+++ b/hwdriver.c
@@ -27,7 +27,9 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
+/** @cond PRIVATE */
 #define LOG_PREFIX "hwdriver"
+/** @endcond */
 
 /**
  * @file
@@ -96,10 +98,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_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",
@@ -208,15 +210,12 @@ extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
 #ifdef HAVE_HW_ASIX_SIGMA
 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
 #endif
-#ifdef HAVE_HW_CHRONOVU_LA8
-extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
+#ifdef HAVE_HW_CHRONOVU_LA
+extern SR_PRIV struct sr_dev_driver chronovu_la_driver_info;
 #endif
 #ifdef HAVE_HW_LINK_MSO19
 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 #endif
-#ifdef HAVE_HW_ALSA
-extern SR_PRIV struct sr_dev_driver alsa_driver_info;
-#endif
 #ifdef HAVE_HW_FX2LAFW
 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 #endif
@@ -366,15 +365,12 @@ static struct sr_dev_driver *drivers_list[] = {
 #ifdef HAVE_HW_ASIX_SIGMA
        &asix_sigma_driver_info,
 #endif
-#ifdef HAVE_HW_CHRONOVU_LA8
-       &chronovu_la8_driver_info,
+#ifdef HAVE_HW_CHRONOVU_LA
+       &chronovu_la_driver_info,
 #endif
 #ifdef HAVE_HW_LINK_MSO19
        &link_mso19_driver_info,
 #endif
-#ifdef HAVE_HW_ALSA
-       &alsa_driver_info,
-#endif
 #ifdef HAVE_HW_FX2LAFW
        &fx2lafw_driver_info,
 #endif
@@ -444,6 +440,8 @@ static struct sr_dev_driver *drivers_list[] = {
  * Return the list of supported hardware drivers.
  *
  * @return Pointer to the NULL-terminated list of hardware driver pointers.
+ *
+ * @since 0.1.0
  */
 SR_API struct sr_dev_driver **sr_driver_list(void)
 {
@@ -467,6 +465,8 @@ SR_API struct sr_dev_driver **sr_driver_list(void)
  * @retval SR_ERR_ARG Invalid parameter(s).
  * @retval SR_ERR_BUG Internal errors.
  * @retval other Another negative error code upon other errors.
+ *
+ * @since 0.2.0
  */
 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 {
@@ -511,6 +511,8 @@ SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
  *         found (or errors were encountered). This list must be freed by the
  *         caller using g_slist_free(), but without freeing the data pointed
  *         to in the list.
+ *
+ * @since 0.2.0
  */
 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 {
@@ -601,6 +603,8 @@ SR_PRIV void sr_config_free(struct sr_config *src)
  * @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.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_config_get(const struct sr_dev_driver *driver,
                const struct sr_dev_inst *sdi,
@@ -640,6 +644,8 @@ SR_API int sr_config_get(const struct sr_dev_driver *driver,
  * @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.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_config_set(const struct sr_dev_inst *sdi,
                const struct sr_channel_group *cg,
@@ -667,6 +673,8 @@ SR_API int sr_config_set(const struct sr_dev_inst *sdi,
  * @param sdi The device instance.
  *
  * @return SR_OK upon success or SR_ERR in case of error.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
 {
@@ -702,6 +710,8 @@ SR_API int sr_config_commit(const struct sr_dev_inst *sdi)
  * @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.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_config_list(const struct sr_dev_driver *driver,
                const struct sr_dev_inst *sdi,
@@ -727,6 +737,8 @@ SR_API int sr_config_list(const struct sr_dev_driver *driver,
  *
  * @return A pointer to a struct sr_config_info, or NULL if the key
  *         was not found.
+ *
+ * @since 0.2.0
  */
 SR_API const struct sr_config_info *sr_config_info_get(int key)
 {
@@ -747,6 +759,8 @@ SR_API const struct sr_config_info *sr_config_info_get(int key)
  *
  * @return A pointer to a struct sr_config_info, or NULL if the key
  *         was not found.
+ *
+ * @since 0.2.0
  */
 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 {
@@ -774,7 +788,7 @@ SR_PRIV int sr_source_remove(int fd)
  *  @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)
+                         sr_receive_data_callback cb, void *cb_data)
 {
        return sr_session_source_add(fd, events, timeout, cb, cb_data);
 }