1    /* 
     2     * Copyright (c) 2010, 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 OS Abstract Layer Configuration
    37     */
    38    @Template("./Settings.xdt")
    39    
    40    metaonly module Settings inherits ti.sdo.ce.osal.IOsal
    41    {
    42        /*!
    43         *  ======== defaultMemSegId ========
    44         *  Default ID of the memory segment from which to allocate space
    45         *  (for Memory_alloc/free() calls, as opposed to Memory_segAlloc/Free()).
    46         *  Typically it's the segment where all other code and data go.
    47         *
    48         *  If left as "null", the system will try to find a BIOS segment named
    49         *  "DDR" or "DDR2" and assign its name to this field. In the future
    50         *  this auto-find feature may be removed, so it's best that user .cfg
    51         *  script set this value directly to what they know is appropriate
    52         *  segment.
    53         *
    54         *  Only set this parameter if not using ti.sdo.osal.Global.runtimeEnv
    55         *  to set the target OS.
    56         */
    57        config String defaultMemSegId = null;
    58    
    59        /*!
    60         *  ======== enableLogging ========
    61         *  If set to true, enable data generation necessary for CE benchmarking
    62         *  analysis.
    63         *
    64         *  Only set this parameter if not using ti.sdo.osal.Global.runtimeEnv
    65         *  to set the target OS.
    66         */
    67        config bool enableLogging = true;
    68    
    69        /*!
    70         *  ======== traceBufferSize ========
    71         *  Size of the server trace buffer, in MAUs.
    72         *
    73         *  The server trace buffer is a circular buffer of characters written
    74         *  to by clients of ti.sdo.ce.osal.Trace (and ti.sdo.utils.trace.GT) and
    75         *  read by the Engine_*Trace() methods.
    76         *
    77         *  All the trace data in the target memory is stored into a globally
    78         *  visible character buffer
    79         *       Char Global_traceBuffer[ <traceBufferSize> ];
    80         *
    81         *  Only set this parameter if not using ti.sdo.osal.Global.runtimeEnv
    82         *  to set the target OS.
    83         */
    84        config Int traceBufferSize = 32768;
    85    
    86        /*!
    87         *  ======== logName ========
    88         *  Name of buffer used for capturing benchmarking data.
    89         *
    90         *  In BIOS environments, this is the name of the BIOS LOG.
    91         *
    92         *  Only set this parameter if not using ti.sdo.osal.Global.runtimeEnv
    93         *  to set the target OS.
    94         */
    95        config String logName = "ti_sdo_ce_osal_LOG_Buffer";
    96    
    97        /*!
    98         *  ======== logSize ========
    99         *  Size of buffer used for capturing benchmarking data.
   100         *
   101         *  Only set this parameter if not using ti.sdo.osal.Global.runtimeEnv
   102         *  to set the target OS.
   103         */
   104        config int logSize = 256;
   105    
   106        /*!
   107         *  ======== logType ========
   108         *  Type of buffer used for capturing benchmarking data.
   109         *
   110         *  This can be either "fixed" or "circular".
   111         *
   112         *  Only set this parameter if not using ti.sdo.osal.Global.runtimeEnv
   113         *  to set the target OS.
   114         */
   115        config String logType = "circular";
   116    
   117        /*!
   118         *  ======== logSeg ========
   119         *  Memory segment for the buffer used for capturing benchmarking data.
   120         *
   121         *  Only set this parameter if not using ti.sdo.osal.Global.runtimeEnv
   122         *  to set the target OS.
   123         */
   124        config String logSeg = null;
   125    
   126        /*!
   127         *  ======== debug ========
   128         *  Enable the debug profile of the osal BIOS module.
   129         *
   130         *  Deprecated, so don't document this.
   131         *  @_nodoc
   132         */
   133        config Bool debug = false;
   134    
   135        override bool supportsLogging();
   136    }
   137    /*
   138     *  @(#) ti.sdo.ce.osal.bios; 2, 0, 1,179; 9-20-2010 16:41:44; /db/atree/library/trees/ce/ce-r09x/src/ xlibrary
   139    
   140     */
   141