module ti.sysbios.family.arm.ducati.Core
index URL

Core Identification Module

The Core module is used to define which core within a dual core "Ducati" subsystem an application is being built for. [ more ... ]
C synopsis target-domain sourced in ti/sysbios/family/arm/ducati/Core.xdc
#include <ti/sysbios/family/arm/ducati/Core.h>
Functions
macro UInt 
Core_getId// Reads M3 core ID (0 or 1)();
Functions common to all target modules
Core_Module_getMask// Returns the diagnostics mask for this module, Core_Module_hasMask// Test whether this module has a diagnostics mask, Core_Module_heap// The heap from which this module allocates memory, Core_Module_id// Get this module's unique id, Core_Module_setMask// Set the diagnostics mask for this module, Core_Module_startupDone// Test if this module has completed startup
Constants
extern const Error_Id 
Core_E_mismatchedIds// Error raised if Core.id does not match the contents of PID0 (at 0xE00FFFE0);
extern const UInt 
Core_id// Ducati Core ID, default is Core 0;
 
DETAILS
The Core module is used to define which core within a dual core "Ducati" subsystem an application is being built for.
At runtime, a comparison is made between the configured Core.id and the value of PID0 (at address 0xe00fffe0). If they do not agree, an Error is raised.
Use of this module has the side effect of configuring default interrupt vector table placements for Core 0 and Core 1 if they haven't already been specified by the Hwi.vectorTableAddress config parameter.
Core 0's default vector table placement is at 0x400.
Core 1's default vector table placement is at 0x800.
 
config Core_E_mismatchedIds  // module-wide
index URL

Error raised if Core.id does not match the contents of PID0 (at 0xE00FFFE0)

C synopsis target-domain
extern const Error_Id Core_E_mismatchedIds;
 
 
config Core_id  // module-wide
index URL

Ducati Core ID, default is Core 0

C synopsis target-domain
extern const UInt Core_id;
 
DETAILS
Used for making static decisions based on Core ID
 
Core_getId()  // module-wide
index URL

Reads M3 core ID (0 or 1)

C synopsis target-domain
macro UInt Core_getId();
 
RETURNS
core ID
DETAILS
Used for making dynamic decisions based on Core ID
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId Core_Module_id();
// Get this module's unique id
 
Bool Core_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle Core_Module_heap();
// The heap from which this module allocates memory
 
Bool Core_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 Core_Module_getMask();
// Returns the diagnostics mask for this module
 
Void Core_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in ti/sysbios/family/arm/ducati/Core.xdc
var Core = xdc.useModule('ti.sysbios.family.arm.ducati.Core');
module-wide config parameters
    Core.E_mismatchedIds// Error raised if Core.id does not match the contents of PID0 (at 0xE00FFFE0) = Error.Desc {
        msg: "E_mismatchedIds: Core_Id: %d does not match hardware core Id: %d"
    };
    Core.id// Ducati Core ID, default is Core 0 = UInt 0;
 
    Core.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
config Core.E_mismatchedIds  // module-wide
index URL

Error raised if Core.id does not match the contents of PID0 (at 0xE00FFFE0)

XDCscript usage meta-domain
Core.E_mismatchedIds = Error.Desc {
    msg: "E_mismatchedIds: Core_Id: %d does not match hardware core Id: %d"
};
 
C SYNOPSIS
Core_E_mismatchedIds
 
config Core.id  // module-wide
index URL

Ducati Core ID, default is Core 0

XDCscript usage meta-domain
Core.id = UInt 0;
 
DETAILS
Used for making static decisions based on Core ID
C SYNOPSIS
Core_id
 
metaonly config Core.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
Core.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:48 GMT