MityDSP::tcDspBootloader Class Reference

Static class to provide application level wrappers for reprogramming MityDSP application and bootloader FPGA and DSP images from a running application. More...

#include <core/DspBootloader.h>

List of all members.

Classes
struct	tsNotifyEvent
Public Types
enum	teState {   eeIdle, eeParsingHexFile, eeErasingFlash, eeProgrammingFlash,   eeProgrammingComplete }
Public Member Functions
MBX_Handle	Mailbox ()
int	ReprogramApp (int anAppID, const char *apFileName)
	This routine updates the DSP application code with the contents of the file specified by the provided FileName.
int	ReprogramFpga (int anAppID, const char *apFileName)
	This routine updates the FPGA image with the contents of the file specified by the provided FileName.
int	ReprogramCLUBApp (const char *apFileName)
	This routine updates the DSP Critical Link Unified bootloader code with the contents of the file specified by the provided FileName.
int	ReprogramCLUBFpga (const char *apFileName)
	This routine updates the DSP Critical Link Unified bootloader FPGA image with the contents of the file specified by the provided FileName.
int	ReprogramBootstrapper (const char *apFileName)
	This routine updates the DSP Critical Link Unified bootloader bootstrapper image with the contents of the file specified by the provided FileName.
int	DecodeFileToFLASH (const char *apFileName, unsigned int anBuffSize, unsigned int anBuffOffset, bool IsDSPCode)
	This routine Decodes an Intel HEX file into a buffer and programes it to FLASH at the offset specified.
Static Public Member Functions
static tcDspBootloader *	GetInstance (void)

---

Detailed Description

Static class to provide application level wrappers for reprogramming MityDSP application and bootloader FPGA and DSP images from a running application.

See also:

tcDspBootloader Page

---

Member Enumeration Documentation

enum MityDSP::tcDspBootloader::teState

Enumerator:

eeIdle
eeParsingHexFile
eeErasingFlash
eeProgrammingFlash
eeProgrammingComplete

---

Member Function Documentation

tcDspBootloader * tcDspBootloader::GetInstance

(

void

)

[static]

MBX_Handle MityDSP::tcDspBootloader::Mailbox

(

)

[inline]

int tcDspBootloader::ReprogramApp	(	int	anAppID,
		const char *	apFileName
	)

This routine updates the DSP application code with the contents of the file specified by the provided FileName.

It is assumed that the file is consistent with a file provided to the MityGUI application.

Parameters:

[in]	anAppID	Application index to reprogram (0 through 7)
[in]	apFileName	Fully qualified filename of file to reprogram

Returns:

Number of Bytes Programmed, or negative number on error

int tcDspBootloader::ReprogramFpga	(	int	anAppID,
		const char *	apFileName
	)

This routine updates the FPGA image with the contents of the file specified by the provided FileName.

It is assumed that the file is consistent with a file provided to the MityGUI application.

Parameters:

[in]	anAppID	Application index to reprogram (1 through 8)
[in]	apFileName	Fully qualified filename of file to reprogram

Returns:

Number of Bytes Programmed, or negative number on error

int tcDspBootloader::ReprogramCLUBApp

(

const char *

apFileName

)

This routine updates the DSP Critical Link Unified bootloader code with the contents of the file specified by the provided FileName.

It is assumed that the file is consistent with a file provided to the MityGUI application.

Parameters:

[in]

apFileName

Fully qualified filename of file to reprogram

Returns:

Number of Bytes Programmed, or negative number on error

int tcDspBootloader::ReprogramCLUBFpga

(

const char *

apFileName

)

This routine updates the DSP Critical Link Unified bootloader FPGA image with the contents of the file specified by the provided FileName.

It is assumed that the file is consistent with a file provided to the MityGUI application.

Parameters:

[in]

apFileName

Fully qualified filename of file to reprogram

Returns:

Number of Bytes Programmed, or negative number on error

int tcDspBootloader::ReprogramBootstrapper

(

const char *

apFileName

)

This routine updates the DSP Critical Link Unified bootloader bootstrapper image with the contents of the file specified by the provided FileName.

It is assumed that the file is consistent with a file provided to the MityGUI application.

Parameters:

[in]

apFileName

Fully qualified filename of file to reprogram

Returns:

Number of Bytes Programmed, or negative number on error

int tcDspBootloader::DecodeFileToFLASH	(	const char *	apFileName,
		unsigned int	anBuffSize,
		unsigned int	anBuffOffset,
		bool	abIsDSPCode
	)

This routine Decodes an Intel HEX file into a buffer and programes it to FLASH at the offset specified.

Parameters:

[in]	apFileName	Fully qualified filename of file to decode
[in]	anBuffSize	Maximum size of the FLASH buffer
[in]	anBuffOffset	Offset into FLASH to write the buffer
[in]	abIsDSPCode	When true, Data is APPLICATION code

Note:

this method allocates a buffer the size of anBuffSize onto the heap. It is deallocated upon exit of this routine.

Returns:

Number of Bytes Programmed, or negative number on error