module ti.mcu.msp430.runtime.SysBuf
index URL

Minimal implementation of functions required by System

SysBuf writes all output to a circular memory buffer configured by the user. [ more ... ]
C synopsis target-domain sourced in ti/mcu/msp430/runtime/SysBuf.xdc
#include <ti/mcu/msp430/runtime/SysBuf.h>
Functions common to all ISystemSupport modules
Void 
SysBuf_abort// Backend for System.abort()(String str);
Void 
SysBuf_exit// Backend for System.exit()(Int stat);
Void 
SysBuf_flush// Backend for System.flush()();
Void 
SysBuf_putch// Backend for System.printf() and System.putch()(Char ch);
Bool 
SysBuf_ready// Test if character output can proceed();
Functions common to all target modules
SysBuf_Module_getMask// Returns the diagnostics mask for this module, SysBuf_Module_hasMask// Test whether this module has a diagnostics mask, SysBuf_Module_heap// The heap from which this module allocates memory, SysBuf_Module_id// Get this module's unique id, SysBuf_Module_setMask// Set the diagnostics mask for this module, SysBuf_Module_startupDone// Test if this module has completed startup
Constants
extern const SizeT 
SysBuf_bufSize// Size (in MAUs) of the output;
 
DETAILS
SysBuf writes all output to a circular memory buffer configured by the user.
This module provides a simple but 100% portable implementation of the ISystemSupport interface.
 
config SysBuf_bufSize  // module-wide
index URL

Size (in MAUs) of the output

C synopsis target-domain
extern const SizeT SysBuf_bufSize;
 
DETAILS
An internal buffer of this size is allocated. All output is stored in this internal buffer.
If 0 is specified for the size, no buffer is created and all output is simply dropped.
 
SysBuf_abort()  // module-wide
index URL

Backend for System.abort()

C synopsis target-domain
Void SysBuf_abort(String 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.
 
SysBuf_exit()  // module-wide
index URL

Backend for System.exit()

C synopsis target-domain
Void SysBuf_exit(Int stat);
 
ARGUMENTS
stat — status value passed to all "atexit" handlers
This value is passed to all "atexit" handles bound via System.atexit(). If the application exits via the ANSI C Standard exit() function rather than via System_exit(), stat will be equal to System.STATUS_UNKNOWN.
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.
SEE
System.atexit
 
SysBuf_flush()  // module-wide
index URL

Backend for System.flush()

C synopsis target-domain
Void SysBuf_flush();
 
DETAILS
This function is simply called by System_flush to output any characters buffered by the underlying SystemSupport module to an output device.
 
SysBuf_putch()  // module-wide
index URL

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

C synopsis target-domain
Void SysBuf_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.
 
SysBuf_ready()  // module-wide
index URL

Test if character output can proceed

C synopsis target-domain
Bool SysBuf_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.
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId SysBuf_Module_id();
// Get this module's unique id
 
Bool SysBuf_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle SysBuf_Module_heap();
// The heap from which this module allocates memory
 
Bool SysBuf_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 SysBuf_Module_getMask();
// Returns the diagnostics mask for this module
 
Void SysBuf_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/mcu/msp430/runtime/SysBuf.xdc
var SysBuf = xdc.useModule('ti.mcu.msp430.runtime.SysBuf');
module-wide config parameters
    SysBuf.bufSize// Size (in MAUs) of the output = SizeT 1024;
 
    SysBuf.bufName// Global variable name containing pointer to output buffer = String "SYSBUF";
    SysBuf.common$// Common module configuration parameters = Types.Common$ undefined;
    SysBuf.sectionName// Section where the internal buffer managed by SysBuf is placed = String null;
 
 
config SysBuf.bufSize  // module-wide
index URL

Size (in MAUs) of the output

XDCscript usage meta-domain
SysBuf.bufSize = SizeT 1024;
 
DETAILS
An internal buffer of this size is allocated. All output is stored in this internal buffer.
If 0 is specified for the size, no buffer is created and all output is simply dropped.
C SYNOPSIS
SysBuf_bufSize
 
metaonly config SysBuf.bufName  // module-wide
index URL

Global variable name containing pointer to output buffer

XDCscript usage meta-domain
SysBuf.bufName = String "SYSBUF";
 
DETAILS
This variable will be created so that it is easy to view the contents of the output buffer within a debugger. If bufName is set to null or undefined, the variable will not be created.
 
metaonly config SysBuf.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
SysBuf.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.
 
metaonly config SysBuf.sectionName  // module-wide
index URL

Section where the internal buffer managed by SysBuf is placed

XDCscript usage meta-domain
SysBuf.sectionName = String null;
 
DETAILS
The default is to have no explicit placement.
generated on Thu, 27 Sep 2012 23:22:29 GMT