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

include/copy_engine.h: add comments for public APIs

Browse Source 
Change-Id: I838fc6a280d0df3516f432ae02d239290fa9809a
Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/402649
Reviewed-by: GangCao <gang.cao@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Yanbo Zhou 2018-03-06 16:27:30 +08:00 committed by Jim Harris
parent b24fdae1a8
commit ca91d671e3
1 changed files with 59 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
include/spdk/copy_engine.h
View File

@ -51,15 +51,74 @@ struct spdk_io_channel;
struct spdk_copy_task;
/**
* Initialize the copy engine.
*
* \return 0 on success.
*/
int spdk_copy_engine_initialize(void);
/**
* Close the copy engine.
*
* \param cb_fn Called when the close operation completes.
* \param cb_arg Argument passed to the callback function.
*/
void spdk_copy_engine_finish(spdk_copy_fini_cb cb_fn, void *cb_arg);
/**
* Close the copy engine module and perform any necessary cleanup.
*/
void spdk_copy_engine_module_finish(void);
/**
* Get the I/O channel registered on the copy engine.
*
* This I/O channel is used to submit copy request.
*
* \return a pointer to the I/O channel on success, or NULL on failure.
*/
struct spdk_io_channel *spdk_copy_engine_get_io_channel(void);
/**
* Submit a copy request.
*
* \param copy_req Copy request task.
* \param ch I/O channel to submit request to the copy engine. This channel can
* be obtained by the function spdk_copy_engine_get_io_channel().
* \param dst Destination to copy to.
* \param src Source to copy from.
* \param nbytes Length in bytes to copy.
* \param cb Called when this copy operation completes.
*
* \return 0 on success, negative errno on failure.
*/
int spdk_copy_submit(struct spdk_copy_task *copy_req, struct spdk_io_channel *ch, void *dst,
void *src, uint64_t nbytes, spdk_copy_completion_cb cb);
/**
* Submit a fill request.
*
* This operation will fill the destination buffer with the specified value.
*
* \param copy_req Copy request task.
* \param ch I/O channel to submit request to the copy engine. This channel can
* be obtained by the function spdk_copy_engine_get_io_channel().
* \param dst Destination to fill.
* \param fill Constant byte to fill to the destination.
* \param nbytes Length in bytes to fill.
* \param cb Called when this copy operation completes.
*
* \return 0 on success, negative errno on failure.
*/
int spdk_copy_submit_fill(struct spdk_copy_task *copy_req, struct spdk_io_channel *ch,
void *dst, uint8_t fill, uint64_t nbytes, spdk_copy_completion_cb cb);
/**
* Get the size of copy task.
*
* \return the size of copy task.
*/
size_t spdk_copy_task_size(void);
#ifdef __cplusplus