oc_devfs.c

Go to the documentation of this file.

#include <oc_devfs.h>
#include <oc_list.h>
#include <oc_object.h>
#include <oc_stdio.h>
#include <oc_driverman.h>
#include <string.h>

#define _________________________________________DEFINITIONS_SECTION________________________________________________________________________

#define MAX_PATH_LENGTH         30

#undef  _________________________________________DEFINITIONS_SECTION________________________________________________________________________


#define _________________________________________TYPES_SECTION______________________________________________________________________________

struct File_t
{
    oC_ObjectControl_t  ObjectControl;
    oC_Driver_t         Driver;
    void *              DriverContext;
};

struct Dir_t
{
    oC_ObjectControl_t  ObjectControl;
    uint32_t            CurrentDriver;
};

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________LOCAL_PROTOTYPES_SECTION___________________________________________________________________

static bool IsFileCorrect( oC_File_t File );
static bool IsDirCorrect( oC_Dir_t Dir );

#undef  _________________________________________LOCAL_PROTOTYPES_SECTION___________________________________________________________________


#define _________________________________________VARIABLES_SECTION__________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
const oC_FileSystem_Registration_t DevFs = {
                .Name     = "DevFs" ,
                .init     = oC_DevFs_init     ,
                .deinit   = oC_DevFs_deinit   ,
                .fopen    = oC_DevFs_fopen    ,
                .fclose   = oC_DevFs_fclose   ,
                .fread    = oC_DevFs_fread    ,
                .fwrite   = oC_DevFs_fwrite   ,
                .lseek    = oC_DevFs_lseek    ,
                .ioctl    = oC_DevFs_ioctl    ,
                .sync     = oC_DevFs_sync     ,
                .Getc     = oC_DevFs_getc     ,
                .Putc     = oC_DevFs_putc     ,
                .tell     = oC_DevFs_tell     ,
                .eof      = oC_DevFs_eof      ,
                .size     = oC_DevFs_size     ,

                .opendir  = oC_DevFs_opendir  ,
                .closedir = oC_DevFs_closedir ,
                .readdir  = oC_DevFs_readdir  ,

                .stat     = oC_DevFs_stat     ,
                .unlink   = oC_DevFs_unlink   ,
                .rename   = oC_DevFs_rename   ,
                .chmod    = oC_DevFs_chmod    ,
                .utime    = oC_DevFs_utime    ,
                .mkdir    = oC_DevFs_mkdir    ,
                .DirExists= oC_DevFs_DirExists,
};

#undef  _________________________________________VARIABLES_SECTION__________________________________________________________________________


#define _________________________________________INTERFACE_FUNCTIONS_SECTION________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_init( oC_DevFs_Context_t * outContext )
{
    return oC_ErrorCode_None;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_deinit( oC_DevFs_Context_t Context )
{
    return oC_ErrorCode_None;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_fopen( oC_DevFs_Context_t Context , oC_File_t * outFile , const char * Path , oC_FileSystem_ModeFlags_t Mode , oC_FileSystem_FileAttributes_t Attributes )
{
    oC_ErrorCode_t  errorCode = oC_ErrorCode_ImplementError;

    if(ErrorCondition(isaddresscorrect(Path) , oC_ErrorCode_PathNotCorrect))
    {
        oC_Driver_t driver = oC_DriverMan_GetDriver(&Path[1]);

        if(
            oC_AssignErrorCodeIfFalse(&errorCode , isram(outFile)           , oC_ErrorCode_OutputAddressNotInRAM) &&
            oC_AssignErrorCodeIfFalse(&errorCode , isaddresscorrect(driver) , oC_ErrorCode_NoSuchFile)
            )
        {
            oC_File_t file = smartalloc(sizeof(struct File_t),AllocationFlags_CanWait1Second);

            if(file)
            {
                file->ObjectControl = oC_CountObjectControl(file,oC_ObjectId_DevFsFile);
                file->Driver        = driver;
                file->DriverContext = NULL;
                *outFile            = file;
                errorCode           = oC_ErrorCode_None;
            }
            else
            {
                errorCode = oC_ErrorCode_AllocationError;
            }
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_fclose( oC_DevFs_Context_t Context , oC_File_t File )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        oC_AssignErrorCodeIfFalse(&errorCode,IsFileCorrect(File),oC_ErrorCode_ObjectNotCorrect)
        )
    {
        File->ObjectControl = 0;

        if(smartfree(File,sizeof(struct File_t),AllocationFlags_CanWaitForever))
        {
            errorCode = oC_ErrorCode_None;
        }
        else
        {
            errorCode = oC_ErrorCode_ReleaseError;
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_fread( oC_DevFs_Context_t Context , oC_File_t File , void * outBuffer , uint32_t * Size )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        oC_AssignErrorCodeIfFalse(&errorCode,IsFileCorrect(File),           oC_ErrorCode_ObjectNotCorrect) &&
        oC_AssignErrorCodeIfFalse(&errorCode,isram(outBuffer),              oC_ErrorCode_OutputAddressNotInRAM) &&
        oC_AssignErrorCodeIfFalse(&errorCode,isram(Size),                   oC_ErrorCode_OutputAddressNotInRAM) &&
        oC_AssignErrorCodeIfFalse(&errorCode,*Size > 0,                     oC_ErrorCode_SizeNotCorrect)        &&
        oC_AssignErrorCodeIfFalse(&errorCode,isarrayinram(outBuffer,*Size), oC_ErrorCode_ArraySizeTooBig)
        )
    {
        errorCode = oC_Driver_Read(File->Driver,File->DriverContext,outBuffer,Size,oC_hour(1));
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_fwrite( oC_DevFs_Context_t Context , oC_File_t File , const void * Buffer , uint32_t * Size )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        oC_AssignErrorCodeIfFalse(&errorCode,IsFileCorrect(File),           oC_ErrorCode_ObjectNotCorrect) &&
        oC_AssignErrorCodeIfFalse(&errorCode,isaddresscorrect(Buffer),      oC_ErrorCode_WrongAddress) &&
        oC_AssignErrorCodeIfFalse(&errorCode,isram(Size),                   oC_ErrorCode_OutputAddressNotInRAM) &&
        oC_AssignErrorCodeIfFalse(&errorCode,*Size > 0,                     oC_ErrorCode_SizeNotCorrect) &&
        oC_AssignErrorCodeIfFalse(&errorCode,isarraycorrect(Buffer,*Size),  oC_ErrorCode_ArraySizeTooBig)
        )
    {
        errorCode = oC_Driver_Write(File->Driver,File->DriverContext,Buffer,Size,oC_hour(1));
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_lseek( oC_DevFs_Context_t Context , oC_File_t File , uint32_t Offset )
{
    return oC_ErrorCode_NotHandledByDriver;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_ioctl( oC_DevFs_Context_t Context , oC_File_t File , oC_Ioctl_Command_t Command , void * Pointer)
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        oC_AssignErrorCodeIfFalse(&errorCode,IsFileCorrect(File),                oC_ErrorCode_ObjectNotCorrect) &&
        oC_AssignErrorCodeIfFalse(&errorCode,oC_Ioctl_IsCorrectCommand(Command), oC_ErrorCode_CommandNotCorrect)
        )
    {
        if(Command == oC_IoCtl_SpecialCommand_SetDriverContext)
        {
            File->DriverContext = Pointer;
            errorCode           = oC_ErrorCode_None;
        }
        else
        {
            errorCode = oC_Driver_HandleIoctl(File->Driver,File->DriverContext,Command,Pointer);
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_sync( oC_DevFs_Context_t Context , oC_File_t File )
{
    return oC_ErrorCode_NotHandledByFileSystem;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_getc( oC_DevFs_Context_t Context , char * outCharacter , oC_File_t File )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        oC_AssignErrorCodeIfFalse(&errorCode,IsFileCorrect(File),           oC_ErrorCode_ObjectNotCorrect) &&
        oC_AssignErrorCodeIfFalse(&errorCode,isram(outCharacter),           oC_ErrorCode_OutputAddressNotInRAM)
        )
    {
        uint32_t bytesToRead = 1;
        errorCode = oC_Driver_Read(File->Driver,File->DriverContext,outCharacter,&bytesToRead,oC_hour(1));
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_putc( oC_DevFs_Context_t Context , char Character , oC_File_t File )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        oC_AssignErrorCodeIfFalse(&errorCode,IsFileCorrect(File), oC_ErrorCode_ObjectNotCorrect)
        )
    {
        uint32_t bytesToWrite = 1;
        errorCode = oC_Driver_Write(File->Driver,File->DriverContext,&Character,&bytesToWrite,oC_hour(1));
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
int32_t oC_DevFs_tell( oC_DevFs_Context_t Context , oC_File_t File )
{
    return -1;
}

//==========================================================================================================================================
//==========================================================================================================================================
bool oC_DevFs_eof( oC_DevFs_Context_t Context , oC_File_t File )
{
    return true;
}

//==========================================================================================================================================
//==========================================================================================================================================
uint32_t oC_DevFs_size( oC_DevFs_Context_t Context , oC_File_t File )
{
    return sizeof(oC_Driver_Registration_t);
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_opendir( oC_DevFs_Context_t Context , oC_Dir_t * outDir , const char * Path )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        oC_AssignErrorCodeIfFalse(&errorCode , isram(outDir)            , oC_ErrorCode_OutputAddressNotInRAM) &&
        oC_AssignErrorCodeIfFalse(&errorCode , isaddresscorrect(Path)   , oC_ErrorCode_WrongAddress) &&
        oC_AssignErrorCodeIfFalse(&errorCode , strcmp(Path,"/") == 0    , oC_ErrorCode_NoSuchFile)
        )
    {
        oC_Dir_t dir = smartalloc(sizeof(struct Dir_t),AllocationFlags_CanWaitForever);

        if(dir)
        {
            dir->ObjectControl = oC_CountObjectControl(dir,oC_ObjectId_DevFsDir);
            dir->CurrentDriver = 0;
            *outDir            = dir;
            errorCode = oC_ErrorCode_None;
        }
        else
        {
            errorCode = oC_ErrorCode_AllocationError;
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_closedir( oC_DevFs_Context_t Context , oC_Dir_t Dir )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(oC_AssignErrorCodeIfFalse(&errorCode , IsDirCorrect(Dir) , oC_ErrorCode_ObjectNotCorrect ))
    {
        Dir->ObjectControl = 0;

        if(smartfree(Dir,sizeof(struct Dir_t),AllocationFlags_CanWaitForever))
        {
            errorCode = oC_ErrorCode_None;
        }
        else
        {
            errorCode = oC_ErrorCode_ReleaseError;
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_readdir( oC_DevFs_Context_t Context , oC_Dir_t Dir , oC_FileInfo_t * outFileInfo )
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        oC_AssignErrorCodeIfFalse(&errorCode , IsDirCorrect(Dir) , oC_ErrorCode_ObjectNotCorrect ) &&
        oC_AssignErrorCodeIfFalse(&errorCode , isram(outFileInfo), oC_ErrorCode_OutputAddressNotInRAM )
        )
    {
        oC_List(oC_Driver_t) drivers = oC_DriverMan_GetList();

        if(oC_List_IsCorrect(drivers))
        {
            oC_Driver_t driver = NULL;

            oC_List_At(drivers,Dir->CurrentDriver,driver);

            if(driver)
            {
                outFileInfo->Name       = driver->FileName;
                outFileInfo->Size       = sizeof(oC_Driver_Registration_t);
                outFileInfo->Timestamp  = 0;
                outFileInfo->FileType   = oC_FileSystem_FileType_File;

                Dir->CurrentDriver++;

                errorCode = oC_ErrorCode_None;
            }
            else
            {
                errorCode = oC_ErrorCode_NoSuchFile;
            }
        }
        else
        {
            errorCode = oC_ErrorCode_ListNotCorrect;
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_stat( oC_DevFs_Context_t Context , const char * Path , oC_FileInfo_t * outFileInfo)
{
    oC_ErrorCode_t errorCode = oC_ErrorCode_ImplementError;

    if(
        oC_AssignErrorCodeIfFalse(&errorCode , isaddresscorrect(Path) , oC_ErrorCode_WrongAddress ) &&
        oC_AssignErrorCodeIfFalse(&errorCode , isram(outFileInfo)     , oC_ErrorCode_OutputAddressNotInRAM ) &&
        oC_AssignErrorCodeIfFalse(&errorCode , strlen(Path) >= 2      , oC_ErrorCode_NoSuchFile ) &&
        oC_AssignErrorCodeIfFalse(&errorCode , Path[0] == '/'         , oC_ErrorCode_NoSuchFile )
            )
    {
        oC_List(oC_Driver_t)    drivers = oC_DriverMan_GetList();

        errorCode = oC_ErrorCode_NoSuchFile;

        oC_List_Foreach(drivers,driver)
        {
            if(strcmp(&Path[1],driver->FileName)==0)
            {
                outFileInfo->Name      = driver->FileName;
                outFileInfo->Size      = sizeof(oC_Driver_Registration_t);
                outFileInfo->Timestamp = 0;

                errorCode = oC_ErrorCode_None;

                break;
            }
        }
    }

    return errorCode;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_unlink( oC_DevFs_Context_t Context , const char * Path)
{
    return oC_ErrorCode_NotHandledByFileSystem;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_rename( oC_DevFs_Context_t Context , const char * OldName , const char * NewName)
{
    return oC_ErrorCode_NotHandledByFileSystem;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_chmod( oC_DevFs_Context_t Context , const char * Path, oC_FileSystem_FileAttributes_t Attributes , oC_FileSystem_FileAttributes_t Mask)
{
    return oC_ErrorCode_NotHandledByFileSystem;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_utime( oC_DevFs_Context_t Context , const char * Path , oC_Timestamp_t Timestamp )
{
    return oC_ErrorCode_NotHandledByFileSystem;
}

//==========================================================================================================================================
//==========================================================================================================================================
oC_ErrorCode_t oC_DevFs_mkdir( oC_DevFs_Context_t Context , const char * Path )
{
    return oC_ErrorCode_NotHandledByFileSystem;
}

//==========================================================================================================================================
//==========================================================================================================================================
bool oC_DevFs_DirExists( oC_DevFs_Context_t Context , const char * Path)
{
    return strcmp(Path,"/") == 0;
}

#undef  _________________________________________INTERFACE_FUNCTIONS_SECTION________________________________________________________________

#define _________________________________________LOCAL_FUNCTIONS_SECTION____________________________________________________________________

static bool IsFileCorrect( oC_File_t File )
{
    return isram(File) && oC_CheckObjectControl(File,oC_ObjectId_DevFsFile,File->ObjectControl);
}

static bool IsDirCorrect( oC_Dir_t Dir )
{
    return isram(Dir) && oC_CheckObjectControl(Dir,oC_ObjectId_DevFsDir,Dir->ObjectControl);
}

#undef  _________________________________________LOCAL_FUNCTIONS_SECTION____________________________________________________________________