S332 SoftDevice v4.0.2
Functions

Functions

uint32_t sd_mutex_new (nrf_mutex_t *p_mutex)
 Initialize a mutex. More...
 
uint32_t sd_mutex_acquire (nrf_mutex_t *p_mutex)
 Attempt to acquire a mutex. More...
 
uint32_t sd_mutex_release (nrf_mutex_t *p_mutex)
 Release a mutex. More...
 
uint32_t sd_rand_application_pool_capacity_get (uint8_t *p_pool_capacity)
 Query the capacity of the application random pool. More...
 
uint32_t sd_rand_application_bytes_available_get (uint8_t *p_bytes_available)
 Get number of random bytes available to the application. More...
 
uint32_t sd_rand_application_vector_get (uint8_t *p_buff, uint8_t length)
 Get random bytes from the application pool. More...
 
uint32_t sd_power_reset_reason_get (uint32_t *p_reset_reason)
 Gets the reset reason register. More...
 
uint32_t sd_power_reset_reason_clr (uint32_t reset_reason_clr_msk)
 Clears the bits of the reset reason register. More...
 
uint32_t sd_power_mode_set (uint8_t power_mode)
 Sets the power mode when in CPU sleep. More...
 
uint32_t sd_power_system_off (void)
 Puts the chip in System OFF mode. More...
 
uint32_t sd_power_pof_enable (uint8_t pof_enable)
 Enables or disables the power-fail comparator. More...
 
uint32_t sd_power_pof_threshold_set (uint8_t threshold)
 Sets the power-fail threshold value. More...
 
uint32_t sd_power_ram_power_set (uint8_t index, uint32_t ram_powerset)
 Writes the NRF_POWER->RAM[index].POWERSET register. More...
 
uint32_t sd_power_ram_power_clr (uint8_t index, uint32_t ram_powerclr)
 Writes the NRF_POWER->RAM[index].POWERCLR register. More...
 
uint32_t sd_power_ram_power_get (uint8_t index, uint32_t *p_ram_power)
 Get contents of NRF_POWER->RAM[index].POWER register, indicates power status of RAM[index] blocks. More...
 
uint32_t sd_power_gpregret_set (uint32_t gpregret_id, uint32_t gpregret_msk)
 Set bits in the general purpose retention registers (NRF_POWER->GPREGRET*). More...
 
uint32_t sd_power_gpregret_clr (uint32_t gpregret_id, uint32_t gpregret_msk)
 Clear bits in the general purpose retention registers (NRF_POWER->GPREGRET*). More...
 
uint32_t sd_power_gpregret_get (uint32_t gpregret_id, uint32_t *p_gpregret)
 Get contents of the general purpose retention registers (NRF_POWER->GPREGRET*). More...
 
uint32_t sd_power_dcdc_mode_set (uint8_t dcdc_mode)
 Sets the DCDC mode. More...
 
uint32_t sd_clock_hfclk_request (void)
 Request the high frequency crystal oscillator. More...
 
uint32_t sd_clock_hfclk_release (void)
 Releases the high frequency crystal oscillator. More...
 
uint32_t sd_clock_hfclk_is_running (uint32_t *p_is_running)
 Checks if the high frequency crystal oscillator is running. More...
 
uint32_t sd_app_evt_wait (void)
 Waits for an application event. More...
 
uint32_t sd_ppi_channel_enable_get (uint32_t *p_channel_enable)
 Get PPI channel enable register contents. More...
 
uint32_t sd_ppi_channel_enable_set (uint32_t channel_enable_set_msk)
 Set PPI channel enable register. More...
 
uint32_t sd_ppi_channel_enable_clr (uint32_t channel_enable_clr_msk)
 Clear PPI channel enable register. More...
 
uint32_t sd_ppi_channel_assign (uint8_t channel_num, const volatile void *evt_endpoint, const volatile void *task_endpoint)
 Assign endpoints to a PPI channel. More...
 
uint32_t sd_ppi_group_task_enable (uint8_t group_num)
 Task to enable a channel group. More...
 
uint32_t sd_ppi_group_task_disable (uint8_t group_num)
 Task to disable a channel group. More...
 
uint32_t sd_ppi_group_assign (uint8_t group_num, uint32_t channel_msk)
 Assign PPI channels to a channel group. More...
 
uint32_t sd_ppi_group_get (uint8_t group_num, uint32_t *p_channel_msk)
 Gets the PPI channels of a channel group. More...
 
uint32_t sd_radio_notification_cfg_set (uint8_t type, uint8_t distance)
 Configures the Radio Notification signal. More...
 
uint32_t sd_ecb_block_encrypt (nrf_ecb_hal_data_t *p_ecb_data)
 Encrypts a block according to the specified parameters. More...
 
uint32_t sd_ecb_blocks_encrypt (uint8_t block_count, nrf_ecb_hal_data_block_t *p_data_blocks)
 Encrypts multiple data blocks provided as an array of data block structures. More...
 
uint32_t sd_evt_get (uint32_t *p_evt_id)
 Gets any pending events generated by the SoC API. More...
 
uint32_t sd_temp_get (int32_t *p_temp)
 Get the temperature measured on the chip. More...
 
uint32_t sd_flash_write (uint32_t *p_dst, uint32_t const *p_src, uint32_t size)
 Flash Write. More...
 
uint32_t sd_flash_page_erase (uint32_t page_number)
 Flash Erase page. More...
 
uint32_t sd_flash_protect (uint32_t block_cfg0, uint32_t block_cfg1, uint32_t block_cfg2, uint32_t block_cfg3)
 Flash Protection set. More...
 
uint32_t sd_radio_session_open (nrf_radio_signal_callback_t p_radio_signal_callback)
 Opens a session for radio timeslot requests. More...
 
uint32_t sd_radio_session_close (void)
 Closes a session for radio timeslot requests. More...
 
uint32_t sd_radio_request (nrf_radio_request_t const *p_request)
 Requests a radio timeslot. More...
 

Detailed Description

Function Documentation

uint32_t sd_app_evt_wait ( void  )

Waits for an application event.

An application event is either an application interrupt or a pended interrupt when the interrupt is disabled.

When the application waits for an application event by calling this function, an interrupt that is enabled will be taken immediately on pending since this function will wait in thread mode, then the execution will return in the application's main thread.

In order to wake up from disabled interrupts, the SEVONPEND flag has to be set in the Cortex-M MCU's System Control Register (SCR), CMSIS_SCB. In that case, when a disabled interrupt gets pended, this function will return to the application's main thread.

Note
The application must ensure that the pended flag is cleared using sd_nvic_ClearPendingIRQ in order to sleep using this function. This is only necessary for disabled interrupts, as the interrupt handler will clear the pending flag automatically for enabled interrupts.
If an application interrupt has happened since the last time sd_app_evt_wait was called this function will return immediately and not go to sleep. This is to avoid race conditions that can occur when a flag is updated in the interrupt handler and processed in the main loop.
Postcondition
An application interrupt has happened or a interrupt pending flag is set.
Return values
NRF_SUCCESS
uint32_t sd_clock_hfclk_is_running ( uint32_t *  p_is_running)

Checks if the high frequency crystal oscillator is running.

See Also
sd_clock_hfclk_request
sd_clock_hfclk_release
Parameters
[out]p_is_running1 if the external crystal oscillator is running, 0 if not.
Return values
NRF_SUCCESS
uint32_t sd_clock_hfclk_release ( void  )

Releases the high frequency crystal oscillator.

Will stop the high frequency crystal oscillator, this happens immediately.

See Also
sd_clock_hfclk_is_running
sd_clock_hfclk_request
Return values
NRF_SUCCESS
uint32_t sd_clock_hfclk_request ( void  )

Request the high frequency crystal oscillator.

Will start the high frequency crystal oscillator, the startup time of the crystal varies and the sd_clock_hfclk_is_running function can be polled to check if it has started.

See Also
sd_clock_hfclk_is_running
sd_clock_hfclk_release
Return values
NRF_SUCCESS
uint32_t sd_ecb_block_encrypt ( nrf_ecb_hal_data_t p_ecb_data)

Encrypts a block according to the specified parameters.

128-bit AES encryption.

Note
:
  • The application may set the SEVONPEND bit in the SCR to 1 to make the SoftDevice sleep while the ECB is running. The SEVONPEND bit should only be cleared (set to 0) from application main or low interrupt level.
Parameters
[in,out]p_ecb_dataPointer to the ECB parameters' struct (two input parameters and one output parameter).
Return values
NRF_SUCCESS
uint32_t sd_ecb_blocks_encrypt ( uint8_t  block_count,
nrf_ecb_hal_data_block_t p_data_blocks 
)

Encrypts multiple data blocks provided as an array of data block structures.

: Performs 128-bit AES encryption on multiple data blocks

Note
:
  • The application may set the SEVONPEND bit in the SCR to 1 to make the SoftDevice sleep while the ECB is running. The SEVONPEND bit should only be cleared (set to 0) from application main or low interrupt level.
Parameters
[in]block_countCount of blocks in the p_data_blocks array.
[in,out]p_data_blocksPointer to the first entry in a contiguous array of nrf_ecb_hal_data_block_t structures.
Return values
NRF_SUCCESS
uint32_t sd_evt_get ( uint32_t *  p_evt_id)

Gets any pending events generated by the SoC API.

The application should keep calling this function to get events, until NRF_ERROR_NOT_FOUND is returned.

Parameters
[out]p_evt_idSet to one of the values in NRF_SOC_EVTS, if any events are pending.
Return values
NRF_SUCCESSAn event was pending. The event id is written in the p_evt_id parameter.
NRF_ERROR_NOT_FOUNDNo pending events.
uint32_t sd_flash_page_erase ( uint32_t  page_number)

Flash Erase page.

Commands to erase a flash page If the SoftDevice is enabled: This call initiates the flash access command, and its completion will be communicated to the application with exactly one of the following events:

If the SoftDevice is not enabled no event will be generated, and this call will return NRF_SUCCESS when the erase has been completed

Note
  • This call takes control over the radio and the CPU during flash erase and write to make sure that they will not interfere with the flash access. This means that all interrupts will be blocked for a predictable time (depending on the NVMC specification in nRF51 Series Reference Manual and the command parameters).
Parameters
[in]page_numberPage number of the page to erase
Return values
NRF_ERROR_INTERNALIf a new session could not be opened due to an internal error.
NRF_ERROR_INVALID_ADDRTried to erase to a non existing flash page.
NRF_ERROR_BUSYThe previous command has not yet completed.
NRF_ERROR_FORBIDDENTried to erase a protected page.
NRF_SUCCESSThe command was accepted.
uint32_t sd_flash_protect ( uint32_t  block_cfg0,
uint32_t  block_cfg1,
uint32_t  block_cfg2,
uint32_t  block_cfg3 
)

Flash Protection set.

Commands to set the flash protection configuration registers. On nRF51 this sets the PROTENSETx registers of the MPU peripheral. On nRF52 this sets the CONFIGx registers of the BPROT peripheral.

Note
To read the values read them directly. They are only write-protected.
Parameters
[in]block_cfg0Value to be written to the configuration register.
[in]block_cfg1Value to be written to the configuration register.
[in]block_cfg2Value to be written to the configuration register (ignored on nRF51).
[in]block_cfg3Value to be written to the configuration register (ignored on nRF51).
Return values
NRF_ERROR_FORBIDDENTried to protect the SoftDevice.
NRF_SUCCESSValues successfully written to configuration registers.
uint32_t sd_flash_write ( uint32_t *  p_dst,
uint32_t const *  p_src,
uint32_t  size 
)

Flash Write.

Commands to write a buffer to flash

If the SoftDevice is enabled: This call initiates the flash access command, and its completion will be communicated to the application with exactly one of the following events:

If the SoftDevice is not enabled no event will be generated, and this call will return NRF_SUCCESS when the write has been completed

Note
  • This call takes control over the radio and the CPU during flash erase and write to make sure that they will not interfere with the flash access. This means that all interrupts will be blocked for a predictable time (depending on the NVMC specification in nRF51 Series Reference Manual and the command parameters).
  • The data in the p_src buffer should not be modified before the NRF_EVT_FLASH_OPERATION_SUCCESS or the NRF_EVT_FLASH_OPERATION_ERROR have been received if the SoftDevice is enabled.
Parameters
[in]p_dstPointer to start of flash location to be written.
[in]p_srcPointer to buffer with data to be written.
[in]sizeNumber of 32-bit words to write. Maximum size is 256 32-bit words for nRF51 and 1024 for nRF52.
Return values
NRF_ERROR_INVALID_ADDRTried to write to a non existing flash address, or p_dst or p_src was unaligned.
NRF_ERROR_BUSYThe previous command has not yet completed.
NRF_ERROR_INVALID_LENGTHSize was 0, or higher than the maximum allowed size.
NRF_ERROR_FORBIDDENTried to write to or read from protected location.
NRF_SUCCESSThe command was accepted.
uint32_t sd_mutex_acquire ( nrf_mutex_t p_mutex)

Attempt to acquire a mutex.

Parameters
[in]p_mutexPointer to the mutex to acquire.
Return values
NRF_SUCCESSThe mutex was successfully acquired.
NRF_ERROR_SOC_MUTEX_ALREADY_TAKENThe mutex could not be acquired.
uint32_t sd_mutex_new ( nrf_mutex_t p_mutex)

Initialize a mutex.

Parameters
[in]p_mutexPointer to the mutex to initialize.
Return values
NRF_SUCCESS
uint32_t sd_mutex_release ( nrf_mutex_t p_mutex)

Release a mutex.

Parameters
[in]p_mutexPointer to the mutex to release.
Return values
NRF_SUCCESS
uint32_t sd_power_dcdc_mode_set ( uint8_t  dcdc_mode)

Sets the DCDC mode.

Enable or disable the DCDC peripheral.

Parameters
[in]dcdc_modeThe mode of the DCDC, see NRF_POWER_DCDC_MODES.
Return values
NRF_SUCCESS
NRF_ERROR_INVALID_PARAMThe DCDC mode is invalid.
uint32_t sd_power_gpregret_clr ( uint32_t  gpregret_id,
uint32_t  gpregret_msk 
)

Clear bits in the general purpose retention registers (NRF_POWER->GPREGRET*).

Parameters
[in]gpregret_id0 for GPREGRET, 1 for GPREGRET2.
[in]gpregret_mskBits to be clear in the GPREGRET register.
Note
nRF51 does only have one general purpose retained register, so gpregret_id must be 0 on nRF51.
Return values
NRF_SUCCESS
uint32_t sd_power_gpregret_get ( uint32_t  gpregret_id,
uint32_t *  p_gpregret 
)

Get contents of the general purpose retention registers (NRF_POWER->GPREGRET*).

Parameters
[in]gpregret_id0 for GPREGRET, 1 for GPREGRET2.
[out]p_gpregretContents of the GPREGRET register.
Note
nRF51 does only have one general purpose retained register, so gpregret_id must be 0 on nRF51.
Return values
NRF_SUCCESS
uint32_t sd_power_gpregret_set ( uint32_t  gpregret_id,
uint32_t  gpregret_msk 
)

Set bits in the general purpose retention registers (NRF_POWER->GPREGRET*).

Parameters
[in]gpregret_id0 for GPREGRET, 1 for GPREGRET2.
[in]gpregret_mskBits to be set in the GPREGRET register.
Note
nRF51 does only have one general purpose retained register, so gpregret_id must be 0 on nRF51.
Return values
NRF_SUCCESS
uint32_t sd_power_mode_set ( uint8_t  power_mode)

Sets the power mode when in CPU sleep.

Parameters
[in]power_modeThe power mode to use when in CPU sleep, see NRF_POWER_MODES.
See Also
sd_app_evt_wait
Return values
NRF_SUCCESSThe power mode was set.
NRF_ERROR_SOC_POWER_MODE_UNKNOWNThe power mode was unknown.
uint32_t sd_power_pof_enable ( uint8_t  pof_enable)

Enables or disables the power-fail comparator.

Enabling this will give a SoftDevice event (NRF_EVT_POWER_FAILURE_WARNING) when the power failure warning occurs. The event can be retrieved with sd_evt_get();

Parameters
[in]pof_enableTrue if the power-fail comparator should be enabled, false if it should be disabled.
Return values
NRF_SUCCESS
uint32_t sd_power_pof_threshold_set ( uint8_t  threshold)

Sets the power-fail threshold value.

Parameters
[in]thresholdThe power-fail threshold value to use, see NRF_POWER_THRESHOLDS.
Return values
NRF_SUCCESSThe power failure threshold was set.
NRF_ERROR_SOC_POWER_POF_THRESHOLD_UNKNOWNThe power failure threshold is unknown.
uint32_t sd_power_ram_power_clr ( uint8_t  index,
uint32_t  ram_powerclr 
)

Writes the NRF_POWER->RAM[index].POWERCLR register.

Parameters
[in]indexContains the index in the NRF_POWER->RAM[index].POWERCLR register to write to.
[in]ram_powerclrContains the word to write to the NRF_POWER->RAM[index].POWERCLR register.
Return values
NRF_SUCCESS
uint32_t sd_power_ram_power_get ( uint8_t  index,
uint32_t *  p_ram_power 
)

Get contents of NRF_POWER->RAM[index].POWER register, indicates power status of RAM[index] blocks.

Parameters
[in]indexContains the index in the NRF_POWER->RAM[index].POWER register to read from.
[out]p_ram_powerContent of NRF_POWER->RAM[index].POWER register.
Return values
NRF_SUCCESS
uint32_t sd_power_ram_power_set ( uint8_t  index,
uint32_t  ram_powerset 
)

Writes the NRF_POWER->RAM[index].POWERSET register.

Parameters
[in]indexContains the index in the NRF_POWER->RAM[index].POWERSET register to write to.
[in]ram_powersetContains the word to write to the NRF_POWER->RAM[index].POWERSET register.
Return values
NRF_SUCCESS
uint32_t sd_power_reset_reason_clr ( uint32_t  reset_reason_clr_msk)

Clears the bits of the reset reason register.

Parameters
[in]reset_reason_clr_mskContains the bits to clear from the reset reason register.
Return values
NRF_SUCCESS
uint32_t sd_power_reset_reason_get ( uint32_t *  p_reset_reason)

Gets the reset reason register.

Parameters
[out]p_reset_reasonContents of the NRF_POWER->RESETREAS register.
Return values
NRF_SUCCESS
uint32_t sd_power_system_off ( void  )

Puts the chip in System OFF mode.

Return values
NRF_ERROR_SOC_POWER_OFF_SHOULD_NOT_RETURN
uint32_t sd_ppi_channel_assign ( uint8_t  channel_num,
const volatile void *  evt_endpoint,
const volatile void *  task_endpoint 
)

Assign endpoints to a PPI channel.

Parameters
[in]channel_numNumber of the PPI channel to assign.
[in]evt_endpointEvent endpoint of the PPI channel.
[in]task_endpointTask endpoint of the PPI channel.
Return values
NRF_ERROR_SOC_PPI_INVALID_CHANNELThe channel number is invalid.
NRF_SUCCESS
uint32_t sd_ppi_channel_enable_clr ( uint32_t  channel_enable_clr_msk)

Clear PPI channel enable register.

Parameters
[in]channel_enable_clr_mskMask containing the bits to clear in the PPI CHEN register.
Return values
NRF_SUCCESS
uint32_t sd_ppi_channel_enable_get ( uint32_t *  p_channel_enable)

Get PPI channel enable register contents.

Parameters
[out]p_channel_enableThe contents of the PPI CHEN register.
Return values
NRF_SUCCESS
uint32_t sd_ppi_channel_enable_set ( uint32_t  channel_enable_set_msk)

Set PPI channel enable register.

Parameters
[in]channel_enable_set_mskMask containing the bits to set in the PPI CHEN register.
Return values
NRF_SUCCESS
uint32_t sd_ppi_group_assign ( uint8_t  group_num,
uint32_t  channel_msk 
)

Assign PPI channels to a channel group.

Parameters
[in]group_numNumber of the channel group.
[in]channel_mskMask of the channels to assign to the group.
Return values
NRF_ERROR_SOC_PPI_INVALID_GROUPThe group number is invalid.
NRF_SUCCESS
uint32_t sd_ppi_group_get ( uint8_t  group_num,
uint32_t *  p_channel_msk 
)

Gets the PPI channels of a channel group.

Parameters
[in]group_numNumber of the channel group.
[out]p_channel_mskMask of the channels assigned to the group.
Return values
NRF_ERROR_SOC_PPI_INVALID_GROUPThe group number is invalid.
NRF_SUCCESS
uint32_t sd_ppi_group_task_disable ( uint8_t  group_num)

Task to disable a channel group.

Parameters
[in]group_numNumber of the PPI group.
Return values
NRF_ERROR_SOC_PPI_INVALID_GROUPThe group number is invalid.
NRF_SUCCESS
uint32_t sd_ppi_group_task_enable ( uint8_t  group_num)

Task to enable a channel group.

Parameters
[in]group_numNumber of the channel group.
Return values
NRF_ERROR_SOC_PPI_INVALID_GROUPThe group number is invalid
NRF_SUCCESS
uint32_t sd_radio_notification_cfg_set ( uint8_t  type,
uint8_t  distance 
)

Configures the Radio Notification signal.

Note
  • The notification signal latency depends on the interrupt priority settings of SWI used for notification signal.
  • To ensure that the radio notification signal behaves in a consistent way, the radio notifications must be configured when there is no protocol stack or other SoftDevice activity in progress. It is recommended that the radio notification signal is configured directly after the SoftDevice has been enabled.
  • In the period between the ACTIVE signal and the start of the Radio Event, the SoftDevice will interrupt the application to do Radio Event preparation.
  • Using the Radio Notification feature may limit the bandwidth, as the SoftDevice may have to shorten the connection events to have time for the Radio Notification signals.
Parameters
[in]typeType of notification signal, see NRF_RADIO_NOTIFICATION_TYPES. NRF_RADIO_NOTIFICATION_TYPE_NONE shall be used to turn off radio notification. Using NRF_RADIO_NOTIFICATION_DISTANCE_NONE is recommended (but not required) to be used with NRF_RADIO_NOTIFICATION_TYPE_NONE.
[in]distanceDistance between the notification signal and start of radio activity, see NRF_RADIO_NOTIFICATION_DISTANCES. This parameter is ignored when NRF_RADIO_NOTIFICATION_TYPE_NONE or NRF_RADIO_NOTIFICATION_TYPE_INT_ON_INACTIVE is used.
Return values
NRF_ERROR_INVALID_PARAMThe group number is invalid.
NRF_ERROR_INVALID_STATEA protocol stack or other SoftDevice is running. Stop all running activities and retry.
NRF_SUCCESS
uint32_t sd_radio_request ( nrf_radio_request_t const *  p_request)

Requests a radio timeslot.

Note
The request type is determined by p_request->request_type, and can be one of NRF_RADIO_REQ_TYPE_EARLIEST and NRF_RADIO_REQ_TYPE_NORMAL. The first request in a session must always be of type NRF_RADIO_REQ_TYPE_EARLIEST.
For a normal request (NRF_RADIO_REQ_TYPE_NORMAL), the start time of a radio timeslot is specified by p_request->distance_us and is given relative to the start of the previous timeslot.
A too small p_request->distance_us will lead to a NRF_EVT_RADIO_BLOCKED event.
Timeslots scheduled too close will lead to a NRF_EVT_RADIO_BLOCKED event.
See the SoftDevice Specification for more on radio timeslot scheduling, distances and lengths.
If an opportunity for the first radio timeslot is not found before 100ms after the call to this function, it is not scheduled, and instead a NRF_EVT_RADIO_BLOCKED event is sent. The application may then try to schedule the first radio timeslot again.
Successful requests will result in nrf_radio_signal_callback_t(NRF_RADIO_CALLBACK_SIGNAL_TYPE_START). Unsuccessful requests will result in a NRF_EVT_RADIO_BLOCKED event, see NRF_SOC_EVTS.
The jitter in the start time of the radio timeslots is +/- NRF_RADIO_START_JITTER_US us.
The nrf_radio_signal_callback_t(NRF_RADIO_CALLBACK_SIGNAL_TYPE_START) call has a latency relative to the specified radio timeslot start, but this does not affect the actual start time of the timeslot.
NRF_TIMER0 is reset at the start of the radio timeslot, and is clocked at 1MHz from the high frequency (16 MHz) clock source. If p_request->hfclk_force_xtal is true, the high frequency clock is guaranteed to be clocked from the external crystal.
The SoftDevice will neither access the NRF_RADIO peripheral nor the NRF_TIMER0 peripheral during the radio timeslot.
Parameters
[in]p_requestPointer to the request parameters.
Return values
NRF_ERROR_FORBIDDENIf session not opened or the session is not IDLE.
NRF_ERROR_INVALID_ADDRIf the p_request pointer is invalid.
NRF_ERROR_INVALID_PARAMIf the parameters of p_request are not valid.
NRF_SUCCESSOtherwise.
uint32_t sd_radio_session_close ( void  )

Closes a session for radio timeslot requests.

Note
Any current radio timeslot will be finished before the session is closed.
If a radio timeslot is scheduled when the session is closed, it will be canceled.
The application cannot consider the session closed until the NRF_EVT_RADIO_SESSION_CLOSED event is received.
Return values
NRF_ERROR_FORBIDDENIf session not opened.
NRF_ERROR_BUSYIf session is currently being closed.
NRF_SUCCESSOtherwise.
uint32_t sd_radio_session_open ( nrf_radio_signal_callback_t  p_radio_signal_callback)

Opens a session for radio timeslot requests.

Note
Only one session can be open at a time.
p_radio_signal_callback(NRF_RADIO_CALLBACK_SIGNAL_TYPE_START) will be called when the radio timeslot starts. From this point the NRF_RADIO and NRF_TIMER0 peripherals can be freely accessed by the application.
p_radio_signal_callback(NRF_RADIO_CALLBACK_SIGNAL_TYPE_TIMER0) is called whenever the NRF_TIMER0 interrupt occurs.
p_radio_signal_callback(NRF_RADIO_CALLBACK_SIGNAL_TYPE_RADIO) is called whenever the NRF_RADIO interrupt occurs.
p_radio_signal_callback() will be called at ARM interrupt priority level 0. This implies that none of the sd_* API calls can be used from p_radio_signal_callback().
Parameters
[in]p_radio_signal_callbackThe signal callback.
Return values
NRF_ERROR_INVALID_ADDRp_radio_signal_callback is an invalid function pointer.
NRF_ERROR_BUSYIf session cannot be opened.
NRF_ERROR_INTERNALIf a new session could not be opened due to an internal error.
NRF_SUCCESSOtherwise.
uint32_t sd_rand_application_bytes_available_get ( uint8_t *  p_bytes_available)

Get number of random bytes available to the application.

Parameters
[out]p_bytes_availableThe number of bytes currently available in the pool.
Return values
NRF_SUCCESS
uint32_t sd_rand_application_pool_capacity_get ( uint8_t *  p_pool_capacity)

Query the capacity of the application random pool.

Parameters
[out]p_pool_capacityThe capacity of the pool.
Return values
NRF_SUCCESS
uint32_t sd_rand_application_vector_get ( uint8_t *  p_buff,
uint8_t  length 
)

Get random bytes from the application pool.

Parameters
[out]p_buffPointer to unit8_t buffer for storing the bytes.
[in]lengthNumber of bytes to take from pool and place in p_buff.
Return values
NRF_SUCCESSThe requested bytes were written to p_buff.
NRF_ERROR_SOC_RAND_NOT_ENOUGH_VALUESNo bytes were written to the buffer, because there were not enough bytes available.
uint32_t sd_temp_get ( int32_t *  p_temp)

Get the temperature measured on the chip.

This function will block until the temperature measurement is done. It takes around 50us from call to return.

Parameters
[out]p_tempResult of temperature measurement. Die temperature in 0.25 degrees celsius.
Return values
NRF_SUCCESSA temperature measurement was done, and the temperature was written to temp

Documentation feedback | Developer Zone | Subscribe | Updated