O-RAN E Maintenance Release contribution for ODULOW
[o-du/phy.git] / fapi_5g / source / include / nr5g_fapi_log.h
1 /******************************************************************************
2 *
3 *   Copyright (c) 2019 Intel.
4 *
5 *   Licensed under the Apache License, Version 2.0 (the "License");
6 *   you may not use this file except in compliance with the License.
7 *   You may obtain a copy of the License at
8 *
9 *       http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *   Unless required by applicable law or agreed to in writing, software
12 *   distributed under the License is distributed on an "AS IS" BASIS,
13 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *   See the License for the specific language governing permissions and
15 *   limitations under the License.
16 *
17 *******************************************************************************/
18
19 /**
20  * @file This file consist of fapi logging macro.
21  *
22  **/
23
24 #ifndef NR5G_FAPI_LOG_H_
25 #define NR5G_FAPI_LOG_H_
26
27 #include <stdio.h>
28
29 #define NR5G_FAPI_STATS_FNAME "FapiStats.txt"
30
31 typedef enum _nr5g_fapi_log_types_t {
32     NONE_LOG = 0,
33     INFO_LOG,                    // default
34     DEBUG_LOG,
35     ERROR_LOG,
36     TRACE_LOG,
37 } nr5g_fapi_log_types_t;
38
39 extern nr5g_fapi_log_types_t nr5g_fapi_log_level_g;
40 // get_logger_type_str is utility function, returns logging lever string.
41 char *get_logger_type_str(
42     nr5g_fapi_log_types_t e);
43
44 void nr5g_fapi_set_log_level(
45     nr5g_fapi_log_types_t new_level);
46
47 nr5g_fapi_log_types_t nr5g_fapi_get_log_level(
48     );
49
50 // NR5G_FAPI__LOG utility Macro for logging.
51 #define NR5G_FAPI_LOG(TYPE, MSG) do { \
52     if(TYPE == ERROR_LOG) { \
53         printf("[%s]", get_logger_type_str(TYPE)); \
54         printf MSG ;\
55         printf("\n");\
56     }   \
57     else \
58     { \
59         if((nr5g_fapi_log_level_g > NONE_LOG) && (TYPE <= nr5g_fapi_log_level_g)) { \
60             printf("[%s]", get_logger_type_str(TYPE)); \
61             printf MSG ;\
62             printf("\n");\
63         }   \
64     } \
65 } while(0)
66
67 typedef struct _nr5g_fapi_performance_statistic {
68     uint64_t min_cycle;
69     uint64_t max_cycle;
70     uint64_t avg_cycle;
71     uint32_t count;
72 } nr5g_fapi_performance_statistic_t;
73
74 extern nr5g_fapi_log_types_t nr5g_fapi_log_level_g;
75 extern nr5g_fapi_performance_statistic_t fapi_statis_info_wls_get_dl;
76 extern nr5g_fapi_performance_statistic_t fapi_statis_info_parse_dl;
77 extern nr5g_fapi_performance_statistic_t fapi_statis_info_wls_send_dl;
78 extern nr5g_fapi_performance_statistic_t fapi_statis_info_wls_get_ul;
79 extern nr5g_fapi_performance_statistic_t fapi_statis_info_parse_ul;
80 extern nr5g_fapi_performance_statistic_t fapi_statis_info_wls_send_ul;
81 extern uint64_t tick_total_wls_get_per_tti_dl;
82 extern uint64_t tick_total_parse_per_tti_dl;
83 extern uint64_t tick_total_wls_send_per_tti_dl;
84 extern uint64_t tick_total_wls_get_per_tti_ul;
85 extern uint64_t tick_total_parse_per_tti_ul;
86 extern uint64_t tick_total_wls_send_per_tti_ul;
87 extern uint16_t g_statistic_start_flag;
88
89 uint16_t nr5g_fapi_statistic_info_set(
90     nr5g_fapi_performance_statistic_t * fapi_statis_info,
91     uint64_t * tick_val_in,
92     uint16_t start_flag);
93
94 uint16_t nr5g_fapi_statistic_info_init(
95     );
96
97 uint16_t nr5g_fapi_statistic_info_print(
98     );
99 uint16_t nr5g_fapi_statistic_info_set_all(
100     );
101
102 #endif                          // NR5G_FAPI_LOG_H_