1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
32 33 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 }