ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

bdev: Add docs to new functions in bdev_module.h

Browse Source 
Change-Id: I4cde4e74879ef1cbf2d75ff5f8d2f054bf3f3141
Signed-off-by: Seth Howell <seth.howell@intel.com>
Reviewed-on: https://review.gerrithub.io/416763
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: John Kariuki <John.K.Kariuki@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
Seth Howell 2018-06-25 16:12:07 -07:00 committed by Jim Harris
parent 5d5243e0d3
commit 575a4025c5
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
include/spdk/bdev_module.h
View File

@ -688,14 +688,49 @@ spdk_bdev_io_from_ctx(void *ctx)
struct spdk_bdev_part_base;
/**
* Returns a pointer to the spdk_bdev associated with an spdk_bdev_part_base
*
* \param part_base A pointer to an spdk_bdev_part_base object.
*
* \return A pointer to the base's spdk_bdev struct.
*/
struct spdk_bdev *spdk_bdev_part_base_get_bdev(struct spdk_bdev_part_base *part_base);
/**
* Returns a pointer to the spdk_bdev_descriptor associated with an spdk_bdev_part_base
*
* \param part_base A pointer to an spdk_bdev_part_base object.
*
* \return A pointer to the base's spdk_bdev_desc struct.
*/
struct spdk_bdev_desc *spdk_bdev_part_base_get_desc(struct spdk_bdev_part_base *part_base);
/**
* Returns a pointer to the tailq associated with an spdk_bdev_part_base
*
* \param part_base A pointer to an spdk_bdev_part_base object.
*
* \return The head of a tailq of spdk_bdev_part structs registered to the base's module.
*/
struct bdev_part_tailq *spdk_bdev_part_base_get_tailq(struct spdk_bdev_part_base *part_base);
/**
* Returns a pointer to the module level context associated with an spdk_bdev_part_base
*
* \param part_base A pointer to an spdk_bdev_part_base object.
*
* \return A pointer to the module level context registered with the base in spdk_bdev_part_base_construct.
*/
void *spdk_bdev_part_base_get_ctx(struct spdk_bdev_part_base *part_base);
/**
* Returns the reference number associated with an spdk_bdev_part_base
*
* \param part_base A pointer to an spdk_bdev_part_base object.
*
* \return The base's reference number.
*/
uint32_t spdk_bdev_part_base_get_ref(struct spdk_bdev_part_base *part_base);
typedef void (*spdk_bdev_part_base_free_fn)(void *ctx);