BLE support in SoftDevice Handler

nRF5 SDK v14.2.0
Modules | Data Structures | Macros | Typedefs | Functions

This file contains the declarations of types and functions required for BLE stack support. More...

Modules

SoftDevice BLE event handler configuration

Data Structures

struct nrf_sdh_ble_evt_observer_t
BLE event observer. More...

Macros

#define NRF_SDH_BLE_EVT_BUF_SIZE BLE_EVT_LEN_MAX ( NRF_SDH_BLE_GATT_MAX_MTU_SIZE )
Size of the buffer for a BLE event.
#define NRF_SDH_BLE_OBSERVER (_name, _prio, _handler, _context)
Macro for registering nrf_sdh_soc_evt_observer_t . Modules that want to be notified about SoC events must register the handler using this macro. More...
#define NRF_SDH_BLE_OBSERVERS (_name, _prio, _handler, _context, _cnt)
Macro for registering an array of nrf_sdh_ble_evt_observer_t . Modules that want to be notified about SoC events must register the handler using this macro. More...

Typedefs

typedef void(* nrf_sdh_ble_evt_handler_t )( ble_evt_t const *p_ble_evt, void *p_context)
BLE stack event handler.

Functions

ret_code_t nrf_sdh_ble_app_ram_start_get (uint32_t *p_app_ram_start)
Function for retrieving the address of the start of application's RAM. More...
ret_code_t nrf_sdh_ble_default_cfg_set (uint8_t conn_cfg_tag, uint32_t *p_ram_start)
Set the default BLE stack configuration. More...
ret_code_t nrf_sdh_ble_enable (uint32_t *p_app_ram_start)
Function for configuring and enabling the BLE stack. More...

Detailed Description

This file contains the declarations of types and functions required for BLE stack support.

Macro Definition Documentation

#define NRF_SDH_BLE_OBSERVER ( _name,
_prio,
_handler,
_context
)

Macro for registering nrf_sdh_soc_evt_observer_t . Modules that want to be notified about SoC events must register the handler using this macro.

This macro places the observer in a section named "sdh_soc_observers".

Parameters
[in] _name Observer name.
[in] _prio Priority of the observer event handler. The smaller the number, the higher the priority.
[in] _handler BLE event handler.
[in] _context Parameter to the event handler.
#define NRF_SDH_BLE_OBSERVERS ( _name,
_prio,
_handler,
_context,
_cnt
)

Macro for registering an array of nrf_sdh_ble_evt_observer_t . Modules that want to be notified about SoC events must register the handler using this macro.

Each observer's handler will be dispatched an event with its relative context from _context . This macro places the observer in a section named "sdh_ble_observers".

Parameters
[in] _name Observer name.
[in] _prio Priority of the observer event handler. The smaller the number, the higher the priority.
[in] _handler BLE event handler.
[in] _context An array of parameters to the event handler.
[in] _cnt Number of observers to register.

Function Documentation

ret_code_t nrf_sdh_ble_app_ram_start_get ( uint32_t * p_app_ram_start )

Function for retrieving the address of the start of application's RAM.

Parameters
[out] p_app_ram_start Address of the start of application's RAM.
Return values
NRF_SUCCESS If the address was successfully retrieved.
NRF_ERROR_NULL If p_app_ram_start was NULL .
ret_code_t nrf_sdh_ble_default_cfg_set ( uint8_t conn_cfg_tag ,
uint32_t * p_ram_start
)

Set the default BLE stack configuration.

This function configures the BLE stack with the settings specified in the SoftDevice handler BLE configuration. The following configurations will be set:

  • Number of peripheral links
  • Number of central links
  • ATT MTU size (for the given connection)
  • Vendor specific UUID count
  • GATTS Attribute table size
  • Service changed
Parameters
[in] conn_cfg_tag The connection to configure.
[out] p_ram_start Application RAM start address.
ret_code_t nrf_sdh_ble_enable ( uint32_t * p_app_ram_start )

Function for configuring and enabling the BLE stack.

Parameters
[in] p_app_ram_start Address of the start of application's RAM.