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).
53 * The default log stream to be used.
58 int rte_eal_common_log_init(FILE *default_log);
61 * Fill configuration with number of physical and logical processors
63 * This function is private to EAL.
65 * Parse /proc/cpuinfo to get the number of physical and logical
66 * processors on the machine.
69 * 0 on success, negative on error
71 int rte_eal_cpu_init(void);
76 * This function is private to EAL.
78 * Fill configuration structure with these infos, and return 0 on success.
81 * 0 on success, negative on error
83 int rte_eal_memory_init(void);
88 * This function is private to EAL.
90 * Mmap memory areas used by HPET (high precision event timer) that will
91 * provide our time reference, and configure the TSC frequency also for it
92 * to be used as a reference.
95 * 0 on success, negative on error
97 int rte_eal_timer_init(void);
102 * This function is private to EAL.
105 * 0 on success, negative on error
107 int rte_eal_log_early_init(void);
110 * Init the default log stream
112 * This function is private to EAL.
115 * 0 on success, negative on error
117 int rte_eal_log_init(const char *id, int facility);
120 * Init the default log stream
122 * This function is private to EAL.
125 * 0 on success, negative on error
127 int rte_eal_pci_init(void);
129 #ifdef RTE_LIBRTE_IVSHMEM
131 * Init the memory from IVSHMEM devices
133 * This function is private to EAL.
136 * 0 on success, negative on error
138 int rte_eal_ivshmem_init(void);
141 * Init objects in IVSHMEM devices
143 * This function is private to EAL.
146 * 0 on success, negative on error
148 int rte_eal_ivshmem_obj_init(void);
151 struct rte_pci_driver;
152 struct rte_pci_device;
155 * Unbind kernel driver for this device
157 * This function is private to EAL.
160 * 0 on success, negative on error
162 int pci_unbind_kernel_driver(struct rte_pci_device *dev);
165 * Map the PCI resource of a PCI device in virtual memory
167 * This function is private to EAL.
170 * 0 on success, negative on error
172 int pci_uio_map_resource(struct rte_pci_device *dev);
175 * Unmap the PCI resource of a PCI device
177 * This function is private to EAL.
179 void pci_uio_unmap_resource(struct rte_pci_device *dev);
182 * Allocate uio resource for PCI device
184 * This function is private to EAL.
187 * PCI device to allocate uio resource
189 * Pointer to uio resource.
190 * If the function returns 0, the pointer will be filled.
192 * 0 on success, negative on error
194 int pci_uio_alloc_resource(struct rte_pci_device *dev,
195 struct mapped_pci_resource **uio_res);
198 * Free uio resource for PCI device
200 * This function is private to EAL.
203 * PCI device to free uio resource
205 * Pointer to uio resource.
207 void pci_uio_free_resource(struct rte_pci_device *dev,
208 struct mapped_pci_resource *uio_res);
211 * Map device memory to uio resource
213 * This function is private to EAL.
216 * PCI device that has memory information.
218 * Memory resource index of the PCI device.
220 * uio resource that will keep mapping information.
222 * Mapping information index of the uio resource.
224 * 0 on success, negative on error
226 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
227 struct mapped_pci_resource *uio_res, int map_idx);
230 * Init tail queues for non-EAL library structures. This is to allow
231 * the rings, mempools, etc. lists to be shared among multiple processes
233 * This function is private to EAL
236 * 0 on success, negative on error
238 int rte_eal_tailqs_init(void);
241 * Init interrupt handling.
243 * This function is private to EAL.
246 * 0 on success, negative on error
248 int rte_eal_intr_init(void);
251 * Init alarm mechanism. This is to allow a callback be called after
254 * This function is private to EAL.
257 * 0 on success, negative on error
259 int rte_eal_alarm_init(void);
262 * This function initialises any virtual devices
264 * This function is private to the EAL.
266 int rte_eal_dev_init(void);
269 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
273 * The module's name which need to be checked
276 * -1 means some error happens(NULL pointer or open failure)
277 * 0 means the module not loaded
278 * 1 means the module loaded
280 int rte_eal_check_module(const char *module_name);
285 * This function is private to the EAL.
287 unsigned eal_cpu_core_id(unsigned lcore_id);
290 * Check if cpu is present.
292 * This function is private to the EAL.
294 int eal_cpu_detected(unsigned lcore_id);
297 * Set TSC frequency from precise value or estimation
299 * This function is private to the EAL.
301 void set_tsc_freq(void);
304 * Get precise TSC frequency from system
306 * This function is private to the EAL.
308 uint64_t get_tsc_freq(void);
311 * Prepare physical memory mapping
312 * i.e. hugepages on Linux and
315 * This function is private to the EAL.
317 int rte_eal_hugepage_init(void);
320 * Creates memory mapping in secondary process
321 * i.e. hugepages on Linux and
324 * This function is private to the EAL.
326 int rte_eal_hugepage_attach(void);
328 #endif /* _EAL_PRIVATE_H_ */