X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fstd.c;h=aadf8236a790a3f79c38ece2cf6ebd191166991c;hb=c01bf34ca264b268fee2e71ab918c71d28dc3018;hp=b9757381291236083ba6acfd8c75ad3d556b47c1;hpb=c1aae90038456a61d0f9313d34e6107c3440d3e7;p=libsigrok.git diff --git a/src/std.c b/src/std.c index b9757381..aadf8236 100644 --- a/src/std.c +++ b/src/std.c @@ -23,9 +23,11 @@ * @internal */ +#include #include #include #include "libsigrok-internal.h" +#include "scpi.h" #define LOG_PREFIX "std" @@ -61,6 +63,28 @@ SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, return SR_OK; } +/** + * Standard driver cleanup() callback API helper + * + * @param di The driver instance to use. + * + * Frees all device instances by calling sr_dev_clear() and then releases any + * resources allocated by std_init(). + * + * @retval SR_OK Success + * @retval SR_ERR_ARG Invalid driver + * +*/ +SR_PRIV int std_cleanup(const struct sr_dev_driver *di) +{ + int ret; + + ret = sr_dev_clear(di); + g_free(di->context); + + return ret; +} + /** * Standard API helper for sending an SR_DF_HEADER packet. * @@ -103,6 +127,38 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, return SR_OK; } +/** + * Standard API helper for sending an SR_DF_END packet. + * + * @param sdi The device instance to use. Must not be NULL. + * @param prefix A driver-specific prefix string used for log messages. + * Must not be NULL. An empty string is allowed. + * + * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or + * SR_ERR upon other errors. + */ +SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi, + const char *prefix) +{ + int ret; + struct sr_datafeed_packet packet; + + if (!sdi || !prefix) + return SR_ERR_ARG; + + sr_dbg("%s: Sending SR_DF_END packet.", prefix); + + packet.type = SR_DF_END; + packet.payload = NULL; + + if ((ret = sr_session_send(sdi, &packet)) < 0) { + sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret); + return ret; + } + + return SR_OK; +} + #ifdef HAVE_LIBSERIALPORT /** @@ -177,11 +233,10 @@ SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi) * @retval SR_ERR Other errors. */ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, - void *cb_data, dev_close_callback dev_close_fn, + dev_close_callback dev_close_fn, struct sr_serial_dev_inst *serial, const char *prefix) { int ret; - struct sr_datafeed_packet packet; if (!prefix) { sr_err("Invalid prefix."); @@ -205,14 +260,7 @@ SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, return ret; } - /* Send SR_DF_END packet to the session bus. */ - sr_dbg("%s: Sending SR_DF_END packet.", prefix); - packet.type = SR_DF_END; - packet.payload = NULL; - if ((ret = sr_session_send(cb_data, &packet)) < 0) { - sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret); - return ret; - } + std_session_send_df_end(sdi, prefix); return SR_OK; } @@ -289,3 +337,22 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, return ret; } + +/** + * Standard implementation for the driver dev_list() callback + * + * This function can be used as the dev_list callback by most drivers that use + * the standard helper functions. It returns the devices contained in the driver + * context instances list. + * + * @param di The driver instance to use. + * + * @return The list of devices/instances of this driver, or NULL upon errors + * or if the list is empty. + */ +SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di) +{ + struct drv_context *drvc = di->context; + + return drvc->instances; +}