|
SimpleLink API Reference Manual
1.11.1
|
|
SimpleLink API Reference Manual
1.11.1
|
Macros | |
| #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 | |
| signed long | nvmem_read (unsigned long file_id, unsigned long length, unsigned long offset, 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. | |
| 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. | |
| unsigned char | nvmem_set_mac_address (unsigned char *mac) |
| Write MAC address to EEPROM. mac address as appears over the air (OUI first) | |
| unsigned char | nvmem_get_mac_address (unsigned char *mac) |
| Read MAC address from EEPROM. mac address as appears over the air (OUI first) | |
| 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. | |
| unsigned char | nvmem_read_sp_version (unsigned char *patchVer) |
| Read patch version. read package version (WiFi FW patch, driver-supplicant-NS patch, bootloader patch) | |
| signed long | nvmem_create_entry (unsigned long file_id, unsigned long newlen) |
| 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. | |
| signed long nvmem_read | ( | unsigned long | file_id, |
| unsigned long | length, | ||
| unsigned long | offset, | ||
| 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
| ulFileId | nvmem 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. |
| ulLength | number of bytes to read |
| ulOffset | ulOffset in file from where to read |
| buff | output buffer pointer |
| 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
| ulFileId | nvmem file id: NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID, NVMEM_MAC_FILEID, NVMEM_BOOTLOADER_SP_FILEID, and user files 12-15. |
| ulLength | number of bytes to write |
| ulEntryOffset | offset in file to start write operation from |
| buff | data to write |
| 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
| mac | mac address to be set |
| 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
| [out] | mac | mac address |
| 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
| ulFileId | nvmem file id: NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID, |
| spLength | number of bytes to write |
| spData | SP data to write |
| 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
| [out] | patchVer | first number indicates package ID and the second number indicates package build number |
| signed long nvmem_create_entry | ( | unsigned long | file_id, |
| unsigned long | newlen | ||
| ) |
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
| ulFileId | nvmem file Id:
|
| ulNewLen | entry ulLength |
1.8.3 
