include/stb_nvm.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2014 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _STB_NVM_H
#define _STB_NVM_H

#include "techtype.h"

/*---Constant and macro definitions for public use-----------------------------*/

/*---Enumerations for public use-----------------------------------------------*/

typedef enum
{
   FILE_MODE_READ,
   FILE_MODE_WRITE,
   FILE_MODE_OVERWRITE
} E_STB_DSK_FILE_MODE;

typedef enum
{
   FILE_POSITION_START,
   FILE_POSITION_END,
   FILE_POSITION_CURRENT
} E_STB_DSK_FILE_POSITION;

typedef enum
{
   DIR_ENTRY_FILE,
   DIR_ENTRY_DIRECTORY,
   DIR_ENTRY_OTHER
} E_STB_DIR_ENTRY_TYPE;


/*---Global type defs for public use-------------------------------------------*/

/*---Global Function prototypes for public use---------------------------------*/

BOOLEAN STB_NVMFileSize(U8BIT *filename, U32BIT *filesize);

void* STB_NVMOpenFile(U8BIT *name, E_STB_DSK_FILE_MODE mode);

void STB_NVMCloseFile(void *file);

U32BIT STB_NVMReadFile(void *file, U8BIT *data, U32BIT size);

U32BIT STB_NVMWriteFile(void *file, U8BIT *data, U32BIT size);

BOOLEAN STB_NVMDeleteFile(U8BIT *filename);

void* STB_NVMOpenDirectory(U8BIT *dir_name);

BOOLEAN STB_NVMReadDirectory(void *dir, U8BIT *filename, U16BIT filename_len,
   E_STB_DIR_ENTRY_TYPE *entry_type);

void STB_NVMCloseDirectory(void *dir);

#endif /*_STB_NVM_H*/