1    /*
     2     * Copyright (c) 2013-2016, Texas Instruments Incorporated
     3     * All rights reserved.
     4     *
     5     * Redistribution and use in source and binary forms, with or without
     6     * modification, are permitted provided that the following conditions
     7     * are met:
     8     *
     9     * *  Redistributions of source code must retain the above copyright
    10     *    notice, this list of conditions and the following disclaimer.
    11     *
    12     * *  Redistributions in binary form must reproduce the above copyright
    13     *    notice, this list of conditions and the following disclaimer in the
    14     *    documentation and/or other materials provided with the distribution.
    15     *
    16     * *  Neither the name of Texas Instruments Incorporated nor the names of
    17     *    its contributors may be used to endorse or promote products derived
    18     *    from this software without specific prior written permission.
    19     *
    20     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
    22     * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    23     * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    24     * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    25     * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    26     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
    27     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    28     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
    29     * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
    30     * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    31     */
    32    /*
    33     *  ======== Build.xdc ========
    34     *  @_nodoc
    35     *  metaonly module to support building various package/product libraries
    36     *
    37     */
    38    
    39    /*!
    40     *  ======== Build ========
    41     */
    42    
    43    @Template("./Build.xdt")
    44    metaonly module Build
    45    {
    46        /*!
    47         *  ======== buildROM ========
    48         *  Setting this to true causes the ROM to be built.
    49         */
    50        metaonly config Bool buildROM = false;
    51    
    52        /*!
    53         *  ======== buildROMApp ========
    54         *  Setting this to true tells the Build system
    55         *  that the user wants their application linked with
    56         *  the ROM image.
    57         */
    58        metaonly config Bool buildROMApp = false;
    59    
    60        /*!
    61         *  ======== includePaths ========
    62         *  Array of header file include search paths
    63         *  used to build the custom RTOS library
    64         *
    65         *  To add to this array, use the following syntax:
    66         *  Build.includePaths.$add("/path/to/my/include/files/");
    67         */
    68        metaonly config String includePaths[];
    69    
    70        /*!
    71         *  ======== ccArgs ========
    72         *  Array of strings added to the compile line
    73         *  used to build the custom RTOS library
    74         *
    75         *  To add to this array, use the following syntax:
    76         *  Build.ccArgs.$add("-DMY_MACRO=1");
    77         */
    78        metaonly config String ccArgs[];
    79    
    80        /*!
    81         *  ======== getDefaultCustomCCOpts ========
    82         */
    83        metaonly String getDefaultCustomCCOpts();
    84    
    85        /*!
    86         *  ======== getDefs ========
    87         *  Get the compiler -D options necessary to build
    88         */
    89        metaonly String getDefs();
    90    
    91        /*!
    92         *  ======== getCFiles ========
    93         *  Get the library C source files.
    94         */
    95        metaonly String getCFiles(String target);
    96    
    97        /*!
    98         *  ======== getAsmFiles ========
    99         *  Get the library Asm source files.
   100         */
   101        metaonly Any getAsmFiles(String target);
   102    
   103        /*!
   104         *  ======== getCommandLineDefs ========
   105         *  Get the set of -D strings to insert into the makefile.
   106         */
   107        metaonly String getCommandLineDefs();
   108    
   109        /*!
   110         *  ======== getIncludePaths ========
   111         *  Get the set of -I strings to insert into the makefile.
   112         */
   113        metaonly String getIncludePaths();
   114    
   115        /*!
   116         *  ======== getCcArgs ========
   117         *  Get the compiler commpand line  args
   118         */
   119        metaonly String getCcArgs();
   120    
   121        /*
   122         *  ======== buildLibs ========
   123         *  This function generates the makefile goals for the libraries
   124         *  produced by a ti.sysbios package.
   125         */
   126        function buildLibs(objList, relList, filter, xdcArgs);
   127    
   128        /*!
   129         *  ======== getLibs ========
   130         *  Common getLibs() for all sysbios packages.
   131         */
   132        function getLibs(pkg);
   133    }