S332 SoftDevice
S332 SoftDevice v6.1.1 API
Message Sequence Charts
API Reference
ANT STACK
ANT Application Interface
ANT Error Return
ANT Stack Parameters
CRC Mode Defines
Time Base Defines
ANT_TIME_STAMP_CONFIG
ANT_TIME_SYNC_CONFIG
ANT_HIGH_DUTY_SEARCH_CONFIG
ANT_PA_LNA_CONFIG
ANT_MESSAGE
ANT_ENABLE
ANT_BUFFER_PTR
BLE SoftDevice Common
Bluetooth status codes
Common types and macro definitions
Defines
Assigned Values for BLE UUIDs
BLE Connection Handles
Bluetooth Appearance values
Types of UUID
Structures
ble_uuid128_t
ble_uuid_t
ble_data_t
Events, type definitions and API calls
Defines
Advertiser Role Scheduling Configuration
Configuration defaults.
User Memory Types
Vendor Specific base UUID counts
Enumerations
Functions
Structures
ble_user_mem_block_t
ble_evt_user_mem_request_t
ble_evt_user_mem_release_t
ble_common_evt_t
ble_evt_hdr_t
ble_evt_t
ble_version_t
ble_pa_lna_cfg_t
ble_common_opt_pa_lna_t
ble_common_opt_conn_evt_ext_t
ble_common_opt_extended_rc_cal_t
ble_common_opt_adv_sched_cfg_t
ble_common_opt_t
ble_opt_t
ble_conn_cfg_t
ble_common_cfg_vs_uuid_t
ble_common_cfg_t
ble_cfg_t
General error codes
Message Sequence Charts
BLE Stack Enable
Connection Configuration
Interrupt-driven Event Retrieval
Thread Mode Event Retrieval
Module specific SVC, event and option number subranges
Module specific error code subranges
SoftDevice Global Error Codes
Error Codes Base number definitions
Generic Access Profile (GAP)
Defines
Advertising data sizes.
Authenticated payload timeout defines.
GAP Address types
GAP Advertisement Flags
GAP Advertising Set Terminated reasons
GAP Advertising and Scan Response Data format
GAP Advertising data status
GAP Advertising filter policies
GAP Advertising interval max and min
GAP Advertising timeout values in 10 ms units
GAP Advertising types
GAP Authentication Key Types
GAP Connection Parameters Limits
GAP Discovery modes
GAP IO Capabilities
GAP Keypress Notification Types
GAP Minimum scanner buffer size
GAP PHYs
GAP Roles
GAP Scan interval max and min
GAP Scan timeout max and min
GAP Scan window max and min
GAP Scanner filter policies
GAP Security Modes
GAP Security status
GAP Security status sources
GAP Timeout sources
GAP attribute security requirement setters
GAP concurrent connection count defines.
GAP device name defines.
GAP event length defines.
Privacy modes
Quality of Service (QoS) Channel survey interval defines
SVC return values specific to GAP
Enumerations
Functions
Message Sequence Charts
Advertising
Advertising using extended advertising PDUs
Advertising using legacy advertising PDUs
Central Connection Establishment and Termination
Connecting to advertisers performing extended advertising
Connecting to legacy advertisers
Central Connection Parameter Update
Central Connection Parameter Update on multiple links
Central Control Procedure Serialization on multiple links
Central Security Procedures
Central Encryption and Authentication mutual exclusion
Central LESC Pairing
Bonding: Numeric Comparison
Bonding: Out of Band
Bonding: Passkey Entry: Central Displays
Bonding: Passkey Entry: User Inputs on Central
Pairing: Just Works
Central Legacy Pairing
Bonding: Just Works
Bonding: Passkey Entry, Central displays
Bonding: Passkey Entry, User Inputs on Central or OOB
Pairing: Just Works
Encryption Establishment using stored keys
Security Request Reception
Unexpected Security Packet Reception
Data Length Update Procedure
PHY Update Procedure
Central PHY Update
Peripheral PHY Update
Peripheral Connection Establishment and Termination
Peripheral Connection Parameter Update
Peripheral Security Procedures
GAP Failed Pairing: Keysize too small
Pairing failure: Keysize out of supported range
Pairing failure: Pairing aborted by the application
Pairing failure: Pairing failed from central
Pairing failure: Timeout
Peripheral Encryption Establishment using stored keys
Peripheral LESC Pairing
Bonding: Numeric Comparison
Bonding: Out of Band
Bonding: Passkey Entry, Peripheral Displays
Bonding: Passkey Entry, User Inputs on Peripheral
Pairing: Just Works
Peripheral Legacy Pairing
Bonding: Just Works
Bonding: Passkey Entry with static passkey
Bonding: Passkey Entry, Peripheral displays
Bonding: Passkey Entry, User Inputs on Peripheral or OOB
Pairing failure: Confirm failed
Pairing: Just Works
Peripheral Security Request
Unexpected Security Packet Reception
Privacy
Central Connection Establishment with Private Peer
Directed Advertising
Peripheral Connection Establishment with Private Peer
Private Advertising
Private Scanning
Scan Private Devices
RSSI for connections with event filter
RSSI get sample
Scanning
Scanning for advertisers performing legacy advertising
Scanning for advertisers performing legacy and extended advertising
Whitelist Sharing
Structures
ble_gap_adv_properties_t
ble_gap_adv_report_type_t
ble_gap_aux_pointer_t
ble_gap_addr_t
ble_gap_conn_params_t
ble_gap_conn_sec_mode_t
ble_gap_conn_sec_t
ble_gap_irk_t
ble_gap_adv_params_t
ble_gap_adv_data_t
ble_gap_scan_params_t
ble_gap_privacy_params_t
ble_gap_phys_t
ble_gap_sec_kdist_t
ble_gap_sec_params_t
ble_gap_enc_info_t
ble_gap_master_id_t
ble_gap_sign_info_t
ble_gap_lesc_p256_pk_t
ble_gap_lesc_dhkey_t
ble_gap_lesc_oob_data_t
ble_gap_evt_connected_t
ble_gap_evt_disconnected_t
ble_gap_evt_conn_param_update_t
ble_gap_evt_phy_update_request_t
ble_gap_evt_phy_update_t
ble_gap_evt_sec_params_request_t
ble_gap_evt_sec_info_request_t
ble_gap_evt_passkey_display_t
ble_gap_evt_key_pressed_t
ble_gap_evt_auth_key_request_t
ble_gap_evt_lesc_dhkey_request_t
ble_gap_sec_levels_t
ble_gap_enc_key_t
ble_gap_id_key_t
ble_gap_sec_keys_t
ble_gap_sec_keyset_t
ble_gap_data_length_params_t
ble_gap_data_length_limitation_t
ble_gap_evt_auth_status_t
ble_gap_evt_conn_sec_update_t
ble_gap_evt_timeout_t
ble_gap_evt_rssi_changed_t
ble_gap_evt_adv_set_terminated_t
ble_gap_evt_adv_report_t
ble_gap_evt_sec_request_t
ble_gap_evt_conn_param_update_request_t
ble_gap_evt_scan_req_report_t
ble_gap_evt_data_length_update_request_t
ble_gap_evt_data_length_update_t
ble_gap_evt_qos_channel_survey_report_t
ble_gap_evt_t
ble_gap_conn_cfg_t
ble_gap_cfg_role_count_t
ble_gap_cfg_device_name_t
ble_gap_cfg_t
ble_gap_opt_ch_map_t
ble_gap_opt_local_conn_latency_t
ble_gap_opt_slave_latency_disable_t
ble_gap_opt_passkey_t
ble_gap_opt_compat_mode_1_t
ble_gap_opt_auth_payload_timeout_t
ble_gap_opt_t
Generic Attribute Profile (GATT) Client
Defines
Attribute Information Formats
GATT Client defaults
SVC return values specific to GATTC
Enumerations
Functions
Message Sequence Charts
GATTC ATT_MTU Exchange
GATTC Characteristic Discovery
GATTC Characteristic Value Write Without Response
GATTC Characteristic or Descriptor Value Long Write
GATTC Characteristic or Descriptor Value Read
GATTC Characteristic or Descriptor Value Reliable Write
GATTC Characteristic or Descriptor Value Write
GATTC Descriptor Discovery
GATTC Handle Value Indication
GATTC Handle Value Notification
GATTC Primary Service Discovery
GATTC Read Characteristic Value by UUID
GATTC Read Multiple Characteristic Values
GATTC Relationship Discovery
GATTC Timeout
Structures
ble_gattc_conn_cfg_t
ble_gattc_handle_range_t
ble_gattc_service_t
ble_gattc_include_t
ble_gattc_char_t
ble_gattc_desc_t
ble_gattc_write_params_t
ble_gattc_attr_info16_t
ble_gattc_attr_info128_t
ble_gattc_evt_prim_srvc_disc_rsp_t
ble_gattc_evt_rel_disc_rsp_t
ble_gattc_evt_char_disc_rsp_t
ble_gattc_evt_desc_disc_rsp_t
ble_gattc_evt_attr_info_disc_rsp_t
ble_gattc_handle_value_t
ble_gattc_evt_char_val_by_uuid_read_rsp_t
ble_gattc_evt_read_rsp_t
ble_gattc_evt_char_vals_read_rsp_t
ble_gattc_evt_write_rsp_t
ble_gattc_evt_hvx_t
ble_gattc_evt_exchange_mtu_rsp_t
ble_gattc_evt_timeout_t
ble_gattc_evt_write_cmd_tx_complete_t
ble_gattc_evt_t
Generic Attribute Profile (GATT) Common
Defines
Characteristic Presentation Formats
GATT Bluetooth Namespaces
GATT Execute Write flags
GATT Handle Value operations
GATT Status Codes
GATT Timeout sources
GATT Write operations
Structures
ble_gatt_conn_cfg_t
ble_gatt_char_props_t
ble_gatt_char_ext_props_t
Generic Attribute Profile (GATT) Server
Defines
Attribute Table size
GATT Server Attribute Types
GATT Server Authorization Types
GATT Server Operations
GATT Server Service Types
GATT Server defaults
GATT Value Locations
Maximum attribute lengths
SVC return values specific to GATTS
Service Changed Inclusion Values
System Attribute Flags
Enumerations
Functions
Message Sequence Charts
GATTS ATT Table Population
GATTS ATT_MTU Exchange
GATTS Handle Value Indication
GATTS Handle Value Indication or Notification disabled
GATTS Handle Value Indication or Notification with System Attributes Missing
GATTS Handle Value Notification
GATTS Queued Writes: App handled, no attributes require authorization
GATTS Queued Writes: App handled, one or more attributes require authorization
GATTS Queued Writes: Execute Write without Prepare Write
GATTS Queued Writes: Peer cancels operation
GATTS Queued Writes: Prepare Queue Full
GATTS Queued Writes: Stack handled, no attributes require authorization
GATTS Queued Writes: Stack handled, one or more attributes require authorization
GATTS Read Request with Authorization
GATTS Read Request without Authorization
GATTS Service Changed
GATTS System Attributes Handling: Bonded Peer
GATTS System Attributes Handling: Unknown Peer
GATTS Timeout
GATTS Write Command With Authorization
GATTS Write Command Without Authorization
GATTS Write Request with Authorization
GATTS Write Request without Authorization
Structures
ble_gatts_conn_cfg_t
ble_gatts_attr_md_t
ble_gatts_attr_t
ble_gatts_value_t
ble_gatts_char_pf_t
ble_gatts_char_md_t
ble_gatts_char_handles_t
ble_gatts_hvx_params_t
ble_gatts_authorize_params_t
ble_gatts_rw_authorize_reply_params_t
ble_gatts_cfg_service_changed_t
ble_gatts_cfg_attr_tab_size_t
ble_gatts_cfg_t
ble_gatts_evt_write_t
ble_gatts_evt_read_t
ble_gatts_evt_rw_authorize_request_t
ble_gatts_evt_sys_attr_missing_t
ble_gatts_evt_hvc_t
ble_gatts_evt_exchange_mtu_request_t
ble_gatts_evt_timeout_t
ble_gatts_evt_hvn_tx_complete_t
ble_gatts_evt_t
User memory layout for Queued Writes
User memory layout for System Attributes
Logical Link Control and Adaptation Protocol (L2CAP)
Defines
L2CAP channel setup refused sources
L2CAP channel status codes
Enumerations
Functions
Message Sequence Charts
L2CAP Channel Release
L2CAP Channel SDU Receive
L2CAP Channel SDU Transmit
L2CAP Channel Setup
L2CAP Channel advanced SDU reception flow control
Structures
ble_l2cap_conn_cfg_t
ble_l2cap_ch_rx_params_t
ble_l2cap_ch_setup_params_t
ble_l2cap_ch_tx_params_t
ble_l2cap_evt_ch_setup_request_t
ble_l2cap_evt_ch_setup_refused_t
ble_l2cap_evt_ch_setup_t
ble_l2cap_evt_ch_sdu_buf_released_t
ble_l2cap_evt_ch_credit_t
ble_l2cap_evt_ch_rx_t
ble_l2cap_evt_ch_tx_t
ble_l2cap_evt_t
Terminology
Master Boot Record API
Defines
Enumerations
Functions
Types
sd_mbr_command_copy_sd_t
sd_mbr_command_compare_t
sd_mbr_command_copy_bl_t
sd_mbr_command_vector_table_base_set_t
sd_mbr_command_irq_forward_address_set_t
sd_mbr_command_t
SoC Library API
Defines
Enumerations
Functions
SoC Library Error Codes
Structures
nrf_radio_request_earliest_t
nrf_radio_request_normal_t
nrf_radio_request_t
nrf_radio_signal_callback_return_param_t
nrf_ecb_hal_data_t
nrf_ecb_hal_data_block_t
SoftDevice Manager API
Defines
Clock accuracy
Fault ID ranges
Fault ID types
Possible LFCLK oscillator sources
Enumerations
Functions
SoftDevice Manager Error Codes
Types
nrf_clock_lf_cfg_t
SoftDevice NVIC API
Defines
SoftDevice NVIC internal definitions
SoftDevice NVIC internal functions
SoftDevice NVIC public functions
Variables
nrf_nvic_state_t
Data Structures
Data Structures
ANT_BUFFER_PTR
ANT_ENABLE
ANT_HIGH_DUTY_SEARCH_CONFIG
ANT_MESSAGE
ANT_PA_LNA_CONFIG
ANT_TIME_STAMP_CONFIG
ANT_TIME_SYNC_CONFIG
ble_cfg_t
ble_common_cfg_t
ble_common_cfg_vs_uuid_t
ble_common_evt_t
ble_common_opt_adv_sched_cfg_t
ble_common_opt_conn_evt_ext_t
ble_common_opt_extended_rc_cal_t
ble_common_opt_pa_lna_t
ble_common_opt_t
ble_conn_cfg_t
ble_data_t
ble_evt_hdr_t
ble_evt_t
ble_evt_user_mem_release_t
ble_evt_user_mem_request_t
ble_gap_addr_t
ble_gap_adv_data_t
ble_gap_adv_params_t
ble_gap_adv_properties_t
ble_gap_adv_report_type_t
ble_gap_aux_pointer_t
ble_gap_cfg_device_name_t
ble_gap_cfg_role_count_t
ble_gap_cfg_t
ble_gap_conn_cfg_t
ble_gap_conn_params_t
ble_gap_conn_sec_mode_t
ble_gap_conn_sec_t
ble_gap_data_length_limitation_t
ble_gap_data_length_params_t
ble_gap_enc_info_t
ble_gap_enc_key_t
ble_gap_evt_adv_report_t
ble_gap_evt_adv_set_terminated_t
ble_gap_evt_auth_key_request_t
ble_gap_evt_auth_status_t
ble_gap_evt_conn_param_update_request_t
ble_gap_evt_conn_param_update_t
ble_gap_evt_conn_sec_update_t
ble_gap_evt_connected_t
ble_gap_evt_data_length_update_request_t
ble_gap_evt_data_length_update_t
ble_gap_evt_disconnected_t
ble_gap_evt_key_pressed_t
ble_gap_evt_lesc_dhkey_request_t
ble_gap_evt_passkey_display_t
ble_gap_evt_phy_update_request_t
ble_gap_evt_phy_update_t
ble_gap_evt_qos_channel_survey_report_t
ble_gap_evt_rssi_changed_t
ble_gap_evt_scan_req_report_t
ble_gap_evt_sec_info_request_t
ble_gap_evt_sec_params_request_t
ble_gap_evt_sec_request_t
ble_gap_evt_t
ble_gap_evt_timeout_t
ble_gap_id_key_t
ble_gap_irk_t
ble_gap_lesc_dhkey_t
ble_gap_lesc_oob_data_t
ble_gap_lesc_p256_pk_t
ble_gap_master_id_t
ble_gap_opt_auth_payload_timeout_t
ble_gap_opt_ch_map_t
ble_gap_opt_compat_mode_1_t
ble_gap_opt_local_conn_latency_t
ble_gap_opt_passkey_t
ble_gap_opt_slave_latency_disable_t
ble_gap_opt_t
ble_gap_phys_t
ble_gap_privacy_params_t
ble_gap_scan_params_t
ble_gap_sec_kdist_t
ble_gap_sec_keys_t
ble_gap_sec_keyset_t
ble_gap_sec_levels_t
ble_gap_sec_params_t
ble_gap_sign_info_t
ble_gatt_char_ext_props_t
ble_gatt_char_props_t
ble_gatt_conn_cfg_t
ble_gattc_attr_info128_t
ble_gattc_attr_info16_t
ble_gattc_char_t
ble_gattc_conn_cfg_t
ble_gattc_desc_t
ble_gattc_evt_attr_info_disc_rsp_t
ble_gattc_evt_char_disc_rsp_t
ble_gattc_evt_char_val_by_uuid_read_rsp_t
ble_gattc_evt_char_vals_read_rsp_t
ble_gattc_evt_desc_disc_rsp_t
ble_gattc_evt_exchange_mtu_rsp_t
ble_gattc_evt_hvx_t
ble_gattc_evt_prim_srvc_disc_rsp_t
ble_gattc_evt_read_rsp_t
ble_gattc_evt_rel_disc_rsp_t
ble_gattc_evt_t
ble_gattc_evt_timeout_t
ble_gattc_evt_write_cmd_tx_complete_t
ble_gattc_evt_write_rsp_t
ble_gattc_handle_range_t
ble_gattc_handle_value_t
ble_gattc_include_t
ble_gattc_service_t
ble_gattc_write_params_t
ble_gatts_attr_md_t
ble_gatts_attr_t
ble_gatts_authorize_params_t
ble_gatts_cfg_attr_tab_size_t
ble_gatts_cfg_service_changed_t
ble_gatts_cfg_t
ble_gatts_char_handles_t
ble_gatts_char_md_t
ble_gatts_char_pf_t
ble_gatts_conn_cfg_t
ble_gatts_evt_exchange_mtu_request_t
ble_gatts_evt_hvc_t
ble_gatts_evt_hvn_tx_complete_t
ble_gatts_evt_read_t
ble_gatts_evt_rw_authorize_request_t
ble_gatts_evt_sys_attr_missing_t
ble_gatts_evt_t
ble_gatts_evt_timeout_t
ble_gatts_evt_write_t
ble_gatts_hvx_params_t
ble_gatts_rw_authorize_reply_params_t
ble_gatts_value_t
ble_l2cap_ch_rx_params_t
ble_l2cap_ch_setup_params_t
ble_l2cap_ch_tx_params_t
ble_l2cap_conn_cfg_t
ble_l2cap_evt_ch_credit_t
ble_l2cap_evt_ch_rx_t
ble_l2cap_evt_ch_sdu_buf_released_t
ble_l2cap_evt_ch_setup_refused_t
ble_l2cap_evt_ch_setup_request_t
ble_l2cap_evt_ch_setup_t
ble_l2cap_evt_ch_tx_t
ble_l2cap_evt_t
ble_opt_t
ble_pa_lna_cfg_t
ble_user_mem_block_t
ble_uuid128_t
ble_uuid_t
ble_version_t
nrf_clock_lf_cfg_t
nrf_ecb_hal_data_block_t
nrf_ecb_hal_data_t
nrf_nvic_state_t
nrf_radio_request_earliest_t
nrf_radio_request_normal_t
nrf_radio_request_t
nrf_radio_signal_callback_return_param_t
sd_mbr_command_compare_t
sd_mbr_command_copy_bl_t
sd_mbr_command_copy_sd_t
sd_mbr_command_irq_forward_address_set_t
sd_mbr_command_t
sd_mbr_command_vector_table_base_set_t
Data Fields
All
_
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
u
v
w
Variables
_
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
u
v
w
L2CAP SDU
A data unit that the application can send/receive to/from a peer.
L2CAP PDU
A data unit that is exchanged between local and remote L2CAP entities. It consists of L2CAP protocol control information and payload fields. The payload field can contain an L2CAP SDU or a part of an L2CAP SDU.
L2CAP MTU
The maximum length of an L2CAP SDU.
L2CAP MPS
The maximum length of an L2CAP PDU payload field.
Credits
A value indicating the number of L2CAP PDUs that the receiver of the credit can send to the peer.