gap_scanner.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_SCANNER_H
#define GAP_SCANNER_H

#ifdef __cplusplus
extern "C"
{
#endif

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

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

/*******************************************************************************
 * Gap Scanner Internal API
 */

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

enum GapScan_AdvRptTypeNStatus_t {
  ADV_RPT_EVT_TYPE_CONNECTABLE = AE_EVT_TYPE_CONN_ADV,
  ADV_RPT_EVT_TYPE_SCANNABLE   = AE_EVT_TYPE_SCAN_ADV,
  ADV_RPT_EVT_TYPE_DIRECTED    = AE_EVT_TYPE_DIR_ADV,
  ADV_RPT_EVT_TYPE_SCAN_RSP    = AE_EVT_TYPE_SCAN_RSP,
  ADV_RPT_EVT_TYPE_LEGACY      = AE_EVT_TYPE_LEGACY,
  ADV_RPT_EVT_STATUS_COMPLETE  = AE_EVT_TYPE_COMPLETE,
  ADV_RPT_EVT_STATUS_MORE_DATA = AE_EVT_TYPE_INCOMPLETE_MORE_TO_COME,
  ADV_RPT_EVT_STATUS_TRUNCATED = AE_EVT_TYPE_INCOMPLETE_NO_MORE_TO_COME,
  ADV_RPT_EVT_STATUS_RFU       = AE_EVT_TYPE_RFU
};

enum GapScan_PrimPhy_t {
  SCAN_PRIM_PHY_1M    = LL_PHY_1_MBPS,  
  SCAN_PRIM_PHY_CODED = LL_PHY_CODED    
};

enum GapScan_FilterPduType_t {
  SCAN_FLT_PDU_NONCONNECTABLE_ONLY = ADV_RPT_EVT_TYPE_CONNECTABLE,
  SCAN_FLT_PDU_CONNECTABLE_ONLY    = ADV_RPT_EVT_TYPE_CONNECTABLE << 1,
  SCAN_FLT_PDU_NONSCANNABLE_ONLY   = ADV_RPT_EVT_TYPE_SCANNABLE << 1,
  SCAN_FLT_PDU_SCANNABLE_ONLY      = ADV_RPT_EVT_TYPE_SCANNABLE << 2,
  SCAN_FLT_PDU_UNDIRECTED_ONLY     = ADV_RPT_EVT_TYPE_DIRECTED << 2,
  SCAN_FLT_PDU_DIRECTED_ONLY       = ADV_RPT_EVT_TYPE_DIRECTED << 3,
  SCAN_FLT_PDU_ADV_ONLY            = ADV_RPT_EVT_TYPE_SCAN_RSP << 3,
  SCAN_FLT_PDU_SCANRSP_ONLY        = ADV_RPT_EVT_TYPE_SCAN_RSP << 4,
  SCAN_FLT_PDU_EXTENDED_ONLY       = ADV_RPT_EVT_TYPE_LEGACY << 4,
  SCAN_FLT_PDU_LEGACY_ONLY         = ADV_RPT_EVT_TYPE_LEGACY << 5,
  SCAN_FLT_PDU_TRUNCATED_ONLY      = BV(10),
  SCAN_FLT_PDU_COMPLETE_ONLY       = BV(11)
};

enum GapScan_AdvRptField_t {
  SCAN_ADVRPT_FLD_EVENTTYPE      = BV( 0), 
  SCAN_ADVRPT_FLD_ADDRTYPE       = BV( 1), 
  SCAN_ADVRPT_FLD_ADDRESS        = BV( 2), 
  SCAN_ADVRPT_FLD_PRIMPHY        = BV( 3), 
  SCAN_ADVRPT_FLD_SECPHY         = BV( 4), 
  SCAN_ADVRPT_FLD_ADVSID         = BV( 5), 
  SCAN_ADVRPT_FLD_TXPOWER        = BV( 6), 
  SCAN_ADVRPT_FLD_RSSI           = BV( 7), 
  SCAN_ADVRPT_FLD_DIRADDRTYPE    = BV( 8), 
  SCAN_ADVRPT_FLD_DIRADDRESS     = BV( 9), 
  SCAN_ADVRPT_FLD_PRDADVINTERVAL = BV(10), 
  SCAN_ADVRPT_FLD_DATALEN        = BV(11), 
};

enum GapScan_EndReason_t {
  SCAN_END_REASON_USR_REQ = 0, 
  SCAN_END_REASON_DUR_EXP      
};

#define SCAN_RSSI_MAX                      127  
#define SCAN_RSSI_MIN                      -128 

#define SCAN_FLT_RSSI_ALL         SCAN_RSSI_MIN 
#define SCAN_FLT_RSSI_NONE        SCAN_RSSI_MAX 

#define SCAN_PARAM_DFLT_INTERVAL           800
#define SCAN_PARAM_DFLT_WINDOW             800
#define SCAN_PARAM_DFLT_TYPE               SCAN_TYPE_PASSIVE
#define SCAN_PARAM_DFLT_RPT_FIELDS         (SCAN_ADVRPT_FLD_EVENTTYPE|\
                                            SCAN_ADVRPT_FLD_ADDRTYPE |\
                                            SCAN_ADVRPT_FLD_ADDRESS  |\
                                            SCAN_ADVRPT_FLD_ADVSID   |\
                                            SCAN_ADVRPT_FLD_RSSI)
#define SCAN_PARAM_DFLT_PHYS               SCAN_PRIM_PHY_1M
#define SCAN_PARAM_DFLT_FLT_POLICY         SCAN_FLT_POLICY_ALL
#define SCAN_PARAM_DFLT_FLT_PDU            SCAN_FLT_PDU_COMPLETE_ONLY
#define SCAN_PARAM_DFLT_FLT_RSSI           SCAN_FLT_RSSI_ALL
#define SCAN_PARAM_DFLT_FLT_DISC           SCAN_FLT_DISC_DISABLE
#define SCAN_PARAM_DFLT_FLT_DUP            SCAN_FLT_DUP_ENABLE
#define SCAN_PARAM_DFLT_NUM_ADV_RPT        0

#define SCAN_PERIODIC_SKIP_MAX                 0x01F3
#define SCAN_PERIODIC_TIMEOUT_MIN              0x000A
#define SCAN_PERIODIC_TIMEOUT_MAX              0x4000
#define SCAN_PERIODIC_CTE_TYPE_ALL             0
#define SCAN_PERIODIC_DO_NOT_SYNC_AOA_CTE      1
#define SCAN_PERIODIC_DO_NOT_SYNC_AOD_CTE_1US  2
#define SCAN_PERIODIC_DO_NOT_SYNC_AOD_CTE_2US  4
#define SCAN_PERIODIC_SYNC_ONLY_WITH_CTE       16
#define SCAN_PERIODIC_MAX_ADV_SID              0x0F
#define SCAN_PERIODIC_SYNC_OPTIONS_MAX         0x03
#define SCAN_PERIODIC_DO_NOT_USE_PERIODIC_ADV_LIST (0 << 0)
#define SCAN_PERIODIC_USE_PERIODIC_ADV_LIST        (1 << 0)
#define SCAN_PERIODIC_REPORTING_INITIALLY_ENABLED  (0 << 1)
#define SCAN_PERIODIC_REPORTING_INITIALLY_DISABLED (1 << 1)

typedef enum
{
  SCAN_PARAM_RPT_FIELDS,

  SCAN_PARAM_PRIM_PHYS,

  SCAN_PARAM_FLT_POLICY,

  SCAN_PARAM_FLT_PDU_TYPE,

  SCAN_PARAM_FLT_MIN_RSSI,

  SCAN_PARAM_FLT_DISC_MODE,

  SCAN_PARAM_FLT_DUP,

  SCAN_NUM_RW_PARAM,

  SCAN_PARAM_NUM_ADV_RPT = SCAN_NUM_RW_PARAM,

  SCAN_NUM_PARAM
} GapScan_ParamId_t;
/*-------------------------------------------------------------------
 * Structures
 */

typedef enum
{
  SCANNED_PHY_NONE  = 0,               
  SCANNED_PHY_1M    = AE_PHY_1_MBPS,   
  SCANNED_PHY_2M    = AE_PHY_2_MBPS,   
  SCANNED_PHY_CODED = AE_PHY_CODED     
} GapScan_ScannedPhy_t;

typedef enum {
  SCAN_TYPE_PASSIVE = LL_SCAN_PASSIVE, 
  SCAN_TYPE_ACTIVE  = LL_SCAN_ACTIVE   
} GapScan_ScanType_t;

typedef enum {
  SCAN_FLT_POLICY_ALL     = 0,
  SCAN_FLT_POLICY_WL      = 1,
  SCAN_FLT_POLICY_ALL_RPA = 2,
  SCAN_FLT_POLICY_WL_RPA  = 3
} GapScan_FilterPolicy_t;

typedef enum {
  SCAN_FLT_DISC_NONE    = 0, 
  SCAN_FLT_DISC_GENERAL = 1, 
  SCAN_FLT_DISC_LIMITED = 2, 
  SCAN_FLT_DISC_ALL     = 3, 
  SCAN_FLT_DISC_DISABLE = 4  
} GapScan_FilterDiscMode_t;

typedef enum {
  SCAN_FLT_DUP_DISABLE = 0, 
  SCAN_FLT_DUP_ENABLE  = 1, 
  SCAN_FLT_DUP_RESET   = 2
} GapScan_FilterDuplicate_t;

typedef struct {
  uint8_t    reason;    
  uint8_t    numReport; 
} GapScan_Evt_End_t;

typedef struct {
  uint8_t  evtType;
  GAP_Addr_Types_t addrType;
  uint8_t  addr[B_ADDR_LEN];
  GapScan_ScannedPhy_t primPhy;
  GapScan_ScannedPhy_t secPhy;
  uint8_t  advSid;
  int8_t   txPower;
  int8_t   rssi;
  GAP_Addr_Types_t directAddrType;
  uint8_t  directAddr[B_ADDR_LEN];
  uint16_t periodicAdvInt;
  uint16_t dataLen;
  uint8_t  *pData;
} GapScan_Evt_AdvRpt_t;

typedef uint32_t GapScan_EventMask_t;

typedef struct
{
  uint8  options;
  uint8  advAddrType;     
  uint8  advAddress[6];   
  uint16 skip;            
  uint16 syncTimeout;     

  uint8  syncCteType;
} GapScan_PeriodicAdvCreateSyncParams_t;

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

typedef struct
{
  osal_event_hdr_t hdr;  
  uint8_t opcode;        
  uint8_t status;        
  uint8_t listSize;      
} GapScan_ReadAdvSizeListEvt_t;

typedef struct
{
  osal_event_hdr_t hdr;   
  uint8_t opcode;         
  uint16_t syncHandle;    
} GapScan_PeriodicAdvSyncLostEvt_t;

typedef struct
{
  osal_event_hdr_t hdr;  
  uint8  opcode;         
  uint8  BLEEventCode;   
  uint16 syncHandle;     
  int8   txPower;        
  int8   rssi;           
  uint8  cteType;        
  uint8  dataStatus;     
  uint8  dataLen;        
  uint8  *pData;         
} GapScan_Evt_PeriodicAdvRpt_t;

typedef struct
{
  osal_event_hdr_t hdr;      
  uint8  opcode;             
  uint8  BLEEventCode;       
  uint8  status;             
  uint16 syncHandle;         
  uint8  advSid;             
  uint8  advAddrType;        
  uint8  advAddress[6];      
  uint8  advPhy;             
  uint16 periodicAdvInt;     
  uint8  advClockAccuracy;   
} GapScan_Evt_PeriodicAdvSyncEst_t;

/*-------------------------------------------------------------------
 * API's
 */

status_t GapScan_registerCb(pfnGapCB_t cb, uintptr_t arg);

status_t GapScan_setPhyParams(uint8_t primPhys, GapScan_ScanType_t type,
                              uint16_t interval, uint16_t window);

status_t GapScan_getPhyParams(uint8_t primPhy, GapScan_ScanType_t* pType,
                              uint16_t* pInterval, uint16_t* pWindow);

status_t GapScan_setParam(GapScan_ParamId_t paramId, void* pValue);

status_t GapScan_getParam(GapScan_ParamId_t paramId, void* pValue, uint8_t *pLen);

void GapScan_setEventMask(GapScan_EventMask_t eventMask);

status_t GapScan_enable(uint16_t period, uint16_t duration,
                        uint8_t maxNumReport);

status_t GapScan_disable(void);

status_t GapScan_getAdvReport(uint8_t rptIdx, GapScan_Evt_AdvRpt_t* pAdvRpt);

status_t GapScan_discardAdvReportList(void);

uint8_t GapScan_PeriodicAdvCreateSync( uint8  advSID,
                                       GapScan_PeriodicAdvCreateSyncParams_t *createSyncParams );

bStatus_t GapScan_PeriodicAdvCreateSyncCancel( void );

bStatus_t GapScan_PeriodicAdvTerminateSync( uint16 syncHandle);

bStatus_t GapScan_SetPeriodicAdvReceiveEnable( uint16 syncHandle,
                                               uint8  enable );

bStatus_t GapScan_AddDeviceToPeriodicAdvList( uint8 advAddrType,
                                              uint8 advAddress[6],
                                              uint8 advSID );

 bStatus_t GapScan_RemoveDeviceFromPeriodicAdvList( uint8 advAddrType,
                                                    uint8 advAddress[6],
                                                    uint8 advSID );

hciStatus_t GapScan_ReadPeriodicAdvListSize( void );

bStatus_t GapScan_ClearPeriodicAdvList( void );

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

#ifdef __cplusplus
}
#endif

#endif /* GAP_SCANNER_H */