module ti.sysbios.knl.Idle
index URL

Idle Thread Manager

The Idle module is used to specify the list of functions to be called when no other tasks are running in the system. [ more ... ]
XDCspec summary sourced in ti/sysbios/knl/Idle.xdc
module Idle {  ...
// inherits xdc.runtime.IModule
C synopsis target-domain
#include <ti/sysbios/knl/Idle.h>
module-wide constants & types
    typedef Void (*Idle_FuncPtr// Idle function type definition)();
module-wide config parameters
    extern const Idle_FuncPtr Idle_funcList// The array of functions to be called when no other Tasks are running[length];
module-wide built-ins
    Types_ModuleId Idle_Module_id// Get this module's unique id( );
    Bool Idle_Module_startupDone// Test if this module has completed startup( );
    IHeap_Handle Idle_Module_heap// The heap from which this module allocates memory( );
    Bool Idle_Module_hasMask// Test whether this module has a diagnostics mask( );
    Bits16 Idle_Module_getMask// Returns the diagnostics mask for this module( );
    Void Idle_Module_setMask// Set the diagnostics mask for this module( Bits16 mask );
 
XDCscript usage meta-domain
var Idle = xdc.useModule('ti.sysbios.knl.Idle');
module-wide constants & types
    var obj = new Idle.ModuleView// ;
        obj.IdleFunctions = String[]  ...
module-wide config parameters
    Idle.funcList// The array of functions to be called when no other Tasks are running = Idle.FuncPtr[length] [ ];
 
    Idle.common$// Common module configuration parameters = Types.Common$ undefined;
module-wide functions
    Idle.addFunc// Statically add a function to the Idle function list( Void(*)() func ) returns Void
 
XDCspec declarations sourced in ti/sysbios/knl/Idle.xdc
package ti.sysbios.knl;
 
module Idle {
module-wide constants & types
    typedef Void (*FuncPtr// Idle function type definition)();
 
    metaonly struct ModuleView//  {
        String IdleFunctions[];
    };
module-wide config parameters
    config Idle.FuncPtr funcList// The array of functions to be called when no other Tasks are running[length] = [ ];
 
    metaonly config Types.Common$ common$// Common module configuration parameters;
module-wide functions
    metaonly Void addFunc// Statically add a function to the Idle function list( Idle.FuncPtr func );
}
DETAILS
The Idle module is used to specify the list of functions to be called when no other tasks are running in the system.
If tasking is enabled, then the Task module will create an "Idle task" with the lowest possible priority. When no other tasks are running, this idle task runs in an infinite loop, calling the list of functions specified by the Idle module.
If tasking is disabled, then the idle functions are called in an infinite loop after main and any Module startup functions.
The list of idle functions is only statically configurable; it cannot be modified at runtime.
 
typedef Idle.FuncPtr
index URL

Idle function type definition

C synopsis target-domain
typedef Void (*Idle_FuncPtr)();
 
 
metaonly struct Idle.ModuleView
index URL
XDCscript usage meta-domain
var obj = new Idle.ModuleView;
 
    obj.IdleFunctions = String[]  ...
 
 
config Idle.funcList  // module-wide
index URL

The array of functions to be called when no other Tasks are running

XDCscript usage meta-domain
Idle.funcList = Idle.FuncPtr[length] [ ];
C synopsis target-domain
extern const Idle_FuncPtr Idle_funcList[length];
 
 
metaonly config Idle.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
Idle.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 Idle.addFunc( )  // module-wide
index URL

Statically add a function to the Idle function list

XDCscript usage meta-domain
Idle.addFunc( Void(*)() func ) returns Void
 
 
module-wide built-ins
index URL

C synopsis target-domain
Types_ModuleId Idle_Module_id( );
// Get this module's unique id
 
Bool Idle_Module_startupDone( );
// Test if this module has completed startup
 
IHeap_Handle Idle_Module_heap( );
// The heap from which this module allocates memory
 
Bool Idle_Module_hasMask( );
// Test whether this module has a diagnostics mask
 
Bits16 Idle_Module_getMask( );
// Returns the diagnostics mask for this module
 
Void Idle_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
generated on Mon, 21 Dec 2009 19:43:37 GMT