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

Implementation of ISystemSupport that sends output to a UART

This module provides an implementation of the ISystemSupport interface that simply writes each character to the MSP430's UART.
C synopsis target-domain sourced in ti/mcu/msp430/runtime/SysUart.xdc
#include <ti/mcu/msp430/runtime/SysUart.h>
Functions common to all ISystemSupport modules
Void 
SysUart_abort// Backend for System.abort()(String str);
Void 
SysUart_exit// Backend for System.exit()(Int stat);
Void 
SysUart_flush// Backend for System.flush()();
Void 
SysUart_putch// Backend for System.printf() and 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 Void 
(*SysUart_GetLineFxn// Input a single line)(Char[],Int);
Constants
extern const SysUart_GetLineFxn 
SysUart_getLineFxn// User suplied character input function;
extern const Int 
SysUart_lineSize// The maximum line buffer size;
 
 
typedef SysUart_GetLineFxn
index URL

Input a single line

C synopsis target-domain
typedef Void (*SysUart_GetLineFxn)(Char[],Int);
 
 
config SysUart_getLineFxn  // module-wide
index URL

User suplied character input function

C synopsis target-domain
extern const SysUart_GetLineFxn SysUart_getLineFxn;
 
DETAILS
If this parameter is set to a non-null value, the specified function will be called to input a line of chars received by SysUart.
For example, if you define a function named myGetLineFxn, the following configuration fragment will cause SysUart to call myGetLineFxn whenever a line is received.
      var SysUart = xdc.useModule("xdc.runtime.SysUart");
      SysUart.getLineFxn = "&myGetLineFxn";
If this parameter is not set, a default function will be used which simply drops the input.
SEE
GetLineFxn
 
config SysUart_lineSize  // module-wide
index URL

The maximum line buffer size

C synopsis target-domain
extern const Int SysUart_lineSize;
 
DETAILS
The maximum number of characters to buffer before calling getLineFxn. If set to zero, no buffering occurs and each character received triggers getLineFxn (if it's defined).
 
SysUart_abort()  // module-wide
index URL

Backend for System.abort()

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

Backend for 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(). 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
 
SysUart_flush()  // module-wide
index URL

Backend for 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.
 
SysUart_putch()  // module-wide
index URL

Backend for System.printf() and 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.
 
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.
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
 
XDCscript usage meta-domain sourced in ti/mcu/msp430/runtime/SysUart.xdc
var SysUart = xdc.useModule('ti.mcu.msp430.runtime.SysUart');
module-wide config parameters
    SysUart.getLineFxn// User suplied character input function = Void(*)(Char[],Int) null;
    SysUart.lineSize// The maximum line buffer size = Int 0;
 
    SysUart.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
config SysUart.getLineFxn  // module-wide
index URL

User suplied character input function

XDCscript usage meta-domain
SysUart.getLineFxn = Void(*)(Char[],Int) null;
 
DETAILS
If this parameter is set to a non-null value, the specified function will be called to input a line of chars received by SysUart.
For example, if you define a function named myGetLineFxn, the following configuration fragment will cause SysUart to call myGetLineFxn whenever a line is received.
      var SysUart = xdc.useModule("xdc.runtime.SysUart");
      SysUart.getLineFxn = "&myGetLineFxn";
If this parameter is not set, a default function will be used which simply drops the input.
SEE
GetLineFxn
C SYNOPSIS
SysUart_getLineFxn
 
config SysUart.lineSize  // module-wide
index URL

The maximum line buffer size

XDCscript usage meta-domain
SysUart.lineSize = Int 0;
 
DETAILS
The maximum number of characters to buffer before calling getLineFxn. If set to zero, no buffering occurs and each character received triggers getLineFxn (if it's defined).
C SYNOPSIS
SysUart_lineSize
 
metaonly config SysUart.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
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 Fri, 14 Sep 2012 21:28:30 GMT