David Fletcher / Mbed 2 deprecated CC3000WebServer

A Port of TI's Webserver for the CC3000

Dependencies:   mbed

CC3000HostDriver/nvmem.h@2:e6a185df9e4c, 2013-09-16 (annotated)

Committer:
dflet
Date:
Mon Sep 16 18:37:14 2013 +0000
Revision:
2:e6a185df9e4c
Parent:
0:6ad60d78b315 
ADC and Leds now work on board and config.html page.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dflet 0:6ad60d78b315 1 /*****************************************************************************
dflet 0:6ad60d78b315 2 *
dflet 0:6ad60d78b315 3 * nvmem.h - CC3000 Host Driver Implementation.
dflet 0:6ad60d78b315 4 * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
dflet 0:6ad60d78b315 5 *
dflet 0:6ad60d78b315 6 * Redistribution and use in source and binary forms, with or without
dflet 0:6ad60d78b315 7 * modification, are permitted provided that the following conditions
dflet 0:6ad60d78b315 8 * are met:
dflet 0:6ad60d78b315 9 *
dflet 0:6ad60d78b315 10 * Redistributions of source code must retain the above copyright
dflet 0:6ad60d78b315 11 * notice, this list of conditions and the following disclaimer.
dflet 0:6ad60d78b315 12 *
dflet 0:6ad60d78b315 13 * Redistributions in binary form must reproduce the above copyright
dflet 0:6ad60d78b315 14 * notice, this list of conditions and the following disclaimer in the
dflet 0:6ad60d78b315 15 * documentation and/or other materials provided with the
dflet 0:6ad60d78b315 16 * distribution.
dflet 0:6ad60d78b315 17 *
dflet 0:6ad60d78b315 18 * Neither the name of Texas Instruments Incorporated nor the names of
dflet 0:6ad60d78b315 19 * its contributors may be used to endorse or promote products derived
dflet 0:6ad60d78b315 20 * from this software without specific prior written permission.
dflet 0:6ad60d78b315 21 *
dflet 0:6ad60d78b315 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
dflet 0:6ad60d78b315 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
dflet 0:6ad60d78b315 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
dflet 0:6ad60d78b315 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
dflet 0:6ad60d78b315 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
dflet 0:6ad60d78b315 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
dflet 0:6ad60d78b315 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
dflet 0:6ad60d78b315 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
dflet 0:6ad60d78b315 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
dflet 0:6ad60d78b315 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
dflet 0:6ad60d78b315 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
dflet 0:6ad60d78b315 33 *
dflet 0:6ad60d78b315 34 *****************************************************************************/
dflet 0:6ad60d78b315 35 #ifndef __NVRAM_H__
dflet 0:6ad60d78b315 36 #define __NVRAM_H__
dflet 0:6ad60d78b315 37
dflet 0:6ad60d78b315 38 #include "cc3000_common.h"
dflet 0:6ad60d78b315 39
dflet 0:6ad60d78b315 40
dflet 0:6ad60d78b315 41 //*****************************************************************************
dflet 0:6ad60d78b315 42 //
dflet 0:6ad60d78b315 43 // If building with a C++ compiler, make all of the definitions in this header
dflet 0:6ad60d78b315 44 // have a C binding.
dflet 0:6ad60d78b315 45 //
dflet 0:6ad60d78b315 46 //*****************************************************************************
dflet 0:6ad60d78b315 47 #ifdef __cplusplus
dflet 0:6ad60d78b315 48 extern "C" {
dflet 0:6ad60d78b315 49 #endif
dflet 0:6ad60d78b315 50
dflet 0:6ad60d78b315 51
dflet 0:6ad60d78b315 52 //*****************************************************************************
dflet 0:6ad60d78b315 53 //
dflet 0:6ad60d78b315 54 //! \addtogroup nvmem_api
dflet 0:6ad60d78b315 55 //! @{
dflet 0:6ad60d78b315 56 //
dflet 0:6ad60d78b315 57 //*****************************************************************************
dflet 0:6ad60d78b315 58
dflet 0:6ad60d78b315 59 /****************************************************************************
dflet 0:6ad60d78b315 60 **
dflet 0:6ad60d78b315 61 ** Definitions for File IDs
dflet 0:6ad60d78b315 62 **
dflet 0:6ad60d78b315 63 ****************************************************************************/
dflet 0:6ad60d78b315 64 /* NVMEM file ID - system files*/
dflet 0:6ad60d78b315 65 #define NVMEM_NVS_FILEID (0)
dflet 0:6ad60d78b315 66 #define NVMEM_NVS_SHADOW_FILEID (1)
dflet 0:6ad60d78b315 67 #define NVMEM_WLAN_CONFIG_FILEID (2)
dflet 0:6ad60d78b315 68 #define NVMEM_WLAN_CONFIG_SHADOW_FILEID (3)
dflet 0:6ad60d78b315 69 #define NVMEM_WLAN_DRIVER_SP_FILEID (4)
dflet 0:6ad60d78b315 70 #define NVMEM_WLAN_FW_SP_FILEID (5)
dflet 0:6ad60d78b315 71 #define NVMEM_MAC_FILEID (6)
dflet 0:6ad60d78b315 72 #define NVMEM_FRONTEND_VARS_FILEID (7)
dflet 0:6ad60d78b315 73 #define NVMEM_IP_CONFIG_FILEID (8)
dflet 0:6ad60d78b315 74 #define NVMEM_IP_CONFIG_SHADOW_FILEID (9)
dflet 0:6ad60d78b315 75 #define NVMEM_BOOTLOADER_SP_FILEID (10)
dflet 0:6ad60d78b315 76 #define NVMEM_RM_FILEID (11)
dflet 0:6ad60d78b315 77
dflet 0:6ad60d78b315 78 /* NVMEM file ID - user files*/
dflet 0:6ad60d78b315 79 #define NVMEM_AES128_KEY_FILEID (12)
dflet 0:6ad60d78b315 80 #define NVMEM_SHARED_MEM_FILEID (13)
dflet 0:6ad60d78b315 81
dflet 0:6ad60d78b315 82 /* max entry in order to invalid nvmem */
dflet 0:6ad60d78b315 83 #define NVMEM_MAX_ENTRY (16)
dflet 0:6ad60d78b315 84
dflet 0:6ad60d78b315 85
dflet 0:6ad60d78b315 86 //*****************************************************************************
dflet 0:6ad60d78b315 87 //
dflet 0:6ad60d78b315 88 //! nvmem_read
dflet 0:6ad60d78b315 89 //!
dflet 0:6ad60d78b315 90 //! @param ulFileId nvmem file id:\n
dflet 0:6ad60d78b315 91 //! NVMEM_NVS_FILEID, NVMEM_NVS_SHADOW_FILEID,
dflet 0:6ad60d78b315 92 //! NVMEM_WLAN_CONFIG_FILEID, NVMEM_WLAN_CONFIG_SHADOW_FILEID,
dflet 0:6ad60d78b315 93 //! NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
dflet 0:6ad60d78b315 94 //! NVMEM_MAC_FILEID, NVMEM_FRONTEND_VARS_FILEID,
dflet 0:6ad60d78b315 95 //! NVMEM_IP_CONFIG_FILEID, NVMEM_IP_CONFIG_SHADOW_FILEID,
dflet 0:6ad60d78b315 96 //! NVMEM_BOOTLOADER_SP_FILEID, NVMEM_RM_FILEID,
dflet 0:6ad60d78b315 97 //! and user files 12-15.
dflet 0:6ad60d78b315 98 //! @param ulLength number of bytes to read
dflet 0:6ad60d78b315 99 //! @param ulOffset ulOffset in file from where to read
dflet 0:6ad60d78b315 100 //! @param buff output buffer pointer
dflet 0:6ad60d78b315 101 //!
dflet 0:6ad60d78b315 102 //! @return number of bytes read, otherwise error.
dflet 0:6ad60d78b315 103 //!
dflet 0:6ad60d78b315 104 //! @brief Reads data from the file referred by the ulFileId parameter.
dflet 0:6ad60d78b315 105 //! Reads data from file ulOffset till length. Err if the file can't
dflet 0:6ad60d78b315 106 //! be used, is invalid, or if the read is out of bounds.
dflet 0:6ad60d78b315 107 //!
dflet 0:6ad60d78b315 108 //*****************************************************************************
dflet 0:6ad60d78b315 109
dflet 0:6ad60d78b315 110 extern signed long nvmem_read(unsigned long file_id, unsigned long length, unsigned long offset, unsigned char *buff);
dflet 0:6ad60d78b315 111
dflet 0:6ad60d78b315 112 //*****************************************************************************
dflet 0:6ad60d78b315 113 //
dflet 0:6ad60d78b315 114 //! nvmem_write
dflet 0:6ad60d78b315 115 //!
dflet 0:6ad60d78b315 116 //! @param ulFileId nvmem file id:\n
dflet 0:6ad60d78b315 117 //! NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
dflet 0:6ad60d78b315 118 //! NVMEM_MAC_FILEID, NVMEM_BOOTLOADER_SP_FILEID,
dflet 0:6ad60d78b315 119 //! and user files 12-15.
dflet 0:6ad60d78b315 120 //! @param ulLength number of bytes to write
dflet 0:6ad60d78b315 121 //! @param ulEntryOffset offset in file to start write operation from
dflet 0:6ad60d78b315 122 //! @param buff data to write
dflet 0:6ad60d78b315 123 //!
dflet 0:6ad60d78b315 124 //! @return on success 0, error otherwise.
dflet 0:6ad60d78b315 125 //!
dflet 0:6ad60d78b315 126 //! @brief Write data to nvmem.
dflet 0:6ad60d78b315 127 //! writes data to file referred by the ulFileId parameter.
dflet 0:6ad60d78b315 128 //! Writes data to file ulOffset till ulLength.The file id will be
dflet 0:6ad60d78b315 129 //! marked invalid till the write is done. The file entry doesn't
dflet 0:6ad60d78b315 130 //! need to be valid - only allocated.
dflet 0:6ad60d78b315 131 //!
dflet 0:6ad60d78b315 132 //*****************************************************************************
dflet 0:6ad60d78b315 133
dflet 0:6ad60d78b315 134 extern signed long nvmem_write(unsigned long ulFileId, unsigned long ulLength, unsigned long ulEntryOffset, unsigned char *buff);
dflet 0:6ad60d78b315 135
dflet 0:6ad60d78b315 136
dflet 0:6ad60d78b315 137 //*****************************************************************************
dflet 0:6ad60d78b315 138 //
dflet 0:6ad60d78b315 139 //! nvmem_set_mac_address
dflet 0:6ad60d78b315 140 //!
dflet 0:6ad60d78b315 141 //! @param mac mac address to be set
dflet 0:6ad60d78b315 142 //!
dflet 0:6ad60d78b315 143 //! @return on success 0, error otherwise.
dflet 0:6ad60d78b315 144 //!
dflet 0:6ad60d78b315 145 //! @brief Write MAC address to EEPROM.
dflet 0:6ad60d78b315 146 //! mac address as appears over the air (OUI first)
dflet 0:6ad60d78b315 147 //!
dflet 0:6ad60d78b315 148 //*****************************************************************************
dflet 0:6ad60d78b315 149 extern unsigned char nvmem_set_mac_address(unsigned char *mac);
dflet 0:6ad60d78b315 150
dflet 0:6ad60d78b315 151
dflet 0:6ad60d78b315 152 //*****************************************************************************
dflet 0:6ad60d78b315 153 //
dflet 0:6ad60d78b315 154 //! nvmem_get_mac_address
dflet 0:6ad60d78b315 155 //!
dflet 0:6ad60d78b315 156 //! @param[out] mac mac address
dflet 0:6ad60d78b315 157 //!
dflet 0:6ad60d78b315 158 //! @return on success 0, error otherwise.
dflet 0:6ad60d78b315 159 //!
dflet 0:6ad60d78b315 160 //! @brief Read MAC address from EEPROM.
dflet 0:6ad60d78b315 161 //! mac address as appears over the air (OUI first)
dflet 0:6ad60d78b315 162 //!
dflet 0:6ad60d78b315 163 //*****************************************************************************
dflet 0:6ad60d78b315 164 extern unsigned char nvmem_get_mac_address(unsigned char *mac);
dflet 0:6ad60d78b315 165
dflet 0:6ad60d78b315 166
dflet 0:6ad60d78b315 167 //*****************************************************************************
dflet 0:6ad60d78b315 168 //
dflet 0:6ad60d78b315 169 //! nvmem_write_patch
dflet 0:6ad60d78b315 170 //!
dflet 0:6ad60d78b315 171 //! @param ulFileId nvmem file id:\n
dflet 0:6ad60d78b315 172 //! NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
dflet 0:6ad60d78b315 173 //! @param spLength number of bytes to write
dflet 0:6ad60d78b315 174 //! @param spData SP data to write
dflet 0:6ad60d78b315 175 //!
dflet 0:6ad60d78b315 176 //! @return on success 0, error otherwise.
dflet 0:6ad60d78b315 177 //!
dflet 0:6ad60d78b315 178 //! @brief program a patch to a specific file ID.
dflet 0:6ad60d78b315 179 //! The SP data is assumed to be organized in 2-dimensional.
dflet 0:6ad60d78b315 180 //! Each line is SP_PORTION_SIZE bytes long. Actual programming is
dflet 0:6ad60d78b315 181 //! applied in SP_PORTION_SIZE bytes portions.
dflet 0:6ad60d78b315 182 //!
dflet 0:6ad60d78b315 183 //*****************************************************************************
dflet 0:6ad60d78b315 184 extern unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spLength, const unsigned char *spData);
dflet 0:6ad60d78b315 185
dflet 0:6ad60d78b315 186
dflet 0:6ad60d78b315 187 //*****************************************************************************
dflet 0:6ad60d78b315 188 //
dflet 0:6ad60d78b315 189 //! nvmem_read_sp_version
dflet 0:6ad60d78b315 190 //!
dflet 0:6ad60d78b315 191 //! @param[out] patchVer first number indicates package ID and the second
dflet 0:6ad60d78b315 192 //! number indicates package build number
dflet 0:6ad60d78b315 193 //!
dflet 0:6ad60d78b315 194 //! @return on success 0, error otherwise.
dflet 0:6ad60d78b315 195 //!
dflet 0:6ad60d78b315 196 //! @brief Read patch version. read package version (WiFi FW patch,
dflet 0:6ad60d78b315 197 //! driver-supplicant-NS patch, bootloader patch)
dflet 0:6ad60d78b315 198 //!
dflet 0:6ad60d78b315 199 //*****************************************************************************
dflet 0:6ad60d78b315 200 #ifndef CC3000_TINY_DRIVER
dflet 0:6ad60d78b315 201 extern unsigned char nvmem_read_sp_version(unsigned char* patchVer);
dflet 0:6ad60d78b315 202 #endif
dflet 0:6ad60d78b315 203
dflet 0:6ad60d78b315 204 //*****************************************************************************
dflet 0:6ad60d78b315 205 //
dflet 0:6ad60d78b315 206 //! nvmem_create_entry
dflet 0:6ad60d78b315 207 //!
dflet 0:6ad60d78b315 208 //! @param ulFileId nvmem file Id:\n
dflet 0:6ad60d78b315 209 //! * NVMEM_AES128_KEY_FILEID: 12
dflet 0:6ad60d78b315 210 //! * NVMEM_SHARED_MEM_FILEID: 13
dflet 0:6ad60d78b315 211 //! * and fileIDs 14 and 15
dflet 0:6ad60d78b315 212 //! @param ulNewLen entry ulLength
dflet 0:6ad60d78b315 213 //!
dflet 0:6ad60d78b315 214 //! @return on success 0, error otherwise.
dflet 0:6ad60d78b315 215 //!
dflet 0:6ad60d78b315 216 //! @brief Create new file entry and allocate space on the NVMEM.
dflet 0:6ad60d78b315 217 //! Applies only to user files.
dflet 0:6ad60d78b315 218 //! Modify the size of file.
dflet 0:6ad60d78b315 219 //! If the entry is unallocated - allocate it to size
dflet 0:6ad60d78b315 220 //! ulNewLen (marked invalid).
dflet 0:6ad60d78b315 221 //! If it is allocated then deallocate it first.
dflet 0:6ad60d78b315 222 //! To just mark the file as invalid without resizing -
dflet 0:6ad60d78b315 223 //! set ulNewLen=0.
dflet 0:6ad60d78b315 224 //!
dflet 0:6ad60d78b315 225 //*****************************************************************************
dflet 0:6ad60d78b315 226 extern signed long nvmem_create_entry(unsigned long file_id, unsigned long newlen);
dflet 0:6ad60d78b315 227
dflet 0:6ad60d78b315 228
dflet 0:6ad60d78b315 229 //*****************************************************************************
dflet 0:6ad60d78b315 230 //
dflet 0:6ad60d78b315 231 // Mark the end of the C bindings section for C++ compilers.
dflet 0:6ad60d78b315 232 //
dflet 0:6ad60d78b315 233 //*****************************************************************************
dflet 0:6ad60d78b315 234
dflet 0:6ad60d78b315 235
dflet 0:6ad60d78b315 236 //*****************************************************************************
dflet 0:6ad60d78b315 237 //
dflet 0:6ad60d78b315 238 // Close the Doxygen group.
dflet 0:6ad60d78b315 239 //! @}
dflet 0:6ad60d78b315 240 //
dflet 0:6ad60d78b315 241 //*****************************************************************************
dflet 0:6ad60d78b315 242
dflet 0:6ad60d78b315 243
dflet 0:6ad60d78b315 244 #ifdef __cplusplus
dflet 0:6ad60d78b315 245 }
dflet 0:6ad60d78b315 246 #endif // __cplusplus
dflet 0:6ad60d78b315 247
dflet 0:6ad60d78b315 248 #endif // __NVRAM_H__
dflet 0:6ad60d78b315 249