module xdc.runtime.SysStd

Implementation of ISystemSupport using ANSI C Standard Library

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 System module. [ more ... ]
C synopsis target-domain sourced in xdc/runtime/SysStd.xdc
DETAILS
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 System module.
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.
 
SysStd_abort()  // module-wide

Backend for System.abort()

C synopsis target-domain
Void SysStd_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
 
SysStd_exit()  // module-wide

Backend for System.exit()

C synopsis target-domain
Void SysStd_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
 
SysStd_flush()  // module-wide

Backend for System.flush()

C synopsis target-domain
Void SysStd_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
 
SysStd_putch()  // module-wide

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

C synopsis target-domain
Void SysStd_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
 
SysStd_ready()  // module-wide

Test if character output can proceed

C synopsis target-domain
Bool SysStd_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
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId SysStd_Module_id();
// Get this module's unique id
 
Bool SysStd_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle SysStd_Module_heap();
// The heap from which this module allocates memory
 
Bool SysStd_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 SysStd_Module_getMask();
// Returns the diagnostics mask for this module
 
Void SysStd_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
Configuration settings sourced in xdc/runtime/SysStd.xdc
var SysStd = xdc.useModule('xdc.runtime.SysStd');
module-wide config parameters
 
 
metaonly config SysStd.common$  // module-wide

Common module configuration parameters

Configuration settings
SysStd.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 Tue, 14 Feb 2017 20:01:29 GMT