bt_hal_gatt_types.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_TYPES_H_
#define _BT_HAL_GATT_TYPES_H_
 
#include <stdint.h>
#include <stdbool.h>
 
#include "bt_hal_manager.h"
#include "bt_hal_manager_types.h"
 
#define btGATT_MAX_ATTR_LEN    600
 
typedef enum
{
    eBTGattStatusSuccess = 0x00,                      
    eBTInvalidHandle = 0x01,                          
    eBTGattStatusReadNotPermitted = 0x02,             
    eBTGattStatusWriteNotPermitted = 0x03,            
    eBTGattStatusInvalidPDU = 0x04,                   
    eBTGattStatusInsufficientAuthentication = 0x05,   
    eBTGattStatusRequestNotSupported = 0x06,          
    eBTGattStatusInvalidOffset = 0x07,                
    eBTGattStatusInsufficientAuthorization = 0x08,    
    eBTGattStatusPrepareQueueFull = 0x09,             
    eBTGattStatusAttributeNotFound = 0x0A,            
    eBTGattStatusAttributeNotLong = 0x0B,             
    eBTGattStatusInsufficientKeySize = 0x0C,          
    eBTGattStatusInvalidAttributeLength = 0x0D,       
    eBTGattStatusUnlikelyError = 0x0E,                
    eBTGattStatusInsufficientEncryption = 0x0F,       
    eBTGattStatusUnsupportedGroupType = 0x10,         
    eBTGattStatusInsufficientResources = 0x11,        
    eBTGattStatusInternalError = 0x81,                
    eBTGattStatusError = 0x85,                        
    eBTGattStatusConnectionCongested = 0x8f,          
    eBTGattStatusErrorConnEstFail = 0x93,             
    eBTGattStatusErrorConnTimeout = 0x94,             
    eBTGattStatusLocalHostTerminatedConnection = 0x99 
} BTGattStatus_t;
 
enum
{
    eBTPropNone = 0x0000,
    eBTPropBroadcast = 0x0001,
    eBTPropRead = 0x0002,
    eBTPropWriteNoResponse = 0x0004,
    eBTPropWrite = 0x0008,
    eBTPropNotify = 0x0010,
    eBTPropIndicate = 0x0020,
    eBTPropSignedWrite = 0x0040,
    eBTPropExtendedProps = 0x0080,
};
typedef uint16_t BTCharProperties_t; 
enum
{
    eBTPermNone = 0x0000,
    eBTPermRead = 0x0001,               
    eBTPermReadEncrypted = 0x0002,      
    eBTPermReadEncryptedMitm = 0x0004,  
    eBTPermWrite = 0x0010,              
    eBTPermWriteEncrypted = 0x0020,     
    eBTPermWriteEncryptedMitm = 0x0040, 
    eBTPermWriteSigned = 0x0080,        
    eBTPermWriteSignedMitm = 0x0100,    
};
typedef uint16_t BTCharPermissions_t;   
typedef enum
{
    eBTWriteTypeNoResponse = 0x0001, 
    eBTWriteTypeDefault = 0x0002,    
    eBTWriteTypePrepare = 0x0003,    
    eBTWriteTypeSigned = 0x0004,     
} BTAttrWriteRequests_t;
 
 
typedef enum
{
    eBTServiceTypePrimary,   
    eBTServiceTypeSecondary, 
} BTGattServiceTypes_t;
 
typedef struct
{
    BTUuid_t xUuid;   
    uint8_t ucInstId; 
} BTGattInstanceId_t;
 
typedef struct
{
    BTGattInstanceId_t xId;            
    BTGattServiceTypes_t xServiceType; 
} BTGattSrvcId_t;
 
 
typedef struct
{
    uint8_t ucClientIf;              
    uint8_t ucFiltIndex;             
    uint8_t ucAdvertiserState;       
    uint8_t ucAdvertiserInfoPresent; 
    uint8_t ucAddrType;              
    uint8_t ucTxPower;               
    int8_t cRssiValue;               
    uint16_t usTimeStamp;            
    BTBdaddr_t xBdAddr;              
    uint8_t ucAdvPktLen;             
    uint8_t * pucAdvPktData;         
    size_t xScanRspLen;              
    uint8_t * pucScanRspData;        
} BTGattTrackAdvInfo_t;
 
typedef enum
{
    eBTDbPrimaryService,     
    eBTDbSecondaryService,   
    eBTDbIncludedService,    
    eBTDbCharacteristicDecl, 
    eBTDbCharacteristic,     
    eBTDbDescriptor,         
} BTDbAttributeType_t;
 
typedef struct BTService BTService_t;
 
typedef struct
{
    BTUuid_t xUuid;                   
    BTCharProperties_t xProperties;   
    BTCharPermissions_t xPermissions; 
} BTCharacteristic_t;
 
typedef struct
{
    BTUuid_t xUuid;                   
    BTCharPermissions_t xPermissions; 
} BTCharacteristicDescr_t;
 
typedef struct
{
    BTUuid_t xUuid;               
    BTService_t * pxPtrToService; 
} BTIncludedService_t;
 
typedef BTUuid_t BTServiceUUID_t;
 
typedef struct
{
    BTDbAttributeType_t xAttributeType; 
    union
    {
        BTServiceUUID_t xServiceUUID;                 
        BTCharacteristic_t xCharacteristic;           
        BTCharacteristicDescr_t xCharacteristicDescr; 
        BTIncludedService_t xIncludedService;         
    };
} BTAttribute_t;
 
struct BTService
{
    uint8_t ucInstId;                
    BTGattServiceTypes_t xType;      
    size_t xNumberOfAttributes;      
    uint16_t * pusHandlesBuffer;     
    BTAttribute_t * pxBLEAttributes; 
};
 
typedef struct
{
    uint16_t usId;              
    BTUuid_t xUuid;             
    BTDbAttributeType_t xType;  
    uint16_t usAttributeHandle; 
    /*
     * If |type| is |btDB_PRIMARY_SERVICE|, or
     * |btDB_SECONDARY_SERVICE|, this contains the start and end attribute
     * handles.
     */
    uint16_t usStartHandle; 
    uint16_t usEndHandle;   
    /*
     * If |type| is |btDB_CHARACTERISTIC|, this contains the properties of
     * the characteristic.
     */
    uint8_t ucProperties; 
} BTGattDbElement_t;
 
typedef void ( * BTConnectCallback_t)( uint16_t usConnId,
                                       BTGattStatus_t xStatus,
                                       uint8_t ucClientIf,
                                       BTBdaddr_t * pxBda );
 
typedef void ( * BTDisconnectCallback_t)( uint16_t usConnId,
                                          BTGattStatus_t xStatus,
                                          uint8_t ucClientIf,
                                          BTBdaddr_t * pxBda );
 
 
typedef void ( * BTReadRemoteRssiCallback_t)( uint8_t ucClientIf,
                                              BTBdaddr_t * pxBda,
                                              uint32_t ulRssi,
                                              BTStatus_t xStatus );
 
typedef void ( * BTCongestionCallback_t)( uint16_t usConnId,
                                          bool bCongested );
 
#endif /* _BT_HAL_GATT_TYPES_H_ */