4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _EAL_PRIVATE_H_
35 #define _EAL_PRIVATE_H_
40 * Initialize the memzone subsystem (private to eal).
46 int rte_eal_memzone_init(void);
49 * Common log initialization function (private to eal).
51 * Called by environment-specific log initialization function to initialize
55 * The default log stream to be used.
60 int rte_eal_common_log_init(FILE *default_log);
63 * Fill configuration with number of physical and logical processors
65 * This function is private to EAL.
67 * Parse /proc/cpuinfo to get the number of physical and logical
68 * processors on the machine.
71 * 0 on success, negative on error
73 int rte_eal_cpu_init(void);
78 * This function is private to EAL.
80 * Fill configuration structure with these infos, and return 0 on success.
83 * 0 on success, negative on error
85 int rte_eal_memory_init(void);
90 * This function is private to EAL.
92 * Mmap memory areas used by HPET (high precision event timer) that will
93 * provide our time reference, and configure the TSC frequency also for it
94 * to be used as a reference.
97 * 0 on success, negative on error
99 int rte_eal_timer_init(void);
104 * This function is private to EAL.
107 * 0 on success, negative on error
109 int rte_eal_log_early_init(void);
112 * Init the default log stream
114 * This function is private to EAL.
117 * 0 on success, negative on error
119 int rte_eal_log_init(const char *id, int facility);
122 * Init the default log stream
124 * This function is private to EAL.
127 * 0 on success, negative on error
129 int rte_eal_pci_init(void);
131 #ifdef RTE_LIBRTE_IVSHMEM
133 * Init the memory from IVSHMEM devices
135 * This function is private to EAL.
138 * 0 on success, negative on error
140 int rte_eal_ivshmem_init(void);
143 * Init objects in IVSHMEM devices
145 * This function is private to EAL.
148 * 0 on success, negative on error
150 int rte_eal_ivshmem_obj_init(void);
153 struct rte_pci_driver;
154 struct rte_pci_device;
157 * Mmap memory for single PCI device
159 * This function is private to EAL.
162 * 0 on success, negative on error
164 int rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr,
165 struct rte_pci_device *dev);
168 * Munmap memory for single PCI device
170 * This function is private to EAL.
173 * The pointer to the pci driver structure
175 * The pointer to the pci device structure
177 * 0 on success, negative on error
179 int rte_eal_pci_close_one_driver(struct rte_pci_driver *dr,
180 struct rte_pci_device *dev);
183 * Init tail queues for non-EAL library structures. This is to allow
184 * the rings, mempools, etc. lists to be shared among multiple processes
186 * This function is private to EAL
189 * 0 on success, negative on error
191 int rte_eal_tailqs_init(void);
194 * Init interrupt handling.
196 * This function is private to EAL.
199 * 0 on success, negative on error
201 int rte_eal_intr_init(void);
204 * Init alarm mechanism. This is to allow a callback be called after
207 * This function is private to EAL.
210 * 0 on success, negative on error
212 int rte_eal_alarm_init(void);
215 * This function initialises any virtual devices
217 * This function is private to the EAL.
219 int rte_eal_dev_init(void);
222 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
226 * The module's name which need to be checked
229 * -1 means some error happens(NULL pointer or open failure)
230 * 0 means the module not loaded
231 * 1 means the module loaded
233 int rte_eal_check_module(const char *module_name);
235 #endif /* _EAL_PRIVATE_H_ */