pci: remove eal prefix

[dpdk.git] / lib / librte_eal / common / eal_private.h

diff --git a/lib/librte_eal/common/eal_private.h b/lib/librte_eal/common/eal_private.h
index f8e8869..6cacce0 100644 (file)
--- a/lib/librte_eal/common/eal_private.h
+++ b/lib/librte_eal/common/eal_private.h
@@ -34,6 +34,7 @@
 #ifndef _EAL_PRIVATE_H_
 #define _EAL_PRIVATE_H_
 
+#include <stdbool.h>
 #include <stdio.h>
 #include <rte_pci.h>
 
@@ -47,10 +48,9 @@
 int rte_eal_memzone_init(void);
 
 /**
- * Common log initialization function (private to eal).
- *
- * Called by environment-specific log initialization function to initialize
- * log history.
+ * Common log initialization function (private to eal).  Determines
+ * where log data is written when no call to rte_openlog_stream is
+ * in effect.
  *
  * @param default_log
  *   The default log stream to be used.
@@ -58,7 +58,7 @@ int rte_eal_memzone_init(void);
  *   - 0 on success
  *   - Negative on error
  */
-int rte_eal_common_log_init(FILE *default_log);
+void eal_log_set_default(FILE *default_log);
 
 /**
  * Fill configuration with number of physical and logical processors
@@ -100,59 +100,65 @@ int rte_eal_memory_init(void);
 int rte_eal_timer_init(void);
 
 /**
- * Init early logs
+ * Init the default log stream
  *
  * This function is private to EAL.
  *
  * @return
  *   0 on success, negative on error
  */
-int rte_eal_log_early_init(void);
+int rte_eal_log_init(const char *id, int facility);
+
+struct rte_pci_driver;
+struct rte_pci_device;
 
 /**
- * Init the default log stream
+ * Add a PCI device to the PCI Bus (append to PCI Device list). This function
+ * also updates the bus references of the PCI Device (and the generic device
+ * object embedded within.
  *
- * This function is private to EAL.
- *
- * @return
- *   0 on success, negative on error
+ * @param pci_dev
+ *     PCI device to add
+ * @return void
  */
-int rte_eal_log_init(const char *id, int facility);
+void rte_pci_add_device(struct rte_pci_device *pci_dev);
 
 /**
- * Init the default log stream
- *
- * This function is private to EAL.
- *
- * @return
- *   0 on success, negative on error
+ * Insert a PCI device in the PCI Bus at a particular location in the device
+ * list. It also updates the PCI Bus reference of the new devices to be
+ * inserted.
+ *
+ * @param exist_pci_dev
+ *     Existing PCI device in PCI Bus
+ * @param new_pci_dev
+ *     PCI device to be added before exist_pci_dev
+ * @return void
  */
-int rte_eal_pci_init(void);
+void rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
+               struct rte_pci_device *new_pci_dev);
 
-#ifdef RTE_LIBRTE_IVSHMEM
 /**
- * Init the memory from IVSHMEM devices
+ * Remove a PCI device from the PCI Bus. This sets to NULL the bus references
+ * in the PCI device object as well as the generic device object.
  *
- * This function is private to EAL.
- *
- * @return
- *  0 on success, negative on error
+ * @param pci_device
+ *     PCI device to be removed from PCI Bus
+ * @return void
  */
-int rte_eal_ivshmem_init(void);
+void rte_pci_remove_device(struct rte_pci_device *pci_device);
 
 /**
- * Init objects in IVSHMEM devices
+ * Update a pci device object by asking the kernel for the latest information.
  *
  * This function is private to EAL.
  *
+ * @param addr
+ *     The PCI Bus-Device-Function address to look for
  * @return
- *  0 on success, negative on error
+ *   - 0 on success.
+ *   - negative on error.
  */
-int rte_eal_ivshmem_obj_init(void);
-#endif
-
-struct rte_pci_driver;
-struct rte_pci_device;
+int pci_update_device(const struct rte_pci_addr *addr);
 
 /**
  * Unbind kernel driver for this device
@@ -164,24 +170,6 @@ struct rte_pci_device;
  */
 int pci_unbind_kernel_driver(struct rte_pci_device *dev);
 
-/**
- * Map this device
- *
- * This function is private to EAL.
- *
- * @return
- *   0 on success, negative on error and positive if no driver
- *   is found for the device.
- */
-int pci_map_device(struct rte_pci_device *dev);
-
-/**
- * Unmap this device
- *
- * This function is private to EAL.
- */
-void pci_unmap_device(struct rte_pci_device *dev);
-
 /**
  * Map the PCI resource of a PCI device in virtual memory
  *
@@ -279,13 +267,6 @@ int rte_eal_intr_init(void);
  */
 int rte_eal_alarm_init(void);
 
-/**
- * This function initialises any virtual devices
- *
- * This function is private to the EAL.
- */
-int rte_eal_dev_init(void);
-
 /**
  * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
  * etc.) loaded.
@@ -328,4 +309,33 @@ void set_tsc_freq(void);
  */
 uint64_t get_tsc_freq(void);
 
+/**
+ * Prepare physical memory mapping
+ * i.e. hugepages on Linux and
+ *      contigmem on BSD.
+ *
+ * This function is private to the EAL.
+ */
+int rte_eal_hugepage_init(void);
+
+/**
+ * Creates memory mapping in secondary process
+ * i.e. hugepages on Linux and
+ *      contigmem on BSD.
+ *
+ * This function is private to the EAL.
+ */
+int rte_eal_hugepage_attach(void);
+
+/**
+ * Returns true if the system is able to obtain
+ * physical addresses. Return false if using DMA
+ * addresses through an IOMMU.
+ *
+ * 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.
+ */
+bool rte_eal_using_phys_addrs(void);
+
 #endif /* _EAL_PRIVATE_H_ */