rte_power_acpi_cpufreq.h File Reference

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

Functions
int	rte_power_acpi_cpufreq_init (unsigned lcore_id)
int	rte_power_acpi_cpufreq_exit (unsigned lcore_id)
uint32_t	rte_power_acpi_cpufreq_freqs (unsigned lcore_id, uint32_t *freqs, uint32_t num)
uint32_t	rte_power_acpi_cpufreq_get_freq (unsigned lcore_id)
int	rte_power_acpi_cpufreq_set_freq (unsigned lcore_id, uint32_t index)
int	rte_power_acpi_cpufreq_freq_up (unsigned lcore_id)
int	rte_power_acpi_cpufreq_freq_down (unsigned lcore_id)
int	rte_power_acpi_cpufreq_freq_max (unsigned lcore_id)
int	rte_power_acpi_cpufreq_freq_min (unsigned lcore_id)

Detailed Description

RTE Power Management via userspace ACPI cpufreq

Function Documentation

int rte_power_acpi_cpufreq_exit

(

unsigned

lcore_id

)

Exit power management on a specific lcore. It will set the governor to which is before initialized.

Parameters

lcore_id

lcore id.

Returns

• 0 on success.
• Negative on error.

int rte_power_acpi_cpufreq_freq_down

(

unsigned

lcore_id

)

Scale down the frequency of a specific lcore according to the available frequencies. It should be protected outside of this function for threadsafe.

Parameters

lcore_id

lcore id.

Returns

• 1 on success with frequency changed.
• 0 on success without frequency changed.
• Negative on error.

int rte_power_acpi_cpufreq_freq_max

(

unsigned

lcore_id

)

Scale up the frequency of a specific lcore to the highest according to the available frequencies. It should be protected outside of this function for threadsafe.

Parameters

lcore_id

lcore id.

Returns

• 1 on success with frequency changed.
• 0 on success without frequency changed.
• Negative on error.

int rte_power_acpi_cpufreq_freq_min

(

unsigned

lcore_id

)

Scale down the frequency of a specific lcore to the lowest according to the available frequencies. It should be protected outside of this function for threadsafe.

Parameters

lcore_id

lcore id.

Returns

• 1 on success with frequency changed.
• 0 on success without frequency chnaged.
• Negative on error.

int rte_power_acpi_cpufreq_freq_up

(

unsigned

lcore_id

)

Scale up the frequency of a specific lcore according to the available frequencies. It should be protected outside of this function for threadsafe.

Parameters

lcore_id

lcore id.

Returns

• 1 on success with frequency changed.
• 0 on success without frequency changed.
• Negative on error.

uint32_t rte_power_acpi_cpufreq_freqs	(	unsigned	lcore_id,
		uint32_t *	freqs,
		uint32_t	num
	)

Get the available frequencies of a specific lcore. The return value will be the minimal one of the total number of available frequencies and the number of buffer. The index of available frequencies used in other interfaces should be in the range of 0 to this return value. It should be protected outside of this function for threadsafe.

Parameters

lcore_id	lcore id.
freqs	The buffer array to save the frequencies.
num	The number of frequencies to get.

Returns

The number of available frequencies.

uint32_t rte_power_acpi_cpufreq_get_freq

(

unsigned

lcore_id

)

Return the current index of available frequencies of a specific lcore. It will return 'RTE_POWER_INVALID_FREQ_INDEX = (~0)' if error. It should be protected outside of this function for threadsafe.

Parameters

lcore_id

lcore id.

Returns

The current index of available frequencies.

int rte_power_acpi_cpufreq_init

(

unsigned

lcore_id

)

Initialize power management for a specific lcore. It will check and set the governor to userspace for the lcore, get the available frequencies, and prepare to set new lcore frequency.

Parameters

lcore_id

lcore id.

Returns

• 0 on success.
• Negative on error.

int rte_power_acpi_cpufreq_set_freq	(	unsigned	lcore_id,
		uint32_t	index
	)

Set the new frequency for a specific lcore by indicating the index of available frequencies. It should be protected outside of this function for threadsafe.

Parameters

lcore_id	lcore id.
index	The index of available frequencies.

Returns

• 1 on success with frequency changed.
• 0 on success without frequency changed.
• Negative on error.