xref: /optee_os/core/include/kernel/tee_common.h (revision 216816c80b0213ff6b222a6e6ee733ac7faf7e7a)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2014, STMicroelectronics International N.V.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef TEE_COMMON_H
29 #define TEE_COMMON_H
30 
31 #include <stdlib.h>
32 
33 #ifdef MEASURE_TIME
34 /*
35  * Initializes mesaure time. Initializes RTT0 to highest possible
36  * resolution.
37  */
38 void tee_mtime_init(void);
39 
40 /*
41  * Adds a time stamp together the description. Note that only the pointer
42  * is copied, not the contents to minimize impact.
43  */
44 void tee_mtime_stamp(const char *descr);
45 
46 /*
47  * Prints a report of measured times and reinitializes clears the table of
48  * saved time stamps.
49  */
50 void tee_mtime_report(void);
51 
52 void tee_mtime_perftest(void);
53 #else
54 /* Empty macros to not have any impact on code when not meassuring time */
55 #define tee_mtime_init() do { } while (0)
56 #define tee_mtime_stamp(descr) do { } while (0)
57 #define tee_mtime_report() do { } while (0)
58 #define tee_mtime_perftest()  do { } while (0)
59 #endif
60 
61 #endif /* TEE_COMMON_H */
62