Commit cfbae9c2 authored by Yanbo Zhou's avatar Yanbo Zhou Committed by Ben Walker
Browse files

include/bdev.h: add comments for callback functions 



Change-Id: Ie7234178306cb83f1c9c2838d483fdc8eb8dbb47
Signed-off-by: default avatarYanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/407682


Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
parent f8387aca

include/spdk/bdev.h

+20 −3
Original line number Diff line number Diff line
@@ -52,6 +52,11 @@ extern "C" { 
#define SPDK_BDEV_SMALL_BUF_MAX_SIZE 8192

#define SPDK_BDEV_LARGE_BUF_MAX_SIZE (64 * 1024)



/**

 * Block device remove callback.

 *

 * \param remove_ctx Context for the removed block device.

 */

typedef void (*spdk_bdev_remove_cb_t)(void *remove_ctx);



/**
@@ -104,8 +109,8 @@ enum spdk_bdev_io_type { 
 * Block device completion callback.

 *

 * \param bdev_io Block device I/O that has completed.

 * \param success true if I/O completed successfully or false if it failed; additional error

 *                information may be retrieved from bdev_io by calling

 * \param success True if I/O completed successfully or false if it failed;

 * additional error information may be retrieved from bdev_io by calling

 * spdk_bdev_io_get_nvme_status() or spdk_bdev_io_get_scsi_status().

 * \param cb_arg Callback argument specified when bdev_io was submitted.

 */
@@ -123,7 +128,19 @@ struct spdk_bdev_io_stat { 
	uint64_t ticks_rate;

};



/**

 * Block device initialization callback.

 *

 * \param cb_arg Callback argument.

 * \param rc 0 if block device initialized successfully or negative errno if it failed.

 */

typedef void (*spdk_bdev_init_cb)(void *cb_arg, int rc);



/**

 * Block device finish callback.

 *

 * \param cb_arg Callback argument.

 */

typedef void (*spdk_bdev_fini_cb)(void *cb_arg);

typedef void (*spdk_bdev_get_device_stat_cb)(struct spdk_bdev *bdev,

		struct spdk_bdev_io_stat *stat, void *cb_arg, int rc);