Power Manager#

Modules#

sl_power_ram_retention_config_t

sl_power_peripheral_t

sl_power_manager_ps_transition_event_info_t

sl_power_manager_ps_transition_event_handle_t

Enumerations#

enum
SL_SI91X_POWER_MANAGER_PS0 = 0
SL_SI91X_POWER_MANAGER_PS1
SL_SI91X_POWER_MANAGER_PS2
SL_SI91X_POWER_MANAGER_PS3
SL_SI91X_POWER_MANAGER_PS4
SL_SI91X_POWER_MANAGER_SLEEP
SL_SI91X_POWER_MANAGER_STANDBY
LAST_ENUM_POWER_STATE
}

Enumeration for the power states.

enum
SL_SI91X_POWER_MANAGER_POWERSAVE
SL_SI91X_POWER_MANAGER_PERFORMANCE
LAST_ENUM_CLOCK_SCALING
}

Enumeration for clock scaling parameters.

enum
SL_SI91X_POWER_MANAGER_ISR_IGNORE = (1UL << 0UL)
SL_SI91X_POWER_MANAGER_ISR_SLEEP = (1UL << 1UL)
SL_SI91X_POWER_MANAGER_ISR_WAKEUP = (1UL << 2UL)
}

On ISR Exit Hook answer.

Typedefs#

typedef uint32_t

Mask of all the event(s) to listen to.

typedef void(*
sl_power_manager_ps_transition_on_event_t)(sl_power_state_t from, sl_power_state_t to)

Typedef for the user supplied callback function which is called when an power state transition occurs.

Functions#

sl_status_t
sli_si91x_power_manager_update_ps_requirement(sl_power_state_t state, boolean_t add)
sl_status_t

Initialize the power manager service.

__STATIC_INLINE sl_status_t

Adds requirement on power states.

__STATIC_INLINE sl_status_t

Removes requirement on power states.

sl_status_t

Configures the clock scaling.

sl_status_t
sl_si91x_power_manager_add_peripheral_requirement(sl_power_peripheral_t *peripheral)

Adds the peripheral requirement.

sl_status_t
sl_si91x_power_manager_remove_peripheral_requirement(sl_power_peripheral_t *peripheral)

Removes the peripheral requirement.

sl_status_t
sl_si91x_power_manager_subscribe_ps_transition_event(sl_power_manager_ps_transition_event_handle_t *event_handle, const sl_power_manager_ps_transition_event_info_t *event_info)

Registers a callback to be called on given Power state transition(s).

sl_status_t
sl_si91x_power_manager_unsubscribe_ps_transition_event(sl_power_manager_ps_transition_event_handle_t *event_handle, const sl_power_manager_ps_transition_event_info_t *event_info)

Unregisters an event callback handle on Power State transition.

sl_status_t

Transit to sleep mode and waits for the peripheral set as wakeup source to trigger and wakeup the m4 soc.

void

Transit to standby state and waits for the interrupt.

sl_status_t
sl_si91x_power_manager_set_wakeup_sources(uint32_t source, boolean_t add)

Configures the wakeup sources.

sl_status_t
sl_si91x_power_manager_configure_ram_retention(sl_power_ram_retention_config_t *config)

Retains the RAM in low power state either by using size or RAM bank as input parameter.

Returns the current power state.

uint8_t *

Get the current requirements on all the power states.

void

De-initialize the power manager service.

void

Print a table that describes the current requirements on each power state and their owner.

Macros#

#define

Event transition for entering PS4 state.

#define

Event transition for leaving PS4 state.

#define

Event transition for entering PS3 state.

#define

Event transition for leaving PS3 state.

#define

Event transition for entering PS2 state.

#define

Event transition for leaving PS2 state.

#define

Event transition for leaving PS1 state.

#define

Event transition for leaving sleep state.

#define

Event transition for leaving standby state.

#define

Deep Sleep Timer based wakeup source.

#define

Wireless based wakeup source.

#define

GPIO based wakeup source.

#define

Comparator based wakeup source.

#define

Sysrtc based wakeup source.

#define

ULP peripheral based wakeup source.

#define

SDC (Sensor data collector) based wakeup source.

#define

Alarm based wakeup source.

#define

Second based wakeup source.

#define

Milli second based wakeup source.

#define
SL_SI91X_POWER_MANAGER_WDT_WAKEUP WDT_INTR_BASED_WAKEUP

Watchdog interrupt based wakeup source.

#define
SL_SI91X_POWER_MANAGER_M4SS_PG_EFUSE M4SS_PWRGATE_ULP_EFUSE_PERI

M4SS EFUSE Power Gate.

#define

M4SS RPDMA Power Gate.

#define
SL_SI91X_POWER_MANAGER_M4SS_PG_SDIO_SPI M4SS_PWRGATE_ULP_SDIO_SPI

M4SS SDIO SPI Power Gate.

#define
SL_SI91X_POWER_MANAGER_M4SS_PG_QSPI M4SS_PWRGATE_ULP_QSPI_ICACHE

M4SS QSPI and ICACHE Power Gate.

#define

M4SS IID Power Gate.

#define
SL_SI91X_POWER_MANAGER_M4SS_PG_M4_DEBUG M4SS_PWRGATE_ULP_M4_DEBUG_FPU

M4SS M4 Debug Power Gate.

#define

M4SS M4 Core Power Gate.

#define

M4SS External ROM Power Gate.

#define

ULP Miscellaneous Power Gate.

#define

ULP Capacitive Touch Sensor Power Gate.

#define

ULP UART Power Gate.

#define

ULP SSI Power Gate.

#define

ULP I2S Power Gate.

#define

ULP I2C Power Gate.

#define

ULP AUX Power Gate.

#define

ULP IR Power Gate.

#define

ULP UDMA Power Gate.

#define

ULP FIM Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_MCUBFFS SLPSS_PWRGATE_ULP_MCUBFFS

NPSS MCU BFFS (Battery FF's) Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_MCUFSM SLPSS_PWRGATE_ULP_MCUFSM

NPSS MCU FSM Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_MCURTC SLPSS_PWRGATE_ULP_MCURTC

NPSS MCU RTC (Real Time Clock) Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_MCUWDT SLPSS_PWRGATE_ULP_MCUWDT

NPSS MCU WDT (Watchdog Timer) Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_MCUPS SLPSS_PWRGATE_ULP_MCUPS

NPSS MCU Process Sensor Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_MCUTS SLPSS_PWRGATE_ULP_MCUTS

NPSS MCU Temperature Sensor Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_MCUSTORE1 SLPSS_PWRGATE_ULP_MCUSTORE1

NPSS MCU Storage 1 Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_MCUSTORE2 SLPSS_PWRGATE_ULP_MCUSTORE2

NPSS MCU Storage 2 Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_MCUSTORE3 SLPSS_PWRGATE_ULP_MCUSTORE3

NPSS MCU Storage 3 Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_TIMEPERIOD SLPSS_PWRGATE_ULP_TIMEPERIOD

NPSS Time Period Power Gate.

#define
SL_SI91X_POWER_MANAGER_NPSS_PG_NWPAPB_MCU_CTRL SLPSS_PWRGATE_ULP_NWPAPB_MCU_CTRL

NPSS MCU APB Control Power Gate.

#define

4 KB (Bank 1 of first 192k chunk)

#define

4 KB (Bank 2 of first 192k chunk)

#define

4 KB (Bank 3 of first 192k chunk)

#define

4 KB (Bank 4 of first 192k chunk)

#define

4 KB (Bank 5 of first 192k chunk)

#define

32 KB (Bank 6-7 of first 192k chunk)

#define

64 KB (Bank 9-11 of first 192k chunk)

#define

64 KB (Bank 12-15 of first 192k chunk)

#define

64 KB (Bank 1-4 of second 192k chunk)

#define

64 KB (Bank 1-4 of third 192k chunk)

#define
#define
#define
#define

Enumeration Documentation#

sl_power_state_t#

sl_power_state_t

Enumeration for the power states.

Enumerator
SL_SI91X_POWER_MANAGER_PS0

PS0 Power State.

SL_SI91X_POWER_MANAGER_PS1

PS1 Power State.

SL_SI91X_POWER_MANAGER_PS2

PS2 Power State.

SL_SI91X_POWER_MANAGER_PS3

PS3 Power State.

SL_SI91X_POWER_MANAGER_PS4

PS4 Power State.

SL_SI91X_POWER_MANAGER_SLEEP

Sleep.

SL_SI91X_POWER_MANAGER_STANDBY

Standby.

LAST_ENUM_POWER_STATE

Last enum for validation.


sl_clock_scaling_t#

sl_clock_scaling_t

Enumeration for clock scaling parameters.

Enumerator
SL_SI91X_POWER_MANAGER_POWERSAVE

Minimum supported frequency in a power state.

SL_SI91X_POWER_MANAGER_PERFORMANCE

Maximum supported frequency in a power state.

LAST_ENUM_CLOCK_SCALING

Last enum for validation.


sl_si91x_power_manager_on_isr_exit_t#

sl_si91x_power_manager_on_isr_exit_t

On ISR Exit Hook answer.

Enumerator
SL_SI91X_POWER_MANAGER_ISR_IGNORE

The module did not trigger an ISR and it doesn't want to contribute to the decision.

SL_SI91X_POWER_MANAGER_ISR_SLEEP

The module was the one that caused the system wakeup and the system SHOULD go back to sleep.

SL_SI91X_POWER_MANAGER_ISR_WAKEUP

The module was the one that caused the system wakeup and the system MUST NOT go back to sleep.


Typedef Documentation#

sl_power_manager_ps_transition_event_t#

typedef uint32_t sl_power_manager_ps_transition_event_t

Mask of all the event(s) to listen to.


sl_power_manager_ps_transition_on_event_t#

typedef void(* sl_power_manager_ps_transition_on_event_t) (sl_power_state_t from, sl_power_state_t to) )(sl_power_state_t from, sl_power_state_t to)

Typedef for the user supplied callback function which is called when an power state transition occurs.

Parameters
TypeDirectionArgument NameDescription
N/Afrom

Power state we are leaving.

N/Ato

Power state we are entering.


Function Documentation#

sli_si91x_power_manager_update_ps_requirement#

sl_status_t sli_si91x_power_manager_update_ps_requirement (sl_power_state_t state, boolean_t add)
Parameters
TypeDirectionArgument NameDescription
sl_power_state_tN/Astate
boolean_tN/Aadd

sl_si91x_power_manager_init#

sl_status_t sl_si91x_power_manager_init (void )

Initialize the power manager service.

Parameters
TypeDirectionArgument NameDescription
void[in]

Configures PS4 state with 100 MHz system clock.

  • Pre-conditions:

    • none

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

    • SL_STATUS_OK (0x0000) Success.

    • SL_STATUS_ALREADY_INITIALIZED (0x0012) Power Manager is already initialized.


sl_si91x_power_manager_add_ps_requirement#

__STATIC_INLINE sl_status_t sl_si91x_power_manager_add_ps_requirement (sl_power_state_t state)

Adds requirement on power states.

Parameters
TypeDirectionArgument NameDescription
sl_power_state_t[in]state

Power state to add requirement: sl_power_state_t

  • SL_POWER_MANAGER_PS4

  • SL_POWER_MANAGER_PS3

  • SL_POWER_MANAGER_PS2

  • SL_POWER_MANAGER_PS1

Default state for power manager is PS4. If any requirements are added then power manager switches to the state if it is a valid transition. Before transition from one state to another, make sure to remove requirements of previous states if any added. If any invalid state requirement is added then it returns SL_STATUS_INVALID_PARAMETER. If power manager service is not initialized then it returns SL_STATUS_NOT_INITIALIZED, to initialize call sl_si91x_power_manager_init. To get the requirements on all power states, call sl_si91x_power_manager_get_requirement_table. To know the current power state, use sl_si91x_power_manager_get_current_state.

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

        - SL_STATUS_OK (0x0000) Success. 
      
        - SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized. 
      
        - SL_STATUS_INVALID_PARAMETER (0x0021) Invalid Parameter is passed.
      

sl_si91x_power_manager_remove_ps_requirement#

__STATIC_INLINE sl_status_t sl_si91x_power_manager_remove_ps_requirement (sl_power_state_t state)

Removes requirement on power states.

Parameters
TypeDirectionArgument NameDescription
sl_power_state_t[in]state

Power state to remove requirement: sl_power_state_t

  • SL_POWER_MANAGER_PS4

  • SL_POWER_MANAGER_PS3

  • SL_POWER_MANAGER_PS2

  • SL_POWER_MANAGER_PS1

Default state for power manager is PS4. Removing requirement will not impact on power state transitions. If the current state is PS4 and no other requirements are added, and PS4 requirement is removed then it returns SL_STATUS_INVALID_PARAMETER. If power manager service is not initialized then it returns SL_STATUS_NOT_INITIALIZED, to initialize call sl_si91x_power_manager_init. To get the requirements on all power states, call sl_si91x_power_manager_get_requirement_table. To know the current power state, use sl_si91x_power_manager_get_current_state.

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

      • SL_STATUS_OK (0x0000) Success.

      • SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized.

      • SL_STATUS_INVALID_PARAMETER (0x0021) Invalid Parameter is passed.


sl_si91x_power_manager_set_clock_scaling#

sl_status_t sl_si91x_power_manager_set_clock_scaling (sl_clock_scaling_t mode)

Configures the clock scaling.

Parameters
TypeDirectionArgument NameDescription
sl_clock_scaling_t[in]mode

(sl_clock_scaling_t type enum) the clock scaling mode sl_clock_scaling_t

PS4 and PS3 states are supported only. Possible values for clock scaling are:

  • POWERSAVE and PERFORMANCE

  • PS4 Performance: 180 MHz clock

  • PS4 Power-save: 100 MHz clock

  • PS3 Performance: 80 MHz clock

  • PS3 Power-save: 32 MHz clock

  • For PS2 state, 20 MHz clock is default.

  • If power manager service is not initialized then it returns SL_STATUS_NOT_INITIALIZED, to initialize call sl_si91x_power_manager_init.

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

        - SL_STATUS_OK (0x0000) Success. 
      
        - SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized. 
      
        - SL_STATUS_INVALID_PARAMETER (0x0021) Invalid Parameter is passed. 
      
        - SL_STATUS_INVALID_CONFIGURATION (0x0023) Invalid configuration of mode. 
      

sl_si91x_power_manager_add_peripheral_requirement#

sl_status_t sl_si91x_power_manager_add_peripheral_requirement (sl_power_peripheral_t * peripheral)

Adds the peripheral requirement.

Parameters
TypeDirectionArgument NameDescription
sl_power_peripheral_t *[in]peripheral

structure for different peripherals sl_power_peripheral_t

Power on the peripherals the valid peripherals passed in the structure. Structure member possible values: sl_power_peripheral_t

  • m4ss_peripheral -> Accepts masked value of m4ss peripherals.

  • ulpss_peripheral -> Accepts masked value of ulpss peripherals.

  • npss_peripheral -> Accepts masked value of npss peripherals. The values of enums can be combined by using 'OR' operator and then passed to the variable.

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

        - SL_STATUS_OK (0x0000) Success. 
      
        - SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized. 
      
        - SL_STATUS_INVALID_STATE (0x0002) Not a valid transition. 
      
        - SL_STATUS_INVALID_PARAMETER (0x0021) Invalid Parameter is passed.
      

sl_si91x_power_manager_remove_peripheral_requirement#

sl_status_t sl_si91x_power_manager_remove_peripheral_requirement (sl_power_peripheral_t * peripheral)

Removes the peripheral requirement.

Parameters
TypeDirectionArgument NameDescription
sl_power_peripheral_t *[in]peripheral

Structure for different peripherals sl_power_peripheral_t

Power off the peripherals the valid peripherals passed in the structure. Structure member possible values: sl_power_peripheral_t

  • m4ss_peripheral -> Accepts masked value of m4ss peripherals.

  • ulpss_peripheral -> Accepts masked value of ulpss peripherals.

  • npss_peripheral -> Accepts masked value of npss peripherals. The values of enums can be combined by using 'OR' operator and then passed to the variable.

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

        - SL_STATUS_OK (0x0000) Success. 
      
        - SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized. 
      
        - SL_STATUS_INVALID_PARAMETER (0x0021) Invalid Parameter is passed.
      

sl_si91x_power_manager_subscribe_ps_transition_event#

sl_status_t sl_si91x_power_manager_subscribe_ps_transition_event (sl_power_manager_ps_transition_event_handle_t * event_handle, const sl_power_manager_ps_transition_event_info_t * event_info)

Registers a callback to be called on given Power state transition(s).

Parameters
TypeDirectionArgument NameDescription
sl_power_manager_ps_transition_event_handle_t *[in]event_handle

Event handle (no initialization needed).

const sl_power_manager_ps_transition_event_info_t *[in]event_info

Event info structure that contains the event mask and the callback that must be called.

If power manager service is not initialized then it returns SL_STATUS_NOT_INITIALIZED, to initialize call sl_si91x_power_manager_init.

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

      • SL_STATUS_OK (0x0000) Success.

      • SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized.

      • SL_STATUS_NULL_POINTER (0x0022) Null Pointer is passed.

Note

  • Adding and removing power state transition requirement(s) from a callback on a transition event is not supported.

  • The parameters passed must be persistent, meaning that they need to survive until the callback fires.

  • An ASSERT is thrown if the handle is not found.

Usage example:

#define PS_EVENT_MASK          (  SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS4 \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS4  \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS3 \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS3  \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS2 \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS2  \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS0 \
                                | SL_POWER_MANAGER_EVENT_TRANSITION_LEAVING_SLEEP)

sl_power_manager_ps_transition_event_handle_t handle;
sl_power_manager_ps_transition_event_info_t info = { .event_mask = PS_EVENT_MASK,
                                                     .on_event   = transition_callback };

void transition_callback(sl_power_state_t from, sl_power_state_t to)
{
  [...]
}

void main(void)
{
  sl_status_t status;

  status = sl_si91x_power_manager_init();
  // Validate the status

  status = sl_si91x_power_manager_subscribe_ps_transition_event(&handle, &info);
  // Validate the status
}

sl_si91x_power_manager_unsubscribe_ps_transition_event#

sl_status_t sl_si91x_power_manager_unsubscribe_ps_transition_event (sl_power_manager_ps_transition_event_handle_t * event_handle, const sl_power_manager_ps_transition_event_info_t * event_info)

Unregisters an event callback handle on Power State transition.

Parameters
TypeDirectionArgument NameDescription
sl_power_manager_ps_transition_event_handle_t *[in]event_handle

Event handle which must be unregistered (must have been registered previously).

const sl_power_manager_ps_transition_event_info_t *[in]event_info

Event info structure that contains the event mask and the callback that must be called.

If power manager service is not initialized then it returns SL_STATUS_NOT_INITIALIZED, to initialize call sl_si91x_power_manager_init.

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

      • SL_STATUS_OK (0x0000) Success.

      • SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized.

      • SL_STATUS_NULL_POINTER (0x0022) Null Pointer is passed.

Note

  • An ASSERT is thrown if the handle is not found.


sl_si91x_power_manager_sleep#

sl_status_t sl_si91x_power_manager_sleep (void )

Transit to sleep mode and waits for the peripheral set as wakeup source to trigger and wakeup the m4 soc.

Parameters
TypeDirectionArgument NameDescription
voidN/A

It supports PS4, PS3 and PS2 only, it cannot enter sleep mode from any other active states. If any error is there, it returns the error code and does not transit to sleep mode.

Note

  • This function expects and call a callback with the following signature: boolean_t sl_si91x_power_manager_is_ok_to_sleep(void). This function can be used to cancel a sleep action and handle the possible race condition where an ISR that would cause a wakeup is triggered right after the decision to call sl_si91x_power_manager_sleep() has been made.

This function also expects and call a callback with the following signature: boolean_t sl_si91x_power_manager_isr_wakeup(void) after wakeup from sleep. The possible return values are

  • SL_SI91X_POWER_MANAGER_ISR_IGNORE

  • SL_SI91X_POWER_MANAGER_ISR_SLEEP

  • SL_SI91X_POWER_MANAGER_ISR_WAKEUP Note

    • It can end up in infinite sleep-wakeup loop if continuously SL_SI91X_POWER_MANAGER_ISR_SLEEP return value is passed.

    • Pre-conditions:

sl_si91x_power_manager_init

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

      • SL_STATUS_OK (0x0000) Success.

      • SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized.

      • SL_STATUS_INVALID_PARAMETER (0x0021) Invalid Parameter is passed.

      • SL_STATUS_INVALID_STATE (0x0002) Not a valid transition.


sl_si91x_power_manager_standby#

void sl_si91x_power_manager_standby (void )

Transit to standby state and waits for the interrupt.

Parameters
TypeDirectionArgument NameDescription
voidN/A

Standby transition is possible from PS4, PS3, PS2 state only. Transition from sleep, PS1 or PS0 is not supported.

Returns

  • The following values are returned:

    • none


sl_si91x_power_manager_set_wakeup_sources#

sl_status_t sl_si91x_power_manager_set_wakeup_sources (uint32_t source, boolean_t add)

Configures the wakeup sources.

Parameters
TypeDirectionArgument NameDescription
uint32_t[in]source

(sl_power_wakeup_sources_t type enum) Wakeup sources sl_power_wakeup_sources_t

boolean_t[in]add

(boolean_t) true enables and false disables wakeup source

One or many wakeup sources can be configured by using 'OR' operation. The initialization of the peripheral configured as wakeup source needs to be performed by user. Power Manager only sets it as a wakeup source.

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

      • SL_STATUS_OK (0x0000) Success.

      • SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized.

      • SL_STATUS_INVALID_PARAMETER (0x0021) Invalid Parameter is passed.


sl_si91x_power_manager_configure_ram_retention#

sl_status_t sl_si91x_power_manager_configure_ram_retention (sl_power_ram_retention_config_t * config)

Retains the RAM in low power state either by using size or RAM bank as input parameter.

Parameters
TypeDirectionArgument NameDescription
sl_power_ram_retention_config_t *[in]config

Structure for the parameters of RAM retention sl_power_ram_retention_config_t.

Structure member possible values: sl_power_ram_retention_config_t

  • configure_ram_banks -> Boolean to switch between RAM Bank retentions. Either by size or by RAM bank number.

  • (Enable -> Use RAM Bank Number).

  • (Disable -> Use Size).

  • m4ss_ram_size_kb -> Retains m4ss RAM banks according to the size.

  • less than 320 KB (Enter 100 for 100 KB).

  • ulpss_ram_size_kb -> Retains ulpss RAM banks according to the size.

  • less than 8 KB (Enter 5 for 5 KB).

  • ram_bank_number -> Retains the m4ss and ulpss RAM Bank using bank number

Returns

  • The following values are returned:

    • status SL_STATUS_OK on success, else error code.

      • SL_STATUS_OK (0x0000) Success.

      • SL_STATUS_NOT_INITIALIZED (0x0011) Power Manager is not initialized.

      • SL_STATUS_NULL_POINTER (0x0022) Null Pointer is passed.


sl_si91x_power_manager_get_current_state#

sl_power_state_t sl_si91x_power_manager_get_current_state (void )

Returns the current power state.

Parameters
TypeDirectionArgument NameDescription
void[in]

Possible return values:

  • 2 : SL_POWER_MANAGER_PS2, ///< PS2 Power State

  • 3 : SL_POWER_MANAGER_PS3, ///< PS3 Power State

  • 4 : SL_POWER_MANAGER_PS4, ///< PS4 Power State

Returns

  • The following values are returned:

    • sl_power_state_t enum value indicating current power state


sl_si91x_power_manager_get_requirement_table#

uint8_t * sl_si91x_power_manager_get_requirement_table (void )

Get the current requirements on all the power states.

Parameters
TypeDirectionArgument NameDescription
void[in]

It returns 5 values starting from PS0 to PS4.

Returns

  • The following values are returned:

    • Pointer to the uint8_t type array which contains 5 elements

Usage example:

void main()
{
  uint8_t *requirement_table;
  sl_si91x_power_manager_init();
  requirement_table = sl_si91x_power_manager_get_requirement_table();
  DEBUGOUT("PS4: %d, PS3: %d, PS2: %d, PS1: %d, PS0: %d", 
-
           requirement_table[4], 
-
           requirement_table[3], 
-
           requirement_table[2], 
-
           requirement_table[1], 
-
           requirement_table[0]); 
-
}

sl_si91x_power_manager_deinit#

void sl_si91x_power_manager_deinit (void )

De-initialize the power manager service.

Parameters
TypeDirectionArgument NameDescription
void[in]

It clears all the power requirements and callback event subscriptions. If power manager service is not initialized then it returns SL_STATUS_NOT_INITIALIZED, to initialize call sl_si91x_power_manager_init.

Returns

  • The following values are returned:

    • none


sl_si91x_power_manager_debug_print_ps_requirements#

void sl_si91x_power_manager_debug_print_ps_requirements (void )

Print a table that describes the current requirements on each power state and their owner.

Parameters
TypeDirectionArgument NameDescription
voidN/A

Macro Definition Documentation#

SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS4#

#define SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS4
Value:
(1 << 0)

Event transition for entering PS4 state.


SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS4#

#define SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS4
Value:
(1 << 1)

Event transition for leaving PS4 state.


SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS3#

#define SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS3
Value:
(1 << 2)

Event transition for entering PS3 state.


SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS3#

#define SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS3
Value:
(1 << 3)

Event transition for leaving PS3 state.


SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS2#

#define SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_ENTERING_PS2
Value:
(1 << 4)

Event transition for entering PS2 state.


SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS2#

#define SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS2
Value:
(1 << 5)

Event transition for leaving PS2 state.


SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS1#

#define SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_PS1
Value:
(1 << 6)

Event transition for leaving PS1 state.


SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_SLEEP#

#define SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_SLEEP
Value:
(1 << 7)

Event transition for leaving sleep state.


SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_STANDBY#

#define SL_SI91X_POWER_MANAGER_EVENT_TRANSITION_LEAVING_STANDBY
Value:
(1 << 8)

Event transition for leaving standby state.


SL_SI91X_POWER_MANAGER_DST_WAKEUP#

#define SL_SI91X_POWER_MANAGER_DST_WAKEUP
Value:
DST_BASED_WAKEUP

Deep Sleep Timer based wakeup source.


SL_SI91X_POWER_MANAGER_WIRELESS_WAKEUP#

#define SL_SI91X_POWER_MANAGER_WIRELESS_WAKEUP
Value:
WIRELESS_BASED_WAKEUP

Wireless based wakeup source.


SL_SI91X_POWER_MANAGER_GPIO_WAKEUP#

#define SL_SI91X_POWER_MANAGER_GPIO_WAKEUP
Value:
GPIO_BASED_WAKEUP

GPIO based wakeup source.


SL_SI91X_POWER_MANAGER_COMPARATOR_WAKEUP#

#define SL_SI91X_POWER_MANAGER_COMPARATOR_WAKEUP
Value:
COMPR_BASED_WAKEUP

Comparator based wakeup source.


SL_SI91X_POWER_MANAGER_SYSRTC_WAKEUP#

#define SL_SI91X_POWER_MANAGER_SYSRTC_WAKEUP
Value:
SYSRTC_BASED_WAKEUP

Sysrtc based wakeup source.


SL_SI91X_POWER_MANAGER_ULPSS_WAKEUP#

#define SL_SI91X_POWER_MANAGER_ULPSS_WAKEUP
Value:
ULPSS_BASED_WAKEUP

ULP peripheral based wakeup source.


SL_SI91X_POWER_MANAGER_SDCSS_WAKEUP#

#define SL_SI91X_POWER_MANAGER_SDCSS_WAKEUP
Value:
SDCSS_BASED_WAKEUP

SDC (Sensor data collector) based wakeup source.


SL_SI91X_POWER_MANAGER_ALARM_WAKEUP#

#define SL_SI91X_POWER_MANAGER_ALARM_WAKEUP
Value:
ALARM_BASED_WAKEUP

Alarm based wakeup source.


SL_SI91X_POWER_MANAGER_SEC_WAKEUP#

#define SL_SI91X_POWER_MANAGER_SEC_WAKEUP
Value:
SEC_BASED_WAKEUP

Second based wakeup source.


SL_SI91X_POWER_MANAGER_MSEC_WAKEUP#

#define SL_SI91X_POWER_MANAGER_MSEC_WAKEUP
Value:
MSEC_BASED_WAKEUP

Milli second based wakeup source.


SL_SI91X_POWER_MANAGER_WDT_WAKEUP#

#define SL_SI91X_POWER_MANAGER_WDT_WAKEUP
Value:
WDT_INTR_BASED_WAKEUP

Watchdog interrupt based wakeup source.


SL_SI91X_POWER_MANAGER_M4SS_PG_EFUSE#

#define SL_SI91X_POWER_MANAGER_M4SS_PG_EFUSE
Value:
M4SS_PWRGATE_ULP_EFUSE_PERI

M4SS EFUSE Power Gate.


SL_SI91X_POWER_MANAGER_M4SS_PG_RPDMA#

#define SL_SI91X_POWER_MANAGER_M4SS_PG_RPDMA
Value:
M4SS_PWRGATE_ULP_RPDMA

M4SS RPDMA Power Gate.


SL_SI91X_POWER_MANAGER_M4SS_PG_SDIO_SPI#

#define SL_SI91X_POWER_MANAGER_M4SS_PG_SDIO_SPI
Value:
M4SS_PWRGATE_ULP_SDIO_SPI

M4SS SDIO SPI Power Gate.


SL_SI91X_POWER_MANAGER_M4SS_PG_QSPI#

#define SL_SI91X_POWER_MANAGER_M4SS_PG_QSPI
Value:
M4SS_PWRGATE_ULP_QSPI_ICACHE

M4SS QSPI and ICACHE Power Gate.


SL_SI91X_POWER_MANAGER_M4SS_PG_IID#

#define SL_SI91X_POWER_MANAGER_M4SS_PG_IID
Value:
M4SS_PWRGATE_ULP_IID

M4SS IID Power Gate.


SL_SI91X_POWER_MANAGER_M4SS_PG_M4_DEBUG#

#define SL_SI91X_POWER_MANAGER_M4SS_PG_M4_DEBUG
Value:
M4SS_PWRGATE_ULP_M4_DEBUG_FPU

M4SS M4 Debug Power Gate.


SL_SI91X_POWER_MANAGER_M4SS_PG_M4_CORE#

#define SL_SI91X_POWER_MANAGER_M4SS_PG_M4_CORE
Value:
M4SS_PWRGATE_ULP_M4_CORE

M4SS M4 Core Power Gate.


SL_SI91X_POWER_MANAGER_M4SS_PG_EXTERNAL_ROM#

#define SL_SI91X_POWER_MANAGER_M4SS_PG_EXTERNAL_ROM
Value:
M4SS_PWRGATE_ULP_EXT_ROM

M4SS External ROM Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_MISC#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_MISC
Value:
ULPSS_PWRGATE_ULP_MISC

ULP Miscellaneous Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_CAP#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_CAP
Value:
ULPSS_PWRGATE_ULP_CAP

ULP Capacitive Touch Sensor Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_UART#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_UART
Value:
ULPSS_PWRGATE_ULP_UART

ULP UART Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_SSI#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_SSI
Value:
ULPSS_PWRGATE_ULP_SSI

ULP SSI Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_I2S#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_I2S
Value:
ULPSS_PWRGATE_ULP_I2S

ULP I2S Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_I2C#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_I2C
Value:
ULPSS_PWRGATE_ULP_I2C

ULP I2C Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_AUX#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_AUX
Value:
ULPSS_PWRGATE_ULP_AUX

ULP AUX Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_IR#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_IR
Value:
ULPSS_PWRGATE_ULP_IR

ULP IR Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_UDMA#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_UDMA
Value:
ULPSS_PWRGATE_ULP_UDMA

ULP UDMA Power Gate.


SL_SI91X_POWER_MANAGER_ULPSS_PG_FIM#

#define SL_SI91X_POWER_MANAGER_ULPSS_PG_FIM
Value:
ULPSS_PWRGATE_ULP_FIM

ULP FIM Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_MCUBFFS#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_MCUBFFS
Value:
SLPSS_PWRGATE_ULP_MCUBFFS

NPSS MCU BFFS (Battery FF's) Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_MCUFSM#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_MCUFSM
Value:
SLPSS_PWRGATE_ULP_MCUFSM

NPSS MCU FSM Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_MCURTC#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_MCURTC
Value:
SLPSS_PWRGATE_ULP_MCURTC

NPSS MCU RTC (Real Time Clock) Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_MCUWDT#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_MCUWDT
Value:
SLPSS_PWRGATE_ULP_MCUWDT

NPSS MCU WDT (Watchdog Timer) Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_MCUPS#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_MCUPS
Value:
SLPSS_PWRGATE_ULP_MCUPS

NPSS MCU Process Sensor Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_MCUTS#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_MCUTS
Value:
SLPSS_PWRGATE_ULP_MCUTS

NPSS MCU Temperature Sensor Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_MCUSTORE1#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_MCUSTORE1
Value:
SLPSS_PWRGATE_ULP_MCUSTORE1

NPSS MCU Storage 1 Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_MCUSTORE2#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_MCUSTORE2
Value:
SLPSS_PWRGATE_ULP_MCUSTORE2

NPSS MCU Storage 2 Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_MCUSTORE3#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_MCUSTORE3
Value:
SLPSS_PWRGATE_ULP_MCUSTORE3

NPSS MCU Storage 3 Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_TIMEPERIOD#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_TIMEPERIOD
Value:
SLPSS_PWRGATE_ULP_TIMEPERIOD

NPSS Time Period Power Gate.


SL_SI91X_POWER_MANAGER_NPSS_PG_NWPAPB_MCU_CTRL#

#define SL_SI91X_POWER_MANAGER_NPSS_PG_NWPAPB_MCU_CTRL
Value:
  SLPSS_PWRGATE_ULP_NWPAPB_MCU_CTRL

NPSS MCU APB Control Power Gate.


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_1#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_1
Value:
RAM_BANK_0

4 KB (Bank 1 of first 192k chunk)


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_2#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_2
Value:
RAM_BANK_1

4 KB (Bank 2 of first 192k chunk)


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_3#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_3
Value:
RAM_BANK_2

4 KB (Bank 3 of first 192k chunk)


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_4#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_4
Value:
RAM_BANK_3

4 KB (Bank 4 of first 192k chunk)


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_5#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_5
Value:
RAM_BANK_4

4 KB (Bank 5 of first 192k chunk)


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_6#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_6
Value:
RAM_BANK_5

32 KB (Bank 6-7 of first 192k chunk)


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_7#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_7
Value:
RAM_BANK_6

64 KB (Bank 9-11 of first 192k chunk)


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_8#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_8
Value:
RAM_BANK_7

64 KB (Bank 12-15 of first 192k chunk)


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_9#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_9
Value:
RAM_BANK_8

64 KB (Bank 1-4 of second 192k chunk)


SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_10#

#define SL_SI91X_POWER_MANAGER_M4SS_RAM_BANK_10
Value:
RAM_BANK_9

64 KB (Bank 1-4 of third 192k chunk)


SL_SI91X_POWER_MANAGER_ULPSS_RAM_BANK_1#

#define SL_SI91X_POWER_MANAGER_ULPSS_RAM_BANK_1
Value:
ULPSS_2K_BANK_0

2 KB


SL_SI91X_POWER_MANAGER_ULPSS_RAM_BANK_2#

#define SL_SI91X_POWER_MANAGER_ULPSS_RAM_BANK_2
Value:
ULPSS_2K_BANK_1

2 KB


SL_SI91X_POWER_MANAGER_ULPSS_RAM_BANK_3#

#define SL_SI91X_POWER_MANAGER_ULPSS_RAM_BANK_3
Value:
ULPSS_2K_BANK_2

2 KB


SL_SI91X_POWER_MANAGER_ULPSS_RAM_BANK_4#

#define SL_SI91X_POWER_MANAGER_ULPSS_RAM_BANK_4
Value:
ULPSS_2K_BANK_3

2 KB


sli_si91x_power_manager_debug_log_ps_requirement#

#define sli_si91x_power_manager_debug_log_ps_requirement
Value:
(em, add, name)