X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=std.c;h=727ee6e98576e4c9c11b999820ad27f5bc3a3b68;hb=7fb5f0a0f5daf0666fded59abf8be63a7fcece46;hp=5bea8985604914314d0a9cfd46e2bda8b405a87d;hpb=12a33563b9cfd14c6dbf23d89c644f4ba16d304f;p=libsigrok.git diff --git a/std.c b/std.c index 5bea8985..727ee6e9 100644 --- a/std.c +++ b/std.c @@ -18,27 +18,34 @@ * 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. * - * This function can be used to simplify most driver's hw_init() API callback. + * This function can be used to simplify most driver's init() API callback. * * It creates a new 'struct drv_context' (drvc), assigns sr_ctx to it, and * then 'drvc' is assigned to the 'struct sr_dev_driver' (di) that is passed. * * @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. */ -SR_PRIV int std_hw_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, - const char *prefix) +SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, + const char *prefix) { struct drv_context *drvc; @@ -63,7 +70,7 @@ SR_PRIV int std_hw_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, * Standard API helper for sending an SR_DF_HEADER packet. * * This function can be used to simplify most driver's - * hw_dev_acquisition_start() API callback. + * dev_acquisition_start() API callback. * * @param sdi The device instance to use. * @param prefix A driver-specific prefix string used for log messages. @@ -101,27 +108,81 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, return SR_OK; } +#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. * * This function can be used to simplify most (serial port based) driver's - * hw_dev_acquisition_stop() API callback. + * dev_acquisition_stop() API callback. * * @param sdi The device instance for which acquisition should stop. * Must not be NULL. * @param cb_data Opaque 'cb_data' pointer. Must not be NULL. - * @param hw_dev_close_fn Function pointer to the driver's hw_dev_close(). + * @param dev_close_fn Function pointer to the driver's dev_close(). * Must not be NULL. * @param serial The serial device instance (struct serial_dev_inst *). * 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. + * @retval SR_OK Success. + * @retval SR_ERR_ARG Invalid arguments. + * @retval SR_ERR_DEV_CLOSED Device is closed. + * @retval SR_ERR Other errors. */ -SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi, - void *cb_data, dev_close_t hw_dev_close_fn, +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) { int ret; @@ -134,17 +195,17 @@ SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi, if (sdi->status != SR_ST_ACTIVE) { sr_err("%sDevice inactive, can't stop acquisition.", prefix); - return SR_ERR; + return SR_ERR_DEV_CLOSED; } 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; } - if ((ret = hw_dev_close_fn(sdi)) < 0) { + if ((ret = dev_close_fn(sdi)) < 0) { sr_err("%sFailed to close device: %d.", prefix, ret); return ret; } @@ -161,6 +222,8 @@ SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi, return SR_OK; } +#endif + /* * Standard driver dev_clear() helper. * @@ -201,12 +264,16 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, driver->dev_close(sdi); if (sdi->conn) { - if (sdi->inst_type == SR_INST_SERIAL) +#if HAVE_LIBSERIALPORT + if (sdi->inst_type == SR_INST_SERIAL) sr_serial_dev_inst_free(sdi->conn); +#endif #if HAVE_LIBUSB_1_0 - else if (sdi->inst_type == SR_INST_USB) + if (sdi->inst_type == SR_INST_USB) sr_usb_dev_inst_free(sdi->conn); #endif + if (sdi->inst_type == SR_INST_SCPI) + sr_scpi_free(sdi->conn); } if (clear_private) clear_private(sdi->priv); @@ -220,3 +287,4 @@ SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, return ret; } +