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

ISystemSupport provider that "calls back" to application defined functions

This module provides an implementation of the ISystemSupport interface that simply calls back to user defined functions to enable the System module's functionality.
C synopsis target-domain sourced in ti/mcu/msp430/runtime/SysCallback.xdc
#include <ti/mcu/msp430/runtime/SysCallback.h>
Functions common to all ISystemSupport modules
Void 
SysCallback_abort// Backend for System.abort()(String str);
Void 
SysCallback_exit// Backend for System.exit()(Int stat);
Void 
SysCallback_flush// Backend for System.flush()();
Void 
SysCallback_putch// Backend for System.printf() and System.putch()(Char ch);
Bool 
SysCallback_ready// Test if character output can proceed();
Functions common to all target modules
SysCallback_Module_getMask// Returns the diagnostics mask for this module, SysCallback_Module_hasMask// Test whether this module has a diagnostics mask, SysCallback_Module_heap// The heap from which this module allocates memory, SysCallback_Module_id// Get this module's unique id, SysCallback_Module_setMask// Set the diagnostics mask for this module, SysCallback_Module_startupDone// Test if this module has completed startup
Typedefs
typedef Void 
(*SysCallback_AbortFxn// Abort function signature)(Void);
typedef Int 
(*SysCallback_AtExitFxn// Function called as part of normal application exit)(Void(*)(Void));
typedef Void 
(*SysCallback_ExitFxn// Exit function signature)(Int);
typedef Void 
(*SysCallback_InitFxn// Init function signature)(Void);
typedef Void 
(*SysCallback_PutCharFxn// Putchar function signature)(Char);
Constants
extern const SysCallback_AbortFxn 
SysCallback_abortFxn// User supplied abort function;
extern const SysCallback_AtExitFxn 
SysCallback_atExitFxn// User supplied atexit function to be called when atexit() is called;
extern const SysCallback_ExitFxn 
SysCallback_exitFxn// User supplied exit function;
extern const SysCallback_InitFxn 
SysCallback_initFxn// User supplied initialization function;
extern const SysCallback_PutCharFxn 
SysCallback_putCharFxn// User suplied character output function;
 
 
typedef SysCallback_AbortFxn
index URL

Abort function signature

C synopsis target-domain
typedef Void (*SysCallback_AbortFxn)(Void);
 
 
typedef SysCallback_AtExitFxn
index URL

Function called as part of normal application exit

C synopsis target-domain
typedef Int (*SysCallback_AtExitFxn)(Void(*)(Void));
 
 
typedef SysCallback_ExitFxn
index URL

Exit function signature

C synopsis target-domain
typedef Void (*SysCallback_ExitFxn)(Int);
 
 
typedef SysCallback_InitFxn
index URL

Init function signature

C synopsis target-domain
typedef Void (*SysCallback_InitFxn)(Void);
 
 
typedef SysCallback_PutCharFxn
index URL

Putchar function signature

C synopsis target-domain
typedef Void (*SysCallback_PutCharFxn)(Char);
 
 
config SysCallback_abortFxn  // module-wide
index URL

User supplied abort function

C synopsis target-domain
extern const SysCallback_AbortFxn SysCallback_abortFxn;
 
DETAILS
This function is called when abort() is called. If it returns to the caller, abort() will enter into a self loop to prevent futher execution.
If this function is set to null, abort() will enter into a self loop to prevent futher execution.
 
config SysCallback_atExitFxn  // module-wide
index URL

User supplied atexit function to be called when atexit() is called

C synopsis target-domain
extern const SysCallback_AtExitFxn SysCallback_atExitFxn;
 
DETAILS
This function is called when the application calls atexit() and its argument is passed to this function.
If this function is set to null, the function passed to atexit() is ignored and atexit() will return 0.
 
config SysCallback_exitFxn  // module-wide
index URL

User supplied exit function

C synopsis target-domain
extern const SysCallback_ExitFxn SysCallback_exitFxn;
 
DETAILS
This function is called when exit() is called. If it returns to the caller, exit() will enter into a self loop to prevent futher execution.
If this function is set to null, exit() will enter into a self loop to prevent futher execution.
 
config SysCallback_initFxn  // module-wide
index URL

User supplied initialization function

C synopsis target-domain
extern const SysCallback_InitFxn SysCallback_initFxn;
 
DETAILS
If this function is set to non-null value, it is called prior to main() during this module's startup function.
 
config SysCallback_putCharFxn  // module-wide
index URL

User suplied character output function

C synopsis target-domain
extern const SysCallback_PutCharFxn SysCallback_putCharFxn;
 
DETAILS
This function is called whenever the System module needs to output a character; e.g., during System_printf() or System_putch().
If this function is set to null, output characters are simply ignored (i.e., they are not output).
 
SysCallback_abort()  // module-wide
index URL

Backend for System.abort()

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

Backend for System.exit()

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

Backend for System.flush()

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

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

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

Test if character output can proceed

C synopsis target-domain
Bool SysCallback_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 SysCallback_Module_id();
// Get this module's unique id
 
Bool SysCallback_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle SysCallback_Module_heap();
// The heap from which this module allocates memory
 
Bool SysCallback_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 SysCallback_Module_getMask();
// Returns the diagnostics mask for this module
 
Void SysCallback_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/mcu/msp430/runtime/SysCallback.xdc
var SysCallback = xdc.useModule('ti.mcu.msp430.runtime.SysCallback');
module-wide config parameters
    SysCallback.abortFxn// User supplied abort function = Void(*)(Void) null;
    SysCallback.atExitFxn// User supplied atexit function to be called when atexit() is called = Int(*)(Void(*)(Void)) null;
    SysCallback.exitFxn// User supplied exit function = Void(*)(Int) null;
    SysCallback.initFxn// User supplied initialization function = Void(*)(Void) null;
    SysCallback.putCharFxn// User suplied character output function = Void(*)(Char) null;
 
    SysCallback.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
config SysCallback.abortFxn  // module-wide
index URL

User supplied abort function

XDCscript usage meta-domain
SysCallback.abortFxn = Void(*)(Void) null;
 
DETAILS
This function is called when abort() is called. If it returns to the caller, abort() will enter into a self loop to prevent futher execution.
If this function is set to null, abort() will enter into a self loop to prevent futher execution.
C SYNOPSIS
SysCallback_abortFxn
 
config SysCallback.atExitFxn  // module-wide
index URL

User supplied atexit function to be called when atexit() is called

XDCscript usage meta-domain
SysCallback.atExitFxn = Int(*)(Void(*)(Void)) null;
 
DETAILS
This function is called when the application calls atexit() and its argument is passed to this function.
If this function is set to null, the function passed to atexit() is ignored and atexit() will return 0.
C SYNOPSIS
SysCallback_atExitFxn
 
config SysCallback.exitFxn  // module-wide
index URL

User supplied exit function

XDCscript usage meta-domain
SysCallback.exitFxn = Void(*)(Int) null;
 
DETAILS
This function is called when exit() is called. If it returns to the caller, exit() will enter into a self loop to prevent futher execution.
If this function is set to null, exit() will enter into a self loop to prevent futher execution.
C SYNOPSIS
SysCallback_exitFxn
 
config SysCallback.initFxn  // module-wide
index URL

User supplied initialization function

XDCscript usage meta-domain
SysCallback.initFxn = Void(*)(Void) null;
 
DETAILS
If this function is set to non-null value, it is called prior to main() during this module's startup function.
C SYNOPSIS
SysCallback_initFxn
 
config SysCallback.putCharFxn  // module-wide
index URL

User suplied character output function

XDCscript usage meta-domain
SysCallback.putCharFxn = Void(*)(Char) null;
 
DETAILS
This function is called whenever the System module needs to output a character; e.g., during System_printf() or System_putch().
If this function is set to null, output characters are simply ignored (i.e., they are not output).
C SYNOPSIS
SysCallback_putCharFxn
 
metaonly config SysCallback.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
SysCallback.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, 27 Sep 2012 23:22:29 GMT