MSP430 DriverLib for MSP430FR2xx_4xx Devices  2.91.13.01
sysctl

Functions

void SysCtl_enableDedicatedJTAGPins (void)
 Sets the JTAG pins to be exclusively for JTAG until a BOR occurs. More...
 
uint8_t SysCtl_getBSLEntryIndication (void)
 Returns the indication of a BSL entry sequence from the Spy-Bi-Wire. More...
 
void SysCtl_enablePMMAccessProtect (void)
 Enables PMM Access Protection. More...
 
void SysCtl_enableRAMBasedInterruptVectors (void)
 Enables RAM-based Interrupt Vectors. More...
 
void SysCtl_disableRAMBasedInterruptVectors (void)
 Disables RAM-based Interrupt Vectors. More...
 
void SysCtl_enableBSLProtect (void)
 Enables BSL memory protection. More...
 
void SysCtl_disableBSLProtect (void)
 Disables BSL memory protection. More...
 
void SysCtl_enableBSLMemory (void)
 Enables BSL memory. More...
 
void SysCtl_disableBSLMemory (void)
 Disables BSL memory. More...
 
void SysCtl_setRAMAssignedToBSL (uint8_t BSLRAMAssignment)
 Sets RAM assignment to BSL area. More...
 
void SysCtl_initJTAGMailbox (uint8_t mailboxSizeSelect, uint8_t autoClearInboxFlagSelect)
 Initializes JTAG Mailbox with selected properties. More...
 
uint8_t SysCtl_getJTAGMailboxFlagStatus (uint8_t mailboxFlagMask)
 Returns the status of the selected JTAG Mailbox flags. More...
 
void SysCtl_clearJTAGMailboxFlagStatus (uint8_t mailboxFlagMask)
 Clears the status of the selected JTAG Mailbox flags. More...
 
uint16_t SysCtl_getJTAGInboxMessage16Bit (uint8_t inboxSelect)
 Returns the contents of the selected JTAG Inbox in a 16 bit format. More...
 
uint32_t SysCtl_getJTAGInboxMessage32Bit (void)
 Returns the contents of JTAG Inboxes in a 32 bit format. More...
 
void SysCtl_setJTAGOutgoingMessage16Bit (uint8_t outboxSelect, uint16_t outgoingMessage)
 Sets a 16 bit outgoing message in to the selected JTAG Outbox. More...
 
void SysCtl_setJTAGOutgoingMessage32Bit (uint32_t outgoingMessage)
 Sets a 32 bit message in to both JTAG Outboxes. More...
 
void SysCtl_protectFRAMWrite (uint8_t writeProtect)
 Sets write protected for data FRAM and program FRAM. More...
 
void SysCtl_enableFRAMWrite (uint8_t writeEnable)
 Sets write enable for data FRAM and program FRAM. More...
 
void SysCtl_setInfraredConfig (uint8_t dataSource, uint8_t mode, uint8_t polarity)
 Sets infrared configuration bits. More...
 
void SysCtl_enableInfrared (void)
 Enables infrared function. More...
 
void SysCtl_disableInfrared (void)
 Disables infrared function. More...
 
uint8_t SysCtl_getInfraredData (void)
 This function returns the infrared data if the infrared data source is configured as from IRDATA bit. More...
 
void SysCtl_setFRWPOA (uint8_t offsetAddress)
 This function sets the Program FRAM write protection offset address from the beginning of Program FRAM. The offset increases by 1 kB resolution. More...
 

Detailed Description

Function Documentation

§ SysCtl_clearJTAGMailboxFlagStatus()

void SysCtl_clearJTAGMailboxFlagStatus ( uint8_t  mailboxFlagMask)

Clears the status of the selected JTAG Mailbox flags.

This function clears the selected JTAG Mailbox flags.

Parameters
mailboxFlagMaskis the bit mask of JTAG mailbox flags that the status of should be cleared. Mask value is the logical OR of any of the following:
  • SYSCTL_JTAGOUTBOX_FLAG0 - flag for JTAG outbox 0
  • SYSCTL_JTAGOUTBOX_FLAG1 - flag for JTAG outbox 1
  • SYSCTL_JTAGINBOX_FLAG0 - flag for JTAG inbox 0
  • SYSCTL_JTAGINBOX_FLAG1 - flag for JTAG inbox 1
Returns
None

§ SysCtl_disableBSLMemory()

void SysCtl_disableBSLMemory ( void  )

Disables BSL memory.

This function disables BSL memory, which makes BSL memory act like vacant memory.

Returns
None

§ SysCtl_disableBSLProtect()

void SysCtl_disableBSLProtect ( void  )

Disables BSL memory protection.

This function disables protection on the BSL memory.

Returns
None

§ SysCtl_disableInfrared()

void SysCtl_disableInfrared ( void  )

Disables infrared function.

Returns
None

§ SysCtl_disableRAMBasedInterruptVectors()

void SysCtl_disableRAMBasedInterruptVectors ( void  )

Disables RAM-based Interrupt Vectors.

This function disables the interrupt vectors from being generated at the top of the RAM.

Returns
None

§ SysCtl_enableBSLMemory()

void SysCtl_enableBSLMemory ( void  )

Enables BSL memory.

This function enables BSL memory, which allows BSL memory to be addressed

Returns
None

§ SysCtl_enableBSLProtect()

void SysCtl_enableBSLProtect ( void  )

Enables BSL memory protection.

This function enables protection on the BSL memory, which prevents any reading, programming, or erasing of the BSL memory.

Returns
None

§ SysCtl_enableDedicatedJTAGPins()

void SysCtl_enableDedicatedJTAGPins ( void  )

Sets the JTAG pins to be exclusively for JTAG until a BOR occurs.

This function sets the JTAG pins to be exclusively used for the JTAG, and not to be shared with the GPIO pins. This setting can only be cleared when a BOR occurs.

Returns
None

§ SysCtl_enableFRAMWrite()

void SysCtl_enableFRAMWrite ( uint8_t  writeEnable)

Sets write enable for data FRAM and program FRAM.

Parameters
writeEnableis the value setting data FRAM and program write enabled. Mask value is the logical OR of any of the following:
  • SYSCTL_FRAMWRITEPROTECTION_DATA - data FRAM write protected
  • SYSCTL_FRAMWRITEPROTECTION_PROGRAM - program FRAM write protected
Returns
None

§ SysCtl_enableInfrared()

void SysCtl_enableInfrared ( void  )

Enables infrared function.

Returns
None

§ SysCtl_enablePMMAccessProtect()

void SysCtl_enablePMMAccessProtect ( void  )

Enables PMM Access Protection.

This function enables the PMM Access Protection, which will lock any changes on the PMM control registers until a BOR occurs.

Returns
None

§ SysCtl_enableRAMBasedInterruptVectors()

void SysCtl_enableRAMBasedInterruptVectors ( void  )

Enables RAM-based Interrupt Vectors.

This function enables RAM-base Interrupt Vectors, which means that interrupt vectors are generated with the end address at the top of RAM, instead of the top of the lower 64kB of flash.

Returns
None

§ SysCtl_getBSLEntryIndication()

uint8_t SysCtl_getBSLEntryIndication ( void  )

Returns the indication of a BSL entry sequence from the Spy-Bi-Wire.

This function returns the indication of a BSL entry sequence from the Spy- Bi-Wire.

Returns
One of the following:
  • SYSCTL_BSLENTRY_INDICATED
  • SYSCTL_BSLENTRY_NOTINDICATED
    indicating if a BSL entry sequence was detected

§ SysCtl_getInfraredData()

uint8_t SysCtl_getInfraredData ( void  )

This function returns the infrared data if the infrared data source is configured as from IRDATA bit.

Returns
the infrared logic data '0' or '1'

§ SysCtl_getJTAGInboxMessage16Bit()

uint16_t SysCtl_getJTAGInboxMessage16Bit ( uint8_t  inboxSelect)

Returns the contents of the selected JTAG Inbox in a 16 bit format.

This function returns the message contents of the selected JTAG inbox. If the auto clear settings for the Inbox flags were set, then using this function will automatically clear the corresponding JTAG inbox flag.

Parameters
inboxSelectis the chosen JTAG inbox that the contents of should be returned Valid values are:
  • SYSCTL_JTAGINBOX_0 - return contents of JTAG inbox 0
  • SYSCTL_JTAGINBOX_1 - return contents of JTAG inbox 1
Returns
The contents of the selected JTAG inbox in a 16 bit format.

§ SysCtl_getJTAGInboxMessage32Bit()

uint32_t SysCtl_getJTAGInboxMessage32Bit ( void  )

Returns the contents of JTAG Inboxes in a 32 bit format.

This function returns the message contents of both JTAG inboxes in a 32 bit format. This function should be used if 32-bit messaging has been set in the SYS_initJTAGMailbox() function. If the auto clear settings for the Inbox flags were set, then using this function will automatically clear both JTAG inbox flags.

Returns
The contents of both JTAG messages in a 32 bit format.

§ SysCtl_getJTAGMailboxFlagStatus()

uint8_t SysCtl_getJTAGMailboxFlagStatus ( uint8_t  mailboxFlagMask)

Returns the status of the selected JTAG Mailbox flags.

This function will return the status of the selected JTAG Mailbox flags in bit mask format matching that passed into the mailboxFlagMask parameter.

Parameters
mailboxFlagMaskis the bit mask of JTAG mailbox flags that the status of should be returned. Mask value is the logical OR of any of the following:
  • SYSCTL_JTAGOUTBOX_FLAG0 - flag for JTAG outbox 0
  • SYSCTL_JTAGOUTBOX_FLAG1 - flag for JTAG outbox 1
  • SYSCTL_JTAGINBOX_FLAG0 - flag for JTAG inbox 0
  • SYSCTL_JTAGINBOX_FLAG1 - flag for JTAG inbox 1
Returns
A bit mask of the status of the selected mailbox flags.

§ SysCtl_initJTAGMailbox()

void SysCtl_initJTAGMailbox ( uint8_t  mailboxSizeSelect,
uint8_t  autoClearInboxFlagSelect 
)

Initializes JTAG Mailbox with selected properties.

This function sets the specified settings for the JTAG Mailbox system. The settings that can be set are the size of the JTAG messages, and the auto- clearing of the inbox flags. If the inbox flags are set to auto-clear, then the inbox flags will be cleared upon reading of the inbox message buffer, otherwise they will have to be reset by software using the SYS_clearJTAGMailboxFlagStatus() function.

Parameters
mailboxSizeSelectis the size of the JTAG Mailboxes, whether 16- or 32-bits. Valid values are:
  • SYSCTL_JTAGMBSIZE_16BIT [Default] - the JTAG messages will take up only one JTAG mailbox (i. e. an outgoing message will take up only 1 outbox of the JTAG mailboxes)
  • SYSCTL_JTAGMBSIZE_32BIT - the JTAG messages will be contained within both JTAG mailboxes (i. e. an outgoing message will take up both Outboxes of the JTAG mailboxes)
    Modified bits are JMBMODE of SYSJMBC register.
autoClearInboxFlagSelectdecides how the JTAG inbox flags should be cleared, whether automatically after the corresponding outbox has been written to, or manually by software. Valid values are:
  • SYSCTL_JTAGINBOX0AUTO_JTAGINBOX1AUTO [Default] - both JTAG inbox flags will be reset automatically when the corresponding inbox is read from.
  • SYSCTL_JTAGINBOX0AUTO_JTAGINBOX1SW - only JTAG inbox 0 flag is reset automatically, while JTAG inbox 1 is reset with the
  • SYSCTL_JTAGINBOX0SW_JTAGINBOX1AUTO - only JTAG inbox 1 flag is reset automatically, while JTAG inbox 0 is reset with the
  • SYSCTL_JTAGINBOX0SW_JTAGINBOX1SW - both JTAG inbox flags will need to be reset manually by the
    Modified bits are JMBCLR0OFF and JMBCLR1OFF of SYSJMBC register.
Returns
None

§ SysCtl_protectFRAMWrite()

void SysCtl_protectFRAMWrite ( uint8_t  writeProtect)

Sets write protected for data FRAM and program FRAM.

Parameters
writeProtectis the value setting data FRAM and program write protection. Mask value is the logical OR of any of the following:
  • SYSCTL_FRAMWRITEPROTECTION_DATA - data FRAM write protected
  • SYSCTL_FRAMWRITEPROTECTION_PROGRAM - program FRAM write protected
Returns
None

§ SysCtl_setFRWPOA()

void SysCtl_setFRWPOA ( uint8_t  offsetAddress)

This function sets the Program FRAM write protection offset address from the beginning of Program FRAM. The offset increases by 1 kB resolution.

Parameters
offsetAddressis the Program FRAM write protection offset address from the beginning of Program FRAM, with offset increases of 1KB resolution. Mask value is the logical OR of any of the following:
  • SYSCTL_FRWPOA0
  • SYSCTL_FRWPOA1
  • SYSCTL_FRWPOA2
  • SYSCTL_FRWPOA3
  • SYSCTL_FRWPOA4
  • SYSCTL_FRWPOA5
Returns
None

§ SysCtl_setInfraredConfig()

void SysCtl_setInfraredConfig ( uint8_t  dataSource,
uint8_t  mode,
uint8_t  polarity 
)

Sets infrared configuration bits.

Parameters
dataSourceis the value setting infrared data source. Valid values are:
  • SYSCTL_INFRAREDDATASOURCE_CONFIG - infrared data from hardware peripherals upon device configuration
  • SYSCTL_INFRAREDDATASOURCE_IRDATA - infrared data from IRDATA bit
modeis the value setting infrared mode. Valid values are:
  • SYSCTL_INFRAREDMODE_ASK - infrared ASK mode
  • SYSCTL_INFRAREDMODE_FSK - infrared FSK mode
polarityis the value setting infrared polarity. Valid values are:
  • SYSCTL_INFRAREDPOLARITY_NORMAL - infrared normal polarity
  • SYSCTL_INFRAREDPOLARITY_INVERTED - infrared inverted polarity
Returns
None

§ SysCtl_setJTAGOutgoingMessage16Bit()

void SysCtl_setJTAGOutgoingMessage16Bit ( uint8_t  outboxSelect,
uint16_t  outgoingMessage 
)

Sets a 16 bit outgoing message in to the selected JTAG Outbox.

This function sets the outgoing message in the selected JTAG outbox. The corresponding JTAG outbox flag is cleared after this function, and set after the JTAG has read the message.

Parameters
outboxSelectis the chosen JTAG outbox that the message should be set it. Valid values are:
  • SYSCTL_JTAGOUTBOX_0 - set the contents of JTAG outbox 0
  • SYSCTL_JTAGOUTBOX_1 - set the contents of JTAG outbox 1
outgoingMessageis the message to send to the JTAG.
Modified bits are MSGHI and MSGLO of SYSJMBOx register.
Returns
None

§ SysCtl_setJTAGOutgoingMessage32Bit()

void SysCtl_setJTAGOutgoingMessage32Bit ( uint32_t  outgoingMessage)

Sets a 32 bit message in to both JTAG Outboxes.

This function sets the 32-bit outgoing message in both JTAG outboxes. The JTAG outbox flags are cleared after this function, and set after the JTAG has read the message.

Parameters
outgoingMessageis the message to send to the JTAG.
Modified bits are MSGHI and MSGLO of SYSJMBOx register.
Returns
None

§ SysCtl_setRAMAssignedToBSL()

void SysCtl_setRAMAssignedToBSL ( uint8_t  BSLRAMAssignment)

Sets RAM assignment to BSL area.

This function allows RAM to be assigned to BSL, based on the selection of the BSLRAMAssignment parameter.

Parameters
BSLRAMAssignmentis the selection of if the BSL should be placed in RAM or not. Valid values are:
  • SYSCTL_BSLRAMASSIGN_NORAM [Default]
  • SYSCTL_BSLRAMASSIGN_LOWEST16BYTES
    Modified bits are SYSBSLR of SYSBSLC register.
Returns
None

Copyright 2020, Texas Instruments Incorporated