1    /* --COPYRIGHT--,BSD
     2     * Copyright (c) $(CPYYEAR), 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     * --/COPYRIGHT--*/
    32    
    33    /*
    34     * ======== UIAMetaData.xdc
    35     */
    36    
    37    /*!
    38     * Unified Arch. Hardware Interrupt Context Instrumentation
    39     *
    40     * The UIAHWICtx module defines context change events
    41     * and methods that allow tooling to identify hardware interrutp context
    42     * switches and to enable HWI-aware filtering, trace and
    43     * analysis.
    44     */
    45    
    46    module UIAMetaData {
    47    
    48    metaonly function generateXML();
    49    
    50    /*!
    51     *  ======== genXmlEntry ========
    52     *  write an entry into an xml file
    53     *
    54     *  e.g. <myTag>myValue</myTag>\n
    55     */
    56    metaonly function genXmlEntry(indent, tag, value);
    57    /*!
    58     *  ======== genXmlEntryOpen ========
    59     *  write an entry into an xml file with a key field
    60     *
    61     *  e.g. <myTag myKeyName=myKeyValue>
    62     */
    63    metaonly function  genXmlEntryOpen(indent,  tag);
    64    
    65    /*!
    66     *  ======== genXmlEntryOpenWithKey ========
    67     *  write an entry into an xml file with a key field
    68     *
    69     *  e.g. <myTag myKeyName=myKeyValue>
    70     */
    71    metaonly function  genXmlEntryOpenWithKey(indent,tag,keyName,keyValue,value);
    72    
    73    /*!
    74     *  ======== genXmlEntryWithKey ========
    75     *  write an entry into an xml file with a key field
    76     *
    77     *  e.g. <myTag myKeyName=myKeyValue>myValue</myTag>\n
    78     */
    79     metaonly function  genXmlEntryWithKey(indent,tag,keyName,keyValue,value);
    80     
    81     /*!
    82      * ======== genXmlComment ========
    83      * add an XML style comment to the active xml file
    84      */
    85     metaonly function  genXmlComment(indent,  comment);
    86    /*!
    87     *  ======== genXmlEntryClose ========
    88     *  write an entry into an xml file with a key field
    89     *
    90     *  e.g. </myTag>\n
    91     */
    92    metaonly function  genXmlEntryClose(indent,  tag);
    93    
    94    
    95    /*! @_nodoc
    96     * ======== setLoggingSetupConfigured ========
    97     * Called by the LoggingSetup module to indicate it is in the .cfg file
    98     * 
    99     * Sets an internal metaonly flag that is used to determine the transport used.
   100     */
   101    metaonly function setLoggingSetupConfigured();
   102    
   103    /*! @_nodoc
   104     * ======== isLoggingSetupConfigured ========
   105     * Called by other modules to see if the LoggingSetup module is in the .cfg file
   106     * 
   107     * Returns true if the LoggingSetup module can be used to determine the transport used.
   108     */
   109    metaonly function isLoggingSetupConfigured();
   110    }
   111    
   112    /*
   113     *! Revision History
   114     *! ================
   115     *! 23-Jun-2010 toddm Started revision history
   116     */