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). Determines
51 * where log data is written when no call to rte_openlog_stream is
55 * The default log stream to be used.
60 void eal_log_set_default(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);
102 * Init the default log stream
104 * This function is private to EAL.
107 * 0 on success, negative on error
109 int rte_eal_log_init(const char *id, int facility);
112 * Init the PCI infrastructure
114 * This function is private to EAL.
117 * 0 on success, negative on error
119 int rte_eal_pci_init(void);
121 struct rte_pci_driver;
122 struct rte_pci_device;
125 * Update a pci device object by asking the kernel for the latest information.
127 * This function is private to EAL.
130 * The PCI Bus-Device-Function address to look for
133 * - negative on error.
135 int pci_update_device(const struct rte_pci_addr *addr);
138 * Unbind kernel driver for this device
140 * This function is private to EAL.
143 * 0 on success, negative on error
145 int pci_unbind_kernel_driver(struct rte_pci_device *dev);
148 * Map the PCI resource of a PCI device in virtual memory
150 * This function is private to EAL.
153 * 0 on success, negative on error
155 int pci_uio_map_resource(struct rte_pci_device *dev);
158 * Unmap the PCI resource of a PCI device
160 * This function is private to EAL.
162 void pci_uio_unmap_resource(struct rte_pci_device *dev);
165 * Allocate uio resource for PCI device
167 * This function is private to EAL.
170 * PCI device to allocate uio resource
172 * Pointer to uio resource.
173 * If the function returns 0, the pointer will be filled.
175 * 0 on success, negative on error
177 int pci_uio_alloc_resource(struct rte_pci_device *dev,
178 struct mapped_pci_resource **uio_res);
181 * Free uio resource for PCI device
183 * This function is private to EAL.
186 * PCI device to free uio resource
188 * Pointer to uio resource.
190 void pci_uio_free_resource(struct rte_pci_device *dev,
191 struct mapped_pci_resource *uio_res);
194 * Map device memory to uio resource
196 * This function is private to EAL.
199 * PCI device that has memory information.
201 * Memory resource index of the PCI device.
203 * uio resource that will keep mapping information.
205 * Mapping information index of the uio resource.
207 * 0 on success, negative on error
209 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
210 struct mapped_pci_resource *uio_res, int map_idx);
213 * Init tail queues for non-EAL library structures. This is to allow
214 * the rings, mempools, etc. lists to be shared among multiple processes
216 * This function is private to EAL
219 * 0 on success, negative on error
221 int rte_eal_tailqs_init(void);
224 * Init interrupt handling.
226 * This function is private to EAL.
229 * 0 on success, negative on error
231 int rte_eal_intr_init(void);
234 * Init alarm mechanism. This is to allow a callback be called after
237 * This function is private to EAL.
240 * 0 on success, negative on error
242 int rte_eal_alarm_init(void);
245 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
249 * The module's name which need to be checked
252 * -1 means some error happens(NULL pointer or open failure)
253 * 0 means the module not loaded
254 * 1 means the module loaded
256 int rte_eal_check_module(const char *module_name);
261 * This function is private to the EAL.
263 unsigned eal_cpu_core_id(unsigned lcore_id);
266 * Check if cpu is present.
268 * This function is private to the EAL.
270 int eal_cpu_detected(unsigned lcore_id);
273 * Set TSC frequency from precise value or estimation
275 * This function is private to the EAL.
277 void set_tsc_freq(void);
280 * Get precise TSC frequency from system
282 * This function is private to the EAL.
284 uint64_t get_tsc_freq(void);
287 * Prepare physical memory mapping
288 * i.e. hugepages on Linux and
291 * This function is private to the EAL.
293 int rte_eal_hugepage_init(void);
296 * Creates memory mapping in secondary process
297 * i.e. hugepages on Linux and
300 * This function is private to the EAL.
302 int rte_eal_hugepage_attach(void);
304 #endif /* _EAL_PRIVATE_H_ */