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