EVE_LoadFile.h File Reference

Eve_Hal framework APIs for loading file. More...

#include "EVE_Platform.h"

Go to the source code of this file.

Functions
EVE_HAL_EXPORT bool	EVE_Util_loadSdCard (EVE_HalContext *phost)
	Mount the SDcard.
EVE_HAL_EXPORT bool	EVE_Util_sdCardReady (EVE_HalContext *phost)
EVE_HAL_EXPORT bool	EVE_Util_loadRawFile (EVE_HalContext *phost, uint32_t address, const char *filename)
	Load a raw file into RAM_G.
EVE_HAL_EXPORT bool	EVE_Util_loadInflateFile (EVE_HalContext *phost, uint32_t address, const char *filename)
	Load file into RAM_G by CMD_INFLATE.
EVE_HAL_EXPORT bool	EVE_Util_loadImageFile (EVE_HalContext *phost, uint32_t address, const char *filename, uint32_t *format)
	Load image into RAM_G.
EVE_HAL_EXPORT bool	EVE_Util_loadCmdFile (EVE_HalContext *phost, const char *filename, uint32_t *transfered)
EVE_HAL_EXPORT size_t	EVE_Util_readFile (EVE_HalContext *phost, uint8_t *buffer, size_t size, const char *filename)
EVE_HAL_EXPORT bool	EVE_Util_loadMediaFile (EVE_HalContext *phost, const char *filename, uint32_t *transfered)
EVE_HAL_EXPORT void	EVE_Util_closeFile (EVE_HalContext *phost)

Detailed Description

Eve_Hal framework APIs for loading file.

Author

Bridgetek

Date

2018

MIT License

Copyright (c) [2019] [Bridgetek Pte Ltd (BRTChip)]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition in file EVE_LoadFile.h.

Function Documentation

EVE_Util_closeFile()

EVE_HAL_EXPORT void EVE_Util_closeFile

(

EVE_HalContext *

phost

)

Definition at line 555 of file EVE_LoadFile_FATFS.c.

{
#if defined(EVE_SUPPORT_MEDIAFIFO)
    if (phost->LoadFileRemaining)
    {
#if EVE_ENABLE_FATFS
        f_close(&phost->LoadFileObj);
#endif
        phost->LoadFileRemaining = 0;
    }
#endif
}

EVE_Util_loadCmdFile()

EVE_HAL_EXPORT bool EVE_Util_loadCmdFile	(	EVE_HalContext *	phost,
		const char *	filename,
		uint32_t *	transfered
	)

Load a file into the coprocessor FIFO

Definition at line 334 of file EVE_LoadFile_FATFS.c.

{
#if EVE_ENABLE_FATFS
    FRESULT fResult;
    FIL InfSrc;
 
    UINT blocklen;
    int32_t filesize;
    uint8_t buffer[512L];
 
    if (!s_FatFSLoaded)
    {
        eve_printf_debug("SD card not ready\n");
        return false;
    }
 
    fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    if (fResult == FR_DISK_ERR)
    {
        eve_printf_debug("Re-mount SD card\n");
        s_FatFSLoaded = false;
        sdhost_init();
        EVE_Util_loadSdCard(phost);
        fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    }
    if (fResult == FR_OK)
    {
        filesize = f_size(&InfSrc);
        while (filesize > 0)
        {
            fResult = f_read(&InfSrc, buffer, 512, &blocklen); // read a chunk of src file
            filesize -= blocklen;
            blocklen += 3;
            blocklen &= ~3U;
            if (!EVE_Cmd_wrMem(phost, (uint8_t *)buffer, blocklen))
                break;
            if (transfered)
                *transfered += blocklen;
        }
        f_close(&InfSrc);
        return EVE_Cmd_waitFlush(phost);
    }
    else
    {
        eve_printf_debug("Unable to open file: \"%s\"\n", filename);
        return false;
    }
#else
    eve_printf_debug("No filesystem support, cannot open: \"%s\"\n", filename);
    return false;
#endif
}

EVE_Util_loadImageFile()

EVE_HAL_EXPORT bool EVE_Util_loadImageFile	(	EVE_HalContext *	phost,
		uint32_t	address,
		const char *	filename,
		uint32_t *	format
	)

Load image into RAM_G.

Load a file using CMD_LOADIMAGE. The image format is provided as output to the optional format argument

Parameters

phost	Pointer to Hal context
address	Address in RAM_G
filename	File to load
format	Target format of image

Returns

true True if ok

false False if error

Definition at line 270 of file EVE_LoadFile_FATFS.c.

{
#if EVE_ENABLE_FATFS
    FRESULT fResult;
    FIL InfSrc;
 
    UINT blocklen;
    int32_t filesize;
    uint8_t buffer[512L];
 
    if (!s_FatFSLoaded)
    {
        eve_printf_debug("SD card not ready\n");
        return false;
    }
 
    if (phost->CmdFault)
        return false;
 
    fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    if (fResult == FR_DISK_ERR)
    {
        eve_printf_debug("Re-mount SD card\n");
        s_FatFSLoaded = false;
        sdhost_init();
        EVE_Util_loadSdCard(phost);
        fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    }
    if (fResult == FR_OK)
    {
        EVE_Cmd_wr32(phost, CMD_LOADIMAGE);
        EVE_Cmd_wr32(phost, address);
        EVE_Cmd_wr32(phost, OPT_NODL);
        filesize = f_size(&InfSrc);
        while (filesize > 0)
        {
            fResult = f_read(&InfSrc, buffer, 512, &blocklen); // read a chunk of src file
            filesize -= blocklen;
            blocklen += 3;
            blocklen &= ~3U;
            if (!EVE_Cmd_wrMem(phost, (uint8_t *)buffer, blocklen))
                break;
        }
        f_close(&InfSrc);
 
        if (!EVE_Cmd_waitFlush(phost))
            return false;
 
        if (format)
            *format = EVE_Hal_rd32(phost, 0x3097e8);
 
        return true;
    }
    else
    {
        eve_printf_debug("Unable to open file: \"%s\"\n", filename);
        return false;
    }
#else
    eve_printf_debug("No filesystem support, cannot open: \"%s\"\n", filename);
    return false;
#endif
}

EVE_Util_loadInflateFile()

EVE_HAL_EXPORT bool EVE_Util_loadInflateFile	(	EVE_HalContext *	phost,
		uint32_t	address,
		const char *	filename
	)

Load file into RAM_G by CMD_INFLATE.

Parameters

phost	Pointer to Hal context
address	Address to write
filename	File to load

Returns

true True if ok

false False if error

Definition at line 207 of file EVE_LoadFile_FATFS.c.

{
#if EVE_ENABLE_FATFS
    FRESULT fResult;
    FIL InfSrc;
 
    UINT blocklen;
    int32_t filesize;
    uint8_t buffer[512L];
 
    if (!s_FatFSLoaded)
    {
        eve_printf_debug("SD card not ready\n");
        return false;
    }
 
    fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    if (fResult == FR_DISK_ERR)
    {
        eve_printf_debug("Re-mount SD card\n");
        s_FatFSLoaded = false;
        sdhost_init();
        EVE_Util_loadSdCard(phost);
        fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    }
    if (fResult == FR_OK)
    {
        EVE_Cmd_wr32(phost, CMD_INFLATE);
        EVE_Cmd_wr32(phost, address);
        filesize = f_size(&InfSrc);
        while (filesize > 0)
        {
            fResult = f_read(&InfSrc, buffer, 512, &blocklen); // read a chunk of src file
            filesize -= blocklen;
            blocklen += 3;
            blocklen &= ~3U;
            if (!EVE_Cmd_wrMem(phost, (uint8_t *)buffer, blocklen))
                break;
        }
        f_close(&InfSrc);
        return EVE_Cmd_waitFlush(phost);
    }
    else
    {
        eve_printf_debug("Unable to open file: \"%s\"\n", filename);
        return false;
    }
#else
    eve_printf_debug("No filesystem support, cannot open: \"%s\"\n", filename);
    return false;
#endif
}

EVE_Util_loadMediaFile()

EVE_HAL_EXPORT bool EVE_Util_loadMediaFile	(	EVE_HalContext *	phost,
		const char *	filename,
		uint32_t *	transfered
	)

Load a file into the media FIFO. If transfered is set, the file may be streamed partially, and will be kept open until EVE_Util_closeFile is called, and stop once the coprocessor has processed it. Filename may be omitted in subsequent calls

Definition at line 432 of file EVE_LoadFile_FATFS.c.

{
 
#if EVE_ENABLE_FATFS && defined(EVE_SUPPORT_MEDIAFIFO)
    FRESULT fResult = FR_INVALID_OBJECT;
 
    UINT blocklen;
    int32_t filesize;
    uint32_t blockSize = min(512, ((phost->MediaFifoSize >> 3) << 2) - 4);
    uint8_t buffer[512L];
 
    if (!s_FatFSLoaded)
    {
        eve_printf_debug("SD card not ready\n");
        return false;
    }
 
    if (phost->CmdFault)
        return false;
 
    if (transfered && phost->LoadFileRemaining)
    {
        filesize = phost->LoadFileRemaining;
    }
    else
    {
        if (!transfered)
        {
            EVE_Util_closeFile(phost);
        }
        fResult = f_open(&phost->LoadFileObj, filename, FA_READ | FA_OPEN_EXISTING);
        if (fResult == FR_DISK_ERR)
        {
            eve_printf_debug("Re-mount SD card\n");
            s_FatFSLoaded = false;
            sdhost_init();
            EVE_Util_loadSdCard(phost);
            fResult = f_open(&phost->LoadFileObj, filename, FA_READ | FA_OPEN_EXISTING);
        }
        if (fResult == FR_OK)
        {
            filesize = f_size(&phost->LoadFileObj);
            if (transfered)
            {
                phost->LoadFileRemaining = filesize;
            }
            if (filesize == 0)
            {
                /* Empty file, no-op */
                eve_printf_debug("Empty file: \"%s\"\n", filename);
                f_close(&phost->LoadFileObj);
                return true;
            }
        }
        else
        {
            eve_printf_debug("Unable to open file: \"%s\"\n", filename);
            return false;
        }
    }
 
    while (filesize > 0)
    {
        fResult = f_read(&phost->LoadFileObj, buffer, blockSize, &blocklen); // read a chunk of src file
        if (fResult != FR_OK)
        {
            if (fResult == FR_DISK_ERR)
            {
                eve_printf_debug("Lost SD card\n");
                s_FatFSLoaded = false;
                sdhost_init();
            }
            break;
        }
 
        filesize -= blocklen;
        blocklen += 3;
        blocklen &= ~3U;
 
        if (transfered)
        {
            uint32_t transferedPart = 0;
            bool wrRes = EVE_MediaFifo_wrMem(phost, buffer, blocklen, &transferedPart); /* copy data continuously into media fifo memory */
            *transfered += transferedPart;
            if (transferedPart < blocklen)
            {
                long offset = (long)transferedPart - (long)blocklen; /* Negative */
                f_lseek(&phost->LoadFileObj, f_tell(&phost->LoadFileObj) + offset); /* Seek back */
                filesize -= offset; /* Increments remaining (double negative) */
                break; /* Early exit, processing done */
            }
            if (!wrRes)
                break;
        }
        else
        {
            if (!EVE_MediaFifo_wrMem(phost, buffer, blocklen, NULL)) /* copy data continuously into media fifo memory */
                break; /* Coprocessor fault */
        }
    }
 
    if (!transfered)
    {
        f_close(&phost->LoadFileObj); /* Close the opened file */
    }
    else if (filesize)
    {
        phost->LoadFileRemaining = filesize; /* Save remaining */
    }
    else
    {
        f_close(&phost->LoadFileObj);
        phost->LoadFileRemaining = 0;
    }
 
    return (fResult == FR_OK) && (transfered ? EVE_Cmd_waitFlush(phost) : EVE_MediaFifo_waitFlush(phost, false));
 
#else
    eve_printf_debug("No filesystem support, cannot open: \"%s\"\n", filename);
    return false;
#endif
}

EVE_Util_loadRawFile()

EVE_HAL_EXPORT bool EVE_Util_loadRawFile	(	EVE_HalContext *	phost,
		uint32_t	address,
		const char *	filename
	)

Load a raw file into RAM_G.

Parameters

phost	Pointer to Hal context
address	Address in RAM_G
filename	File to load

Returns

true True if ok

false False if error

Definition at line 148 of file EVE_LoadFile_FATFS.c.

{
#if EVE_ENABLE_FATFS
    FRESULT fResult;
    FIL InfSrc;
 
    UINT blocklen;
    int32_t filesize;
    uint8_t buffer[512L];
    uint32_t addr = address;
 
    if (!s_FatFSLoaded)
    {
        eve_printf_debug("SD card not ready\n");
        return false;
    }
 
    fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    if (fResult == FR_DISK_ERR)
    {
        eve_printf_debug("Re-mount SD card\n");
        s_FatFSLoaded = false;
        sdhost_init();
        EVE_Util_loadSdCard(phost);
        fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    }
    if (fResult == FR_OK)
    {
        filesize = f_size(&InfSrc);
        while (filesize > 0)
        {
            fResult = f_read(&InfSrc, buffer, 512, &blocklen); // read a chunk of src file
            filesize -= blocklen;
            EVE_Hal_wrMem(phost, addr, buffer, blocklen);
            addr += blocklen;
        }
        f_close(&InfSrc);
        return true;
    }
    else
    {
        eve_printf_debug("Unable to open file: \"%s\"\n", filename);
        return false;
    }
#else
    eve_printf_debug("No filesystem support, cannot open: \"%s\"\n", filename);
    return false;
#endif
}

EVE_Util_loadSdCard()

EVE_HAL_EXPORT bool EVE_Util_loadSdCard

(

EVE_HalContext *

phost

)

Mount the SDcard.

Load SD card

Parameters

phost

Pointer to Hal context

Returns

true True if ok

false False if error

Definition at line 98 of file EVE_LoadFile_FATFS.c.

{
#if EVE_ENABLE_FATFS
#ifndef PANL_APPLET
    SDHOST_STATUS status = sdhost_card_detect();
    if (status == SDHOST_CARD_INSERTED)
    {
        if (!s_FatFSLoaded && (f_mount(&s_FatFS, MOUNT_POINT, 1) != FR_OK))
        {
            printf("FatFS SD card mount failed\n");
        }
        else
        {
            printf("FatFS SD card mounted successfully\n");
            s_FatFSLoaded = true;
        }
    }
    else
    {
        printf("SD card not detected\n");
        s_FatFSLoaded = false;
    }
#else
    s_FatFSLoaded = true;
#endif
    return s_FatFSLoaded;
#else
    return false;
#endif
}

EVE_Util_readFile()

EVE_HAL_EXPORT size_t EVE_Util_readFile	(	EVE_HalContext *	phost,
		uint8_t *	buffer,
		size_t	size,
		const char *	filename
	)

Read a file into a buffer, returns the number of bytes read

Definition at line 387 of file EVE_LoadFile_FATFS.c.

{
    // Read up to `size` number of bytes from the file into `buffer`, then return the number of read bytes
#if EVE_ENABLE_FATFS
    FRESULT fResult;
    FIL InfSrc;
 
    if (!s_FatFSLoaded)
    {
        eve_printf_debug("SD card not ready\n");
        return false;
    }
 
    fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    if (fResult == FR_DISK_ERR)
    {
        eve_printf_debug("Re-mount SD card\n");
        s_FatFSLoaded = false;
#ifndef RP2040_PLATFORM
        sdhost_init();
#else
        sd_init_card();
#endif
        EVE_Util_loadSdCard(phost);
        fResult = f_open(&InfSrc, filename, FA_READ | FA_OPEN_EXISTING);
    }
    if (fResult == FR_OK)
    {
        size_t read;
        fResult = f_read(&InfSrc, buffer, size, &read);
        f_close(&InfSrc);
        return read;
    }
    else
    {
        eve_printf_debug("Unable to open file: \"%s\"\n", filename);
        return 0;
    }
    
#else
    eve_printf_debug("No filesystem support, cannot open: \"%s\"\n", filename);
    return 0;
#endif
}

EVE_Util_sdCardReady()

EVE_HAL_EXPORT bool EVE_Util_sdCardReady

(

EVE_HalContext *

phost

)

Definition at line 129 of file EVE_LoadFile_FATFS.c.

{
    /* no-op */
#if EVE_ENABLE_FATFS
    return s_FatFSLoaded;
#else
    return false;
#endif
}