TI BLE5-Stack API Documentation
2.02.08.00
|
Modules | |
GAP Bond Manager Callbacks | |
GAP Bond Manager Constants | |
GAP Bond Manager Pairing State Events | |
GAP Bond Manager Parameters | |
GAP Bond Manager Structures | |
Files | |
file | gapbondmgr.h |
Functions | |
bStatus_t | GAPBondMgr_FindAddr (uint8_t *pDevAddr, GAP_Peer_Addr_Types_t addrType, uint8_t *pIdx, GAP_Peer_Addr_Types_t *pIdentityAddrType, uint8_t *pIdentityAddr) |
Search for an address in the bonding table. If the address is a random private resolvable address, attempt to resolve the random address against all IRK's in bonding table. As output parameters, return the following: More... | |
bStatus_t | GAPBondMgr_GenerateEccKeys (void) |
Generates ECC keys. More... | |
bStatus_t | GAPBondMgr_GetParameter (uint16_t param, void *pValue) |
uint8_t | GapBondMgr_GetPrevAuth (uint16_t connHandle, uint8_t *pMitmReq, uint8_t *pKeySize) |
bStatus_t | GAPBondMgr_Pair (uint16_t connHandle) |
bStatus_t | GAPBondMgr_PasscodeRsp (uint16_t connectionHandle, uint8_t status, uint32_t passcode) |
void | GAPBondMgr_Register (gapBondCBs_t *pCB) |
bStatus_t | GAPBondMgr_SCGetLocalOOBParameters (gapBondOOBData_t *localOobData) |
Get local Random number and confirm value for secure connection. More... | |
bStatus_t | GAPBondMgr_SCSetRemoteOOBParameters (gapBondOOBData_t *remoteOobData, uint8 OOBDataFlag) |
Set remote's OOB parameters for secure connection. More... | |
bStatus_t | GAPBondMgr_ServiceChangeInd (uint16_t connectionHandle, uint8_t setParam) |
bStatus_t | GAPBondMgr_SetParameter (uint16_t param, uint8_t len, void *pValue) |
uint8_t | GapBondMgr_StartEnc (uint16_t connHandle) |
uint8_t | gapBondMgrImportBond (gapBondRec_t *pBondRec, gapBondLTK_t *pLocalLtk, gapBondLTK_t *pDevLtk, uint8_t *pIRK, uint8_t *pSRK, uint32_t signCount, gapBondCharCfg_t *charCfg) |
Import bond record to NV. More... | |
uint8_t | gapBondMgrReadBondRec (GAP_Peer_Addr_Types_t addrType, uint8_t *pDevAddr, gapBondRec_t *pBondRec, gapBondLTK_t *pLocalLtk, gapBondLTK_t *pDevLtk, uint8_t *pIRK, uint8_t *pSRK, uint32_t signCount, gapBondCharCfg_t *charCfg) |
Read bond record from NV. More... | |
This module implements the GAP Bond Manager
bStatus_t GAPBondMgr_FindAddr | ( | uint8_t * | pDevAddr, |
GAP_Peer_Addr_Types_t | addrType, | ||
uint8_t * | pIdx, | ||
GAP_Peer_Addr_Types_t * | pIdentityAddrType, | ||
uint8_t * | pIdentityAddr | ||
) |
Search for an address in the bonding table. If the address is a random private resolvable address, attempt to resolve the random address against all IRK's in bonding table. As output parameters, return the following:
Note that the output parameters are optional. If it is not desired for them to be returned, a NULL pointer can safely be passed.
pDevAddr | peer's address |
addrType | peer's address type |
pIdx | pointer to byte to put the bond index if found |
pIdentityAddrType | pointer to byte to put the identity address type if applicable |
pIdentityAddr | pointer to buffer to put the identity address type if applicable |
bStatus_t GAPBondMgr_GenerateEccKeys | ( | void | ) |
Generates ECC keys.
/ref did_244389729
bStatus_t GAPBondMgr_GetParameter | ( | uint16_t | param, |
void * | pValue | ||
) |
Get a GAP Bond Manager parameter.
param | Profile parameter ID: GAP Bond Manager Parameters |
pValue | pointer to location to get the value. This is dependent on the parameter ID and WILL be cast to the appropriate data type (example: data type of uint16_t will be cast to uint16_t pointer). |
bStatus_t GAPBondMgr_Pair | ( | uint16_t | connHandle | ) |
Start (or re-start) the pairing process
This API can be used to initiate pairing in cases where it is not started automatically by the gapbondmgr or to re-pair after the initial pairing has occurred if, for example, the pairing requirements have changed.
connHandle | connection handle to initiate pairing with |
bStatus_t GAPBondMgr_PasscodeRsp | ( | uint16_t | connectionHandle, |
uint8_t | status, | ||
uint32_t | passcode | ||
) |
Respond to a passcode request.
connectionHandle | connection handle of the connected device or 0xFFFF if all devices in database. |
status | SUCCESS if passcode is available, otherwise see Pairing failure status values. |
passcode | integer value containing the passcode. |
void GAPBondMgr_Register | ( | gapBondCBs_t * | pCB | ) |
Register callback functions with the bond manager.
pCB | pointer to callback function structure. |
bStatus_t GAPBondMgr_SCGetLocalOOBParameters | ( | gapBondOOBData_t * | localOobData | ) |
Get local Random number and confirm value for secure connection.
/ref did_244389729
localOobData | - Struct holding local's random number and confirm value |
bStatus_t GAPBondMgr_SCSetRemoteOOBParameters | ( | gapBondOOBData_t * | remoteOobData, |
uint8 | OOBDataFlag | ||
) |
Set remote's OOB parameters for secure connection.
/ref did_244389729
remoteOobData | - struct holding remote random number and confirm value |
OOBDataFlag | - 1 - OOB Authentication data from remote device present, else 0 |
bStatus_t GAPBondMgr_ServiceChangeInd | ( | uint16_t | connectionHandle, |
uint8_t | setParam | ||
) |
Set/clear the service change indication in a bond record.
connectionHandle | connection handle of the connected device or 0xFFFF if all devices in database. |
setParam | TRUE to set the service change indication, FALSE to clear it. |
bStatus_t GAPBondMgr_SetParameter | ( | uint16_t | param, |
uint8_t | len, | ||
void * | pValue | ||
) |
Set a GAP Bond Manager parameter.
param | GAP Bond Manager Parameters |
len | length of data to write |
pValue | pointer to data to write. This is dependent on the parameter ID and WILL be cast to the appropriate data type (example: data type of uint16_t will be cast to uint16_t pointer). |
uint8_t gapBondMgrImportBond | ( | gapBondRec_t * | pBondRec, |
gapBondLTK_t * | pLocalLtk, | ||
gapBondLTK_t * | pDevLtk, | ||
uint8_t * | pIRK, | ||
uint8_t * | pSRK, | ||
uint32_t | signCount, | ||
gapBondCharCfg_t * | charCfg | ||
) |
Import bond record to NV.
pBondRec | - basic bond record |
pLocalLTK | - LTK used by the device that has the same public address as current device |
pDevLTK | - LTK used by the peer device during pairing |
pIRK | - IRK used by the peer device during pairing |
pSRK | - SRK used by the peer device during pairing |
signCounter | - Sign counter used by the peer device during pairing |
charCfg | - GATT characteristic configuration |
uint8_t gapBondMgrReadBondRec | ( | GAP_Peer_Addr_Types_t | addrType, |
uint8_t * | pDevAddr, | ||
gapBondRec_t * | pBondRec, | ||
gapBondLTK_t * | pLocalLtk, | ||
gapBondLTK_t * | pDevLtk, | ||
uint8_t * | pIRK, | ||
uint8_t * | pSRK, | ||
uint32_t | signCount, | ||
gapBondCharCfg_t * | charCfg | ||
) |
Read bond record from NV.
pBondRec | - basic bond record |
pLocalLTK | - LTK used by this device during pairing |
pDevLTK | - LTK used by the peer device during pairing |
pIRK | - IRK used by the peer device during pairing |
pSRK | - SRK used by the peer device during pairing |
signCounter | - Sign counter used by the peer device during pairing |
charCfg | - GATT characteristic configuration |