gattservapp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2016, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*!*****************************************************************************
 *  @defgroup GATTServApp GATTServApp
 *  @brief This module implements the GATT Server App
 *  @{
 *  @file       gattservapp.h
 *  @brief      GATTServApp layer interface
 */

#ifndef GATTSERVAPP_H
#define GATTSERVAPP_H

#ifdef __cplusplus
extern "C"
{
#endif

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

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

#define GATT_CLIENT_CHAR_CFG_UPDATED_EVENT  0x00 


#define GATT_PROP_BCAST                  0x01 
#define GATT_PROP_READ                   0x02 
#define GATT_PROP_WRITE_NO_RSP           0x04 
#define GATT_PROP_WRITE                  0x08 
#define GATT_PROP_NOTIFY                 0x10 
#define GATT_PROP_INDICATE               0x20 
#define GATT_PROP_AUTHEN                 0x40 
#define GATT_PROP_EXTENDED               0x80 


#define GATT_EXT_PROP_RELIABLE_WRITE     0x0001 
#define GATT_EXT_PROP_WRITABLE_AUX       0x0002 


#define GATT_CLIENT_CFG_NOTIFY           0x0001 
#define GATT_CLIENT_CFG_INDICATE         0x0002 


#define GATT_SERV_CFG_BCAST              0x0001 


#define GATT_CFG_NO_OPERATION            0x0000 // No operation

#define GATT_FORMAT_BOOL                 0x01 
#define GATT_FORMAT_2BIT                 0x02 
#define GATT_FORMAT_NIBBLE               0x03 
#define GATT_FORMAT_UINT8                0x04 
#define GATT_FORMAT_UINT12               0x05 
#define GATT_FORMAT_UINT16               0x06 
#define GATT_FORMAT_UINT24               0x07 
#define GATT_FORMAT_UINT32               0x08 
#define GATT_FORMAT_UINT48               0x09 
#define GATT_FORMAT_UINT64               0x0a 
#define GATT_FORMAT_UINT128              0x0b 
#define GATT_FORMAT_SINT8                0x0c 
#define GATT_FORMAT_SINT12               0x0d 
#define GATT_FORMAT_SINT16               0x0e 
#define GATT_FORMAT_SINT24               0x0f 
#define GATT_FORMAT_SINT32               0x10 
#define GATT_FORMAT_SINT48               0x11 
#define GATT_FORMAT_SINT64               0x12 
#define GATT_FORMAT_SINT128              0x13 
#define GATT_FORMAT_FLOAT32              0x14 
#define GATT_FORMAT_FLOAT64              0x15 
#define GATT_FORMAT_SFLOAT               0x16 
#define GATT_FORMAT_FLOAT                0x17 
#define GATT_FORMAT_DUINT16              0x18 
#define GATT_FORMAT_UTF8S                0x19 
#define GATT_FORMAT_UTF16S               0x1a 
#define GATT_FORMAT_STRUCT               0x1b 


#define GATT_NS_NONE                     0x00 
#define GATT_NS_BT_SIG                   0x01 
#define GATT_NS_BT_DESC_UNKNOWN          0x0000 

#define GATT_ALL_SERVICES                0xFFFFFFFF

#define GATT_SERVICE                     0x00000001

#if defined ( TESTMODES )
  // GATT Test Modes
  #define GATT_TESTMODE_OFF              0 // Test mode off
  #define GATT_TESTMODE_NO_RSP           1 // Ignore incoming request
  #define GATT_TESTMODE_PREPARE_WRITE    2 // Forward Prepare Write Request right away
  #define GATT_TESTMODE_MAX_MTU_SIZE     3 // Use Max ATT MTU size with Exchange MTU Rsp
  #define GATT_TESTMODE_CORRUPT_PW_DATA  4 // Corrupt incoming Prepare Write Request data
#endif

#define GATT_PARAM_NUM_PREPARE_WRITES    0 // RW  uint8

#define PTR_TYPE                         unsigned int *

#define GATT_LOCAL_READ                  0xFF
#define GATT_LOCAL_WRITE                 0xFE

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

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

#define GATT_NUM_ATTRS( attrs )          ( sizeof( attrs ) / sizeof( gattAttribute_t ) )

#define GATT_SERVICE_HANDLE( attrs )     ( (attrs)[0].handle )

#define GATT_INCLUDED_HANDLE( attrs, i ) ( *((uint16 *)((attrs)[(i)].pValue)) )

#define GATT_CCC_TBL( pValue )           ( (gattCharCfg_t *)(*((PTR_TYPE)(pValue))) )

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

typedef bStatus_t (*pfnGATTReadAttrCB_t)( uint16 connHandle, gattAttribute_t *pAttr,
                                          uint8 *pValue, uint16 *pLen, uint16 offset,
                                          uint16 maxLen, uint8 method );

typedef bStatus_t (*pfnGATTWriteAttrCB_t)( uint16 connHandle, gattAttribute_t *pAttr,
                                           uint8 *pValue, uint16 len, uint16 offset,
                                           uint8 method );
typedef bStatus_t (*pfnGATTAuthorizeAttrCB_t)( uint16 connHandle, gattAttribute_t *pAttr,
                                               uint8 opcode );

typedef struct
{
  uint8 format;    
  int8 exponent;   
  uint16 unit;     
  uint8 nameSpace; 
  uint16 desc;     
} gattCharFormat_t;

typedef struct
{
  uint16 connHandle; 
  uint8  value;      
} gattCharCfg_t;

typedef struct
{
  pfnGATTReadAttrCB_t pfnReadAttrCB;           
  pfnGATTWriteAttrCB_t pfnWriteAttrCB;         
  pfnGATTAuthorizeAttrCB_t pfnAuthorizeAttrCB; 
} gattServiceCBs_t;

typedef struct
{
  osal_event_hdr_t  hdr;           
  uint16 connHandle;               
  uint8 method;                    
} gattEventHdr_t;

typedef struct
{
  osal_event_hdr_t hdr; 
  uint16 connHandle;    
  uint8 method;         
  uint16 attrHandle;    
  uint16 value;         
} gattClientCharCfgUpdatedEvent_t;


typedef struct
{
  uint16 connHandle;                    // connection message was received on
  attPrepareWriteReq_t *pPrepareWriteQ; // Prepare Write Request queue
} prepareWrites_t;

typedef struct
{
  uint16 handle;                // Service handle - assigned internally by GATT Server
  CONST gattServiceCBs_t *pCBs; // Service callback function pointers
} gattServiceCBsInfo_t;

typedef struct _serviceCBsList
{
  struct _serviceCBsList *next;     // pointer to next service callbacks record
  gattServiceCBsInfo_t serviceInfo; // service handle/callbacks
} serviceCBsList_t;


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

extern prepareWrites_t          *prepareWritesTbl;

extern serviceCBsList_t         *serviceCBsList;

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

extern void GATTServApp_RegisterForMsg( uint8 taskID );

extern bStatus_t GATTServApp_RegisterService( gattAttribute_t *pAttrs,
                                              uint16 numAttrs, uint8 encKeySize,
                                              CONST gattServiceCBs_t *pServiceCBs );

bStatus_t GATTServApp_DeregisterService( uint16 handle, gattAttribute_t **p2pAttrs );

extern gattAttribute_t *GATTServApp_FindAttr( gattAttribute_t *pAttrTbl,
                                              uint16 numAttrs, uint8 *pValue );
extern bStatus_t GATTServApp_AddService( uint32 services );

extern bStatus_t GATTServApp_DelService( uint32 services );

extern bStatus_t GATTServApp_SetParameter( uint8 param, uint8 len, void *pValue );

extern bStatus_t GATTServApp_GetParameter( uint8 param, void *pValue );

extern bStatus_t GATTServApp_UpdateCharCfg( uint16 connHandle, uint16 attrHandle, uint16 value );

extern void GATTServApp_InitCharCfg( uint16 connHandle, gattCharCfg_t *charCfgTbl );

extern uint16 GATTServApp_ReadCharCfg( uint16 connHandle, gattCharCfg_t *charCfgTbl );

extern uint8 GATTServApp_WriteCharCfg( uint16 connHandle, gattCharCfg_t *charCfgTbl, uint16 value );

extern bStatus_t GATTServApp_ProcessCCCWriteReq( uint16 connHandle, gattAttribute_t *pAttr,
                                          uint8 *pValue, uint16 len, uint16 offset,
                                          uint16 validCfg );

extern bStatus_t GATTServApp_ProcessCharCfg( gattCharCfg_t *charCfgTbl, uint8 *pValue,
                                        uint8 authenticated, gattAttribute_t *attrTbl,
                                        uint16 numAttrs, uint8 taskId,
                                        pfnGATTReadAttrCB_t pfnReadAttrCB );

extern void GATTServApp_SendCCCUpdatedEvent( uint16 connHandle, uint16 attrHandle, uint16 value );

extern bStatus_t GATTServApp_SendServiceChangedInd( uint16 connHandle, uint8 taskId );

extern uint8 GATTServApp_ReadAttr( uint16 connHandle, gattAttribute_t *pAttr,
                                   uint16 service, uint8 *pValue, uint16 *pLen,
                                   uint16 offset, uint16 maxLen, uint8 method );

extern uint8 GATTServApp_WriteAttr( uint16 connHandle, uint16 handle,
                                    uint8 *pValue, uint16 len, uint16 offset,
                                    uint8 method );

extern bStatus_t GATTServApp_ReadRsp( uint16 connHandle, uint8 *pValue,
                                      uint16 pLen, uint16 offset );

extern void GATTServApp_SetParamValue( uint16 value );

extern uint16 GATTServApp_GetParamValue( void );

/*-------------------------------------------------------------------
 * TASK API - These functions must only be called by OSAL.
 */


extern void GATTServApp_Init( uint8 taskId );

extern uint16 GATTServApp_ProcessEvent( uint8 taskId, uint16 events );

extern pfnGATTAuthorizeAttrCB_t  gattServApp_FindAuthorizeAttrCB( uint16 handle );

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

extern bStatus_t gattServApp_ProcessWriteLong( gattMsgEvent_t *pMsg, prepareWrites_t *pQueue, uint16 *pErrHandle );

extern bStatus_t gattServApp_ProcessReliableWrites( gattMsgEvent_t *pMsg, prepareWrites_t *pQueue, uint16 *pErrHandle );

extern bStatus_t gattServApp_buildReadByTypeRsp( uint16 connHandle, uint8 *pAttrValue, uint16 attrLen, uint16 attrHandle );

extern prepareWrites_t *gattServApp_FindPrepareWriteQ( uint16 connHandle );

extern uint8 gattServApp_IsWriteLong( attExecuteWriteReq_t *pReq, prepareWrites_t *pQueue );

extern void gattServApp_ClearPrepareWriteQ( prepareWrites_t *pQueue );


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

#ifdef __cplusplus
}
#endif

#endif /* GATTSERVAPP_H */