1    /*
     2     * Copyright (c) 2019, 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     *  ======== TimestampProvider.xdc ========
    35     */
    36    
    37    package ti.sysbios.family.arm.vxm;
    38    
    39    import xdc.rov.ViewInfo;
    40    
    41    /*!
    42     *  ======== TimestampProvider ========
    43     *  Cortex M TimestampProvider
    44     *
    45     *  Cortex M TimestampProvider delegate for use 
    46     *  with {@link xdc.runtime.Timestamp}.
    47     *
    48     *  The 32 bit DWT cycle counter is used as the timestamp source.
    49     *
    50     *  Implements {@link ti.sysbios.interfaces.ITimestampProvider}
    51     *
    52     *  @a(Note)
    53     *  Only 32 bits supported.
    54     *  @a
    55     *
    56     *  @p(html)
    57     *  <h3> Calling Context </h3>
    58     *  <table border="1" cellpadding="3">
    59     *    <colgroup span="1"></colgroup> <colgroup span="5" align="center"></colgroup>
    60     *
    61     *    <tr><th> Function                 </th><th>  Hwi   </th><th>  Swi   </th><th>  Task  </th><th>  Main**  </th><th>  Startup***  </th></tr>
    62     *    <!--                                                                                                                 -->
    63     *    <tr><td> {@link #get32}           </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   N    </td></tr>
    64     *    <tr><td> {@link #get64}           </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   N    </td></tr>
    65     *    <tr><td> {@link #getFreq}         </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   N    </td></tr>
    66     *
    67     *  </table>
    68     *  @p
    69     */
    70    
    71    @ModuleStartup
    72    
    73    module TimestampProvider inherits ti.sysbios.interfaces.ITimestamp
    74    {
    75        /*! @_nodoc */
    76        metaonly struct ModuleView {
    77            String      timestamp;
    78        }
    79    
    80        @Facet
    81        metaonly config ViewInfo.Instance rovViewInfo =
    82            ViewInfo.create({
    83                viewMap: [
    84                [
    85                    'Module',
    86                    {
    87                        type: ViewInfo.MODULE,
    88                        viewInitFxn: 'viewInitModule',
    89                        structName: 'ModuleView'
    90                    }
    91                ],
    92                ]
    93            });
    94    }