mem: clarify documentation of virt2iova behaviour
authorAnatoly Burakov <anatoly.burakov@intel.com>
Thu, 14 Nov 2019 14:13:06 +0000 (14:13 +0000)
committerThomas Monjalon <thomas@monjalon.net>
Mon, 25 Nov 2019 23:30:51 +0000 (00:30 +0100)
commitbdc993fa3dc38d6ae2d4d1480604556bc20a5522
treeceb9563bf2c027c11f7c7b105f541259bbcef816
parent19802aaf7ca296c8d4cfbb0583869899f4118a74
mem: clarify documentation of virt2iova behaviour

It may not be immediately clear that rte_mem_virt2iova does not actually
check the internal memseg table, and will instead either return VA (in
IOVA as VA mode), or will fall back to kernel page table walk (in IOVA
as PA mode).

Add a note to API documentation indicating the above.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Reviewed-by: Olivier Matz <olivier.matz@6wind.com>
lib/librte_eal/common/include/rte_memory.h