1    /*
     2     * Copyright (c) 2016-2020, 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.tms320x28;
    37    
    38    /*!
    39     *  ======== Platform ========
    40     *  A generic platform that supports any TMS320x28 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.tms320x28:TMS320C2812"
    47     *  @p
    48     *
    49     *  In package.bld, the platform instance is selected as in:
    50     *  @p(code)
    51     *  Pkg.addExecutable("test", target, "ti.platforms.tms320x28:TMS320C2812");
    52     *  @p
    53     *
    54     *  This platform does not generate a complete linker command file. It can add
    55     *  a linker command file to the build, if the configuration parameter
    56     *  `includeLinkCmdFile' is used. Otherwise, either a user or an IDE (CCS, for
    57     *  example) must add a linker command file that contains the memory map and
    58     *  section allocations for commonly used sections.
    59     */
    60    metaonly module Platform inherits xdc.platform.IPlatform
    61    {
    62        config xdc.platform.IPlatform.Board BOARD = {
    63            id:             "0",
    64            boardName:      "tms320x28",
    65            boardFamily:    null,
    66            boardRevision:  null
    67        };
    68    
    69        /*!
    70         *  ======== nameFormat ========
    71         *  Encoding of instance creation parameters in the instance's name
    72         *
    73         *  For this platform, the parameters `deviceName`, `includeLinkCmdFile`
    74         *  and `clockRate` can be encoded in the instance name supplied on
    75         *  `xdc.tools.configuro` command line, for example:
    76         *  @p(code)
    77         *      xs xdc.tools.configuro ... -p ti.platforms.tms320x28:TMS320F28035:1:60
    78         *  @p
    79         *  Optional parameters can be omitted:
    80         *  @p(code)
    81         *      xs xdc.tools.configuro ... -p ti.platforms.tms320x28:TMS320F28035
    82         *  @p
    83         */
    84        readonly config string nameFormat
    85            = "$(deviceName):$(includeLinkCmdFile):$(clockRate)";
    86    
    87        /*!
    88         *  ======== genAliases ========
    89         *  Generate symbol mapping for TI Tools 6.0 or newer
    90         */
    91        config Bool genAliases = true;
    92    
    93    instance:
    94    
    95        config xdc.platform.IExeContext.Cpu CPU = {
    96            id:             "0",
    97            clockRate:      0,
    98            catalogName:    "ti.catalog.c2800",
    99            deviceName:     "TMS320F28069",
   100            revision:       null,
   101        };
   102    
   103        /*!
   104         *  ======== deviceName ========
   105         *  The name of an `ICpuDataSheet` module for the device
   106         *
   107         *  This parameter is required, but it does not have to be set explicitly;
   108         *  it can be encoded in the instance's name.
   109         */
   110        config string deviceName;
   111    
   112        /*!
   113         *  ======== clockRate ========
   114         *  The clock rate for this device.
   115         */
   116        config Double clockRate = 0;
   117    
   118        override config string codeMemory = null;
   119    
   120        override config string dataMemory = null;
   121    
   122        override config string stackMemory = null;
   123    
   124        /*!
   125         *  ======== includeLinkCmdFile ========
   126         *  The flag that specifies if the platform should include a linker command
   127         *  file.
   128         *
   129         *  By default, a user is responsible for adding a linker command file to
   130         *  the project, or to the linker command line. However, if this flag is
   131         *  set, this platform will include a default linker command file for the
   132         *  selected device.
   133         */
   134        config Bool includeLinkCmdFile = false;
   135    };