1 /*
2 * Copyright (c) 2016, 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 package ti.sysbios.family.arm.v8a;
37
38 /*!
39 * ======== TimestampProvider ========
40 * ARMv8A TimestampProvider.
41 *
42 * The source of the timestamps is the ARMv8A core's internal
43 * PMC counter which counts CPU cycles.
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">
49 * </colgroup>
50 *
51 * <tr><th> Function </th><th> Hwi </th><th> Swi </th>
52 * <th> Task </th><th> Main </th><th> Startup </th></tr>
53 * <!-- -->
54 * <tr><td> {@link #get32} </td><td> Y </td><td> Y </td>
55 * <td> Y </td><td> Y </td><td> N </td></tr>
56 * <tr><td> {@link #get64} </td><td> Y </td><td> Y </td>
57 * <td> Y </td><td> Y </td><td> N </td></tr>
58 * <tr><td> {@link #getFreq} </td><td> Y </td><td> Y </td>
59 * <td> Y </td><td> Y </td><td> N </td></tr>
60 * <tr><td colspan="6"> Definitions: <br />
61 * <ul>
62 * <li> <b>Hwi</b>: API is callable from a Hwi thread. </li>
63 * <li> <b>Swi</b>: API is callable from a Swi thread. </li>
64 * <li> <b>Task</b>: API is callable from a Task thread. </li>
65 * <li> <b>Main</b>: API is callable during any of these phases: </li>
66 * <ul>
67 * <li> In your module startup after this module is started
68 * (e.g. TimestampProvider_Module_startupDone() returns TRUE). </li>
69 * <li> During xdc.runtime.Startup.lastFxns. </li>
70 * <li> During main().</li>
71 * <li> During BIOS.startupFxns.</li>
72 * </ul>
73 * <li> <b>Startup</b>: API is callable during any of these phases:</li>
74 * <ul>
75 * <li> During xdc.runtime.Startup.firstFxns.</li>
76 * <li> In your module startup before this module is started
77 * (e.g. TimestampProvider_Module_startupDone() returns FALSE).</li>
78 * </ul>
79 * </ul>
80 * </td></tr>
81 *
82 * </table>
83 * @p
84 */
85
86 @ModuleStartup
87
88 module TimestampProvider inherits ti.sysbios.interfaces.ITimestamp
89 {
90 /*! @_nodoc */
91 @XmlDtd
92 metaonly struct Module_View {
93 };
94
95 internal: /* not for client use */
96
97 /*
98 * initialize and start the CCNT performance monitor
99 */
100 Void initCCNT();
101
102 /*
103 * get 64bit timestamp
104 */
105 UInt64 get64I();
106 }