File ns_power.c

FileList > neuralSPOT > neuralspot > ns-peripherals > src > ns_power.c

Go to the source code of this file

• #include "am_bsp.h"
• #include "am_mcu_apollo.h"
• #include "am_util.h"
• #include "ns_core.h"
• #include "ns_peripherals_power.h"

Public Attributes

Type	Name
const ns_power_config_t	ns_audio_default Good for AI that uses audio peripherals.
const ns_power_config_t	ns_debug_default Enables all things.
const ns_power_config_t	ns_development_default Enables most things.
const ns_power_config_t	ns_good_default Reasonable settings for more applications.
const ns_power_config_t	ns_mlperf_mode1 Good power/perf setting.
const ns_power_config_t	ns_mlperf_mode2 Good power/perf setting.
const ns_power_config_t	ns_mlperf_mode3 Good power/perf setting.
const ns_core_api_t	ns_power_V0_0_1 Power Control Utilities.
const ns_core_api_t	ns_power_V1_0_0
const ns_core_api_t	ns_power_current_version
const ns_core_api_t	ns_power_oldest_supported_version

Public Functions

Type	Name
void	ns_deep_sleep (void) neuralSPOT-aware deep_sleep - turns off certain systems off before sleeping and turns them back upon waking.
void	ns_platform_deep_sleep (void) Wraps am_hal_sysctrl_sleep to enable and disable systems as needed.
uint32_t	ns_power_config (const ns_power_config_t * pCfg) Set SOC Power Mode.
uint32_t	ns_power_platform_config (const ns_power_config_t * pCfg)
uint32_t	ns_set_performance_mode (ns_power_mode_e eAIPowerMode) Sets CPU frequency to one of the ns_power_modes.

Public Attributes Documentation

variable ns_audio_default

const ns_power_config_t ns_audio_default;

variable ns_debug_default

const ns_power_config_t ns_debug_default;

variable ns_development_default

const ns_power_config_t ns_development_default;

variable ns_good_default

const ns_power_config_t ns_good_default;

variable ns_mlperf_mode1

const ns_power_config_t ns_mlperf_mode1;

variable ns_mlperf_mode2

const ns_power_config_t ns_mlperf_mode2;

variable ns_mlperf_mode3

const ns_power_config_t ns_mlperf_mode3;

variable ns_power_V0_0_1

const ns_core_api_t ns_power_V0_0_1;

variable ns_power_V1_0_0

const ns_core_api_t ns_power_V1_0_0;

variable ns_power_current_version

const ns_core_api_t ns_power_current_version;

variable ns_power_oldest_supported_version

const ns_core_api_t ns_power_oldest_supported_version;

Public Functions Documentation

function ns_deep_sleep

void ns_deep_sleep (
    void
) 

function ns_platform_deep_sleep

void ns_platform_deep_sleep (
    void
) 

function ns_power_config

Set SOC Power Mode.

uint32_t ns_power_config (
    const ns_power_config_t * pCfg
) 

Parameters:

• ns_power_config_t Desired power mode

Returns:

uint32_t success/failure

function ns_power_platform_config

uint32_t ns_power_platform_config (
    const ns_power_config_t * pCfg
) 

function ns_set_performance_mode

Sets CPU frequency to one of the ns_power_modes.

uint32_t ns_set_performance_mode (
    ns_power_mode_e eAIPowerMode
) 

Parameters:

• eAIPowerMode

Returns:

uint32_t status

Sets CPU frequency to one of the ns_power_modes.

---

The documentation for this class was generated from the following file neuralSPOT/neuralspot/ns-peripherals/src/ns_power.c