mh5nvm.c File Reference

functions to support NVM store More...

#include "mh5memory.h"
#include "mh5debug.h"
#include "mh5profile.h"
#include "mh5nvm.h"
#include "mheg5_nvm.h"
#include "stb_nvm.h"

Data Structures
struct	sNvmFile

Macros
#define	MAX_NAME_LENGTH   8
#define	NVM_STORE_FILENAME   "NVMFILELIST.dat"

Typedefs
typedef struct sNvmFile	MHEG5NvmFile

Functions
void	MHEG5nvmInitialise (U32BIT nvmSize)
	Initialise NVM Storage. More...
MHEG5Bool	MHEG5nvmRead (MHEG5String fn, void **buf, MHEG5Int *len)
	Read a file from the nvm store. More...
MHEG5Bool	MHEG5nvmWrite (MHEG5String fn, void *buf, MHEG5Int len)
	Write a file to the nvm store. More...
void	MHEG5nvmReset (void)
	Clear all NVM data from the persistent store. More...

Detailed Description

functions to support NVM store

Date

20/12/2012

Author

Adam Sturtridge

Macro Definition Documentation

#define MAX_NAME_LENGTH   8

#define NVM_STORE_FILENAME   "NVMFILELIST.dat"

Typedef Documentation

typedef struct sNvmFile MHEG5NvmFile

Function Documentation

void MHEG5nvmInitialise

(

U32BIT

nvmSize

)

Initialise NVM Storage.

Parameters

nvmSize

Size of nvm available

Returns

void

MHEG5Bool MHEG5nvmRead	(	MHEG5String	fn,
		void **	buf,
		MHEG5Int *	len
	)

Read a file from the nvm store.

Read a file from the persistent store.

Parameters

fn	File name specifier.
buf	Data variable.
len	Data length.

Returns

MHEG5TRUE - Success. MHEG5FALSE - Failure.

void MHEG5nvmReset

(

void

)

Clear all NVM data from the persistent store.

Returns

void.

MHEG5Bool MHEG5nvmWrite	(	MHEG5String	fn,
		void *	buf,
		MHEG5Int	len
	)

Write a file to the nvm store.

Write a file to the persistent store.

Parameters

fn	File name specifier.
buf	Data variable.
len	Data length.

Returns

MHEG5TRUE - Success. MHEG5FALSE - Failure.