pal_fileSystem.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// Copyright 2016-2019 ARM Ltd.
//
// SPDX-License-Identifier: Apache-2.0
//
// 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.
// ----------------------------------------------------------------------------

#ifndef PAL_FILE_SYSTEM_H
#define PAL_FILE_SYSTEM_H

#ifndef _PAL_H
    #error "Please do not include this file directly, use pal.h instead"
#endif

#define PAL_MAX_FILE_NAME_SIZE      8               
#define PAL_MAX_FILE_NAME_SUFFIX    3               
#define PAL_MAX_FOLDER_DEPTH_CHAR   66              
#define PAL_MAX_FILE_AND_FOLDER_LENGTH  (PAL_MAX_FILE_NAME_SIZE + PAL_MAX_FILE_NAME_SUFFIX + PAL_MAX_FOLDER_DEPTH_CHAR + 1) 
#define PAL_MAX_FULL_FILE_NAME  (PAL_MAX_FILE_NAME_SUFFIX + PAL_MAX_FOLDER_DEPTH_CHAR + 1) 

typedef uintptr_t palFileDescriptor_t; 

typedef enum {
    PAL_FS_OFFSET_KEEP_FIRST = 0,
    PAL_FS_OFFSET_SEEKSET,      
    PAL_FS_OFFSET_SEEKCUR,      
    PAL_FS_OFFSET_SEEKEND,      
    PAL_FS_OFFSET_KEEP_LAST,

} pal_fsOffset_t;

typedef enum {
    PAL_FS_FLAG_KEEP_FIRST = 0,
    PAL_FS_FLAG_READONLY,           
    PAL_FS_FLAG_READWRITE,          
    PAL_FS_FLAG_READWRITEEXCLUSIVE, 
    PAL_FS_FLAG_READWRITETRUNC,     
  PAL_FS_FLAG_KEEP_LAST,
} pal_fsFileMode_t;
typedef enum {
    PAL_FS_PARTITION_PRIMARY = 0,        
    PAL_FS_PARTITION_SECONDARY,          
    PAL_FS_PARTITION_LAST                
} pal_fsStorageID_t;


palStatus_t pal_fsMkDir(const char *pathName);

palStatus_t pal_fsRmDir(const char *pathName);


palStatus_t pal_fsFopen(const char *pathName, pal_fsFileMode_t mode,
        palFileDescriptor_t *fd);

palStatus_t pal_fsFclose(palFileDescriptor_t *fd);


palStatus_t pal_fsFread(palFileDescriptor_t *fd, void * buffer,
        size_t numOfBytes, size_t *numberOfBytesRead);

palStatus_t pal_fsFwrite(palFileDescriptor_t *fd, const void * buffer,
        size_t numOfBytes, size_t *numberOfBytesWritten);


palStatus_t pal_fsFseek(palFileDescriptor_t *fd, int32_t offset,
        pal_fsOffset_t whence);

palStatus_t pal_fsFtell(palFileDescriptor_t *fd, int32_t *pos);

palStatus_t pal_fsUnlink(const char *pathName);

palStatus_t pal_fsRmFiles(const char *pathName);

palStatus_t pal_fsCpFolder(const char *pathNameSrc, char *pathNameDest);

palStatus_t pal_fsSetMountPoint(pal_fsStorageID_t dataID, const char *Path);

palStatus_t pal_fsGetMountPoint(pal_fsStorageID_t dataID, size_t length, char *Path);

palStatus_t pal_fsFormat(pal_fsStorageID_t dataID);

bool pal_fsIsPrivatePartition(pal_fsStorageID_t dataID);


void pal_fsCleanup(void);


#endif//test