/************************************************************************************ * * Copyright (C) 2009-2012 Broadcom Corporation * * This program is the proprietary software of Broadcom Corporation and/or its * licensors, and may only be used, duplicated, modified or distributed * pursuant to the terms and conditions of a separate, written license * agreement executed between you and Broadcom (an "Authorized License"). * Except as set forth in an Authorized License, Broadcom grants no license * (express or implied), right to use, or waiver of any kind with respect to * the Software, and Broadcom expressly reserves all rights in and to the * Software and all intellectual property rights therein. * IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU HAVE NO RIGHT TO USE THIS * SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY NOTIFY BROADCOM AND DISCONTINUE * ALL USE OF THE SOFTWARE. * * Except as expressly set forth in the Authorized License, * * 1. This program, including its structure, sequence and organization, * constitutes the valuable trade secrets of Broadcom, and you shall * use all reasonable efforts to protect the confidentiality thereof, * and to use this information only in connection with your use of * Broadcom integrated circuit products. * * 2. TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED * "AS IS" AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES, * REPRESENTATIONS OR WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, * OR OTHERWISE, WITH RESPECT TO THE SOFTWARE. BROADCOM SPECIFICALLY * DISCLAIMS ANY AND ALL IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, * NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, LACK OF VIRUSES, * ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION OR * CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING OUT * OF USE OR PERFORMANCE OF THE SOFTWARE. * * 3. TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL BROADCOM OR * ITS LICENSORS BE LIABLE FOR * (i) CONSEQUENTIAL, INCIDENTAL, SPECIAL, INDIRECT, OR EXEMPLARY * DAMAGES WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATING TO * YOUR USE OF OR INABILITY TO USE THE SOFTWARE EVEN IF BROADCOM * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES; OR * (ii) ANY AMOUNT IN EXCESS OF THE AMOUNT ACTUALLY PAID FOR THE * SOFTWARE ITSELF OR U.S. $1, WHICHEVER IS GREATER. THESE * LIMITATIONS SHALL APPLY NOTWITHSTANDING ANY FAILURE OF * ESSENTIAL PURPOSE OF ANY LIMITED REMEDY. * ************************************************************************************/ /************************************************************************************ * * Filename: btif_storage.h * * Description: * ***********************************************************************************/ #ifndef BTIF_STORAGE_H #define BTIF_STORAGE_H #include "data_types.h" #include "bt_types.h" #include /************************************************************************************ ** Constants & Macros ************************************************************************************/ #define BTIF_STORAGE_FILL_PROPERTY(p_prop, t, l, p_v) \ (p_prop)->type = t;(p_prop)->len = l; (p_prop)->val = (p_v); /************************************************************************************ ** Type definitions for callback functions ************************************************************************************/ /************************************************************************************ ** Type definitions and return values ************************************************************************************/ /************************************************************************************ ** Functions ************************************************************************************/ /******************************************************************************* ** ** Function btif_storage_get_adapter_property ** ** Description BTIF storage API - Fetches the adapter property->type ** from NVRAM and fills property->val. ** Caller should provide memory for property->val and ** set the property->val ** ** Returns BT_STATUS_SUCCESS if the fetch was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_get_adapter_property(bt_property_t *property); /******************************************************************************* ** ** Function btif_storage_set_adapter_property ** ** Description BTIF storage API - Stores the adapter property ** to NVRAM ** ** Returns BT_STATUS_SUCCESS if the store was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_set_adapter_property(bt_property_t *property); /******************************************************************************* ** ** Function btif_storage_get_remote_device_property ** ** Description BTIF storage API - Fetches the remote device property->type ** from NVRAM and fills property->val. ** Caller should provide memory for property->val and ** set the property->val ** ** Returns BT_STATUS_SUCCESS if the fetch was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_get_remote_device_property(bt_bdaddr_t *remote_bd_addr, bt_property_t *property); /******************************************************************************* ** ** Function btif_storage_set_remote_device_property ** ** Description BTIF storage API - Stores the remote device property ** to NVRAM ** ** Returns BT_STATUS_SUCCESS if the store was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_set_remote_device_property(bt_bdaddr_t *remote_bd_addr, bt_property_t *property); /******************************************************************************* ** ** Function btif_storage_add_remote_device ** ** Description BTIF storage API - Adds a newly discovered device to NVRAM ** along with the timestamp. Also, stores the various ** properties - RSSI, BDADDR, NAME (if found in EIR) ** ** Returns BT_STATUS_SUCCESS if the store was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_add_remote_device(bt_bdaddr_t *remote_bdaddr, uint32_t num_properties, bt_property_t *properties); /******************************************************************************* ** ** Function btif_storage_add_bonded_device ** ** Description BTIF storage API - Adds the newly bonded device to NVRAM ** along with the link-key, Key type and Pin key length ** ** Returns BT_STATUS_SUCCESS if the store was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_add_bonded_device(bt_bdaddr_t *remote_bd_addr, LINK_KEY link_key, uint8_t key_type, uint8_t pin_length); /******************************************************************************* ** ** Function btif_storage_remove_bonded_device ** ** Description BTIF storage API - Deletes the bonded device from NVRAM ** ** Returns BT_STATUS_SUCCESS if the deletion was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_remove_bonded_device(bt_bdaddr_t *remote_bd_addr); /******************************************************************************* ** ** Function btif_storage_remove_bonded_device ** ** Description BTIF storage API - Deletes the bonded device from NVRAM ** ** Returns BT_STATUS_SUCCESS if the deletion was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_load_bonded_devices(void); /******************************************************************************* ** ** Function btif_storage_read_hl_apps_cb ** ** Description BTIF storage API - Read HL application control block from NVRAM ** ** Returns BT_STATUS_SUCCESS if the operation was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_read_hl_apps_cb(char *value, int value_size); /******************************************************************************* ** ** Function btif_storage_write_hl_apps_cb ** ** Description BTIF storage API - Write HL application control block to NVRAM ** ** Returns BT_STATUS_SUCCESS if the operation was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_write_hl_apps_cb(char *value, int value_size); /******************************************************************************* ** ** Function btif_storage_read_hl_apps_cb ** ** Description BTIF storage API - Read HL application configuration from NVRAM ** ** Returns BT_STATUS_SUCCESS if the operation was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_read_hl_app_data(UINT8 app_idx, char *value, int value_size); /******************************************************************************* ** ** Function btif_storage_write_hl_app_data ** ** Description BTIF storage API - Write HL application configuration to NVRAM ** ** Returns BT_STATUS_SUCCESS if the operation was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_write_hl_app_data(UINT8 app_idx, char *value, int value_size); /******************************************************************************* ** ** Function btif_storage_read_hl_mdl_data ** ** Description BTIF storage API - Read HL application MDL configuration from NVRAM ** ** Returns BT_STATUS_SUCCESS if the operation was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_read_hl_mdl_data(UINT8 app_idx, char *value, int value_size); /******************************************************************************* ** ** Function btif_storage_write_hl_mdl_data ** ** Description BTIF storage API - Write HL application MDL configuration from NVRAM ** ** Returns BT_STATUS_SUCCESS if the operation was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_write_hl_mdl_data(UINT8 app_idx, char *value, int value_size); /******************************************************************************* ** ** Function btif_storage_add_hid_device_info ** ** Description BTIF storage API - Adds the hid information of bonded hid devices-to NVRAM ** ** Returns BT_STATUS_SUCCESS if the store was successful, ** BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_add_hid_device_info(bt_bdaddr_t *remote_bd_addr, UINT16 attr_mask, UINT8 sub_class, UINT8 app_id, UINT16 vendor_id, UINT16 product_id, UINT16 version, UINT8 ctry_code, UINT16 dl_len, UINT8 *dsc_list); /******************************************************************************* ** ** Function btif_storage_load_bonded_hid_info ** ** Description BTIF storage API - Loads hid info for all the bonded devices from NVRAM ** and adds those devices to the BTA_HH. ** ** Returns BT_STATUS_SUCCESS if successful, BT_STATUS_FAIL otherwise ** *******************************************************************************/ bt_status_t btif_storage_load_bonded_hid_info(void); bt_status_t btif_storage_remove_hid_info(bt_bdaddr_t *remote_bd_addr); #endif /* BTIF_STORAGE_H */