iot_ble.h

Go to the documentation of this file.

/*
 * FreeRTOS BLE V2.1.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * 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 _AWS_BLE_H_
#define _AWS_BLE_H_
 
#include <stddef.h>
#include "bt_hal_manager_adapter_ble.h"
#include "bt_hal_manager.h"
#include "bt_hal_gatt_server.h"
#include "bt_hal_gatt_types.h"
#include "iot_ble_config.h"
#include "iot_linear_containers.h"
 
typedef struct
{
    uint32_t appearance;      
    uint32_t minInterval;     
    uint32_t maxInterval;     
    char * pManufacturerData; 
    char * pServiceData;      
    BTUuid_t * pUUID1;        
    BTUuid_t * pUUID2;        
    uint16_t manufacturerLen; 
    uint16_t serviceDataLen;  
    bool includeTxPower;      
    BTGattAdvName_t name;     
    bool setScanRsp;          
} IotBleAdvertisementParams_t;
 
typedef struct
{
    uint32_t minInterval; 
    uint32_t maxInterval; 
    uint32_t latency;     
    uint32_t timeout;     
} IotBleConnectionParam_t;
 
 
typedef struct
{
    IotLink_t connectionList;                 
    IotBleConnectionParam_t connectionParams; 
    BTBdaddr_t remoteBdAddr;                  
    BTSecurityLevel_t securityLevel;          
    IotLink_t clientCharDescrListHead;        
    uint16_t connId;                          
    bool isBonded;                            
} IotBleConnectionInfoListElement_t;
 
typedef enum
{
    eBLERead,                      
    eBLEWrite,                     
    eBLEWriteNoResponse,           
    eBLEWritePrepare,              
    eBLEExecWrite,                 
    eBLEResponseConfirmation,      
    eBLEIndicationConfirmReceived, 
} IotBleAttributeEventType_t;
 
typedef struct IotBleAttributeEvent IotBleAttributeEvent_t;
 
 
typedef void (* IotBleAttributeEventCallback_t)( IotBleAttributeEvent_t * pEventParam );
 
/************************************************************/
 
typedef struct
{
    uint16_t connId;            
    uint32_t transId;           
    BTBdaddr_t * pRemoteBdAddr; 
    uint16_t attrHandle;        
    uint16_t offset;            
} IotBleReadEventParams_t;
 
typedef struct
{
    uint32_t transId;           
    BTBdaddr_t * pRemoteBdAddr; 
    uint8_t * pValue;           
    uint32_t length;            
    uint16_t connId;            
    uint16_t attrHandle;        
    uint16_t offset;            
    bool needRsp;               
    bool isPrep;                
} IotBleWriteEventParams_t;
 
typedef struct
{
    uint32_t transId;           
    BTBdaddr_t * pRemoteBdAddr; 
    uint16_t connId;            
    bool execWrite;             
} IotBleExecWriteEventParams_t;
 
typedef struct
{
    BTStatus_t status; 
    uint16_t handle;   
} IotBleRespConfirmEventParams_t;
 
typedef struct
{
    BTAttribute_t * pAttribute; 
    uint16_t connId;            
    BTStatus_t status;          
} IotBleIndicationSentEventParams_t;
 
struct IotBleAttributeEvent
{
    union
    {
        IotBleReadEventParams_t * pParamRead;                     
        IotBleWriteEventParams_t * pParamWrite;                   
        IotBleExecWriteEventParams_t * pParamExecWrite;           
        IotBleRespConfirmEventParams_t * pParamRespConfirm;       
        IotBleIndicationSentEventParams_t * pParamIndicationSent; 
    };
    IotBleAttributeEventType_t xEventType;                        
};
 
typedef struct
{
    size_t size;     
    uint8_t * pData; 
    BTUuid_t uuid;   
    size_t handle;   
} IotBleAttributeData_t;
 
typedef struct
{
    IotBleAttributeData_t * pAttrData; 
    size_t attrDataOffset;             
    BTStatus_t eventStatus;            
    BTRspErrorStatus_t rspErrorStatus; 
} IotBleEventResponse_t;
 
typedef void (* IotBle_MtuChangedCallback_t)( uint16_t connId,
                                              uint16_t mtu );
 
typedef void (* IotBle_ConnectionCallback_t)( BTStatus_t status,
                                              uint16_t connId,
                                              bool connected,
                                              BTBdaddr_t * pRemoteBdAddr );
 
typedef void (* IotBle_StartAdvCallback_t)( BTStatus_t status );
 
typedef void (* IotBle_StopAdvCallback_t)( BTStatus_t status );
 
typedef void ( * IotBle_ConnParameterUpdateRequestCallback_t )( BTStatus_t status,
                                                                const BTBdaddr_t * pRemoteBdAddr,
                                                                IotBleConnectionParam_t * pConnectionParam,
                                                                uint32_t connInterval );
 
typedef void (* IotBle_PairingStateChanged_t)( BTStatus_t status,
                                               BTBdaddr_t * pRemoteBdAddr,
                                               BTBondState_t bondstate,
                                               BTSecurityLevel_t securityLevel,
                                               BTAuthFailureReason_t reason );
 
typedef void ( * IotBle_NumericComparisonCallback_t )( BTBdaddr_t * pRemoteBdAddr,
                                                       uint32_t passKey );
 
typedef enum
{
    eBLEMtuChanged,                         
    eBLEConnection,                         
    eBLEPairingStateChanged,                
    eBLEConnParameterUpdateRequestCallback, 
    eBLENumericComparisonCallback,          
    eNbEvents,                              
} IotBleEvents_t;
 
typedef union
{
    IotBle_MtuChangedCallback_t pMtuChangedCb;                                 
    IotBle_ConnectionCallback_t pConnectionCb;                                 
    IotBle_PairingStateChanged_t pGAPPairingStateChangedCb;                    
    IotBle_ConnParameterUpdateRequestCallback_t pConnParameterUpdateRequestCb; 
    IotBle_NumericComparisonCallback_t pNumericComparisonCb;                   
    void * pvPtr;                                                              
} IotBleEventsCallbacks_t;
 
 
#if ( IOT_BLE_ADD_CUSTOM_SERVICES == 1 )
 
    void IotBle_AddCustomServicesCb( void );
#endif
 
#if ( IOT_BLE_SET_CUSTOM_ADVERTISEMENT_MSG == 1 )
 
    void IotBle_SetCustomAdvCb( IotBleAdvertisementParams_t * pAdvParams,
                                IotBleAdvertisementParams_t * pScanParams );
#endif
 
/* @[declare_iotble_init] */
BTStatus_t IotBle_Init( void );
/* @[declare_iotble_init] */
 
/* @[declare_iotble_on] */
BTStatus_t IotBle_On( void );
/* @[declare_iotble_on] */
 
/* @[declare_iotble_off] */
BTStatus_t IotBle_Off( void );
/* @[declare_iotble_off] */
 
/* @[declare_iotble_startadv] */
BTStatus_t IotBle_StartAdv( IotBle_StartAdvCallback_t pStartAdvCb );
/* @[declare_iotble_startadv] */
 
/* @[declare_iotble_stopadv] */
BTStatus_t IotBle_StopAdv( IotBle_StopAdvCallback_t pStopAdvCb );
/* @[declare_iotble_stopadv] */
 
/* @[declare_iotble_connparameterupdaterequest] */
BTStatus_t IotBle_ConnParameterUpdateRequest( const BTBdaddr_t * pRemoteBdAddr,
                                              IotBleConnectionParam_t * pConnectionParam );
/* @[declare_iotble_connparameterupdaterequest] */
 
 
/* @[declare_iotble_registereventcb] */
BTStatus_t IotBle_RegisterEventCb( IotBleEvents_t event,
                                   IotBleEventsCallbacks_t bleEventsCallbacks );
/* @[declare_iotble_registereventcb] */
 
/* @[declare_iotble_unregistereventcb] */
BTStatus_t IotBle_UnRegisterEventCb( IotBleEvents_t event,
                                     IotBleEventsCallbacks_t bleEventsCallbacks );
/* @[declare_iotble_unregistereventcb] */
 
/* @[declare_iotble_removebond] */
BTStatus_t IotBle_RemoveBond( const BTBdaddr_t * pRemoteBdAddr );
/* @[declare_iotble_removebond] */
 
/* @[declare_iotble_createservice] */
BTStatus_t IotBle_CreateService( BTService_t * pService,
                                 IotBleAttributeEventCallback_t pEventsCallbacks[] );
/* @[declare_iotble_createservice] */
 
/* @[declare_iotble_deleteservice] */
BTStatus_t IotBle_DeleteService( BTService_t * pService );
/* @[declare_iotble_deleteservice] */
 
/* @[declare_iotble_sendindication] */
BTStatus_t IotBle_SendIndication( IotBleEventResponse_t * pResp,
                                  uint16_t connId,
                                  bool confirm );
/* @[declare_iotble_sendindication] */
 
/* @[declare_iotble_sendresponse] */
BTStatus_t IotBle_SendResponse( IotBleEventResponse_t * pResp,
                                uint16_t connId,
                                uint32_t transId );
/* @[declare_iotble_sendresponse] */
 
/* @[declare_iotble_getconnectioninfolist] */
BTStatus_t IotBle_GetConnectionInfoList( IotLink_t ** pConnectionInfoList );
/* @[declare_iotble_getconnectioninfolist] */
 
/* @[declare_iotble_getconnectioninfo] */
BTStatus_t IotBle_GetConnectionInfo( uint16_t connId,
                                     IotBleConnectionInfoListElement_t ** pConnectionInfo );
/* @[declare_iotble_getconnectioninfo] */
 
/* @[declare_iotble_confirmnumericcomparisonkeys] */
BTStatus_t IotBle_ConfirmNumericComparisonKeys( BTBdaddr_t * pBdAddr,
                                                bool keyAccepted );
/* @[declare_iotble_confirmnumericcomparisonkeys] */
 
 
/* @[declare_iotble_setdevicename] */
BTStatus_t IotBle_SetDeviceName( const char * pName,
                                 size_t length );
/* @[declare_iotble_setdevicename] */
 
#endif /* _AWS_BLE_H_*/