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_
41 * Initialize the memzone subsystem (private to eal).
47 int rte_eal_memzone_init(void);
50 * Common log initialization function (private to eal).
52 * Called by environment-specific log initialization function to initialize
56 * The default log stream to be used.
61 int rte_eal_common_log_init(FILE *default_log);
64 * Fill configuration with number of physical and logical processors
66 * This function is private to EAL.
68 * Parse /proc/cpuinfo to get the number of physical and logical
69 * processors on the machine.
72 * 0 on success, negative on error
74 int rte_eal_cpu_init(void);
79 * This function is private to EAL.
81 * Fill configuration structure with these infos, and return 0 on success.
84 * 0 on success, negative on error
86 int rte_eal_memory_init(void);
91 * This function is private to EAL.
93 * Mmap memory areas used by HPET (high precision event timer) that will
94 * provide our time reference, and configure the TSC frequency also for it
95 * to be used as a reference.
98 * 0 on success, negative on error
100 int rte_eal_timer_init(void);
105 * This function is private to EAL.
108 * 0 on success, negative on error
110 int rte_eal_log_early_init(void);
113 * Init the default log stream
115 * This function is private to EAL.
118 * 0 on success, negative on error
120 int rte_eal_log_init(const char *id, int facility);
123 * Init the default log stream
125 * This function is private to EAL.
128 * 0 on success, negative on error
130 int rte_eal_pci_init(void);
132 #ifdef RTE_LIBRTE_IVSHMEM
134 * Init the memory from IVSHMEM devices
136 * This function is private to EAL.
139 * 0 on success, negative on error
141 int rte_eal_ivshmem_init(void);
144 * Init objects in IVSHMEM devices
146 * This function is private to EAL.
149 * 0 on success, negative on error
151 int rte_eal_ivshmem_obj_init(void);
154 struct rte_pci_driver;
155 struct rte_pci_device;
158 * Unbind kernel driver for this device
160 * This function is private to EAL.
163 * 0 on success, negative on error
165 int pci_unbind_kernel_driver(struct rte_pci_device *dev);
168 * Map the PCI resource of a PCI device in virtual memory
170 * This function is private to EAL.
173 * 0 on success, negative on error
175 int pci_uio_map_resource(struct rte_pci_device *dev);
178 * Unmap the PCI resource of a PCI device
180 * This function is private to EAL.
182 void pci_uio_unmap_resource(struct rte_pci_device *dev);
185 * Allocate uio resource for PCI device
187 * This function is private to EAL.
190 * PCI device to allocate uio resource
192 * Pointer to uio resource.
193 * If the function returns 0, the pointer will be filled.
195 * 0 on success, negative on error
197 int pci_uio_alloc_resource(struct rte_pci_device *dev,
198 struct mapped_pci_resource **uio_res);
201 * Free uio resource for PCI device
203 * This function is private to EAL.
206 * PCI device to free uio resource
208 * Pointer to uio resource.
210 void pci_uio_free_resource(struct rte_pci_device *dev,
211 struct mapped_pci_resource *uio_res);
214 * Map device memory to uio resource
216 * This function is private to EAL.
219 * PCI device that has memory information.
221 * Memory resource index of the PCI device.
223 * uio resource that will keep mapping information.
225 * Mapping information index of the uio resource.
227 * 0 on success, negative on error
229 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
230 struct mapped_pci_resource *uio_res, int map_idx);
233 * Init tail queues for non-EAL library structures. This is to allow
234 * the rings, mempools, etc. lists to be shared among multiple processes
236 * This function is private to EAL
239 * 0 on success, negative on error
241 int rte_eal_tailqs_init(void);
244 * Init interrupt handling.
246 * This function is private to EAL.
249 * 0 on success, negative on error
251 int rte_eal_intr_init(void);
254 * Init alarm mechanism. This is to allow a callback be called after
257 * This function is private to EAL.
260 * 0 on success, negative on error
262 int rte_eal_alarm_init(void);
265 * This function initialises any virtual devices
267 * This function is private to the EAL.
269 int rte_eal_dev_init(void);
272 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
276 * The module's name which need to be checked
279 * -1 means some error happens(NULL pointer or open failure)
280 * 0 means the module not loaded
281 * 1 means the module loaded
283 int rte_eal_check_module(const char *module_name);
288 * This function is private to the EAL.
290 unsigned eal_cpu_core_id(unsigned lcore_id);
293 * Check if cpu is present.
295 * This function is private to the EAL.
297 int eal_cpu_detected(unsigned lcore_id);
300 * Set TSC frequency from precise value or estimation
302 * This function is private to the EAL.
304 void set_tsc_freq(void);
307 * Get precise TSC frequency from system
309 * This function is private to the EAL.
311 uint64_t get_tsc_freq(void);
314 * Prepare physical memory mapping
315 * i.e. hugepages on Linux and
318 * This function is private to the EAL.
320 int rte_eal_hugepage_init(void);
323 * Creates memory mapping in secondary process
324 * i.e. hugepages on Linux and
327 * This function is private to the EAL.
329 int rte_eal_hugepage_attach(void);
331 #endif /* _EAL_PRIVATE_H_ */