Detailed Description

GAP Advertiser layer interface.

Data Structures
struct	GapAdv_params_t

struct	GapAdv_periodicAdvData_t
	Periodic advertising data structure. More...

struct	GapAdv_periodicAdvParams_t
	Periodic advertising parameters structure. More...

struct	GapAdv_scanReqReceived_t
	Data type returned with GAP_EVT_SCAN_REQ_RECEIVED event. More...

struct	GapAdv_setTerm_t
	Data type returned with GAP_EVT_ADV_SET_TERMINATED event. More...

struct	GapAdv_truncData_t
	Data type returned with GAP_EVT_ADV_DATA_TRUNCATED event. More...

Macros
#define	GAP_ADV_INVALID_HANDLE 0xFF
	Invalid Advertising Handle for GAP Advertising API's.

#define	GAP_ADV_TX_POWER_NO_PREFERENCE 127
	Allow the controller to choose the Tx power.

#define	GAPADV_PARAMS_AE_LONG_RANGE_CONN
	Default parameters for long range, connectable, advertising extension. More...

#define	GAPADV_PARAMS_AE_NC_NS
	Non-Connectable & Non-Scannable advertising set. More...

#define	GAPADV_PARAMS_LEGACY_SCANN_CONN
	Default parameters for legacy, scannable, connectable advertising. More...

#define	GAPADV_PERIODIC_ADV_DATA_COMPLETE 0x03
	Periodic Advertising operation options - Complete data.

#define	GAPADV_PERIODIC_ADV_DATA_FIRST_FRAG 0x01
	Periodic Advertising operation options - First fragment.

#define	GAPADV_PERIODIC_ADV_DATA_INTERMIDIATE_FRAG 0x00
	Periodic Advertising operation options - Intermidiate fragment.

#define	GAPADV_PERIODIC_ADV_DATA_LAST_FRAG 0x02
	Periodic Advertising operation options - Last fragment.

#define	GAPADV_PERIODIC_ADV_DISABLE_TX_POWER 0x0000
	Periodic Advertising - Disable TX power property.

#define	GAPADV_PERIODIC_ADV_ENABLE_TX_POWER 0x0040
	Periodic Advertising - Enable TX power property.

#define	GAPADV_PERIODIC_ADV_INTERVAL_MAX 0xFFFF
	Periodic Advertising - Maximum interval.

#define	GAPADV_PERIODIC_ADV_INTERVAL_MIN 0x0006
	Periodic Advertising - Minimum interval.

#define	GAPADV_PERIODIC_ADV_MAX_DATA_LEN 252
	Periodic Advertising - Maximum fragment/complete data length.

Enumerations
enum	GapAdv_advChannels_t { GAP_ADV_CHAN_37 = BV(0), GAP_ADV_CHAN_38 = BV(1), GAP_ADV_CHAN_39 = BV(2), GAP_ADV_CHAN_37_38, GAP_ADV_CHAN_37_39, GAP_ADV_CHAN_38_39, GAP_ADV_CHAN_ALL }
	GAP Advertiser Defines for Advertiser Channels. More...

enum	GapAdv_dataTypes_t { GAP_ADV_DATA_TYPE_ADV, GAP_ADV_DATA_TYPE_SCAN_RSP }
	Gap Advertising Data Types. More...

enum	GapAdv_enableOptions_t { GAP_ADV_ENABLE_OPTIONS_USE_MAX, GAP_ADV_ENABLE_OPTIONS_USE_DURATION, GAP_ADV_ENABLE_OPTIONS_USE_MAX_EVENTS }
	Enable options for GapAdv_enable. More...

enum	GapAdv_eventMaskFlags_t { GAP_ADV_EVT_MASK_SCAN_REQ_NOTI = AE_NOTIFY_ENABLE_SCAN_REQUEST, GAP_ADV_EVT_MASK_SET_TERMINATED = BV(1), GAP_ADV_EVT_MASK_START_AFTER_ENABLE = AE_NOTIFY_ENABLE_ADV_SET_START, GAP_ADV_EVT_MASK_START = AE_NOTIFY_ENABLE_ADV_START, GAP_ADV_EVT_MASK_END = AE_NOTIFY_ENABLE_ADV_END, GAP_ADV_EVT_MASK_END_AFTER_DISABLE = AE_NOTIFY_ENABLE_ADV_SET_END, GAP_ADV_EVT_MASK_ALL }

enum	GapAdv_eventProps_t { GAP_ADV_PROP_CONNECTABLE = BV(0), GAP_ADV_PROP_SCANNABLE = BV(1), GAP_ADV_PROP_DIRECTED = BV(2), GAP_ADV_PROP_HDC = BV(3), GAP_ADV_PROP_LEGACY = BV(4), GAP_ADV_PROP_ANONYMOUS = BV(5), GAP_ADV_PROP_TX_POWER = BV(6) }
	GAP Advertising Event Param Properties. More...

enum	GapAdv_filterPolicy_t { GAP_ADV_WL_POLICY_ANY_REQ, GAP_ADV_WL_POLICY_WL_SCAN_REQ, GAP_ADV_WL_POLICY_WL_CONNECT_IND, GAP_ADV_WL_POLICY_WL_ALL_REQ }
	GAP Advertiser White List Policy. More...

enum	GapAdv_freeBufferOptions_t { GAP_ADV_FREE_OPTION_DONT_FREE, GAP_ADV_FREE_OPTION_ADV_DATA, GAP_ADV_FREE_OPTION_SCAN_RESP_DATA }
	Possible free options for Gap Advertiser API's. More...

enum	GapAdv_ParamId_t { GAP_ADV_PARAM_PROPS, GAP_ADV_PARAM_PRIMARY_INTERVAL_MIN, GAP_ADV_PARAM_PRIMARY_INTERVAL_MAX, GAP_ADV_PARAM_PRIMARY_CHANNEL_MAP, GAP_ADV_PARAM_PEER_ADDRESS_TYPE, GAP_ADV_PARAM_PEER_ADDRESS, GAP_ADV_PARAM_FILTER_POLICY, GAP_ADV_PARAM_TX_POWER, GAP_ADV_PARAM_PRIMARY_PHY, GAP_ADV_PARAM_SECONDARY_PHY, GAP_ADV_PARAM_SID }

enum	GapAdv_primaryPHY_t { GAP_ADV_PRIM_PHY_1_MBPS = 0x01, GAP_ADV_PRIM_PHY_CODED_S8 = 0x03, GAP_ADV_PRIM_PHY_CODED_S2 = 0x83 }
	Gap Advertiser Options for advertising on the primary PHY. More...

enum	GapAdv_secondaryPHY_t { GAP_ADV_SEC_PHY_1_MBPS = 0x01, GAP_ADV_SEC_PHY_2_MBPS = 0x02, GAP_ADV_SEC_PHY_CODED_S8 = 0x03, GAP_ADV_SEC_PHY_CODED_S2 = 0x83 }
	Gap Advertiser Options for advertising on the secondary PHY. More...

Functions
bStatus_t	GapAdv_abortLoad (void)

bStatus_t	GapAdv_create (pfnGapCB_t cb, GapAdv_params_t advParam, uint8 *advHandle)

bStatus_t	GapAdv_destroy (uint8 handle, GapAdv_freeBufferOptions_t freeOptions)

bStatus_t	GapAdv_disable (uint8 handle)
	Disable an active advertising set. More...

bStatus_t	GapAdv_enable (uint8 handle, GapAdv_enableOptions_t enableOptions, uint16 durationOrMaxEvents)

bStatus_t	GapAdv_getBuffer (uint8 handle, GapAdv_dataTypes_t dataType, uint16 pLen, uint8 *ppBuf)

bStatus_t	GapAdv_getParam (uint8 handle, GapAdv_ParamId_t paramID, void pValue, uint8_t pLen)

bStatus_t	GapAdv_loadByBuffer (uint16 len, uint8 *pBuf)

bStatus_t	GapAdv_loadByBuffer_hook (uint16 len, uint8 *pBuf)

bStatus_t	GapAdv_loadByHandle (uint8 handle, GapAdv_dataTypes_t dataType, uint16 len, uint8 *pBuf)

bStatus_t	GapAdv_prepareLoadByBuffer (uint8 *pBuf, bool freeOldData)

bStatus_t	GapAdv_prepareLoadByHandle (uint8 handle, GapAdv_freeBufferOptions_t freeOptions)

bStatus_t	GapAdv_setEventMask (uint8 handle, GapAdv_eventMaskFlags_t mask)

bStatus_t	GapAdv_setParam (uint8 handle, GapAdv_ParamId_t paramID, void *pValue)

bStatus_t	GapAdv_SetPeriodicAdvData (uint8 advHandle, GapAdv_periodicAdvData_t *periodicAdvData)

bStatus_t	GapAdv_SetPeriodicAdvEnable (uint8 enable, uint8 advHandle)

uint8_t	GapAdv_SetPeriodicAdvParams (uint8 advHandle, GapAdv_periodicAdvParams_t *periodicAdvParams)

bStatus_t	GapAdv_setVirtualAdvAddr (uint8 advHandle, uint8 *bdAddr)

Detailed Description

Data Structures

Macros

Enumerations

Functions