gapbondmgr.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 GAPBondMgr GAPBondMgr
 *  @brief This module implements the GAP Bond Manager
 *  @{
 *  @file       gapbondmgr.h
 *  @brief      GAPBondMgr layer interface
 */

#ifndef GAPBONDMGR_H
#define GAPBONDMGR_H

#ifdef __cplusplus
extern "C"
{
#endif

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

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

#if !defined ( GAP_BONDINGS_MAX )
  #define GAP_BONDINGS_MAX    10    
#endif

#if !defined ( GAP_CHAR_CFG_MAX )
  #define GAP_CHAR_CFG_MAX    4    
#endif

#define GAPBOND_PAIRING_MODE          0x400

#define GAPBOND_INITIATE_WAIT         0x401

#define GAPBOND_MITM_PROTECTION       0x402

#define GAPBOND_IO_CAPABILITIES       0x403

#define GAPBOND_OOB_ENABLED           0x404

#define GAPBOND_OOB_DATA              0x405

#define GAPBOND_BONDING_ENABLED       0x406

#define GAPBOND_KEY_DIST_LIST         0x407

#define GAPBOND_DEFAULT_PASSCODE      0x408

#define GAPBOND_ERASE_ALLBONDS        0x409

#define GAPBOND_AUTO_FAIL_PAIRING     0x40A
#define GAPBOND_AUTO_FAIL_REASON      0x40B

#define GAPBOND_KEYSIZE               0x40C

#define GAPBOND_AUTO_SYNC_WL          0x40D

#define GAPBOND_BOND_COUNT            0x40E

#define GAPBOND_BOND_FAIL_ACTION      0x40F

#define GAPBOND_ERASE_SINGLEBOND      0x410

#define GAPBOND_SECURE_CONNECTION     0x411

#define GAPBOND_ECCKEY_REGEN_POLICY   0x412

#define GAPBOND_ECC_KEYS              0x413

#define GAPBOND_REMOTE_OOB_SC_ENABLED 0x414

#define GAPBOND_REMOTE_OOB_SC_DATA    0x415

#define GAPBOND_LOCAL_OOB_SC_ENABLED  0x416

#define GAPBOND_LOCAL_OOB_SC_DATA     0x417

#define GAPBOND_LRU_BOND_REPLACEMENT  0x418

#define GAPBOND_PAIRING_MODE_NO_PAIRING          0x00  
#define GAPBOND_PAIRING_MODE_WAIT_FOR_REQ        0x01  
#define GAPBOND_PAIRING_MODE_INITIATE            0x02  

#define GAPBOND_IO_CAP_DISPLAY_ONLY              0x00  
#define GAPBOND_IO_CAP_DISPLAY_YES_NO            0x01  
#define GAPBOND_IO_CAP_KEYBOARD_ONLY             0x02  
#define GAPBOND_IO_CAP_NO_INPUT_NO_OUTPUT        0x03  
#define GAPBOND_IO_CAP_KEYBOARD_DISPLAY          0x04  

#define GAPBOND_KEYDIST_SENCKEY                  0x01  
#define GAPBOND_KEYDIST_SIDKEY                   0x02  
#define GAPBOND_KEYDIST_SSIGN                    0x04  
#define GAPBOND_KEYDIST_SLINK                    0x08  
#define GAPBOND_KEYDIST_MENCKEY                  0x10  
#define GAPBOND_KEYDIST_MIDKEY                   0x20  
#define GAPBOND_KEYDIST_MSIGN                    0x40  
#define GAPBOND_KEYDIST_MLINK                    0x80  

#define GAPBOND_PAIRING_STATE_STARTED             0x00

#define GAPBOND_PAIRING_STATE_COMPLETE            0x01

#define GAPBOND_PAIRING_STATE_BONDED              0x02
#define GAPBOND_PAIRING_STATE_BOND_SAVED          0x03  
#define GAPBOND_PAIRING_STATE_CAR_READ            0x04  

#define SMP_PAIRING_FAILED_PASSKEY_ENTRY_FAILED   0x01 
#define SMP_PAIRING_FAILED_OOB_NOT_AVAIL          0x02 
#define SMP_PAIRING_FAILED_AUTH_REQ               0x03 
#define SMP_PAIRING_FAILED_CONFIRM_VALUE          0x04 
#define SMP_PAIRING_FAILED_NOT_SUPPORTED          0x05 
#define SMP_PAIRING_FAILED_ENC_KEY_SIZE           0x06 
#define SMP_PAIRING_FAILED_CMD_NOT_SUPPORTED      0x07 
#define SMP_PAIRING_FAILED_UNSPECIFIED            0x08 
#define SMP_PAIRING_FAILED_REPEATED_ATTEMPTS      0x09 
#define SMP_PAIRING_FAILED_INVALID_PARAMETERS     0x0A 
#define SMP_PAIRING_FAILED_DHKEY_CHECK_FAILED     0x0B 
#define SMP_PAIRING_FAILED_NUM_COMPARISON_FAILED  0x0C 

#define GAPBOND_FAIL_NO_ACTION                         0x00 
#define GAPBOND_FAIL_INITIATE_PAIRING                  0x01 
#define GAPBOND_FAIL_TERMINATE_LINK                    0x02 
#define GAPBOND_FAIL_TERMINATE_ERASE_BONDS             0x03 

#define GAPBOND_SECURE_CONNECTION_NONE                 0x00 
#define GAPBOND_SECURE_CONNECTION_ALLOW                0x01 
#define GAPBOND_SECURE_CONNECTION_ONLY                 0x02 

#define GAPBOND_REGENERATE_ALWAYS                       0x00 
#define GAPBOND_REGENERATE_NEVER                        0xFF 

// ECC Key Length
#define ECC_KEYLEN                                     32   


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

typedef void (*pfnPasscodeCB_t)
(
  uint8  *deviceAddr,
  uint16 connectionHandle,
  uint8  uiInputs,
  uint8  uiOutputs,
  uint32 numComparison
 );

typedef void (*pfnPairStateCB_t)
(
  uint16 connectionHandle,
  uint8  state,
  uint8  status
);

/*
 * @brief GAPBondMgr Callback Structure
 *
 * This must be setup by the application and passed to the GAPRole when
 * @ref GAPBondMgr_Register is called.
 */
typedef struct
{
  pfnPasscodeCB_t     passcodeCB;       
  pfnPairStateCB_t    pairStateCB;      
} gapBondCBs_t;

typedef struct
{
  uint8 privateKey[ECC_KEYLEN];
  uint8 publicKeyX[ECC_KEYLEN];
  uint8 publicKeyY[ECC_KEYLEN];
} gapBondEccKeys_t;

typedef struct
{
  uint8 addr[B_ADDR_LEN];    
  uint8 confirm[KEYLEN]; 
  uint8 oob[KEYLEN];     
} gapBondOobSC_t;

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

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

extern bStatus_t GAPBondMgr_SetParameter( uint16 param, uint8 len, void *pValue );

extern bStatus_t GAPBondMgr_GetParameter( uint16 param, void *pValue );

extern bStatus_t GAPBondMgr_LinkEst( uint8 addrType, uint8 *pDevAddr, uint16 connHandle, uint8 role );

extern void GAPBondMgr_LinkTerm(uint16 connHandle);

extern void GAPBondMgr_SlaveReqSecurity(uint16 connHandle, uint8 authReq);

extern uint8 GAPBondMgr_ResolveAddr( uint8 addrType, uint8 *pDevAddr, uint8 *pResolvedAddr );

extern bStatus_t GAPBondMgr_ServiceChangeInd( uint16 connectionHandle, uint8 setParam );

extern bStatus_t GAPBondMgr_UpdateCharCfg( uint16 connectionHandle, uint16 attrHandle, uint16 value );

extern void GAPBondMgr_Register( gapBondCBs_t *pCB );

extern bStatus_t GAPBondMgr_PasscodeRsp( uint16 connectionHandle, uint8 status, uint32 passcode );

extern bStatus_t GAPBondMgr_ReadCentAddrResChar( uint16 connectionHandle );

extern uint8 GAPBondMgr_SupportsEnhancedPriv( uint8 *pPeerIdAddr );

extern uint8 GAPBondMgr_ProcessGAPMsg( gapEventHdr_t *pMsg );

extern uint8 GAPBondMgr_CheckNVLen( uint8 id, uint8 len );

extern bStatus_t GAPBondMgr_syncResolvingList( void );


/*-------------------------------------------------------------------
 * TASK FUNCTIONS - Don't call these. These are system functions.
 */

extern void GAPBondMgr_Init( uint8 task_id );

extern uint16 GAPBondMgr_ProcessEvent( uint8 task_id, uint16 events );


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

#ifdef __cplusplus
}
#endif

#endif /* GAPBONDMGR_H */