gap_advertiser.h

Go to the documentation of this file.

/******************************************************************************

 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: TI_TEXT 2009 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/

#ifndef GAP_ADVERTISER_H
#define GAP_ADVERTISER_H

#ifdef __cplusplus
extern "C"
{
#endif

/*-------------------------------------------------------------------
 * INCLUDES
 */
#include "bcomdef.h"
#include "osal.h"
#include "gap.h"

/*-------------------------------------------------------------------
 * MACROS
 */

// This is a common file for the legacy and sysconfig examples,
// the parameters under ifndef SYSCFG are defined in this file for
// the legacy examples and generated using the sysconfig tool for
// the sysconfig examples
#ifndef SYSCFG

#define GAPADV_PARAMS_LEGACY_SCANN_CONN {                                  \
  .eventProps = GAP_ADV_PROP_CONNECTABLE | GAP_ADV_PROP_SCANNABLE |        \
                GAP_ADV_PROP_LEGACY,                                       \
  .primIntMin = 160,                                                       \
  .primIntMax = 160,                                                       \
  .primChanMap = GAP_ADV_CHAN_ALL,                                         \
  .peerAddrType = PEER_ADDRTYPE_PUBLIC_OR_PUBLIC_ID,                       \
  .peerAddr = { 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa },                      \
  .filterPolicy = GAP_ADV_AL_POLICY_ANY_REQ,                               \
  .txPower = GAP_ADV_TX_POWER_NO_PREFERENCE,                               \
  .primPhy = GAP_ADV_PRIM_PHY_1_MBPS,                                      \
  .secPhy = GAP_ADV_SEC_PHY_1_MBPS,                                        \
  .sid = 0                                                                 \
  .zeroDelay = 0                                                           \
}

#ifdef USE_AE
#define GAPADV_PARAMS_AE_LONG_RANGE_CONN {                                 \
  .eventProps = GAP_ADV_PROP_CONNECTABLE,                                  \
  .primIntMin = 160,                                                       \
  .primIntMax = 160,                                                       \
  .primChanMap = GAP_ADV_CHAN_ALL,                                         \
  .peerAddrType = PEER_ADDRTYPE_PUBLIC_OR_PUBLIC_ID,                       \
  .peerAddr = { 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa },                      \
  .filterPolicy = GAP_ADV_AL_POLICY_ANY_REQ,                               \
  .txPower = GAP_ADV_TX_POWER_NO_PREFERENCE,                               \
  .primPhy = GAP_ADV_PRIM_PHY_CODED_S2,                                    \
  .secPhy = GAP_ADV_SEC_PHY_CODED_S2,                                      \
  .sid = 0                                                                 \
  .zeroDelay = 0                                                           \
}

#define GAPADV_PARAMS_AE_NC_NS {                                           \
  .eventProps = 0,                                                         \
  .primIntMin = 160,                                                       \
  .primIntMax = 160,                                                       \
  .primChanMap = GAP_ADV_CHAN_ALL,                                         \
  .peerAddrType = PEER_ADDRTYPE_PUBLIC_OR_PUBLIC_ID,                       \
  .peerAddr = { 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa },                      \
  .filterPolicy = GAP_ADV_AL_POLICY_ANY_REQ,                               \
  .txPower = GAP_ADV_TX_POWER_NO_PREFERENCE,                               \
  .primPhy = GAP_ADV_PRIM_PHY_1_MBPS,                                      \
  .secPhy = GAP_ADV_SEC_PHY_1_MBPS,                                        \
  .sid = 1                                                                 \
  .zeroDelay = 0                                                           \
}
#endif

#endif

/*-------------------------------------------------------------------
 * CONSTANTS
 */

typedef enum
{
  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,

  GAP_ADV_PARAM_OWN_ADDRESS_TYPE,

  GAP_ADV_PARAM_ZERODELAY,

  GAP_ADV_PARAM_COUNT
} GapAdv_ParamId_t;
#define GAP_ADV_INVALID_HANDLE        0xFF

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)   
};

typedef enum
{
  GAP_ADV_DATA_TYPE_ADV,        
  GAP_ADV_DATA_TYPE_SCAN_RSP    
} GapAdv_dataTypes_t;

typedef enum
{
  GAP_ADV_FREE_OPTION_DONT_FREE,       
  GAP_ADV_FREE_OPTION_ADV_DATA,        
  GAP_ADV_FREE_OPTION_SCAN_RESP_DATA,  
} GapAdv_freeBufferOptions_t;

typedef enum
{
  GAP_ADV_ENABLE_OPTIONS_USE_MAX,
  GAP_ADV_ENABLE_OPTIONS_USE_DURATION,
  GAP_ADV_ENABLE_OPTIONS_USE_MAX_EVENTS,
} GapAdv_enableOptions_t;

typedef enum
{
  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 |
                           GAP_ADV_CHAN_38),  
  GAP_ADV_CHAN_37_39    = (GAP_ADV_CHAN_37 |
                           GAP_ADV_CHAN_39),  
  GAP_ADV_CHAN_38_39    = (GAP_ADV_CHAN_38 |
                           GAP_ADV_CHAN_39),  
  GAP_ADV_CHAN_ALL      = (GAP_ADV_CHAN_37 |
                           GAP_ADV_CHAN_38 |
                           GAP_ADV_CHAN_39)  
} GapAdv_advChannels_t;

typedef enum
{
  GAP_ADV_AL_POLICY_ANY_REQ,
  GAP_ADV_AL_POLICY_AL_SCAN_REQ,
  GAP_ADV_AL_POLICY_AL_CONNECT_IND,
  GAP_ADV_AL_POLICY_AL_ALL_REQ
} GapAdv_filterPolicy_t;

#define GAP_ADV_TX_POWER_NO_PREFERENCE      127

typedef enum
{
  GAP_ADV_PRIM_PHY_1_MBPS     = 0x01,  
  GAP_ADV_PRIM_PHY_CODED_S8   = 0x03,  
  GAP_ADV_PRIM_PHY_CODED_S2   = 0x83   
} GapAdv_primaryPHY_t;

typedef enum
{
  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   
} GapAdv_secondaryPHY_t;

typedef enum
{
  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                 = GAP_ADV_EVT_MASK_SCAN_REQ_NOTI |
                                         GAP_ADV_EVT_MASK_START_AFTER_ENABLE |
                                         GAP_ADV_EVT_MASK_START |
                                         GAP_ADV_EVT_MASK_END |
                                         GAP_ADV_EVT_MASK_END_AFTER_DISABLE |
                                         GAP_ADV_EVT_MASK_SET_TERMINATED,

  GAP_ADV_EVT_MASK_RESERVED            = BV(15)
} GapAdv_eventMaskFlags_t;


#define GAPADV_PERIODIC_ADV_INTERVAL_MIN                 0x0006
#define GAPADV_PERIODIC_ADV_INTERVAL_MAX                 0xFFFF
#define GAPADV_PERIODIC_ADV_ENABLE_TX_POWER              0x0040
#define GAPADV_PERIODIC_ADV_DISABLE_TX_POWER             0x0000
#define GAPADV_PERIODIC_ADV_DATA_INTERMIDIATE_FRAG       0x00
#define GAPADV_PERIODIC_ADV_DATA_FIRST_FRAG              0x01
#define GAPADV_PERIODIC_ADV_DATA_LAST_FRAG               0x02
#define GAPADV_PERIODIC_ADV_DATA_COMPLETE                0x03
#define GAPADV_PERIODIC_ADV_MAX_DATA_LEN                 252


/*-------------------------------------------------------------------
 * Structures
 */

typedef struct
{
  uint16_t eventProps;                   
  uint32_t primIntMin;                   
  uint32_t primIntMax;                   
  GapAdv_advChannels_t primChanMap;      
  GAP_Peer_Addr_Types_t peerAddrType;    
  uint8_t peerAddr[B_ADDR_LEN];          
  GapAdv_filterPolicy_t filterPolicy;    
  int8_t txPower;                        
  GapAdv_primaryPHY_t primPhy;           
  GapAdv_secondaryPHY_t secPhy;          
  uint8_t sid;                           
  uint8_t zeroDelay;                     
} GapAdv_params_t;


typedef struct
{
  uint8  handle;         
  uint8  status;         
  uint16 connHandle;     
  uint8  numCompAdvEvts; 
} GapAdv_setTerm_t;

typedef struct
{
  uint8  handle;                 
  uint8  scanAddrType;           
  uint8  scanAddr[B_ADDR_LEN];   
  uint8  channel;                
  int8   rssi;                   
} GapAdv_scanReqReceived_t;

typedef struct
{
  uint8  handle;           
  uint8  availAdvDataLen;  

  uint16 advDataLen;
} GapAdv_truncData_t;


typedef struct
{
  uint16 periodicAdvIntervalMin;   
  uint16 periodicAdvIntervalMax;   
  uint16 periodicAdvProp;          
} GapAdv_periodicAdvParams_t;

typedef struct
{
  uint8 operation;
  uint8 dataLength;   
  uint8 *pData;       
} GapAdv_periodicAdvData_t;

typedef struct
{
  osal_event_hdr_t hdr;   
  uint8_t opcode;         
  uint8_t status;         
} GapAdv_periodicAdvEvt_t;

typedef struct
{
  osal_event_hdr_t hdr;
  uint8_t opcode;
  uint8_t dataType;
} GapAdv_dataUpdateEvent_t;

typedef struct
{
  osal_event_hdr_t hdr;
  uint8_t opcode;
} GapAv_setAdvStatusDoneEvent_t;

/*-------------------------------------------------------------------
 * FUNCTIONS - Advertising
 */

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

extern bStatus_t GapAdv_destroy(uint8 handle,
                                GapAdv_freeBufferOptions_t freeOptions);

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

extern bStatus_t GapAdv_disable(uint8 handle);

extern bStatus_t GapAdv_setEventMask(uint8 handle, GapAdv_eventMaskFlags_t mask);

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

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

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

bStatus_t GapAdv_prepareLoadByHandle(uint8 handle,
                                     GapAdv_freeBufferOptions_t freeOptions);

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

extern bStatus_t GapAdv_prepareLoadByBuffer(uint8 *pBuf, bool freeOldData);

extern bStatus_t GapAdv_loadByBuffer(uint16 len, uint8 *pBuf);

extern bStatus_t GapAdv_abortLoad(void);

extern bStatus_t GapAdv_setVirtualAdvAddr(uint8 advHandle, uint8 *bdAddr);


 uint8_t GapAdv_SetPeriodicAdvParams( uint8 advHandle,
                                      GapAdv_periodicAdvParams_t *periodicAdvParams );

 bStatus_t GapAdv_SetPeriodicAdvData( uint8 advHandle,
                                      GapAdv_periodicAdvData_t *periodicAdvData );

 bStatus_t GapAdv_SetPeriodicAdvEnable( uint8 enable,
                                        uint8 advHandle );

/*-------------------------------------------------------------------
-------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif

#endif /* GAP_ADVERTISER_H */