Detailed Description

This module provide low-level stubs for retargetting stdio for all supported toolchains. The stubs are minimal yet sufficient implementations. Refer to chapter 12 in the reference manual for newlib 1.17.0 for details on implementing newlib stubs.

Retarget TextDisplay Module

The source code of the RETARGETTEXTDISPLAY module is implemented in kits/common/drivers/retargettextdisplay.c and retargettextdisplay.h .

Introduction

The RETARGETTEXTDISPLAY Library implements a stdout interface to a textdisplay device ( TextDisplay Library ) in order for the user to print text by calling standard C language functions that prints text to stdout.

Retarget TextDisplay Configuration.

This section contains a description of the configuration parameters of the RETARGETTEXTDISPLAY Library.

#define RETARGETTEXTDISPLAY_SCROLL_MODE
       Set to 'true' to enable scroll mode on the text display device where
       stdout is retargeted. Set to 'false' to disable scroll mode.
#define RETARGETTEXTDISPLAY_LINE_FEED_MODE
       Set to 'true' to enable adding Carriage Return (CR) to Line Feed (LF)
       characters on the text display device where stdout is retargeted.
       Set to 'false' to disable line feed mode.
#define RETARGETTEXTDISPLAY_DISPLAY_NO
       Select which TEXTDISPLAY device number to retarget stdout to. Normally
       there is only one display device present in the system therefore this
       parameter should be zero. However if there are more than one display
       device the user may want to select a different display device.

Macros
#define	RXBUFSIZE 8

#define	setupSWOForPrint RETARGET_SwoInit

Functions
int	_close (int file)
	Close a file.

void	_exit (int status)
	Exit the program.

int	_fstat (int file, struct stat *st)
	Status of an open file.

int	_getpid (void)
	Get process ID.

int	_isatty (int file)
	Query whether output stream is a terminal.

int	_kill (int pid, int sig)
	Send signal to process.

int	_lseek (int file, int ptr, int dir)
	Set position in a file.

int	_read (int file, char *ptr, int len)
	Read from a file.

caddr_t	_sbrk (int incr)
	Increase heap.

int	_write (int file, const char *ptr, int len)
	Write to a file.

static void	disableRxInterrupt ()
	Disable RX interrupt.

static void	enableRxInterrupt ()
	Enable RX interrupt.

void	RETARGET_IRQ_NAME (void)
	UART/LEUART IRQ Handler.

int	RETARGET_ReadChar (void)
	Receive a byte from USART/LEUART and put into global buffer.

void	RETARGET_SerialCrLf (int on)
	UART/LEUART toggle LF to CRLF conversion.

bool	RETARGET_SerialEnableFlowControl (void)
	Enable hardware flow control. (RTS + CTS)

void	RETARGET_SerialFlush (void)
	Flush UART/LEUART.

void	RETARGET_SerialInit (void)
	Intializes UART/LEUART.

void	RETARGET_SwoInit (void)
	Setup SWO for output.

EMSTATUS	RETARGET_TextDisplayInit (void)
	Initialize/retarget a TEXTDISPLAY device to receivie stdout(put).

void	RETARGET_TftCrLf (int on)
	Toggle LF to CRLF conversion.

void	RETARGET_TftInit (void)
	Intializes TFT text display.

void	RETARGET_TFTTX (int c)
	Transmit/display a character.

void	RETARGET_TFTUpdate (bool fullFrame)
	Display framebuffer.

int	RETARGET_WriteChar (char c)
	Transmit single byte to USART/LEUART.

EMSTATUS	RETARGET_WriteString (char *str)
	Write a string of characters to the RETARGET text display device.

Variables
char	_end

static bool	initialized = false

static uint8_t	LFtoCRLF = 0

static volatile uint8_t	rxBuffer [ RXBUFSIZE ]

static volatile int	rxCount = 0

static volatile int	rxReadIndex = 0

static volatile int	rxWriteIndex = 0

Macro Definition Documentation

#define RXBUFSIZE 8

Buffer size for RX

Definition at line 44 of file retargetserial.c .

Referenced by RETARGET_IRQ_NAME() , and RETARGET_ReadChar() .

#define setupSWOForPrint RETARGET_SwoInit

Deprecated:: Use RETARGET_SwoInit instead

Definition at line 40 of file retargetswo.h .

Function Documentation

int _close ( int file )

Close a file.

Parameters

[in] file File you want to close.

Returns: Returns 0 when the file is closed.

Definition at line 60 of file retargetio.c .

void _exit ( int status )

Exit the program.

Parameters

[in] status The value to return to the parent process as the exit status (not used).

Definition at line 71 of file retargetio.c .

int _fstat	(	int	`file,`
		struct stat *	`st`
	)

Status of an open file.

Parameters

[in]	`file`	Check status for this file.
[in]	`st`	Status information.

Returns: Returns 0 when st_mode is set to character special.

Definition at line 91 of file retargetio.c .

int _isatty ( int file )

Query whether output stream is a terminal.

Parameters

[in] file Descriptor for the file.

Returns: Returns 1 when query is done.

Definition at line 116 of file retargetio.c .

int _kill	(	int	`pid,`
		int	`sig`
	)

Send signal to process.

Parameters

[in]	`pid`	Process id (not used).
[in]	`sig`	Signal to send (not used).

Definition at line 127 of file retargetio.c .

int _lseek	(	int	`file,`
		int	`ptr,`
		int	`dir`
	)

Set position in a file.

Parameters

[in]	`file`	Descriptor for the file.
[in]	`ptr`	Poiter to the argument offset.
[in]	`dir`	Directory whence.

Returns: Returns 0 when position is set.

Definition at line 150 of file retargetio.c .

int _read	(	int	`file,`
		char *	`ptr,`
		int	`len`
	)

Read from a file.

Parameters

[in]	`file`	Descriptor for the file you want to read from.
[in]	`ptr`	Pointer to the chacaters that are beeing read.
[in]	`len`	Number of characters to be read.

Returns: Number of characters that have been read.

Definition at line 174 of file retargetio.c .

References RETARGET_ReadChar() , and rxCount .

caddr_t _sbrk ( int incr )

Increase heap.

Parameters

[in] incr Number of bytes you want increment the program's data space.

Returns: Rsturns a pointer to the start of the new area.

Definition at line 206 of file retargetio.c .

References _end .

int _write	(	int	`file,`
		const char *	`ptr,`
		int	`len`
	)

Write to a file.

Parameters

[in]	`file`	Descriptor for the file you want to write to.
[in]	`ptr`	Pointer to the text you want to write
[in]	`len`	Number of characters to be written.

Returns: Number of characters that have been written.

Definition at line 237 of file retargetio.c .

References RETARGET_WriteChar() .

int RETARGET_ReadChar ( void )

Receive a byte from USART/LEUART and put into global buffer.

Returns: -1 on failure, or positive character integer on sucesss

Receive a byte from USART/LEUART and put into global buffer.

SWO is a one-way link, it is not possible to read data from SWO.

Receive a byte from USART/LEUART and put into global buffer.

Returns: -1 on failure

Receive a byte from USART/LEUART and put into global buffer.

Returns: -1 on failure, or positive character integer on sucesss

Definition at line 253 of file retargetserial.c .

References CORE_DECLARE_IRQ_STATE , CORE_ENTER_ATOMIC , CORE_EXIT_ATOMIC , enableRxInterrupt() , initialized , RETARGET_SerialInit() , rxBuffer , RXBUFSIZE , rxCount , and rxReadIndex .

Referenced by _read() .

void RETARGET_SerialCrLf ( int on )

UART/LEUART toggle LF to CRLF conversion.

Parameters

`on`	If non-zero, automatic LF to CRLF conversion will be enabled

Definition at line 112 of file retargetserial.c .

References LFtoCRLF .

bool RETARGET_SerialEnableFlowControl ( void )

Enable hardware flow control. (RTS + CTS)

Returns: true if hardware flow control was enabled and false otherwise.

Definition at line 305 of file retargetserial.c .

References _USART_ROUTELOC1_CTSLOC_SHIFT , _USART_ROUTELOC1_RTSLOC_SHIFT , GPIO_PinModeSet() , gpioModeInputPull , gpioModePushPull , USART_CTRLX_CTSEN , USART_ROUTEPEN_CTSPEN , and USART_ROUTEPEN_RTSPEN .

EMSTATUS RETARGET_TextDisplayInit ( void )

Initialize/retarget a TEXTDISPLAY device to receivie stdout(put).

Returns: EMSTATUS code of the operation.

Definition at line 44 of file retargettextdisplay.c .

References DISPLAY_DeviceGet() , DISPLAY_EMSTATUS_OK , TEXTDISPLAY_Config_t::displayDeviceNo , TEXTDISPLAY_Config_t::lfToCrLf , TEXTDISPLAY_Config_t::scrollEnable , TEXTDISPLAY_EMSTATUS_OK , and TEXTDISPLAY_New() .

void RETARGET_TftCrLf ( int on )

Toggle LF to CRLF conversion.

Parameters

`on`	If non-zero, automatic LF to CRLF conversion will be enabled

Definition at line 65 of file retargettft.c .

References LFtoCRLF .

void RETARGET_TFTTX ( int c )

Transmit/display a character.

Parameters

[in] c ASCII character to output

Returns: -1 on failure, or positive character integer on sucesss

Definition at line 170 of file retargettft.c .

References charBuffer , CHARS , LINES , rgbColor , tftTextScrollUp() , xpos , and ypos .

Referenced by RETARGET_WriteChar() .

void RETARGET_TFTUpdate ( bool fullFrame )

Display framebuffer.

Parameters

[in] fullFrame If true, draw entire screen, if false, draw incremental update (faster)

Definition at line 221 of file retargettft.c .

References charBuffer , CHARS , fontBits , LINES , rgbColor , xpos , and ypos .

Referenced by RETARGET_WriteChar() .

int RETARGET_WriteChar ( char c )

Transmit single byte to USART/LEUART.

Parameters

`c`	Character to transmit

Returns: Transmitted character

Transmit single byte to USART/LEUART.

This function will output a character on SWO using ITM channel 0.

Transmit single byte to USART/LEUART.

Parameters

`c`	Character to write

Returns: Printed character if text display is initialized. -1 if text display is not initialized.

Transmit single byte to USART/LEUART.

Parameters

`c`	Character to transmit

Returns: Transmitted character

Definition at line 286 of file retargetserial.c .

References BC_ARB_CTRL_EBI , BC_REGISTER , BC_UIF_AEM_EFM , BSP_RegisterRead() , bufferReset , fullUpdate , initialized , LFtoCRLF , RETARGET_SerialInit() , RETARGET_TFTTX() , RETARGET_TFTUpdate() , TEXTDISPLAY_WriteChar() , tftReset , and tftTextReset() .

Referenced by _write() .

EMSTATUS RETARGET_WriteString ( char * str )

Write a string of characters to the RETARGET text display device.

Parameters

[in] str String to write.

Returns: EMSTATUS code of the operation.

Definition at line 108 of file retargettextdisplay.c .

References TEXTDISPLAY_EMSTATUS_NOT_INITIALIZED , and TEXTDISPLAY_WriteString() .

Variable Documentation

char _end

Defined by the linker

Referenced by _sbrk() .

bool initialized = false

static

Initialize UART/LEUART

Definition at line 51 of file retargetserial.c .

Referenced by DMADRV_AllocateChannel() , DMADRV_DeInit() , DMADRV_FreeChannel() , DMADRV_Init() , DMADRV_LdmaStartTransfer() , DMADRV_PauseTransfer() , DMADRV_ResumeTransfer() , DMADRV_StopTransfer() , DMADRV_TransferActive() , DMADRV_TransferCompletePending() , DMADRV_TransferDone() , DMADRV_TransferRemainingCount() , RETARGET_ReadChar() , RETARGET_SerialInit() , RETARGET_WriteChar() , and TEXTDISPLAY_New() .

uint8_t LFtoCRLF = 0

static

LF to CRLF conversion disabled

Definition at line 50 of file retargetserial.c .

Referenced by RETARGET_SerialCrLf() , and RETARGET_WriteChar() .

volatile uint8_t rxBuffer[ RXBUFSIZE ]

static

Buffer to store data

Definition at line 49 of file retargetserial.c .

Referenced by KSZ8851SNL_SPI_ReadRegister() , RETARGET_IRQ_NAME() , RETARGET_ReadChar() , SPIDRV_MTransferSingleItemB() , UARTDRV_Abort() , and UARTDRV_GetReceiveStatus() .

volatile int rxCount = 0

static

Keeps track of how much data which are stored in the buffer

Definition at line 48 of file retargetserial.c .

Referenced by _read() , RETARGET_IRQ_NAME() , and RETARGET_ReadChar() .

volatile int rxReadIndex = 0

static

Index in buffer to be read

Definition at line 46 of file retargetserial.c .

Referenced by RETARGET_ReadChar() .

volatile int rxWriteIndex = 0

static

Index in buffer to be written to

Definition at line 47 of file retargetserial.c .

Referenced by RETARGET_IRQ_NAME() .

RetargetIoKit Drivers

Detailed Description

Retarget TextDisplay Module

Introduction

Retarget TextDisplay Configuration.

Macros

Functions

Variables

Macro Definition Documentation

Function Documentation

Variable Documentation