PikeAero::CConfigurationAlternate Class Reference

Implements the static alternate configuration class (stored in off-chip EEPROM). More...

#include <cconfigurationalternate.h>

Inheritance diagram for PikeAero::CConfigurationAlternate:

[legend]

Collaboration diagram for PikeAero::CConfigurationAlternate:

[legend]

Public Member Functions
	CConfigurationAlternate (CMachine::ubit32 sector=0)
virtual bool	initializeStorage ()
	Initialize configuration storage.
virtual	~CConfigurationAlternate ()
Protected Member Functions
CSPIEEPROM *	eeprom ()
	Abstractor method for EEPROM object instance.
virtual tConfigRecord *	fixedRecord ()
	Return a pointer to the fixed config record.
virtual CMachine::ubit16	getUBit16 (CMachine::ubit16 *mem)
	Get an 16-bit word from memory location...
virtual CMachine::ubit32	getUBit32 (CMachine::ubit32 *mem)
	Get an 32-bit word from memory location...
virtual CMachine::ubit8	getUBit8 (CMachine::ubit8 *mem)
	Get an 8-bit word from memory location...
virtual CMachine::ubit16	setUBit16 (CMachine::ubit16 *mem, CMachine::ubit16 data)
	Store an 16-bit word to memory location...
virtual CMachine::ubit32	setUBit32 (CMachine::ubit32 *mem, CMachine::ubit32 data)
	Store an 32-bit word to memory location...
virtual CMachine::ubit8	setUBit8 (CMachine::ubit8 *mem, CMachine::ubit8 data)
	Store an 8-bit word to memory location...
Private Attributes
CSPIEEPROM *	mMem
CMachine::ubit32	mSector

---

Detailed Description

Implements the static alternate configuration class (stored in off-chip EEPROM).

Author:

Michael Sharkey <mike@pikeaero.com>

Definition at line 33 of file cconfigurationalternate.h.

---

Constructor & Destructor Documentation

PikeAero::CConfigurationAlternate::CConfigurationAlternate

(

CMachine::ubit32

sector = 0

)

Definition at line 29 of file cconfigurationalternate.cpp.

References mMem.

: mSector(SECTOR_SIZE*sector)
, inherited()
{
    mMem = new CSPIEEPROM();
}

PikeAero::CConfigurationAlternate::~CConfigurationAlternate

(

)

[virtual]

Definition at line 36 of file cconfigurationalternate.cpp.

{
}

---

Member Function Documentation

CSPIEEPROM* PikeAero::CConfigurationAlternate::eeprom

(

)

[inline, protected]

Abstractor method for EEPROM object instance.

Returns:

Pointer to EEPROM object instance.

Definition at line 96 of file cconfigurationalternate.h.

References mMem.

Referenced by getUBit16(), getUBit32(), getUBit8(), setUBit16(), setUBit32(), and setUBit8().

{return mMem;}

Here is the caller graph for this function:

CConfigurationAlternate::tConfigRecord * PikeAero::CConfigurationAlternate::fixedRecord

(

)

[protected, virtual]

Return a pointer to the fixed config record.

Returns:

Off-chip pointer to EEPROM memory containing tConfigRecord structure.

Reimplemented from PikeAero::CConfiguration.

Definition at line 54 of file cconfigurationalternate.cpp.

References mSector.

{
    return (tConfigRecord*)mSector;
}

CMachine::ubit16 PikeAero::CConfigurationAlternate::getUBit16

(

CMachine::ubit16 *

mem

)

[protected, virtual]

Get an 16-bit word from memory location...

Parameters:

mem

Pointer to memory location.

Returns:

16-bit word data.

Reimplemented from PikeAero::CConfiguration.

Definition at line 76 of file cconfigurationalternate.cpp.

References eeprom(), and PikeAero::CSPIEEPROM::read().

{
    CMachine::ubit16 data;
    eeprom()->read((CMachine::ubit32)mem,(CMachine::ubit8*)&data,sizeof(CMachine::ubit16));
    return data;
}

Here is the call graph for this function:

CMachine::ubit32 PikeAero::CConfigurationAlternate::getUBit32

(

CMachine::ubit32 *

mem

)

[protected, virtual]

Get an 32-bit word from memory location...

Parameters:

mem

Pointer to memory location.

Returns:

32-bit word data.

Reimplemented from PikeAero::CConfiguration.

Definition at line 88 of file cconfigurationalternate.cpp.

References eeprom(), and PikeAero::CSPIEEPROM::read().

{
    CMachine::ubit32 data;
    eeprom()->read((CMachine::ubit32)mem,(CMachine::ubit8*)&data,sizeof(CMachine::ubit32));
    return data;
}

Here is the call graph for this function:

CMachine::ubit8 PikeAero::CConfigurationAlternate::getUBit8

(

CMachine::ubit8 *

mem

)

[protected, virtual]

Get an 8-bit word from memory location...

Parameters:

mem

Pointer to memory location.

Returns:

8-bit word data.

Reimplemented from PikeAero::CConfiguration.

Definition at line 64 of file cconfigurationalternate.cpp.

References eeprom(), and PikeAero::CSPIEEPROM::read().

{
    CMachine::ubit8 data;
    eeprom()->read((CMachine::ubit32)mem,&data,sizeof(CMachine::ubit8));
    return data;
}

Here is the call graph for this function:

bool PikeAero::CConfigurationAlternate::initializeStorage

(

)

[virtual]

Initialize configuration storage.

Returns:

true on success, else false.

FIXME - not absolutely required since EEPROM has byte-level auto-erase-on-write function.

Reimplemented from PikeAero::CConfiguration.

Definition at line 44 of file cconfigurationalternate.cpp.

{
    /** FIXME - not absolutely required since EEPROM has byte-level auto-erase-on-write function. */
    return true;
}

CMachine::ubit16 PikeAero::CConfigurationAlternate::setUBit16	(	CMachine::ubit16 *	mem,
		CMachine::ubit16	data
	)			[protected, virtual]

Store an 16-bit word to memory location...

Parameters:

mem

Pointer to memory location.

Returns:

16-bit word data.

Reimplemented from PikeAero::CConfiguration.

Definition at line 111 of file cconfigurationalternate.cpp.

References eeprom(), and PikeAero::CSPIEEPROM::write().

{
    eeprom()->write((CMachine::ubit32)mem,(CMachine::ubit8*)&data,sizeof(CMachine::ubit16));
    return data;
}

Here is the call graph for this function:

CMachine::ubit32 PikeAero::CConfigurationAlternate::setUBit32	(	CMachine::ubit32 *	mem,
		CMachine::ubit32	data
	)			[protected, virtual]

Store an 32-bit word to memory location...

Parameters:

mem

Pointer to memory location.

Returns:

32-bit word data.

Reimplemented from PikeAero::CConfiguration.

Definition at line 122 of file cconfigurationalternate.cpp.

References eeprom(), and PikeAero::CSPIEEPROM::write().

{
    eeprom()->write((CMachine::ubit32)mem,(CMachine::ubit8*)&data,sizeof(CMachine::ubit32));
    return data;
}

Here is the call graph for this function:

CMachine::ubit8 PikeAero::CConfigurationAlternate::setUBit8	(	CMachine::ubit8 *	mem,
		CMachine::ubit8	data
	)			[protected, virtual]

Store an 8-bit word to memory location...

Parameters:

mem

Pointer to memory location.

Returns:

8-bit word data.

Reimplemented from PikeAero::CConfiguration.

Definition at line 100 of file cconfigurationalternate.cpp.

References eeprom(), and PikeAero::CSPIEEPROM::write().

{
    eeprom()->write((CMachine::ubit32)mem,&data,sizeof(CMachine::ubit8));
    return data;
}

Here is the call graph for this function:

---

Field Documentation

CSPIEEPROM* PikeAero::CConfigurationAlternate::mMem [private]

Definition at line 100 of file cconfigurationalternate.h.

Referenced by CConfigurationAlternate(), and eeprom().

CMachine::ubit32 PikeAero::CConfigurationAlternate::mSector [private]

Definition at line 101 of file cconfigurationalternate.h.

Referenced by fixedRecord().

---

The documentation for this class was generated from the following files:

• cconfigurationalternate.h
• cconfigurationalternate.cpp