Enumerations

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_RAND_APPLICATION_POOL_CAPACITY_GET,   SD_RAND_APPLICATION_BYTES_AVAILABLE_GET,   SD_RAND_APPLICATION_VECTOR_GET,   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_RAM_POWER_SET,   SD_POWER_RAM_POWER_CLR,   SD_POWER_RAM_POWER_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_ECB_BLOCKS_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. More...
enum	NRF_MUTEX_VALUES {   NRF_MUTEX_FREE,   NRF_MUTEX_TAKEN }
	Possible values of a nrf_mutex_t.
enum	NRF_POWER_MODES {   NRF_POWER_MODE_CONSTLAT,   NRF_POWER_MODE_LOWPWR }
	Power modes. More...
enum	NRF_POWER_THRESHOLDS {   NRF_POWER_THRESHOLD_V17 = 4UL,   NRF_POWER_THRESHOLD_V18,   NRF_POWER_THRESHOLD_V19,   NRF_POWER_THRESHOLD_V20,   NRF_POWER_THRESHOLD_V21,   NRF_POWER_THRESHOLD_V22,   NRF_POWER_THRESHOLD_V23,   NRF_POWER_THRESHOLD_V24,   NRF_POWER_THRESHOLD_V25,   NRF_POWER_THRESHOLD_V26,   NRF_POWER_THRESHOLD_V27,   NRF_POWER_THRESHOLD_V28 }
	Power failure thresholds. More...
enum	NRF_POWER_DCDC_MODES {   NRF_POWER_DCDC_DISABLE,   NRF_POWER_DCDC_ENABLE }
	DC/DC converter modes. 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 }
	Radio notification distances. 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 }
	Radio notification types. 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_XTAL_GUARANTEED,   NRF_RADIO_HFCLK_CFG_NO_GUARANTEE }
	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...
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...

Detailed Description

Enumeration Type Documentation

enum NRF_POWER_DCDC_MODES

DC/DC converter modes.

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

Definition at line 182 of file nrf_soc.h.

enum NRF_POWER_MODES

Power modes.

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.

Definition at line 156 of file nrf_soc.h.

enum NRF_POWER_THRESHOLDS

Power failure thresholds.

Enumerator
NRF_POWER_THRESHOLD_V17	1.7 Volts power failure threshold.
NRF_POWER_THRESHOLD_V18	1.8 Volts power failure threshold.
NRF_POWER_THRESHOLD_V19	1.9 Volts power failure threshold.
NRF_POWER_THRESHOLD_V20	2.0 Volts power failure threshold.
NRF_POWER_THRESHOLD_V21	2.1 Volts power failure threshold.
NRF_POWER_THRESHOLD_V22	2.2 Volts power failure threshold.
NRF_POWER_THRESHOLD_V23	2.3 Volts power failure threshold.
NRF_POWER_THRESHOLD_V24	2.4 Volts power failure threshold.
NRF_POWER_THRESHOLD_V25	2.5 Volts power failure threshold.
NRF_POWER_THRESHOLD_V26	2.6 Volts power failure threshold.
NRF_POWER_THRESHOLD_V27	2.7 Volts power failure threshold.
NRF_POWER_THRESHOLD_V28	2.8 Volts power failure threshold.

Definition at line 164 of file nrf_soc.h.

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.

Definition at line 211 of file nrf_soc.h.

enum NRF_RADIO_HFCLK_CFG

Radio timeslot high frequency clock source configuration.

Enumerator
NRF_RADIO_HFCLK_CFG_XTAL_GUARANTEED	The SoftDevice will guarantee that the high frequency clock source is the external crystal for the whole duration of the timeslot. This should be the preferred option for events that use the radio or require high timing accuracy. Note The SoftDevice will automatically turn on and off the external crystal, at the beginning and end of the timeslot, respectively. The crystal may also intentionally be left running after the timeslot, in cases where it is needed by the SoftDevice shortly after the end of the timeslot.
NRF_RADIO_HFCLK_CFG_NO_GUARANTEE	This configuration allows for earlier and tighter scheduling of timeslots. The RC oscillator may be the clock source in part or for the whole duration of the timeslot. The RC oscillator's accuracy must therefore be taken into consideration. Note If the application will use the radio peripheral in timeslots with this configuration, it must make sure that the crystal is running and stable before starting the radio.

Definition at line 234 of file nrf_soc.h.

enum NRF_RADIO_NOTIFICATION_DISTANCES

Radio notification distances.

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.

Definition at line 189 of file nrf_soc.h.

enum NRF_RADIO_NOTIFICATION_TYPES

Radio notification types.

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.

Definition at line 202 of file nrf_soc.h.

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 activities of the SoftDevice stack(s)).

Definition at line 251 of file nrf_soc.h.

enum NRF_RADIO_REQUEST_TYPE

Radio timeslot request type.

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

Definition at line 258 of file nrf_soc.h.

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.

Definition at line 225 of file nrf_soc.h.

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 timeslot signal callback handler return was invalid.
NRF_EVT_RADIO_SESSION_IDLE	Event indicating that a radio timeslot session is idle.
NRF_EVT_RADIO_SESSION_CLOSED	Event indicating that a radio timeslot session is closed.

Definition at line 265 of file nrf_soc.h.

enum NRF_SOC_SVCS

The SVC numbers used by the SVC functions in the SoC library.

Enumerator
SD_PPI_CHANNEL_ENABLE_GET	Base value for SVCs that are available when the SoftDevice is disabled.
SD_MUTEX_NEW	Base value for SVCs that are not available when the SoftDevice is disabled.

Definition at line 101 of file nrf_soc.h.