Data Structures | Macros | Enumerations | Functions

SimpleLink Filesystem. More...

+ Collaboration diagram for Filesystem:

Data Structures

struct  SlFsFileInfo_t
 

Macros

#define _FS_MODE(Access, SizeGran, Size, Flags)
 
#define _FS_MODE_ACCESS_FLAGS_MASK   (0xFF)
 
#define _FS_MODE_ACCESS_FLAGS_OFFSET   (16)
 
#define _FS_MODE_ACCESS_MASK   (0xF)
 
#define _FS_MODE_ACCESS_OFFSET   (12)
 
#define _FS_MODE_ACCESS_RESERVED_MASK   (0xFF)
 
#define _FS_MODE_ACCESS_RESERVED_OFFSET   (24)
 
#define _FS_MODE_OPEN_SIZE_GRAN_MASK   (0xF)
 
#define _FS_MODE_OPEN_SIZE_GRAN_OFFSET   (8)
 
#define _FS_MODE_OPEN_SIZE_MASK   (0xFF)
 
#define _FS_MODE_OPEN_SIZE_OFFSET   (0)
 
#define FS_MODE_OPEN_CREATE(maxSizeInBytes, accessModeFlags)   _sl_GetCreateFsMode(maxSizeInBytes,accessModeFlags)
 
#define FS_MODE_OPEN_READ   _FS_MODE(_FS_MODE_OPEN_READ,0,0,0)
 
#define FS_MODE_OPEN_WRITE   _FS_MODE(_FS_MODE_OPEN_WRITE,0,0,0)
 
#define MAX_MODE_SIZE   (0xFF)
 
#define SL_FS_CERT_CHAIN_ERROR   (-60)
 
#define SL_FS_DATA_ADDRESS_SHOUD_BE_IN_DATA_RAM   (-48)
 
#define SL_FS_DATA_IS_NOT_ALIGNED   (-47)
 
#define SL_FS_ERASING_FLASH   (-65)
 
#define SL_FS_ERR_ALLOC   (-14)
 
#define SL_FS_ERR_BAD_FILE_MODE   (-22)
 
#define SL_FS_ERR_CONTINUE_WRITE_MUST_BE_MOD_4   (-19)
 
#define SL_FS_ERR_DEVICE_IS_NOT_FORMATTED   (-36)
 
#define SL_FS_ERR_DEVICE_NOT_LOADED   (-4)
 
#define SL_FS_ERR_EMPTY_ERROR   (-10)
 
#define SL_FS_ERR_EMPTY_SFLASH   (-67)
 
#define SL_FS_ERR_FAILED_INIT_STORAGE   (-20)
 
#define SL_FS_ERR_FAILED_LOAD_FILE   (-18)
 
#define SL_FS_ERR_FAILED_READ_NVFILE   (-21)
 
#define SL_FS_ERR_FAILED_READ_NVMEM_HEADER   (-55)
 
#define SL_FS_ERR_FAILED_TO_ALLOCATE_MEM   (-33)
 
#define SL_FS_ERR_FAILED_TO_CREATE_FILE   (-8)
 
#define SL_FS_ERR_FAILED_TO_CREATE_LOCK_OBJ   (-5)
 
#define SL_FS_ERR_FAILED_TO_READ   (-2)
 
#define SL_FS_ERR_FAILED_TO_READ_INTEGRITY_HEADER_1   (-31)
 
#define SL_FS_ERR_FAILED_TO_READ_INTEGRITY_HEADER_2   (-32)
 
#define SL_FS_ERR_FAILED_TO_WRITE   (-16)
 
#define SL_FS_ERR_FAILED_WRITE_NVMEM_HEADER   (-35)
 
#define SL_FS_ERR_FILE_ACCESS_IS_DIFFERENT   (-23)
 
#define SL_FS_ERR_FILE_ALREADY_EXISTS   (-26)
 
#define SL_FS_ERR_FILE_EXISTS_ON_DIFFERENT_DEVICE_ID   (-28)
 
#define SL_FS_ERR_FILE_IMAGE_IS_CORRUPTED   (-39)
 
#define SL_FS_ERR_FILE_IS_NOT_SECURE_AND_SIGN   (-66)
 
#define SL_FS_ERR_FILE_MAX_SIZE_BIGGER_THAN_EXISTING_FILE   (-29)
 
#define SL_FS_ERR_FILE_NOT_EXISTS   (-11)
 
#define SL_FS_ERR_FS_ALREADY_LOADED   (-7)
 
#define SL_FS_ERR_INCORRECT_OFFSET_ALIGNMENT   (-56)
 
#define SL_FS_ERR_INVALID_ACCESS_TYPE   (-27)
 
#define SL_FS_ERR_INVALID_ARGS   (-9)
 
#define SL_FS_ERR_INVALID_FILE_ID   (-12)
 
#define SL_FS_ERR_INVALID_HANDLE   (-17)
 
#define SL_FS_ERR_INVALID_MAGIC_NUM   (-3)
 
#define SL_FS_ERR_MAX_FS_FILES_IS_LARGER   (-44)
 
#define SL_FS_ERR_MAX_FS_FILES_IS_SMALLER   (-43)
 
#define SL_FS_ERR_NO_AVAILABLE_BLOCKS   (-30)
 
#define SL_FS_ERR_NO_AVAILABLE_NV_INDEX   (-34)
 
#define SL_FS_ERR_NO_ENTRIES_AVAILABLE   (-24)
 
#define SL_FS_ERR_NOT_SUPPORTED   (-1)
 
#define SL_FS_ERR_OFFSET_OUT_OF_RANGE   (-15)
 
#define SL_FS_ERR_OVERLAP_DETECTION_THRESHHOLD   (-46)
 
#define SL_FS_ERR_PROGRAM   (-25)
 
#define SL_FS_ERR_READ_DATA_LENGTH   (-13)
 
#define SL_FS_ERR_SIZE_OF_FILE_EXT_EXCEEDED   (-38)
 
#define SL_FS_ERR_TOKEN_IS_NOT_VALID   (-50)
 
#define SL_FS_ERR_UNKNOWN   (-6)
 
#define SL_FS_FILE_HAS_NOT_BEEN_CLOSE_CORRECTLY   (-64)
 
#define SL_FS_FILE_HAS_RESERVED_NV_INDEX   (-45)
 
#define SL_FS_FILE_MAX_SIZE_EXCEEDED   (-42)
 
#define SL_FS_FILE_NAME_EXIST   (-59)
 
#define SL_FS_FILE_SYSTEM_IS_LOCKED   (-53)
 
#define SL_FS_FILE_UNVALID_FILE_SIZE   (-51)
 
#define SL_FS_INVALID_BUFFER_FOR_READ   (-41)
 
#define SL_FS_INVALID_BUFFER_FOR_WRITE   (-40)
 
#define SL_FS_NO_DEVICE_IS_LOADED   (-49)
 
#define SL_FS_NOT_16_ALIGNED   (-61)
 
#define SL_FS_OK   (0)
 
#define SL_FS_SECURE_FILE_MUST_BE_COMMIT   (-57)
 
#define SL_FS_SECURITY_ALLERT   (-52)
 
#define SL_FS_SECURITY_BUF_ALREADY_ALLOC   (-58)
 
#define SL_FS_WARNING_FILE_NAME_NOT_KEPT   (-37)
 
#define SL_FS_WRONG_FILE_NAME   (-54)
 
#define SL_FS_WRONG_SIGNATURE   (-63)
 
#define SL_FS_WRONG_SIGNATURE_OR_CERTIFIC_NAME_LENGTH   (-62)
 

Enumerations

enum  _SlFsFileOpenMaxSizeGran_e
 
enum  SlFileOpenFlags_e
 
enum  SlFsFileOpenAccessType_e
 

Functions

_u32 _sl_GetCreateFsMode (_u32 maxSizeInBytes, _u32 accessFlags)
 

Detailed Description


Data Structure Documentation

struct SlFsFileInfo_t

Data Fields

_u32 AllocatedLen
 
_u32 FileLen
 
_u16 flags
 
_u32 Token [4]
 

Field Documentation

_u32 AllocatedLen
_u32 FileLen
_u16 flags
_u32 Token[4]

Macro Definition Documentation

#define _FS_MODE (   Access,
  SizeGran,
  Size,
  Flags 
)
Value:
#define _FS_MODE_OPEN_SIZE_OFFSET
Definition: fs.h:142
#define _FS_MODE_OPEN_SIZE_MASK
Definition: fs.h:143
#define _FS_MODE_ACCESS_OFFSET
Definition: fs.h:138
#define _FS_MODE_OPEN_SIZE_GRAN_OFFSET
Definition: fs.h:140
#define _FS_MODE_OPEN_SIZE_GRAN_MASK
Definition: fs.h:141
#define _FS_MODE_ACCESS_FLAGS_OFFSET
Definition: fs.h:136
#define _FS_MODE_ACCESS_FLAGS_MASK
Definition: fs.h:137
#define _FS_MODE_ACCESS_MASK
Definition: fs.h:139
#define _FS_MODE_ACCESS_FLAGS_MASK   (0xFF)
#define _FS_MODE_ACCESS_FLAGS_OFFSET   (16)
#define _FS_MODE_ACCESS_MASK   (0xF)
#define _FS_MODE_ACCESS_OFFSET   (12)
#define _FS_MODE_ACCESS_RESERVED_MASK   (0xFF)
#define _FS_MODE_ACCESS_RESERVED_OFFSET   (24)
#define _FS_MODE_OPEN_SIZE_GRAN_MASK   (0xF)
#define _FS_MODE_OPEN_SIZE_GRAN_OFFSET   (8)
#define _FS_MODE_OPEN_SIZE_MASK   (0xFF)
#define _FS_MODE_OPEN_SIZE_OFFSET   (0)
#define FS_MODE_OPEN_CREATE (   maxSizeInBytes,
  accessModeFlags 
)    _sl_GetCreateFsMode(maxSizeInBytes,accessModeFlags)
#define FS_MODE_OPEN_READ   _FS_MODE(_FS_MODE_OPEN_READ,0,0,0)
#define FS_MODE_OPEN_WRITE   _FS_MODE(_FS_MODE_OPEN_WRITE,0,0,0)
#define MAX_MODE_SIZE   (0xFF)
#define SL_FS_CERT_CHAIN_ERROR   (-60)
#define SL_FS_DATA_ADDRESS_SHOUD_BE_IN_DATA_RAM   (-48)
#define SL_FS_DATA_IS_NOT_ALIGNED   (-47)
#define SL_FS_ERASING_FLASH   (-65)
#define SL_FS_ERR_ALLOC   (-14)
#define SL_FS_ERR_BAD_FILE_MODE   (-22)
#define SL_FS_ERR_CONTINUE_WRITE_MUST_BE_MOD_4   (-19)
#define SL_FS_ERR_DEVICE_IS_NOT_FORMATTED   (-36)
#define SL_FS_ERR_DEVICE_NOT_LOADED   (-4)
#define SL_FS_ERR_EMPTY_ERROR   (-10)
#define SL_FS_ERR_EMPTY_SFLASH   (-67)
#define SL_FS_ERR_FAILED_INIT_STORAGE   (-20)
#define SL_FS_ERR_FAILED_LOAD_FILE   (-18)
#define SL_FS_ERR_FAILED_READ_NVFILE   (-21)
#define SL_FS_ERR_FAILED_READ_NVMEM_HEADER   (-55)
#define SL_FS_ERR_FAILED_TO_ALLOCATE_MEM   (-33)
#define SL_FS_ERR_FAILED_TO_CREATE_FILE   (-8)
#define SL_FS_ERR_FAILED_TO_CREATE_LOCK_OBJ   (-5)
#define SL_FS_ERR_FAILED_TO_READ   (-2)
#define SL_FS_ERR_FAILED_TO_READ_INTEGRITY_HEADER_1   (-31)
#define SL_FS_ERR_FAILED_TO_READ_INTEGRITY_HEADER_2   (-32)
#define SL_FS_ERR_FAILED_TO_WRITE   (-16)
#define SL_FS_ERR_FAILED_WRITE_NVMEM_HEADER   (-35)
#define SL_FS_ERR_FILE_ACCESS_IS_DIFFERENT   (-23)
#define SL_FS_ERR_FILE_ALREADY_EXISTS   (-26)
#define SL_FS_ERR_FILE_EXISTS_ON_DIFFERENT_DEVICE_ID   (-28)
#define SL_FS_ERR_FILE_IMAGE_IS_CORRUPTED   (-39)
#define SL_FS_ERR_FILE_IS_NOT_SECURE_AND_SIGN   (-66)
#define SL_FS_ERR_FILE_MAX_SIZE_BIGGER_THAN_EXISTING_FILE   (-29)
#define SL_FS_ERR_FILE_NOT_EXISTS   (-11)
#define SL_FS_ERR_FS_ALREADY_LOADED   (-7)
#define SL_FS_ERR_INCORRECT_OFFSET_ALIGNMENT   (-56)
#define SL_FS_ERR_INVALID_ACCESS_TYPE   (-27)
#define SL_FS_ERR_INVALID_ARGS   (-9)
#define SL_FS_ERR_INVALID_FILE_ID   (-12)
#define SL_FS_ERR_INVALID_HANDLE   (-17)
#define SL_FS_ERR_INVALID_MAGIC_NUM   (-3)
#define SL_FS_ERR_MAX_FS_FILES_IS_LARGER   (-44)
#define SL_FS_ERR_MAX_FS_FILES_IS_SMALLER   (-43)
#define SL_FS_ERR_NO_AVAILABLE_BLOCKS   (-30)
#define SL_FS_ERR_NO_AVAILABLE_NV_INDEX   (-34)
#define SL_FS_ERR_NO_ENTRIES_AVAILABLE   (-24)
#define SL_FS_ERR_NOT_SUPPORTED   (-1)
#define SL_FS_ERR_OFFSET_OUT_OF_RANGE   (-15)
#define SL_FS_ERR_OVERLAP_DETECTION_THRESHHOLD   (-46)
#define SL_FS_ERR_PROGRAM   (-25)
#define SL_FS_ERR_READ_DATA_LENGTH   (-13)
#define SL_FS_ERR_SIZE_OF_FILE_EXT_EXCEEDED   (-38)
#define SL_FS_ERR_TOKEN_IS_NOT_VALID   (-50)
#define SL_FS_ERR_UNKNOWN   (-6)
#define SL_FS_FILE_HAS_NOT_BEEN_CLOSE_CORRECTLY   (-64)
#define SL_FS_FILE_HAS_RESERVED_NV_INDEX   (-45)
#define SL_FS_FILE_MAX_SIZE_EXCEEDED   (-42)
#define SL_FS_FILE_NAME_EXIST   (-59)
#define SL_FS_FILE_SYSTEM_IS_LOCKED   (-53)
#define SL_FS_FILE_UNVALID_FILE_SIZE   (-51)
#define SL_FS_INVALID_BUFFER_FOR_READ   (-41)
#define SL_FS_INVALID_BUFFER_FOR_WRITE   (-40)
#define SL_FS_NO_DEVICE_IS_LOADED   (-49)
#define SL_FS_NOT_16_ALIGNED   (-61)
#define SL_FS_OK   (0)
#define SL_FS_SECURE_FILE_MUST_BE_COMMIT   (-57)
#define SL_FS_SECURITY_ALLERT   (-52)
#define SL_FS_SECURITY_BUF_ALREADY_ALLOC   (-58)
#define SL_FS_WARNING_FILE_NAME_NOT_KEPT   (-37)
#define SL_FS_WRONG_FILE_NAME   (-54)
#define SL_FS_WRONG_SIGNATURE   (-63)
#define SL_FS_WRONG_SIGNATURE_OR_CERTIFIC_NAME_LENGTH   (-62)

Enumeration Type Documentation

Enumerator
_FS_MODE_SIZE_GRAN_256B 
_FS_MODE_SIZE_GRAN_1KB 
_FS_MODE_SIZE_GRAN_4KB 
_FS_MODE_SIZE_GRAN_16KB 
_FS_MODE_SIZE_GRAN_64KB 
_FS_MAX_MODE_SIZE_GRAN 
Enumerator
_FS_FILE_OPEN_FLAG_COMMIT 
_FS_FILE_OPEN_FLAG_SECURE 
_FS_FILE_OPEN_FLAG_NO_SIGNATURE_TEST 
_FS_FILE_OPEN_FLAG_STATIC 
_FS_FILE_OPEN_FLAG_VENDOR 
_FS_FILE_PUBLIC_WRITE 
_FS_FILE_PUBLIC_READ 
Enumerator
_FS_MODE_OPEN_READ 
_FS_MODE_OPEN_WRITE 
_FS_MODE_OPEN_CREATE 
_FS_MODE_OPEN_WRITE_CREATE_IF_NOT_EXIST 

Function Documentation

_u32 _sl_GetCreateFsMode ( _u32  maxSizeInBytes,
_u32  accessFlags 
)

This documentation file has been automatically generated on Fri Oct 4 2019 03:47:32 by doxygen 1.8.8