ble_gattc.h

/*
 * Copyright (c) Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 *    Semiconductor ASA integrated circuit in a product or a software update for
 *    such product, 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.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 *    Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 *    engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA 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.
 */
 
#ifndef BLE_GATTC_H__
#define BLE_GATTC_H__
 
#include <stdint.h>
#include "nrf_svc.h"
#include "nrf_error.h"
#include "ble_ranges.h"
#include "ble_types.h"
#include "ble_err.h"
#include "ble_gatt.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum BLE_GATTC_SVCS
{
  SD_BLE_GATTC_PRIMARY_SERVICES_DISCOVER = BLE_GATTC_SVC_BASE, 
  SD_BLE_GATTC_RELATIONSHIPS_DISCOVER,                         
  SD_BLE_GATTC_CHARACTERISTICS_DISCOVER,                       
  SD_BLE_GATTC_DESCRIPTORS_DISCOVER,                           
  SD_BLE_GATTC_ATTR_INFO_DISCOVER,                             
  SD_BLE_GATTC_CHAR_VALUE_BY_UUID_READ,                        
  SD_BLE_GATTC_READ,                                           
  SD_BLE_GATTC_CHAR_VALUES_READ,                               
  SD_BLE_GATTC_WRITE,                                          
  SD_BLE_GATTC_HV_CONFIRM,                                     
  SD_BLE_GATTC_EXCHANGE_MTU_REQUEST,                           
};
 
enum BLE_GATTC_EVTS
{
  BLE_GATTC_EVT_PRIM_SRVC_DISC_RSP = BLE_GATTC_EVT_BASE,  
  BLE_GATTC_EVT_REL_DISC_RSP,                             
  BLE_GATTC_EVT_CHAR_DISC_RSP,                            
  BLE_GATTC_EVT_DESC_DISC_RSP,                            
  BLE_GATTC_EVT_ATTR_INFO_DISC_RSP,                       
  BLE_GATTC_EVT_CHAR_VAL_BY_UUID_READ_RSP,                
  BLE_GATTC_EVT_READ_RSP,                                 
  BLE_GATTC_EVT_CHAR_VALS_READ_RSP,                       
  BLE_GATTC_EVT_WRITE_RSP,                                
  BLE_GATTC_EVT_HVX,                                      
  BLE_GATTC_EVT_EXCHANGE_MTU_RSP,                         
  BLE_GATTC_EVT_TIMEOUT,                                  
  BLE_GATTC_EVT_WRITE_CMD_TX_COMPLETE                     
};
 
enum BLE_GATTC_OPTS
{
  BLE_GATTC_OPT_UUID_DISC = BLE_GATTC_OPT_BASE,     
};
 
#define BLE_ERROR_GATTC_PROC_NOT_PERMITTED    (NRF_GATTC_ERR_BASE + 0x000) 
#define BLE_GATTC_ATTR_INFO_FORMAT_16BIT    1 
#define BLE_GATTC_ATTR_INFO_FORMAT_128BIT   2 
#define BLE_GATTC_WRITE_CMD_TX_QUEUE_SIZE_DEFAULT  1 
typedef struct
{
  uint8_t  write_cmd_tx_queue_size; 
} ble_gattc_conn_cfg_t;
 
typedef struct
{
  uint16_t          start_handle; 
  uint16_t          end_handle;   
} ble_gattc_handle_range_t;
 
 
typedef struct
{
  ble_uuid_t               uuid;          
  ble_gattc_handle_range_t handle_range;  
} ble_gattc_service_t;
 
 
typedef struct
{
  uint16_t            handle;           
  ble_gattc_service_t included_srvc;    
} ble_gattc_include_t;
 
 
typedef struct
{
  ble_uuid_t              uuid;                 
  ble_gatt_char_props_t   char_props;           
  uint8_t                 char_ext_props : 1;   
  uint16_t                handle_decl;          
  uint16_t                handle_value;         
} ble_gattc_char_t;
 
 
typedef struct
{
  uint16_t          handle;         
  ble_uuid_t        uuid;           
} ble_gattc_desc_t;
 
 
typedef struct
{
  uint8_t        write_op;             
  uint8_t        flags;                
  uint16_t       handle;               
  uint16_t       offset;               
  uint16_t       len;                  
  uint8_t const *p_value;              
} ble_gattc_write_params_t;
 
typedef struct
{
  uint16_t       handle;               
  ble_uuid_t     uuid;                 
} ble_gattc_attr_info16_t;
 
typedef struct
{
  uint16_t       handle;               
  ble_uuid128_t  uuid;                 
} ble_gattc_attr_info128_t;
 
typedef struct
{
  uint16_t             count;           
  ble_gattc_service_t services[1];      
} ble_gattc_evt_prim_srvc_disc_rsp_t;
 
typedef struct
{
  uint16_t             count;           
  ble_gattc_include_t includes[1];      
} ble_gattc_evt_rel_disc_rsp_t;
 
typedef struct
{
  uint16_t            count;          
  ble_gattc_char_t    chars[1];       
} ble_gattc_evt_char_disc_rsp_t;
 
typedef struct
{
  uint16_t            count;          
  ble_gattc_desc_t    descs[1];       
} ble_gattc_evt_desc_disc_rsp_t;
 
typedef struct
{
  uint16_t                     count;            
  uint8_t                      format;           
  union
  {
    ble_gattc_attr_info16_t  attr_info16[1];     
    ble_gattc_attr_info128_t attr_info128[1];    
  } info;                                        
} ble_gattc_evt_attr_info_disc_rsp_t;
 
typedef struct
{
  uint16_t            handle;          
  uint8_t            *p_value;         
} ble_gattc_handle_value_t;
 
typedef struct
{
  uint16_t                  count;            
  uint16_t                  value_len;        
  uint8_t                   handle_value[1];  
} ble_gattc_evt_char_val_by_uuid_read_rsp_t;
 
typedef struct
{
  uint16_t            handle;         
  uint16_t            offset;         
  uint16_t            len;            
  uint8_t             data[1];        
} ble_gattc_evt_read_rsp_t;
 
typedef struct
{
  uint16_t            len;            
  uint8_t             values[1];      
} ble_gattc_evt_char_vals_read_rsp_t;
 
typedef struct
{
  uint16_t            handle;           
  uint8_t             write_op;         
  uint16_t            offset;           
  uint16_t            len;              
  uint8_t             data[1];          
} ble_gattc_evt_write_rsp_t;
 
typedef struct
{
  uint16_t            handle;         
  uint8_t             type;           
  uint16_t            len;            
  uint8_t             data[1];        
} ble_gattc_evt_hvx_t;
 
typedef struct
{
  uint16_t          server_rx_mtu;            
} ble_gattc_evt_exchange_mtu_rsp_t;
 
typedef struct
{
  uint8_t          src;                       
} ble_gattc_evt_timeout_t;
 
typedef struct
{
  uint8_t             count;            
} ble_gattc_evt_write_cmd_tx_complete_t;
 
typedef struct
{
  uint16_t            conn_handle;                
  uint16_t            gatt_status;                
  uint16_t            error_handle;               
  union
  {
    ble_gattc_evt_prim_srvc_disc_rsp_t          prim_srvc_disc_rsp;         
    ble_gattc_evt_rel_disc_rsp_t                rel_disc_rsp;               
    ble_gattc_evt_char_disc_rsp_t               char_disc_rsp;              
    ble_gattc_evt_desc_disc_rsp_t               desc_disc_rsp;              
    ble_gattc_evt_char_val_by_uuid_read_rsp_t   char_val_by_uuid_read_rsp;  
    ble_gattc_evt_read_rsp_t                    read_rsp;                   
    ble_gattc_evt_char_vals_read_rsp_t          char_vals_read_rsp;         
    ble_gattc_evt_write_rsp_t                   write_rsp;                  
    ble_gattc_evt_hvx_t                         hvx;                        
    ble_gattc_evt_exchange_mtu_rsp_t            exchange_mtu_rsp;           
    ble_gattc_evt_timeout_t                     timeout;                    
    ble_gattc_evt_attr_info_disc_rsp_t          attr_info_disc_rsp;         
    ble_gattc_evt_write_cmd_tx_complete_t       write_cmd_tx_complete;      
  } params;                                                                 
} ble_gattc_evt_t;
 
typedef struct
{
  uint8_t auto_add_vs_enable : 1;   
} ble_gattc_opt_uuid_disc_t;
 
typedef union
{
  ble_gattc_opt_uuid_disc_t uuid_disc;  
} ble_gattc_opt_t;
 
SVCALL(SD_BLE_GATTC_PRIMARY_SERVICES_DISCOVER, uint32_t, sd_ble_gattc_primary_services_discover(uint16_t conn_handle, uint16_t start_handle, ble_uuid_t const *p_srvc_uuid));
 
 
SVCALL(SD_BLE_GATTC_RELATIONSHIPS_DISCOVER, uint32_t, sd_ble_gattc_relationships_discover(uint16_t conn_handle, ble_gattc_handle_range_t const *p_handle_range));
 
 
SVCALL(SD_BLE_GATTC_CHARACTERISTICS_DISCOVER, uint32_t, sd_ble_gattc_characteristics_discover(uint16_t conn_handle, ble_gattc_handle_range_t const *p_handle_range));
 
 
SVCALL(SD_BLE_GATTC_DESCRIPTORS_DISCOVER, uint32_t, sd_ble_gattc_descriptors_discover(uint16_t conn_handle, ble_gattc_handle_range_t const *p_handle_range));
 
 
SVCALL(SD_BLE_GATTC_CHAR_VALUE_BY_UUID_READ, uint32_t, sd_ble_gattc_char_value_by_uuid_read(uint16_t conn_handle, ble_uuid_t const *p_uuid, ble_gattc_handle_range_t const *p_handle_range));
 
 
SVCALL(SD_BLE_GATTC_READ, uint32_t, sd_ble_gattc_read(uint16_t conn_handle, uint16_t handle, uint16_t offset));
 
 
SVCALL(SD_BLE_GATTC_CHAR_VALUES_READ, uint32_t, sd_ble_gattc_char_values_read(uint16_t conn_handle, uint16_t const *p_handles, uint16_t handle_count));
 
 
SVCALL(SD_BLE_GATTC_WRITE, uint32_t, sd_ble_gattc_write(uint16_t conn_handle, ble_gattc_write_params_t const *p_write_params));
 
 
SVCALL(SD_BLE_GATTC_HV_CONFIRM, uint32_t, sd_ble_gattc_hv_confirm(uint16_t conn_handle, uint16_t handle));
 
SVCALL(SD_BLE_GATTC_ATTR_INFO_DISCOVER, uint32_t, sd_ble_gattc_attr_info_discover(uint16_t conn_handle, ble_gattc_handle_range_t const * p_handle_range));
 
SVCALL(SD_BLE_GATTC_EXCHANGE_MTU_REQUEST, uint32_t, sd_ble_gattc_exchange_mtu_request(uint16_t conn_handle, uint16_t client_rx_mtu));
 
#ifndef SUPPRESS_INLINE_IMPLEMENTATION
static inline uint32_t sd_ble_gattc_evt_char_val_by_uuid_read_rsp_iter(ble_gattc_evt_t *p_gattc_evt, ble_gattc_handle_value_t *p_iter)
{
  uint32_t value_len = p_gattc_evt->params.char_val_by_uuid_read_rsp.value_len;
  uint8_t *p_first = p_gattc_evt->params.char_val_by_uuid_read_rsp.handle_value;
  uint8_t *p_next = p_iter->p_value ? p_iter->p_value + value_len : p_first;
 
  if ((p_next - p_first) / (sizeof(uint16_t) + value_len) < p_gattc_evt->params.char_val_by_uuid_read_rsp.count)
  {
    p_iter->handle = (uint16_t)((uint16_t)p_next[1] << 8U | p_next[0]);
    p_iter->p_value = p_next + sizeof(uint16_t);
    return NRF_SUCCESS;
  }
  else
  {
    return NRF_ERROR_NOT_FOUND;
  }
}
#else
uint32_t sd_ble_gattc_evt_char_val_by_uuid_read_rsp_iter(ble_gattc_evt_t *p_gattc_evt, ble_gattc_handle_value_t *p_iter);
#endif /* SUPPRESS_INLINE_IMPLEMENTATION */
 
#ifdef __cplusplus
}
#endif
#endif /* BLE_GATTC_H__ */