Texas
          Instruments Technology for
        Innovators

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:

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 xdcpaths.mak

The Framework Components examples are provided with XDC build scripts. xdcpaths.mak is the Makefile include file that 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 xdcpaths.mak file which has to be edited for your particular usecase. Edit the following variables described below

PROGRAMS

DEVICES

INSTALL_DIR

CGTOOLS_

MY_XDC_PATH

2. Build examples

From the base of your examples directory, type

    gmake clean
    gmake

This will build all the examples that are applicable for your DEVICE and PROGRAMS. Other make targets might also be available in the Makefile to build subsets of the examples.

You can also step into a specific example directory, and type the above commands to build individual examples.


Last updated: October 10, 2011