1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
|
/************************************************************************************
*
* 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 <utils/Log.h>
/************************************************************************************
** 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);
/*******************************************************************************
**
** Function btif_storage_remove_hid_info
**
** Description BTIF storage API - Deletes the bonded hid device info from NVRAM
**
** Returns BT_STATUS_SUCCESS if the deletion was successful,
** BT_STATUS_FAIL otherwise
**
*******************************************************************************/
bt_status_t btif_storage_remove_hid_info(bt_bdaddr_t *remote_bd_addr);
/*******************************************************************************
**
** Function btif_storage_load_autopair_device_list
**
** Description BTIF storage API - Populates auto pair device list
**
** Returns BT_STATUS_SUCCESS if the auto pair blacklist is successfully populated
** BT_STATUS_FAIL otherwise
**
*******************************************************************************/
bt_status_t btif_storage_load_autopair_device_list();
/*******************************************************************************
**
** Function btif_storage_is_device_autopair_blacklisted
**
** Description BTIF storage API Checks if the given device is blacklisted for auto pairing
**
** Returns TRUE if the device is found in the auto pair blacklist
** FALSE otherwise
**
*******************************************************************************/
BOOLEAN btif_storage_is_device_autopair_blacklisted(bt_bdaddr_t *remote_dev_addr);
/*******************************************************************************
**
** Function btif_storage_add_device_to_autopair_blacklist
**
** Description BTIF storage API - Add a remote device to the auto pairing blacklist
**
** Returns BT_STATUS_SUCCESS if the device is successfully added to the auto pair blacklist
** BT_STATUS_FAIL otherwise
**
*******************************************************************************/
bt_status_t btif_storage_add_device_to_autopair_blacklist(bt_bdaddr_t *remote_dev_addr);
/*******************************************************************************
**
** Function btif_storage_is_fixed_pin_zeros_keyboard
**
** Description BTIF storage API - checks if this device has fixed PIN key device list
**
** Returns TRUE if the device is found in the fixed pin keyboard device list
** FALSE otherwise
**
*******************************************************************************/
BOOLEAN btif_storage_is_fixed_pin_zeros_keyboard(bt_bdaddr_t *remote_dev_addr);
#endif /* BTIF_STORAGE_H */
|
