NCP Interface#

Component that provides the Bluetooth Network Co-Processor (NCP) communication interface. This is a No-Code component.

Enumerations#

enum
SL_NCP_ERROR_RUNTIME = 0
SL_NCP_ERROR_RECEIVE = 1
SL_NCP_ERROR_TIMER = 2
SL_NCP_ERROR_ENCRYPT = 3
SL_NCP_ERROR_BGAPI_LOCK = 4
SL_NCP_ERROR_EVT_ENQUE = 5
SL_NCP_ERROR_EVT_DEQUE = 6
}

NCP error type.

Functions#

void
void
sl_ncp_user_cmd_message_to_target_rsp(sl_status_t result, uint8_t len, uint8_t *data)
void
sl_ncp_user_evt_message_to_host(uint8_t len, uint8_t *data)
bool
sl_ncp_local_evt_process(sl_bt_msg_t *evt)
bool
void
sl_ncp_on_error(sl_ncp_error_t error, sl_status_t status)

Macros#

#define
SL_NCP_CMD_BUF_SIZE (260)
#define
SL_NCP_EVT_BUF_SIZE (260)
#define
SL_NCP_CMD_TIMEOUT_MS (500)
#define
SL_NCP_TASK_PRIO APP_RTA_PRIORITY_NORMAL
#define
SL_NCP_TASK_STACK 1024
#define
SL_NCP_WAIT_FOR_GUARD 10
#define
SL_NCP_EMIT_SYSTEM_ERROR_EVT 0

Enumeration Documentation#

sl_ncp_error_t#

sl_ncp_error_t

NCP error type.

Enumerator
SL_NCP_ERROR_RUNTIME
SL_NCP_ERROR_RECEIVE
SL_NCP_ERROR_TIMER
SL_NCP_ERROR_ENCRYPT
SL_NCP_ERROR_BGAPI_LOCK
SL_NCP_ERROR_EVT_ENQUE
SL_NCP_ERROR_EVT_DEQUE

Definition at line 55 of file common/ncp/sl_ncp.h

Function Documentation#

sl_ncp_init#

void sl_ncp_init (void )
Parameters
TypeDirectionArgument NameDescription
voidN/A

NCP initialization function.


Definition at line 68 of file common/ncp/sl_ncp.h

sl_ncp_rta_ready#

void sl_ncp_rta_ready (void )
Parameters
TypeDirectionArgument NameDescription
voidN/A

NCP runtime ready.


Definition at line 73 of file common/ncp/sl_ncp.h

sl_ncp_user_cmd_message_to_target_cb#

void sl_ncp_user_cmd_message_to_target_cb (void * data)
Parameters
TypeDirectionArgument NameDescription
void *[in]data

Data received from NCP through UART.

User command (message_to_target) handler callback.

Handle user defined commands received from NCP-host.


Definition at line 82 of file common/ncp/sl_ncp.h

sl_ncp_user_cs_cmd_message_to_target_cb#

void sl_ncp_user_cs_cmd_message_to_target_cb (const void * data)
Parameters
TypeDirectionArgument NameDescription
const void *[in]data

Data received from NCP through UART.

CS user command (message_to_target) handler callback.

Handle CS defined user commands received from NCP-host.


Definition at line 91 of file common/ncp/sl_ncp.h

sl_ncp_user_cmd_message_to_target_rsp#

void sl_ncp_user_cmd_message_to_target_rsp (sl_status_t result, uint8_t len, uint8_t * data)
Parameters
TypeDirectionArgument NameDescription
sl_status_t[out]result

Result of the response to the command received.

uint8_t[out]len

Message length.

uint8_t *[out]data

Data to send to NCP.

Send user command (message_to_target) response.

Send response to user defined (message_to_target) command to NCP-host.


Definition at line 102 of file common/ncp/sl_ncp.h

sl_ncp_user_evt_message_to_host#

void sl_ncp_user_evt_message_to_host (uint8_t len, uint8_t * data)
Parameters
TypeDirectionArgument NameDescription
uint8_t[out]len

Message length.

uint8_t *[out]data

Data to send to NCP.

Send user event (message_to_host).

Send user defined (message_to_host) event to NCP-host.


Definition at line 114 of file common/ncp/sl_ncp.h

sl_ncp_local_evt_process#

bool sl_ncp_local_evt_process (sl_bt_msg_t * evt)
Parameters
TypeDirectionArgument NameDescription
sl_bt_msg_t *[in]evt

Bluetooth event.

Local event processor for handling Bluetooth events in the application.

Note

  • This function can be implemented in the application.


Definition at line 125 of file common/ncp/sl_ncp.h

sl_ncp_local_common_evt_process#

bool sl_ncp_local_common_evt_process (sl_bt_msg_t * evt)
Parameters
TypeDirectionArgument NameDescription
sl_bt_msg_t *[in]evt

Bluetooth event.

Process Bluetooth events locally using template contribution.

Note


Definition at line 137 of file common/ncp/sl_ncp.h

sl_ncp_on_error#

void sl_ncp_on_error (sl_ncp_error_t error, sl_status_t status)
Parameters
TypeDirectionArgument NameDescription
sl_ncp_error_tN/Aerror

error type

sl_status_tN/Astatus

status code

NCP runtime error callback.

Note

  • The error callback is called when an error has occurred in the runtime context. The weak implementation asserts. It can be overridden in user code by adding a strong implementation.


Definition at line 177 of file common/ncp/sl_ncp.h