xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/MsFS.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)

//<MStar Software>
//******************************************************************************
// MStar Software
// Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
// All software, firmware and related documentation herein ("MStar Software") are
// intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
// law, including, but not limited to, copyright law and international treaties.
// Any use, modification, reproduction, retransmission, or republication of all
// or part of MStar Software is expressly prohibited, unless prior written
// permission has been granted by MStar.
//
// By accessing, browsing and/or using MStar Software, you acknowledge that you
// have read, understood, and agree, to be bound by below terms ("Terms") and to
// comply with all applicable laws and regulations:
//
// 1. MStar shall retain any and all right, ownership and interest to MStar
//    Software and any modification/derivatives thereof.
//    No right, ownership, or interest to MStar Software and any
//    modification/derivatives thereof is transferred to you under Terms.
//
// 2. You understand that MStar Software might include, incorporate or be
//    supplied together with third party`s software and the use of MStar
//    Software may require additional licenses from third parties.
//    Therefore, you hereby agree it is your sole responsibility to separately
//    obtain any and all third party right and license necessary for your use of
//    such third party`s software.
//
// 3. MStar Software and any modification/derivatives thereof shall be deemed as
//    MStar`s confidential information and you agree to keep MStar`s
//    confidential information in strictest confidence and not disclose to any
//    third party.
//
// 4. MStar Software is provided on an "AS IS" basis without warranties of any
//    kind. Any warranties are hereby expressly disclaimed by MStar, including
//    without limitation, any warranties of merchantability, non-infringement of
//    intellectual property rights, fitness for a particular purpose, error free
//    and in conformity with any international standard.  You agree to waive any
//    claim against MStar for any loss, damage, cost or expense that you may
//    incur related to your use of MStar Software.
//    In no event shall MStar be liable for any direct, indirect, incidental or
//    consequential damages, including without limitation, lost of profit or
//    revenues, lost or damage of data, and unauthorized system use.
//    You agree that this Section 4 shall still apply without being affected
//    even if MStar Software has been modified by MStar in accordance with your
//    request or instruction for your use, except otherwise agreed by both
//    parties in writing.
//
// 5. If requested, MStar may from time to time provide technical supports or
//    services in relation with MStar Software to you for your use of
//    MStar Software in conjunction with your or your customer`s product
//    ("Services").
//    You understand and agree that, except otherwise agreed by both parties in
//    writing, Services are provided on an "AS IS" basis and the warranty
//    disclaimer set forth in Section 4 above shall apply.
//
// 6. Nothing contained herein shall be construed as by implication, estoppels
//    or otherwise:
//    (a) conferring any license or right to use MStar name, trademark, service
//        mark, symbol or any other identification;
//    (b) obligating MStar or any of its affiliates to furnish any person,
//        including without limitation, you and your customers, any assistance
//        of any kind whatsoever, or any information; or
//    (c) conferring any license or right under any intellectual property right.
//
// 7. These terms shall be governed by and construed in accordance with the laws
//    of Taiwan, R.O.C., excluding its conflict of law rules.
//    Any and all dispute arising out hereof or related hereto shall be finally
//    settled by arbitration referred to the Chinese Arbitration Association,
//    Taipei in accordance with the ROC Arbitration Law and the Arbitration
//    Rules of the Association by three (3) arbitrators appointed in accordance
//    with the said Rules.
//    The place of arbitration shall be in Taipei, Taiwan and the language shall
//    be English.
//    The arbitration award shall be final and binding to both parties.
//
//******************************************************************************
//<MStar Software>

////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2006-2007 MStar Semiconductor, Inc.
// All rights reserved.
//
// Unless otherwise stipulated in writing, any and all information contained
// herein regardless in any format shall remain the sole proprietary of
// MStar Semiconductor Inc. and be kept in strict confidence
// (��MStar Confidential Information��) by the recipient.
// Any unauthorized act including without limitation unauthorized disclosure,
// copying, use, reproduction, sale, distribution, modification, disassembling,
// reverse engineering and compiling of the contents of MStar Confidential
// Information is unlawful and strictly prohibited. MStar hereby reserves the
// rights to any and all damages, losses, costs and expenses resulting therefrom.
//
/// @file   apiFS.h
/// @author MStar Semiconductor Inc.
/// @brief  FileSystem wrapper
/// @note   Most of the APIs follows POSIX Specification including: \n
///                  - Files and Directories [POSIX Section 5] \n
///                  - Input and Output [POSIX Section 6]
/// @note   With some limitations: \n
///                  - Doesn't support symolic link, user/group/other ID, ...
/// @note   Plz reference Open Group's Single Unix Specification V3 for detailed POSIX API descriptions: \n
///                  - http://www.opengroup.org/onlinepubs/009695399/
///////////////////////////////////////////////////////////////////////////////////////////////////

#ifndef __MSFS_H__
#define __MSFS_H__

//-------------------------------------------------------------------------------------------------
// Include Files
//-------------------------------------------------------------------------------------------------
#ifdef __cplusplus
extern "C"
{
#endif

#include "MsTypes.h"
#include "stdlib.h"
#include "stdio.h"
#include "dirent.h"

//-------------------------------------------------------------------------------------------------
// Defines
//------------------------------------------------------------------------------------------------

//-------------------------------------------------------------------------------------------------
// Macros
//-------------------------------------------------------------------------------------------------

//-------------------------------------------------------------------------------------------------
// Type and Structure Declaration
//-------------------------------------------------------------------------------------------------

//-------------------------------------------------------------------------------------------------
// Extern Functions
//-------------------------------------------------------------------------------------------------
// // int MsFS_Init( int bUnicode);
// int MsFS_Init(int bUnitcode);

//
// Mount/Umount operations
//
// int MsFS_Mount( const char *devname, const char *dir, const char *fsname, unsigned long mountflags, const void* data );
// int MsFS_Umount( const char *dir);

//
// File/Directory operations
//
// int MsFS_Open( const char *path, int oflag, ... );
// int MsFS_Unlink( const char *path );
// int MsFS_MkDir( const char *path, mode_t mode );
// int MsFS_RmDir( const char *path );
// int MsFS_ChDir(const char *path);
// int MsFS_Rename( const char *path1, const char *path2 );
// int MsFS_Link( const char *path1, const char *path2 );
// int MsFS_Stat( const char *path, struct stat *buf );
// int MsFS_FStat( int fd, struct stat *buf );
// long MsFS_PathConf( const char *path, int name );
// long MsFS_FPathConf( int fd, int name );
// int MsFS_Access( const char *path, int amode );
// char* MsFS_GetCwd( char *buf, size_t size );
// DIR* MsFS_OpenDir( const char *dirname );
// struct dirent* MsFS_ReadDir( DIR *dirp );
// void MsFS_RewindDir( DIR *dirp );
// void MsFS_CloseDir( DIR *dirp );


//
// File IO operations
//
// ssize_t MsFS_Read( int fd, void *buf, size_t len );
// ssize_t MsFS_Write( int fd, const void *buf, size_t len );
// int MsFS_Close( int fd );
// MS_U64 MsFS_Lseek( int fd, MS_U64 pos, int whence );
// int MsFS_FCntl( int fd, int cmd, ... );
// // int MsFS_FSync( int fd );
void MsFS_Sync(void);


//
// Standard C Library's counterparts
//
FILE * MsFS_Fopen( const char *filename, const char *mode );
int MsFS_Fclose( FILE *stream );
size_t MsFS_Fread( void *data, size_t itemsize, size_t nitems, FILE *stream );
size_t MsFS_Fwrite( const void *data, size_t itemsize, size_t nitems, FILE *stream );
int MsFS_Fseek( FILE *stream, MS_U64 pos, int whence );
void MsFS_Rewind( FILE *stream );
MS_U64 MsFS_Ftell( FILE *stream );
int MsFS_Fflush(FILE *stream);

//
// File system information query
//
typedef struct
{
    MS_U32      u32ClusTotal;
    MS_U32      u32ClusFree;
    MS_U32      u32ClusSize;
} MApi_FsInfo;

// MS_BOOL MApi_FS_Info(const char *path, MS_BOOL bUnicode, MApi_FsInfo* pFsInfo);

#ifdef __cplusplus
}
#endif


#endif // #ifndef __MSFS_H__