X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=std.c;h=727ee6e98576e4c9c11b999820ad27f5bc3a3b68;hb=3544f848e0d7f67af8e11ce7ec344b34cd797df3;hp=ed37abeac641b02a760f6e1d46bad285772c002e;hpb=4b4474ed6a4701e28961569eb777052d0b74673d;p=libsigrok.git diff --git a/std.c b/std.c index ed37abea..727ee6e9 100644 --- a/std.c +++ b/std.c @@ -18,10 +18,17 @@ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ +/** @file + * Standard API helper functions. + * @internal + */ + #include #include "libsigrok.h" #include "libsigrok-internal.h" +#define LOG_PREFIX "std" + /** * Standard sr_driver_init() API helper. * @@ -32,7 +39,7 @@ * * @param sr_ctx The libsigrok context to assign. * @param di The driver instance to use. - * @param prefix A driver-specific prefix string used for log messages. + * @param[in] prefix A driver-specific prefix string used for log messages. * * @return SR_OK upon success, SR_ERR_ARG upon invalid arguments, or * SR_ERR_MALLOC upon memory allocation errors. @@ -103,6 +110,56 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, #ifdef HAVE_LIBSERIALPORT +/* + * Standard serial driver dev_open() helper. + * + * This function can be used to implement the dev_open() driver API + * callback in drivers that use a serial port. The port is opened + * with the SERIAL_RDWR and SERIAL_NONBLOCK flags. + * + * If the open succeeded, the status field of the given sdi is set + * to SR_ST_ACTIVE. + * + * @retval SR_OK Success. + * @retval SR_ERR Serial port open failed. + */ +SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi) +{ + struct sr_serial_dev_inst *serial; + + serial = sdi->conn; + if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK) + return SR_ERR; + + sdi->status = SR_ST_ACTIVE; + + return SR_OK; +} + +/* + * Standard serial driver dev_close() helper. + * + * This function can be used to implement the dev_close() driver API + * callback in drivers that use a serial port. + * + * After closing the port, the status field of the given sdi is set + * to SR_ST_INACTIVE. + * + * @retval SR_OK Success. + */ +SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi) +{ + struct sr_serial_dev_inst *serial; + + serial = sdi->conn; + if (serial && sdi->status == SR_ST_ACTIVE) { + serial_close(serial); + sdi->status = SR_ST_INACTIVE; + } + + return SR_OK; +} + /* * Standard sr_session_stop() API helper. * @@ -124,7 +181,7 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, * @retval SR_ERR_DEV_CLOSED Device is closed. * @retval SR_ERR Other errors. */ -SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi, +SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data, dev_close_t dev_close_fn, struct sr_serial_dev_inst *serial, const char *prefix) { @@ -143,7 +200,7 @@ SR_PRIV int std_dev_acquisition_stop_serial(struct sr_dev_inst *sdi, sr_dbg("%sStopping acquisition.", prefix); - if ((ret = sr_source_remove(serial->fd)) < 0) { + if ((ret = serial_source_remove(serial)) < 0) { sr_err("%sFailed to remove source: %d.", prefix, ret); return ret; } @@ -230,3 +287,4 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, return ret; } +