lib/librte_power/rte_power_kvm_vm.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_KVM_VM_H
  35 #define _RTE_POWER_KVM_VM_H
  36
  37 /**
  38  * @file
  39  * RTE Power Management KVM VM
  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.
  53  *
  54  * @param lcore_id
  55  *  lcore id.
  56  *
  57  * @return
  58  *  - 0 on success.
  59  *  - Negative on error.
  60  */
  61 int rte_power_kvm_vm_init(unsigned lcore_id);
  62
  63 /**
  64  * Exit power management on a specific lcore.
  65  *
  66  * @param lcore_id
  67  *  lcore id.
  68  *
  69  * @return
  70  *  - 0 on success.
  71  *  - Negative on error.
  72  */
  73 int rte_power_kvm_vm_exit(unsigned lcore_id);
  74
  75 /**
  76  * Get the available frequencies of a specific lcore.
  77  * It is not currently supported for VM Power Management.
  78  *
  79  * @param lcore_id
  80  *  lcore id.
  81  * @param freqs
  82  *  The buffer array to save the frequencies.
  83  * @param num
  84  *  The number of frequencies to get.
  85  *
  86  * @return
  87  *  -ENOTSUP
  88  */
  89 uint32_t rte_power_kvm_vm_freqs(unsigned lcore_id, uint32_t *freqs,
  90                 uint32_t num);
  91
  92 /**
  93  * Return the current index of available frequencies of a specific lcore.
  94  * It is not currently supported for VM Power Management.
  95  *
  96  * @param lcore_id
  97  *  lcore id.
  98  *
  99  * @return
 100  *  -ENOTSUP
 101  */
 102 uint32_t rte_power_kvm_vm_get_freq(unsigned lcore_id);
 103
 104 /**
 105  * Set the new frequency for a specific lcore by indicating the index of
 106  * available frequencies.
 107  * It is not currently supported for VM Power Management.
 108  *
 109  * @param lcore_id
 110  *  lcore id.
 111  * @param index
 112  *  The index of available frequencies.
 113  *
 114  * @return
 115  *  -ENOTSUP
 116  */
 117 int rte_power_kvm_vm_set_freq(unsigned lcore_id, uint32_t index);
 118
 119 /**
 120  * Scale up the frequency of a specific lcore. This request is forwarded to the
 121  * host monitor.
 122  * It should be protected outside of this function for threadsafe.
 123  *
 124  * @param lcore_id
 125  *  lcore id.
 126  *
 127  * @return
 128  *  - 1 on success.
 129  *  - Negative on error.
 130  */
 131 int rte_power_kvm_vm_freq_up(unsigned lcore_id);
 132
 133 /**
 134  * Scale down the frequency of a specific lcore according to the available
 135  * frequencies.
 136  * It should be protected outside of this function for threadsafe.
 137  *
 138  * @param lcore_id
 139  *  lcore id.
 140  *
 141  * @return
 142  *  - 1 on success.
 143  *  - Negative on error.
 144  */
 145 int rte_power_kvm_vm_freq_down(unsigned lcore_id);
 146
 147 /**
 148  * Scale up the frequency of a specific lcore to the highest according to the
 149  * available frequencies.
 150  * It should be protected outside of this function for threadsafe.
 151  *
 152  * @param lcore_id
 153  *  lcore id.
 154  *
 155  * @return
 156  *  - 1 on success.
 157  *  - Negative on error.
 158  */
 159 int rte_power_kvm_vm_freq_max(unsigned lcore_id);
 160
 161 /**
 162  * Scale down the frequency of a specific lcore to the lowest according to the
 163  * available frequencies.
 164  * It should be protected outside of this function for threadsafe.
 165  *
 166  * @param lcore_id
 167  *  lcore id.
 168  *
 169  * @return
 170  *  - 1 on success.
 171  *  - Negative on error.
 172  */
 173 int rte_power_kvm_vm_freq_min(unsigned lcore_id);
 174
 175 /**
 176  * It should be protected outside of this function for threadsafe.
 177  *
 178  * @param lcore_id
 179  *  lcore id.
 180  *
 181  * @return
 182  *  -ENOTSUP
 183  */
 184 int rte_power_kvm_vm_turbo_status(unsigned int lcore_id);
 185
 186 /**
 187  * It should be protected outside of this function for threadsafe.
 188  *
 189  * @param lcore_id
 190  *  lcore id.
 191  *
 192  * @return
 193  *  - 1 on success.
 194  *  - Negative on error.
 195  */
 196 int rte_power_kvm_vm_enable_turbo(unsigned int lcore_id);
 197
 198 /**
 199  * It should be protected outside of this function for threadsafe.
 200  *
 201  * @param lcore_id
 202  *  lcore id.
 203  *
 204  * @return
 205  *  - 1 on success.
 206  *  - Negative on error.
 207  */
 208 int rte_power_kvm_vm_disable_turbo(unsigned int lcore_id);
 209 #ifdef __cplusplus
 210 }
 211 #endif
 212 #endif