linkdb.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 LINKDB_H
#define LINKDB_H

#ifdef __cplusplus
extern "C"
{
#endif

/*********************************************************************
 * INCLUDES
 */

/*********************************************************************
 * MACROS
 */

/*********************************************************************
 * CONSTANTS
 */

// Special case connection handles
#define INVALID_CONNHANDLE              0xFFFF  
#define LOOPBACK_CONNHANDLE             0xFFFE  


// Link state flags
#define LINK_NOT_CONNECTED              0x00    
#define LINK_CONNECTED                  0x01    
#define LINK_AUTHENTICATED              0x02    
#define LINK_BOUND                      0x04    
#define LINK_ENCRYPTED                  0x10    
#define LINK_SECURE_CONNECTIONS         0x20    
#define LINK_IN_UPDATE                  0x40    
#define LINK_PAIR_TIMEOUT               0x80    

// Link Database Status callback changeTypes
#define LINKDB_STATUS_UPDATE_NEW        0       
#define LINKDB_STATUS_UPDATE_REMOVED    1       
#define LINKDB_STATUS_UPDATE_STATEFLAGS 2       

// Link Authentication Errors
#define LINKDB_ERR_INSUFFICIENT_AUTHEN      0x05  
#define LINBDB_ERR_INSUFFICIENT_KEYSIZE     0x0c  
#define LINKDB_ERR_INSUFFICIENT_ENCRYPTION  0x0f  

// Secure Connection Only Mode Encryption Key Size
#define SCOM_ENCRYPT_KEY_SIZE           16      

/*********************************************************************
 * TYPEDEFS
 */

typedef struct
{
  uint8 srk[KEYLEN];  
  uint32 signCounter; 
} linkSec_t;

typedef struct
{
  uint8 ltk[KEYLEN];             
  uint16 div;                    
  uint8 rand[B_RANDOM_NUM_SIZE]; 
  uint8 keySize;                 
} encParams_t;

typedef struct
{
  uint8 taskID;                 
  uint16 connectionHandle;      
  uint8 stateFlags;             
  uint8 addrType;               
  uint8 addr[B_ADDR_LEN];       
  uint8 addrPriv[B_ADDR_LEN];   
  uint8 connRole;               
  uint16 connInterval;          
  uint16 MTU;                   
  linkSec_t sec;                
  encParams_t *pEncParams;      
} linkDBItem_t;

typedef struct
{
  uint8 stateFlags;             
  uint8 addrType;               
  uint8 addr[B_ADDR_LEN];       
  uint8 addrPriv[B_ADDR_LEN];   
  uint8 connRole;               
  uint16 connInterval;          
  uint16 MTU;                   
} linkDBInfo_t;
typedef void (*pfnLinkDBCB_t)( uint16 connectionHandle, uint8 changeType );

typedef void (*pfnPerformFuncCB_t)( linkDBItem_t *pLinkItem );
/*********************************************************************
 * GLOBAL VARIABLES
 */


extern uint8 linkDBNumConns;


/*********************************************************************
 * PUBLIC FUNCTIONS
 */

  extern void linkDB_Init( void );
  extern uint8 linkDB_Register( pfnLinkDBCB_t pFunc );

  extern uint8 linkDB_Add( uint8 taskID, uint16 connectionHandle,
                           uint8 stateFlags, uint8 addrType, uint8 *pAddr,
                           uint8 *pAddrPriv, uint8 connRole, uint16 connInterval,
                           uint16 MTU );

  extern uint8 linkDB_Remove( uint16 connectionHandle );

  extern uint8 linkDB_Update( uint16 connectionHandle, uint8 newState,
                              uint8 add );


  extern uint8 linkDB_NumActive( void );

  extern uint8 linkDB_NumConns( void );

  extern uint8 linkDB_UpdateMTU( uint16 connectionHandle, uint16 newMtu );

  extern uint16 linkDB_MTU( uint16 connectionHandle );

  extern uint8 linkDB_GetInfo( uint16 connectionHandle, linkDBInfo_t * pInfo );

  extern linkDBItem_t *linkDB_Find( uint16 connectionHandle );

  extern linkDBItem_t *linkDB_FindFirst( uint8 taskID );

  extern uint8 linkDB_State( uint16 connectionHandle, uint8 state );

  extern uint8 linkDB_Authen( uint16 connectionHandle, uint8 keySize,
                              uint8 mitmRequired );

  extern uint8 linkDB_Role( uint16 connectionHandle );

  extern void linkDB_PerformFunc( pfnPerformFuncCB_t cb );

  extern void linkDB_SecurityModeSCOnly( uint8 state );

/*********************************************************************
 * LINK STATE MACROS
 * Developer note:  Call from Application only.  Do not call from Stack,
 * not supported for ROM patching!
 */

  #define linkDB_Up( connectionHandle )  linkDB_State( (connectionHandle), LINK_CONNECTED )

  #define linkDB_Encrypted( connectionHandle )  linkDB_State( (connectionHandle), LINK_ENCRYPTED )

  #define linkDB_Authenticated( connectionHandle )  linkDB_State( (connectionHandle), LINK_AUTHENTICATED )

  #define linkDB_Bonded( connectionHandle )  linkDB_State( (connectionHandle), LINK_BOUND )

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

#ifdef __cplusplus
}
#endif

#endif /* LINKDB_H */