att.h

/******************************************************************************

 @file  att.h

 @brief This file contains Attribute Protocol (ATT) definitions and prototypes
        prototypes.

 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: TISD 2009 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/

#ifndef ATT_H
#define ATT_H

#ifdef __cplusplus
extern "C"
{
#endif

/*********************************************************************
 * INCLUDES
 */
#include "bcomdef.h"
#include "osal.h"

#include "l2cap.h"

/*********************************************************************
 * CONSTANTS
 */

// The Exchanging MTU Size is defined as the maximum size of any packet
// transmitted between a client and a server. A higher layer specification
// defines the default ATT MTU value. The ATT MTU value should be within
// the range 23 to 517 inclusive.
// Refer to ble_user_config.h for the device-specific maximum MTU value.
#define ATT_MTU_SIZE                     L2CAP_MTU_SIZE 
#define ATT_MAX_MTU_SIZE                 517            


#define ATT_ERROR_RSP                    0x01 
#define ATT_EXCHANGE_MTU_REQ             0x02 
#define ATT_EXCHANGE_MTU_RSP             0x03 
#define ATT_FIND_INFO_REQ                0x04 
#define ATT_FIND_INFO_RSP                0x05 
#define ATT_FIND_BY_TYPE_VALUE_REQ       0x06 
#define ATT_FIND_BY_TYPE_VALUE_RSP       0x07 
#define ATT_READ_BY_TYPE_REQ             0x08 
#define ATT_READ_BY_TYPE_RSP             0x09 
#define ATT_READ_REQ                     0x0a 
#define ATT_READ_RSP                     0x0b 
#define ATT_READ_BLOB_REQ                0x0c 
#define ATT_READ_BLOB_RSP                0x0d 
#define ATT_READ_MULTI_REQ               0x0e 
#define ATT_READ_MULTI_RSP               0x0f 
#define ATT_READ_BY_GRP_TYPE_REQ         0x10 
#define ATT_READ_BY_GRP_TYPE_RSP         0x11 
#define ATT_WRITE_REQ                    0x12 
#define ATT_WRITE_RSP                    0x13 
#define ATT_PREPARE_WRITE_REQ            0x16 
#define ATT_PREPARE_WRITE_RSP            0x17 
#define ATT_EXECUTE_WRITE_REQ            0x18 
#define ATT_EXECUTE_WRITE_RSP            0x19 
#define ATT_HANDLE_VALUE_NOTI            0x1b 
#define ATT_HANDLE_VALUE_IND             0x1d 
#define ATT_HANDLE_VALUE_CFM             0x1e 
#define ATT_UNSUPPORTED_METHOD           0x20

#define ATT_WRITE_CMD                    0x52 
#define ATT_SIGNED_WRITE_CMD             0xD2 


#define ATT_FLOW_CTRL_VIOLATED_EVENT    0x7E 
#define ATT_MTU_UPDATED_EVENT           0x7F 


/*** Opcode fields: bitmasks ***/
// Method (bits 5-0)
#define ATT_METHOD_BITS                  0x3f

// Command Flag (bit 6)
#define ATT_CMD_FLAG_BIT                 0x40

// Authentication Signature Flag (bit 7)
#define ATT_AUTHEN_SIG_FLAG_BIT          0x80

// Size of 16-bit Bluetooth UUID
#define ATT_BT_UUID_SIZE                 2

// Size of 128-bit UUID
#define ATT_UUID_SIZE                    16

// ATT Response or Confirmation timeout
#define ATT_MSG_TIMEOUT                  30

// Authentication Signature status for received PDU; it's TRUE or FALSE for PDU to be sent
#define ATT_SIG_NOT_INCLUDED             0x00 // Signature not included
#define ATT_SIG_VALID                    0x01 // Included signature valid
#define ATT_SIG_INVALID                  0x02 // Included signature not valid

/*********************************************************************
 * Error Response: Error Code
 */

#define ATT_ERR_INVALID_HANDLE           0x01 
#define ATT_ERR_READ_NOT_PERMITTED       0x02 
#define ATT_ERR_WRITE_NOT_PERMITTED      0x03 
#define ATT_ERR_INVALID_PDU              0x04 
#define ATT_ERR_INSUFFICIENT_AUTHEN      0x05 
#define ATT_ERR_UNSUPPORTED_REQ          0x06 
#define ATT_ERR_INVALID_OFFSET           0x07 
#define ATT_ERR_INSUFFICIENT_AUTHOR      0x08 
#define ATT_ERR_PREPARE_QUEUE_FULL       0x09 
#define ATT_ERR_ATTR_NOT_FOUND           0x0a 
#define ATT_ERR_ATTR_NOT_LONG            0x0b 
#define ATT_ERR_INSUFFICIENT_KEY_SIZE    0x0c 
#define ATT_ERR_INVALID_VALUE_SIZE       0x0d 
#define ATT_ERR_UNLIKELY                 0x0e 
#define ATT_ERR_INSUFFICIENT_ENCRYPT     0x0f 
#define ATT_ERR_UNSUPPORTED_GRP_TYPE     0x10 
#define ATT_ERR_INSUFFICIENT_RESOURCES   0x11 

/*** Reserved for future use: 0x12 - 0x7F ***/

/*** Application error code defined by a higher layer specification: 0x80-0x9F ***/

#define ATT_ERR_INVALID_VALUE            0x80 


/*********************************************************************
 * Find Information Response: UUID Format
 */
  // Handle and 16-bit Bluetooth UUID
#define ATT_HANDLE_BT_UUID_TYPE          0x01

  // Handle and 128-bit UUID
#define ATT_HANDLE_UUID_TYPE             0x02

/*********************************************************************
 * Read Multiple Request: Handles
 */
  // Minimum number of handles in a single Read Multiple Request
#define ATT_MIN_NUM_HANDLES              2

/*********************************************************************
 * Execute Write Request: Flags
 */
  // Cancel all prepared writes
#define ATT_CANCEL_PREPARED_WRITES       0x00

  // Immediately write all pending prepared values
#define ATT_WRITE_PREPARED_VALUES        0x01

#if defined ( TESTMODES )
  // ATT Test Modes
  #define ATT_TESTMODE_OFF               0 // Test mode off
  #define ATT_TESTMODE_UNAUTHEN_SIG      1 // Do not authenticate incoming signature
  #define ATT_TESTMODE_SEND_UNS_REQ      2 // Send ATT request with unsupported opcode
  #define ATT_TESTMODE_SEND_UNS_CMD      3 // Send ATT command with unsupported opcode
#endif

/*********************************************************************
 * Size of mandatory fields of ATT requests
 */

// Length of opcode field: Opcode (1)
#define ATT_OPCODE_SIZE                        1

// Length of Exchange MTU Request: client receive MTU size (2)
#define ATT_EXCHANGE_MTU_REQ_SIZE              2

// Length of Exchange MTU Response: server receive MTU size (2)
#define ATT_EXCHANGE_MTU_RSP_SIZE              2

// Length of Error Response: Command opcode in error (1) + Attribute handle in error (2) + Status code (1)
#define ATT_ERROR_RSP_SIZE                     4

// Length of Find Information Request's fixed fields: First handle number (2) + Last handle number (2)
#define ATT_FIND_INFO_REQ_FIXED_SIZE           4

// Length of Find Information Response's fixed field: Format (1)
#define ATT_FIND_INFO_RSP_FIXED_SIZE           1
#define ATT_FIND_INFO_RSP_HDR_SIZE             ( ATT_OPCODE_SIZE + ATT_FIND_INFO_RSP_FIXED_SIZE )

// Length of Find By Type Value Request's fixed fields: Start handle (2) + End handle (2) + Type (2)
#define ATT_FIND_BY_TYPE_VALUE_REQ_FIXED_SIZE  6
#define ATT_FIND_BY_TYPE_VALUE_REQ_HDR_SIZE    ( ATT_OPCODE_SIZE + ATT_FIND_BY_TYPE_VALUE_REQ_FIXED_SIZE )

// Length of Read By Type Request's fixed fields: First handle number (2) + Last handle number (2)
#define ATT_READ_BY_TYPE_REQ_FIXED_SIZE        4
#define ATT_READ_BY_TYPE_REQ_HDR_SIZE          ( ATT_OPCODE_SIZE + ATT_READ_BY_TYPE_REQ_FIXED_SIZE )

// Length of Read By Type Response's fixed fields: Length (1)
#define ATT_READ_BY_TYPE_RSP_FIXED_SIZE        1
#define ATT_READ_BY_TYPE_RSP_HDR_SIZE          ( ATT_OPCODE_SIZE + ATT_READ_BY_TYPE_RSP_FIXED_SIZE )

// Length of Read Request: Attribute Handle (2)
#define ATT_READ_REQ_SIZE                      2

// Length of Read By Type Response's fixed fields: Length (1)
#define ATT_READ_BY_GRP_TYPE_RSP_FIXED_SIZE    1
#define ATT_READ_BY_GRP_TYPE_RSP_HDR_SIZE      ( ATT_OPCODE_SIZE + ATT_READ_BY_GRP_TYPE_RSP_FIXED_SIZE )

// Length of Write Request's fixed field: Attribute Handle (2)
#define ATT_WRITE_REQ_FIXED_SIZE               2

// Length of Read Blob Request: Attribute Handle (2) + Value Offset (2)
#define ATT_READ_BLOB_REQ_SIZE                 4

// Length of Write Request's fixed field: Attribute Handle (2)
#define ATT_WRITE_REQ_FIXED_SIZE               2
#define ATT_WRITE_REQ_HDR_SIZE                 ( ATT_OPCODE_SIZE + ATT_WRITE_REQ_FIXED_SIZE )

// Length of Prepare Write Request's fixed fields: Attribute Handle (2) + Value Offset (2)
#define ATT_PREPARE_WRITE_REQ_FIXED_SIZE       4
#define ATT_PREPARE_WRITE_REQ_HDR_SIZE         ( ATT_OPCODE_SIZE + ATT_PREPARE_WRITE_REQ_FIXED_SIZE )

// Length of Prepare Write Response's fixed size: Attribute Handle (2) + Value Offset (2)
#define ATT_PREPARE_WRITE_RSP_FIXED_SIZE       4

// Length of Execute Write Request: Flags (1)
#define ATT_EXECUTE_WRITE_REQ_SIZE             1

// Length of Handle Value Indication's fixed size: Attribute Handle (2)
#define ATT_HANDLE_VALUE_IND_FIXED_SIZE        2
#define ATT_HANDLE_VALUE_IND_HDR_SIZE          ( ATT_OPCODE_SIZE + ATT_HANDLE_VALUE_IND_FIXED_SIZE )

// Length of Authentication Signature field
#define ATT_AUTHEN_SIG_LEN                     12

/*********************************************************************
 * VARIABLES
 */

extern CONST uint8 btBaseUUID[ATT_UUID_SIZE];

/*********************************************************************
 * MACROS
 */

#define ATT_WRITE_COMMAND( method, cmd ) ( ( (method) == ATT_WRITE_REQ ) && ( (cmd) == TRUE ) )

/*********************************************************************
 * ATT Find Info Response macros
 */
// Handle and 16-bit Bluetooth UUID pair indexes
#define ATT_BT_PAIR_HANDLE_IDX( i )        ( (i) * (2 + ATT_BT_UUID_SIZE) )
#define ATT_BT_PAIR_UUID_IDX( i )          ( ATT_BT_PAIR_HANDLE_IDX( (i) ) + 2 )

#define ATT_BT_PAIR_HANDLE( info, i )      ( BUILD_UINT16( (info)[ATT_BT_PAIR_HANDLE_IDX((i))], \
                                                           (info)[ATT_BT_PAIR_HANDLE_IDX((i))+1] ) )
#define ATT_BT_PAIR_UUID( info, i )        ( BUILD_UINT16( (info)[ATT_BT_PAIR_UUID_IDX((i))], \
                                                           (info)[ATT_BT_PAIR_UUID_IDX((i))+1] ) )

// Handle and 128-bit UUID pair indexes
#define ATT_PAIR_HANDLE_IDX( i )           ( (i) * (2 + ATT_UUID_SIZE) )
#define ATT_PAIR_UUID_IDX( i )             ( ATT_PAIR_HANDLE_IDX( (i) ) + 2 )

#define ATT_PAIR_HANDLE( info, i )         ( BUILD_UINT16( (info)[ATT_PAIR_HANDLE_IDX((i))], \
                                                           (info)[ATT_PAIR_HANDLE_IDX((i))+1] ) )

/*********************************************************************
 * ATT Find By Type Value Response macros
 */
// Attribute Handle and Group End Handle pair indexes
#define ATT_ATTR_HANDLE_IDX( i )           ( (i) * (2 + 2) )
#define ATT_GRP_END_HANDLE_IDX( i )        ( ATT_ATTR_HANDLE_IDX( (i) ) + 2 )

#define ATT_ATTR_HANDLE( info, i )         ( BUILD_UINT16( (info)[ATT_ATTR_HANDLE_IDX((i))], \
                                                           (info)[ATT_ATTR_HANDLE_IDX((i))+1] ) )
#define ATT_GRP_END_HANDLE( info, i )      ( BUILD_UINT16( (info)[ATT_GRP_END_HANDLE_IDX((i))], \
                                                           (info)[ATT_GRP_END_HANDLE_IDX((i))+1] ) )

/*********************************************************************
 * ATT Read Multiple Request macros
 */
// Attribute Handle index
#define ATT_HANDLE_IDX( i )                ( (i) * 2 )

#define ATT_HANDLE( handles, i )           ( BUILD_UINT16( (handles)[ATT_HANDLE_IDX((i))], \
                                                           (handles)[ATT_HANDLE_IDX((i))+1] ) )

/*********************************************************************
 * TYPEDEFS
 */

typedef struct
{
  uint8 sig;      
  uint8 cmd;      
  uint8 method;   
  uint16 len;     
  uint8 *pParams; 
} attPacket_t;

typedef struct
{
  uint8 len;                 
  uint8 uuid[ATT_UUID_SIZE]; 
} attAttrType_t;

typedef struct
{
  uint8 len;                    
  uint8 uuid[ATT_BT_UUID_SIZE]; 
} attAttrBtType_t;

typedef struct
{
  uint8 reqOpcode; 
  uint16 handle;   
  uint8 errCode;   
} attErrorRsp_t;

typedef struct
{
  uint16 clientRxMTU; 
} attExchangeMTUReq_t;

typedef struct
{
  uint16 serverRxMTU; 
} attExchangeMTURsp_t;

typedef struct
{
  uint16 startHandle;       
  uint16 endHandle;         
} attFindInfoReq_t;

typedef struct
{
  uint16 handle;                
  uint8 uuid[ATT_BT_UUID_SIZE]; 
} attHandleBtUUID_t;

typedef struct
{
  uint16 handle;             
  uint8 uuid[ATT_UUID_SIZE]; 
} attHandleUUID_t;

typedef struct
{
  uint16 numInfo; 
  uint8 format;   
  uint8 *pInfo;   
} attFindInfoRsp_t;

typedef struct
{
  uint16 startHandle;   
  uint16 endHandle;     
  attAttrBtType_t type; 
  uint16 len;           
  uint8 *pValue;        
} attFindByTypeValueReq_t;

typedef struct
{
  uint16 handle;       
  uint16 grpEndHandle; 
} attHandlesInfo_t;

typedef struct
{
  uint16 numInfo;      
  uint8 *pHandlesInfo; 
} attFindByTypeValueRsp_t;

typedef struct
{
  uint16 startHandle; 
  uint16 endHandle;   
  attAttrType_t type; 
} attReadByTypeReq_t;

typedef struct
{
  uint16 numPairs;  
  uint16 len;       
  uint8 *pDataList; 
  uint16 dataLen;   
} attReadByTypeRsp_t;

typedef struct
{
  uint16 handle; 
} attReadReq_t;

typedef struct
{
  uint16 len;    
  uint8 *pValue; 
} attReadRsp_t;

typedef struct
{
  uint16 handle; 
  uint16 offset; 
} attReadBlobReq_t;

typedef struct
{
  uint16 len;    
  uint8 *pValue; 
} attReadBlobRsp_t;

typedef struct
{
  uint8 *pHandles;   
  uint16 numHandles; 
} attReadMultiReq_t;

typedef struct
{
  uint16 len;     
  uint8 *pValues; 
} attReadMultiRsp_t;

typedef struct
{
  uint16 startHandle; 
  uint16 endHandle;   
  attAttrType_t type; 
} attReadByGrpTypeReq_t;

typedef struct
{
  uint16 numGrps;   
  uint16 len;       
  uint8 *pDataList; 
} attReadByGrpTypeRsp_t;

typedef struct
{
  uint16 handle; 
  uint16 len;    
  uint8 *pValue; 
  uint8 sig;     
  uint8 cmd;     
} attWriteReq_t;

typedef struct
{
  uint16 handle; 
  uint16 offset; 
  uint16 len;    
  uint8 *pValue; 
} attPrepareWriteReq_t;

typedef struct
{
  uint16 handle; 
  uint16 offset; 
  uint16 len;    
  uint8 *pValue; 
} attPrepareWriteRsp_t;

typedef struct
{
  uint8 flags; 
} attExecuteWriteReq_t;

typedef struct
{
  uint16 handle; 
  uint16 len;    
  uint8 *pValue; 
} attHandleValueNoti_t;

typedef struct
{
  uint16 handle; 
  uint16 len;    
  uint8 *pValue; 
} attHandleValueInd_t;

typedef struct
{
  uint8 opcode;        
  uint8 pendingOpcode; 
} attFlowCtrlViolatedEvt_t;

typedef struct
{
  uint16 MTU; 
} attMtuUpdatedEvt_t;

typedef union
{
  // Request messages
  attExchangeMTUReq_t exchangeMTUReq;         
  attFindInfoReq_t findInfoReq;               
  attFindByTypeValueReq_t findByTypeValueReq; 
  attReadByTypeReq_t readByTypeReq;           
  attReadReq_t readReq;                       
  attReadBlobReq_t readBlobReq;               
  attReadMultiReq_t readMultiReq;             
  attReadByGrpTypeReq_t readByGrpTypeReq;     
  attWriteReq_t writeReq;                     
  attPrepareWriteReq_t prepareWriteReq;       
  attExecuteWriteReq_t executeWriteReq;       

  // Response messages
  attErrorRsp_t errorRsp;                     
  attExchangeMTURsp_t exchangeMTURsp;         
  attFindInfoRsp_t findInfoRsp;               
  attFindByTypeValueRsp_t findByTypeValueRsp; 
  attReadByTypeRsp_t readByTypeRsp;           
  attReadRsp_t readRsp;                       
  attReadBlobRsp_t readBlobRsp;               
  attReadMultiRsp_t readMultiRsp;             
  attReadByGrpTypeRsp_t readByGrpTypeRsp;     
  attPrepareWriteRsp_t prepareWriteRsp;       

  // Indication and Notification messages
  attHandleValueNoti_t handleValueNoti;       
  attHandleValueInd_t handleValueInd;         

  // Locally-generated event messages
  attFlowCtrlViolatedEvt_t flowCtrlEvt;       
  attMtuUpdatedEvt_t mtuEvt;                  
} attMsg_t;

// Function prototype to notify GATT Server or Client about an outgoing ATT message.
typedef void (*attNotifyTxCB_t)( uint16 connHandle, uint8 opcode );

/*********************************************************************
 * VARIABLES
 */

/*********************************************************************
 * API FUNCTIONS
 */

/*-------------------------------------------------------------------
 *  General Utility APIs
 */

/*
 * Parse an attribute protocol message.
 */
extern uint8 ATT_ParsePacket( l2capDataEvent_t *pL2capMsg, attPacket_t *pPkt );

/*
 * Compare two UUIDs. The UUIDs are converted if necessary.
 */
extern uint8 ATT_CompareUUID( const uint8 *pUUID1, uint16 len1,
                              const uint8 *pUUID2, uint16 len2 );
/*
 * Convert a 16-bit UUID to 128-bit UUID.
 */
extern uint8 ATT_ConvertUUIDto128( const uint8 *pUUID16, uint8 *pUUID128 );

/*
 * Convert a 128-bit UUID to 16-bit UUID.
 */
extern uint8 ATT_ConvertUUIDto16( const uint8 *pUUID128, uint8 *pUUID16 );


/*-------------------------------------------------------------------
 *  Attribute Client Utility APIs
 */

/*
 * Build Error Response.
 */
extern uint16 ATT_BuildErrorRsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Error Response.
 */
extern bStatus_t ATT_ParseErrorRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Exchange MTU Request.
 */
extern uint16 ATT_BuildExchangeMTUReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Build Exchange MTU Response.
 */
extern uint16 ATT_BuildExchangeMTURsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Exchange MTU Response.
 */
extern bStatus_t ATT_ParseExchangeMTURsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Find Information Request.
 */
extern uint16 ATT_BuildFindInfoReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Find Information Response.
 */
extern bStatus_t ATT_ParseFindInfoRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Find Information Response.
 */
extern uint16 ATT_BuildFindInfoRsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Build Find By Type Value Request.
 */
extern uint16 ATT_BuildFindByTypeValueReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Build Find By Type Value Response.
 */
extern uint16 ATT_BuildFindByTypeValueRsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Find By Type Value Response.
 */
extern bStatus_t ATT_ParseFindByTypeValueRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Read By Type Request.
 */
extern uint16 ATT_BuildReadByTypeReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Build Read By Type Response.
 */
extern uint16 ATT_BuildReadByTypeRsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Read By Type Response.
 */
extern bStatus_t ATT_ParseReadByTypeRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Read Request.
 */
extern uint16 ATT_BuildReadReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Build Read Response.
 */
extern uint16 ATT_BuildReadRsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Read Response.
 */
extern bStatus_t ATT_ParseReadRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Read Blob Request.
 */
extern uint16 ATT_BuildReadBlobReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Build Read Blob Response.
 */
extern uint16 ATT_BuildReadBlobRsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Read Blob Response.
 */
extern bStatus_t ATT_ParseReadBlobRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Read Multiple Request.
 */
extern uint16 ATT_BuildReadMultiReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Build Read Multiple Response.
 */
extern uint16 ATT_BuildReadMultiRsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Read Multiple Response.
 */
extern bStatus_t ATT_ParseReadMultiRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Read By Group Type Response.
 */
extern uint16 ATT_BuildReadByGrpTypeRsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Read By Group Type Response.
 */
extern bStatus_t ATT_ParseReadByGrpTypeRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Write Request.
 */
extern uint16 ATT_BuildWriteReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Write Response.
 */
extern bStatus_t ATT_ParseWriteRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Prepare Write Request.
 */
extern uint16 ATT_BuildPrepareWriteReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Build Prepare Write Response.
 */
extern uint16 ATT_BuildPrepareWriteRsp( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Prepare Write Response.
 */
extern bStatus_t ATT_ParsePrepareWriteRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Execute Write Request.
 */
extern uint16 ATT_BuildExecuteWriteReq( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Execute Write Response.
 */
extern bStatus_t ATT_ParseExecuteWriteRsp( uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Build Handle Value Indication.
 */
extern uint16 ATT_BuildHandleValueInd( uint8 *pBuf, uint8 *pMsg );

/*
 * Parse Handle Value Indication.
 */
extern bStatus_t ATT_ParseHandleValueInd( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );


/*-------------------------------------------------------------------
 *  Attribute Server Utility APIs
 */

/*
 * Parse Exchange MTU Request.
 */
extern bStatus_t ATT_ParseExchangeMTUReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Find Information Request.
 */
extern bStatus_t ATT_ParseFindInfoReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Find By Type Value Request.
 */
extern bStatus_t ATT_ParseFindByTypeValueReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Read By Type Request.
 */
extern bStatus_t ATT_ParseReadByTypeReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Read Request.
 */
extern bStatus_t ATT_ParseReadReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Write Blob Request.
 */
extern bStatus_t ATT_ParseReadBlobReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Read Multiple Request.
 */
extern bStatus_t ATT_ParseReadMultiReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Write Request.
 */
extern bStatus_t ATT_ParseWriteReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Execute Write Request.
 */
extern bStatus_t ATT_ParseExecuteWriteReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Prepare Write Request.
 */
extern bStatus_t ATT_ParsePrepareWriteReq( uint8 sig, uint8 cmd, uint8 *pParams, uint16 len, attMsg_t *pMsg );

/*
 * Parse Handle Value Confirmation.
 */
extern bStatus_t ATT_ParseHandleValueCfm( uint8 *pParams, uint16 len, attMsg_t *pMsg );


/*-------------------------------------------------------------------
 *  Attribute Client Public APIs
 */

extern bStatus_t ATT_ExchangeMTUReq( uint16 connHandle, attExchangeMTUReq_t *pReq );

extern bStatus_t ATT_FindInfoReq( uint16 connHandle, attFindInfoReq_t *pReq );

extern bStatus_t ATT_FindByTypeValueReq( uint16 connHandle, attFindByTypeValueReq_t *pReq );

extern bStatus_t ATT_ReadByTypeReq( uint16 connHandle, attReadByTypeReq_t *pReq );

extern bStatus_t ATT_ReadReq( uint16 connHandle, attReadReq_t *pReq );

extern bStatus_t ATT_ReadBlobReq( uint16 connHandle, attReadBlobReq_t *pReq );

extern bStatus_t ATT_ReadMultiReq( uint16 connHandle, attReadMultiReq_t *pReq );

extern bStatus_t ATT_ReadByGrpTypeReq( uint16 connHandle, attReadByGrpTypeReq_t *pReq );

extern bStatus_t ATT_WriteReq( uint16 connHandle, attWriteReq_t *pReq );

extern bStatus_t ATT_PrepareWriteReq( uint16 connHandle, attPrepareWriteReq_t *pReq );

extern bStatus_t ATT_ExecuteWriteReq( uint16 connHandle, attExecuteWriteReq_t *pReq );

extern bStatus_t ATT_HandleValueCfm( uint16 connHandle );

/*-------------------------------------------------------------------
 *  Attribute Server Public APIs
 */

extern bStatus_t ATT_ErrorRsp( uint16 connHandle, attErrorRsp_t *pRsp );

extern bStatus_t ATT_ExchangeMTURsp( uint16 connHandle, attExchangeMTURsp_t *pRsp );

extern bStatus_t ATT_FindInfoRsp( uint16 connHandle, attFindInfoRsp_t *pRsp );

extern bStatus_t ATT_FindByTypeValueRsp( uint16 connHandle, attFindByTypeValueRsp_t *pRsp );

extern bStatus_t ATT_ReadByTypeRsp( uint16 connHandle, attReadByTypeRsp_t *pRsp );

extern bStatus_t ATT_ReadRsp( uint16 connHandle, attReadRsp_t *pRsp );

extern bStatus_t ATT_ReadBlobRsp( uint16 connHandle, attReadBlobRsp_t *pRsp );

extern bStatus_t ATT_ReadMultiRsp( uint16 connHandle, attReadMultiRsp_t *pRsp ) ;

extern bStatus_t ATT_ReadByGrpTypeRsp( uint16 connHandle, attReadByGrpTypeRsp_t *pRsp );

extern bStatus_t ATT_WriteRsp( uint16 connHandle );

extern bStatus_t ATT_PrepareWriteRsp( uint16 connHandle, attPrepareWriteRsp_t *pRsp );

extern bStatus_t ATT_ExecuteWriteRsp( uint16 connHandle );

extern bStatus_t ATT_HandleValueNoti( uint16 connHandle, attHandleValueNoti_t *pNoti );

extern bStatus_t ATT_HandleValueInd( uint16 connHandle, attHandleValueInd_t *pInd );

/*-------------------------------------------------------------------
 *  Attribute Common Public APIs
 */

extern uint8 ATT_UpdateMTU( uint16 connHandle, uint16 MTU );

extern uint16 ATT_GetMTU( uint16 connHandle );

extern void ATT_SetParamValue( uint16 value );

extern uint16 ATT_GetParamValue( void );

extern void ATT_RegisterServer( attNotifyTxCB_t pfnNotifyTx );

extern void ATT_RegisterClient( attNotifyTxCB_t pfnNotifyTx );

/*********************************************************************
*********************************************************************/

#ifdef __cplusplus
}
#endif

#endif /* ATT_H */