Commit 575a4025 authored by Seth Howell's avatar Seth Howell Committed by Jim Harris
Browse files

bdev: Add docs to new functions in bdev_module.h 



Change-Id: I4cde4e74879ef1cbf2d75ff5f8d2f054bf3f3141
Signed-off-by: default avatarSeth Howell <seth.howell@intel.com>
Reviewed-on: https://review.gerrithub.io/416763


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarJohn Kariuki <John.K.Kariuki@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 5d5243e0

include/spdk/bdev_module.h

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