module ti.sysbios.family.windows.TaskSupport
index URL

Windows Task Support Module

C synopsis target-domain sourced in ti/sysbios/family/windows/TaskSupport.xdc
#include <ti/sysbios/family/windows/TaskSupport.h>
Functions common to all target modules
TaskSupport_Module_getMask// Returns the diagnostics mask for this module, TaskSupport_Module_hasMask// Test whether this module has a diagnostics mask, TaskSupport_Module_heap// The heap from which this module allocates memory, TaskSupport_Module_id// Get this module's unique id, TaskSupport_Module_setMask// Set the diagnostics mask for this module, TaskSupport_Module_startupDone// Test if this module has completed startup
Typedefs
typedef Void 
(*TaskSupport_GlueFxn// Prototype of task enter and exit functions)();
typedef Void 
(*TaskSupport_IsrFxn// Isr function type definition)(UInt);
typedef struct
TaskSupport_Task// Emulation task object TaskSupport_Task;
typedef Void 
(*TaskSupport_TaskFxn// Task function type definition)(UArg,UArg);
Constants
extern const SizeT 
TaskSupport_defaultStackSize// Default task stack size;
extern const Error_Id 
TaskSupport_E_calloc// Error: memory allocation request failed;
extern const Error_Id 
TaskSupport_E_event// Error: CreateEvent failed;
extern const Error_Id 
TaskSupport_E_taskState// Error: invalid incoming task state;
extern const Error_Id 
TaskSupport_E_thread// Error: CreateThread failed;
extern const Error_Id 
TaskSupport_E_wait// Error: WaitForSingleObject failed;
extern const UInt 
TaskSupport_stackAlignment// Required stack alignment (in MAUs);
 
 
typedef TaskSupport_GlueFxn
index URL

Prototype of task enter and exit functions

C synopsis target-domain
typedef Void (*TaskSupport_GlueFxn)();
 
 
typedef TaskSupport_IsrFxn
index URL

Isr function type definition

C synopsis target-domain
typedef Void (*TaskSupport_IsrFxn)(UInt);
 
 
typedef TaskSupport_TaskFxn
index URL

Task function type definition

C synopsis target-domain
typedef Void (*TaskSupport_TaskFxn)(UArg,UArg);
 
 
struct TaskSupport_Task
index URL

Emulation task object

C synopsis target-domain
typedef struct TaskSupport_Task TaskSupport_Task;
 
 
config TaskSupport_defaultStackSize  // module-wide
index URL

Default task stack size

C synopsis target-domain
extern const SizeT TaskSupport_defaultStackSize;
 
 
config TaskSupport_stackAlignment  // module-wide
index URL

Required stack alignment (in MAUs)

C synopsis target-domain
extern const UInt TaskSupport_stackAlignment;
 
 
config TaskSupport_E_calloc  // module-wide
index URL

Error: memory allocation request failed

C synopsis target-domain
extern const Error_Id TaskSupport_E_calloc;
 
DETAILS
A request into the Windows runtime library for memory has failed.
RAISED_IN
start
startup
 
config TaskSupport_E_event  // module-wide
index URL

Error: CreateEvent failed

C synopsis target-domain
extern const Error_Id TaskSupport_E_event;
 
DETAILS
A CreateEvent call into the Win32 API has failed.
RAISED_IN
start
startup
 
config TaskSupport_E_taskState  // module-wide
index URL

Error: invalid incoming task state

C synopsis target-domain
extern const Error_Id TaskSupport_E_taskState;
 
DETAILS
A task swap was attempted where the incoming task is in an invalid state.
RAISED_IN
swap
 
config TaskSupport_E_thread  // module-wide
index URL

Error: CreateThread failed

C synopsis target-domain
extern const Error_Id TaskSupport_E_thread;
 
DETAILS
A CreateThread call into the Win32 API has failed.
RAISED_IN
processInterrupt
start
 
config TaskSupport_E_wait  // module-wide
index URL

Error: WaitForSingleObject failed

C synopsis target-domain
extern const Error_Id TaskSupport_E_wait;
 
DETAILS
A WaitForSingleObject call into the Win32 API has failed.
RAISED_IN
processInterrupt
start
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId TaskSupport_Module_id();
// Get this module's unique id
 
Bool TaskSupport_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle TaskSupport_Module_heap();
// The heap from which this module allocates memory
 
Bool TaskSupport_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 TaskSupport_Module_getMask();
// Returns the diagnostics mask for this module
 
Void TaskSupport_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/sysbios/family/windows/TaskSupport.xdc
var TaskSupport = xdc.useModule('ti.sysbios.family.windows.TaskSupport');
module-wide config parameters
    const TaskSupport.defaultStackSize// Default task stack size = SizeT 128;
    const TaskSupport.stackAlignment// Required stack alignment (in MAUs) = UInt 0;
 
    TaskSupport.E_calloc// Error: memory allocation request failed = Error.Desc {
        msg: "calloc failed"
    };
    TaskSupport.E_event// Error: CreateEvent failed = Error.Desc {
        msg: "CreateEvent failed"
    };
    TaskSupport.E_taskState// Error: invalid incoming task state = Error.Desc {
        msg: "invalid incoming task state"
    };
    TaskSupport.E_thread// Error: CreateThread failed = Error.Desc {
        msg: "CreateThread failed"
    };
    TaskSupport.E_wait// Error: WaitForSingleObject failed = Error.Desc {
        msg: "WaitForSingleObject failed"
    };
 
    TaskSupport.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
config TaskSupport.defaultStackSize  // module-wide
index URL

Default task stack size

XDCscript usage meta-domain
const TaskSupport.defaultStackSize = SizeT 128;
 
C SYNOPSIS
TaskSupport_defaultStackSize
 
config TaskSupport.stackAlignment  // module-wide
index URL

Required stack alignment (in MAUs)

XDCscript usage meta-domain
const TaskSupport.stackAlignment = UInt 0;
 
C SYNOPSIS
TaskSupport_stackAlignment
 
config TaskSupport.E_calloc  // module-wide
index URL

Error: memory allocation request failed

XDCscript usage meta-domain
TaskSupport.E_calloc = Error.Desc {
    msg: "calloc failed"
};
 
DETAILS
A request into the Windows runtime library for memory has failed.
RAISED_IN
start
startup
C SYNOPSIS
TaskSupport_E_calloc
 
config TaskSupport.E_event  // module-wide
index URL

Error: CreateEvent failed

XDCscript usage meta-domain
TaskSupport.E_event = Error.Desc {
    msg: "CreateEvent failed"
};
 
DETAILS
A CreateEvent call into the Win32 API has failed.
RAISED_IN
start
startup
C SYNOPSIS
TaskSupport_E_event
 
config TaskSupport.E_taskState  // module-wide
index URL

Error: invalid incoming task state

XDCscript usage meta-domain
TaskSupport.E_taskState = Error.Desc {
    msg: "invalid incoming task state"
};
 
DETAILS
A task swap was attempted where the incoming task is in an invalid state.
RAISED_IN
swap
C SYNOPSIS
TaskSupport_E_taskState
 
config TaskSupport.E_thread  // module-wide
index URL

Error: CreateThread failed

XDCscript usage meta-domain
TaskSupport.E_thread = Error.Desc {
    msg: "CreateThread failed"
};
 
DETAILS
A CreateThread call into the Win32 API has failed.
RAISED_IN
processInterrupt
start
C SYNOPSIS
TaskSupport_E_thread
 
config TaskSupport.E_wait  // module-wide
index URL

Error: WaitForSingleObject failed

XDCscript usage meta-domain
TaskSupport.E_wait = Error.Desc {
    msg: "WaitForSingleObject failed"
};
 
DETAILS
A WaitForSingleObject call into the Win32 API has failed.
RAISED_IN
processInterrupt
start
C SYNOPSIS
TaskSupport_E_wait
 
metaonly config TaskSupport.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
TaskSupport.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, 01 Mar 2012 16:57:53 GMT