metaonly module ti.sdo.fc.global.Settings

Global configuration settings for all Framework Components packages

This module provides high-level configuration settings for all Framework Components packages. [ more ... ]
XDCspec summary sourced in ti/sdo/fc/global/Settings.xdc
metaonly module Settings {  ...
XDCscript usage meta-domain
XDCspec declarations sourced in ti/sdo/fc/global/Settings.xdc
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.multiProcess  // module-wide
XDCscript usage meta-domain
Settings.multiProcess = Bool true;
 
 
config Settings.osalPackage  // module-wide

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). Point to a package that implements these Signatures of the Lock functions are available at ti/sdo/fc/utils/lock.h

XDCscript usage meta-domain
Settings.osalPackage = String undefined;
 
 
config Settings.profile  // module-wide

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.
generated on Mon, 20 Sep 2010 23:50:04 GMT