Data Structures
struct	nrf_radio_request_earliest_t
	Parameters for a request for a timeslot as early as possible. More...

struct	nrf_radio_request_normal_t
	Parameters for a normal radio request. More...

struct	nrf_radio_request_t
	Radio request parameters. More...

struct	nrf_radio_signal_callback_return_param_t
	Return parameters of the radio timeslot signal callback. More...

struct	nrf_ecb_hal_data_t
	AES ECB data structure. More...

Typedefs
typedef volatile uint8_t	nrf_mutex_t
	Represents a mutex for use with the nrf_mutex functions. More...

typedef uint8_t	nrf_app_irq_priority_t
	The interrupt priorities available to the application while the softdevice is active.

typedef uint8_t	nrf_power_mode_t
	Represents a power mode, used in power mode functions.

typedef uint8_t	nrf_power_failure_threshold_t
	Represents a power failure threshold value.

typedef uint32_t	nrf_power_dcdc_mode_t
	Represents a DCDC mode value.

typedef uint8_t	nrf_radio_notification_distance_t
	Radio notification distances.

typedef uint8_t	nrf_radio_notification_type_t
	Radio notification types.

typedef nrf_radio_signal_callback_return_param_t (	nrf_radio_signal_callback_t )(uint8_t signal_type)
	The radio signal callback type. More...

Enumerations
enum	NRF_SOC_SVCS { SD_PPI_CHANNEL_ENABLE_GET = (0x20), SD_PPI_CHANNEL_ENABLE_SET, SD_PPI_CHANNEL_ENABLE_CLR, SD_PPI_CHANNEL_ASSIGN, SD_PPI_GROUP_TASK_ENABLE, SD_PPI_GROUP_TASK_DISABLE, SD_PPI_GROUP_ASSIGN, SD_PPI_GROUP_GET, SD_FLASH_PAGE_ERASE, SD_FLASH_WRITE, SD_FLASH_PROTECT, SD_MUTEX_NEW = (0x2B), SD_MUTEX_ACQUIRE, SD_MUTEX_RELEASE, SD_NVIC_ENABLEIRQ, SD_NVIC_DISABLEIRQ, SD_NVIC_GETPENDINGIRQ, SD_NVIC_SETPENDINGIRQ, SD_NVIC_CLEARPENDINGIRQ, SD_NVIC_SETPRIORITY, SD_NVIC_GETPRIORITY, SD_NVIC_SYSTEMRESET, SD_NVIC_CRITICAL_REGION_ENTER, SD_NVIC_CRITICAL_REGION_EXIT, SD_RAND_APPLICATION_POOL_CAPACITY, SD_RAND_APPLICATION_BYTES_AVAILABLE, SD_RAND_APPLICATION_GET_VECTOR, SD_POWER_MODE_SET, SD_POWER_SYSTEM_OFF, SD_POWER_RESET_REASON_GET, SD_POWER_RESET_REASON_CLR, SD_POWER_POF_ENABLE, SD_POWER_POF_THRESHOLD_SET, SD_POWER_RAMON_SET, SD_POWER_RAMON_CLR, SD_POWER_RAMON_GET, SD_POWER_GPREGRET_SET, SD_POWER_GPREGRET_CLR, SD_POWER_GPREGRET_GET, SD_POWER_DCDC_MODE_SET, SD_APP_EVT_WAIT, SD_CLOCK_HFCLK_REQUEST, SD_CLOCK_HFCLK_RELEASE, SD_CLOCK_HFCLK_IS_RUNNING, SD_RADIO_NOTIFICATION_CFG_SET, SD_ECB_BLOCK_ENCRYPT, SD_RADIO_SESSION_OPEN, SD_RADIO_SESSION_CLOSE, SD_RADIO_REQUEST, SD_EVT_GET, SD_TEMP_GET, SVC_SOC_LAST }
	The SVC numbers used by the SVC functions in the SoC library.

enum	NRF_MUTEX_VALUES { NRF_MUTEX_FREE, NRF_MUTEX_TAKEN }
	Possible values of a nrf_mutex_t.

enum	NRF_APP_PRIORITIES { NRF_APP_PRIORITY_HIGH = 1, NRF_APP_PRIORITY_LOW = 3 }
	Possible values of nrf_app_irq_priority_t.

enum	NRF_POWER_MODES { NRF_POWER_MODE_CONSTLAT, NRF_POWER_MODE_LOWPWR }
	Possible values of nrf_power_mode_t. More...

enum	NRF_POWER_THRESHOLDS { NRF_POWER_THRESHOLD_V21, NRF_POWER_THRESHOLD_V23, NRF_POWER_THRESHOLD_V25, NRF_POWER_THRESHOLD_V27 }
	Possible values of nrf_power_failure_threshold_t. More...

enum	NRF_POWER_DCDC_MODES { NRF_POWER_DCDC_DISABLE, NRF_POWER_DCDC_ENABLE }
	Possible values of nrf_power_dcdc_mode_t. More...

enum	NRF_RADIO_NOTIFICATION_DISTANCES { NRF_RADIO_NOTIFICATION_DISTANCE_NONE = 0, NRF_RADIO_NOTIFICATION_DISTANCE_800US, NRF_RADIO_NOTIFICATION_DISTANCE_1740US, NRF_RADIO_NOTIFICATION_DISTANCE_2680US, NRF_RADIO_NOTIFICATION_DISTANCE_3620US, NRF_RADIO_NOTIFICATION_DISTANCE_4560US, NRF_RADIO_NOTIFICATION_DISTANCE_5500US }
	Possible values of nrf_radio_notification_distance_t. More...

enum	NRF_RADIO_NOTIFICATION_TYPES { NRF_RADIO_NOTIFICATION_TYPE_NONE = 0, NRF_RADIO_NOTIFICATION_TYPE_INT_ON_ACTIVE, NRF_RADIO_NOTIFICATION_TYPE_INT_ON_INACTIVE, NRF_RADIO_NOTIFICATION_TYPE_INT_ON_BOTH }
	Possible values of nrf_radio_notification_type_t. More...

enum	NRF_SOC_EVTS { NRF_EVT_HFCLKSTARTED, NRF_EVT_POWER_FAILURE_WARNING, NRF_EVT_FLASH_OPERATION_SUCCESS, NRF_EVT_FLASH_OPERATION_ERROR, NRF_EVT_RADIO_BLOCKED, NRF_EVT_RADIO_CANCELED, NRF_EVT_RADIO_SIGNAL_CALLBACK_INVALID_RETURN, NRF_EVT_RADIO_SESSION_IDLE, NRF_EVT_RADIO_SESSION_CLOSED, NRF_EVT_NUMBER_OF_EVTS }
	SoC Events. More...

enum	NRF_RADIO_CALLBACK_SIGNAL_TYPE { NRF_RADIO_CALLBACK_SIGNAL_TYPE_START, NRF_RADIO_CALLBACK_SIGNAL_TYPE_TIMER0, NRF_RADIO_CALLBACK_SIGNAL_TYPE_RADIO, NRF_RADIO_CALLBACK_SIGNAL_TYPE_EXTEND_FAILED, NRF_RADIO_CALLBACK_SIGNAL_TYPE_EXTEND_SUCCEEDED }
	The Radio signal callback types. More...

enum	NRF_RADIO_SIGNAL_CALLBACK_ACTION { NRF_RADIO_SIGNAL_CALLBACK_ACTION_NONE, NRF_RADIO_SIGNAL_CALLBACK_ACTION_EXTEND, NRF_RADIO_SIGNAL_CALLBACK_ACTION_END, NRF_RADIO_SIGNAL_CALLBACK_ACTION_REQUEST_AND_END }
	The actions requested by the signal callback. More...

enum	NRF_RADIO_HFCLK_CFG { NRF_RADIO_HFCLK_CFG_DEFAULT, NRF_RADIO_HFCLK_CFG_FORCE_XTAL }
	Radio timeslot high frequency clock source configuration. More...

enum	NRF_RADIO_PRIORITY { NRF_RADIO_PRIORITY_HIGH, NRF_RADIO_PRIORITY_NORMAL }
	Radio timeslot priorities. More...

enum	NRF_RADIO_REQUEST_TYPE { NRF_RADIO_REQ_TYPE_EARLIEST, NRF_RADIO_REQ_TYPE_NORMAL }
	Radio timeslot request type. More...

Detailed Description

Typedef Documentation

typedef volatile uint8_t nrf_mutex_t

Represents a mutex for use with the nrf_mutex functions.

Note: Accessing the value directly is not safe, use the mutex functions!

typedef nrf_radio_signal_callback_return_param_t*(* nrf_radio_signal_callback_t)(uint8_t signal_type)

The radio signal callback type.

Note: In case of invalid return parameters, the radio timeslot will automatically end immediately after returning from the signal callback and the NRF_EVT_RADIO_SIGNAL_CALLBACK_INVALID_RETURN event will be sent.; The returned struct pointer must remain valid after the signal callback function returns. For instance, this means that it must not point to a stack variable.

Parameters

[in] signal_type Type of signal, see NRF_RADIO_CALLBACK_SIGNAL_TYPE.

Returns: Pointer to structure containing action requested by the application.

Enumeration Type Documentation

enum NRF_POWER_DCDC_MODES

Possible values of nrf_power_dcdc_mode_t.

Enumerator
NRF_POWER_DCDC_DISABLE	The DCDC is disabled.
NRF_POWER_DCDC_ENABLE	The DCDC is enabled.

enum NRF_POWER_MODES

Possible values of nrf_power_mode_t.

Enumerator
NRF_POWER_MODE_CONSTLAT	Constant latency mode. See power management in the reference manual.
NRF_POWER_MODE_LOWPWR	Low power mode. See power management in the reference manual.

enum NRF_POWER_THRESHOLDS

Possible values of nrf_power_failure_threshold_t.

Enumerator
NRF_POWER_THRESHOLD_V21	2.1 Volts power failure threshold.
NRF_POWER_THRESHOLD_V23	2.3 Volts power failure threshold.
NRF_POWER_THRESHOLD_V25	2.5 Volts power failure threshold.
NRF_POWER_THRESHOLD_V27	2.7 Volts power failure threshold.

enum NRF_RADIO_CALLBACK_SIGNAL_TYPE

The Radio signal callback types.

Enumerator
NRF_RADIO_CALLBACK_SIGNAL_TYPE_START	This signal indicates the start of the radio timeslot.
NRF_RADIO_CALLBACK_SIGNAL_TYPE_TIMER0	This signal indicates the NRF_TIMER0 interrupt.
NRF_RADIO_CALLBACK_SIGNAL_TYPE_RADIO	This signal indicates the NRF_RADIO interrupt.
NRF_RADIO_CALLBACK_SIGNAL_TYPE_EXTEND_FAILED	This signal indicates extend action failed.
NRF_RADIO_CALLBACK_SIGNAL_TYPE_EXTEND_SUCCEEDED	This signal indicates extend action succeeded.

enum NRF_RADIO_HFCLK_CFG

Radio timeslot high frequency clock source configuration.

Enumerator
NRF_RADIO_HFCLK_CFG_DEFAULT	Use the currently selected oscillator as HF clock source during the timeslot (i.e. the source is not specified).
NRF_RADIO_HFCLK_CFG_FORCE_XTAL	Force external crystal to be used as HF clock source during whole the timeslot.

enum NRF_RADIO_NOTIFICATION_DISTANCES

Possible values of nrf_radio_notification_distance_t.

Enumerator
NRF_RADIO_NOTIFICATION_DISTANCE_NONE	The event does not have a notification.
NRF_RADIO_NOTIFICATION_DISTANCE_800US	The distance from the active notification to start of radio activity.
NRF_RADIO_NOTIFICATION_DISTANCE_1740US	The distance from the active notification to start of radio activity.
NRF_RADIO_NOTIFICATION_DISTANCE_2680US	The distance from the active notification to start of radio activity.
NRF_RADIO_NOTIFICATION_DISTANCE_3620US	The distance from the active notification to start of radio activity.
NRF_RADIO_NOTIFICATION_DISTANCE_4560US	The distance from the active notification to start of radio activity.
NRF_RADIO_NOTIFICATION_DISTANCE_5500US	The distance from the active notification to start of radio activity.

enum NRF_RADIO_NOTIFICATION_TYPES

Possible values of nrf_radio_notification_type_t.

Enumerator
NRF_RADIO_NOTIFICATION_TYPE_NONE	The event does not have a radio notification signal.
NRF_RADIO_NOTIFICATION_TYPE_INT_ON_ACTIVE	Using interrupt for notification when the radio will be enabled.
NRF_RADIO_NOTIFICATION_TYPE_INT_ON_INACTIVE	Using interrupt for notification when the radio has been disabled.
NRF_RADIO_NOTIFICATION_TYPE_INT_ON_BOTH	Using interrupt for notification both when the radio will be enabled and disabled.

enum NRF_RADIO_PRIORITY

Radio timeslot priorities.

Enumerator
NRF_RADIO_PRIORITY_HIGH	High (equal priority as the normal connection priority of the SoftDevice stack(s)).
NRF_RADIO_PRIORITY_NORMAL	Normal (equal priority as the priority of secondary activites of the SoftDevice stack(s)).

enum NRF_RADIO_REQUEST_TYPE

Radio timeslot request type.

Enumerator
NRF_RADIO_REQ_TYPE_EARLIEST	Request timeslot as early as possible. This should always be used for the first request in a session.
NRF_RADIO_REQ_TYPE_NORMAL	Normal timeslot request.

enum NRF_RADIO_SIGNAL_CALLBACK_ACTION

The actions requested by the signal callback.

This code gives the SOC instructions about what action to take when the signal callback has returned.

Enumerator
NRF_RADIO_SIGNAL_CALLBACK_ACTION_NONE	Return without action.
NRF_RADIO_SIGNAL_CALLBACK_ACTION_EXTEND	Request an extension of the current timeslot (maximum execution time for this action is when the extension succeeded).
NRF_RADIO_SIGNAL_CALLBACK_ACTION_END	End the current radio timeslot.
NRF_RADIO_SIGNAL_CALLBACK_ACTION_REQUEST_AND_END	Request a new radio timeslot and end the current timeslot.

enum NRF_SOC_EVTS

SoC Events.

Enumerator
NRF_EVT_HFCLKSTARTED	Event indicating that the HFCLK has started.
NRF_EVT_POWER_FAILURE_WARNING	Event indicating that a power failure warning has occurred.
NRF_EVT_FLASH_OPERATION_SUCCESS	Event indicating that the ongoing flash operation has completed successfully.
NRF_EVT_FLASH_OPERATION_ERROR	Event indicating that the ongoing flash operation has timed out with an error.
NRF_EVT_RADIO_BLOCKED	Event indicating that a radio timeslot was blocked.
NRF_EVT_RADIO_CANCELED	Event indicating that a radio timeslot was canceled by SoftDevice.
NRF_EVT_RADIO_SIGNAL_CALLBACK_INVALID_RETURN	Event indicating that a radio signal callback handler return was invalid.
NRF_EVT_RADIO_SESSION_IDLE	Event indicating that a radio session is idle.
NRF_EVT_RADIO_SESSION_CLOSED	Event indicating that a radio session is closed.

Data Structures

Typedefs

Enumerations

Detailed Description

Typedef Documentation

Enumeration Type Documentation