nvme: clarify scatter-gather function docs

Each SGL element must be physically contiguous; this was not clearly
documented, so add an explicit requirement to the next_sge callback
documentation.

Change-Id: I165af531f8509e1b89e3562439b70d75acb23bcf
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-on: https://review.gerrithub.io/371729
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Daniel Verkamp 2017-07-28 09:07:34 -07:00
parent 71904d7f4d
commit 8b5b1abea8

View File

@ -948,6 +948,7 @@ typedef void (*spdk_nvme_req_reset_sgl_cb)(void *cb_arg, uint32_t offset);
* The cb_arg parameter is the value passed to readv/writev. * The cb_arg parameter is the value passed to readv/writev.
* The address parameter contains the virtual address of this segment. * The address parameter contains the virtual address of this segment.
* The length parameter contains the length of this physical segment. * The length parameter contains the length of this physical segment.
* The described segment must be physically contiguous.
*/ */
typedef int (*spdk_nvme_req_next_sge_cb)(void *cb_arg, void **address, uint32_t *length); typedef int (*spdk_nvme_req_next_sge_cb)(void *cb_arg, void **address, uint32_t *length);