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 package ti.sysbios.timers.timer64;
38
39 import xdc.rov.ViewInfo;
40
41 import ti.sysbios.timers.timer64.Timer;
42
43 /*!
44 * ======== TimestampProvider ========
45 * Provides dm6446 specific timestamp APIs to xdc.runtime.Timestamp
46 *
47 * @p(html)
48 * <h3> Calling Context </h3>
49 * <table border="1" cellpadding="3">
50 * <colgroup span="1"></colgroup> <colgroup span="5" align="center">
51 * </colgroup>
52 *
53 * <tr><th> Function </th><th> Hwi </th><th> Swi </th>
54 * <th> Task </th><th> Main </th><th> Startup </th></tr>
55 * <!-- -->
56 * <tr><td> {@link #get32} </td><td> Y </td><td> Y </td>
57 * <td> Y </td><td> Y </td><td> N </td></tr>
58 * <tr><td> {@link #get64} </td><td> Y </td><td> Y </td>
59 * <td> Y </td><td> Y </td><td> N </td></tr>
60 * <tr><td> {@link #getFreq} </td><td> Y </td><td> Y </td>
61 * <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
70 * (e.g. TimestampProvider_Module_startupDone() returns TRUE). </li>
71 * <li> During xdc.runtime.Startup.lastFxns. </li>
72 * <li> During main().</li>
73 * <li> During BIOS.startupFxns.</li>
74 * </ul>
75 * <li> <b>Startup</b>: API is callable during any of these phases:</li>
76 * <ul>
77 * <li> During xdc.runtime.Startup.firstFxns.</li>
78 * <li> In your module startup before this module is started
79 * (e.g. TimestampProvider_Module_startupDone() returns FALSE).</li>
80 * </ul>
81 * </ul>
82 * </td></tr>
83 *
84 *
85 * </table>
86 * @p
87 */
88
89 @ModuleStartup
90
91 module TimestampProvider inherits ti.sysbios.interfaces.ITimestamp
92 {
93 /*! @_nodoc */
94 metaonly struct Module_View {
95
96 Bool usesClockTimer;
97 };
98
99 /*! TimestampProvider timer id. Max id value is 2 */
100 config UInt timerId = Timer.ANY;
101
102 /*!
103 * Set this parameter when you want TimestampProvider is use the same timer
104 * as the Clock module
105 *
106 * This parameter overrides the timeId setting.
107 */
108 config Bool useClockTimer = false;
109
110 /*!@_nodoc
111 * Internal use. Function that starts timer before main
112 */
113 Void startTimer();
114
115 /*!@_nodoc
116 * Internal use. Timer rollover interrupt handler.
117 */
118 Void rolloverFunc(UArg unused);
119
120 internal:
121
122 struct Module_State {
123 Timer.Handle timer;
124 volatile UInt32 hi;
125 }
126 }