bt_gattc.h

/* Copyright Statement:
 *
 * (C) 2005-2016  MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User").  If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __BT_GATT_H__
#define __BT_GATT_H__

#include <stdint.h>
#include "bt_att.h"
#include "bt_gatt.h"
#include "bt_system.h"
#include "bt_platform.h"
#include "bt_type.h"
#include "bt_uuid.h"

BT_EXTERN_C_BEGIN

#define BT_GATTC_EXCHANGE_MTU                                 (BT_MODULE_GATT | 0x00010000)      
#define BT_GATTC_DISCOVER_PRIMARY_SERVICE                     (BT_MODULE_GATT | 0x00020000)      
#define BT_GATTC_DISCOVER_PRIMARY_SERVICE_BY_UUID             (BT_MODULE_GATT | 0x00030000)      
#define BT_GATTC_FIND_INCLUDED_SERVICES                       (BT_MODULE_GATT | 0x00040000)      
#define BT_GATTC_DISCOVER_CHARC                               (BT_MODULE_GATT | 0x00050000)      
#define BT_GATTC_DISCOVER_CHARC_DESCRIPTOR                    (BT_MODULE_GATT | 0x00060000)      
#define BT_GATTC_READ_CHARC                                   (BT_MODULE_GATT | 0x00070000)      
#define BT_GATTC_READ_LONG_CHARC                              (BT_MODULE_GATT | 0x00080000)      
#define BT_GATTC_READ_USING_CHARC_UUID                        (BT_MODULE_GATT | 0x00090000)      
#define BT_GATTC_READ_MULTI_CHARC_VALUES                      (BT_MODULE_GATT | 0x000A0000)      
#define BT_GATTC_WRITE_CHARC                                  (BT_MODULE_GATT | 0x000D0000)      
#define BT_GATTC_WRITE_LONG_CHARC                             (BT_MODULE_GATT | 0x000E0000)      
#define BT_GATTC_RELIABLE_WRITE_CHARC                         (BT_MODULE_GATT | 0x000F0000)      
#define BT_GATTC_CHARC_VALUE_NOTIFICATION                     (BT_MODULE_GATT | 0x00110000)      
#define BT_GATTC_CHARC_VALUE_INDICATION                       (BT_MODULE_GATT | 0x00120000)      
#define BT_GATTC_CHARC_VALUE_CONFIRMATION                     (BT_MODULE_GATT | 0x00130000)      
typedef bt_att_exchange_mtu_req_t bt_gattc_exchange_mtu_req_t;

BT_PACKED (
typedef struct {
    uint8_t opcode;             
    uint16_t starting_handle;   
    uint16_t ending_handle;     
    uint16_t type16;            
}) bt_gattc_discover_primary_service_req_t;

BT_PACKED (
typedef struct {
    uint16_t attribute_value_length;             
    bt_att_find_by_type_value_req_t *att_req;   
}) bt_gattc_discover_primary_service_by_uuid_req_t;

typedef bt_gattc_discover_primary_service_req_t bt_gattc_find_included_services_req_t;

BT_PACKED (
typedef struct {
    uint8_t opcode;             
    uint16_t starting_handle;   
    uint16_t ending_handle;     
    bt_uuid_t type;             
}) bt_gattc_discover_charc_req_t;

typedef bt_att_find_info_req_t bt_gattc_discover_charc_descriptor_req_t;

typedef bt_att_read_req_t bt_gattc_read_charc_req_t;

typedef bt_att_read_blob_req_t bt_gattc_read_long_charc_value_req_t;

typedef bt_att_read_by_type_req_t bt_gattc_read_using_charc_uuid_req_t;

BT_PACKED (
typedef struct {
    uint16_t handle_length;                  
    bt_att_read_multiple_req_t *att_req;    
}) bt_gattc_read_multi_charc_values_req_t;

BT_PACKED (
typedef struct {
    uint16_t attribute_value_length;         
    bt_att_write_command_t *att_req;        
}) bt_gattc_write_without_rsp_req_t;

BT_PACKED (
typedef struct {
    uint16_t attribute_value_length;         
    bt_att_write_req_t *att_req;            
}) bt_gattc_write_charc_req_t;

BT_PACKED (
typedef struct {
    uint16_t attribute_value_length;        
    bt_att_prepare_write_req_t *att_req;    
}) bt_gattc_prepare_write_charc_req_t;

typedef bt_att_execute_write_req_t bt_gattc_execute_write_req_t;

BT_PACKED (
typedef struct {
    uint16_t attribute_value_length;                
    bt_att_handle_value_notification_t att_req;     
}) bt_gattc_charc_value_notification_indication_t;

BT_PACKED (
typedef struct {
    uint16_t length;                         
    bt_handle_t connection_handle;          
    bt_att_error_rsp_t *att_rsp;            
}) bt_gattc_error_rsp_t;

BT_PACKED (
typedef struct {
    bt_handle_t connection_handle;          
    uint16_t server_rx_mtu;                 
}) bt_gatt_exchange_mtu_rsp_t;

BT_PACKED (
typedef struct {
    uint16_t length;                        
    bt_handle_t connection_handle;          
    bt_att_find_info_rsp_t *att_rsp;        
}) bt_gattc_find_info_rsp_t;

BT_PACKED (
typedef struct {
    uint16_t length;                                
    bt_handle_t connection_handle;                  
    bt_att_find_by_type_value_rsp_t *att_rsp;       
}) bt_gattc_find_by_type_value_rsp_t;

BT_PACKED (
typedef struct {
    uint16_t length;                        
    bt_handle_t connection_handle;          
    bt_att_read_by_type_rsp_t *att_rsp;     
}) bt_gattc_read_by_type_rsp_t;

BT_PACKED (
typedef struct {
    uint16_t length;                    
    bt_handle_t connection_handle;      
    bt_att_read_rsp_t *att_rsp;         
}) bt_gattc_read_rsp_t;

BT_PACKED (
typedef struct {
    uint16_t length;                    
    bt_handle_t connection_handle;      
    bt_att_read_blob_rsp_t *att_rsp;    
}) bt_gattc_read_blob_rsp_t;

BT_PACKED (
typedef struct {
    uint16_t length;                        
    bt_handle_t connection_handle;          
    bt_att_read_multiple_rsp_t *att_rsp;    
}) bt_gattc_read_multiple_rsp_t;

BT_PACKED (
typedef struct {
    uint16_t length;                            
    bt_handle_t connection_handle;              
    bt_att_read_by_group_type_rsp_t *att_rsp;   
}) bt_gattc_read_by_group_type_rsp_t;

BT_PACKED (
typedef struct {
    bt_handle_t connection_handle;              
    bt_att_write_rsp_t *att_rsp;                
}) bt_gattc_write_rsp_t;

BT_PACKED (
typedef struct {
    uint16_t attribute_value_length;        
    bt_handle_t connection_handle;          
    bt_att_prepare_write_rsp_t *att_rsp;    
}) bt_gattc_prepare_write_rsp_t;


BT_PACKED (
typedef struct {
    bt_handle_t connection_handle;              
    bt_att_execute_write_rsp_t *att_rsp;        
}) bt_gattc_execute_write_rsp_t;

BT_PACKED (
typedef struct {
    uint16_t length;                                
    bt_handle_t connection_handle;                  
    bt_att_handle_value_notification_t *att_rsp;    
}) bt_gatt_handle_value_notification_t;

typedef bt_gatt_handle_value_notification_t bt_gatt_handle_value_indication_t;

typedef bt_att_handle_value_confirmation_t bt_gattc_handle_value_confirmation_t;

#define BT_GATTC_NEW_EXCHANGE_MTU_REQ(name, mtu)        \
    static bt_gattc_exchange_mtu_req_t name;            \
    name.opcode = BT_ATT_OPCODE_EXCHANGE_MTU_REQUEST;   \
    name.client_rx_mtu = mtu;                           \


#define BT_GATTC_NEW_DISCOVER_PRIMARY_SERVICE_REQ(name)             \
    static const bt_gattc_discover_primary_service_req_t name = {   \
    .opcode = BT_ATT_OPCODE_READ_BY_GROUP_TYPE_REQUEST,             \
    .starting_handle = 0x0001,                                      \
    .ending_handle = 0xFFFF,                                        \
    .type16 = BT_GATT_UUID16_PRIMARY_SERVICE                        \
    }

#define BT_GATTC_NEW_DISCOVER_PRIMARY_SERVICE_BY_UUID16_REQ(name, uuid16)       \
    static bt_gattc_discover_primary_service_by_uuid_req_t name;                \
    static uint8_t name##buf[9];                                                \
    name.attribute_value_length = 2;                                            \
    name.att_req = (bt_att_find_by_type_value_req_t *)(name##buf);              \
    name.att_req->opcode = BT_ATT_OPCODE_FIND_BY_TYPE_VALUE_REQUEST;            \
    name.att_req->starting_handle = 0x0001;                                     \
    name.att_req->ending_handle = 0xFFFF;                                       \
    name.att_req->uuid = BT_GATT_UUID16_PRIMARY_SERVICE;                        \
    memcpy(&(name.att_req->attribute_value), &uuid16, 2);

#define BT_GATTC_NEW_DISCOVER_PRIMARY_SERVICE_BY_UUID128_REQ(name, uuid128)       \
    static bt_gattc_discover_primary_service_by_uuid_req_t name;                \
    static uint8_t name##buf[30];                                                \
    name.attribute_value_length = 16;                                            \
    name.att_req = (bt_att_find_by_type_value_req_t *)(name##buf);              \
    name.att_req->opcode = BT_ATT_OPCODE_FIND_BY_TYPE_VALUE_REQUEST;            \
    name.att_req->starting_handle = 0x0001;                                     \
    name.att_req->ending_handle = 0xFFFF;                                       \
    name.att_req->uuid = BT_GATT_UUID16_PRIMARY_SERVICE;                        \
    memcpy(&(name.att_req->attribute_value), &uuid128, 16);

#define BT_GATTC_NEW_FIND_INCLUDED_SERVICE_REQ(name, start_handle, end_handle)       \
    static bt_gattc_find_included_services_req_t name;          \
    name.opcode = BT_ATT_OPCODE_READ_BY_TYPE_REQUEST;           \
    name.type16 = BT_GATT_UUID16_INCLUDE;                       \
    name.starting_handle = start_handle;                        \
    name.ending_handle = end_handle;

#define BT_GATTC_NEW_DISCOVER_CHARC_REQ(name, start_handle, end_handle)       \
    static bt_gattc_discover_charc_req_t name;              \
    name.opcode = BT_ATT_OPCODE_READ_BY_TYPE_REQUEST;       \
    name.starting_handle = start_handle;                    \
    name.ending_handle = end_handle;                        \
    uint16_t name##uuid_16 = BT_GATT_UUID16_CHARC;          \
    bt_uuid_load(&(name.type), (void *)&(name##uuid_16), 2);

#define BT_GATTC_NEW_DISCOVER_CHARC_BY_UUID_REQ(name, start_handle, end_handle, uuid, len)       \
    static bt_gattc_discover_charc_req_t name;              \
    name.opcode = BT_ATT_OPCODE_READ_BY_TYPE_REQUEST;       \
    name.starting_handle = start_handle;                    \
    name.ending_handle = end_handle;                        \
    bt_uuid_load(&(name.type), (void *)uuid, len);

#define BT_GATTC_NEW_DISCOVER_CHARC_DESCRIPTOR_REQ(name, start_handle, end_handle)  \
    static bt_gattc_discover_charc_descriptor_req_t name;    \
    name.opcode = BT_ATT_OPCODE_FIND_INFORMATION_REQUEST;    \
    name.starting_handle = start_handle;                     \
    name.ending_handle = end_handle;

#define BT_GATTC_NEW_READ_CHARC_REQ(name, attr_handle)  \
    static bt_gattc_read_charc_req_t name;              \
    name.opcode = BT_ATT_OPCODE_READ_REQUEST;           \
    name.attribute_handle = attr_handle;

#define BT_GATTC_NEW_READ_LONG_CHARC_REQ(name, attr_handle, offset)  \
    static bt_gattc_read_long_charc_value_req_t name;              \
    name.opcode = BT_ATT_OPCODE_READ_BLOB_REQUEST;          \
    name.attribute_handle = attr_handle;                    \
    name.value_offset = offset;

#define BT_GATTC_NEW_READ_USING_CHARC_UUID_REQ(name, start_handle, end_handle, uuid, len)  \
    static bt_gattc_read_using_charc_uuid_req_t name;       \
    name.opcode = BT_ATT_OPCODE_READ_BY_TYPE_REQUEST;       \
    name.starting_handle = start_handle;                    \
    name.ending_handle = end_handle;                        \
    bt_uuid_load(&name.type, (void *)uuid, len);

#define BT_GATTC_NEW_WRITE_WITHOUT_RSP_REQ(name, buffer, type, attribute_handle, attribute_value, attribute_len)  \
    static bt_gattc_write_without_rsp_req_t name;               \
    name.attribute_value_length = attribute_len;                \
    name.att_req = (bt_att_write_command_t *)(buffer);          \
    name.att_req->opcode = (type == 0 ? BT_ATT_OPCODE_WRITE_COMMAND : BT_ATT_OPCODE_SIGNED_WRITE_COMMAND);  \
    name.att_req->attribute_handle = attribute_handle;          \
    memcpy(name.att_req->attribute_value, attribute_value, attribute_len);

#define BT_GATTC_NEW_WRITE_CHARC_REQ(name, buffer, attribute_handle, attribute_value, attribute_len)  \
    static bt_gattc_write_charc_req_t name;                 \
    name.attribute_value_length = attribute_len;            \
    name.att_req = (bt_att_write_req_t *)(buffer);          \
    name.att_req->opcode = BT_ATT_OPCODE_WRITE_REQUEST;     \
    name.att_req->attribute_handle = attribute_handle;          \
    memcpy(name.att_req->attribute_value, attribute_value, attribute_len);

#define BT_GATTC_NEW_PREPARE_WRITE_REQ(name, attr_handle, offset, value, value_len) \
    static bt_gattc_prepare_write_charc_req_t name;                 \
    static bt_att_prepare_write_req_t name##att_req;                \
    (name##att_req).opcode = BT_ATT_OPCODE_PREPARE_WRITE_REQUEST;   \
    (name##att_req).attribute_handle = attr_handle;            \
    (name##att_req).value_offset = offset;                          \
    (name##att_req).part_attribute_value = value;                   \
    name.attribute_value_length = value_len;                        \
    name.att_req = &(name##att_req);

#define BT_GATTC_NEW_EXECUTE_WRITE_REQ(name, flag)      \
    static bt_gattc_execute_write_req_t name;           \
    name.opcode = BT_ATT_OPCODE_EXECUTE_WRITE_REQUEST;  \
    name.flags = flag;

bt_status_t bt_gattc_exchange_mtu(bt_handle_t connection_handle,
                                  const bt_gattc_exchange_mtu_req_t *req);

uint32_t bt_gattc_get_mtu(bt_handle_t connection_handle);

bt_status_t bt_gattc_discover_primary_service(
    bt_handle_t connection_handle,
    const bt_gattc_discover_primary_service_req_t *req);

bt_status_t bt_gattc_discover_primary_service_by_uuid(
    bt_handle_t connection_handle,
    const bt_gattc_discover_primary_service_by_uuid_req_t *req);

bt_status_t bt_gattc_find_included_services(
    bt_handle_t connection_handle,
    const bt_gattc_find_included_services_req_t *req);
bt_status_t bt_gattc_discover_charc(
    bt_handle_t connection_handle,
    const bt_gattc_discover_charc_req_t *req);

bt_status_t bt_gattc_discover_charc_descriptor(
    bt_handle_t connection_handle,
    const bt_gattc_discover_charc_descriptor_req_t *req);

bt_status_t bt_gattc_read_charc(
    bt_handle_t connection_handle,
    const bt_gattc_read_charc_req_t *req);

bt_status_t bt_gattc_read_long_charc(
    bt_handle_t connection_handle,
    const bt_gattc_read_long_charc_value_req_t *req);

bt_status_t bt_gattc_read_using_charc_uuid(
    bt_handle_t connection_handle,
    const bt_gattc_read_using_charc_uuid_req_t *req);

bt_status_t bt_gattc_read_multi_charc_values(
    bt_handle_t connection_handle,
    const bt_gattc_read_multi_charc_values_req_t *req);

bt_status_t bt_gattc_write_without_rsp(
    bt_handle_t connection_handle,
    uint8_t is_signed,
    const bt_gattc_write_without_rsp_req_t *req);


bt_status_t bt_gattc_write_charc(
    bt_handle_t connection_handle,
    const bt_gattc_write_charc_req_t *req);

bt_status_t bt_gattc_prepare_write_charc(
    bt_handle_t connection_handle,
    uint8_t is_reliable,
    uint16_t offset,
    const bt_gattc_prepare_write_charc_req_t *req);

bt_status_t bt_gattc_send_execute_write_req(
    bt_handle_t connection_handle,
    const bt_gattc_execute_write_req_t *req);

BT_EXTERN_C_END

#endif /*__BT_GATT_H__*/