S132 SoftDevice v5.0.0-1.alpha
Functions

Functions

uint32_t sd_softdevice_enable (nrf_clock_lf_cfg_t const *p_clock_lf_cfg, nrf_fault_handler_t fault_handler)
 Enables the SoftDevice and by extension the protocol stack. More...
 
uint32_t sd_softdevice_disable (void)
 Disables the SoftDevice and by extension the protocol stack. More...
 
uint32_t sd_softdevice_is_enabled (uint8_t *p_softdevice_enabled)
 Check if the SoftDevice is enabled. More...
 
uint32_t sd_softdevice_vector_table_base_set (uint32_t address)
 Sets the base address of the interrupt vector table for interrupts forwarded from the SoftDevice. More...
 

Detailed Description

Function Documentation

uint32_t sd_softdevice_disable ( void  )

Disables the SoftDevice and by extension the protocol stack.

Idempotent function to disable the SoftDevice.

Postcondition
SoC library and protocol stack APIs are made unavailable.
All interrupts that was protected by the SoftDevice will be disabled and initialized to priority 0 (highest).
All peripherals used by the SoftDevice will be reset to default values.
All of RAM become available.
All interrupts are forwarded to the application.
LFCLK source chosen in sd_softdevice_enable will be left running.
Return values
NRF_SUCCESS
uint32_t sd_softdevice_enable ( nrf_clock_lf_cfg_t const *  p_clock_lf_cfg,
nrf_fault_handler_t  fault_handler 
)

Enables the SoftDevice and by extension the protocol stack.

Note
Some care must be taken if a low frequency clock source is already running when calling this function: If the LF clock has a different source then the one currently running, it will be stopped. Then, the new clock source will be started.
This function has no effect when returning with an error.
Postcondition
If return code is NRF_SUCCESS
  • SoC library and protocol stack APIs are made available.
  • A portion of RAM will be unavailable (see relevant SDS documentation).
  • Some peripherals will be unavailable or available only through the SoC API (see relevant SDS documentation).
  • Interrupts will not arrive from protected peripherals or interrupts.
  • nrf_nvic_ functions must be used instead of CMSIS NVIC_ functions for reliable usage of the SoftDevice.
  • Interrupt latency may be affected by the SoftDevice (see relevant SDS documentation).
  • Chosen low frequency clock source will be running.
Parameters
p_clock_lf_cfgLow frequency clock source and accuracy. If NULL the clock will be configured as an rc source with rc_ctiv = 16 and .rc_temp_ctiv = 2 In the case of XTAL source, the PPM accuracy of the chosen clock source must be greater than or equal to the actual characteristics of your XTAL clock.
fault_handlerCallback to be invoked in case of fault, cannot be NULL.
Return values
NRF_SUCCESS
NRF_ERROR_INVALID_ADDRInvalid or NULL pointer supplied.
NRF_ERROR_INVALID_STATESoftDevice is already enabled, and the clock source and fault handler cannot be updated.
NRF_ERROR_SDM_INCORRECT_INTERRUPT_CONFIGURATIONSoftDevice interrupt is already enabled, or an enabled interrupt has an illegal priority level.
NRF_ERROR_SDM_LFCLK_SOURCE_UNKNOWNUnknown low frequency clock source selected.
uint32_t sd_softdevice_is_enabled ( uint8_t *  p_softdevice_enabled)

Check if the SoftDevice is enabled.

Parameters
[out]p_softdevice_enabledIf the SoftDevice is enabled: 1 else 0.
Return values
NRF_SUCCESS
uint32_t sd_softdevice_vector_table_base_set ( uint32_t  address)

Sets the base address of the interrupt vector table for interrupts forwarded from the SoftDevice.

This function is only intended to be called when a bootloader is enabled.

Parameters
[in]addressThe base address of the interrupt vector table for forwarded interrupts.
Return values
NRF_SUCCESS

Documentation feedback | Developer Zone | Subscribe | Updated