lib/librte_power/rte_power_acpi_cpufreq.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 #ifndef _RTE_POWER_ACPI_CPUFREQ_H
  35 #define _RTE_POWER_ACPI_CPUFREQ_H
  36
  37 /**
  38  * @file
  39  * RTE Power Management via userspace ACPI cpufreq
  40  */
  41
  42 #include <rte_common.h>
  43 #include <rte_byteorder.h>
  44 #include <rte_log.h>
  45 #include <rte_string_fns.h>
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 /**
  52  * Initialize power management for a specific lcore. It will check and set the
  53  * governor to userspace for the lcore, get the available frequencies, and
  54  * prepare to set new lcore frequency.
  55  *
  56  * @param lcore_id
  57  *  lcore id.
  58  *
  59  * @return
  60  *  - 0 on success.
  61  *  - Negative on error.
  62  */
  63 int rte_power_acpi_cpufreq_init(unsigned lcore_id);
  64
  65 /**
  66  * Exit power management on a specific lcore. It will set the governor to which
  67  * is before initialized.
  68  *
  69  * @param lcore_id
  70  *  lcore id.
  71  *
  72  * @return
  73  *  - 0 on success.
  74  *  - Negative on error.
  75  */
  76 int rte_power_acpi_cpufreq_exit(unsigned lcore_id);
  77
  78 /**
  79  * Get the available frequencies of a specific lcore. The return value will be
  80  * the minimal one of the total number of available frequencies and the number
  81  * of buffer. The index of available frequencies used in other interfaces
  82  * should be in the range of 0 to this return value.
  83  * It should be protected outside of this function for threadsafe.
  84  *
  85  * @param lcore_id
  86  *  lcore id.
  87  * @param freqs
  88  *  The buffer array to save the frequencies.
  89  * @param num
  90  *  The number of frequencies to get.
  91  *
  92  * @return
  93  *  The number of available frequencies.
  94  */
  95 uint32_t rte_power_acpi_cpufreq_freqs(unsigned lcore_id, uint32_t *freqs,
  96                 uint32_t num);
  97
  98 /**
  99  * Return the current index of available frequencies of a specific lcore. It
 100  * will return 'RTE_POWER_INVALID_FREQ_INDEX = (~0)' if error.
 101  * It should be protected outside of this function for threadsafe.
 102  *
 103  * @param lcore_id
 104  *  lcore id.
 105  *
 106  * @return
 107  *  The current index of available frequencies.
 108  */
 109 uint32_t rte_power_acpi_cpufreq_get_freq(unsigned lcore_id);
 110
 111 /**
 112  * Set the new frequency for a specific lcore by indicating the index of
 113  * available frequencies.
 114  * It should be protected outside of this function for threadsafe.
 115  *
 116  * @param lcore_id
 117  *  lcore id.
 118  * @param index
 119  *  The index of available frequencies.
 120  *
 121  * @return
 122  *  - 1 on success with frequency changed.
 123  *  - 0 on success without frequency changed.
 124  *  - Negative on error.
 125  */
 126 int rte_power_acpi_cpufreq_set_freq(unsigned lcore_id, uint32_t index);
 127
 128 /**
 129  * Scale up the frequency of a specific lcore according to the available
 130  * frequencies.
 131  * It should be protected outside of this function for threadsafe.
 132  *
 133  * @param lcore_id
 134  *  lcore id.
 135  *
 136  * @return
 137  *  - 1 on success with frequency changed.
 138  *  - 0 on success without frequency changed.
 139  *  - Negative on error.
 140  */
 141 int rte_power_acpi_cpufreq_freq_up(unsigned lcore_id);
 142
 143 /**
 144  * Scale down the frequency of a specific lcore according to the available
 145  * frequencies.
 146  * It should be protected outside of this function for threadsafe.
 147  *
 148  * @param lcore_id
 149  *  lcore id.
 150  *
 151  * @return
 152  *  - 1 on success with frequency changed.
 153  *  - 0 on success without frequency changed.
 154  *  - Negative on error.
 155  */
 156 int rte_power_acpi_cpufreq_freq_down(unsigned lcore_id);
 157
 158 /**
 159  * Scale up the frequency of a specific lcore to the highest according to the
 160  * available frequencies.
 161  * It should be protected outside of this function for threadsafe.
 162  *
 163  * @param lcore_id
 164  *  lcore id.
 165  *
 166  * @return
 167  *  - 1 on success with frequency changed.
 168  *  - 0 on success without frequency changed.
 169  *  - Negative on error.
 170  */
 171 int rte_power_acpi_cpufreq_freq_max(unsigned lcore_id);
 172
 173 /**
 174  * Scale down the frequency of a specific lcore to the lowest according to the
 175  * available frequencies.
 176  * It should be protected outside of this function for threadsafe.
 177  *
 178  * @param lcore_id
 179  *  lcore id.
 180  *
 181  * @return
 182  *  - 1 on success with frequency changed.
 183  *  - 0 on success without frequency changed.
 184  *  - Negative on error.
 185  */
 186 int rte_power_acpi_cpufreq_freq_min(unsigned lcore_id);
 187
 188 /**
 189  * Get the turbo status of a specific lcore.
 190  * It should be protected outside of this function for threadsafe.
 191  *
 192  * @param lcore_id
 193  *  lcore id.
 194  *
 195  * @return
 196  *  - 1 Turbo Boost is enabled on this lcore.
 197  *  - 0 Turbo Boost is disabled on this lcore.
 198  *  - Negative on error.
 199  */
 200 int rte_power_acpi_turbo_status(unsigned int lcore_id);
 201
 202 /**
 203  * Enable Turbo Boost on a specific lcore.
 204  * It should be protected outside of this function for threadsafe.
 205  *
 206  * @param lcore_id
 207  *  lcore id.
 208  *
 209  * @return
 210  *  - 0 Turbo Boost is enabled successfully on this lcore.
 211  *  - Negative on error.
 212  */
 213 int rte_power_acpi_enable_turbo(unsigned int lcore_id);
 214
 215 /**
 216  * Disable Turbo Boost on a specific lcore.
 217  * It should be protected outside of this function for threadsafe.
 218  *
 219  * @param lcore_id
 220  *  lcore id.
 221  *
 222  * @return
 223  *  - 0 Turbo Boost disabled successfully on this lcore.
 224  *  - Negative on error.
 225  */
 226 int rte_power_acpi_disable_turbo(unsigned int lcore_id);
 227
 228 #ifdef __cplusplus
 229 }
 230 #endif
 231
 232 #endif