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