DPDK  16.11.9
rte_power.h
Go to the documentation of this file.
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_H
35 #define _RTE_POWER_H
36 
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 /* Power Management Environment State */
52 enum power_management_env {PM_ENV_NOT_SET, PM_ENV_ACPI_CPUFREQ, PM_ENV_KVM_VM};
53 
66 int rte_power_set_env(enum power_management_env env);
67 
72 void rte_power_unset_env(void);
73 
80 enum power_management_env rte_power_get_env(void);
81 
94 int rte_power_init(unsigned lcore_id);
95 
107 int rte_power_exit(unsigned lcore_id);
108 
124 typedef uint32_t (*rte_power_freqs_t)(unsigned lcore_id, uint32_t *freqs,
125  uint32_t num);
126 
127 extern rte_power_freqs_t rte_power_freqs;
128 
140 typedef uint32_t (*rte_power_get_freq_t)(unsigned lcore_id);
141 
142 extern rte_power_get_freq_t rte_power_get_freq;
143 
160 typedef int (*rte_power_set_freq_t)(unsigned lcore_id, uint32_t index);
161 
162 extern rte_power_set_freq_t rte_power_set_freq;
163 
176 typedef int (*rte_power_freq_change_t)(unsigned lcore_id);
177 
192 
208 
223 
238 
239 #ifdef __cplusplus
240 }
241 #endif
242 
243 #endif