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.
39 * RTE Power Management
42 #include <rte_common.h>
43 #include <rte_byteorder.h>
45 #include <rte_string_fns.h>
51 #define RTE_POWER_INVALID_FREQ_INDEX (~0)
54 * Initialize power management for a specific lcore. It will check and set the
55 * governor to userspace for the lcore, get the available frequencies, and
56 * prepare to set new lcore frequency.
63 * - Negative on error.
65 int rte_power_init(unsigned lcore_id);
68 * Exit power management on a specific lcore. It will set the governor to which
69 * is before initialized.
76 * - Negative on error.
78 int rte_power_exit(unsigned lcore_id);
81 * Get the available frequencies of a specific lcore. The return value will be
82 * the minimal one of the total number of available frequencies and the number
83 * of buffer. The index of available frequencies used in other interfaces
84 * should be in the range of 0 to this return value.
85 * It should be protected outside of this function for threadsafe.
90 * The buffer array to save the frequencies.
92 * The number of frequencies to get.
95 * The number of available frequencies.
97 uint32_t rte_power_freqs(unsigned lcore_id, uint32_t *freqs, uint32_t num);
100 * Return the current index of available frequencies of a specific lcore. It
101 * will return 'RTE_POWER_INVALID_FREQ_INDEX = (~0)' if error.
102 * It should be protected outside of this function for threadsafe.
108 * The current index of available frequencies.
110 uint32_t rte_power_get_freq(unsigned lcore_id);
113 * Set the new frequency for a specific lcore by indicating the index of
114 * available frequencies.
115 * It should be protected outside of this function for threadsafe.
120 * The index of available frequencies.
123 * - 1 on success with frequency changed.
124 * - 0 on success without frequency chnaged.
125 * - Negative on error.
127 int rte_power_set_freq(unsigned lcore_id, uint32_t index);
130 * Scale up the frequency of a specific lcore according to the available
132 * It should be protected outside of this function for threadsafe.
138 * - 1 on success with frequency changed.
139 * - 0 on success without frequency chnaged.
140 * - Negative on error.
142 int rte_power_freq_up(unsigned lcore_id);
145 * Scale down the frequency of a specific lcore according to the available
147 * It should be protected outside of this function for threadsafe.
153 * - 1 on success with frequency changed.
154 * - 0 on success without frequency chnaged.
155 * - Negative on error.
157 int rte_power_freq_down(unsigned lcore_id);
160 * Scale up the frequency of a specific lcore to the highest according to the
161 * available frequencies.
162 * It should be protected outside of this function for threadsafe.
168 * - 1 on success with frequency changed.
169 * - 0 on success without frequency chnaged.
170 * - Negative on error.
172 int rte_power_freq_max(unsigned lcore_id);
175 * Scale down the frequency of a specific lcore to the lowest according to the
176 * available frequencies.
177 * It should be protected outside of this function for threadsafe.
183 * - 1 on success with frequency changed.
184 * - 0 on success without frequency chnaged.
185 * - Negative on error.
187 int rte_power_freq_min(unsigned lcore_id);