MSP430 DriverLib for MSP430FR5xx_6xx Devices  2.91.13.01
framctl_a

Functions

void FRAMCtl_A_write8 (uint8_t *dataPtr, uint8_t *framPtr, uint16_t numberOfBytes)
 Write data into the fram memory in byte format. More...
 
void FRAMCtl_A_write16 (uint16_t *dataPtr, uint16_t *framPtr, uint16_t numberOfWords)
 Write data into the fram memory in word format. More...
 
void FRAMCtl_A_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_A_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_A_enableInterrupt (uint8_t interruptMask)
 Enables selected FRAMCtl_A interrupt sources. More...
 
uint8_t FRAMCtl_A_getInterruptStatus (uint16_t interruptFlagMask)
 Returns the status of the selected FRAMCtl_A interrupt flags. More...
 
void FRAMCtl_A_disableInterrupt (uint16_t interruptMask)
 Disables selected FRAMCtl_A interrupt sources. More...
 
void FRAMCtl_A_clearInterrupt (uint16_t interruptFlagMask)
 Clears selected FRAMCtl_A interrupt status flag. More...
 
void FRAMCtl_A_configureWaitStateControl (uint8_t waitState)
 Configures the access time of the FRAMCtl_A module. More...
 
void FRAMCtl_A_delayPowerUpFromLPM (uint8_t delayStatus)
 Configures when the FRAMCtl_A module will power up after LPM exit. More...
 
void FRAMCtl_A_enableWriteProtection (void)
 Enables FRAM write protection. More...
 
void FRAMCtl_A_disableWriteProtection (void)
 Disables FRAM write protection. More...
 

Detailed Description

Function Documentation

§ FRAMCtl_A_clearInterrupt()

void FRAMCtl_A_clearInterrupt ( uint16_t  interruptFlagMask)

Clears selected FRAMCtl_A interrupt status flag.

Clears the indicated FRAMCtl_A interrupt status flag. These interrupt status flag can also be cleared through reading the system reset vector word SYSRSTIV.

Parameters
interruptFlagMaskis a bit mask of the interrupt flags status to be cleared. Mask value is the logical OR of any of the following:
  • FRAMCTL_A_ACCESS_TIME_ERROR_FLAG - Interrupt flag is set if a wrong setting for NPRECHG and NACCESS is set and FRAMCtl_A access time is not hold.
  • FRAMCTL_A_UNCORRECTABLE_BIT_FLAG - Interrupt flag is set if an uncorrectable bit error has been detected in the FRAMCtl_A memory error detection logic.
  • FRAMCTL_A_CORRECTABLE_BIT_FLAG - Interrupt flag is set if a correctable bit error has been detected and corrected in the FRAMCtl_A memory error detection logic.
  • FRAMCTL_A_WRITE_PROTECTION_FLAG - Interrupt flag is set if a write access to FRAM memory
Returns
None

§ FRAMCtl_A_configureWaitStateControl()

void FRAMCtl_A_configureWaitStateControl ( uint8_t  waitState)

Configures the access time of the FRAMCtl_A module.

Configures the access time of the FRAMCtl_A module.

Parameters
waitStatedefines the number of CPU cycles required for access time defined in the datasheet Valid values are:
  • FRAMCTL_A_ACCESS_TIME_CYCLES_0
  • FRAMCTL_A_ACCESS_TIME_CYCLES_1
  • FRAMCTL_A_ACCESS_TIME_CYCLES_2
  • FRAMCTL_A_ACCESS_TIME_CYCLES_3
  • FRAMCTL_A_ACCESS_TIME_CYCLES_4
  • FRAMCTL_A_ACCESS_TIME_CYCLES_5
  • FRAMCTL_A_ACCESS_TIME_CYCLES_6
  • FRAMCTL_A_ACCESS_TIME_CYCLES_7
  • FRAMCTL_A_ACCESS_TIME_CYCLES_8
  • FRAMCTL_A_ACCESS_TIME_CYCLES_9
  • FRAMCTL_A_ACCESS_TIME_CYCLES_10
  • FRAMCTL_A_ACCESS_TIME_CYCLES_11
  • FRAMCTL_A_ACCESS_TIME_CYCLES_12
  • FRAMCTL_A_ACCESS_TIME_CYCLES_13
  • FRAMCTL_A_ACCESS_TIME_CYCLES_14
  • FRAMCTL_A_ACCESS_TIME_CYCLES_15

Modified bits are NWAITS of GCCTL0 register.

Returns
None

§ FRAMCtl_A_delayPowerUpFromLPM()

void FRAMCtl_A_delayPowerUpFromLPM ( uint8_t  delayStatus)

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

Configures when the FRAMCtl_A module will power up after LPM exit. The module can either wait until the first FRAM access to power up or power up immediately after leaving LPM. If FRAM power is disabled, the FRAM memory remains in inactive mode until the FRAM memory is actually accessed. If FRAM power is enabled, the FRAM wil be immediately powered up (active mode).

Parameters
delayStatuschooses if FRAMCTL_A should power up instantly with LPM exit or to wait until first FRAMCTL_A access after LPM exit Valid values are:
  • FRAMCTL_A_DELAY_FROM_LPM_ENABLE
  • FRAMCTL_A_DELAY_FROM_LPM_DISABLE
Returns
None

§ FRAMCtl_A_disableInterrupt()

void FRAMCtl_A_disableInterrupt ( uint16_t  interruptMask)

Disables selected FRAMCtl_A interrupt sources.

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

Parameters
interruptMaskis the bit mask of the memory buffer interrupt sources to be disabled. Mask value is the logical OR of any of the following:
  • FRAMCTL_A_PUC_ON_UNCORRECTABLE_BIT - Enable PUC reset if FRAMCtl_A uncorrectable bit error detected.
  • FRAMCTL_A_UNCORRECTABLE_BIT_INTERRUPT - Interrupts when an uncorrectable bit error is detected.
  • FRAMCTL_A_CORRECTABLE_BIT_INTERRUPT - Interrupts when a correctable bit error is detected.
  • FRAMCTL_A_ACCESS_TIME_ERROR_INTERRUPT - Interrupts when an access time error occurs.
  • FRAMCTL_A_WRITE_PROTECTION_INTERRUPT - Interrupts when detecting a write access to FRAM.
Returns
None

§ FRAMCtl_A_disableWriteProtection()

void FRAMCtl_A_disableWriteProtection ( void  )

Disables FRAM write protection.

Disables the FRAM write protection. Writing to FRAM memory is allowed.

Modified bits are WPROT of FRCTL0 register.

Returns
None

§ FRAMCtl_A_enableInterrupt()

void FRAMCtl_A_enableInterrupt ( uint8_t  interruptMask)

Enables selected FRAMCtl_A interrupt sources.

Enables the indicated FRAMCtl_A 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
interruptMaskis the bit mask of the memory buffer interrupt sources to be disabled. Mask value is the logical OR of any of the following:
  • FRAMCTL_A_PUC_ON_UNCORRECTABLE_BIT - Enable PUC reset if FRAMCtl_A uncorrectable bit error detected.
  • FRAMCTL_A_UNCORRECTABLE_BIT_INTERRUPT - Interrupts when an uncorrectable bit error is detected.
  • FRAMCTL_A_CORRECTABLE_BIT_INTERRUPT - Interrupts when a correctable bit error is detected.
  • FRAMCTL_A_ACCESS_TIME_ERROR_INTERRUPT - Interrupts when an access time error occurs.
  • FRAMCTL_A_WRITE_PROTECTION_INTERRUPT - Interrupts when detecting a write access to FRAM.

Modified bits of GCCTL0 register and bits of FRCTL0 register.

Returns
None

§ FRAMCtl_A_enableWriteProtection()

void FRAMCtl_A_enableWriteProtection ( void  )

Enables FRAM write protection.

This function enables FRAM write protection and protect entire FRAM memory from unintended write. It should be used as temporary protection. The permanent FRAM memory protection should be done via MPU segments related APIs.

Modified bits are WPROT of FRCTL0 register.

Returns
None

§ FRAMCtl_A_fillMemory32()

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

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

Parameters
valueis the value to written to FRAMCTL_A memory
framPtris the pointer into which to write the data
countis the number of 32 bit addresses to fill
Returns
None

§ FRAMCtl_A_getInterruptStatus()

uint8_t FRAMCtl_A_getInterruptStatus ( uint16_t  interruptFlagMask)

Returns the status of the selected FRAMCtl_A interrupt flags.

Parameters
interruptFlagMaskis a bit mask of the interrupt flags status to be returned. Mask value is the logical OR of any of the following:
  • FRAMCTL_A_ACCESS_TIME_ERROR_FLAG - Interrupt flag is set if a wrong setting for NPRECHG and NACCESS is set and FRAMCtl_A access time is not hold.
  • FRAMCTL_A_UNCORRECTABLE_BIT_FLAG - Interrupt flag is set if an uncorrectable bit error has been detected in the FRAMCtl_A memory error detection logic.
  • FRAMCTL_A_CORRECTABLE_BIT_FLAG - Interrupt flag is set if a correctable bit error has been detected and corrected in the FRAMCtl_A memory error detection logic.
  • FRAMCTL_A_WRITE_PROTECTION_FLAG - Interrupt flag is set if a write access to FRAM memory
Returns
Logical OR of any of the following:
  • FRAMCTL_A_ACCESS_TIME_ERROR_FLAG Interrupt flag is set if a wrong setting for NPRECHG and NACCESS is set and FRAMCtl_A access time is not hold.
  • FRAMCTL_A_UNCORRECTABLE_BIT_FLAG Interrupt flag is set if an uncorrectable bit error has been detected in the FRAMCtl_A memory error detection logic.
  • FRAMCTL_A_CORRECTABLE_BIT_FLAG Interrupt flag is set if a correctable bit error has been detected and corrected in the FRAMCtl_A memory error detection logic.
  • FRAMCTL_A_WRITE_PROTECTION_FLAG Interrupt flag is set if a write access to FRAM memory
    indicating the status of the masked flags

§ FRAMCtl_A_write16()

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

Write data into the fram memory in word format.

Parameters
dataPtris the pointer to the data to be written
framPtris the pointer into which to write the data
numberOfWordsis the number of words to be written
Returns
None

§ FRAMCtl_A_write32()

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

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

Parameters
dataPtris the pointer to the data to be written
framPtris the pointer into which to write the data
countis the number of 32 bit words to be written
Returns
None

§ FRAMCtl_A_write8()

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

Write data into the fram memory in byte format.

Parameters
dataPtris the pointer to the data to be written
framPtris the pointer into which to write the data
numberOfBytesis the number of bytes to be written
Returns
None

Copyright 2020, Texas Instruments Incorporated