X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=session.c;h=81e09b114dc59c44a2300dd85ad927329a7714ba;hb=6b7ace4832b3b574399098de2ad4f4bd0f35a14e;hp=0c57a87ba3a6573e73b00c24c173deb84a830b27;hpb=b4bd70889f3009f5d836a9bf701725a6aceac039;p=libsigrok.git diff --git a/session.c b/session.c index 0c57a87b..81e09b11 100644 --- a/session.c +++ b/session.c @@ -25,6 +25,20 @@ #include "libsigrok.h" #include "libsigrok-internal.h" +/** + * @file + * + * Creating, using, or destroying libsigrok sessions. + */ + +/** + * @defgroup grp_session Session handling + * + * Creating, using, or destroying libsigrok sessions. + * + * @{ + */ + struct source { int timeout; sr_receive_data_callback_t cb; @@ -43,7 +57,7 @@ struct sr_session *session; /** * Create a new session. * - * TODO: Should it use the file-global "session" variable or take an argument? + * @todo Should it use the file-global "session" variable or take an argument? * The same question applies to all the other session functions. * * @return A pointer to the newly allocated session, or NULL upon errors. @@ -78,8 +92,6 @@ SR_API int sr_session_destroy(void) /* TODO: Error checks needed? */ - /* TODO: Loop over protocol decoders and free them. */ - g_free(session); session = NULL; @@ -93,7 +105,7 @@ static void sr_dev_close(struct sr_dev_inst *sdi) } /** - * Remove all the devices from the current session. TODO? + * Remove all the devices from the current session. * * The session itself (i.e., the struct sr_session) is not free'd and still * exists after this function returns. @@ -114,9 +126,9 @@ SR_API int sr_session_dev_remove_all(void) } /** - * Add a device to the current session. + * Add a device instance to the current session. * - * @param dev The device instance to add to the current session. Must not + * @param sdi The device instance to add to the current session. Must not * be NULL. Also, sdi->driver and sdi->driver->dev_open must * not be NULL. * @@ -276,8 +288,6 @@ SR_API int sr_session_start(void) /** * Run the session. * - * TODO: Various error checks etc. - * * @return SR_OK upon success, SR_ERR_BUG upon errors. */ SR_API int sr_session_run(void) @@ -408,7 +418,7 @@ static void datafeed_dump(struct sr_datafeed_packet *packet) * * Hardware drivers use this to send a data packet to the frontend. * - * @param dev TODO. + * @param sdi TODO. * @param packet The datafeed packet to send to the session bus. * * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments. @@ -441,6 +451,18 @@ SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, return SR_OK; } +/** + * Add an event source for a file descriptor. + * + * @param pollfd The GPollFD. + * @param timeout Max time to wait before the callback is called, ignored if 0. + * @param cb Callback function to add. Must not be NULL. + * @param cb_data Data for the callback function. Can be NULL. + * @param poll_object TODO. + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or + * SR_ERR_MALLOC upon memory allocation errors. + */ static int _sr_session_source_add(GPollFD *pollfd, int timeout, sr_receive_data_callback_t cb, void *cb_data, gintptr poll_object) { @@ -485,7 +507,7 @@ static int _sr_session_source_add(GPollFD *pollfd, int timeout, } /** - * Add a event source for a file descriptor. + * Add an event source for a file descriptor. * * @param fd The file descriptor. * @param events Events to check for. @@ -510,8 +532,6 @@ SR_API int sr_session_source_add(int fd, int events, int timeout, /** * Add an event source for a GPollFD. * - * TODO: More error checks etc. - * * @param pollfd The GPollFD. * @param timeout Max time to wait before the callback is called, ignored if 0. * @param cb Callback function to add. Must not be NULL. @@ -530,8 +550,6 @@ SR_API int sr_session_source_add_pollfd(GPollFD *pollfd, int timeout, /** * Add an event source for a GIOChannel. * - * TODO: More error checks etc. - * * @param channel The GIOChannel. * @param events Events to poll on. * @param timeout Max time to wait before the callback is called, ignored if 0. @@ -547,8 +565,7 @@ SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, GPollFD p; #ifdef _WIN32 - g_io_channel_win32_make_pollfd(channel, - events, &p); + g_io_channel_win32_make_pollfd(channel, events, &p); #else p.fd = g_io_channel_unix_get_fd(channel); p.events = events; @@ -557,7 +574,17 @@ SR_API int sr_session_source_add_channel(GIOChannel *channel, int events, return _sr_session_source_add(&p, timeout, cb, cb_data, (gintptr)channel); } - +/** + * Remove the source belonging to the specified channel. + * + * @todo Add more error checks and logging. + * + * @param channel The channel for which the source should be removed. + * + * @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. + */ static int _sr_session_source_remove(gintptr poll_object) { struct source *new_sources; @@ -605,11 +632,9 @@ static int _sr_session_source_remove(gintptr poll_object) return SR_OK; } -/* +/** * Remove the source belonging to the specified file descriptor. * - * TODO: More error checks. - * * @param fd The file descriptor for which the source should be removed. * * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or @@ -624,8 +649,6 @@ SR_API int sr_session_source_remove(int fd) /** * Remove the source belonging to the specified poll descriptor. * - * TODO: More error checks. - * * @param pollfd The poll descriptor for which the source should be removed. * * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or @@ -637,11 +660,9 @@ SR_API int sr_session_source_remove_pollfd(GPollFD *pollfd) return _sr_session_source_remove((gintptr)pollfd); } -/* +/** * Remove the source belonging to the specified channel. * - * TODO: More error checks. - * * @param channel The channel for which the source should be removed. * * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or @@ -652,3 +673,5 @@ SR_API int sr_session_source_remove_channel(GIOChannel *channel) { return _sr_session_source_remove((gintptr)channel); } + +/** @} */