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_memoryFill32 (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 manualWaitState, uint8_t accessTime, uint8_t prechargeTime)
	Configures the wait state control of the FRAMCtl module Configures the wait state control of the FRAM module. If using the FRAMCtl_AUTO_MODE the values for accessTime and prechargeTime do not matter. More...

Detailed Description

Function Documentation

void FRAMCtl_configureWaitStateControl	(	uint8_t	manualWaitState,
		uint8_t	accessTime,
		uint8_t	prechargeTime
	)

Configures the wait state control of the FRAMCtl module Configures the wait state control of the FRAM module. If using the FRAMCtl_AUTO_MODE the values for accessTime and prechargeTime do not matter.

Parameters

manualWaitState	chooses if the wait state control is manual or automatic Valid values are: FRAMCTL_AUTO_MODE FRAMCTL_MANUAL_MODE
accessTime	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 FRAMCTL_PRECHARGE_TIME_CYCLES_0 FRAMCTL_PRECHARGE_TIME_CYCLES_1 FRAMCTL_PRECHARGE_TIME_CYCLES_2 FRAMCTL_PRECHARGE_TIME_CYCLES_3 FRAMCTL_PRECHARGE_TIME_CYCLES_4 FRAMCTL_PRECHARGE_TIME_CYCLES_5 FRAMCTL_PRECHARGE_TIME_CYCLES_6 FRAMCTL_PRECHARGE_TIME_CYCLES_7
prechargeTime

void FRAMCtl_disableInterrupt

(

uint16_t

interruptMask

)

Disables selected FRAMCtl interrupt sources.

If header file contains legacy definitions: FRAMCtl_PUC_ON_DOUBLE_BIT_ERROR

• Enable PUC reset if FRAMCtl detects double bit error is detected. FRAMCtl_DOUBLE_BIT_ERROR_INTERRUPT - Interrupts when a double bit error is detected. FRAMCtl_SINGLE_BIT_ERROR_INTERRUPT - Interrupts when a single bit error is detected.

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. FRAMCTL_ACCESS_VIOLATION_INTERRUPT - Interrupts when an access violation occurs. FRAMCTL_ACCESS_TIME_ERROR_INTERRUPT - Interrupts when an access time error occurs.

Returns

None

void FRAMCtl_enableInterrupt

(

uint8_t

interruptMask

)

Enables selected FRAMCtl interrupt sources.

If header file contains legacy definitions: FRAMCtl_PUC_ON_DOUBLE_BIT_ERROR

• Enable PUC reset if FRAMCtl detects double bit error is detected. FRAMCtl_DOUBLE_BIT_ERROR_INTERRUPT - Interrupts when a double bit error is detected. FRAMCtl_SINGLE_BIT_ERROR_INTERRUPT - Interrupts when a single bit error is detected.

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. FRAMCTL_ACCESS_VIOLATION_INTERRUPT - Interrupts when an access violation occurs. FRAMCTL_ACCESS_TIME_ERROR_INTERRUPT - Interrupts when an access time error occurs.

Returns

None

uint8_t FRAMCtl_getInterruptStatus

(

uint16_t

interruptFlagMask

)

Returns the status of the selected FRAMCtl interrupt flags.

If header file contains legacy definitions: FRAMCtl_SINGLE_BIT_ERROR_FLAG - Interrupt flag is set if a correctable bit error has been detected and corrected in the FRAMCtl memory error detection logic. FRAMCtl_DOUBLE_BIT_ERROR_FLAG .- Interrupt flag is set if an uncorrectable bit error has been detected in the FRAMCtl memory error detection logic.

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. FRAMCTL_ACCESS_VIOLATION_FLAG - Interrupt flag is set if an access violation is triggered.

Returns

The current interrupt flag status for the corresponding mask. Return 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.
• FRAMCtl_ACCESS_VIOLATION_FLAG Interrupt flag is set if an access violation is triggered.
  indicating the status of the masked flags

void FRAMCtl_memoryFill32	(	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

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

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

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