uble.h

Go to the documentation of this file.

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

 Group: WCS, BTS
 $Target Device: DEVICES $

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

#ifndef UBLE_H
#define UBLE_H

#ifdef __cplusplus
extern "C"
{
#endif

/*-------------------------------------------------------------------
 * INCLUDES
 */
#include <urfc.h>
#include <port.h>

/*-------------------------------------------------------------------
 * DEFINITIONS & CONSTANTS
 */

    #define UBLE_PARAM_COMMON_START       0

    #define UBLE_PARAM_RFPRIORITY         (UBLE_PARAM_COMMON_START+0)

    #define UBLE_PARAM_TXPOWER            (UBLE_PARAM_COMMON_START+1)

    #define UBLE_PARAM_COMMON_END         UBLE_PARAM_TXPOWER
#if defined(FEATURE_ADVERTISER)
    #define UBLE_PARAM_ADV_CMN_START      (UBLE_PARAM_COMMON_END+1)

      #define UBLE_PARAM_ADVINTERVAL        (UBLE_PARAM_ADV_CMN_START+0)

      #define UBLE_PARAM_ADVCHANMAP         (UBLE_PARAM_ADV_CMN_START+1)

      #define UBLE_PARAM_ADVTYPE            (UBLE_PARAM_ADV_CMN_START+2)

      #define UBLE_PARAM_TIMETOADV          (UBLE_PARAM_ADV_CMN_START+3)

      #define UBLE_PARAM_ADVDATA            (UBLE_PARAM_ADV_CMN_START+4)

    #define UBLE_PARAM_ADV_CMN_END        UBLE_PARAM_ADVDATA
  #if defined(FEATURE_SCAN_RESPONSE)
    #define UBLE_PARAM_ADV_SR_START       (UBLE_PARAM_ADV_CMN_END+1)

    #define UBLE_PARAM_SCANRSPDATA        (UBLE_PARAM_ADV_SR_START+0)

    #define UBLE_PARAM_ADVFLTPOLICY       (UBLE_PARAM_ADV_SR_START+1)
    #define UBLE_PARAM_ADV_SR_END         UBLE_PARAM_ADVFLTPOLICY
  #else  /* FEATURE_SCAN_RESPONSE */
    #define UBLE_PARAM_ADV_SR_END         UBLE_PARAM_ADV_CMN_END
  #endif /* FEATURE_SCAN_RESPONSE */
#else  /* FEATURE_ADVERTISER */
    #define UBLE_PARAM_ADV_SR_END         UBLE_PARAM_COMMON_END
#endif /* FEATURE_ADVERTISER */
#if defined(FEATURE_SCANNER)
    #define UBLE_PARAM_SCAN_START         (UBLE_PARAM_ADV_SR_END+1)

    #define UBLE_PARAM_SCANINTERVAL       (UBLE_PARAM_SCAN_START+0)

    #define UBLE_PARAM_SCANWINDOW         (UBLE_PARAM_SCAN_START+1)

    #define UBLE_PARAM_SCANCHANMAP        (UBLE_PARAM_SCAN_START+2)

    #define UBLE_PARAM_SCANTYPE           (UBLE_PARAM_SCAN_START+3)

    #define UBLE_PARAM_FLTDUPLICATE       (UBLE_PARAM_SCAN_START+4)

    #define UBLE_PARAM_SCANFLTPOLICY      (UBLE_PARAM_SCAN_START+5)
    #define UBLE_PARAM_SCAN_END           UBLE_PARAM_SCANFLTPOLICY
#else  /*FEATURE_SCANNER */
    #define UBLE_PARAM_SCAN_END           UBLE_PARAM_ADV_SR_END
#endif /* FEATURE_SCANNER */
    #if defined(FEATURE_MONITOR)
    #define UBLE_PARAM_MONITOR_START         (UBLE_PARAM_ADV_SR_END+1)

    #define UBLE_PARAM_SESSIONID         (UBLE_PARAM_MONITOR_START+0)

    #define UBLE_PARAM_MONITOR_CHAN      (UBLE_PARAM_MONITOR_START+1)

    #define UBLE_PARAM_MONITOR_DURATION  (UBLE_PARAM_MONITOR_START+2)

    #define UBLE_PARAM_MONITOR_START_TIME  (UBLE_PARAM_MONITOR_START+3)

    #define UBLE_PARAM_MONITOR_ACCESS_ADDR (UBLE_PARAM_MONITOR_START+4)
    #define UBLE_PARAM_MONITOR_END           UBLE_PARAM_MONITOR_ACCESS_ADDR
#else  /* FEATURE_MONITOR */
    #define UBLE_PARAM_MONITOR_END           UBLE_PARAM_ADV_SR_END
#endif /* FEATURE_MONITOR */
    #define UBLE_NUM_PARAM  (UBLE_PARAM_MONITOR_END+1)

#define UBLE_RF_PRI_NORMAL      ((uint8) RF_PriorityNormal)  
#define UBLE_RF_PRI_HIGH        ((uint8) RF_PriorityHigh)    
#define UBLE_RF_PRI_HIGHEST     ((uint8) RF_PriorityHighest) 

#define RF_TIME_RELAXED    0    
#define RF_TIME_CRITICAL   1    

#define UBLE_TX_POWER_INVALID 0xFFFF

#define UBLE_ADDRTYPE_PUBLIC          0 
#define UBLE_ADDRTYPE_STATIC          1 
#define UBLE_ADDRTYPE_NONRESOLVABLE   2 
#define UBLE_ADDRTYPE_RESOLVABLE      3 
#define UBLE_ADDRTYPE_BD               4 

#define UBLE_ADVTYPE_ADV_NC   5   
#define UBLE_ADVTYPE_ADV_SCAN 6   

#define UBLE_ADV_CHAN_37   0x01 
#define UBLE_ADV_CHAN_38   0x02 
#define UBLE_ADV_CHAN_39   0x04 
#define UBLE_ADV_CHAN_ALL  (UBLE_ADV_CHAN_37 | UBLE_ADV_CHAN_38 | UBLE_ADV_CHAN_39)  

/* Min/Max for parameters */
#define UBLE_MIN_ADV_INTERVAL    160  
#define UBLE_MAX_ADV_INTERVAL    16384 
#define UBLE_MIN_CHANNEL_MAP     UBLE_ADV_CHAN_37 
#define UBLE_MAX_CHANNEL_MAP     UBLE_ADV_CHAN_ALL    
#define UBLE_MIN_TX_POWER        TX_POWER_MINUS_21_DBM 
#define UBLE_MAX_TX_POWER        TX_POWER_5_DBM        
#define UBLE_MIN_SCAN_INTERVAL   4 
#define UBLE_MAX_SCAN_INTERVAL   16384 
#define UBLE_MIN_SCAN_WINDOW     4 
#define UBLE_MAX_SCAN_WINDOW     16384 
#define UBLE_MIN_MONITOR_HANDLE    0 
#define UBLE_MAX_MONITOR_HANDLE    8 
#define UBLE_MIN_MONITOR_CHAN      0 
#define UBLE_MAX_MONITOR_CHAN      39 
#define UBLE_MIN_MONITOR_DURATION  0 
#define UBLE_MAX_MONITOR_DURATION  64000 

/* Default Parameter Values */
#define UBLE_PARAM_DFLT_RFPRIORITY      UBLE_RF_PRI_NORMAL  
#define UBLE_PARAM_DFLT_RFTIMECRIT      RF_TIME_RELAXED   
#define UBLE_PARAM_DFLT_TXPOWER         TX_POWER_0_DBM    
#define UBLE_PARAM_DFLT_ADVINTERVAL     1600              
#define UBLE_PARAM_DFLT_ADVCHANMAP      UBLE_ADV_CHAN_ALL   
#define UBLE_PARAM_DFLT_ADVTYPE         UBLE_ADVTYPE_ADV_NC 
#define UBLE_PARAM_DFLT_TIMETOADV       0                 
#define UBLE_PARAM_DFLT_ADVDATA         {0}               
#define UBLE_PARAM_DFLT_SCANRSPDATA     {0}               
#define UBLE_PARAM_DFLT_ADVFLTPOLICY    0                 
#define UBLE_PARAM_DFLT_SCANINTERVAL    16                
#define UBLE_PARAM_DFLT_SCANWINDOW      16                
#define UBLE_PARAM_DFLT_SCANCHAN        UBLE_ADV_CHAN_ALL   
#define UBLE_PARAM_DFLT_SCANTYPE        0                 
#define UBLE_PARAM_DFLT_FLTDUPLICATE    0                 
#define UBLE_PARAM_DFLT_SCANFLTPOLICY   0                 
#define UBLE_PARAM_DFLT_MONITOR_HANDLE    0               
#define UBLE_PARAM_DFLT_MONITOR_CHAN      37              
#define UBLE_PARAM_DFLT_MONITOR_DURATION  320             
#define UBLE_PARAM_DFLT_MONITOR_START_TIME  6400          
#define UBLE_PARAM_DFLT_MONITOR_ACCESS_ADDR 0x8E89BED6    
#define UBLE_PARAM_DFLT_MONITOR_CRCINIT     0x555555      


#define UBLE_EVTDST_LL       0      
#define UBLE_EVTDST_GAP      1      
#define UBLE_NUM_EVTDST      2      


#define US_TO_RAT        4

#define MS_TO_RAT        4000

#define BLE_TO_RAT       2500

#define SYSTICK_TO_RAT   (Clock_tickPeriod * US_TO_RAT)

#define MS_TO_SYSTICK    (1000 / Clock_tickPeriod)

#define BLE_TO_SYSTICK   (625 / Clock_tickPeriod)

#define BYTE_TO_RAT      (8 * US_TO_RAT)

/* Length of ADV Data */
#define UBLE_MAX_ADVDATA_LEN         B_MAX_ADV_LEN  

#define UBLE_MAX_OVERLAP_TIME_LIMIT     0x7270E000  // 8 minutes in 625us ticks. chosen to be half of 17 minutes RF overlap.
#define UBLE_MAX_32BIT_TIME             0xFFFFFFFF

/*-------------------------------------------------------------------
 * TYPEDEFS
 */

typedef uint8 ubleAddrType_t;

typedef uint8 ubleEvtDst_t;

typedef uint8 ubleEvt_t;

PACKED_TYPEDEF_STRUCT {
  port_queueElem_t pElem;  
  ubleEvtDst_t     dst;    
  ubleEvt_t        evt;    
} ubleEvtHdr_t;  

typedef uint8 ubleMsg_t;

PACKED_TYPEDEF_STRUCT {
  ubleEvtHdr_t  hdr;      
  ubleMsg_t     msg[];    
} ubleEvtMsg_t; 

typedef void (*ublePostEvtProxyCB_t)(void);

typedef void (*ubleAntSwitchCB_t)(void);

typedef void (*ubleProcessMsg_t)(ubleEvtMsg_t *pEvtMsg);


PACKED_TYPEDEF_STRUCT {
  uint8  rfPriority;              
  int8   txPower;                 
#if defined(FEATURE_ADVERTISER)
  uint16 advInterval;             
  uint8  advChanMap;              
  uint8  advType;                 
  uint8  timeToAdv;               
  uint8  advData[UBLE_MAX_ADVDATA_LEN];     
#if defined(FEATURE_SCAN_RESPONSE)
  uint8  scanRspData[UBLE_MAX_ADVDATA_LEN];   
  uint8  advFltPolicy;            
#endif /* FEATURE_SCAN_RESPONSE */
#endif /* FEATURE_ADVERTISER */
#if defined(FEATURE_SCANNER)
  uint16 scanInterval;            
  uint16 scanWindow;              
  uint8  scanChanMap;             
  uint8  scanType;                
  uint8  fltDuplicate;            
  uint8  scanFltPolicy;           
#endif /* FEATURE_SCANNER */
#if defined(FEATURE_MONITOR)
  uint8  monitorHandle;           
  uint8  monitorChan;             
  uint16 monitorDuration;         
  uint32 startTime;               
  uint32 accessAddr;              
  uint32 crcInit;
#endif /* FEATURE_MONITOR */
} ubleParams_t;

PACKED_TYPEDEF_STRUCT {
  uint8  offset;
  uint8  len;
  uint8  min;
  uint8  max;
} ubParamLookup_t;

/*-------------------------------------------------------------------
 * API FUNCTIONS
 */

bStatus_t uble_stackInit(ubleAddrType_t addrType, uint8* pStaticAddr,
                         ublePostEvtProxyCB_t pfnPostEvtProxyCB, uint8 timeCritical);

uint8 uble_timeCompare(uint32 time1, uint32 time2);

uint32 uble_timeDelta(uint32 time1, uint32 time2);

bStatus_t uble_setParameter(uint8 param, uint8 len, void *pValue);

bStatus_t uble_getParameter(uint8 param, void *pValue);

bStatus_t uble_checkAddr(ubleAddrType_t addrType, uint8 *pAddr);

void uble_resetAddr(void);

bStatus_t uble_getAddr(ubleAddrType_t addrType, uint8* pAddr);

bStatus_t uble_registerAntSwitchCB(ubleAntSwitchCB_t pfnAntSwitchCB);

void uble_processMsg(void);

/*-------------------------------------------------------------------
 * BLE_LOG FUNCTIONS
 */
//#define BLE_LOG
#ifdef BLE_LOG

#define BLE_LOG_MODULE_CTRL            0x01
#define BLE_LOG_MODULE_HOST            0x02
#define BLE_LOG_MODULE_APP             0x04
#define BLE_LOG_MODULE_OSAL_TASK       0x08
#define BLE_LOG_MODULE_RF_CMD          0x10

void bleLog_int_int(void *handle, uint32_t type, uint8_t *format, uint32_t param1, uint32_t param2);
void bleLog_int_str(void *handle, uint32_t type, uint8_t *format, uint32_t param1, char *param2);
void bleLog_int_time(void *handle, uint32_t type, uint8_t *start_str, uint32_t param1);

#define BLE_LOG_INT_INT(handle, type, format, param1, param2)         bleLog_int_int(handle, type, format, param1, param2)
#define BLE_LOG_INT_STR(handle, type, format, param1, param2)         bleLog_int_str(handle, type, format, param1, param2)
#define BLE_LOG_INT_TIME(handle, type, start_str, param1)             bleLog_int_time(handle, type, start_str, param1)
#else
#define BLE_LOG_INT_INT(handle, type, format, param1, param2)
#define BLE_LOG_INT_STR(handle, type, format, param1, param2)
#define BLE_LOG_INT_TIME(handle, type, start_str, param1)

#endif //BLE_LOG

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

#ifdef __cplusplus
}
#endif

#endif /* UBLE_H */