handover.h File Reference

Go to the source code of this file.

Data Structures
struct	handoverCNCBs_t
	Host Handover CN callbacks. More...
struct	handoverCNParams_t
	Host Handover Candidate Node Configuration parameters. More...
struct	handoverSNCBs_t
	Host Handover SN callbacks. More...
struct	handoverSNParams_t
	Host Handover Serving Node Configuration parameters. More...

Macros
#define	HANDOVER_CONN_ESTABLISH_WITH_HANDOVER   LL_STATUS_ESTABLISH_WITH_HANDOVER
#define	HANDOVER_CONNHANDLE_INVALID   LL_CONNHANDLE_INVALID
#define	HANDOVER_DEFAULT_MAX_FAILED_CONN_EVENTS   6
#define	HANDOVER_HOST_DATA_SIZE   0
#define	HANDOVER_INVALID_DATA_SIZE   0xFFFFFFFF
#define	HANDOVER_SN_MODE_DISCONNECT_IMMED   0
#define	HANDOVER_SN_MODE_WAIT_CN_STATUS   1
#define	HANDOVER_TX_BURST_RATIO_DEFAULT_VAL   30

Typedefs
typedef void(*	pfnHandoverStartCNCB_t) (uint16_t connHandle, uint32_t status)
typedef void(*	pfnHandoverStartSNCB_t) (uint16_t connHandle, uint32_t status)

Functions
void	Handover_ApplyCnData (uint16_t connHandle)
uint8_t	Handover_CloseSN (handoverSNParams_t *pParams, uint16_t handoverStatus)
uint32_t	Handover_GetSNDataSize (handoverSNParams_t *pParams)
uint8_t	Handover_InitCNParams (handoverCNParams_t *pParams)
uint8_t	Handover_InitSNParams (handoverSNParams_t *pParams)
uint8_t	Handover_RegisterCNCBs (const handoverCNCBs_t *pCBs)
uint8_t	Handover_RegisterSNCBs (const handoverSNCBs_t *pCBs)
uint8_t	Handover_StartCN (handoverCNParams_t *pParams)
uint8_t	Handover_StartSN (handoverSNParams_t *pParams)

Macro Definition Documentation

HANDOVER_CONN_ESTABLISH_WITH_HANDOVER

#define HANDOVER_CONN_ESTABLISH_WITH_HANDOVER   LL_STATUS_ESTABLISH_WITH_HANDOVER

HANDOVER_CONNHANDLE_INVALID

#define HANDOVER_CONNHANDLE_INVALID   LL_CONNHANDLE_INVALID

HANDOVER_DEFAULT_MAX_FAILED_CONN_EVENTS

#define HANDOVER_DEFAULT_MAX_FAILED_CONN_EVENTS   6

HANDOVER_HOST_DATA_SIZE

#define HANDOVER_HOST_DATA_SIZE   0

HANDOVER_INVALID_DATA_SIZE

#define HANDOVER_INVALID_DATA_SIZE   0xFFFFFFFF

HANDOVER_SN_MODE_DISCONNECT_IMMED

#define HANDOVER_SN_MODE_DISCONNECT_IMMED   0

HANDOVER_SN_MODE_WAIT_CN_STATUS

#define HANDOVER_SN_MODE_WAIT_CN_STATUS   1

HANDOVER_TX_BURST_RATIO_DEFAULT_VAL

#define HANDOVER_TX_BURST_RATIO_DEFAULT_VAL   30

Typedef Documentation

pfnHandoverStartCNCB_t

typedef void(* pfnHandoverStartCNCB_t) (uint16_t connHandle, uint32_t status)

pfnHandoverStartSNCB_t

typedef void(* pfnHandoverStartSNCB_t) (uint16_t connHandle, uint32_t status)

Function Documentation

Handover_ApplyCnData()

void Handover_ApplyCnData

(

uint16_t

connHandle

)

Handover_CloseSN()

uint8_t Handover_CloseSN	(	handoverSNParams_t *	pParams,
		uint16_t	handoverStatus
	)

Handover_CloseSN

Close the Handover process on the serving node side. If the handover was successful this will cause the serving node to teminate the conenction. Otherwise, it will continue the connection with the peer device.

Parameters

pParams	- Pointer to the serving node parameters
handoverStatus	- TRUE if the candidate was able to follow the handover connection. Otherwise, FALSE

Returns

SUCCESS

bleIncorrectMode

INVALIDPARAMETER

Handover_GetSNDataSize()

uint32_t Handover_GetSNDataSize

(

handoverSNParams_t *

pParams

)

Handover_GetSNDataSize

Request the controller data size and returns the sum of the controller and host data size

Parameters

pParams	- pointer to serving node parameters
connHandle	- the connection handle of the requested handover link

Returns

SUCCESS

FAILURE

Handover_InitCNParams()

uint8_t Handover_InitCNParams

(

handoverCNParams_t *

pParams

)

Handover_InitCNParams

Initialize the given parameter structure with default values

Parameters

pParams

- Pointer to the parameters structure

Returns

SUCCESS

FAILURE

Handover_InitSNParams()

uint8_t Handover_InitSNParams

(

handoverSNParams_t *

pParams

)

Handover_InitSNParams

Initialize the given parameter structure with default values

Parameters

pParams

- Pointer to the parameters structure

Returns

SUCCESS

FAILURE

Handover_RegisterCNCBs()

uint8_t Handover_RegisterCNCBs

(

const handoverCNCBs_t *

pCBs

)

Handover_RegisterCNCBs

Register the application callback function at the host

Parameters

pCBs	- pointer to the callback functions

Returns

SUCCESS

FAILURE

Handover_RegisterSNCBs()

uint8_t Handover_RegisterSNCBs

(

const handoverSNCBs_t *

pCBs

)

Handover_RegisterSNCBs

Register the application callback function at the host

Parameters

pCBs	- pointer to the callback functions

Returns

SUCCESS

FAILURE

Handover_StartCN()

uint8_t Handover_StartCN

(

handoverCNParams_t *

pParams

)

Handover_StartCN

Starts the Handover process on the serving node side. This function will save the application data size and will call the LL command for further handling

: BLE_LOKI-1495

Parameters

pParams

- Pointer to the candidate node parameters

Returns

SUCCESS

bleNoResources

bleAlreadyInRequestedMode

bleInvalidRange

LL_STATUS_SUCCESS

LL_STATUS_ERROR_CONNECTION_LIMIT_EXCEEDED

LL_STATUS_ERROR_COMMAND_DISALLOWED

LL_STATUS_ERROR_BAD_PARAMETER

Handover_StartSN()

uint8_t Handover_StartSN

(

handoverSNParams_t *

pParams

)

Handover_StartSN

Starts the Handover process on the serving node side. This function will save the application data size and will call the LL command for further handling

Parameters

pParams

- Pointer to the serving node parameters

Returns

SUCCESS

bleIncorrectMode

bleNotConnected

bleAlreadyInRequestedMode

INVALIDPARAMETER

LL_STATUS_SUCCESS

LL_STATUS_ERROR_INACTIVE_CONNECTION

LL_STATUS_ERROR_COMMAND_DISALLOWED

LL_STATUS_ERROR_BAD_PARAMETER

LL_STATUS_ERROR_DUE_TO_LIMITED_RESOURCES

NOTE: The caller is responsible to free the pBuf upon failure.