bluenrg_gatt_aci.h

Go to the documentation of this file.

/******************** (C) COPYRIGHT 2014 STMicroelectronics ********************
* File Name          : bluenrg_gatt_aci.h
* Author             : AMS - AAS
* Version            : V1.0.0
* Date               : 26-Jun-2014
* Description        : Header file with GATT commands for BlueNRG FW6.3.
********************************************************************************
* THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
* WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
* AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
* INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
* CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
* INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
*******************************************************************************/

#ifndef __BLUENRG_GATT_ACI_H__
#define __BLUENRG_GATT_ACI_H__

#include "bluenrg_gatt_server.h"

tBleStatus aci_gatt_init(void);

tBleStatus aci_gatt_add_serv(uint8_t service_uuid_type,
                 const uint8_t* service_uuid,
                 uint8_t service_type,
                 uint8_t max_attr_records,
                 uint16_t *serviceHandle);

tBleStatus aci_gatt_include_service(uint16_t service_handle, uint16_t included_start_handle,
                    uint16_t included_end_handle, uint8_t included_uuid_type,
                    const uint8_t* included_uuid, uint16_t *included_handle);

tBleStatus aci_gatt_add_char(uint16_t serviceHandle,
                 uint8_t charUuidType,
                 const uint8_t* charUuid, 
                 uint8_t charValueLen, 
                 uint8_t charProperties,
                 uint8_t secPermissions,
                 uint8_t gattEvtMask,
                 uint8_t encryKeySize,
                 uint8_t isVariable,
                 uint16_t* charHandle);

tBleStatus aci_gatt_add_char_desc(uint16_t serviceHandle,
                                  uint16_t charHandle,
                                  uint8_t descUuidType,
                                  const uint8_t* uuid, 
                                  uint8_t descValueMaxLen,
                                  uint8_t descValueLen,
                                  const void* descValue, 
                                  uint8_t secPermissions,
                                  uint8_t accPermissions,
                                  uint8_t gattEvtMask,
                                  uint8_t encryKeySize,
                                  uint8_t isVariable,
                                  uint16_t* descHandle);

tBleStatus aci_gatt_update_char_value(uint16_t servHandle, 
                      uint16_t charHandle,
                      uint8_t charValOffset,
                      uint8_t charValueLen,   
                      const void *charValue);
tBleStatus aci_gatt_del_char(uint16_t servHandle, uint16_t charHandle);

tBleStatus aci_gatt_del_service(uint16_t servHandle);

tBleStatus aci_gatt_del_include_service(uint16_t servHandle, uint16_t includeServHandle);

tBleStatus aci_gatt_exchange_configuration(uint16_t conn_handle);

tBleStatus aci_att_find_information_req(uint16_t conn_handle, uint16_t start_handle, uint16_t end_handle);

tBleStatus aci_att_find_by_type_value_req(uint16_t conn_handle, uint16_t start_handle, uint16_t end_handle,
                                          uint8_t* uuid, uint8_t attr_val_len, uint8_t* attr_val);

tBleStatus aci_att_read_by_type_req(uint16_t conn_handle, uint16_t start_handle, uint16_t end_handle,
                                    uint8_t  uuid_type, uint8_t* uuid);

tBleStatus aci_att_read_by_group_type_req(uint16_t conn_handle, uint16_t start_handle, uint16_t end_handle,
                                    uint8_t  uuid_type, uint8_t* uuid);

tBleStatus aci_att_prepare_write_req(uint16_t conn_handle, uint16_t attr_handle, uint16_t value_offset,
                                    uint8_t  attr_val_len, uint8_t* attr_val);

tBleStatus aci_att_execute_write_req(uint16_t conn_handle, uint8_t execute);

tBleStatus aci_gatt_disc_all_prim_services(uint16_t conn_handle);

tBleStatus aci_gatt_disc_prim_service_by_uuid(uint16_t conn_handle, uint8_t uuid_type, uint8_t* uuid);

tBleStatus aci_gatt_find_included_services(uint16_t conn_handle, uint16_t start_handle,
                       uint16_t end_handle);

tBleStatus aci_gatt_disc_all_charac_of_serv(uint16_t conn_handle, uint16_t start_attr_handle,
                        uint16_t end_attr_handle);

tBleStatus aci_gatt_disc_charac_by_uuid(uint16_t conn_handle, uint16_t start_handle,
                                     uint16_t end_handle, uint8_t uuid_type, const uint8_t* uuid);

tBleStatus aci_gatt_disc_all_charac_descriptors(uint16_t conn_handle, uint16_t char_val_handle,
                        uint16_t char_end_handle);

tBleStatus aci_gatt_read_charac_val(uint16_t conn_handle, uint16_t attr_handle);

tBleStatus aci_gatt_read_using_charac_uuid(uint16_t conn_handle, uint16_t start_handle, uint16_t end_handle,
                                    uint8_t  uuid_type, uint8_t* uuid);

tBleStatus aci_gatt_read_long_charac_val(uint16_t conn_handle, uint16_t attr_handle,
                     uint16_t val_offset);

tBleStatus aci_gatt_read_multiple_charac_val(uint16_t conn_handle, uint8_t num_handles, 
                                             uint8_t* set_of_handles);

tBleStatus aci_gatt_write_charac_value(uint16_t conn_handle, uint16_t attr_handle,
                       uint8_t value_len, uint8_t *attr_value);

tBleStatus aci_gatt_write_long_charac_val(uint16_t conn_handle, uint16_t attr_handle,
                                          uint16_t val_offset, uint8_t val_len, const uint8_t* attr_val);

tBleStatus aci_gatt_write_charac_reliable(uint16_t conn_handle, uint16_t attr_handle,
                                          uint16_t val_offset, uint8_t val_len, uint8_t* attr_val);

tBleStatus aci_gatt_write_long_charac_desc(uint16_t conn_handle, uint16_t attr_handle,
                                          uint16_t val_offset, uint8_t val_len, uint8_t* attr_val);

tBleStatus aci_gatt_read_long_charac_desc(uint16_t conn_handle, uint16_t attr_handle,
                                          uint16_t val_offset);

tBleStatus aci_gatt_write_charac_descriptor(uint16_t conn_handle, uint16_t attr_handle,
                       uint8_t value_len, uint8_t *attr_value);

tBleStatus aci_gatt_read_charac_desc(uint16_t conn_handle, uint16_t attr_handle);

tBleStatus aci_gatt_write_without_response(uint16_t conn_handle, uint16_t attr_handle,
                                              uint8_t val_len, const uint8_t* attr_val);

tBleStatus aci_gatt_signed_write_without_resp(uint16_t conn_handle, uint16_t attr_handle,
                                              uint8_t val_len, uint8_t* attr_val);

tBleStatus aci_gatt_confirm_indication(uint16_t conn_handle);

tBleStatus aci_gatt_write_response(uint16_t conn_handle,
                                   uint16_t attr_handle,
                                   uint8_t write_status,
                                   uint8_t err_code,
                                   uint8_t att_val_len,
                                   uint8_t *att_val);

tBleStatus aci_gatt_allow_read(uint16_t conn_handle);

tBleStatus aci_gatt_set_security_permission(uint16_t service_handle, uint16_t attr_handle,
                                            uint8_t security_permission);

tBleStatus aci_gatt_set_desc_value(uint16_t servHandle,
                   uint16_t charHandle,
                   uint16_t charDescHandle,
                   uint16_t charDescValOffset,
                   uint8_t charDescValueLen,
                   const void *charDescValue);

tBleStatus aci_gatt_read_handle_value(uint16_t attr_handle, uint16_t data_len, uint16_t *data_len_out_p, uint8_t *data);

tBleStatus aci_gatt_read_handle_value_offset_IDB05A1(uint16_t attr_handle, uint8_t offset, uint16_t data_len, uint16_t *data_len_out_p, uint8_t *data);

tBleStatus aci_gatt_update_char_value_ext_IDB05A1(uint16_t service_handle, uint16_t char_handle,
                                                  uint8_t update_type, uint16_t char_length,
                                                  uint16_t value_offset, uint8_t value_length,
                                                  const uint8_t* value);

tBleStatus aci_gatt_set_event_mask(uint32_t event_mask);

#define EVT_BLUE_GATT_ATTRIBUTE_MODIFIED          (0x0C01)

typedef __packed struct _evt_gatt_attr_modified_IDB05A1{
  uint16_t conn_handle; 
  uint16_t attr_handle; 
  uint8_t  data_length; 
  uint16_t  offset; 
  uint8_t  att_data[VARIABLE_SIZE]; 
} PACKED evt_gatt_attr_modified_IDB05A1;

typedef __packed struct _evt_gatt_attr_modified_IDB04A1{
  uint16_t conn_handle; 
  uint16_t attr_handle; 
  uint8_t  data_length; 
  uint8_t  att_data[VARIABLE_SIZE]; 
} PACKED evt_gatt_attr_modified_IDB04A1;

#define EVT_BLUE_GATT_PROCEDURE_TIMEOUT           (0x0C02)
typedef __packed struct _evt_gatt_procedure_timeout{
    uint16_t conn_handle; 
} PACKED evt_gatt_procedure_timeout;

#define EVT_BLUE_ATT_EXCHANGE_MTU_RESP        (0x0C03)
typedef __packed struct _evt_att_exchange_mtu_resp{
  uint16_t conn_handle; 
  uint8_t  event_data_length; 
  uint16_t server_rx_mtu; 
} PACKED evt_att_exchange_mtu_resp;

#define EVT_BLUE_ATT_FIND_INFORMATION_RESP    (0x0C04)
typedef __packed struct _evt_att_find_information_resp{
  uint16_t conn_handle;         
  uint8_t  event_data_length;   
  uint8_t  format;              
  uint8_t  handle_uuid_pair[VARIABLE_SIZE];
} PACKED evt_att_find_information_resp;

#define EVT_BLUE_ATT_FIND_BY_TYPE_VAL_RESP    (0x0C05)
typedef __packed struct _evt_att_find_by_type_val_resp{
  uint16_t conn_handle;             
  uint8_t  event_data_length;       
  uint8_t  handles_info_list[VARIABLE_SIZE];
} PACKED evt_att_find_by_type_val_resp;

#define EVT_BLUE_ATT_READ_BY_TYPE_RESP        (0x0C06)
typedef __packed struct _evt_att_read_by_type_resp{
  uint16_t conn_handle;             
  uint8_t  event_data_length;       
  uint8_t  handle_value_pair_length; 
  uint8_t  handle_value_pair[VARIABLE_SIZE];
} PACKED evt_att_read_by_type_resp;

#define EVT_BLUE_ATT_READ_RESP            (0x0C07)
typedef __packed struct _evt_att_read_resp{
  uint16_t conn_handle;             
  uint8_t  event_data_length;       
  uint8_t  attribute_value[VARIABLE_SIZE]; 
} PACKED evt_att_read_resp;

#define EVT_BLUE_ATT_READ_BLOB_RESP       (0x0C08)
typedef __packed struct _evt_att_read_blob_resp{
  uint16_t conn_handle;             
  uint8_t  event_data_length;       
  uint8_t  part_attribute_value[VARIABLE_SIZE]; 
} PACKED evt_att_read_blob_resp;

#define EVT_BLUE_ATT_READ_MULTIPLE_RESP       (0x0C09)
typedef __packed struct _evt_att_read_mult_resp{
  uint16_t conn_handle;             
  uint8_t  event_data_length;       
  uint8_t  set_of_values[VARIABLE_SIZE]; 
} PACKED evt_att_read_mult_resp;

#define EVT_BLUE_ATT_READ_BY_GROUP_TYPE_RESP           (0x0C0A)
typedef __packed struct _evt_att_read_by_group_resp{
  uint16_t conn_handle;             
  uint8_t  event_data_length;       
  uint8_t  attribute_data_length;   
  uint8_t  attribute_data_list[VARIABLE_SIZE];
} PACKED evt_att_read_by_group_resp;

#define EVT_BLUE_ATT_PREPARE_WRITE_RESP       (0x0C0C)
typedef __packed struct _evt_att_prepare_write_resp{
  uint16_t conn_handle;             
  uint8_t  event_data_length;       
  uint16_t  attribute_handle;       
  uint16_t  offset;                 
  uint8_t  part_attr_value[VARIABLE_SIZE]; 
} PACKED evt_att_prepare_write_resp;

#define EVT_BLUE_ATT_EXEC_WRITE_RESP          (0x0C0D)
typedef __packed struct _evt_att_exec_write_resp{
  uint16_t conn_handle;         
  uint8_t  event_data_length;   
} PACKED evt_att_exec_write_resp;

#define EVT_BLUE_GATT_INDICATION          (0x0C0E)
typedef __packed struct _evt_gatt_indication{
  uint16_t conn_handle;                 
  uint8_t  event_data_length;           
  uint16_t attr_handle;                 
  uint8_t  attr_value[VARIABLE_SIZE];   
} PACKED evt_gatt_indication;

#define EVT_BLUE_GATT_NOTIFICATION        (0x0C0F)
typedef __packed struct _evt_gatt_notification{
  uint16_t conn_handle;                 
  uint8_t  event_data_length;           
  uint16_t attr_handle;                 
  uint8_t  attr_value[VARIABLE_SIZE];   
} PACKED evt_gatt_attr_notification;

#define EVT_BLUE_GATT_PROCEDURE_COMPLETE          (0x0C10)
typedef __packed struct _evt_gatt_procedure_complete{
  uint16_t conn_handle; 
  uint8_t  data_length; 
  uint8_t  error_code;
} PACKED evt_gatt_procedure_complete;

#define EVT_BLUE_GATT_ERROR_RESP                  (0x0C11)
typedef __packed struct _evt_gatt_error_resp{
  uint16_t conn_handle;         
  uint8_t  event_data_length;   
  uint8_t  req_opcode;          
  uint16_t attr_handle;         
  uint8_t  error_code;          
} PACKED evt_gatt_error_resp;

#define EVT_BLUE_GATT_DISC_READ_CHAR_BY_UUID_RESP (0x0C12)
typedef __packed struct _evt_gatt_disc_read_char_by_uuid_resp{
  uint16_t conn_handle;                     
  uint8_t  event_data_length;               
  uint16_t attr_handle;                     
  uint8_t  attr_value[VARIABLE_SIZE];
} PACKED evt_gatt_disc_read_char_by_uuid_resp;

#define EVT_BLUE_GATT_WRITE_PERMIT_REQ            (0x0C13)
typedef __packed struct _evt_gatt_write_permit_req{
  uint16_t conn_handle; 
  uint16_t attr_handle; 
  uint8_t  data_length; 
  uint8_t  data[VARIABLE_SIZE]; 
} PACKED evt_gatt_write_permit_req;

#define EVT_BLUE_GATT_READ_PERMIT_REQ             (0x0C14)
typedef __packed struct _evt_gatt_read_permit_req{
  uint16_t conn_handle; 
  uint16_t attr_handle; 
  uint8_t  data_length; 
  uint16_t offset;      
} PACKED evt_gatt_read_permit_req;

#define EVT_BLUE_GATT_READ_MULTI_PERMIT_REQ       (0x0C15)
typedef __packed struct _evt_gatt_read_multi_permit_req{
  uint16_t conn_handle; 
  uint8_t  data_length; 
  uint8_t  data[VARIABLE_SIZE]; 
} PACKED evt_gatt_read_multi_permit_req;

#define EVT_BLUE_GATT_TX_POOL_AVAILABLE           (0x0C16)
typedef __packed struct _evt_gatt_tx_pool_available{
  uint16_t conn_handle; 
  uint16_t available_buffers; 
} PACKED evt_gatt_tx_pool_available;

#define EVT_BLUE_GATT_SERVER_CONFIRMATION_EVENT    (0x0C17)
typedef __packed struct _evt_gatt_server_confirmation{
  uint16_t conn_handle; 
} PACKED evt_gatt_server_confirmation;


#define EVT_BLUE_GATT_PREPARE_WRITE_PERMIT_REQ            (0x0C18)
typedef __packed struct _evt_gatt_prepare_write_permit_req{
  uint16_t conn_handle; 
  uint16_t attr_handle; 
  uint16_t offset; 
  uint8_t  data_length; 
  uint8_t  data[VARIABLE_SIZE]; 
} PACKED evt_gatt_prepare_write_permit_req;

#endif /* __BLUENRG_GATT_ACI_H__ */