1 /*
2 * Copyright (c) 2011, 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.family.arm.lm3;
39
40 /*!
41 * ======== TimestampProvider ========
42 * Implements ITimestampProvider
43 *
44 * Cortex M3 TimestampProvider delegate for use
45 * with {@link xdc.runtime.Timestamp}.
46 *
47 * The SysTick timer is used as the timestamp source.
48 *
49 * @p(html)
50 * <h3> Calling Context </h3>
51 * <table border="1" cellpadding="3">
52 * <colgroup span="1"></colgroup> <colgroup span="5" align="center"></colgroup>
53 *
54 * <tr><th> Function </th><th> Hwi </th><th> Swi </th><th> Task </th><th> Main** </th><th> Startup*** </th></tr>
55 * <!-- -->
56 * <tr><td> {@link #get32} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr>
57 * <tr><td> {@link #get64} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr>
58 * <tr><td> {@link #getFreq} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr>
59 * <tr><td colspan="6"> Definitions: <br />
60 * <ul>
61 * <li> <b>Hwi</b>: API is callable from a Hwi thread. </li>
62 * <li> <b>Swi</b>: API is callable from a Swi thread. </li>
63 * <li> <b>Task</b>: API is callable from a Task thread. </li>
64 * <li> <b>Main</b>: API is callable during any of these phases: </li>
65 * <ul>
66 * <li> In your module startup after this module is started (e.g. TimestampProvider_Module_startupDone() returns TRUE). </li>
67 * <li> During xdc.runtime.Startup.lastFxns. </li>
68 * <li> During main().</li>
69 * <li> During BIOS.startupFxns.</li>
70 * </ul>
71 * <li> <b>Startup</b>: API is callable during any of these phases:</li>
72 * <ul>
73 * <li> During xdc.runtime.Startup.firstFxns.</li>
74 * <li> In your module startup before this module is started (e.g. TimestampProvider_Module_startupDone() returns FALSE).</li>
75 * </ul>
76 * </ul>
77 * </td></tr>
78 * </table>
79 * @p
80 */
81
82 @ModuleStartup
83
84 module TimestampProvider inherits ti.sysbios.interfaces.ITimestamp
85 {
86 /*!
87 * Set this parameter when you want TimestampProvider to use
88 * the same timer as the Clock module.
89 *
90 * This parameter overrides the {@link #timerId} setting.
91 */
92 config Bool useClockTimer = false;
93
94 /*!
95 * TimestampProvider timer id.
96 *
97 * When not using the Clock timer, TimestampProvider will
98 * create an {@link Timer} using this timer id.
99 */
100 config UInt timerId = Timer.ANY;
101
102 /*!@_nodoc
103 * Internal use. Function that starts timer before main
104 */
105 @DirectCall
106 Void startTimer();
107
108 /*!@_nodoc
109 * Internal use. Timer rollover interrupt handler.
110 */
111 @DirectCall
112 Void rolloverFunc(UArg unused);
113
114 internal: /* not for client use */
115
116 struct Module_State {
117 Timer.Handle timer; /* timer instance used */
118 volatile UInt32 hi; /* upper 32 bits */
119 }
120 }
121 /*
122 * @(#) ti.sysbios.family.arm.lm3; 2, 0, 0, 0,172; 6-15-2011 16:24:32; /db/vtree/library/trees/avala/avala-p38x/src/ xlibrary
123
124 */
125