X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=std.c;h=22123fc5d743dc527ca31af3e3cdca549cf8b31d;hb=4a35548bbee613149fa4fbfa3dd9eaacb7511376;hp=5bea8985604914314d0a9cfd46e2bda8b405a87d;hpb=12a33563b9cfd14c6dbf23d89c644f4ba16d304f;p=libsigrok.git diff --git a/std.c b/std.c index 5bea8985..22123fc5 100644 --- a/std.c +++ b/std.c @@ -25,7 +25,7 @@ /** * 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. @@ -37,8 +37,8 @@ * @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 +63,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. @@ -105,23 +105,25 @@ SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, * 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_dev_acquisition_stop_serial(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,7 +136,7 @@ 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); @@ -144,7 +146,7 @@ SR_PRIV int std_hw_dev_acquisition_stop_serial(struct sr_dev_inst *sdi, 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; }