Functions
[SoC Library API]

Initialize a mutex.

Parameters:

[in]

p_mutex

Pointer to the mutex to initialize.

Return values:

NRF_SUCCESS

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_request

Pointer to the request parameters.

Return values:

NRF_ERROR_FORBIDDEN	If session not opened or the session is not IDLE.
NRF_ERROR_INVALID_ADDR	If the p_request pointer is invalid.
NRF_ERROR_INVALID_PARAM	If the parameters of p_request are not valid.
NRF_SUCCESS	Otherwise.

Closes a session for radio 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_FORBIDDEN	If session not opened.
NRF_ERROR_BUSY	If session is currently being closed.
NRF_SUCCESS	Otherwise.

Opens a session for radio 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_callback

The signal callback.

Return values:

NRF_ERROR_INVALID_ADDR	p_radio_signal_callback is an invalid function pointer.
NRF_ERROR_BUSY	If session cannot be opened.
NRF_ERROR_INTERNAL	If a new session could not be opened due to an internal error.
NRF_SUCCESS	Otherwise.

Flash Protection set.

Commands to set the flash protection registers PROTENSETx

Note:

To read the values in PROTENSETx you can read them directly. They are only write-protected.

Parameters:

[in]	protenset0	Value to be written to PROTENSET0.
[in]	protenset1	Value to be written to PROTENSET1.

Return values:

NRF_ERROR_FORBIDDEN	Tried to protect the SoftDevice.
NRF_SUCCESS	Values successfully written to PROTENSETx.

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:

• NRF_EVT_FLASH_OPERATION_SUCCESS - The command was successfully completed.
• NRF_EVT_FLASH_OPERATION_ERROR - The command could not be started.

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_number

Pagenumber of the page to erase

Return values:

NRF_ERROR_INTERNAL	If a new session could not be opened due to an internal error.
NRF_ERROR_INVALID_ADDR	Tried to erase to a non existing flash page.
NRF_ERROR_BUSY	The previous command has not yet completed.
NRF_ERROR_FORBIDDEN	Tried to erase a protected page.
NRF_SUCCESS	The command was accepted.

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:

• NRF_EVT_FLASH_OPERATION_SUCCESS - The command was successfully completed.
• NRF_EVT_FLASH_OPERATION_ERROR - The command could not be started.

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).

Parameters:

[in]	p_dst	Pointer to start of flash location to be written.
[in]	p_src	Pointer to buffer with data to be written.
[in]	size	Number of 32-bit words to write. Maximum size is 256 32bit words.

Return values:

NRF_ERROR_INVALID_ADDR	Tried to write to a non existing flash address, or p_dst or p_src was unaligned.
NRF_ERROR_BUSY	The previous command has not yet completed.
NRF_ERROR_INVALID_LENGTH	Size was 0, or more than 256 words.
NRF_ERROR_FORBIDDEN	Tried to write to or read from protected location.
NRF_SUCCESS	The command was accepted.

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.

Note:

Pan #28 in PAN-028 v 1.6 "Negative measured values are not represented correctly" is corrected by this function.

Parameters:

[out]

p_temp

Result of temperature measurement. Die temperature in 0.25 degrees celsius.

Return values:

NRF_SUCCESS

A temperature measurement was done, and the temperature was written to temp

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_id

Set to one of the values in NRF_SOC_EVTS, if any events are pending.

Return values:

NRF_SUCCESS	An event was pending. The event id is written in the p_evt_id parameter.
NRF_ERROR_NOT_FOUND	No pending events.

Encrypts a block according to the specified parameters.

128-bit AES encryption.

Parameters:

[in,out]

p_ecb_data

Pointer to the ECB parameters' struct (two input parameters and one output parameter).

Return values:

NRF_SUCCESS

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, always configure radio notifications 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]	type	Type of notification signal. 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]	distance	Distance between the notification signal and start of radio activity. 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_PARAM	The group number is invalid.
NRF_SUCCESS

Gets the PPI channels of a channel group.

Parameters:

[in]	group_num	Number of the channel group.
[out]	p_channel_msk	Mask of the channels assigned to the group.

Return values:

NRF_ERROR_SOC_PPI_INVALID_GROUP	The group number is invalid.
NRF_SUCCESS

Assign PPI channels to a channel group.

Parameters:

[in]	group_num	Number of the channel group.
[in]	channel_msk	Mask of the channels to assign to the group.

Return values:

NRF_ERROR_SOC_PPI_INVALID_GROUP	The group number is invalid.
NRF_SUCCESS

Task to disable a channel group.

Parameters:

[in]

group_num

Number of the PPI group.

Return values:

NRF_ERROR_SOC_PPI_INVALID_GROUP	The group number is invalid.
NRF_SUCCESS

Task to enable a channel group.

Parameters:

[in]

group_num

Number of the channel group.

Return values:

NRF_ERROR_SOC_PPI_INVALID_GROUP	The group number is invalid
NRF_SUCCESS

Assign endpoints to a PPI channel.

Parameters:

[in]	channel_num	Number of the PPI channel to assign.
[in]	evt_endpoint	Event endpoint of the PPI channel.
[in]	task_endpoint	Task endpoint of the PPI channel.

Return values:

NRF_ERROR_SOC_PPI_INVALID_CHANNEL	The channel number is invalid.
NRF_SUCCESS

Clear PPI channel enable register.

Parameters:

[in]

channel_enable_clr_msk

Mask containing the bits to clear in the PPI CHEN register.

Return values:

NRF_SUCCESS

Set PPI channel enable register.

Parameters:

[in]

channel_enable_set_msk

Mask containing the bits to set in the PPI CHEN register.

Return values:

NRF_SUCCESS

Get PPI channel enable register contents.

Parameters:

[out]

p_channel_enable

The contents of the PPI CHEN register.

Return values:

NRF_SUCCESS

Waits for an application event.

An application event is either an application interrupt or a pended interrupt when the interrupt is disabled. When the interrupt is enabled it will be taken immediately since this function will wait in thread mode, then the execution will return in the application's main thread. When an interrupt is disabled and gets pended it will return to the application's thread main. 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.

In order to wake up from disabled interrupts, the SEVONPEND flag has to be set in the Cortex-M0 System Control Register (SCR).

See also:

CMSIS_SCB

Note:

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

Checks if the high frequency crystal oscillator is running.

See also:

sd_clock_hfclk_request

sd_clock_hfclk_release

Parameters:

[out]

p_is_running

1 if the external crystal oscillator is running, 0 if not.

Return values:

NRF_SUCCESS

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

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

Sets the DCDC mode.

This function is to enable or disable the DCDC periperhal.

Parameters:

[in]

dcdc_mode

The mode of the DCDC.

Return values:

NRF_SUCCESS
NRF_ERROR_INVALID_PARAM	The DCDC mode is invalid.

Get contents of the NRF_POWER->GPREGRET register.

Parameters:

[out]

p_gpregret

Contents of the GPREGRET register.

Return values:

NRF_SUCCESS

Clear bits in the NRF_POWER->GPREGRET register.

Parameters:

[in]

gpregret_msk

Bits to be clear in the GPREGRET register.

Return values:

NRF_SUCCESS

Set bits in the NRF_POWER->GPREGRET register.

Parameters:

[in]

gpregret_msk

Bits to be set in the GPREGRET register.

Return values:

NRF_SUCCESS

Get contents of NRF_POWER->RAMON register, indicates power status of ram blocks.

Parameters:

[out]

p_ramon

Content of NRF_POWER->RAMON register.

Return values:

NRF_SUCCESS

Clears bits in the NRF_POWER->RAMON register.

Parameters:

ramon

Contains the bits needed to be cleared in the NRF_POWER->RAMON register.

Return values:

NRF_SUCCESS

Sets bits in the NRF_POWER->RAMON register.

Parameters:

[in]

ramon

Contains the bits needed to be set in the NRF_POWER->RAMON register.

Return values:

NRF_SUCCESS

Sets the power-fail threshold value.

Parameters:

[in]

threshold

The power-fail threshold value to use.

Return values:

NRF_SUCCESS	The power failure threshold was set.
NRF_ERROR_SOC_POWER_POF_THRESHOLD_UNKNOWN	The power failure threshold is unknown.

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_enable

True if the power-fail comparator should be enabled, false if it should be disabled.

Return values:

NRF_SUCCESS

Puts the chip in System OFF mode.

Return values:

NRF_ERROR_SOC_POWER_OFF_SHOULD_NOT_RETURN

Sets the power mode when in CPU sleep.

Parameters:

[in]

power_mode

The power mode to use when in CPU sleep.

See also:

sd_app_evt_wait

Return values:

NRF_SUCCESS	The power mode was set.
NRF_ERROR_SOC_POWER_MODE_UNKNOWN	The power mode was unknown.

Clears the bits of the reset reason register.

Parameters:

[in]

reset_reason_clr_msk

Contains the bits to clear from the reset reason register.

Return values:

NRF_SUCCESS

Gets the reset reason register.

Parameters:

[out]

p_reset_reason

Contents of the NRF_POWER->RESETREAS register.

Return values:

NRF_SUCCESS

Get random bytes from the application pool.

Parameters:

[out]	p_buff	Pointer to unit8_t buffer for storing the bytes.
[in]	length	Number of bytes to take from pool and place in p_buff.

Return values:

NRF_SUCCESS	The requested bytes were written to p_buff.
NRF_ERROR_SOC_RAND_NOT_ENOUGH_VALUES	No bytes were written to the buffer, because there were not enough bytes available.

Get number of random bytes available to the application.

Parameters:

[out]

p_bytes_available

The number of bytes currently available in the pool.

Return values:

NRF_SUCCESS

Query the capacity of the application random pool.

Parameters:

[out]

p_pool_capacity

The capacity of the pool.

Return values:

NRF_SUCCESS

Exit critical region.

Precondition:

Application has entered a critical region using sd_nvic_critical_region_enter.

Postcondition:

If not in a nested critical region, the application interrupts will restored to the state before sd_nvic_critical_region_enter was called.

Parameters:

[in]

is_nested_critical_region

If this is set to 1, the critical region won't be exited.

See also:

sd_nvic_critical_region_enter.

Return values:

NRF_SUCCESS

Enters critical region.

Postcondition:

Application interrupts will be disabled.

See also:

sd_nvic_critical_region_exit

Parameters:

[out]

p_is_nested_critical_region

1: If in a nested critical region. 0: Otherwise.

Return values:

NRF_SUCCESS

System Reset.

Note:

Corresponds to NVIC_SystemReset in CMSIS.

Return values:

NRF_ERROR_SOC_NVIC_SHOULD_NOT_RETURN

Get Interrupt Priority.

Note:

Corresponds to NVIC_GetPriority in CMSIS.

Precondition:

IRQn is valid and not reserved by the stack.

Parameters:

[in]	IRQn	See the NVIC_GetPriority documentation in CMSIS.
[out]	p_priority	Return value from NVIC_GetPriority.

Return values:

NRF_SUCCESS	The interrupt priority is returned in p_priority.
NRF_ERROR_SOC_NVIC_INTERRUPT_NOT_AVAILABLE	- IRQn is not available for the application.

Set Interrupt Priority.

Note:

Corresponds to NVIC_SetPriority in CMSIS.

Precondition:

IRQn is valid and not reserved by the stack.

Priority is valid and not reserved by the stack.

Parameters:

[in]	IRQn	See the NVIC_SetPriority documentation in CMSIS.
[in]	priority	A valid IRQ priority for use by the application.

Return values:

NRF_SUCCESS	The interrupt and priority level is available for the application.
NRF_ERROR_SOC_NVIC_INTERRUPT_NOT_AVAILABLE	IRQn is not available for the application.
NRF_ERROR_SOC_NVIC_INTERRUPT_PRIORITY_NOT_ALLOWED	The interrupt priority is not available for the application.

Clear Pending Interrupt.

Note:

Corresponds to NVIC_ClearPendingIRQ in CMSIS.

Precondition:

IRQn is valid and not reserved by the stack.

Parameters:

[in]

IRQn

See the NVIC_ClearPendingIRQ documentation in CMSIS.

Return values:

NRF_SUCCESS	The interrupt pending flag is cleared.
NRF_ERROR_SOC_NVIC_INTERRUPT_NOT_AVAILABLE	IRQn is not available for the application.

Set Pending Interrupt.

Note:

Corresponds to NVIC_SetPendingIRQ in CMSIS.

Precondition:

IRQn is valid and not reserved by the stack.

Parameters:

[in]

IRQn

See the NVIC_SetPendingIRQ documentation in CMSIS.

Return values:

NRF_SUCCESS	The interrupt is set pending.
NRF_ERROR_SOC_NVIC_INTERRUPT_NOT_AVAILABLE	IRQn is not available for the application.

Get Pending Interrupt.

Note:

Corresponds to NVIC_GetPendingIRQ in CMSIS.

Precondition:

IRQn is valid and not reserved by the stack.

Parameters:

[in]	IRQn	See the NVIC_GetPendingIRQ documentation in CMSIS.
[out]	p_pending_irq	Return value from NVIC_GetPendingIRQ.

Return values:

NRF_SUCCESS	The interrupt is available for the application.
NRF_ERROR_SOC_NVIC_INTERRUPT_NOT_AVAILABLE	IRQn is not available for the application.

Disable External Interrupt.

Note:

Corresponds to NVIC_DisableIRQ in CMSIS.

Precondition:

IRQn is valid and not reserved by the stack.

Parameters:

[in]

IRQn

See the NVIC_DisableIRQ documentation in CMSIS.

Return values:

NRF_SUCCESS	The interrupt was disabled.
NRF_ERROR_SOC_NVIC_INTERRUPT_NOT_AVAILABLE	The interrupt is not available for the application.

Enable External Interrupt.

Note:

Corresponds to NVIC_EnableIRQ in CMSIS.

Precondition:

IRQn is valid and not reserved by the stack.

Parameters:

[in]

IRQn

See the NVIC_EnableIRQ documentation in CMSIS.

Return values:

NRF_SUCCESS	The interrupt was enabled.
NRF_ERROR_SOC_NVIC_INTERRUPT_NOT_AVAILABLE	The interrupt is not available for the application.
NRF_ERROR_SOC_NVIC_INTERRUPT_PRIORITY_NOT_ALLOWED	The interrupt has a priority not available for the application.

Release a mutex.

Parameters:

[in]

p_mutex

Pointer to the mutex to release.

Return values:

NRF_SUCCESS

Attempt to acquire a mutex.

Parameters:

[in]

p_mutex

Pointer to the mutex to acquire.

Return values:

NRF_SUCCESS	The mutex was successfully acquired.
NRF_ERROR_SOC_MUTEX_ALREADY_TAKEN	The mutex could not be acquired.