DPDK  2.0.0
Typedefs | Functions | Variables
rte_power.h File Reference
#include <rte_common.h>
#include <rte_byteorder.h>
#include <rte_log.h>
#include <rte_string_fns.h>

Typedefs

typedef uint32_t(* rte_power_freqs_t )(unsigned lcore_id, uint32_t *freqs, uint32_t num)
typedef uint32_t(* rte_power_get_freq_t )(unsigned lcore_id)
typedef int(* rte_power_set_freq_t )(unsigned lcore_id, uint32_t index)
typedef int(* rte_power_freq_change_t )(unsigned lcore_id)

Functions

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)

Variables

rte_power_freq_change_t rte_power_freq_up
rte_power_freq_change_t rte_power_freq_down
rte_power_freq_change_t rte_power_freq_max
rte_power_freq_change_t rte_power_freq_min

Detailed Description

RTE Power Management

Typedef Documentation

typedef int(* rte_power_freq_change_t)(unsigned lcore_id)

Function pointer definition for generic frequency change functions. Review each environments specific documentation for usage.

Parameters
lcore_idlcore id.
Returns
  • 1 on success with frequency changed.
  • 0 on success without frequency changed.
  • Negative on error.
typedef uint32_t(* rte_power_freqs_t)(unsigned lcore_id, uint32_t *freqs, uint32_t num)

Get the available frequencies of a specific lcore. Function pointer definition. Review each environments specific documentation for usage.

Parameters
lcore_idlcore id.
freqsThe buffer array to save the frequencies.
numThe number of frequencies to get.
Returns
The number of available frequencies.
typedef uint32_t(* rte_power_get_freq_t)(unsigned lcore_id)

Return the current index of available frequencies of a specific lcore. Function pointer definition. Review each environments specific documentation for usage.

Parameters
lcore_idlcore id.
Returns
The current index of available frequencies.
typedef int(* rte_power_set_freq_t)(unsigned lcore_id, uint32_t index)

Set the new frequency for a specific lcore by indicating the index of available frequencies. Function pointer definition. Review each environments specific documentation for usage.

Parameters
lcore_idlcore id.
indexThe index of available frequencies.
Returns
  • 1 on success with frequency changed.
  • 0 on success without frequency changed.
  • Negative on error.

Function Documentation

int rte_power_exit ( unsigned  lcore_id)

Exit power management on a specific lcore. This will call the environment dependent exit function.

Parameters
lcore_idlcore id.
Returns
  • 0 on success.
  • Negative on error.
enum power_management_env rte_power_get_env ( void  )

Get the default power management implementation.

Parameters
None.
Returns
power_management_env The configured environment.
int rte_power_init ( unsigned  lcore_id)

Initialize power management for a specific lcore. If rte_power_set_env() has not been called then an auto-detect of the environment will start and initialise the corresponding resources.

Parameters
lcore_idlcore id.
Returns
  • 0 on success.
  • Negative on error.
int rte_power_set_env ( enum power_management_env  env)

Set the default power management implementation. If this is not called prior to rte_power_init(), then auto-detect of the environment will take place. It is not thread safe.

Parameters
envenv. The environment in which to initialise Power Management for.
Returns
  • 0 on success.
  • Negative on error.
void rte_power_unset_env ( void  )

Unset the global environment configuration. This can only be called after all threads have completed.

Parameters
None.
Returns
None.

Variable Documentation

rte_power_freq_change_t rte_power_freq_down

Scale down the frequency of a specific lcore according to the available frequencies. Review each environments specific documentation for usage.

Parameters
lcore_idlcore id.
Returns
  • 1 on success with frequency changed.
  • 0 on success without frequency changed.
  • Negative on error.
rte_power_freq_change_t rte_power_freq_max

Scale up the frequency of a specific lcore to the highest according to the available frequencies. Review each environments specific documentation for usage.

Parameters
lcore_idlcore id.
Returns
  • 1 on success with frequency changed.
  • 0 on success without frequency changed.
  • Negative on error.
rte_power_freq_change_t rte_power_freq_min

Scale down the frequency of a specific lcore to the lowest according to the available frequencies. Review each environments specific documentation for usage..

Parameters
lcore_idlcore id.
Returns
  • 1 on success with frequency changed.
  • 0 on success without frequency changed.
  • Negative on error.
rte_power_freq_change_t rte_power_freq_up

Scale up the frequency of a specific lcore according to the available frequencies. Review each environments specific documentation for usage.

Parameters
lcore_idlcore id.
Returns
  • 1 on success with frequency changed.
  • 0 on success without frequency changed.
  • Negative on error.
Generated by   doxygen 1.8.1.2