bt_hal_gatt_server.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_GATT_SERVER_H_
#define _BT_HAL_GATT_SERVER_H_
 
#include "bt_hal_gatt_types.h"
 
 
typedef enum
{
    eBTRspErrorNone = 0,         
    eBTRspErrorNo_mitm = 1,      
    eBTRspErrorMitm = 2,         
    eBTRspErrorSignedNoMitm = 3, 
    eBTRspErrorSignedMitm = 4,   
} BTRspErrorStatus_t;
 
typedef struct
{
    uint16_t usHandle;                  
    uint8_t * pucValue;                 
    uint16_t usOffset;                  
    size_t xLen;                        
    BTRspErrorStatus_t xRspErrorStatus; 
} BTGattValue_t;
 
typedef union
{
    BTGattValue_t xAttrValue; 
    uint16_t usHandle;        
} BTGattResponse_t;
 
typedef void (* BTRegisterServerCallback_t)( BTStatus_t xStatus,
                                             uint8_t ucServerIf,
                                             BTUuid_t * pxAppUuid );
 
typedef void (* BTUnregisterServerCallback_t)( BTStatus_t xStatus,
                                               uint8_t ucServerIf );
 
typedef void (* BTConnectionCallback_t)( uint16_t usConnId,
                                         uint8_t ucServerIf,
                                         bool bConnected,
                                         BTBdaddr_t * pxBda );
 
typedef void (* BTServiceAddedCallback_t)( BTStatus_t xStatus,
                                           uint8_t ucServerIf,
                                           BTGattSrvcId_t * pxSrvcId,
                                           uint16_t usServiceHandle );
 
typedef void (* BTIncludedServiceAddedCallback_t)( BTStatus_t xStatus,
                                                   uint8_t ucServerIf,
                                                   uint16_t usServiceHandle,
                                                   uint16_t usInclSrvcHandle );
 
typedef void (* BTCharacteristicAddedCallback_t)( BTStatus_t xStatus,
                                                  uint8_t ucServerIf,
                                                  BTUuid_t * pxUuid,
                                                  uint16_t usServiceHandle,
                                                  uint16_t usCharHandle );
 
typedef void (* BTSetValCallback_t)( BTStatus_t xStatus,
                                     uint16_t usAttrHandle );
 
typedef void (* BTDescriptorAddedCallback_t)( BTStatus_t xStatus,
                                              uint8_t ucServerIf,
                                              BTUuid_t * pxUuid,
                                              uint16_t usServiceHandle,
                                              uint16_t usDescrHandle );
 
typedef void (* BTServiceStartedCallback_t)( BTStatus_t xStatus,
                                             uint8_t ucServerIf,
                                             uint16_t usServiceHandle );
 
typedef void (* BTServiceStoppedCallback_t)( BTStatus_t xStatus,
                                             uint8_t ucServerIf,
                                             uint16_t usServiceHandle );
 
typedef void (* BTServiceDeletedCallback_t)( BTStatus_t xStatus,
                                             uint8_t ucServerIf,
                                             uint16_t usServiceHandle );
 
typedef void (* BTRequestReadCallback_t)( uint16_t usConnId,
                                          uint32_t ulTransId,
                                          BTBdaddr_t * pxBda,
                                          uint16_t usAttrHandle,
                                          uint16_t usOffset );
 
typedef void (* BTRequestWriteCallback_t)( uint16_t usConnId,
                                           uint32_t ulTransId,
                                           BTBdaddr_t * pxBda,
                                           uint16_t usAttrHandle,
                                           uint16_t usOffset,
                                           size_t xLength,
                                           bool bNeedRsp,
                                           bool bIsPrep,
                                           uint8_t * pucValue );
 
typedef void (* BTRequestExecWriteCallback_t)( uint16_t usConnId,
                                               uint32_t ulTransId,
                                               BTBdaddr_t * pxBda,
                                               bool bExecWrite );
 
typedef void (* BTResponseConfirmationCallback_t)( BTStatus_t xStatus,
                                                   uint16_t usHandle );
 
typedef void (* BTIndicationSentCallback_t)( uint16_t usConnId,
                                             BTStatus_t xStatus );
 
typedef void (* BTMtuChangedCallback_t)( uint16_t usConnId,
                                         uint16_t usMtu );
 
typedef void (* BTWhiteListChangedCallback_t)( const BTBdaddr_t * pxBdAddr,
                                               bool bIsAdded );
 
typedef struct
{
    BTRegisterServerCallback_t pxRegisterServerCb;             
    BTUnregisterServerCallback_t pxUnregisterServerCb;         
    BTConnectionCallback_t pxConnectionCb;                     
    BTServiceAddedCallback_t pxServiceAddedCb;                 
    BTIncludedServiceAddedCallback_t pxIncludedServiceAddedCb; 
    BTCharacteristicAddedCallback_t pxCharacteristicAddedCb;   
    BTSetValCallback_t pxSetValCallbackCb;                     
    BTDescriptorAddedCallback_t pxDescriptorAddedCb;           
    BTServiceStartedCallback_t pxServiceStartedCb;             
    BTServiceStoppedCallback_t pxServiceStoppedCb;             
    BTServiceDeletedCallback_t pxServiceDeletedCb;             
    BTRequestReadCallback_t pxRequestReadCb;                   
    BTRequestWriteCallback_t pxRequestWriteCb;                 
    BTRequestExecWriteCallback_t pxRequestExecWriteCb;         
    BTResponseConfirmationCallback_t pxResponseConfirmationCb; 
    BTIndicationSentCallback_t pxIndicationSentCb;             
    BTCongestionCallback_t pxCongestionCb;                     
    BTMtuChangedCallback_t pxMtuChangedCb;                     
    BTWhiteListChangedCallback_t pxBTWhiteListChangedCb;       
} BTGattServerCallbacks_t;
 
typedef struct
{
    BTStatus_t ( * pxRegisterServer )( BTUuid_t * pxUuid );
 
    BTStatus_t ( * pxUnregisterServer )( uint8_t ucServerIf );
 
    BTStatus_t ( * pxGattServerInit )( const BTGattServerCallbacks_t * pxCallbacks );
 
    BTStatus_t ( * pxConnect )( uint8_t ucServerIf,
                                const BTBdaddr_t * pxBdAddr,
                                bool bIsDirect,
                                BTTransport_t xTransport );
 
    BTStatus_t ( * pxDisconnect )( uint8_t ucServerIf,
                                   const BTBdaddr_t * pxBdAddr,
                                   uint16_t usConnId );
 
    BTStatus_t ( * pxAddServiceBlob )( uint8_t ucServerIf,
                                       BTService_t * pxService );
 
    BTStatus_t ( * pxAddService )( uint8_t ucServerIf,
                                   BTGattSrvcId_t * pxSrvcId,
                                   uint16_t usNumHandles );
 
    BTStatus_t ( * pxAddIncludedService )( uint8_t ucServerIf,
                                           uint16_t usServiceHandle,
                                           uint16_t usIncludedHandle );
 
    BTStatus_t ( * pxAddCharacteristic )( uint8_t ucServerIf,
                                          uint16_t usServiceHandle,
                                          BTUuid_t * pxUuid,
                                          BTCharProperties_t xProperties,
                                          BTCharPermissions_t xPermissions );
 
    BTStatus_t ( * pxSetVal )( BTGattResponse_t * pxValue );
 
    BTStatus_t ( * pxAddDescriptor )( uint8_t ucServerIf,
                                      uint16_t usServiceHandle,
                                      BTUuid_t * pxUuid,
                                      BTCharPermissions_t ulPermissions );
 
    BTStatus_t ( * pxStartService )( uint8_t ucServerIf,
                                     uint16_t usServiceHandle,
                                     BTTransport_t xTransport );
 
    BTStatus_t ( * pxStopService )( uint8_t ucServerIf,
                                    uint16_t usServiceHandle );
 
    BTStatus_t ( * pxDeleteService )( uint8_t ucServerIf,
                                      uint16_t usServiceHandle );
 
    BTStatus_t ( * pxSendIndication )( uint8_t ucServerIf,
                                       uint16_t usAttributeHandle,
                                       uint16_t usConnId,
                                       size_t xLen,
                                       uint8_t * pucValue,
                                       bool bConfirm );
 
    BTStatus_t ( * pxSendResponse )( uint16_t usConnId,
                                     uint32_t ulTransId,
                                     BTStatus_t xStatus,
                                     BTGattResponse_t * pxResponse );
 
    BTStatus_t ( * pxReconnect )( uint8_t ucServerIf,
                                  const BTBdaddr_t * pxBdAddr );
 
    BTStatus_t ( * pxAddDevicesToWhiteList )( uint8_t ucServerIf,
                                              const BTBdaddr_t * pxBdAddr,
                                              uint32_t ulNumberOfDevices );
 
    BTStatus_t ( * pxRemoveDevicesFromWhiteList )( uint8_t ucServerIf,
                                                   const BTBdaddr_t * pxBdAddr,
                                                   uint32_t ulNumberOfDevices );
 
    BTStatus_t ( * pxConfigureMtu )( uint8_t ucServerIf,
                                     uint16_t usMtu );
} BTGattServerInterface_t;
 
#endif /* _BT_HAL_GATT_SERVER_H_ */