Nut/OS  5.0.5
API Reference
ITM Functions

Functions that access the ITM debug interface. More...

Collaboration diagram for ITM Functions:

Defines

#define ITM_RXBUFFER_EMPTY   0x5AA55AA5
#define ITM_RXBUFFER_EMPTY   0x5AA55AA5

Functions

__STATIC_INLINE uint32_t ITM_SendChar (uint32_t ch)
 ITM Send Character.
__STATIC_INLINE int32_t ITM_ReceiveChar (void)
 ITM Receive Character.
__STATIC_INLINE int32_t ITM_CheckChar (void)
 ITM Check Character.

Variables

volatile int32_t ITM_RxBuffer
volatile int32_t ITM_RxBuffer

Detailed Description

Functions that access the ITM debug interface.


Define Documentation

#define ITM_RXBUFFER_EMPTY   0x5AA55AA5

Value identifying ITM_RxBuffer is ready for next character.

Referenced by ITM_CheckChar(), and ITM_ReceiveChar().

#define ITM_RXBUFFER_EMPTY   0x5AA55AA5

Value identifying ITM_RxBuffer is ready for next character.


Function Documentation

__STATIC_INLINE uint32_t ITM_SendChar ( uint32_t  ch)

ITM Send Character.

The function transmits a character via the ITM channel 0, and

  • Just returns when no debugger is connected that has booked the output.
  • Is blocking when a debugger is connected, but the previous character sent has not been transmitted.
Parameters:
[in]chCharacter to transmit.
Returns:
Character to transmit.

References ITM, and ITM_TCR_ITMENA_Msk.

__STATIC_INLINE int32_t ITM_ReceiveChar ( void  )

ITM Receive Character.

The function inputs a character via the external variable ITM_RxBuffer.

Returns:
Received character.
-1 No character pending.

References ITM_RxBuffer, and ITM_RXBUFFER_EMPTY.

__STATIC_INLINE int32_t ITM_CheckChar ( void  )

ITM Check Character.

The function checks whether a character is pending for reading in the variable ITM_RxBuffer.

Returns:
0 No character available.
1 Character available.

References ITM_RXBUFFER_EMPTY.


Variable Documentation

External variable to receive characters.

Referenced by ITM_ReceiveChar().

External variable to receive characters.