diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/libvfio-user.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/include/libvfio-user.h b/include/libvfio-user.h index a5dcc75..28933a5 100644 --- a/include/libvfio-user.h +++ b/include/libvfio-user.h @@ -655,7 +655,9 @@ vfu_unmap_sg(vfu_ctx_t *vfu_ctx, const dma_sg_t *sg, struct iovec *iov, int cnt); /** - * Read from the dma region exposed by the client. + * Read from the dma region exposed by the client. This can be used as an + * alternative to vfu_map_sg(), if the region is not directly mappable, or DMA + * notification callbacks have not been provided. * * @vfu_ctx: the libvfio-user context * @sg: a DMA segment obtained from dma_addr_to_sg @@ -667,7 +669,9 @@ int vfu_dma_read(vfu_ctx_t *vfu_ctx, dma_sg_t *sg, void *data); /** - * Write to the dma region exposed by the client. + * Write to the dma region exposed by the client. This can be used as an + * alternative to vfu_map_sg(), if the region is not directly mappable, or DMA + * notification callbacks have not been provided. * * @vfu_ctx: the libvfio-user context * @sg: a DMA segment obtained from dma_addr_to_sg |