bt_hal_manager_adapter_ble.h

Go to the documentation of this file.

/*
 * FreeRTOS BLE HAL V5.1.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */
 
#ifndef _BT_HAL_MANAGER_ADAPTER_BLE_H_
#define _BT_HAL_MANAGER_ADAPTER_BLE_H_
 
#include <stdint.h>
#include "bt_hal_gatt_types.h"
#include "bt_hal_manager_types.h"
#include "bt_hal_manager.h"
 
/* Ble Advertisement Power Levels Index. This index would translate into platform specific values power (bBm) values */
#define BT_HAL_BLE_ADV_TX_PWR_ULTRA_LOW     0              
#define BT_HAL_BLE_ADV_TX_PWR_LOW           1              
#define BT_HAL_BLE_ADV_TX_PWR_MEDIUM        2              
#define BT_HAL_BLE_ADV_TX_PWR_HIGH          3              
#define BT_HAL_BLE_ADV_TX_PWR_ULTRA_HIGH    4              
typedef struct
{
    uint8_t ucAdapterIf;             
    uint8_t ucAction;                
    uint8_t ucFiltIndex;             
    uint16_t usFeatSeln;             
    uint16_t usListLogicType;        
    uint8_t ucFiltLogicType;         
    uint8_t ucRssiHighThres;         
    uint8_t ucRssiLowThres;          
    uint8_t ucDelayMode;             
    uint16_t usFoundTimeout;         
    uint16_t usLostTimeout;          
    uint8_t ucFoundTimeout_cnt;      
    uint16_t usNumOfTrackingEntries; 
} BTGattFiltParamSetup_t;
 
typedef enum
{
    BTAddrTypePublic,
    BTAddrTypeRandom,
    BTAddrTypeStaticRandom,
    BTAddrTypeResolvable,
} BTAddrType_t;
 
typedef enum
{
    BTAdvInd,
    BTAdvDirectInd,
    BTAdvNonconnInd,
} BTAdvProperties_t;
 
typedef struct
{
    enum
    {
        BTGattAdvNameNone,
        BTGattAdvNameShort,
        BTGattAdvNameComplete
    } xType;                
    uint8_t ucShortNameLen; 
} BTGattAdvName_t;
 
/*TODO enum for usAdvertisingEventProperties */
 
typedef struct
{
    BTAdvProperties_t usAdvertisingEventProperties; 
    bool bIncludeTxPower;                           
    BTGattAdvName_t ucName;                         
    bool bSetScanRsp;                               
    uint32_t ulAppearance;                          
    uint32_t ulMinInterval;                         
    uint32_t ulMaxInterval;                         
    uint16_t usMinAdvInterval;                      
    uint16_t usMaxAdvInterval;                      
    uint8_t ucChannelMap;                           
    uint8_t ucTxPower;                              
    uint8_t ucTimeout;                              
    uint16_t usTimeout;                             
    uint8_t ucPrimaryAdvertisingPhy;                
    uint8_t ucSecondaryAdvertisingPhy;              
    BTAddrType_t xAddrType;                         
} BTGattAdvertismentParams_t;
 
typedef struct
{
    uint16_t usVersionSupported;           
    uint8_t ucLocalPrivacyEnabled;         
    uint8_t ucMaxAdvInstance;              
    uint8_t ucRpaOffloadSupported;         
    uint8_t ucMaxIrkListSize;              
    uint8_t ucMaxAdFilterSupported;        
    uint8_t ucActivityEnergyInfoSupported; 
    uint16_t usScanResultStorageSize;      
    uint16_t usTotalTrackableAdvertisers;  
    bool bExtendedScanSupport;             
    bool bDebugLoggingSupported;           
} BTLocalLeFeatures_t;
 
typedef enum
{
    eBTPropertyLocalLeFeatures,
} BTBlePropertyType_t;
 
typedef struct
{
    BTBlePropertyType_t xType; 
    size_t xLen;               
    void * pvVal;              
} BTBleProperty_t;
 
typedef void (* BTRegisterBleAdapterCallback_t)( BTStatus_t xStatus,
                                                 uint8_t ucAdapterIf,
                                                 BTUuid_t * pxAppUuid );
 
typedef void (* BTBleDevicePropertiesCallback_t)( BTStatus_t xStatus,
                                                  uint32_t ulNumProperties,
                                                  BTBleProperty_t * pxProperties );
 
typedef void (* BTBleRemoteDevicePropertiesCallback_t)( BTStatus_t xStatus,
                                                        BTBdaddr_t * pxBdAddr,
                                                        uint32_t ulNumProperties,
                                                        BTBleProperty_t * pxProperties );
 
typedef void (* BTScanResultCallback_t)( BTBdaddr_t * pxBda,
                                         uint32_t ulRssi,
                                         uint8_t * pucAdvData );
 
typedef void (* BTAdvStatusCallback_t)( BTStatus_t xStatus,
                                        uint8_t ucAdapterIf,
                                        bool bStart );
 
typedef void (* BTSetAdvDataCallback_t) ( BTStatus_t xStatus );
 
typedef void ( * BTConnParameterUpdateCallback_t )( BTStatus_t xStatus,
                                                    const BTBdaddr_t * pxBdAddr,
                                                    uint32_t ulMinInterval,
                                                    uint32_t ulMaxInterval,
                                                    uint32_t ulLatency,
                                                    uint32_t usConnInterval,
                                                    uint32_t ulTimeout );
 
typedef void (* BTScanFilterCfgCallback_t)( uint32_t ulAction,
                                            uint8_t ucAdapterIf,
                                            BTStatus_t xStatus,
                                            uint32_t ulFiltType,
                                            uint32_t ulAvblSpace );
 
typedef void (* BTScanFilterParamCallback_t)( uint32_t ulAction,
                                              uint8_t ucAdapterIf,
                                              BTStatus_t xStatus,
                                              uint32_t ulAvblSpace );
 
typedef void (* BTScanFilterStatusCallback_t)( bool bEnable,
                                               uint8_t ucAdapterIf,
                                               BTStatus_t xStatus );
 
typedef void (* BTMultiAdvEnableCallback_t)( uint8_t ucAdapterIf,
                                             BTStatus_t xStatus );
 
typedef void (* BTMultiAdvUpdateCallback_t)( uint8_t ucAdapterIf,
                                             BTStatus_t xStatus );
 
typedef void (* BTMultiAdvDataCallback_t)( uint8_t ucAdapterIf,
                                           BTStatus_t xStatus );
 
 
typedef void (* BTMultiAdvDisableCallback_t)( uint8_t ucAdapterIf,
                                              BTStatus_t xStatus );
 
typedef void (* BTBatchscanCfgStorageCallback_t)( uint8_t ucAdapterIf,
                                                  BTStatus_t xStatus );
 
typedef void (* BTBatchscanEnableDisableCallback_t)( uint32_t ulAction,
                                                     uint8_t ucAdapterIf,
                                                     BTStatus_t xStatus );
 
typedef void (* BTBatchscanReportsCallback_t)( uint8_t ucAdapterIf,
                                               BTStatus_t xStatus,
                                               uint32_t ulReportFormat,
                                               uint32_t ulNumRecords,
                                               size_t XDataLen,
                                               uint8_t * pucRepData );
 
typedef void (* BTBatchscanThresholdCallback_t)( uint8_t ucAdapterIf );
 
typedef void (* BTTrackAdvEventCallback_t)( BTGattTrackAdvInfo_t * pxTrackAdvInfo );
 
 
typedef void (* BTScanParameterSetupCompletedCallback_t)( uint8_t ucAdapterIf,
                                                          BTStatus_t xStatus );
 
typedef void (* BTPhyUpdatedCallback_t)( uint16_t usConnId,
                                         uint8_t ucTxPhy,
                                         uint8_t ucRxPhy,
                                         BTStatus_t xStatus );
 
typedef void (* BTReadClientPhyCallback_t)( uint16_t usConnId,
                                            uint8_t ucTxPhy,
                                            uint8_t ucRxPhy,
                                            BTStatus_t xStatus );
 
typedef struct
{
    BTRegisterBleAdapterCallback_t pxRegisterBleAdapterCb;                   
    BTScanResultCallback_t pxScanResultCb;                                   
    BTBleDevicePropertiesCallback_t pxBleAdapterPropertiesCb;                
    BTBleRemoteDevicePropertiesCallback_t pxBleRemoteDevicePropertiesCb;     
    BTConnectCallback_t pxOpenCb;                                            
    BTDisconnectCallback_t pxCloseCb;                                        
    BTReadRemoteRssiCallback_t pxReadRemoteRssiCb;                           
    BTAdvStatusCallback_t pxAdvStatusCb;                                     
    BTSetAdvDataCallback_t pxSetAdvDataCb;                                   
    BTConnParameterUpdateCallback_t pxConnParameterUpdateCb;                 
    BTScanFilterCfgCallback_t pxScanFilterCfgCb;                             
    BTScanFilterParamCallback_t pxScanFilterParamCb;                         
    BTScanFilterStatusCallback_t pxScanFilterStatusCb;                       
    BTMultiAdvEnableCallback_t pxMultiAdvEnableCb;                           
    BTMultiAdvUpdateCallback_t pxMultiAdvUpdateCb;                           
    BTMultiAdvDataCallback_t pxMultiAdvDataCb;                               
    BTMultiAdvDisableCallback_t pxMultiAdvDisableCb;                         
    BTCongestionCallback_t pxCongestionCb;                                   
    BTBatchscanCfgStorageCallback_t pxBatchscanCfgStorageCb;                 
    BTBatchscanEnableDisableCallback_t pxBatchscanEnbDisableCb;              
    BTBatchscanReportsCallback_t pxBatchscanReportsCb;                       
    BTBatchscanThresholdCallback_t pxBatchscanThresholdCb;                   
    BTTrackAdvEventCallback_t pxTrackAdvEventCb;                             
    BTScanParameterSetupCompletedCallback_t pxScanParameterSetupCompletedCb; 
    BTPhyUpdatedCallback_t pxPhyUpdatedCb;                                   
} BTBleAdapterCallbacks_t;
 
 
typedef struct
{
    BTStatus_t ( * pxRegisterBleApp )( BTUuid_t * pxAppUuid );
 
    BTStatus_t ( * pxUnregisterBleApp )( uint8_t ucAdapterIf );
 
    BTStatus_t ( * pxBleAdapterInit )( const BTBleAdapterCallbacks_t * pxCallbacks );
 
    BTStatus_t ( * pxGetBleAdapterProperty )( BTBlePropertyType_t xType );
 
    BTStatus_t ( * pxSetBleAdapterProperty )( const BTBleProperty_t * pxProperty );
 
    BTStatus_t ( * pxGetallBleRemoteDeviceProperties )( BTBdaddr_t * pxRremoteAddr );
 
    BTStatus_t ( * pxGetBleRemoteDeviceProperty )( BTBdaddr_t * pxRemoteAddr,
                                                   BTBleProperty_t xType );
 
    BTStatus_t ( * pxSetBleRemoteDeviceProperty )( BTBdaddr_t * pxRemoteAddr,
                                                   const BTBleProperty_t * pxProperty );
 
    BTStatus_t ( * pxScan )( bool bStart );
 
    BTStatus_t ( * pxConnect )( uint8_t ucAdapterIf,
                                const BTBdaddr_t * pxBdAddr,
                                bool bIsDirect,
                                BTTransport_t ulTransport );
 
    BTStatus_t ( * pxDisconnect )( uint8_t ucAdapterIf,
                                   const BTBdaddr_t * pxBdAddr,
                                   uint16_t usConnId );
 
    BTStatus_t ( * pxStartAdv )( uint8_t ucAdapterIf );
 
    BTStatus_t ( * pxStopAdv )( uint8_t ucAdapterIf );
 
    BTStatus_t ( * pxReadRemoteRssi )( uint8_t ucAdapterIf,
                                       const BTBdaddr_t * pxBdAddr );
 
    BTStatus_t ( * pxScanFilterParamSetup )( BTGattFiltParamSetup_t xFiltParam );
 
    BTStatus_t ( * pxScanFilterAddRemove )( uint8_t ucAdapterIf,
                                            uint32_t ulAction,
                                            uint32_t ulFiltType,
                                            uint32_t ulFiltIndex,
                                            uint32_t ulCompanyId,
                                            uint32_t ulCompanyIdMask,
                                            const BTUuid_t * pxUuid,
                                            const BTUuid_t * pxUuidMask,
                                            const BTBdaddr_t * pxBdAddr,
                                            char cAddrType,
                                            size_t xDataLen,
                                            char * pcData,
                                            size_t xMaskLen,
                                            char * pcMask );
 
    BTStatus_t ( * pxScanFilterClear )( uint8_t ucAdapterIf,
                                        uint32_t ulFiltIndex );
 
    BTStatus_t ( * pxScanFilterEnable )( uint8_t ucAdapterIf,
                                         bool bEnable );
 
    BTTransport_t ( * pxGetDeviceType )( const BTBdaddr_t * pxBdAddr );
 
    BTStatus_t ( * pxSetAdvData )( uint8_t ucAdapterIf,
                                   BTGattAdvertismentParams_t * pxParams,
                                   uint16_t usManufacturerLen,
                                   char * pcManufacturerData,
                                   uint16_t usServiceDataLen,
                                   char * pcServiceData,
                                   BTUuid_t * pxServiceUuid,
                                   size_t xNbServices );
 
    BTStatus_t ( * pxSetAdvRawData )( uint8_t ucAdapterIf,
                                      uint8_t * pucData,
                                      uint8_t ucLen );
 
    BTStatus_t ( * pxConnParameterUpdateRequest )( const BTBdaddr_t * pxBdAddr,
                                                   uint32_t ulMinInterval,
                                                   uint32_t ulMaxInterval,
                                                   uint32_t ulLatency,
                                                   uint32_t ulTimeout );
 
    BTStatus_t ( * pxSetScanParameters )( uint8_t ucAdapterIf,
                                          uint32_t ulScanInterval,
                                          uint32_t ulScanWindow );
 
    BTStatus_t ( * pxMultiAdvEnable )( uint8_t ucAdapterIf,
                                       BTGattAdvertismentParams_t * xAdvParams );
 
    BTStatus_t ( * pxMultiAdvUpdate )( uint8_t ucAdapterIf,
                                       BTGattAdvertismentParams_t * advParams );
 
    BTStatus_t ( * pxMultiAdvSetInstData )( uint8_t ucAdapterIf,
                                            bool bSetScanRsp,
                                            bool bIncludeName,
                                            bool bInclTxpower,
                                            uint32_t ulAppearance,
                                            size_t xManufacturerLen,
                                            char * pcManufacturerData,
                                            size_t xServiceDataLen,
                                            char * pcServiceData,
                                            BTUuid_t * pxServiceUuid,
                                            size_t xNbServices );
 
    BTStatus_t ( * pxMultiAdvDisable )( uint8_t ucAdapterIf );
 
    BTStatus_t ( * pxBatchscanCfgStorage )( uint8_t ucAdapterIf,
                                            uint32_t ulBatchScanFullMax,
                                            uint32_t ulBatchScanTruncMax,
                                            uint32_t ulBatchScanNotifyThreshold );
 
    BTStatus_t ( * pxBatchscanEndBatchScan )( uint8_t ucAdapterIf,
                                              uint32_t ulScanMode,
                                              uint32_t ulScanInterval,
                                              uint32_t ulScanWindow,
                                              uint32_t ulAddrType,
                                              uint32_t ulDiscardRule );
 
    BTStatus_t ( * pxBatchscanDisBatchScan )( uint8_t ucAdapterIf );
 
    BTStatus_t ( * pxBatchscanReadReports )( uint8_t ucAdapterIf,
                                             uint32_t ulScanMode );
 
    BTStatus_t ( * pxSetPreferredPhy )( uint16_t usConnId,
                                        uint8_t ucTxPhy,
                                        uint8_t ucRxPhy,
                                        uint16_t usPhyOptions );
 
    BTStatus_t ( * pxReadPhy )( uint16_t usConnId,
                                BTReadClientPhyCallback_t xCb );
 
    const void * ( *ppvGetGattClientInterface )( );
 
    const void * ( *ppvGetGattServerInterface )( );
 
    BTStatus_t ( * pxMultiAdvSetInstRawData )( uint8_t ucAdapterIf,
                                               bool bSetScanRsp,
                                               uint8_t * pucData,
                                               size_t xDataLen );
 
    BTStatus_t ( * pxSetBgScanParameters )( uint8_t ucAdapterIf,
                                            uint32_t ulScanIntervalTime,
                                            uint32_t ulScanWindowTime );
} BTBleAdapter_t;
 
#endif /* #ifndef _BT_HAL_MANAGER_ADAPTER_BLE_H_ */