uble.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*!*****************************************************************************
 *  @defgroup Micro_BLE_Stack Micro BLE Stack
 *  @brief This module implmements the Micro BLE Stack
 *  @{
 *  @defgroup UBLE Micro Link Layer
 *  @{
 *  @file   uble.h
 *  @brief  This file contains the interface to the Micro Link Layer.
 */

#ifndef UBLE_H
#define UBLE_H

#ifdef __cplusplus
extern "C"
{
#endif

/*-------------------------------------------------------------------
 * INCLUDES
 */
#include <ti/sysbios/knl/Queue.h>
#include <urfc.h>

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

    #define UB_PARAM_COMMON_START       0

      #define UB_PARAM_RFPRIORITY         (UB_PARAM_COMMON_START+0)

      #define UB_PARAM_RFTIMECRIT         (UB_PARAM_COMMON_START+1)

      #define UB_PARAM_TXPOWER            (UB_PARAM_COMMON_START+2)

    #define UB_PARAM_COMMON_END         UB_PARAM_TXPOWER
#if defined(FEATURE_ADVERTISER)
    #define UB_PARAM_ADV_CMN_START      (UB_PARAM_COMMON_END+1)

      #define UB_PARAM_ADVINTERVAL        (UB_PARAM_ADV_CMN_START+0)

      #define UB_PARAM_ADVCHANMAP         (UB_PARAM_ADV_CMN_START+1)

      #define UB_PARAM_ADVTYPE            (UB_PARAM_ADV_CMN_START+2)

      #define UB_PARAM_TIMETOADV          (UB_PARAM_ADV_CMN_START+3)

      #define UB_PARAM_ADVDATA            (UB_PARAM_ADV_CMN_START+4)

    #define UB_PARAM_ADV_CMN_END        UB_PARAM_ADVDATA
  #if defined(FEATURE_SCAN_RESPONSE)
    #define UB_PARAM_ADV_SR_START       (UB_PARAM_ADV_CMN_END+1)

      #define UB_PARAM_SCANRSPDATA        (UB_PARAM_ADV_SR_START+0)

      #define UB_PARAM_ADVFLTPOLICY       (UB_PARAM_ADV_SR_START+1)

    #define UB_PARAM_ADV_SR_END         UB_PARAM_ADVFLTPOLICY
  #else  /* FEATURE_SCAN_RESPONSE */
    #define UB_PARAM_ADV_SR_END         UB_PARAM_ADV_CMN_END
  #endif /* FEATURE_SCAN_RESPONSE */
#else  /* FEATURE_ADVERTISER */
    #define UB_PARAM_ADV_SR_END         UB_PARAM_COMMON_END
#endif /* FEATURE_ADVERTISER */
#if defined(FEATURE_SCANNER)
    #define UB_PARAM_SCAN_START         (UB_PARAM_ADV_SR_END+1)
      #define UB_PARAM_SCANINTERVAL       (UB_PARAM_SCAN_START+0)
      #define UB_PARAM_SCANWINDOW         (UB_PARAM_SCAN_START+1)
      #define UB_PARAM_SCANCHANMAP        (UB_PARAM_SCAN_START+2)
      #define UB_PARAM_SCANTYPE           (UB_PARAM_SCAN_START+3)
      #define UB_PARAM_FLTDUPLICATE       (UB_PARAM_SCAN_START+4)
      #define UB_PARAM_SCANFLTPOLICY      (UB_PARAM_SCAN_START+5)
    #define UB_PARAM_SCAN_END           UB_PARAM_SCANFLTPOLICY
#else  /*FEATURE_SCANNER */
    #define UB_PARAM_SCAN_END           UB_PARAM_ADV_SR_END
#endif /* FEATURE_SCANNER */
    #define UB_NUM_PARAM  (UB_PARAM_SCAN_END+1)

#define RF_PRI_NORMAL      ((uint8) RF_PriorityNormal) 
#define RF_PRI_HIGH        ((uint8) RF_PriorityHigh)    
#define RF_PRI_HIGHEST     ((uint8) RF_PriorityHighest) 

#define RF_TIME_RELAXED    0    
#define RF_TIME_CRITICAL   1    

#define UB_TX_POWER_INVALID 0xFFFF
  
#define UB_ADDRTYPE_PUBLIC          0 
#define UB_ADDRTYPE_STATIC          1 
#define UB_ADDRTYPE_NONRESOLVABLE   2 
#define UB_ADDRTYPE_RESOLVABLE      3 
#define UB_ADDRTYPE_BD               4 

#define UB_ADVTYPE_ADV_NC   5   
#define UB_ADVTYPE_ADV_SCAN 6   

#define UB_ADV_CHAN_37   0x01 
#define UB_ADV_CHAN_38   0x02 
#define UB_ADV_CHAN_39   0x04 
#define UB_ADV_CHAN_ALL  (UB_ADV_CHAN_37 | UB_ADV_CHAN_38 | UB_ADV_CHAN_39)  

/* Min/Max for parameters */
#define UB_MIN_ADV_INTERVAL    160  
#define UB_MAX_ADV_INTERVAL    16384 
#define UB_MIN_CHANNEL_MAP     UB_ADV_CHAN_37
#define UB_MAX_CHANNEL_MAP     UB_ADV_CHAN_ALL
#define UB_MIN_TX_POWER        TX_POWER_MINUS_21_DBM 
#define UB_MAX_TX_POWER        TX_POWER_5_DBM        

/* Default Parameter Values */
#define UB_PARAM_DFLT_RFPRIORITY      RF_PRI_NORMAL     
#define UB_PARAM_DFLT_RFTIMECRIT      RF_TIME_RELAXED   
#define UB_PARAM_DFLT_TXPOWER         TX_POWER_0_DBM    
#define UB_PARAM_DFLT_ADVINTERVAL     1600              
#define UB_PARAM_DFLT_ADVCHANMAP      UB_ADV_CHAN_ALL   
#define UB_PARAM_DFLT_ADVTYPE         UB_ADVTYPE_ADV_NC 
#define UB_PARAM_DFLT_TIMETOADV       0                 
#define UB_PARAM_DFLT_ADVDATA         {0}               
#define UB_PARAM_DFLT_SCANRSPDATA     {0}               
#define UB_PARAM_DFLT_ADVFLTPOLICY    0                 


#define UB_EVTDST_LL       0
#define UB_EVTDST_GAP      1
#define UB_NUM_EVTDST      2
   
/* 1 us = 4 RAT tick */
#define US_TO_RAT        4
/* 1 ms = 4000 RAT tick */
#define MS_TO_RAT        4000
/* 1 BLE tick(0.625 ms) = 2500 RAT tick */
#define BLE_TO_RAT       2500
/* 1 system tick = (Clock_tickPeriod * US_TO_RAT) RAT tick */
#define SYSTICK_TO_RAT   (Clock_tickPeriod * US_TO_RAT)
/* 1 ms = (1000 / Clock_tickPeriod) system tick */
#define MS_TO_SYSTICK    (1000 / Clock_tickPeriod)

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


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

typedef uint8 ubAddrType_t;

typedef uint8 ubEvtDst_t;

typedef uint8 ubEvt_t;

PACKED_TYPEDEF_STRUCT {
  Queue_Elem    _elem;
  ubEvtDst_t    dst;
  ubEvt_t       evt;
} ubEvtHdr_t;

typedef uint8 ubMsg_t;

PACKED_TYPEDEF_STRUCT {
  ubEvtHdr_t    hdr;
  ubMsg_t       msg[];
} ubEvtMsg_t;

typedef void (*ubPostEvtProxyCB_t)(void);

typedef void (*ubProcessMsg_t)(ubEvtMsg_t *pEvtMsg);


PACKED_TYPEDEF_STRUCT {
  uint8  rfPriority;              
  uint8  rfTimeCrit;              
  int8   txPower;                 
  uint8 _dummy0;                  
#if defined(FEATURE_ADVERTISER)
  uint16 advInterval;             
  uint8  advChanMap;              
  uint8  advType;                 
  uint8  timeToAdv;               
  uint8  advData[UB_MAX_ADVDATA_LEN];     
#if defined(FEATURE_SCAN_RESPONSE)
  uint8  scanRspData[UB_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 */
} ubParams_t;

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

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

bStatus_t ub_stackInit(ubAddrType_t addrType, uint8* pStaticAddr,
                       ubPostEvtProxyCB_t pfnPostEvtProxyCB);
  
bStatus_t ub_setParameter(uint8 param, uint8 len, void *pValue);
  
bStatus_t ub_getParameter(uint8 param, void *pValue);

bStatus_t ub_checkAddr(ubAddrType_t addrType, uint8 *pAddr);

void ub_resetAddr(void);

bStatus_t ub_getAddr(ubAddrType_t addrType, uint8* pAddr);

void ub_processMsg(void);

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

#ifdef __cplusplus
}
#endif

#endif /* UBLE_H */