ANT support in SoftDevice Handler

nRF5 SDK v15.0.0
Modules | Data Structures | Macros | Typedefs | Functions

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

Modules

SoftDevice ANT event handler configuration

Data Structures

struct ant_evt_t
ANT stack event. More...
struct nrf_sdh_ant_evt_observer_t
ANT event observer. More...

Macros

#define NRF_SDH_ANT_EVT_CHANNEL_FIELD_SIZE 1
Size of the channel field in ANT stack event.
#define NRF_SDH_ANT_EVT_EVENT_FIELD_SIZE 1
Size of the event field in ANT stack event.
#define NRF_SDH_ANT_BUF_SIZE
Size of the buffer provided to the ANT SoftDevice.
#define NRF_SDH_ANT_MESSAGE_SIZE (( CEIL_DIV ( MESG_BUFFER_SIZE , sizeof(uint32_t))) * sizeof(uint32_t))
Size of the buffer provided to the ANT SoftDevice to receive ANT events.
#define NRF_SDH_ANT_EVT_BUF_SIZE
Size of the buffer provided to the Events Scheduler to hold ANT events. More...
#define NRF_SDH_ANT_OBSERVER (_name, _prio, _handler, _context)
Macro for registering an ANT observer. Modules that want to be notified about ANT events must register the handler using this macro. More...
#define NRF_SDH_ANT_OBSERVERS (_name, _prio, _handler, _context, _cnt)
Macro for registering an array of nrf_sdh_ant_evt_observer_t . Modules that want to be notified about ANT events must register the handler using this macro. More...

Typedefs

typedef void(* nrf_sdh_ant_evt_handler_t )( ant_evt_t *p_ant_evt, void *p_context)
ANT stack event handler.

Functions

ret_code_t nrf_sdh_ant_enable (void)
Function for configuring and enabling the ANT stack. More...

Detailed Description

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

Macro Definition Documentation

#define NRF_SDH_ANT_EVT_BUF_SIZE
Value:
(( CEIL_DIV ( NRF_SDH_ANT_MESSAGE_SIZE + \
NRF_SDH_ANT_EVT_CHANNEL_FIELD_SIZE + \
NRF_SDH_ANT_EVT_EVENT_FIELD_SIZE , \
sizeof (uint32_t))) * sizeof (uint32_t))

Size of the buffer provided to the Events Scheduler to hold ANT events.

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

Macro for registering an ANT observer. Modules that want to be notified about ANT events must register the handler using this macro.

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

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

Macro for registering an array of nrf_sdh_ant_evt_observer_t . Modules that want to be notified about ANT 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_ant_observers".

Parameters
[in] _name Observer name.
[in] _prio Priority of the observer event handler. The smaller the number, the higher the priority.
[in] _handler ANT 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_ant_enable ( void )

Function for configuring and enabling the ANT stack.

The function sets the channel configuration for the stack using the parameters provided in the sdk_config file. It also assigns a correspondingly large buffer as a static resource.