API  2.2
TSmarT Software Library
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions

Functions

signed long nvmem_read (unsigned long ulFileId, unsigned long ulLength, unsigned long ulOffset, unsigned char *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...
 
signed long nvmem_write (unsigned long ulFileId, unsigned long ulLength, unsigned long ulEntryOffset, unsigned char *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...
 
unsigned char nvmem_set_mac_address (unsigned char *mac)
 Write MAC address to EEPROM. mac address as appears over the air (OUI first) More...
 
unsigned char nvmem_get_mac_address (unsigned char *mac)
 Read MAC address from EEPROM. mac address as appears over the air (OUI first) More...
 
unsigned char nvmem_write_patch (unsigned long ulFileId, unsigned long spLength, const unsigned char *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...
 
unsigned char nvmem_read_sp_version (unsigned char *patchVer)
 Read patch version. read package version (WiFi FW patch, driver-supplicant-NS patch, bootloader patch) More...
 
signed long nvmem_create_entry (unsigned long ulFileId, unsigned long 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

signed long nvmem_create_entry ( unsigned long  ulFileId,
unsigned long  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.
unsigned char nvmem_get_mac_address ( unsigned char *  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.
signed long nvmem_read ( unsigned long  ulFileId,
unsigned long  ulLength,
unsigned long  ulOffset,
unsigned char *  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
number of bytes read, otherwise error.
unsigned char nvmem_read_sp_version ( unsigned char *  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.
unsigned char nvmem_set_mac_address ( unsigned char *  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.
signed long nvmem_write ( unsigned long  ulFileId,
unsigned long  ulLength,
unsigned long  ulEntryOffset,
unsigned char *  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.
unsigned char nvmem_write_patch ( unsigned long  ulFileId,
unsigned long  spLength,
const unsigned char *  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.