1    /* 
     2     * Copyright (c) 2012, 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    /*!
    35     *  ======== Settings ========
    36     *  Global configuration settings for all Framework Components packages
    37     *
    38     *  This module provides high-level configuration settings for all
    39     *  Framework Components packages.
    40     *
    41     *  @a(Linking with Framework Components Libraries)
    42     *
    43     *  When linking an executable, this module's profile config param is
    44     *  used to select which libraries are used. See the {@link #profile}
    45     *  config param below. There are three typical use-cases.
    46     *
    47     *  1. Link with Framework Components libraries of a specific profile. Add the
    48     *  following to your application cfg script.
    49     *
    50     *  @p(code)
    51     *  // set all framework component libraries to the given profile
    52     *  xdc.useModule('ti.sdo.fc.global.Settings').profile = "debug";
    53     *  @p
    54     *
    55     *  2. Link with Framework Component libraries using the program's profile. Add
    56     *  the following to your application cfg script.
    57     *
    58     *  @p(code)
    59     *  // use the program's profile
    60     *  var Program = xdc.useModule('xdc.cfg.Program');
    61     *  xdc.useModule('ti.sdo.fc.global.Settings').profile = Program.build.profile;
    62     *  @p
    63     *
    64     *  3. Specify a profile on a per-package basis.
    65     *
    66     *  @p(code)
    67     *  // specify the profile for some select packages
    68     *  xdc.loadPackage('ti.sdo.fc').profile = "debug";
    69     *  xdc.loadPackage('ti.sdo.fc.rman').profile = "debug";
    70     *  xdc.loadPackage('ti.sdo.fc.dman3').profile = "debug";
    71     *  xdc.loadPackage('ti.sdo.fc.edma3').profile = "debug";
    72     *  @p
    73     *
    74     *  Note that the third method above does not actually use the `profile`
    75     *  config param. It sets the package's profile config param directly.
    76     *
    77     *  The default value for the `profile` config param is `release`.
    78     *  Thus, even when building your executable using a debug profile, the
    79     *  Framework Component release libraries will be used. This helps to keep the
    80     *  executable size smaller when you want to debug the application code.
    81     */
    82    
    83    @Template("./Settings.xdt")
    84    
    85    metaonly module Settings
    86    {
    87        /*!
    88         * ======== multiProcess ========
    89         * Add multi-process support for Framework Components libraries.
    90         *
    91         * This flag indicates whether an OSAL's multi-process support should
    92         * be linked in.
    93         */
    94        config Bool multiProcess = true;
    95    
    96        /*!
    97         * ======== osalPackage ========
    98         * Name of the package supplying osal libraries.
    99         *
   100         * Some FC packages (such as ti.sdo.fc.rman and
   101         * ti.sdo.fc.ires.* on Linux) need implementation
   102         * of some OSAL APIs (LockMP_acquire/release/create/delete
   103         * and Sem_create/delete/pend/post).
   104         *
   105         * Assign this to a package name that implements these
   106         * signatures of the Lock functions are available at
   107         * ti/sdo/fc/utils/lock.h
   108         */
   109        config String osalPackage;
   110    
   111        /*!
   112         *  ======== profile ========
   113         *  Name the library profile to use at link time
   114         *
   115         *  If the Framework Component libraries have been built using the profile
   116         *  named by this config param, then these libraries will be used
   117         *  when linking the final executable. Otherwise, a substitute
   118         *  library will be used. For example, if this config param is set to
   119         *  debug but there are only release libraries available, then the
   120         *  release library is used.
   121         */
   122        config String profile = "release";
   123    
   124        /*!
   125         *  ======== enableLogFC ========
   126         *  Globally enable or disable logging in Framework components.
   127         *
   128         *  If enableLogFC is set to false, any Diags masks of a Framework
   129         *  Components module that have not been set in the application's
   130         *  configuration file, will be set to Diags.ALWAYS_OFF. However,
   131         *  the if the module's 'enableLog' configuration parameter has been
   132         *  set, it will override this.
   133         *
   134         *  If enableLogFC has been set to true, or has not been set at all,
   135         *  the default value for unset FC Diags masks will be RUNTIME_OFF.
   136         *
   137         *  @sa xdc.runtime.Diags
   138         *  @sa xdc.runtime.Log
   139         */
   140        config Bool enableLogFC;
   141    
   142        /*!
   143         *  ======== useDNUM ========
   144         *  Use DNUM to convert internal memory addresses to core-specific 
   145         *  addresses, that peripherals such as the EDMA3 can understand. 
   146         *  This is automatically done for devices such as 6472, 6474, 6486, 6488
   147         *  Should be explicitly set for others, others FC will return un-modified  
   148         *  internal memory addresses.
   149         */
   150        config Bool useDNUM;
   151    
   152        config Bool useL3MemoryMap; 
   153    }
   154    /*
   155     *  @(#) ti.sdo.fc.global; 1, 0, 0,6; 4-16-2012 00:00:54; /db/atree/library/trees/fc/fc-q08/src/ xlibrary
   156    
   157     */
   158