FileTransfer.h File Reference

File transfer interface from host to flash. More...

#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	Ftf_Progress

Macros
#define	FTF_PROGESS_READ   1
#define	FTF_PROGESS_WRITE   2
#define	MSG_SIZE   200

Typedefs
typedef struct Ftf_Progress	Ftf_Progress_t

Functions
uint32_t	Ftf_Write_File_nBytes_To_RAM_G (EVE_HalContext *phost, const char *file, uint32_t addr, int nbytes, int offset)
	Transfer a file to RAM_G.
uint32_t	Ftf_Write_File_To_RAM_G (EVE_HalContext *phost, const char *file, uint32_t addr)
	Transfer a file to RAM_G.
uint32_t	Ftf_Write_FileArr_To_RAM_G (EVE_HalContext *phost, char *file[], uint32_t addr)
	Transfer a file list into RAM_G.
uint32_t	Ftf_Read_File_From_RAM_G (EVE_HalContext *phost, const uint8_t *output, uint32_t startAddress, uint32_t size)
	Read data on RAM_G into a file.

Detailed Description

File transfer interface from host to flash.

Author

Tuan Nguyen tuan..nosp@m.nguy.nosp@m.en@br.nosp@m.tchi.nosp@m.p.com

Date

2019

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 FileTransfer.h.

Macro Definition Documentation

FTF_PROGESS_READ

#define FTF_PROGESS_READ   1

Definition at line 36 of file FileTransfer.h.

FTF_PROGESS_WRITE

#define FTF_PROGESS_WRITE   2

Definition at line 37 of file FileTransfer.h.

MSG_SIZE

#define MSG_SIZE   200

Definition at line 38 of file FileTransfer.h.

Typedef Documentation

Ftf_Progress_t

typedef struct Ftf_Progress Ftf_Progress_t

Function Documentation

Ftf_Read_File_From_RAM_G()

uint32_t Ftf_Read_File_From_RAM_G	(	EVE_HalContext *	phost,
		const uint8_t *	output,
		uint32_t	startAddress,
		uint32_t	size
	)

Read data on RAM_G into a file.

Parameters

phost	Pointer to Hal context
output	Filename output
startAddress	Address on RAM_G
size	Size to read

Returns

uint32_t 1 on successful, 0 on error

Definition at line 825 of file FileTransfer.c.

                                                                                                                      {
    if (-1 == FileIO_File_Open(output, FILEIO_E_FOPEN_WRITE)) {
        printf("Unable to open file: %s\n", output);
        return 0;
    }
 
    uint8_t pbuff[FREAD_BLOCK];
    uint32_t block = 0;
    uint32_t offset = 0;
 
    while (size > 0) {
        block = size > FREAD_BLOCK ? FREAD_BLOCK : size;
        EVE_Hal_rdMem(phost, pbuff, startAddress + offset, block);
        offset += block;
        size -= block;
 
        if (0 == FileIO_File_Write(pbuff, block)) {
            printf("Unable to write file: %s\n", output);
            return 0;
        }
 
    }
    FileIO_File_Close();
 
    return 1;
}

Ftf_Write_File_nBytes_To_RAM_G()

uint32_t Ftf_Write_File_nBytes_To_RAM_G	(	EVE_HalContext *	phost,
		const char *	file,
		uint32_t	addr,
		int	nbytes,
		int	offset
	)

Transfer a file to RAM_G.

Parameters

phost	Pointer to Hal context
file	File to transfer
addr	Address on RAM_G
nbytes	Number of bytes to transfer
offset	Offset of the file

Returns

uint32_t Number of bytes transfered on successful, 0 on error

Definition at line 738 of file FileTransfer.c.

                                                                                                                        {
    const uint32_t BufferSize = FREAD_BLOCK;
    int32_t bytes;
    int32_t sent = 0;
    int32_t fileSize = 0;
    uint8_t pbuff[FREAD_BLOCK];
 
    fileSize = FileIO_File_Open(file, FILEIO_E_FOPEN_READ);
    if (nbytes == 0){
        nbytes = fileSize;
    }
 
    if (offset) {
        FileIO_File_Seek(offset);
    }
 
    if (0 >= fileSize) {
        printf("Unable to open file: %s\n", file);
        return 0;
    }
    while (fileSize > 0 && sent < nbytes) {
        bytes = FileIO_File_Read(pbuff, BufferSize);
        if (bytes == 0) {
            printf("Error on f_read\n");
            break;
        }
        if ((sent + bytes) > nbytes) {
            bytes = nbytes - sent;
        }
        EVE_Hal_wrMem(phost, addr, pbuff, bytes);
        fileSize -= bytes;
        sent += bytes;
        addr += bytes;
    }
 
    FileIO_File_Close();
 
    return sent;
}

Ftf_Write_File_To_RAM_G()

uint32_t Ftf_Write_File_To_RAM_G	(	EVE_HalContext *	phost,
		const char *	file,
		uint32_t	addr
	)

Transfer a file to RAM_G.

Parameters

phost	Pointer to Hal context
file	File to transfer
addr	Address on RAM_G

Returns

uint32_t Number of bytes transfered on successful, 0 on error

Definition at line 786 of file FileTransfer.c.

                                                                                         {
    return Ftf_Write_File_nBytes_To_RAM_G(phost, file, addr, 0, 0);
}

Ftf_Write_FileArr_To_RAM_G()

uint32_t Ftf_Write_FileArr_To_RAM_G	(	EVE_HalContext *	phost,
		char *	file[],
		uint32_t	addr
	)

Transfer a file list into RAM_G.

Parameters

phost	Pointer to Hal context
file	File name array
addr	Address on RAM_G

Returns

uint32_t Number of bytes transfered on successful, 0 on error

Definition at line 798 of file FileTransfer.c.

                                                                                        {
    int i = 0;
    uint32_t bytes;
    uint32_t sent = 0;
    while (file[i] != NULL) {
        bytes = Ftf_Write_File_To_RAM_G(phost, file[i], addr);
        if (0 == bytes) {
            printf("Error when write file: %s\n", file[i]);
            return 0;
        }
 
        sent += bytes;
        i++;
    }
 
    return sent;
}