BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

sr_init/sr_exit: Improve docs, add error checks.

This commit is contained in:
Uwe Hermann 2012-10-21 22:40:43 +02:00
parent 785b9ff290
commit c46762a285
1 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
backend.c
View File

@ -25,13 +25,27 @@
/** /**
* Initialize libsigrok. * Initialize libsigrok.
* *
* @return SR_OK upon success, a (negative) error code otherwise. * This function must be called before any other libsigrok function.
*
* @param ctx Pointer to a libsigrok context struct pointer. Must not be NULL.
* This will be a pointer to a newly allocated libsigrok context
* object upon success, and is undefined upon errors.
*
* @return SR_OK upon success, a (negative) error code otherwise. Upon errors
* the 'ctx' pointer is undefined and should not be used. Upon success,
* the context will be free'd by sr_exit() as part of the libsigrok
* shutdown.
*/ */
SR_API int sr_init(struct sr_context **ctx) SR_API int sr_init(struct sr_context **ctx)
{ {
int ret = SR_ERR; int ret = SR_ERR;
struct sr_context *context; struct sr_context *context;
if (!ctx) {
sr_err("%s(): libsigrok context was NULL.", __func__);
return SR_ERR;
}
/* + 1 to handle when struct sr_context has no members. */ /* + 1 to handle when struct sr_context has no members. */
context = g_try_malloc0(sizeof(struct sr_context) + 1); context = g_try_malloc0(sizeof(struct sr_context) + 1);
@ -42,8 +56,8 @@ SR_API int sr_init(struct sr_context **ctx)
#ifdef HAVE_LIBUSB_1_0 #ifdef HAVE_LIBUSB_1_0
ret = libusb_init(&context->libusb_ctx); ret = libusb_init(&context->libusb_ctx);
if (LIBUSB_SUCCESS != ret) { if (LIBUSB_SUCCESS == ret) {
sr_err("libusb_init() returned %s\n", libusb_error_name(ret)); sr_err("libusb_init() returned %s.\n", libusb_error_name(ret));
goto done; goto done;
} }
#endif #endif
@ -58,10 +72,17 @@ done:
/** /**
* Shutdown libsigrok. * Shutdown libsigrok.
* *
* @param ctx Pointer to a libsigrok context struct. Must not be NULL.
*
* @return SR_OK upon success, a (negative) error code otherwise. * @return SR_OK upon success, a (negative) error code otherwise.
*/ */
SR_API int sr_exit(struct sr_context *ctx) SR_API int sr_exit(struct sr_context *ctx)
{ {
if (!ctx) {
sr_err("%s(): libsigrok context was NULL.", __func__);
return SR_ERR;
}
sr_hw_cleanup_all(); sr_hw_cleanup_all();
#ifdef HAVE_LIBUSB_1_0 #ifdef HAVE_LIBUSB_1_0