1    /*
     2     * Copyright (c) 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    /*
    34     *  ======== Platform.xdc ========
    35     */
    36    package ti.platforms.tiva;
    37    
    38    /*!
    39     *  ======== Platform ========
    40     *  A generic platform that supports any Tiva device
    41     *
    42     *  The device to be used by this platform is passed as the platform instance
    43     *  name. On the `xdc.tools.configuro` command line, it is done in the
    44     *  following way:
    45     *  @p(code)
    46     *  xs xdc.tools.configuro ... -p "ti.platforms.tiva:TM4C1290NCZAD"
    47     *  @p
    48     *
    49     *  In package.bld, the platform instance is selected as in:
    50     *  @p(code)
    51     *  Pkg.addExecutable("test", target, "ti.platforms.tiva:TM4C1290NCZAD");
    52     *  @p
    53     */
    54    @Template ("./Platform.xdt")
    55    metaonly module Platform inherits xdc.platform.IPlatform
    56    {
    57        config xdc.platform.IPlatform.Board BOARD = {
    58            id:             "0",
    59            boardName:      "tiva",
    60            boardFamily:    null,
    61            boardRevision:  null
    62        };
    63    
    64        /*!
    65         *  ======== nameFormat ========
    66         *  Encoding of instance creation parameters in the instance's name
    67         *
    68         *  For this platform, the parameters `deviceName`, `includeLinkCmdFile`
    69         *  and `clockRate` can be encoded in the instance name supplied on
    70         *  `xdc.tools.configuro` command line, for example:
    71         *  @p(code)
    72         *      xs xdc.tools.configuro ... -p ti.platforms.tiva:TM4C1290NCZAD:1:20
    73         *  @p
    74         *  Optional parameters can be omitted:
    75         *  @p(code)
    76         *      xs xdc.tools.configuro ... -p ti.platforms.tiva:TM4C1290NCZAD
    77         *  @p
    78         */
    79         readonly config string nameFormat
    80             = "$(deviceName):$(includeLinkCmdFile):$(clockRate)";
    81    
    82    instance:
    83    
    84        /*
    85         *  This platform supports either Cortex M3 or M4 cores.
    86         *  The corresponding "actual" catalogName is overwritten
    87         *  in Platform.instance$meta$init() based on the device name
    88         */
    89        config xdc.platform.IExeContext.Cpu CPU = {
    90            id:             "0",
    91            clockRate:      1.0,
    92            catalogName:    "ti.catalog.arm.cortexm4",
    93            deviceName:     "Tiva",
    94            revision:       "",
    95        };
    96    
    97        /*!
    98         *  ======== deviceName ========
    99         *  The name of an `ICpuDataSheet` module for the device
   100         *
   101         *  This parameter is required, but it does not have to be set explicitly;
   102         *  it can be encoded in the instance's name.
   103         */
   104        config string deviceName;
   105    
   106        /*!
   107         *  ======== clockRate ========
   108         *  The clock rate for this device.
   109         */
   110        config Double clockRate;
   111    
   112        override config string codeMemory = null;
   113    
   114        override config string dataMemory = null;
   115    
   116        override config string stackMemory = null;
   117    
   118        /*!
   119         *  ======== includeLinkCmdFile ========
   120         *  The flag that specifies if the platform should include a linker command
   121         *  file.
   122         *
   123         *  By default, a user is responsible for adding a linker command file to
   124         *  the project, or to the linker command line. However, if this flag is
   125         *  set, this platform will include a default linker command file for the
   126         *  selected device.
   127         */
   128        config Bool includeLinkCmdFile = false;
   129    };