Commit c60422dd authored by Yanbo Zhou's avatar Yanbo Zhou Committed by Jim Harris
Browse files

include/blob_bdev.h: add comments for public APIs 



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


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 0aa48e09

include/spdk/blob_bdev.h

+17 −0
Original line number Diff line number Diff line
@@ -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