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_
42 * Initialize the memzone subsystem (private to eal).
48 int rte_eal_memzone_init(void);
51 * Common log initialization function (private to eal). Determines
52 * where log data is written when no call to rte_openlog_stream is
56 * The default log stream to be used.
61 void eal_log_set_default(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);
103 * Init the default log stream
105 * This function is private to EAL.
108 * 0 on success, negative on error
110 int rte_eal_log_init(const char *id, int facility);
113 * Init the PCI infrastructure
115 * This function is private to EAL.
118 * 0 on success, negative on error
120 int rte_eal_pci_init(void);
122 struct rte_pci_driver;
123 struct rte_pci_device;
126 * Update a pci device object by asking the kernel for the latest information.
128 * This function is private to EAL.
131 * The PCI Bus-Device-Function address to look for
134 * - negative on error.
136 int pci_update_device(const struct rte_pci_addr *addr);
139 * Unbind kernel driver for this device
141 * This function is private to EAL.
144 * 0 on success, negative on error
146 int pci_unbind_kernel_driver(struct rte_pci_device *dev);
149 * Map the PCI resource of a PCI device in virtual memory
151 * This function is private to EAL.
154 * 0 on success, negative on error
156 int pci_uio_map_resource(struct rte_pci_device *dev);
159 * Unmap the PCI resource of a PCI device
161 * This function is private to EAL.
163 void pci_uio_unmap_resource(struct rte_pci_device *dev);
166 * Allocate uio resource for PCI device
168 * This function is private to EAL.
171 * PCI device to allocate uio resource
173 * Pointer to uio resource.
174 * If the function returns 0, the pointer will be filled.
176 * 0 on success, negative on error
178 int pci_uio_alloc_resource(struct rte_pci_device *dev,
179 struct mapped_pci_resource **uio_res);
182 * Free uio resource for PCI device
184 * This function is private to EAL.
187 * PCI device to free uio resource
189 * Pointer to uio resource.
191 void pci_uio_free_resource(struct rte_pci_device *dev,
192 struct mapped_pci_resource *uio_res);
195 * Map device memory to uio resource
197 * This function is private to EAL.
200 * PCI device that has memory information.
202 * Memory resource index of the PCI device.
204 * uio resource that will keep mapping information.
206 * Mapping information index of the uio resource.
208 * 0 on success, negative on error
210 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
211 struct mapped_pci_resource *uio_res, int map_idx);
214 * Init tail queues for non-EAL library structures. This is to allow
215 * the rings, mempools, etc. lists to be shared among multiple processes
217 * This function is private to EAL
220 * 0 on success, negative on error
222 int rte_eal_tailqs_init(void);
225 * Init interrupt handling.
227 * This function is private to EAL.
230 * 0 on success, negative on error
232 int rte_eal_intr_init(void);
235 * Init alarm mechanism. This is to allow a callback be called after
238 * This function is private to EAL.
241 * 0 on success, negative on error
243 int rte_eal_alarm_init(void);
246 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
250 * The module's name which need to be checked
253 * -1 means some error happens(NULL pointer or open failure)
254 * 0 means the module not loaded
255 * 1 means the module loaded
257 int rte_eal_check_module(const char *module_name);
262 * This function is private to the EAL.
264 unsigned eal_cpu_core_id(unsigned lcore_id);
267 * Check if cpu is present.
269 * This function is private to the EAL.
271 int eal_cpu_detected(unsigned lcore_id);
274 * Set TSC frequency from precise value or estimation
276 * This function is private to the EAL.
278 void set_tsc_freq(void);
281 * Get precise TSC frequency from system
283 * This function is private to the EAL.
285 uint64_t get_tsc_freq(void);
288 * Prepare physical memory mapping
289 * i.e. hugepages on Linux and
292 * This function is private to the EAL.
294 int rte_eal_hugepage_init(void);
297 * Creates memory mapping in secondary process
298 * i.e. hugepages on Linux and
301 * This function is private to the EAL.
303 int rte_eal_hugepage_attach(void);
306 * Returns true if the system is able to obtain
307 * physical addresses. Return false if using DMA
308 * addresses through an IOMMU.
310 * Drivers based on uio will not load unless physical
311 * addresses are obtainable. It is only possible to get
312 * physical addresses when running as a privileged user.
314 bool rte_eal_using_phys_addrs(void);
316 #endif /* _EAL_PRIVATE_H_ */