xref: /linux/drivers/gpu/drm/amd/display/include/logger_interface.h (revision 26ba4e5738a544aa17c462bfbe580e74071c810b)
1  /*
2   * Copyright 2012-15 Advanced Micro Devices, Inc.
3   *
4   * Permission is hereby granted, free of charge, to any person obtaining a
5   * copy of this software and associated documentation files (the "Software"),
6   * to deal in the Software without restriction, including without limitation
7   * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8   * and/or sell copies of the Software, and to permit persons to whom the
9   * Software is furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17   * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18   * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19   * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20   * OTHER DEALINGS IN THE SOFTWARE.
21   *
22   * Authors: AMD
23   *
24   */
25  
26  #ifndef __DAL_LOGGER_INTERFACE_H__
27  #define __DAL_LOGGER_INTERFACE_H__
28  
29  #include "logger_types.h"
30  
31  struct dc_context;
32  struct dc_link;
33  struct dc_surface_update;
34  struct resource_context;
35  struct dc_state;
36  
37  /*
38   *
39   * DAL logger functionality
40   *
41   */
42  
43  void dc_conn_log_hex_linux(const uint8_t *hex_data, int hex_data_count);
44  
45  void pre_surface_trace(
46  		struct dc *dc,
47  		const struct dc_plane_state *const *plane_states,
48  		int surface_count);
49  
50  void update_surface_trace(
51  		struct dc *dc,
52  		const struct dc_surface_update *updates,
53  		int surface_count);
54  
55  void post_surface_trace(struct dc *dc);
56  
57  void context_timing_trace(
58  		struct dc *dc,
59  		struct resource_context *res_ctx);
60  
61  void context_clock_trace(
62  		struct dc *dc,
63  		struct dc_state *context);
64  
65  /* Any function which is empty or have incomplete implementation should be
66   * marked by this macro.
67   * Note that the message will be printed exactly once for every function
68   * it is used in order to avoid repeating of the same message. */
69  
70  #define DAL_LOGGER_NOT_IMPL(fmt, ...) \
71  	do { \
72  		static bool print_not_impl = true; \
73  		if (print_not_impl == true) { \
74  			print_not_impl = false; \
75  			DRM_WARN("DAL_NOT_IMPL: " fmt, ##__VA_ARGS__); \
76  		} \
77  	} while (0)
78  
79  /******************************************************************************
80   * Convenience macros to save on typing.
81   *****************************************************************************/
82  
83  #define DC_ERROR(...) \
84  		do { \
85  			(void)(dc_ctx); \
86  			DC_LOG_ERROR(__VA_ARGS__); \
87  		} while (0)
88  
89  #define DC_SYNC_INFO(...) \
90  		do { \
91  			(void)(dc_ctx); \
92  			DC_LOG_SYNC(__VA_ARGS__); \
93  		} while (0)
94  
95  /* Connectivity log format:
96   * [time stamp]   [drm] [Major_minor] [connector name] message.....
97   * eg:
98   * [   26.590965] [drm] [Conn_LKTN]	  [DP-1] HBRx4 pass VS=0, PE=0^
99   * [   26.881060] [drm] [Conn_Mode]	  [DP-1] {2560x1080, 2784x1111@185580Khz}^
100   */
101  
102  #define CONN_DATA_DETECT(link, hex_data, hex_len, ...) \
103  		do { \
104  			(void)(link); \
105  			dc_conn_log_hex_linux(hex_data, hex_len); \
106  			DC_LOG_EVENT_DETECTION(__VA_ARGS__); \
107  		} while (0)
108  
109  #define CONN_DATA_LINK_LOSS(link, hex_data, hex_len, ...) \
110  		do { \
111  			(void)(link); \
112  			dc_conn_log_hex_linux(hex_data, hex_len); \
113  			DC_LOG_EVENT_LINK_LOSS(__VA_ARGS__); \
114  		} while (0)
115  
116  #define CONN_MSG_LT(link, ...) \
117  		do { \
118  			(void)(link); \
119  			DC_LOG_EVENT_LINK_TRAINING(__VA_ARGS__); \
120  		} while (0)
121  
122  #define CONN_MSG_MODE(link, ...) \
123  		do { \
124  			(void)(link); \
125  			DC_LOG_EVENT_MODE_SET(__VA_ARGS__); \
126  		} while (0)
127  
128  /*
129   * Display Test Next logging
130   */
131  #define DTN_INFO_BEGIN() \
132  	dm_dtn_log_begin(dc_ctx, log_ctx)
133  
134  #define DTN_INFO(msg, ...) \
135  	dm_dtn_log_append_v(dc_ctx, log_ctx, msg, ##__VA_ARGS__)
136  
137  #define DTN_INFO_END() \
138  	dm_dtn_log_end(dc_ctx, log_ctx)
139  
140  #define PERFORMANCE_TRACE_START() \
141  	unsigned long long perf_trc_start_stmp = dm_get_timestamp(dc->ctx)
142  
143  #define PERFORMANCE_TRACE_END() \
144  	do { \
145  		unsigned long long perf_trc_end_stmp = dm_get_timestamp(dc->ctx); \
146  		if (dc->debug.performance_trace) { \
147  			DC_LOG_PERF_TRACE("%s duration: %lld ticks\n", __func__, \
148  				perf_trc_end_stmp - perf_trc_start_stmp); \
149  		} \
150  	} while (0)
151  
152  #define DISPLAY_STATS_BEGIN(entry) (void)(entry)
153  
154  #define DISPLAY_STATS(msg, ...) DC_LOG_PERF_TRACE(msg, __VA_ARGS__)
155  
156  #define DISPLAY_STATS_END(entry) (void)(entry)
157  
158  #define LOG_GAMMA_WRITE(msg, ...)
159  
160  #endif /* __DAL_LOGGER_INTERFACE_H__ */
161