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     *  ======== package.xdc ========
    34     *
    35     */
    36    
    37    /*!
    38     *  ======== ti.sysbios.timer ========
    39     *  Contains various timer modules
    40     *
    41     *  This package contains Timer modules that manage the timer peripherals
    42     *  available on various devices.  For the IDs, names, and base addresses of
    43     *  supported devices, see the following Timer Mapping Tables:
    44     *  @p(blist)
    45     *  - {@link ./dmtimer/doc-files/TimerTables.html DMTimer Timer Mapping Table}
    46     *  - {@link ./gptimer/doc-files/TimerTables.html GPTimer Timer Mapping Table}
    47     *  - {@link ./timer64/doc-files/TimerTables.html Timer64 Timer Mapping Table}
    48     *  @p
    49     *  The Timer modules let you use and configure various timers that exist 
    50     *  on a particular device. This is achieved by specifying a timer ID when
    51     *  calling Timer_create(). 
    52     *
    53     *  By default, the {@link ti.sysbios.knl.Clock} module statically configures 
    54     *  a {@link ti.sysbios.hal.Timer}
    55     *  timer instance to provide the periodic 1 ms tick interrupt. If you
    56     *  want to use a custom configured timer for the Clock module's tick source,
    57     *  use the following example configuration as a guide:
    58     *
    59     *  @p(code)
    60     *  var Clock = xdc.useModule('ti.sysbios.knl.Clock');
    61     *
    62     *  // Tell the Clock module that YOU are providing the periodic interrupt
    63     *  Clock.tickSource = Clock.TickSource_USER;
    64     *
    65     *  // this example uses the ti.sysbios.timers.dmtimer.Timer module
    66     *  var Timer = xdc.useModule('ti.sysbios.timers.dmtimer.Timer');
    67     *
    68     *  // create a dmtimer config parameter object
    69     *  var timerParams = new Timer.Params();
    70     *
    71     *  // make sure you set the period to 1000 us (1ms)
    72     *  timerParams.period = 1000;
    73     *
    74     *  // custom dmtimer config parameters here...
    75     *  timerParams.twer.ovf_wup_ena = 1;
    76     *
    77     *  // Create the timer.
    78     *  // This example uses timer id 3.
    79     *  // The timer interrupt handler must be set to 'Clock.tick'. 
    80     *  Timer.create(3, Clock.tick, timerParams);
    81     *  @p
    82     */
    83    package ti.sysbios.timers [2,0,0,0] {
    84    }