bt_notify.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_NOTIFY_H__
#define __BT_NOTIFY_H__
#include "stdbool.h"
#include <stdint.h>
#include <string.h>
#include <stdio.h>
#ifdef __MTK_BLE_ONLY_ENABLE__
#include "bt_spp_dummy.h"
#else
#include "bt_spp.h"
#endif
#include <FreeRTOS.h>
#include <timers.h>

/*****************************************************************************
 * define
 *****************************************************************************/
#define BT_NOTIFY_MIN_RECEIVE_DATA_BUF_SIZE   (2*1024 + 1)  
#define BT_NOTIFY_MIN_PARSER_BUF_SIZE         (3*1024)      
#define BT_NOTIFY_MAX_CHANNEL                    1          
#define BT_NOTIFY_MAX_SENDER_LENGTH              50         
#define BT_NOTIFY_MAX_PAGE_CONTENT_LENGTH        300        
#define BT_NOTIFY_MAX_PAGE_TITLE_LENGTH          30         
#define BT_NOTIFY_MAX_PHONE_NUMBER_LENGTH              20         
/*actions related*/
#define BT_NOTIFY_MAX_ACTION_NUM                  5         
#define BT_NOTIFY_MAX_ACTION_NAME_LENGTH         20         
#define BT_NOTIFY_MAX_ACTION_ID_LENGTH           20         
#define BT_NOTIFY_MAX_GROUP_ID_LENGTH               30         
#define BT_NOTIFY_MAX_SENDER_RECEIVER_ID_LENGTH     16         
#ifdef _ICON_SUPPORT_ /*Define _ICON_SUPPORT_ macro to enable the notification icon feature, i.e. a notification with icon data from a remote device. The application needs to decode the icon data itself.*/
#define BT_NOTIFY_MAX_ICON_SIZE                2560            
#endif /*_ICON_SUPPORT_*/



typedef void (*bt_notify_callback_t)(void *data); 
typedef enum {
    BT_NOTIFY_EVENT_NONE = 1,       
    BT_NOTIFY_EVENT_CONNECTION,     
    BT_NOTIFY_EVENT_DISCONNECTION,  
    BT_NOTIFY_EVENT_SEND_IND,       
    BT_NOTIFY_EVENT_DATA_RECEIVED,  
    BT_NOTIFY_EVENT_NOTIFICATION,   
    BT_NOTIFY_EVENT_MISSED_CALL,    
    BT_NOTIFY_EVENT_SMS,            
    BT_NOTIFY_EVENT_END             
} bt_notify_event_t;

typedef struct {
    char sender_id[BT_NOTIFY_MAX_SENDER_RECEIVER_ID_LENGTH];               
    char receiver_id[BT_NOTIFY_MAX_SENDER_RECEIVER_ID_LENGTH];             
    int32_t error_code;                                                    
    uint8_t  data[BT_NOTIFY_MIN_RECEIVE_DATA_BUF_SIZE];                    
    uint16_t length;                                                       
} bt_notify_event_data_t;


typedef enum {
    BT_NOTIFY_REMOTE_SYSTEM_NONE,       
    BT_NOTIFY_REMOTE_SYSTEM_ANDROID,    
    BT_NOTIFY_REMOTE_SYSTEM_IOS         
} bt_notify_remote_system_type_t;

typedef enum {
    BT_NOTIFY_ACTION_TYPE_NEW,        
    BT_NOTIFY_ACTION_TYPE_DELETE      
} bt_notify_action_type_t;


#ifdef _ICON_SUPPORT_ /*Define _ICON_SUPPORT_ macro to enable the notification icon feature, i.e. a notification with icon data from a remote device. The application needs to decode the icon data itself.*/
typedef struct {
    uint8_t icon_buffer[BT_NOTIFY_MAX_ICON_SIZE]; /*Requires a Base64 decoder.*/
    uint32_t icon_size;
} bt_notify_data_icon_t;
#endif /*_ICON_SUPPORT_*/

typedef struct page_struct {
    uint16_t content[BT_NOTIFY_MAX_PAGE_CONTENT_LENGTH];   
    uint16_t title[BT_NOTIFY_MAX_PAGE_TITLE_LENGTH];       
    struct page_struct *next;                              
} bt_notify_page_content_list_t;

typedef struct {
    uint16_t action_id[BT_NOTIFY_MAX_ACTION_ID_LENGTH];         
    uint16_t action_name[BT_NOTIFY_MAX_ACTION_NAME_LENGTH];     
} bt_notify_action_content_t;

typedef struct {
    uint16_t sender[BT_NOTIFY_MAX_SENDER_LENGTH];              
    uint32_t page_num;                                         
    bt_notify_page_content_list_t *page_content;                    
    uint32_t action_number;                                    
    bt_notify_action_content_t action_content[BT_NOTIFY_MAX_ACTION_NUM];  
    uint8_t group_id[BT_NOTIFY_MAX_GROUP_ID_LENGTH];              
    uint32_t timestamp;                                        
    uint32_t app_id;                                           
    bt_notify_action_type_t action;                    
    uint32_t msg_id;                                           
#ifdef _ICON_SUPPORT_ /*Define _ICON_SUPPORT_ macro to enable the notification icon feature, i.e. a notification with icon data from a remote device. The application needs to decode the icon data itself.*/
    bt_notify_data_icon_t *icon;                               
#endif /*_ICON_SUPPORT_*/

} bt_notify_notification_t;

typedef struct {
    uint16_t sender[BT_NOTIFY_MAX_SENDER_LENGTH];            
    uint16_t sender_number[BT_NOTIFY_MAX_PHONE_NUMBER_LENGTH]; 
    bt_notify_page_content_list_t *page_content;             
    uint32_t msg_id;                                         
    uint32_t timestamp;                                      
} bt_notify_sms_t;

typedef struct {
    uint16_t sender[BT_NOTIFY_MAX_SENDER_LENGTH];      
    uint16_t sender_number[BT_NOTIFY_MAX_PHONE_NUMBER_LENGTH]; 
    uint32_t msg_id;                                   
    uint32_t missed_call_count;                        
    uint32_t timestamp;                                
} bt_notify_missed_call_t;

typedef struct {
    bt_notify_event_t evt_id;                
    bt_notify_remote_system_type_t remote_system; 
    bt_bd_addr_t bt_addr;                    
    bt_notify_event_data_t event_data;              
    bt_notify_notification_t notification;           
    bt_notify_sms_t sms;                     
    bt_notify_missed_call_t missed_call;            
} bt_notify_callback_data_t;

typedef enum {
    BT_NOTIFY_RESULT_NOT_SUPPORTED = -9,                        
    BT_NOTIFY_RESULT_INVALID_PARAMETER,                         
    BT_NOTIFY_RESULT_PARSING_ERROR,                             
    BT_NOTIFY_RESULT_CHANNAL_UNAVAILABLE,                       
    BT_NOTIFY_RESULT_FAILED,                                    
    BT_NOTIFY_RESULT_REGISTER_INVALID_PARAMETER,                
    BT_NOTIFY_RESULT_REGISTER_SYSTEM_ALREADY_REGISTERED,        
    BT_NOTIFY_RESULT_REGISTER_REPEATED_REGISTRATION,            
    BT_NOTIFY_RESULT_REGISTER_NOT_IMPLEMENTED,                  
    BT_NOTIFY_RESULT_REGISTER_OK,                               
    BT_NOTIFY_RESULT_NO_ERROR = BT_NOTIFY_RESULT_REGISTER_OK,   
} bt_notify_result_t;

typedef enum {
    BT_NOTIFY_DATA_SOURCE_INVALID = 0x00,   
    BT_NOTIFY_DATA_SOURCE_SPP = 0x01,       
    BT_NOTIFY_DATA_SOURCE_DOGP = 0x02,      
} bt_notify_data_source_t;

bt_notify_result_t bt_notify_register_callback(const bt_bd_addr_t *bt_addr,  char *sender, bt_notify_callback_t cb_ptr);
bt_notify_result_t bt_notify_deregister_callback(const bt_bd_addr_t *bt_addr, bt_notify_callback_t cb_ptr);
int32_t bt_notify_send_data(bt_bd_addr_t *bt_addr,  const char *data, uint16_t data_len, bool is_new);

void bt_notify_init(uint8_t sdp_id);

bt_notify_data_source_t bt_notify_get_data_source(bt_bd_addr_t *bt_addr);


#endif/*__BT_NOTIFY_H__*/