xref: /optee_os/lib/libutee/include/pta_gprof.h (revision 1bb929836182ecb96d2d9d268daa807c67596396)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2016, Linaro Limited
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 
29 #ifndef __PTA_GPROF_H
30 #define __PTA_GPROF_H
31 
32 /*
33  * Interface to the gprof pseudo-TA, which is used by libutee to control TA
34  * profiling and forward data to tee-supplicant.
35  */
36 
37 #define PTA_GPROF_UUID { 0x2f6e0d48, 0xc574, 0x426d, { \
38 			 0x82, 0x4e, 0x40, 0x19, 0x8c, 0xde, 0x5c, 0xac } }
39 
40 /*
41  * Send TA profiling data (gmon.out format) to tee-supplicant
42  * Data may be sent in several chunks: first set id to 0, then re-use the
43  * allocated value in subsequent calls.
44  *
45  * [in/out] value[0].a: id
46  * [in]     memref[1]: profiling data
47  */
48 #define PTA_GPROF_SEND			0
49 
50 /*
51  * Start PC sampling of a user TA session
52  *
53  * [in/out] memref[0]: sampling buffer
54  * [in]     value[1].a: offset: the lowest PC value in the TA
55  * [in]     value[1].b: scale: histogram scaling factor
56  */
57 #define PTA_GPROF_START_PC_SAMPLING	1
58 
59 /*
60  * Stop PC sampling of a user TA session and retrieve data
61  *
62  * [out] value[0].a: sampling frequency
63  */
64 #define PTA_GPROF_STOP_PC_SAMPLING	2
65 
66 #endif /* __PTA_GPROF_H */
67