include/blob_bdev.h: add comments for public APIs

Change-Id: Id429d420a79dbe5efdd6720c0a25e6fe04911c3a
Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/391513
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
Yanbo Zhou 2017-12-13 10:32:43 +08:00 committed by Jim Harris
parent 0aa48e09da
commit c60422dd96

View File

@ -49,9 +49,26 @@ struct spdk_bs_dev;
struct spdk_bdev;
struct spdk_bdev_module_if;
/**
* Create a blobstore block device from a bdev.
*
* \param bdev Bdev to use.
* \param remove_cb Called when the block device is removed.
* \param remove_ctx Argument passed to function remove_cb.
*
* \return a pointer to the blobstore block device on success or NULL otherwise.
*/
struct spdk_bs_dev *spdk_bdev_create_bs_dev(struct spdk_bdev *bdev, spdk_bdev_remove_cb_t remove_cb,
void *remove_ctx);
/**
* Claim the bdev module for the given blobstore.
*
* \param bs_dev Blobstore block device.
* \param module Bdev module to claim.
*
* \return 0 on success, negative errno on failure.
*/
int spdk_bs_bdev_claim(struct spdk_bs_dev *bs_dev, struct spdk_bdev_module_if *module);
#ifdef __cplusplus