CC3000  1.14
 All Classes Functions Groups
Nvmem_api

Macros

#define NVMEM_READ_PARAMS_LEN   (12)
 
#define NVMEM_CREATE_PARAMS_LEN   (8)
 
#define NVMEM_WRITE_PARAMS_LEN   (16)
 
#define NVMEM_NVS_FILEID   (0)
 
#define NVMEM_NVS_SHADOW_FILEID   (1)
 
#define NVMEM_WLAN_CONFIG_FILEID   (2)
 
#define NVMEM_WLAN_CONFIG_SHADOW_FILEID   (3)
 
#define NVMEM_WLAN_DRIVER_SP_FILEID   (4)
 
#define NVMEM_WLAN_FW_SP_FILEID   (5)
 
#define NVMEM_MAC_FILEID   (6)
 
#define NVMEM_FRONTEND_VARS_FILEID   (7)
 
#define NVMEM_IP_CONFIG_FILEID   (8)
 
#define NVMEM_IP_CONFIG_SHADOW_FILEID   (9)
 
#define NVMEM_BOOTLOADER_SP_FILEID   (10)
 
#define NVMEM_RM_FILEID   (11)
 
#define NVMEM_AES128_KEY_FILEID   (12)
 
#define NVMEM_SHARED_MEM_FILEID   (13)
 
#define NVMEM_MAX_ENTRY   (16)
 

Functions

INT32 nvmem_read (UINT32 ulFileId, UINT32 ulLength, UINT32 ulOffset, UINT8 *buff)
 Reads data from the file referred by the ulFileId parameter. Reads data from file ulOffset till length. Err if the file can't be used, is invalid, or if the read is out of bounds. More...
 
INT32 nvmem_write (UINT32 ulFileId, UINT32 ulLength, UINT32 ulEntryOffset, UINT8 *buff)
 Write data to nvmem. writes data to file referred by the ulFileId parameter. Writes data to file ulOffset till ulLength.The file id will be marked invalid till the write is done. The file entry doesn't need to be valid - only allocated. More...
 
UINT8 nvmem_set_mac_address (UINT8 *mac)
 Write MAC address to EEPROM. mac address as appears over the air (OUI first) More...
 
UINT8 nvmem_get_mac_address (UINT8 *mac)
 Read MAC address from EEPROM. mac address as appears over the air (OUI first) More...
 
UINT8 nvmem_write_patch (UINT32 ulFileId, UINT32 spLength, const UINT8 *spData)
 program a patch to a specific file ID. The SP data is assumed to be organized in 2-dimensional. Each line is SP_PORTION_SIZE bytes long. Actual programming is applied in SP_PORTION_SIZE bytes portions. More...
 
UINT8 nvmem_read_sp_version (UINT8 *patchVer)
 Read patch version. read package version (WiFi FW patch, driver-supplicant-NS patch, bootloader patch) More...
 
INT32 nvmem_create_entry (UINT32 ulFileId, UINT32 ulNewLen)
 Create new file entry and allocate space on the NVMEM. Applies only to user files. Modify the size of file. If the entry is unallocated - allocate it to size ulNewLen (marked invalid). If it is allocated then deallocate it first. To just mark the file as invalid without resizing - set ulNewLen=0. More...
 

Detailed Description

Function Documentation

INT32 nvmem_create_entry ( UINT32  ulFileId,
UINT32  ulNewLen 
)

Create new file entry and allocate space on the NVMEM. Applies only to user files. Modify the size of file. If the entry is unallocated - allocate it to size ulNewLen (marked invalid). If it is allocated then deallocate it first. To just mark the file as invalid without resizing - set ulNewLen=0.

nvmem_create_entry

Parameters
ulFileIdnvmem file Id:
  • NVMEM_AES128_KEY_FILEID: 12
  • NVMEM_SHARED_MEM_FILEID: 13
  • and fileIDs 14 and 15
ulNewLenentry ulLength
Returns
on success 0, error otherwise.
UINT8 nvmem_get_mac_address ( UINT8 *  mac)

Read MAC address from EEPROM. mac address as appears over the air (OUI first)

nvmem_get_mac_address

Parameters
[out]macmac address
Returns
on success 0, error otherwise.
INT32 nvmem_read ( UINT32  ulFileId,
UINT32  ulLength,
UINT32  ulOffset,
UINT8 *  buff 
)

Reads data from the file referred by the ulFileId parameter. Reads data from file ulOffset till length. Err if the file can't be used, is invalid, or if the read is out of bounds.

nvmem_read

Parameters
ulFileIdnvmem file id:
NVMEM_NVS_FILEID, NVMEM_NVS_SHADOW_FILEID, NVMEM_WLAN_CONFIG_FILEID, NVMEM_WLAN_CONFIG_SHADOW_FILEID, NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID, NVMEM_MAC_FILEID, NVMEM_FRONTEND_VARS_FILEID, NVMEM_IP_CONFIG_FILEID, NVMEM_IP_CONFIG_SHADOW_FILEID, NVMEM_BOOTLOADER_SP_FILEID, NVMEM_RM_FILEID, and user files 12-15.
ulLengthnumber of bytes to read
ulOffsetulOffset in file from where to read
buffoutput buffer pointer
Returns
on success 0, error otherwise.
UINT8 nvmem_read_sp_version ( UINT8 *  patchVer)

Read patch version. read package version (WiFi FW patch, driver-supplicant-NS patch, bootloader patch)

nvmem_read_sp_version

Parameters
[out]patchVerfirst number indicates package ID and the second number indicates package build number
Returns
on success 0, error otherwise.
UINT8 nvmem_set_mac_address ( UINT8 *  mac)

Write MAC address to EEPROM. mac address as appears over the air (OUI first)

nvmem_set_mac_address

Parameters
macmac address to be set
Returns
on success 0, error otherwise.
INT32 nvmem_write ( UINT32  ulFileId,
UINT32  ulLength,
UINT32  ulEntryOffset,
UINT8 *  buff 
)

Write data to nvmem. writes data to file referred by the ulFileId parameter. Writes data to file ulOffset till ulLength.The file id will be marked invalid till the write is done. The file entry doesn't need to be valid - only allocated.

nvmem_write

Parameters
ulFileIdnvmem file id:
NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID, NVMEM_MAC_FILEID, NVMEM_BOOTLOADER_SP_FILEID, and user files 12-15.
ulLengthnumber of bytes to write
ulEntryOffsetoffset in file to start write operation from
buffdata to write
Returns
on success 0, error otherwise.
UINT8 nvmem_write_patch ( UINT32  ulFileId,
UINT32  spLength,
const UINT8 *  spData 
)

program a patch to a specific file ID. The SP data is assumed to be organized in 2-dimensional. Each line is SP_PORTION_SIZE bytes long. Actual programming is applied in SP_PORTION_SIZE bytes portions.

nvmem_write_patch

Parameters
ulFileIdnvmem file id:
NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
spLengthnumber of bytes to write
spDataSP data to write
Returns
on success 0, error otherwise.