1    /*
     2     * Copyright (c) 2012-2013, 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     *  ======== TimestampProvider.xdc ========
    34     *
    35     *
    36     */
    37    
    38    package ti.sysbios.timers.dmtimer;
    39    
    40    /*!
    41     *  ======== TimestampProvider ========
    42     *
    43     *  @p(html)
    44     *  <h3> Calling Context </h3>
    45     *  <table border="1" cellpadding="3">
    46     *    <colgroup span="1"></colgroup> <colgroup span="5" align="center"></colgroup>
    47     *
    48     *    <tr><th> Function                 </th><th>  Hwi   </th><th>  Swi   </th><th>  Task  </th><th>  Main**  </th><th>  Startup***  </th></tr>
    49     *    <!--                                                                                                                 -->
    50     *    <tr><td> {@link #get32}           </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   N    </td></tr>
    51     *    <tr><td> {@link #get64}           </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   N    </td></tr>
    52     *    <tr><td> {@link #getFreq}         </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   Y    </td><td>   N    </td></tr>
    53     *
    54     *  </table>
    55     *  @p
    56     */
    57    
    58    @ModuleStartup          /* To get Clock Timer Handle */
    59    
    60    module TimestampProvider inherits ti.sysbios.interfaces.ITimestamp
    61    {
    62        /*!
    63         *  ======== timerId ========
    64         *  TimestampProvider timer id
    65         *
    66         *  A value of {@link Timer#ANY Timer.ANY} (-1) indicates any timer is ok.
    67         */
    68        config UInt timerId = Timer.ANY;
    69    
    70        /*!
    71         *  
    72         *  ======== useClockTimer ========
    73         *  Use the same timer as Clock
    74         *
    75         *  Set this parameter when you want TimestampProvider to use the same
    76         *  timer as the BIOS {@link ti.sysbios.knl.Clock Clock} module.
    77         *
    78         *  This parameter overrides the {@link #timerId timeId} setting.
    79         */
    80        config Bool useClockTimer;
    81    
    82        /*!
    83         *  ======== startTimer ========
    84         *  Function that starts timer before main
    85         *
    86         *  @_nodoc Internal use. 
    87         */
    88        Void startTimer();
    89    
    90        /*!
    91         *  ======== rolloverFunc ========
    92         *  Timer rollover interrupt handler
    93         *
    94         *  @_nodoc Internal use. 
    95         */
    96        Void rolloverFunc(UArg unused);
    97    
    98    internal:   /* not for client use */
    99    
   100        struct Module_State {
   101            Timer.Handle    timer;          /* timer instance used */
   102            volatile UInt32 rollovers;      /* timer rollover counts */
   103        }
   104    }