module ti.mcu.msp430.runtime.utils.Stack
index URL

Stack monitoring functions

This module provides simple stack monitoring operations that enables an application efficiently monitor the system's worst-case stack usage. [ more ... ]
C synopsis target-domain sourced in ti/mcu/msp430/runtime/utils/Stack.xdc
#include <ti/mcu/msp430/runtime/utils/Stack.h>
Functions
Bool 
Stack_check// Return non-zero if stack pointer is within allocated stack();
Void 
Stack_fill// Fill unused stack with initial value();
Void 
Stack_getStatus// Get number of words of unused stack space(Stack_Status *stat);
Int 
Stack_getUnused// Get number of words of unused stack space();
Functions common to all target modules
Stack_Module_getMask// Returns the diagnostics mask for this module, Stack_Module_hasMask// Test whether this module has a diagnostics mask, Stack_Module_heap// The heap from which this module allocates memory, Stack_Module_id// Get this module's unique id, Stack_Module_setMask// Set the diagnostics mask for this module, Stack_Module_startupDone// Test if this module has completed startup
Typedefs
typedef struct
Stack_Status// Stack status information buffer ...
Constants
extern const Log_Event 
Stack_UNUSED// Unused stack space event;
 
DETAILS
This module provides simple stack monitoring operations that enables an application efficiently monitor the system's worst-case stack usage.
Stack overruns are a common problem in embedded development and they result in intermittent and difficult to reproduce failures. The ability to quickly determine of unexpected behavious is the result of a stack overrun can save hours of debug time.
 
struct Stack_Status
index URL

Stack status information buffer

C synopsis target-domain
typedef struct Stack_Status {
    Int unused;
    // number of words never used (so far)
    Int used;
    // worst-case number of words used (so far)
    Int curDepth;
    // current number of words on the stack
} Stack_Status;
 
 
config Stack_UNUSED  // module-wide
index URL

Unused stack space event

C synopsis target-domain
extern const Log_Event Stack_UNUSED;
 
 
Stack_check()  // module-wide
index URL

Return non-zero if stack pointer is within allocated stack

C synopsis target-domain
Bool Stack_check();
 
DETAILS
If this function returns 0, the current stack pointer is pointing to a location _outside_ the caller's allocated stack.
 
Stack_fill()  // module-wide
index URL

Fill unused stack with initial value

C synopsis target-domain
Void Stack_fill();
 
DETAILS
This function is called at startup and may be called at runtime to re-initialize the stack. However, interrupts must be disabled during this process (to prevent corruption of ISR state).
 
Stack_getStatus()  // module-wide
index URL

Get number of words of unused stack space

C synopsis target-domain
Void Stack_getStatus(Stack_Status *stat);
 
 
Stack_getUnused()  // module-wide
index URL

Get number of words of unused stack space

C synopsis target-domain
Int Stack_getUnused();
 
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId Stack_Module_id();
// Get this module's unique id
 
Bool Stack_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle Stack_Module_heap();
// The heap from which this module allocates memory
 
Bool Stack_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 Stack_Module_getMask();
// Returns the diagnostics mask for this module
 
Void Stack_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/mcu/msp430/runtime/utils/Stack.xdc
var Stack = xdc.useModule('ti.mcu.msp430.runtime.utils.Stack');
module-wide constants & types
    var obj = new Stack.Status// Stack status information buffer;
        obj.unused// number of words never used (so far) = Int  ...
        obj.used// worst-case number of words used (so far) = Int  ...
        obj.curDepth// current number of words on the stack = Int  ...
module-wide config parameters
    Stack.UNUSED// Unused stack space event = Log.EventDesc {
        mask: Diags.USER1,
        msg: "unused stack space = %d words"
    };
 
    Stack.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
struct Stack.Status
index URL

Stack status information buffer

XDCscript usage meta-domain
var obj = new Stack.Status;
 
    obj.unused = Int  ...
    // number of words never used (so far)
    obj.used = Int  ...
    // worst-case number of words used (so far)
    obj.curDepth = Int  ...
    // current number of words on the stack
 
C SYNOPSIS
Stack_Status
 
config Stack.UNUSED  // module-wide
index URL

Unused stack space event

XDCscript usage meta-domain
Stack.UNUSED = Log.EventDesc {
    mask: Diags.USER1,
    msg: "unused stack space = %d words"
};
 
C SYNOPSIS
Stack_UNUSED
 
metaonly config Stack.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
Stack.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:30 GMT