bt_hal_gatt_client.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.
 *
 * 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_CLIENT_H_
#define _BT_HAL_GATT_CLIENT_H_

#include <stdint.h>
#include "bt_hal_gatt_types.h"
#include "bt_hal_manager_types.h"


typedef struct
{
    uint8_t ucValue[ btGATT_MAX_ATTR_LEN ];
    uint16_t usLen;
} BTGattUnformattedValue_t;

typedef struct
{
    uint16_t usHandle;
    BTGattUnformattedValue_t xValue;
    uint16_t usValueType;
    uint8_t ucStatus;
} BTGattReadParams_t;

typedef struct
{
    BTGattSrvcId_t xSrvcId;
    BTGattInstanceId_t xCharId;
    BTGattInstanceId_t xDescrId;
    uint8_t ucStatus;
} BTGattWriteParams_t;

typedef struct
{
    uint8_t ucValue[ btGATT_MAX_ATTR_LEN ];
    BTBdaddr_t xBda;
    uint16_t usHandle;
    size_t xLen;
    bool bIsNotify;
} BTGattNotifyParams_t;

typedef struct
{
    BTBdaddr_t * pxBda1;
    BTUuid_t * pxUuid1;
    uint16_t usU1;
    uint16_t usU2;
    uint16_t usU3;
    uint16_t usU4;
    uint16_t usU5;
} BTGattTestParams_t;


typedef enum
{
    eBTGattcCommandSuccess = 0,           
    eBTGattcCommandStarted = 1,           
    eBTGattcCommandBusy = 2,              
    eBTGattcCommandStored = 3,            
    eBTGattcNoResources = 4,              
    eBTGattcModeUnsupported = 5,          
    eBTGattcIllegalValue = 6,             
    eBTGattcIncorrectState = 7,           
    eBTGattcUnknownAddr = 8,              
    eBTGattcDeviceTimeout = 9,            
    eBTGattcInvalidControllerOutput = 10, 
    eBTGattcSecurityError = 11,           
    eBTGattcDelayedEncryptionCheck = 12,  
    eBTGattcErrProcessing = 13            
} BTGattcError_t;

typedef void ( * BTRegisterClientCallback_t)( BTGattStatus_t xStatus,
                                              uint8_t ucClientIf,
                                              BTUuid_t * pxAppUuid );

typedef void ( * BTSearchCompleteCallback_t)( uint16_t usConnId,
                                              BTGattStatus_t xStatus );

typedef void ( * BTRegisterForNotificationCallback_t)( uint16_t usConnId,
                                                       bool bRegistered,
                                                       BTGattStatus_t xStatus,
                                                       uint16_t usHandle );

typedef void ( * BTNotifyCallback_t)( uint16_t usConnId,
                                      BTGattNotifyParams_t * pxData );

typedef void ( * BTReadCharacteristicCallback_t)( uint16_t usConnId,
                                                  BTGattStatus_t xStatus,
                                                  BTGattReadParams_t * pxData );

typedef void ( * BTWriteCharacteristicCallback_t)( uint16_t usConnId,
                                                   BTGattStatus_t xStatus,
                                                   uint16_t usHandle );

typedef void ( * BTExecuteWriteCallback_t)( uint16_t usConnId,
                                            BTGattStatus_t xStatus );

typedef void ( * BTReadDescriptorCallback_t)( uint16_t usConnId,
                                              BTGattStatus_t xStatus,
                                              BTGattReadParams_t * pxData );

typedef void ( * BTWriteDescriptorCallback_t)( uint16_t usConnId,
                                               BTGattStatus_t xStatus,
                                               uint16_t usHandle );

typedef void ( * BTListenCallback_t)( BTGattStatus_t xStatus,
                                      uint32_t ulServerIf );

typedef void ( * BTConfigureMtuCallback_t)( uint16_t usConnId,
                                            BTGattStatus_t xStatus,
                                            uint32_t ulMtu );

typedef void ( * BTGetGattDbCallback_t)( uint16_t usConnId,
                                         BTGattDbElement_t * pxDb,
                                         uint32_t ulCount );

typedef void ( * BTServicesRemovedCallback_t)( uint16_t usConnId,
                                               uint16_t usStartHandle,
                                               uint16_t usEndHandle );

typedef void ( * BTServicesAddedCallback_t)( uint16_t usConnId,
                                             BTGattDbElement_t * pxAdded,
                                             uint32_t ulAddedCount );

typedef struct
{
    BTRegisterClientCallback_t pxRegisterClientCb;
    BTConnectCallback_t pxOpenCb;
    BTDisconnectCallback_t pxCloseCb;
    BTSearchCompleteCallback_t pxSearchCompleteCb;
    BTRegisterForNotificationCallback_t pxRegisterForNotificationCb;
    BTNotifyCallback_t pxNotifyCb;
    BTReadCharacteristicCallback_t pxReadCharacteristicCb;
    BTWriteCharacteristicCallback_t pxWriteCharacteristicCb;
    BTReadDescriptorCallback_t pxReadDescriptorCb;
    BTWriteDescriptorCallback_t pxWriteDescriptorCb;
    BTExecuteWriteCallback_t pxExecuteWriteCb;
    BTReadRemoteRssiCallback_t pxReadRemoteRssiCb;
    BTListenCallback_t pxListenCb; 
    BTConfigureMtuCallback_t pxConfigureMtuCb;
    BTCongestionCallback_t pxCongestionCb;
    BTGetGattDbCallback_t pxGetGattDbCb;
    BTServicesRemovedCallback_t pxServicesRemovedCb;
    BTServicesAddedCallback_t pxServicesAddedCb;
} BTGattClientCallbacks_t;

typedef struct
{
    BTStatus_t ( * pxRegisterClient )( BTUuid_t * pxUuid );

    BTStatus_t ( * pxUnregisterClient )( uint8_t ucClientIf );

    BTStatus_t ( * pxGattClientInit )( const BTGattClientCallbacks_t * pxCallbacks );

    BTStatus_t ( * pxConnect )( uint8_t ucClientIf,
                                const BTBdaddr_t * pxBdAddr,
                                bool bIsDirect,
                                BTTransport_t xTransport );

    BTStatus_t ( * pxDisconnect )( uint8_t ucClientIf,
                                   const BTBdaddr_t * pxBdAddr,
                                   uint16_t usConnId );

    BTStatus_t ( * pxRefresh )( uint8_t ucClientIf,
                                const BTBdaddr_t * pxBdAddr );

    BTStatus_t ( * pxSearchService )( uint16_t usConnId,
                                      BTUuid_t * pxFilterUuid );

    BTStatus_t ( * pxReadCharacteristic )( uint16_t usConnId,
                                           uint16_t usHandle,
                                           uint32_t ulAuthReq );

    BTStatus_t ( * pxWriteCharacteristic )( uint16_t usConnId,
                                            uint16_t usHandle,
                                            BTAttrWriteRequests_t xWriteType,
                                            size_t xLen,
                                            uint32_t ulAuthReq,
                                            char * pcValue );

    BTStatus_t ( * pxReadDescriptor )( uint16_t usConnId,
                                       uint16_t usHandle,
                                       uint32_t ulAuthReq );

    BTStatus_t ( * pxWriteDescriptor )( uint16_t usConnId,
                                        uint16_t usHandle,
                                        BTAttrWriteRequests_t xWriteType,
                                        size_t xLen,
                                        uint32_t ulAuthReq,
                                        char * pcValue );

    BTStatus_t ( * pxExecuteWrite )( uint16_t usConnId,
                                     bool bExecute );

    BTStatus_t ( * pxRegisterForNotification )( uint8_t ucClientIf,
                                                const BTBdaddr_t * pxBdAddr,
                                                uint16_t usHandle );

    BTStatus_t ( * pxUnregisterForNotification )( uint8_t ucClientIf,
                                                  const BTBdaddr_t * pxBdAddr,
                                                  uint16_t usHandle );

    BTStatus_t ( * pxReadRemoteRssi )( uint8_t ucClientIf,
                                       const BTBdaddr_t * pxBdAddr );

    BTTransport_t ( * pxGetDeviceType )( const BTBdaddr_t * pxBdAddr );

    BTStatus_t ( * pxConfigureMtu )( uint16_t usConnId,
                                     uint16_t usMtu );

    BTStatus_t ( * pxTestCommand )( uint32_t ulCommand,
                                    BTGattTestParams_t * pxParams );

    BTStatus_t ( * pxGetGattDb )( uint16_t usConnId );
} BTGattClientInterface_t;

#endif /* #ifndef _BT_HAL_GATT_CLIENT_H_ */