module ti.sysbios.family.shared.keystone3.SysUart

Implementation of xdc.runtime.ISystemSupport using ANSI C Standard Library

C synopsis
Individual elements
Configuration settings
Individual elements

This implementation provides a fully functional implementation of all methods specified by ISystemSupport. As with all ISystemSupport modules, this module is the back-end for the xdc.runtime.System module. [ more ... ]

C synopsis target-domain sourced in ti/sysbios/family/shared/keystone3/SysUart.xdc

#include <ti/sysbios/family/shared/keystone3/SysUart.h>

Functions common to all ISystemSupport modules
Void	SysUart_abort// Backend for `xdc.runtime.System.abort()`(CString str);
Void	SysUart_exit// Backend for `xdc.runtime.System.exit()`(Int stat);
Void	SysUart_flush// Backend for `xdc.runtime.System.flush()`();
Void	SysUart_putch// Backend for `xdc.runtime.System.printf()` and `xdc.runtime.System.putch()`(Char ch);
Bool	SysUart_ready// Test if character output can proceed();
Functions common to all target modules
	SysUart_Module_getMask// Returns the diagnostics mask for this module, SysUart_Module_hasMask// Test whether this module has a diagnostics mask, SysUart_Module_heap// The heap from which this module allocates memory, SysUart_Module_id// Get this module's unique id, SysUart_Module_setMask// Set the diagnostics mask for this module, SysUart_Module_startupDone// Test if this module has completed startup
Typedefs
typedef enum	SysUart_Uart// UART peripheral base address ...
Constants
extern const Ptr	SysUart_uartBaseAddr// ;

DETAILS

This implementation relies on the target's runtime support libraries (i.e. fflush() and putchar()). Therefore the functions are re-entrant (thread-safe) if the underlying rts library is re-entrant.

enum SysUart_Uart

index URL

UART peripheral base address

C synopsis target-domain

typedef enum SysUart_Uart {

SysUart_Uart0,

// UART0 Base Address

SysUart_Uart1,

// UART1 Base Address

SysUart_Uart2,

// UART2 Base Address

SysUart_Uart3,

// UART3 Base Address

SysUart_Uart4

// UART4 Base Address

} SysUart_Uart;

DETAILS

These enumerations are the base addresses of the different UART peripherals.

config SysUart_uartBaseAddr // module-wide

index URL

C synopsis target-domain

extern const Ptr SysUart_uartBaseAddr;

SysUart_abort() // module-wide

index URL

Backend for xdc.runtime.System.abort()

C synopsis target-domain

Void SysUart_abort(CString str);

ARGUMENTS

str — message to output just prior to aborting

If non-NULL, this string should be output just prior to terminating.

DETAILS

This function is called by System.abort() prior to calling the ANSI C Standard library function abort(). So, to ensure the abort processing of the system's ANSI C Standard library completes, this function should return to its caller.

This abort function writes the string via putchar() and flushes via fflush() to stdout.

SEE

xdc.runtime.ISystemSupport.abort

SysUart_exit() // module-wide

index URL

Backend for xdc.runtime.System.exit()

C synopsis target-domain

Void SysUart_exit(Int stat);

ARGUMENTS

stat — status value passed to all "atexit" handlers

This value is passed to all "atexit" handles bound via System.atexit().

DETAILS

This function is called as part the normal "atexit" processing performed by the ANSI C Standard Library's exit() function; System.exit() directly calls ANSI exit().

This function is called after all "atexit" handlers bound via System.atexit() are run and it is always called while "inside" the the System gate.

To ensure that all exit processing of the system's ANSI C Standard Library completes, this function should return to its caller. Exit handlers bound using the ANSI C Standard Library atexit() function may run before or after this function.

This exit function flushes via fflush() to stdout.

SEE

System.atexit, xdc.runtime.ISystemSupport.exit

SysUart_flush() // module-wide

index URL

Backend for xdc.runtime.System.flush()

C synopsis target-domain

Void SysUart_flush();

DETAILS

This function is simply called by System_flush to output any characters buffered by the underlying SystemSupport module to an output device.

This flush function flushes via fflush() to stdout.

SEE

xdc.runtime.ISystemSupport.flush

SysUart_putch() // module-wide

index URL

Backend for xdc.runtime.System.printf() and xdc.runtime.System.putch()

C synopsis target-domain

Void SysUart_putch(Char ch);

ARGUMENTS

ch — character to output

DETAILS

Output a single character. This function is called by System_printf() to write each character of formated output specified by its arguments.

This function outputs the character via putchar().

SEE

xdc.runtime.ISystemSupport.putch

SysUart_ready() // module-wide

index URL

Test if character output can proceed

C synopsis target-domain

Bool SysUart_ready();

DETAILS

This function is called by System prior to performing any character output. If this function returns FALSE, the System functions that would normally call putch() simply return (with an appropriate error status) without ever calling putch.

This always returns TRUE.

SEE

xdc.runtime.ISystemSupport.ready

Module-Wide Built-Ins

index URL

C synopsis target-domain

Types_ModuleId SysUart_Module_id();

// Get this module's unique id

Bool SysUart_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle SysUart_Module_heap();

// The heap from which this module allocates memory

Bool SysUart_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 SysUart_Module_getMask();

// Returns the diagnostics mask for this module

Void SysUart_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

Configuration settings sourced in ti/sysbios/family/shared/keystone3/SysUart.xdc

var SysUart = xdc.useModule('ti.sysbios.family.shared.keystone3.SysUart');

module-wide constants & types

values of type SysUart.Uart// UART peripheral base address

const SysUart.Uart0// UART0 Base Address;

const SysUart.Uart1// UART1 Base Address;

const SysUart.Uart2// UART2 Base Address;

const SysUart.Uart3// UART3 Base Address;

const SysUart.Uart4// UART4 Base Address;

module-wide config parameters

SysUart.uartBaseAddr// = Ptr undefined;

SysUart.common$// Common module configuration parameters = Types.Common$ undefined;

enum SysUart.Uart

index URL

UART peripheral base address

Configuration settings

values of type SysUart.Uart

const SysUart.Uart0;

// UART0 Base Address

const SysUart.Uart1;

// UART1 Base Address

const SysUart.Uart2;

// UART2 Base Address

const SysUart.Uart3;

// UART3 Base Address

const SysUart.Uart4;

// UART4 Base Address

DETAILS

These enumerations are the base addresses of the different UART peripherals.

C SYNOPSIS

SysUart_Uart

config SysUart.uartBaseAddr // module-wide

index URL

Configuration settings

SysUart.uartBaseAddr = Ptr undefined;

C SYNOPSIS

SysUart_uartBaseAddr

metaonly config SysUart.common$ // module-wide

index URL

Common module configuration parameters

Configuration settings

SysUart.common$ = Types.Common$ undefined;

DETAILS

All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.

generated on Thu, 23 May 2019 00:22:28 GMT