mem: rename segment address from physical to IOVA
[dpdk.git] / lib / librte_eal / common / include / rte_memory.h
index c545963..d16b284 100644 (file)
@@ -44,8 +44,6 @@
 #include <stddef.h>
 #include <stdio.h>
 
-#include <rte_config.h>
-
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -94,14 +92,27 @@ enum rte_page_sizes {
  */
 #define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
 
-typedef uint64_t phys_addr_t; /**< Physical address definition. */
+typedef uint64_t phys_addr_t; /**< Physical address. */
 #define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1)
+/**
+ * IO virtual address type.
+ * When the physical addressing mode (IOVA as PA) is in use,
+ * the translation from an IO virtual address (IOVA) to a physical address
+ * is a direct mapping, i.e. the same value.
+ * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation.
+ */
+typedef uint64_t rte_iova_t;
+#define RTE_BAD_IOVA ((rte_iova_t)-1)
 
 /**
  * Physical memory segment descriptor.
  */
 struct rte_memseg {
-       phys_addr_t phys_addr;      /**< Start physical address. */
+       RTE_STD_C11
+       union {
+               phys_addr_t phys_addr;  /**< deprecated - Start physical address. */
+               rte_iova_t iova;        /**< Start IO address. */
+       };
        RTE_STD_C11
        union {
                void *addr;         /**< Start virtual address. */
@@ -132,7 +143,7 @@ int rte_mem_lock_page(const void *virt);
  * @param virt
  *   The virtual address.
  * @return
- *   The physical address or RTE_BAD_PHYS_ADDR on error.
+ *   The physical address or RTE_BAD_IOVA on error.
  */
 phys_addr_t rte_mem_virt2phy(const void *virt);
 
@@ -187,6 +198,17 @@ unsigned rte_memory_get_nchannel(void);
  */
 unsigned rte_memory_get_nrank(void);
 
+/**
+ * Drivers based on uio will not load unless physical
+ * addresses are obtainable. It is only possible to get
+ * physical addresses when running as a privileged user.
+ *
+ * @return
+ *   1 if the system is able to obtain physical addresses.
+ *   0 if using DMA addresses through an IOMMU.
+ */
+int rte_eal_using_phys_addrs(void);
+
 #ifdef __cplusplus
 }
 #endif