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_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...

Detailed Description

Function Documentation

void SysCtl_clearJTAGMailboxFlagStatus ( uint8_t mailboxFlagMask )

Clears the status of the selected JTAG Mailbox flags.

This function clears the selected JTAG Mailbox flags.

Parameters

mailboxFlagMask

is 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

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

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

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

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

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

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

inboxSelect

is 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.

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.

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

mailboxFlagMask

is 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.

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

mailboxSizeSelect

is 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.

autoClearInboxFlagSelect

decides 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

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

outboxSelect	is 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
outgoingMessage	is the message to send to the JTAG. Modified bits are MSGHI and MSGLO of SYSJMBOx register.

Returns: None

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

outgoingMessage is the message to send to the JTAG.
Modified bits are MSGHI and MSGLO of SYSJMBOx register.

Returns: None

Functions

Detailed Description

Function Documentation