| metaonly module ti.sdo.ipc.Build |
 |
 |
| Configuration settings | sourced in ti/sdo/ipc/Build.xdc |
var Build = xdc.useModule('ti.sdo.ipc.Build');
module-wide constants & types
values of type Build.LibType// IPC library selection options
module-wide config parameters
module-wide functions
Build.getDefaultCustomCCOpts// () returns String
Build.getDefs// Get the compiler -D options necessary to build() returns String
| enum Build.LibType |
|
IPC library selection options
| Configuration settings |
values of type Build.LibType
const Build.LibType_Instrumented;
// Instrumented
const Build.LibType_NonInstrumented;
// Non-instrumented
const Build.LibType_Custom;
// Custom (Optimized)
const Build.LibType_Debug;
// Custom (Debug)
const Build.LibType_PkgLib;
// Use package library
VALUES
LibType_Instrumented
— The library supplied is prebuilt
with logging and assertions enabled.
LibType_NonInstrumented
— The library supplied is prebuilt
with logging and assertions disabled.
LibType_Custom
— This option builds the IPC library from
sources using the options specified by customCCOpts.
Only the modules and APIs that your application uses are
contained in the resulting executable. Program optimization is
performed to reduce the size of the executable and improve
performance. Enough debug information is retained to allow you
to step through the application code in CCS and locate global
variables.
LibType_Debug
— This option is similar to the LibType_Custom
option in that it builds the IPC library from sources and omits
modules and APIs that your code does not use. However, no program
optimization is performed. The resulting executable is fully
debuggable, and you can step into IPC code. The tradeoff is that
the executable is larger and runs slower than builds that use the
LibType_Custom option.
LibType_PkgLib
— This option uses the individual libraries
built by each package of the IPC product. These libraries are
not shipped. You must build the product to generate the package
libraries. See the IPC Install Guides (links in the Release
Note) for details on building the IPC product.
DETAILS
This enumeration defines all the IPC library types provided
by the product. You can select the library type by setting
the Build.libType configuration parameter.
SEE
| config Build.assertsEnabled // module-wide |
|
IPC assert checking in custom library enable flag
| Configuration settings |
Build.assertsEnabled = Bool true;
DETAILS
When set to true, assert checking code is compiled into
the custom library created when Build.libType
is set to Build_LibType_Custom or
Build_LibType_Debug.
When set to false, assert checking code is removed from the
custom library created when Build.libType is set to
Build.LibType_Custom or Build.LibType_Debug. This option can
considerably improve runtime performance as well significantly
reduce the application's code size.
SEE
| config Build.customCCOpts // module-wide |
|
Compiler options used when building a custom IPC library
| Configuration settings |
Build.customCCOpts = String undefined;
DETAILS
When Build.libType is set to
Build_LibType_Custom or
Build_LibType_Debug, this string contains
the options passed to the compiler during any re-build of the
IPC sources.
In addition to the options specified by Build.customCCOpts,
several -D and -I options are also passed to the compiler.
The options specified by Build.customCCOpts preceed the -D
and -I options passed to the compiler on the command line.
To view the custom compiler options, add the following line
to your config script:
print("Build.customCCOpts="+Build.customCCOpts);
When Build.libType is set to
Build_LibType_Custom, Build.customCCOpts
is initialized to create a highly optimized library.
When Build.libType is set to
Build_LibType_Debug, Build.customCCOpts
is initialized to create a non-optimized library that can be
used to single-step through the APIs with the CCS debugger.
WARNING
The default value of Build.customCCOpts, which is derived from
the target specified by your configuration, includes runtime
model options (such as endianess) that must be the same for all
sources built and linked into your application. You must not
change or add any options that can alter the runtime model
specified by the default value of Build.customCCOpts.
| config Build.libDir // module-wide |
|
| Configuration settings |
Build.libDir = String null;
| config Build.libType // module-wide |
|
IPC library type
| Configuration settings |
DETAILS
The IPC runtime is provided in the form of a library that is
linked with your application. Several forms of this library are
provided with the IPC product. In addition, there is an option
to build the library from source. This configuration parameter
allows you to select the form of the IPC library to use.
The default value of libType is taken from the BIOS.libType
configuration parameter. For a complete list of options and
what they offer see LibType.
| config Build.logsEnabled // module-wide |
|
IPC log support in custom library enable flag
| Configuration settings |
Build.logsEnabled = Bool true;
DETAILS
When set to true, IPC execution log code is compiled into
the custom library created when Build.libType
is set to Build_LibType_Custom or
Build_LibType_Debug.
When set to false, all log code is removed from the custom
library created when Build.libType = Build.LibType_Custom or
Build.LibType_Debug. This option can considerably improve runtime
performance as well signficantly reduce the application's code
size.
SEE
| Build.buildLibs() // module-wide |
|
| Configuration settings |
Build.buildLibs(Any objList, Any relList, Any filter, Any xdcArgs) returns Any
| Build.getAsmFiles() // module-wide |
|
Get the library Asm source files
| Configuration settings |
Build.getAsmFiles(String target) returns Any
| Build.getCCOpts() // module-wide |
|
| Configuration settings |
| Build.getCFiles() // module-wide |
|
Get the library C source files
| Configuration settings |
Build.getCFiles(String target) returns String
| Build.getDefaultCustomCCOpts() // module-wide |
|
| Configuration settings |
Build.getDefaultCustomCCOpts() returns String
| Build.getDefs() // module-wide |
|
Get the compiler -D options necessary to build
| Configuration settings |
Build.getDefs() returns String
| Build.getLibs() // module-wide |
|
Common getLibs() for all ipc packages
| Configuration settings |
Build.getLibs(Any pkg) returns Any
generated on Fri, 21 Aug 2015 19:35:35 GMT