linkdb.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 LinkDB LinkDB
 *  @brief This module implements the Link Database Module
 *  @{
 *  @file       linkdb.h
 *  @brief      LinkDB layer interface
 */

#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    

// 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  

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

typedef struct
{
  uint8 srk[KEYLEN];  // Signature Resolving Key
  uint32 signCounter; // Sign Counter 
} linkSec_t;

typedef struct
{
  uint8 ltk[KEYLEN];             // Long Term Key
  uint16 div;                    // Diversifier
  uint8 rand[B_RANDOM_NUM_SIZE]; // random number
  uint8 keySize;                 // LTK Key Size
} encParams_t;

typedef struct
{
  uint8 taskID;                 // Application that controls the link
  uint16 connectionHandle;      // Controller connection handle
  uint8 stateFlags;             // LINK_CONNECTED, LINK_AUTHENTICATED...
  uint8 addrType;               // Address type of connected device
  uint8 addr[B_ADDR_LEN];       // Other Device's address
  uint8 addrPriv[B_ADDR_LEN];   // Other Device's Private address
  uint8 connRole;               // Connection formed as Master or Slave
  uint16 connInterval;          // The connection's interval (n * 1.23 ms)
  uint16 MTU;                   // The connection's MTU size
  linkSec_t sec;                // Connection Security related items
  encParams_t *pEncParams;      // pointer to LTK, ediv, rand. if needed.
} linkDBItem_t;

typedef struct
{
  uint8 stateFlags;             // LINK_CONNECTED, LINK_AUTHENTICATED...
  uint8 addrType;               // Address type of connected device
  uint8 addr[B_ADDR_LEN];       // Other Device's address
  uint8 addrPriv[B_ADDR_LEN];   // Other Device's Private address
  uint8 connRole;               // Connection formed as Master or Slave
  uint16 connInterval;          // The connection's interval (n * 1.23 ms)
  uint16 MTU;                   // The connection's MTU size
} 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 );

/*
 * @brief       This function is used to get the MTU size of a link.
 *
 * @param       connectionHandle - controller link connection handle.
 *
 * @return      link MTU size
 */
  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 */