Build Instructions for Framework Components Examples
General Information
This page explains how to build the examples provided in the
Framework Components product.
Requirements
See the Release Notes
for the specific software and hardware components this release of
Framework Components has been validated against.
Directory Structure
examples
+---ti
+---sdo
+---fc
+---dman3
| +---examples
| +---fastcopy
| +---<device_os> (device/OS-specific directories)
+---rman
+---examples
+---bufres
+---bufres_yield
+---dmaXferScratch
+---dummyEdma3
+---hdvicp
+---nonRtscExample
+---nullresource
+---scratchEdma3
+---sdma
+---shmbuf
+---vicp
+---vicpsync
Directory Conventions
Important: throughout the rest of this document, we will use the
following notation:
- <FC_INSTALL_DIR> - the root directory of your FC
installation. The FC packages are in the
<FC_INSTALL_DIR>/packages directory (or repository); the
original examples are in the <FC_INSTALL_DIR>/examples
directory (or repository).
- <XDAIS_INSTALL_DIR> - the root directory of your
XDAIS installation. Some distributions of this FC release include an
fctools directory which contains an XDAIS release. In the case of
those distributions, <XDAIS_INSTALL_DIR> could be set to
<FC_INSTALL_DIR>/fctools. Note that the XDAIS packages will
be located in the <XDAIS_INSTALL_DIR>/packages directory
(or repository).
- <XDC_INSTALL_DIR> - the root directory of your
XDC tools installation. The FC examples now have a dependency on the XDC
tools std.h header file. If you have installed DSP BIOS, you can set
<XDC_INSTALL_DIR> to <BIOS_INSTALL_DIR>/xdctools.
Otherwise, set <XDC_INSTALL_DIR> to the root directory of your XDC
tools installation.
Preparing to Build the Examples
Create a working directory
Create a working directory (e.g. c:/myPackages) and copy the
examples directory into it (e.g. c:/myPackages/examples).
This will be where you build and modify the Framework Components examples.
Doing this will ensure you have a backup copy of the original examples, as
provided by the Framework Components product.
Build using XDC tools
1. Manage config.bld
The Framework Components examples are also provided with XDC build scripts. The master
build configuration script, config.bld, is used to define the targets
and environment in which the example XDC packages will be built.
At the root of the Examples directory, there is a
config.bld.default config script which can be used to start from.
Simply rename it to config.bld, and open this file in a text editor.
Build.targets
- Some of the FC examples can be built and run for different targets.
The Build.targets array specifies which targets you want to build for.
Edit this file to add/remove other targets that you would like to build the
examples for.
Toolchain roots - rootDir
- C64P.rootDir - Specify where your C64 tools are
Edit the string (directory name) assigned to the C64P.rootDir
variable. Note that both Windows and Linux builds are supported.
Note that this the directory that contains bin/, include/, and lib/
subdirectory. (Note that this is only necessary if "C64P" is
included in your "Build.targets" array). Similarly, edit the rootDir for
other targets that the examples are built for.
2. Edit Makefile to define the necessary variables
The Makefile file, located at the root of the examples/
directory, defines where the FC product is installed, and where the
XDC tools are. Open this file in a text editor.
- Specify where your FC product is installed:
Set FC_INSTALL_DIR to the absolute path to your FC
installation directory.
Set XDAIS_INSTALL_DIR to the absolute path to your XDAIS
installation directory. In most cases you can set it to
$(FC_INSTALL_DIR)/fctools.
- Specify where your XDC tools are installed:
Set XDC_INSTALL_DIR to the absolute
path to your XDC tools installation directory. The version of the xdctools
to be used is mentioned in the Makefile
- Depending on the examples you are trying to build and the target you are
building them for, you may need to specify the BIOS_INSTALL_DIR and
the LINUXUTILS install locations.
- For EDMA3 tests built for the DSP, location of the Low level Resource
Manager, EDMA3_LLD_ROOT will be required. In most cases, it can be
pointed to $(FC_INSTALL_DIR)/fctools.
3. Build examples
From the base of your examples directory, type
gmake clean
gmake
Other make targets might also be available in the Makefile to build subsets of
the examples.
Build using the provided .pjt files (dman3 fastcopy examples only)
In addition to the portable (but admittedly confusing), XDC-based
package.bld build scripts, the dman3 fastcopy examples also provide
.pjt-based builds for CCS 3 Windows users. This section describes those
examples.
For each platform supported, there are 2
example applications provided, e.g., dm6446_bios
and dm6446_nobios. Each includes its own .pjt file located in
their respective directories. For each of the CCS Debug and Release build
configurations, the .pjt files also support 2 more configurations: one with
the instrumented version of the ACPY3 library, and the other with the
non-instrumented version.
Note:There is also a library
shared by both examples, which includes its own .pjt file
(fcpy_ti64.pjt). Building either application will also build the
shared library.
The .pjts require three variables to be
set, both are described above:
- XDAIS_INSTALL_DIR - required for the XDAIS interface headers
- FC_INSTALL_DIR - required for the FC interface headers
- XDC_INSTALL_DIR - required for the XDC standard types
You can either set these variables in your system, or modify the .pjt files
with paths appropriate for your development environment.
As expected, these .pjts require CCS and only run on Windows.
Last updated: July 2, 2010