SimpleLink API Reference Manual  1.11.1
•All Data Structures Files Functions Variables Typedefs Macros Groups
nvmem.h
Go to the documentation of this file.
1 /*****************************************************************************
2 *
3 * nvmem.h - CC3000 Host Driver Implementation.
4 * Copyright (C) 2011 Texas Instruments Incorporated - https://www.ti.com/
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 *
13 * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the
16 * distribution.
17 *
18 * Neither the name of Texas Instruments Incorporated nor the names of
19 * its contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 *****************************************************************************/
35 #ifndef __NVRAM_H__
36 #define __NVRAM_H__
37 
38 #include "cc3000_common.h"
39 
40 
41 //*****************************************************************************
42 //
43 // If building with a C++ compiler, make all of the definitions in this header
44 // have a C binding.
45 //
46 //*****************************************************************************
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 
52 //*****************************************************************************
53 //
56 //
57 //*****************************************************************************
58 
59 /****************************************************************************
60 **
61 ** Definitions for File IDs
62 **
63 ****************************************************************************/
64 /* NVMEM file ID - system files*/
65 #define NVMEM_NVS_FILEID (0)
66 #define NVMEM_NVS_SHADOW_FILEID (1)
67 #define NVMEM_WLAN_CONFIG_FILEID (2)
68 #define NVMEM_WLAN_CONFIG_SHADOW_FILEID (3)
69 #define NVMEM_WLAN_DRIVER_SP_FILEID (4)
70 #define NVMEM_WLAN_FW_SP_FILEID (5)
71 #define NVMEM_MAC_FILEID (6)
72 #define NVMEM_FRONTEND_VARS_FILEID (7)
73 #define NVMEM_IP_CONFIG_FILEID (8)
74 #define NVMEM_IP_CONFIG_SHADOW_FILEID (9)
75 #define NVMEM_BOOTLOADER_SP_FILEID (10)
76 #define NVMEM_RM_FILEID (11)
77 
78 /* NVMEM file ID - user files*/
79 #define NVMEM_AES128_KEY_FILEID (12)
80 #define NVMEM_SHARED_MEM_FILEID (13)
81 
82 /* max entry in order to invalid nvmem */
83 #define NVMEM_MAX_ENTRY (16)
84 
85 
86 //*****************************************************************************
87 //
108 //*****************************************************************************
109 
110 extern signed long nvmem_read(unsigned long file_id, unsigned long length, unsigned long offset, unsigned char *buff);
111 
112 //*****************************************************************************
113 //
132 //*****************************************************************************
133 
134 extern signed long nvmem_write(unsigned long ulFileId, unsigned long ulLength, unsigned long ulEntryOffset, unsigned char *buff);
135 
136 
137 //*****************************************************************************
138 //
148 //*****************************************************************************
149 extern unsigned char nvmem_set_mac_address(unsigned char *mac);
150 
151 
152 //*****************************************************************************
153 //
163 //*****************************************************************************
164 extern unsigned char nvmem_get_mac_address(unsigned char *mac);
165 
166 
167 //*****************************************************************************
168 //
183 //*****************************************************************************
184 extern unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spLength, const unsigned char *spData);
185 
186 
187 //*****************************************************************************
188 //
199 //*****************************************************************************
200 #ifndef CC3000_TINY_DRIVER
201 extern unsigned char nvmem_read_sp_version(unsigned char* patchVer);
202 #endif
203 
204 //*****************************************************************************
205 //
225 //*****************************************************************************
226 extern signed long nvmem_create_entry(unsigned long file_id, unsigned long newlen);
227 
228 
229 //*****************************************************************************
230 //
231 // Mark the end of the C bindings section for C++ compilers.
232 //
233 //*****************************************************************************
234 
235 
236 //*****************************************************************************
237 //
238 // Close the Doxygen group.
240 //
241 //*****************************************************************************
242 
243 
244 #ifdef __cplusplus
245 }
246 #endif // __cplusplus
247 
248 #endif // __NVRAM_H__