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 _RTE_POWER_KVM_VM_H
35 #define _RTE_POWER_KVM_VM_H
39 * RTE Power Management KVM VM
42 #include <rte_common.h>
43 #include <rte_byteorder.h>
45 #include <rte_string_fns.h>
52 * Initialize power management for a specific lcore.
59 * - Negative on error.
61 int rte_power_kvm_vm_init(unsigned lcore_id);
64 * Exit power management on a specific lcore.
71 * - Negative on error.
73 int rte_power_kvm_vm_exit(unsigned lcore_id);
76 * Get the available frequencies of a specific lcore.
77 * It is not currently supported for VM Power Management.
82 * The buffer array to save the frequencies.
84 * The number of frequencies to get.
89 uint32_t rte_power_kvm_vm_freqs(unsigned lcore_id, uint32_t *freqs,
93 * Return the current index of available frequencies of a specific lcore.
94 * It is not currently supported for VM Power Management.
102 uint32_t rte_power_kvm_vm_get_freq(unsigned lcore_id);
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.
112 * The index of available frequencies.
117 int rte_power_kvm_vm_set_freq(unsigned lcore_id, uint32_t index);
120 * Scale up the frequency of a specific lcore. This request is forwarded to the
122 * It should be protected outside of this function for threadsafe.
129 * - Negative on error.
131 int rte_power_kvm_vm_freq_up(unsigned lcore_id);
134 * Scale down the frequency of a specific lcore according to the available
136 * It should be protected outside of this function for threadsafe.
143 * - Negative on error.
145 int rte_power_kvm_vm_freq_down(unsigned lcore_id);
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.
157 * - Negative on error.
159 int rte_power_kvm_vm_freq_max(unsigned lcore_id);
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.
171 * - Negative on error.
173 int rte_power_kvm_vm_freq_min(unsigned lcore_id);