Generic RAM Control layer

Helper layer that provides a uniform way of controlling the RAM power and retention settings. More...

Functions
void	nrfx_ram_ctrl_power_enable_set (void const *p_object, size_t length, bool enable)
	Function for setting if the RAM sections containing specified object are to be powered on or off.
void	nrfx_ram_ctrl_power_enable_all_set (bool enable)
	Function for setting if all RAM sections are to be powered on or off.
void	nrfx_ram_ctrl_retention_enable_set (void const *p_object, size_t length, bool enable)
	Function for setting if the RAM sections containing specified object are to be retained or not.
void	nrfx_ram_ctrl_retention_enable_all_set (bool enable)
	Function for setting if all RAM sections are to be retained or not.
__STATIC_INLINE void	nrfx_ram_ctrl_section_power_mask_enable_set (uint8_t block_idx, uint32_t section_mask, bool enable)
	Function for setting if the specified mask of RAM sections contained within given RAM block is to be powered on or off.
__STATIC_INLINE void	nrfx_ram_ctrl_section_retention_mask_enable_set (uint8_t block_idx, uint32_t section_mask, bool enable)
	Function for setting if the specified mask of RAM sections contained within given RAM block is to be retained or not.

Detailed Description

Helper layer that provides a uniform way of controlling the RAM power and retention settings.

Function Documentation

nrfx_ram_ctrl_power_enable_all_set()

void nrfx_ram_ctrl_power_enable_all_set

(

bool

enable

)

Function for setting if all RAM sections are to be powered on or off.

Parameters

[in]

enable

True if RAM sections are to be powered on, false otherwise.

nrfx_ram_ctrl_power_enable_set()

void nrfx_ram_ctrl_power_enable_set	(	void const *	p_object,
		size_t	length,
		bool	enable )

Function for setting if the RAM sections containing specified object are to be powered on or off.

Parameters

[in]	p_object	Pointer to the object.
[in]	length	Object size in bytes.
[in]	enable	True if RAM sections are to be powered on, false otherwise.

nrfx_ram_ctrl_retention_enable_all_set()

void nrfx_ram_ctrl_retention_enable_all_set

(

bool

enable

)

Function for setting if all RAM sections are to be retained or not.

Parameters

[in]

enable

True if RAM sections are to be retained, false otherwise.

nrfx_ram_ctrl_retention_enable_set()

void nrfx_ram_ctrl_retention_enable_set	(	void const *	p_object,
		size_t	length,
		bool	enable )

Function for setting if the RAM sections containing specified object are to be retained or not.

Parameters

[in]	p_object	Pointer to the object.
[in]	length	Object size in bytes.
[in]	enable	True if RAM sections are to be retained, false otherwise.

nrfx_ram_ctrl_section_power_mask_enable_set()

__STATIC_INLINE void nrfx_ram_ctrl_section_power_mask_enable_set	(	uint8_t	block_idx,
		uint32_t	section_mask,
		bool	enable )

Function for setting if the specified mask of RAM sections contained within given RAM block is to be powered on or off.

Parameters

[in]	block_idx	RAM block index.
[in]	section_mask	Mask of RAM sections.
[in]	enable	True if RAM sections are to be powered on, false otherwise.

nrfx_ram_ctrl_section_retention_mask_enable_set()

__STATIC_INLINE void nrfx_ram_ctrl_section_retention_mask_enable_set	(	uint8_t	block_idx,
		uint32_t	section_mask,
		bool	enable )

Function for setting if the specified mask of RAM sections contained within given RAM block is to be retained or not.

Parameters

[in]	block_idx	RAM block index.
[in]	section_mask	Mask of RAM sections.
[in]	enable	True if RAM sections are to be retained, false otherwise.