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 * ======== TimestampProvider.xdc ========
34 *
35 *
36 */
37
38 package ti.sysbios.family.arm.f28m35x;
39
40 import xdc.runtime.Types;
41
42 /*!
43 * ======== TimestampProvider ========
44 *
45 * @p(html)
46 * <h3> Calling Context </h3>
47 * <table border="1" cellpadding="3">
48 * <colgroup span="1"></colgroup> <colgroup span="5" align="center"></colgroup>
49 *
50 * <tr><th> Function </th><th> Hwi </th><th> Swi </th><th> Task </th><th> Main </th><th> Startup </th></tr>
51 * <!-- -->
52 * <tr><td> {@link #get32} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr>
53 * <tr><td> {@link #get64} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr>
54 * <tr><td> {@link #getFreq} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr>
55 * <tr><td> {@link #setFreq} </td><td> Y </td><td> Y </td><td> Y </td><td> Y </td><td> N </td></tr>
56 * <tr><td colspan="6"> Definitions: <br />
57 * <ul>
58 * <li> <b>Hwi</b>: API is callable from a Hwi thread. </li>
59 * <li> <b>Swi</b>: API is callable from a Swi thread. </li>
60 * <li> <b>Task</b>: API is callable from a Task thread. </li>
61 * <li> <b>Main</b>: API is callable during any of these phases: </li>
62 * <ul>
63 * <li> In your module startup after this module is started (e.g. TimestampProvider_Module_startupDone() returns TRUE). </li>
64 * <li> During xdc.runtime.Startup.lastFxns. </li>
65 * <li> During main().</li>
66 * <li> During BIOS.startupFxns.</li>
67 * </ul>
68 * <li> <b>Startup</b>: API is callable during any of these phases:</li>
69 * <ul>
70 * <li> During xdc.runtime.Startup.firstFxns.</li>
71 * <li> In your module startup before this module is started (e.g. TimestampProvider_Module_startupDone() returns FALSE).</li>
72 * </ul>
73 * </ul>
74 * </td></tr>
75 *
76 * </table>
77 * @p
78 *
79 */
80
81
82 module TimestampProvider inherits ti.sysbios.interfaces.ITimestamp
83 {
84
85 /*
86 * Frequency of the timestamp provider.
87 */
88 metaonly config Types.FreqHz freq;
89
90 /*!
91 * ======== setFreq ========
92 * Set the timestamp frequency (in Hz)
93 *
94 * @param(freq) pointer to a 64-bit structure
95 *
96 * This parameter is a pointer to a structure representing a 64-bit
97 * wide frequency value (in Hz); see `{@link xdc.runtime.Types#FreqHz}`
98 * This function provides a way of converting timestamp
99 * values into units of real time.
100 *
101 */
102 Void setFreq(xdc.runtime.Types.FreqHz *freq);
103
104 internal:
105
106 const UInt32 MIPCCOUNTERL = 0x400FB718;
107 const UInt32 MIPCCOUNTERH = 0x400FB71C;
108
109 /*
110 * ======== Module_State ========
111 */
112 struct Module_State {
113 Types.FreqHz freq; /* in KHz */
114 };
115
116 }
117