S140 SoftDevice v7.2.0
Enumerations
Enumerations

Enumerations

enum  NRF_SOC_SVCS {
  SD_PPI_CHANNEL_ENABLE_GET = (0x20),
  SD_PPI_CHANNEL_ENABLE_SET = (0x20) + 1,
  SD_PPI_CHANNEL_ENABLE_CLR = (0x20) + 2,
  SD_PPI_CHANNEL_ASSIGN = (0x20) + 3,
  SD_PPI_GROUP_TASK_ENABLE = (0x20) + 4,
  SD_PPI_GROUP_TASK_DISABLE = (0x20) + 5,
  SD_PPI_GROUP_ASSIGN = (0x20) + 6,
  SD_PPI_GROUP_GET = (0x20) + 7,
  SD_FLASH_PAGE_ERASE = (0x20) + 8,
  SD_FLASH_WRITE = (0x20) + 9,
  SD_PROTECTED_REGISTER_WRITE = (0x20) + 11,
  SD_MUTEX_NEW = (0x2C),
  SD_MUTEX_ACQUIRE = (0x2C) + 1,
  SD_MUTEX_RELEASE = (0x2C) + 2,
  SD_RAND_APPLICATION_POOL_CAPACITY_GET = (0x2C) + 3,
  SD_RAND_APPLICATION_BYTES_AVAILABLE_GET = (0x2C) + 4,
  SD_RAND_APPLICATION_VECTOR_GET = (0x2C) + 5,
  SD_POWER_MODE_SET = (0x2C) + 6,
  SD_POWER_SYSTEM_OFF = (0x2C) + 7,
  SD_POWER_RESET_REASON_GET = (0x2C) + 8,
  SD_POWER_RESET_REASON_CLR = (0x2C) + 9,
  SD_POWER_POF_ENABLE = (0x2C) + 10,
  SD_POWER_POF_THRESHOLD_SET = (0x2C) + 11,
  SD_POWER_POF_THRESHOLDVDDH_SET = (0x2C) + 12,
  SD_POWER_RAM_POWER_SET = (0x2C) + 13,
  SD_POWER_RAM_POWER_CLR = (0x2C) + 14,
  SD_POWER_RAM_POWER_GET = (0x2C) + 15,
  SD_POWER_GPREGRET_SET = (0x2C) + 16,
  SD_POWER_GPREGRET_CLR = (0x2C) + 17,
  SD_POWER_GPREGRET_GET = (0x2C) + 18,
  SD_POWER_DCDC_MODE_SET = (0x2C) + 19,
  SD_POWER_DCDC0_MODE_SET = (0x2C) + 20,
  SD_APP_EVT_WAIT = (0x2C) + 21,
  SD_CLOCK_HFCLK_REQUEST = (0x2C) + 22,
  SD_CLOCK_HFCLK_RELEASE = (0x2C) + 23,
  SD_CLOCK_HFCLK_IS_RUNNING = (0x2C) + 24,
  SD_RADIO_NOTIFICATION_CFG_SET = (0x2C) + 25,
  SD_ECB_BLOCK_ENCRYPT = (0x2C) + 26,
  SD_ECB_BLOCKS_ENCRYPT = (0x2C) + 27,
  SD_RADIO_SESSION_OPEN = (0x2C) + 28,
  SD_RADIO_SESSION_CLOSE = (0x2C) + 29,
  SD_RADIO_REQUEST = (0x2C) + 30,
  SD_EVT_GET = (0x2C) + 31,
  SD_TEMP_GET = (0x2C) + 32,
  SD_POWER_USBPWRRDY_ENABLE = (0x2C) + 33,
  SD_POWER_USBDETECTED_ENABLE = (0x2C) + 34,
  SD_POWER_USBREMOVED_ENABLE = (0x2C) + 35,
  SD_POWER_USBREGSTATUS_GET = (0x2C) + 36,
  SVC_SOC_LAST = (0x2C) + 37
}
 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_THRESHOLDVDDHS {
  NRF_POWER_THRESHOLDVDDH_V27,
  NRF_POWER_THRESHOLDVDDH_V28,
  NRF_POWER_THRESHOLDVDDH_V29,
  NRF_POWER_THRESHOLDVDDH_V30,
  NRF_POWER_THRESHOLDVDDH_V31,
  NRF_POWER_THRESHOLDVDDH_V32,
  NRF_POWER_THRESHOLDVDDH_V33,
  NRF_POWER_THRESHOLDVDDH_V34,
  NRF_POWER_THRESHOLDVDDH_V35,
  NRF_POWER_THRESHOLDVDDH_V36,
  NRF_POWER_THRESHOLDVDDH_V37,
  NRF_POWER_THRESHOLDVDDH_V38,
  NRF_POWER_THRESHOLDVDDH_V39,
  NRF_POWER_THRESHOLDVDDH_V40,
  NRF_POWER_THRESHOLDVDDH_V41,
  NRF_POWER_THRESHOLDVDDH_V42
}
 Power failure thresholds for high voltage. 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_POWER_USB_POWER_READY,
  NRF_EVT_POWER_USB_DETECTED,
  NRF_EVT_POWER_USB_REMOVED,
  NRF_EVT_NUMBER_OF_EVTS
}
 SoC Events. More...
 

Detailed Description

Enumeration Type Documentation

DC/DC converter modes.

Enumerator
NRF_POWER_DCDC_DISABLE 

The DCDC is disabled.

NRF_POWER_DCDC_ENABLE 

The DCDC is enabled.

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.

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.

Power failure thresholds for high voltage.

Enumerator
NRF_POWER_THRESHOLDVDDH_V27 

2.7 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V28 

2.8 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V29 

2.9 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V30 

3.0 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V31 

3.1 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V32 

3.2 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V33 

3.3 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V34 

3.4 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V35 

3.5 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V36 

3.6 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V37 

3.7 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V38 

3.8 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V39 

3.9 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V40 

4.0 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V41 

4.1 Volts power failure threshold.

NRF_POWER_THRESHOLDVDDH_V42 

4.2 Volts power failure threshold.

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.

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.

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.

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.

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

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.

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: NRF_RADIO_MAX_EXTENSION_PROCESSING_TIME_US. This action must be started at least NRF_RADIO_MIN_EXTENSION_MARGIN_US before the end of the timeslot.

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.

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.

NRF_EVT_POWER_USB_POWER_READY 

Event indicating that a USB 3.3 V supply is ready.

NRF_EVT_POWER_USB_DETECTED 

Event indicating that voltage supply is detected on VBUS.

NRF_EVT_POWER_USB_REMOVED 

Event indicating that voltage supply is removed from VBUS.

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_PPI_CHANNEL_ENABLE_SET 

Base value for SVCs that are available when the SoftDevice is disabled.

SD_PPI_CHANNEL_ENABLE_CLR 

Base value for SVCs that are available when the SoftDevice is disabled.

SD_PPI_CHANNEL_ASSIGN 

Base value for SVCs that are available when the SoftDevice is disabled.

SD_PPI_GROUP_TASK_ENABLE 

Base value for SVCs that are available when the SoftDevice is disabled.

SD_PPI_GROUP_TASK_DISABLE 

Base value for SVCs that are available when the SoftDevice is disabled.

SD_PPI_GROUP_ASSIGN 

Base value for SVCs that are available when the SoftDevice is disabled.

SD_PPI_GROUP_GET 

Base value for SVCs that are available when the SoftDevice is disabled.

SD_FLASH_PAGE_ERASE 

Base value for SVCs that are available when the SoftDevice is disabled.

SD_FLASH_WRITE 

Base value for SVCs that are available when the SoftDevice is disabled.

SD_PROTECTED_REGISTER_WRITE 

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.

SD_MUTEX_ACQUIRE 

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

SD_MUTEX_RELEASE 

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

SD_RAND_APPLICATION_POOL_CAPACITY_GET 

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

SD_RAND_APPLICATION_BYTES_AVAILABLE_GET 

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

SD_RAND_APPLICATION_VECTOR_GET 

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

SD_POWER_MODE_SET 

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

SD_POWER_SYSTEM_OFF 

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

SD_POWER_RESET_REASON_GET 

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

SD_POWER_RESET_REASON_CLR 

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

SD_POWER_POF_ENABLE 

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

SD_POWER_POF_THRESHOLD_SET 

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

SD_POWER_POF_THRESHOLDVDDH_SET 

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

SD_POWER_RAM_POWER_SET 

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

SD_POWER_RAM_POWER_CLR 

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

SD_POWER_RAM_POWER_GET 

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

SD_POWER_GPREGRET_SET 

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

SD_POWER_GPREGRET_CLR 

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

SD_POWER_GPREGRET_GET 

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

SD_POWER_DCDC_MODE_SET 

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

SD_POWER_DCDC0_MODE_SET 

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

SD_APP_EVT_WAIT 

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

SD_CLOCK_HFCLK_REQUEST 

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

SD_CLOCK_HFCLK_RELEASE 

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

SD_CLOCK_HFCLK_IS_RUNNING 

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

SD_RADIO_NOTIFICATION_CFG_SET 

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

SD_ECB_BLOCK_ENCRYPT 

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

SD_ECB_BLOCKS_ENCRYPT 

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

SD_RADIO_SESSION_OPEN 

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

SD_RADIO_SESSION_CLOSE 

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

SD_RADIO_REQUEST 

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

SD_EVT_GET 

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

SD_TEMP_GET 

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

SD_POWER_USBPWRRDY_ENABLE 

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

SD_POWER_USBDETECTED_ENABLE 

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

SD_POWER_USBREMOVED_ENABLE 

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

SD_POWER_USBREGSTATUS_GET 

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

SVC_SOC_LAST 

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


Documentation feedback | Developer Zone | Subscribe | Updated