]> sigrok.org Git - libsigrok.git/blobdiff - session.c
log.c: Avoid using the same name for a variable and enum.
[libsigrok.git] / session.c
index 1ba05cb6d777a2a523693c50617a9f7c9809e8f9..0540942f5f53ea053391e495595505f255a9a77a 100644 (file)
--- a/session.c
+++ b/session.c
@@ -45,7 +45,7 @@
 
 struct source {
        int timeout;
-       sr_receive_data_callback_t cb;
+       sr_receive_data_callback cb;
        void *cb_data;
 
        /* This is used to keep track of the object (fd, pollfd or channel) which is
@@ -55,7 +55,7 @@ struct source {
 };
 
 struct datafeed_callback {
-       sr_datafeed_callback_t cb;
+       sr_datafeed_callback cb;
        void *cb_data;
 };
 
@@ -71,6 +71,8 @@ struct sr_session *session;
  *
  * @retval NULL Error.
  * @retval other A pointer to the newly allocated session.
+ *
+ * @since 0.1.0
  */
 SR_API struct sr_session *sr_session_new(void)
 {
@@ -93,6 +95,8 @@ SR_API struct sr_session *sr_session_new(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_destroy(void)
 {
@@ -121,6 +125,8 @@ SR_API int sr_session_destroy(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_dev_remove_all(void)
 {
@@ -145,6 +151,8 @@ SR_API int sr_session_dev_remove_all(void)
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.2.0
  */
 SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
 {
@@ -209,6 +217,8 @@ SR_API int sr_session_dev_add(const struct sr_dev_inst *sdi)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR Invalid argument.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_dev_list(GSList **devlist)
 {
@@ -228,6 +238,8 @@ SR_API int sr_session_dev_list(GSList **devlist)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_datafeed_callback_remove_all(void)
 {
@@ -251,8 +263,10 @@ SR_API int sr_session_datafeed_callback_remove_all(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.3.0
  */
-SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback_t cb, void *cb_data)
+SR_API int sr_session_datafeed_callback_add(sr_datafeed_callback cb, void *cb_data)
 {
        struct datafeed_callback *cb_struct;
 
@@ -340,6 +354,8 @@ static int sr_session_iteration(gboolean block)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR Error occured.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_start(void)
 {
@@ -386,6 +402,8 @@ SR_API int sr_session_start(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG Error occured.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_run(void)
 {
@@ -470,6 +488,8 @@ SR_PRIV int sr_session_stop_sync(void)
  *
  * @retval SR_OK Success.
  * @retval SR_ERR_BUG No session exists.
+ *
+ * @since 0.1.0
  */
 SR_API int sr_session_stop(void)
 {
@@ -507,8 +527,8 @@ static void datafeed_dump(const struct sr_datafeed_packet *packet)
                break;
        case SR_DF_LOGIC:
                logic = packet->payload;
-               sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes).",
-                      logic->length);
+               sr_dbg("bus: Received SR_DF_LOGIC packet (%" PRIu64 " bytes, "
+                      "unitsize = %d).", logic->length, logic->unitsize);
                break;
        case SR_DF_ANALOG:
                analog = packet->payload;
@@ -584,7 +604,7 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
  * @retval SR_ERR_MALLOC Memory allocation error.
  */
 static int _sr_session_source_add(GPollFD *pollfd, int timeout,
-       sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object)
+       sr_receive_data_callback cb, void *cb_data, gintptr poll_object)
 {
        struct source *new_sources, *s;
        GPollFD *new_pollfds;
@@ -638,9 +658,11 @@ static int _sr_session_source_add(GPollFD *pollfd, int timeout,
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_MALLOC Memory allocation error.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_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)
 {
        GPollFD p;
 
@@ -661,9 +683,11 @@ SR_API int sr_session_source_add(int fd, int events, int timeout,
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_MALLOC Memory allocation error.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
-               sr_receive_data_callback_t cb, void *cb_data)
+               sr_receive_data_callback cb, void *cb_data)
 {
        return _sr_session_source_add(pollfd, timeout, cb,
                                      cb_data, (gintptr)pollfd);
@@ -681,9 +705,11 @@ SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout,
  * @retval SR_OK Success.
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_MALLOC Memory allocation error.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_source_add_channel(GIOChannel *channel, int events,
-               int timeout, sr_receive_data_callback_t cb, void *cb_data)
+               int timeout, sr_receive_data_callback cb, void *cb_data)
 {
        GPollFD p;
 
@@ -765,6 +791,8 @@ static int _sr_session_source_remove(gintptr poll_object)
  * @retval SR_ERR_ARG Invalid argument
  * @retval SR_ERR_MALLOC Memory allocation error.
  * @retval SR_ERR_BUG Internal error.
+ *
+ * @since 0.3.0
  */
 SR_API int sr_session_source_remove(int fd)
 {
@@ -779,6 +807,8 @@ SR_API int sr_session_source_remove(int fd)
  * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or
  *         SR_ERR_MALLOC upon memory allocation errors, SR_ERR_BUG upon
  *         internal errors.
+ *
+ * @since 0.2.0
  */
 SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
 {
@@ -794,6 +824,8 @@ SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd)
  * @retval SR_ERR_ARG Invalid argument.
  * @retval SR_ERR_MALLOC Memory allocation error.
  * @return SR_ERR_BUG Internal error.
+ *
+ * @since 0.2.0
  */
 SR_API int sr_session_source_remove_channel(GIOChannel *channel)
 {