4 * Copyright(c) 2010-2013 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.
40 * RTE Power Management
43 #include <rte_common.h>
44 #include <rte_byteorder.h>
46 #include <rte_string_fns.h>
52 #define RTE_POWER_INVALID_FREQ_INDEX (~0)
55 * Initialize power management for a specific lcore. It will check and set the
56 * governor to userspace for the lcore, get the available frequencies, and
57 * prepare to set new lcore frequency.
64 * - Negative on error.
66 int rte_power_init(unsigned lcore_id);
69 * Exit power management on a specific lcore. It will set the governor to which
70 * is before initialized.
77 * - Negative on error.
79 int rte_power_exit(unsigned lcore_id);
82 * Get the available frequencies of a specific lcore. The return value will be
83 * the minimal one of the total number of available frequencies and the number
84 * of buffer. The index of available frequencies used in other interfaces
85 * should be in the range of 0 to this return value.
86 * It should be protected outside of this function for threadsafe.
91 * The buffer array to save the frequencies.
93 * The number of frequencies to get.
96 * The number of available frequencies.
98 uint32_t rte_power_freqs(unsigned lcore_id, uint32_t *freqs, uint32_t num);
101 * Return the current index of available frequencies of a specific lcore. It
102 * will return 'RTE_POWER_INVALID_FREQ_INDEX = (~0)' if error.
103 * It should be protected outside of this function for threadsafe.
109 * The current index of available frequencies.
111 uint32_t rte_power_get_freq(unsigned lcore_id);
114 * Set the new frequency for a specific lcore by indicating the index of
115 * available frequencies.
116 * It should be protected outside of this function for threadsafe.
121 * The index of available frequencies.
124 * - 1 on success with frequency changed.
125 * - 0 on success without frequency chnaged.
126 * - Negative on error.
128 int rte_power_set_freq(unsigned lcore_id, uint32_t index);
131 * Scale up the frequency of a specific lcore according to the available
133 * It should be protected outside of this function for threadsafe.
139 * - 1 on success with frequency changed.
140 * - 0 on success without frequency chnaged.
141 * - Negative on error.
143 int rte_power_freq_up(unsigned lcore_id);
146 * Scale down the frequency of a specific lcore according to the available
148 * It should be protected outside of this function for threadsafe.
154 * - 1 on success with frequency changed.
155 * - 0 on success without frequency chnaged.
156 * - Negative on error.
158 int rte_power_freq_down(unsigned lcore_id);
161 * Scale up the frequency of a specific lcore to the highest according to the
162 * available frequencies.
163 * It should be protected outside of this function for threadsafe.
169 * - 1 on success with frequency changed.
170 * - 0 on success without frequency chnaged.
171 * - Negative on error.
173 int rte_power_freq_max(unsigned lcore_id);
176 * Scale down the frequency of a specific lcore to the lowest according to the
177 * available frequencies.
178 * It should be protected outside of this function for threadsafe.
184 * - 1 on success with frequency changed.
185 * - 0 on success without frequency chnaged.
186 * - Negative on error.
188 int rte_power_freq_min(unsigned lcore_id);