framctl

Functions
void	FRAMCtl_write8 (uint8_t *dataPtr, uint8_t *framPtr, uint16_t numberOfBytes)
	Write data into the fram memory in byte format. More...
void	FRAMCtl_write16 (uint16_t *dataPtr, uint16_t *framPtr, uint16_t numberOfWords)
	Write data into the fram memory in word format. More...
void	FRAMCtl_write32 (uint32_t *dataPtr, uint32_t *framPtr, uint16_t count)
	Write data into the fram memory in long format, pass by reference. More...
void	FRAMCtl_fillMemory32 (uint32_t value, uint32_t *framPtr, uint16_t count)
	Write data into the fram memory in long format, pass by value. More...
void	FRAMCtl_enableInterrupt (uint8_t interruptMask)
	Enables selected FRAMCtl interrupt sources. More...
uint8_t	FRAMCtl_getInterruptStatus (uint16_t interruptFlagMask)
	Returns the status of the selected FRAMCtl interrupt flags. More...
void	FRAMCtl_disableInterrupt (uint16_t interruptMask)
	Disables selected FRAMCtl interrupt sources. More...
void	FRAMCtl_configureWaitStateControl (uint8_t waitState)
	Configures the access time of the FRAMCtl module. More...
void	FRAMCtl_delayPowerUpFromLPM (uint8_t delayStatus)
	Configures when the FRAMCtl module will power up after LPM exit. More...

Detailed Description

Function Documentation

void FRAMCtl_configureWaitStateControl

(

uint8_t

waitState

)

Configures the access time of the FRAMCtl module.

Configures the access time of the FRAMCtl module.

Parameters

waitState

defines the number of CPU cycles required for access time defined in the datasheet Valid values are: FRAMCTL_ACCESS_TIME_CYCLES_0 FRAMCTL_ACCESS_TIME_CYCLES_1 FRAMCTL_ACCESS_TIME_CYCLES_2 FRAMCTL_ACCESS_TIME_CYCLES_3 FRAMCTL_ACCESS_TIME_CYCLES_4 FRAMCTL_ACCESS_TIME_CYCLES_5 FRAMCTL_ACCESS_TIME_CYCLES_6 FRAMCTL_ACCESS_TIME_CYCLES_7

Modified bits are NWAITS of GCCTL0 register.

Returns

None

void FRAMCtl_delayPowerUpFromLPM

(

uint8_t

delayStatus

)

Configures when the FRAMCtl module will power up after LPM exit.

Configures when the FRAMCtl module will power up after LPM exit. The module can either wait until the first FRAMCtl access to power up or power up immediately after leaving LPM. If FRAMCtl power is disabled, a memory access will automatically insert wait states to ensure sufficient timing for the FRAMCtl power-up and access.

Parameters

delayStatus

chooses if FRAMCTL should power up instantly with LPM exit or to wait until first FRAMCTL access after LPM exit Valid values are: FRAMCTL_DELAY_FROM_LPM_ENABLE FRAMCTL_DELAY_FROM_LPM_DISABLE

Returns

None

void FRAMCtl_disableInterrupt

(

uint16_t

interruptMask

)

Disables selected FRAMCtl interrupt sources.

Disables the indicated FRAMCtl interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.

Parameters

interruptMask

is the bit mask of the memory buffer interrupt sources to be disabled. Mask value is the logical OR of any of the following: FRAMCTL_PUC_ON_UNCORRECTABLE_BIT - Enable PUC reset if FRAMCtl uncorrectable bit error detected. FRAMCTL_UNCORRECTABLE_BIT_INTERRUPT - Interrupts when an uncorrectable bit error is detected. FRAMCTL_CORRECTABLE_BIT_INTERRUPT - Interrupts when a correctable bit error is detected.

Returns

None

void FRAMCtl_enableInterrupt

(

uint8_t

interruptMask

)

Enables selected FRAMCtl interrupt sources.

Enables the indicated FRAMCtl interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor. Does not clear interrupt flags.

Parameters

interruptMask

is the bit mask of the memory buffer interrupt sources to be disabled. Mask value is the logical OR of any of the following: FRAMCTL_PUC_ON_UNCORRECTABLE_BIT - Enable PUC reset if FRAMCtl uncorrectable bit error detected. FRAMCTL_UNCORRECTABLE_BIT_INTERRUPT - Interrupts when an uncorrectable bit error is detected. FRAMCTL_CORRECTABLE_BIT_INTERRUPT - Interrupts when a correctable bit error is detected.

Modified bits of GCCTL0 register and bits of FRCTL0 register.

Returns

None

void FRAMCtl_fillMemory32	(	uint32_t	value,
		uint32_t *	framPtr,
		uint16_t	count
	)

Write data into the fram memory in long format, pass by value.

Parameters

value	is the value to written to FRAMCTL memory
framPtr	is the pointer into which to write the data
count	is the number of 32 bit addresses to fill

Returns

None

uint8_t FRAMCtl_getInterruptStatus

(

uint16_t

interruptFlagMask

)

Returns the status of the selected FRAMCtl interrupt flags.

Parameters

interruptFlagMask

is a bit mask of the interrupt flags status to be returned. Mask value is the logical OR of any of the following: FRAMCTL_ACCESS_TIME_ERROR_FLAG - Interrupt flag is set if a wrong setting for NPRECHG and NACCESS is set and FRAMCtl access time is not hold. FRAMCTL_UNCORRECTABLE_BIT_FLAG - Interrupt flag is set if an uncorrectable bit error has been detected in the FRAMCtl memory error detection logic. FRAMCTL_CORRECTABLE_BIT_FLAG - Interrupt flag is set if a correctable bit error has been detected and corrected in the FRAMCtl memory error detection logic.

Returns

Logical OR of any of the following:

• FRAMCtl_ACCESS_TIME_ERROR_FLAG Interrupt flag is set if a wrong setting for NPRECHG and NACCESS is set and FRAMCtl access time is not hold.
• FRAMCtl_UNCORRECTABLE_BIT_FLAG Interrupt flag is set if an uncorrectable bit error has been detected in the FRAMCtl memory error detection logic.
• FRAMCtl_CORRECTABLE_BIT_FLAG Interrupt flag is set if a correctable bit error has been detected and corrected in the FRAMCtl memory error detection logic.
  indicating the status of the masked flags

void FRAMCtl_write16	(	uint16_t *	dataPtr,
		uint16_t *	framPtr,
		uint16_t	numberOfWords
	)

Write data into the fram memory in word format.

Parameters

dataPtr	is the pointer to the data to be written
framPtr	is the pointer into which to write the data
numberOfWords	is the number of words to be written

Returns

None

void FRAMCtl_write32	(	uint32_t *	dataPtr,
		uint32_t *	framPtr,
		uint16_t	count
	)

Write data into the fram memory in long format, pass by reference.

Parameters

dataPtr	is the pointer to the data to be written
framPtr	is the pointer into which to write the data
count	is the number of 32 bit words to be written

Returns

None

void FRAMCtl_write8	(	uint8_t *	dataPtr,
		uint8_t *	framPtr,
		uint16_t	numberOfBytes
	)

Write data into the fram memory in byte format.

Parameters

dataPtr	is the pointer to the data to be written
framPtr	is the pointer into which to write the data
numberOfBytes	is the number of bytes to be written

Returns

None