lib/librte_eal/common/include/eal_private.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  *
  33  */
  34
  35 #ifndef _EAL_PRIVATE_H_
  36 #define _EAL_PRIVATE_H_
  37
  38 #include <stdio.h>
  39
  40 /**
  41  * Initialize the memzone subsystem (private to eal).
  42  *
  43  * @return
  44  *   - 0 on success
  45  *   - Negative on error
  46  */
  47 int rte_eal_memzone_init(void);
  48
  49 /**
  50  * Common log initialization function (private to eal).
  51  *
  52  * Called by environment-specific log initialization function to initialize
  53  * log history.
  54  *
  55  * @param default_log
  56  *   The default log stream to be used.
  57  * @return
  58  *   - 0 on success
  59  *   - Negative on error
  60  */
  61 int rte_eal_common_log_init(FILE *default_log);
  62
  63 /**
  64  * Fill configuration with number of physical and logical processors
  65  *
  66  * This function is private to EAL.
  67  *
  68  * Parse /proc/cpuinfo to get the number of physical and logical
  69  * processors on the machine.
  70  *
  71  * @return
  72  *   0 on success, negative on error
  73  */
  74 int rte_eal_cpu_init(void);
  75
  76 /**
  77  * Map memory
  78  *
  79  * This function is private to EAL.
  80  *
  81  * Fill configuration structure with these infos, and return 0 on success.
  82  *
  83  * @return
  84  *   0 on success, negative on error
  85  */
  86 int rte_eal_memory_init(void);
  87
  88 /**
  89  * Configure timers
  90  *
  91  * This function is private to EAL.
  92  *
  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.
  96  *
  97  * @return
  98  *   0 on success, negative on error
  99  */
 100 int rte_eal_timer_init(void);
 101
 102 /**
 103  * Init early logs
 104  *
 105  * This function is private to EAL.
 106  *
 107  * @return
 108  *   0 on success, negative on error
 109  */
 110 int rte_eal_log_early_init(void);
 111
 112 /**
 113  * Init the default log stream
 114  *
 115  * This function is private to EAL.
 116  *
 117  * @return
 118  *   0 on success, negative on error
 119  */
 120 int rte_eal_log_init(const char *id, int facility);
 121
 122 /**
 123  * Init the default log stream
 124  *
 125  * This function is private to EAL.
 126  *
 127  * @return
 128  *   0 on success, negative on error
 129  */
 130 int rte_eal_pci_init(void);
 131
 132 struct rte_pci_driver;
 133 struct rte_pci_device;
 134
 135 /**
 136  * Mmap memory for single PCI device
 137  *
 138  * This function is private to EAL.
 139  *
 140  * @return
 141  *   0 on success, negative on error
 142  */
 143 int rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr,
 144                 struct rte_pci_device *dev);
 145
 146 /**
 147  * Init tail queues for non-EAL library structures. This is to allow
 148  * the rings, mempools, etc. lists to be shared among multiple processes
 149  *
 150  * This function is private to EAL
 151  *
 152  * @return
 153  *    0 on success, negative on error
 154  */
 155 int rte_eal_tailqs_init(void);
 156
 157 /**
 158  * Init interrupt handling.
 159  *
 160  * This function is private to EAL.
 161  *
 162  * @return
 163  *  0 on success, negative on error
 164  */
 165 int rte_eal_intr_init(void);
 166
 167 /**
 168  * Init alarm mechanism. This is to allow a callback be called after
 169  * specific time.
 170  *
 171  * This function is private to EAL.
 172  *
 173  * @return
 174  *  0 on success, negative on error
 175  */
 176 int rte_eal_alarm_init(void);
 177
 178 #endif /* _EAL_PRIVATE_H_ */