lib: use SPDX tag for Intel copyright files
[dpdk.git] / lib / librte_eal / common / eal_private.h
index 159cd66..c46dd8f 100644 (file)
@@ -1,39 +1,12 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2014 Intel Corporation
  */
 
 #ifndef _EAL_PRIVATE_H_
 #define _EAL_PRIVATE_H_
 
+#include <stdbool.h>
+#include <stdint.h>
 #include <stdio.h>
 
 /**
 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.
@@ -57,7 +29,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
@@ -99,122 +71,128 @@ 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);
 
 /**
- * Init the default log stream
+ * Init tail queues for non-EAL library structures. This is to allow
+ * the rings, mempools, etc. lists to be shared among multiple processes
  *
- * This function is private to EAL.
+ * This function is private to EAL
  *
  * @return
- *   0 on success, negative on error
+ *    0 on success, negative on error
  */
-int rte_eal_log_init(const char *id, int facility);
+int rte_eal_tailqs_init(void);
 
 /**
- * Init the default log stream
+ * Init interrupt handling.
  *
  * This function is private to EAL.
  *
  * @return
- *   0 on success, negative on error
+ *  0 on success, negative on error
  */
-int rte_eal_pci_init(void);
+int rte_eal_intr_init(void);
 
-#ifdef RTE_LIBRTE_IVSHMEM
 /**
- * Init the memory from IVSHMEM devices
+ * Init alarm mechanism. This is to allow a callback be called after
+ * specific time.
  *
  * This function is private to EAL.
  *
  * @return
  *  0 on success, negative on error
  */
-int rte_eal_ivshmem_init(void);
+int rte_eal_alarm_init(void);
 
 /**
- * Init objects in IVSHMEM devices
+ * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
+ * etc.) loaded.
  *
- * This function is private to EAL.
+ * @param module_name
+ *     The module's name which need to be checked
  *
  * @return
- *  0 on success, negative on error
+ *     -1 means some error happens(NULL pointer or open failure)
+ *     0  means the module not loaded
+ *     1  means the module loaded
  */
-int rte_eal_ivshmem_obj_init(void);
-#endif
-
-struct rte_pci_driver;
-struct rte_pci_device;
+int rte_eal_check_module(const char *module_name);
 
 /**
- * Mmap memory for single PCI device
+ * Get cpu core_id.
  *
- * This function is private to EAL.
+ * This function is private to the EAL.
+ */
+unsigned eal_cpu_core_id(unsigned lcore_id);
+
+/**
+ * Check if cpu is present.
  *
- * @return
- *   0 on success, negative on error
+ * This function is private to the EAL.
  */
-int rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr,
-               struct rte_pci_device *dev);
+int eal_cpu_detected(unsigned lcore_id);
 
 /**
- * Init tail queues for non-EAL library structures. This is to allow
- * the rings, mempools, etc. lists to be shared among multiple processes
+ * Set TSC frequency from precise value or estimation
  *
- * This function is private to EAL
+ * This function is private to the EAL.
+ */
+void set_tsc_freq(void);
+
+/**
+ * Get precise TSC frequency from system
  *
- * @return
- *    0 on success, negative on error
+ * This function is private to the EAL.
  */
-int rte_eal_tailqs_init(void);
+uint64_t get_tsc_freq(void);
 
 /**
- * Init interrupt handling.
+ * Get TSC frequency if the architecture supports.
  *
- * This function is private to EAL.
+ * This function is private to the EAL.
  *
  * @return
- *  0 on success, negative on error
+ *   The number of TSC cycles in one second.
+ *   Returns zero if the architecture support is not available.
  */
-int rte_eal_intr_init(void);
+uint64_t get_tsc_freq_arch(void);
 
 /**
- * Init alarm mechanism. This is to allow a callback be called after
- * specific time.
- *
- * This function is private to EAL.
+ * Prepare physical memory mapping
+ * i.e. hugepages on Linux and
+ *      contigmem on BSD.
  *
- * @return
- *  0 on success, negative on error
+ * This function is private to the EAL.
  */
-int rte_eal_alarm_init(void);
+int rte_eal_hugepage_init(void);
 
 /**
- * This function initialises any virtual devices
+ * 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_dev_init(void);
+int rte_eal_hugepage_attach(void);
 
 /**
- * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
- * etc.) loaded.
+ * Find a bus capable of identifying a device.
  *
- * @param module_name
- *     The module's name which need to be checked
+ * @param str
+ *   A device identifier (PCI address, virtual PMD name, ...).
  *
  * @return
- *     -1 means some error happens(NULL pointer or open failure)
- *     0  means the module not loaded
- *     1  means the module loaded
+ *   A valid bus handle if found.
+ *   NULL if no bus is able to parse this device.
  */
-int rte_eal_check_module(const char *module_name);
+struct rte_bus *rte_bus_find_by_device_name(const char *str);
 
 #endif /* _EAL_PRIVATE_H_ */