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);
112 struct rte_pci_driver;
113 struct rte_pci_device;
116 * Add a PCI device to the PCI Bus (append to PCI Device list). This function
117 * also updates the bus references of the PCI Device (and the generic device
118 * object embedded within.
124 void rte_pci_add_device(struct rte_pci_device *pci_dev);
127 * Insert a PCI device in the PCI Bus at a particular location in the device
128 * list. It also updates the PCI Bus reference of the new devices to be
131 * @param exist_pci_dev
132 * Existing PCI device in PCI Bus
134 * PCI device to be added before exist_pci_dev
137 void rte_pci_insert_device(struct rte_pci_device *exist_pci_dev,
138 struct rte_pci_device *new_pci_dev);
141 * Remove a PCI device from the PCI Bus. This sets to NULL the bus references
142 * in the PCI device object as well as the generic device object.
145 * PCI device to be removed from PCI Bus
148 void rte_pci_remove_device(struct rte_pci_device *pci_device);
151 * Update a pci device object by asking the kernel for the latest information.
153 * This function is private to EAL.
156 * The PCI Bus-Device-Function address to look for
159 * - negative on error.
161 int pci_update_device(const struct rte_pci_addr *addr);
164 * Unbind kernel driver for this device
166 * This function is private to EAL.
169 * 0 on success, negative on error
171 int pci_unbind_kernel_driver(struct rte_pci_device *dev);
174 * Map the PCI resource of a PCI device in virtual memory
176 * This function is private to EAL.
179 * 0 on success, negative on error
181 int pci_uio_map_resource(struct rte_pci_device *dev);
184 * Unmap the PCI resource of a PCI device
186 * This function is private to EAL.
188 void pci_uio_unmap_resource(struct rte_pci_device *dev);
191 * Allocate uio resource for PCI device
193 * This function is private to EAL.
196 * PCI device to allocate uio resource
198 * Pointer to uio resource.
199 * If the function returns 0, the pointer will be filled.
201 * 0 on success, negative on error
203 int pci_uio_alloc_resource(struct rte_pci_device *dev,
204 struct mapped_pci_resource **uio_res);
207 * Free uio resource for PCI device
209 * This function is private to EAL.
212 * PCI device to free uio resource
214 * Pointer to uio resource.
216 void pci_uio_free_resource(struct rte_pci_device *dev,
217 struct mapped_pci_resource *uio_res);
220 * Map device memory to uio resource
222 * This function is private to EAL.
225 * PCI device that has memory information.
227 * Memory resource index of the PCI device.
229 * uio resource that will keep mapping information.
231 * Mapping information index of the uio resource.
233 * 0 on success, negative on error
235 int pci_uio_map_resource_by_index(struct rte_pci_device *dev, int res_idx,
236 struct mapped_pci_resource *uio_res, int map_idx);
239 * Init tail queues for non-EAL library structures. This is to allow
240 * the rings, mempools, etc. lists to be shared among multiple processes
242 * This function is private to EAL
245 * 0 on success, negative on error
247 int rte_eal_tailqs_init(void);
250 * Init interrupt handling.
252 * This function is private to EAL.
255 * 0 on success, negative on error
257 int rte_eal_intr_init(void);
260 * Init alarm mechanism. This is to allow a callback be called after
263 * This function is private to EAL.
266 * 0 on success, negative on error
268 int rte_eal_alarm_init(void);
271 * Function is to check if the kernel module(like, vfio, vfio_iommu_type1,
275 * The module's name which need to be checked
278 * -1 means some error happens(NULL pointer or open failure)
279 * 0 means the module not loaded
280 * 1 means the module loaded
282 int rte_eal_check_module(const char *module_name);
287 * This function is private to the EAL.
289 unsigned eal_cpu_core_id(unsigned lcore_id);
292 * Check if cpu is present.
294 * This function is private to the EAL.
296 int eal_cpu_detected(unsigned lcore_id);
299 * Set TSC frequency from precise value or estimation
301 * This function is private to the EAL.
303 void set_tsc_freq(void);
306 * Get precise TSC frequency from system
308 * This function is private to the EAL.
310 uint64_t get_tsc_freq(void);
313 * Prepare physical memory mapping
314 * i.e. hugepages on Linux and
317 * This function is private to the EAL.
319 int rte_eal_hugepage_init(void);
322 * Creates memory mapping in secondary process
323 * i.e. hugepages on Linux and
326 * This function is private to the EAL.
328 int rte_eal_hugepage_attach(void);
331 * Returns true if the system is able to obtain
332 * physical addresses. Return false if using DMA
333 * addresses through an IOMMU.
335 * Drivers based on uio will not load unless physical
336 * addresses are obtainable. It is only possible to get
337 * physical addresses when running as a privileged user.
339 bool rte_eal_using_phys_addrs(void);
341 #endif /* _EAL_PRIVATE_H_ */