metaonly module ti.sdo.fc.global.Settings
index URL

Global configuration settings for all Framework Components packages

This module provides high-level configuration settings for all Framework Components packages. [ more ... ]
XDCscript usage meta-domain sourced in ti/sdo/fc/global/Settings.xdc
var Settings = xdc.useModule('ti.sdo.fc.global.Settings');
module-wide config parameters
    Settings.enableLogFC// Globally enable or disable logging in Framework components = Bool undefined;
    Settings.multiProcess// Add multi-process support for Framework Components libraries = Bool true;
    Settings.osalPackage// Name of the package supplying osal libraries = String undefined;
    Settings.profile// Name the library profile to use at link time = String "release";
    Settings.useDNUM// Use DNUM to convert internal memory addresses to core-specific addresses, that peripherals such as the EDMA3 can understand. This is automatically done for devices such as 6472, 6474, 6486, 6488 Should be explicitly set for others, others FC will return un-modified internal memory addresses = Bool undefined;
    Settings.useL3MemoryMap//  = Bool undefined;
 
DETAILS
This module provides high-level configuration settings for all Framework Components packages.
LINKING WITH FRAMEWORK COMPONENTS LIBRARIES
When linking an executable, this module's profile config param is used to select which libraries are used. See the profile config param below. There are three typical use-cases.
1. Link with Framework Components libraries of a specific profile. Add the following to your application cfg script.
  // set all framework component libraries to the given profile
  xdc.useModule('ti.sdo.fc.global.Settings').profile = "debug";
2. Link with Framework Component libraries using the program's profile. Add the following to your application cfg script.
  // use the program's profile
  var Program = xdc.useModule('xdc.cfg.Program');
  xdc.useModule('ti.sdo.fc.global.Settings').profile = Program.build.profile;
3. Specify a profile on a per-package basis.
  // specify the profile for some select packages
  xdc.loadPackage('ti.sdo.fc').profile = "debug";
  xdc.loadPackage('ti.sdo.fc.rman').profile = "debug";
  xdc.loadPackage('ti.sdo.fc.dman3').profile = "debug";
  xdc.loadPackage('ti.sdo.fc.edma3').profile = "debug";
Note that the third method above does not actually use the profile config param. It sets the package's profile config param directly.
The default value for the profile config param is release. Thus, even when building your executable using a debug profile, the Framework Component release libraries will be used. This helps to keep the executable size smaller when you want to debug the application code.
 
config Settings.enableLogFC  // module-wide
index URL

Globally enable or disable logging in Framework components

XDCscript usage meta-domain
Settings.enableLogFC = Bool undefined;
 
DETAILS
If enableLogFC is set to false, any Diags masks of a Framework Components module that have not been set in the application's configuration file, will be set to Diags.ALWAYS_OFF. However, the if the module's 'enableLog' configuration parameter has been set, it will override this.
If enableLogFC has been set to true, or has not been set at all, the default value for unset FC Diags masks will be RUNTIME_OFF.
SA
xdc.runtime.Diags xdc.runtime.Log
 
config Settings.multiProcess  // module-wide
index URL

Add multi-process support for Framework Components libraries

XDCscript usage meta-domain
Settings.multiProcess = Bool true;
 
DETAILS
This flag indicates whether an OSAL's multi-process support should be linked in.
 
config Settings.osalPackage  // module-wide
index URL

Name of the package supplying osal libraries

XDCscript usage meta-domain
Settings.osalPackage = String undefined;
 
DETAILS
Some FC packages (such as ti.sdo.fc.rman and ti.sdo.fc.ires.* on Linux) need implementation of some OSAL APIs (LockMP_acquire/release/create/delete and Sem_create/delete/pend/post).
Assign this to a package name that implements these signatures of the Lock functions are available at ti/sdo/fc/utils/lock.h
 
config Settings.profile  // module-wide
index URL

Name the library profile to use at link time

XDCscript usage meta-domain
Settings.profile = String "release";
 
DETAILS
If the Framework Component libraries have been built using the profile named by this config param, then these libraries will be used when linking the final executable. Otherwise, a substitute library will be used. For example, if this config param is set to debug but there are only release libraries available, then the release library is used.
 
config Settings.useDNUM  // module-wide
index URL

Use DNUM to convert internal memory addresses to core-specific addresses, that peripherals such as the EDMA3 can understand. This is automatically done for devices such as 6472, 6474, 6486, 6488 Should be explicitly set for others, others FC will return un-modified internal memory addresses

XDCscript usage meta-domain
Settings.useDNUM = Bool undefined;
 
 
config Settings.useL3MemoryMap  // module-wide
index URL
XDCscript usage meta-domain
Settings.useL3MemoryMap = Bool undefined;
 
generated on Mon, 16 Apr 2012 07:09:40 GMT