rte_power.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _RTE_POWER_H
#define _RTE_POWER_H

#include <rte_common.h>
#include <rte_byteorder.h>
#include <rte_log.h>
#include <rte_string_fns.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Power Management Environment State */
enum power_management_env {PM_ENV_NOT_SET, PM_ENV_ACPI_CPUFREQ, PM_ENV_KVM_VM};

int rte_power_set_env(enum power_management_env env);

void rte_power_unset_env(void);

enum power_management_env rte_power_get_env(void);

int rte_power_init(unsigned lcore_id);

int rte_power_exit(unsigned lcore_id);

typedef uint32_t (*rte_power_freqs_t)(unsigned lcore_id, uint32_t *freqs,
        uint32_t num);

extern rte_power_freqs_t rte_power_freqs;

typedef uint32_t (*rte_power_get_freq_t)(unsigned lcore_id);

extern rte_power_get_freq_t rte_power_get_freq;

typedef int (*rte_power_set_freq_t)(unsigned lcore_id, uint32_t index);

extern rte_power_set_freq_t rte_power_set_freq;

typedef int (*rte_power_freq_change_t)(unsigned lcore_id);

extern rte_power_freq_change_t rte_power_freq_up;

extern rte_power_freq_change_t rte_power_freq_down;

extern rte_power_freq_change_t rte_power_freq_max;

extern rte_power_freq_change_t rte_power_freq_min;

extern rte_power_freq_change_t rte_power_turbo_status;

extern rte_power_freq_change_t rte_power_freq_enable_turbo;

extern rte_power_freq_change_t rte_power_freq_disable_turbo;


#ifdef __cplusplus
}
#endif

#endif