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
|
/************************************************************************************
*
* 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: unv.h
*
* Description: Universal NV Ram API
*
***********************************************************************************/
#ifndef UNV_H
#define UNV_H
/************************************************************************************
** Constants & Macros
************************************************************************************/
/* any keyfile line cannot exceed this length */
#define UNV_MAXLINE_LENGTH (2048)
/************************************************************************************
** Type definitions for callback functions
************************************************************************************/
typedef int (*unv_iter_cb)(char *key, char *val, void *userdata);
/************************************************************************************
** Type definitions and return values
************************************************************************************/
/************************************************************************************
** Extern variables and functions
************************************************************************************/
/************************************************************************************
** Functions
************************************************************************************/
/******************************************************************************
**
** Function unv_create_directory
**
** Description Creates directory, if full path is not available it
** will construct it. Must be called from BTIF task context.
**
** Parameters
** path : directory path to be created
**
** Returns 0 if successful, -1 if failure
**
*******************************************************************************/
int unv_create_directory(const char *path);
/*******************************************************************************
**
** Function unv_create_file
**
** Description Creates file
** Must be called from BTIF task context
**
** Parameters
** filename : file path to be created
**
** Returns 0 if successful, -1 if failure
**
*******************************************************************************/
int unv_create_file(const char *filename);
/*******************************************************************************
**
** Function unv_read_key
**
** Description Reads keyvalue from file
** Path must be an existing absolute path
** Must be called from BTIF task context
**
** Parameters
** path : path of keyfile
** key : key string to query for
** p_out : output line buffer supplied by caller
** out_len : max length of output buffer
**
** Returns Returns buffer of key value.
**
*******************************************************************************/
char* unv_read_key( const char *path,
const char *key,
char *p_out,
int out_len);
/*******************************************************************************
**
** Function unv_read_key_iter
**
** Description Reads keyvalue from file iteratively
** Path must be an existing absolute path
** cb is the callback that is invoked for each entry read
** Must be called from BTIF task context
**
** Parameters
** path : path of keyfile
** cb : iteration callback
** userdata : context specific userdata passed onto callback
**
** Returns 0 if successful, -1 if failure
**
*******************************************************************************/
int unv_read_key_iter( const char *path,
unv_iter_cb cb,
void *userdata );
/*******************************************************************************
**
** Function unv_write_key
**
** Description Writes key to file. If key value exists it will be updated
** Path must be an existing absolute path
** Must be called from BTIF task context
**
** Parameters
** path : path of keyfile
** key : key string to write
** value : value string to set for this key
**
** Returns 0 if successful, -1 if failure
**
*******************************************************************************/
int unv_write_key( const char *path,
const char *key,
const char *value );
/*******************************************************************************
**
** Function unv_remove_key
**
** Description Removes keyvalue from file
** Path must be an existing absolute path
** Must be called from BTIF task context
**
** Parameters
** path : path of keyfile
** key : key string to delete
**
** Returns 0 if successful, -1 if failure
**
*******************************************************************************/
int unv_remove_key( const char *path,
const char *key );
#endif /* UNV_H */
|
