Embedded File System service. More...
Go to the source code of this file.
Data Structures | |
| struct | wsfEsfAttributes_t |
| File attributes data type. More... | |
| struct | wsfEfsControl_t |
| File control block data type. More... | |
| struct | wsfEfsFileInfo_t |
| File Listing Information. More... | |
| struct | wsfEfsMedia_t |
| Media Control data type. More... | |
Macros | |
| #define | WSF_EFS_MAX_FILES 6 |
| Max Number of Files and Media. More... | |
| #define | WSF_EFS_MAX_MEDIA 4 |
| Max Number of Media. More... | |
| #define | WSF_EFS_FILE_OFFSET_ANY 0xFFFFFFFF |
| Offset to WsfEfsAddFile indicating any file offset can be used. More... | |
| #define | WSF_EFS_NAME_LEN 16 |
| File name length in bytes. More... | |
| #define | WSF_EFS_VERSION_LEN 16 |
| File version length in bytes. More... | |
| #define | WSF_EFS_USER_CMD 0x80 |
| Media Specific Command Identifiers reserved for applications begin at 0x80. More... | |
Status Codes | |
| #define | WSF_EFS_SUCCESS 0 |
| Success. More... | |
| #define | WSF_EFS_FAILURE 1 |
| Failure. More... | |
| #define | WSF_EFS_GET_FAILED 0xFFFF |
| Get operation failure. More... | |
| #define | WSF_EFS_PUT_FAILED 0xFFFF |
| PUT operation failure. More... | |
Invalid Parameter Identifiers | |
| #define | WSF_EFS_INVALID_HANDLE 0xFFFF |
| Invalid Handle. More... | |
| #define | WSF_EFS_INVALID_OFFSET 0xFFFFFFFF |
| Invalid Offset. More... | |
| #define | WSF_EFS_INVALID_SIZE 0xFFFFFFFF |
| Invalid Size. More... | |
| #define | WSF_EFS_INVALID_MEDIA 0xFF |
| Invalid Media. More... | |
File Types | |
| #define | WSF_EFS_FILE_TYPE_BULK 0 |
| Bulk File Type. More... | |
| #define | WSF_EFS_FILE_TYPE_STREAM 1 |
| Stream File Type. More... | |
File Permissions | |
| #define | WSF_EFS_REMOTE_PERMISSIONS_MASK 0xFF |
| Remote Permissions. More... | |
| #define | WSF_EFS_REMOTE_GET_PERMITTED 0x01 |
| Remote Get Permitted. More... | |
| #define | WSF_EFS_REMOTE_PUT_PERMITTED 0x02 |
| Remote Put Permitted. More... | |
| #define | WSF_EFS_REMOTE_ERASE_PERMITTED 0x04 |
| Remote Erase Permitted. More... | |
| #define | WSF_EFS_REMOTE_VERIFY_PERMITTED 0x08 |
| Remote Verify Permitted. More... | |
| #define | WSF_EFS_LOCAL_GET_PERMITTED 0x0100 |
| Local Get Permitted. More... | |
| #define | WSF_EFS_LOCAL_PUT_PERMITTED 0x0200 |
| Local Put Permitted. More... | |
| #define | WSF_EFS_LOCAL_ERASE_PERMITTED 0x0400 |
| Local Erase Permitted. More... | |
| #define | WSF_EFS_REMOTE_VISIBLE 0x0800 |
| File Visible via Remote WDXS. More... | |
Standard Media Specific Command Identifiers | |
| #define | WSF_EFS_WDXS_PUT_COMPLETE_CMD 0x00 |
| Put Complete. More... | |
| #define | WSF_EFS_VALIDATE_CMD 0x01 |
| Validate Req for the file. More... | |
Typedefs | |
| typedef uint16_t | wsfEfsHandle_t |
| File handle data type. More... | |
| typedef uint8_t | wsfMediaInitFunc_t(void) |
| Media Init function, called when media is registered. More... | |
| typedef uint8_t | wsfMediaEraseFunc_t(uint8_t *pAddress, uint32_t size) |
| Media Erase function. More... | |
| typedef uint8_t | wsfMediaReadFunc_t(uint8_t *pBuf, uint8_t *pAddress, uint32_t size) |
| Media Read function. More... | |
| typedef uint8_t | wsfMediaWriteFunc_t(const uint8_t *pBuf, uint8_t *pAddress, uint32_t size) |
| Media Write function. More... | |
| typedef uint8_t | wsfMediaHandleCmdFunc_t(uint8_t cmd, uint32_t param) |
| Media Specific Command handler. More... | |
| typedef const wsfEfsMedia_t * | pWsfEfsMedia_t |
| Pointer to Media Control data type. More... | |
Functions | |
| void | WsfEfsInit (void) |
| Initialise the embedded file system. More... | |
| wsfEfsHandle_t | WsfEfsAddFile (uint32_t maxSize, uint8_t media, wsfEsfAttributes_t *pAttr, uint32_t offset) |
| Create a file in the embedded file system. More... | |
| uint8_t | WsfEfsRemoveFile (wsfEfsHandle_t handle) |
| Deletes a file in the embedded file system. More... | |
| uint8_t | WsfEfsErase (wsfEfsHandle_t handle) |
| Clears the contents of a file without deleting the file. More... | |
| uint8_t | WsfEfsGetAttributes (wsfEfsHandle_t handle, wsfEsfAttributes_t *pAttr) |
| Gets the attributes of a file. More... | |
| uint8_t | WsfEfsSetAttributes (wsfEfsHandle_t handle, wsfEsfAttributes_t *pInfo) |
| Updates the attributes of a file. More... | |
| uint16_t | WsfEfsGet (wsfEfsHandle_t handle, uint32_t offset, uint8_t *pBuffer, uint16_t len) |
| Copies data from a file. More... | |
| uint16_t | WsfEfsPut (wsfEfsHandle_t handle, uint32_t offset, const uint8_t *pBuffer, uint16_t len) |
| Writes data to a file. More... | |
| uint8_t | WsfEfsRegisterMedia (const wsfEfsMedia_t *pMediaCtrl, uint8_t mediaID) |
| Registers a File Storage Medium with the Embedded File System. More... | |
| wsfEfsControl_t * | WsfEfsGetFileByHandle (wsfEfsHandle_t handle) |
| Returns the file control block for the given handle. More... | |
| char * | WsfEfsGetFileName (wsfEfsHandle_t handle) |
| Get the name of a file. More... | |
| char * | WsfEfsGetFileVersion (wsfEfsHandle_t handle) |
| Get the version of a file. More... | |
| uint32_t | WsfEfsGetFileSize (wsfEfsHandle_t handle) |
| Get the size of a file. More... | |
| uint32_t | WsfEfsGetFileMaxSize (wsfEfsHandle_t handle) |
| Get the number of bytes of memory reserved for use by a file. More... | |
| uint8_t | WsfEfsGetFileType (wsfEfsHandle_t handle) |
| Get the type of a file. More... | |
| uint16_t | WsfEfsGetFilePermissions (wsfEfsHandle_t handle) |
| Get the permissions of a file. More... | |
| uint8_t | WsfEfsMediaSpecificCommand (wsfEfsHandle_t handle, uint8_t cmd, uint32_t param) |
| Execute a media specific command on a file. More... | |
Embedded File System service.
Copyright (c) 2014-2018 Arm Ltd. All Rights Reserved.
Copyright (c) 2019-2020 Packetcraft, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Definition in file wsf_efs.h.
