Bluetooth Low Energy Host Stack  Rev. 4
API Reference Manual
gap_interface.h File Reference
#include "ble_general.h"
#include "gap_types.h"
#include "gatt_types.h"

Macros

#define Gap_AddSecurityModesAndLevels(modeLevelA, modeLevelB)
 
#define Gap_CancelInitiatingConnection()
 
#define Gap_ReadAdvertisingTxPowerLevel()
 
#define Gap_ReadRssi(deviceId)
 
#define Gap_ReadTxPowerLevelInConnection(deviceId)
 

Functions

bleResult_t Gap_RegisterDeviceSecurityRequirements (gapDeviceSecurityRequirements_t *pSecurity)
 
bleResult_t Gap_SetAdvertisingParameters (gapAdvertisingParameters_t *pAdvertisingParameters)
 
bleResult_t Gap_SetAdvertisingData (gapAdvertisingData_t *pAdvertisingData, gapScanResponseData_t *pScanResponseData)
 
bleResult_t Gap_StartAdvertising (gapAdvertisingCallback_t advertisingCallback, gapConnectionCallback_t connectionCallback)
 
bleResult_t Gap_StopAdvertising (void)
 
bleResult_t Gap_Authorize (deviceId_t deviceId, uint16_t handle, gattDbAccessType_t access)
 
bleResult_t Gap_SaveCccd (deviceId_t deviceId, uint16_t handle, gattCccdFlags_t cccd)
 
bleResult_t Gap_CheckNotificationStatus (deviceId_t deviceId, uint16_t handle, bool_t *pOutIsActive)
 
bleResult_t Gap_CheckIndicationStatus (deviceId_t deviceId, uint16_t handle, bool_t *pOutIsActive)
 
bleResult_t Gap_GetBondedStaticAddresses (bleDeviceAddress_t *aOutDeviceAddresses, uint8_t maxDevices, uint8_t *pOutActualCount)
 
bleResult_t Gap_GetBondedDevicesIdentityInformation (gapIdentityInformation_t *aOutIdentityAddresses, uint8_t maxDevices, uint8_t *pOutActualCount)
 
bleResult_t Gap_Pair (deviceId_t deviceId, gapPairingParameters_t *pPairingParameters)
 
bleResult_t Gap_SendSlaveSecurityRequest (deviceId_t deviceId, bool_t bondAfterPairing, gapSecurityModeAndLevel_t securityModeLevel)
 
bleResult_t Gap_EncryptLink (deviceId_t deviceId)
 
bleResult_t Gap_AcceptPairingRequest (deviceId_t deviceId, gapPairingParameters_t *pPairingParameters)
 
bleResult_t Gap_RejectPairing (deviceId_t deviceId, gapAuthenticationRejectReason_t reason)
 
bleResult_t Gap_EnterPasskey (deviceId_t deviceId, uint32_t passkey)
 
bleResult_t Gap_ProvideOob (deviceId_t deviceId, uint8_t *aOob)
 
bleResult_t Gap_RejectPasskeyRequest (deviceId_t deviceId)
 
bleResult_t Gap_SendSmpKeys (deviceId_t deviceId, gapSmpKeys_t *pKeys)
 
bleResult_t Gap_RejectKeyExchangeRequest (deviceId_t deviceId)
 
bleResult_t Gap_LeScRegeneratePublicKey (void)
 
bleResult_t Gap_LeScValidateNumericValue (deviceId_t deviceId, bool_t valid)
 
bleResult_t Gap_LeScGetLocalOobData (void)
 
bleResult_t Gap_LeScSetPeerOobData (deviceId_t deviceId, gapLeScOobData_t *pPeerOobData)
 
bleResult_t Gap_LeScSendKeypressNotification (deviceId_t deviceId, gapKeypressNotification_t keypressNotification)
 
bleResult_t Gap_ProvideLongTermKey (deviceId_t deviceId, uint8_t *aLtk, uint8_t ltkSize)
 
bleResult_t Gap_DenyLongTermKey (deviceId_t deviceId)
 
bleResult_t Gap_LoadEncryptionInformation (deviceId_t deviceId, uint8_t *aOutLtk, uint8_t *pOutLtkSize)
 
bleResult_t Gap_SetLocalPasskey (uint32_t passkey)
 
bleResult_t Gap_SetScanMode (gapScanMode_t scanMode, gapAutoConnectParams_t *pAutoConnectParams)
 
bleResult_t Gap_StartScanning (gapScanningParameters_t *pScanningParameters, gapScanningCallback_t scanningCallback)
 
bleResult_t Gap_StopScanning (void)
 
bleResult_t Gap_Connect (gapConnectionRequestParameters_t *pParameters, gapConnectionCallback_t connCallback)
 
bleResult_t Gap_Disconnect (deviceId_t deviceId)
 
bleResult_t Gap_SaveCustomPeerInformation (deviceId_t deviceId, void *aInfo, uint16_t offset, uint16_t infoSize)
 
bleResult_t Gap_LoadCustomPeerInformation (deviceId_t deviceId, void *aOutInfo, uint16_t offset, uint16_t infoSize)
 
bleResult_t Gap_CheckIfBonded (deviceId_t deviceId, bool_t *pOutIsBonded)
 
bleResult_t Gap_ReadWhiteListSize (void)
 
bleResult_t Gap_ClearWhiteList (void)
 
bleResult_t Gap_AddDeviceToWhiteList (bleAddressType_t addressType, bleDeviceAddress_t address)
 
bleResult_t Gap_RemoveDeviceFromWhiteList (bleAddressType_t addressType, bleDeviceAddress_t address)
 
bleResult_t Gap_ReadPublicDeviceAddress (void)
 
bleResult_t Gap_CreateRandomDeviceAddress (uint8_t *aIrk, uint8_t *aRandomPart)
 
bleResult_t Gap_SaveDeviceName (deviceId_t deviceId, uchar_t *aName, uint8_t cNameSize)
 
bleResult_t Gap_GetBondedDevicesCount (uint8_t *pOutBondedDevicesCount)
 
bleResult_t Gap_GetBondedDeviceName (uint8_t nvmIndex, uchar_t *aOutName, uint8_t maxNameSize)
 
bleResult_t Gap_RemoveBond (uint8_t nvmIndex)
 
bleResult_t Gap_RemoveAllBonds (void)
 
bleResult_t Gap_ReadRadioPowerLevel (gapRadioPowerLevelReadType_t txReadType, deviceId_t deviceId)
 
bleResult_t Gap_SetTxPowerLevel (uint8_t powerLevel, bleTransmitPowerChannelType_t channelType)
 
bleResult_t Gap_VerifyPrivateResolvableAddress (uint8_t nvmIndex, bleDeviceAddress_t aAddress)
 
bleResult_t Gap_SetRandomAddress (bleDeviceAddress_t aAddress)
 
bleResult_t Gap_SetDefaultPairingParameters (gapPairingParameters_t *pPairingParameters)
 
bleResult_t Gap_UpdateConnectionParameters (deviceId_t deviceId, uint16_t intervalMin, uint16_t intervalMax, uint16_t slaveLatency, uint16_t timeoutMultiplier, uint16_t minCeLength, uint16_t maxCeLength)
 
bleResult_t Gap_EnableUpdateConnectionParameters (deviceId_t deviceId, bool_t enable)
 
bleResult_t Gap_UpdateLeDataLength (deviceId_t deviceId, uint16_t txOctets, uint16_t txTime)
 
bleResult_t Gap_ControllerReset (void)
 
bleResult_t Gap_EnableHostPrivacy (bool_t enable, uint8_t *aIrk)
 
bleResult_t Gap_EnableControllerPrivacy (bool_t enable, uint8_t *aOwnIrk, uint8_t peerIdCount, gapIdentityInformation_t *aPeerIdentities)
 
bleResult_t Gap_ControllerTest (gapControllerTestCmd_t testCmd, uint8_t radioChannel, uint8_t txDataLength, gapControllerTestTxType_t txPayloadType)
 

Detailed Description

Copyright (c) 2015, Freescale Semiconductor, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

o Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

o 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.

o Neither the name of Freescale Semiconductor, Inc. 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 HOLDER 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.