logger_interface.h

  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
 31struct dc_context;
 32struct dc_link;
 33struct dc_surface_update;
 34struct resource_context;
 35struct dc_state;
 36
 37/*
 38 *
 39 * DAL logger functionality
 40 *
 41 */
 42
 43void update_surface_trace(
 44		struct dc *dc,
 45		const struct dc_surface_update *updates,
 46		int surface_count);
 47
 48void post_surface_trace(struct dc *dc);
 49
 50void context_clock_trace(
 51		struct dc *dc,
 52		struct dc_state *context);
 53
 54/* Any function which is empty or have incomplete implementation should be
 55 * marked by this macro.
 56 * Note that the message will be printed exactly once for every function
 57 * it is used in order to avoid repeating of the same message. */
 58
 59#define DAL_LOGGER_NOT_IMPL(fmt, ...) \
 60	do { \
 61		static bool print_not_impl = true; \
 62		if (print_not_impl == true) { \
 63			print_not_impl = false; \
 64			DRM_WARN("DAL_NOT_IMPL: " fmt, ##__VA_ARGS__); \
 65		} \
 66	} while (0)
 67
 68/******************************************************************************
 69 * Convenience macros to save on typing.
 70 *****************************************************************************/
 71
 72#define DC_ERROR(...) \
 73		do { \
 74			(void)(dc_ctx); \
 75			DC_LOG_ERROR(__VA_ARGS__); \
 76		} while (0)
 77
 78#define DC_SYNC_INFO(...) \
 79		do { \
 80			(void)(dc_ctx); \
 81			DC_LOG_SYNC(__VA_ARGS__); \
 82		} while (0)
 83
 84/* Connectivity log format:
 85 * [time stamp]   [drm] [Major_minor] [connector name] message.....
 86 * eg:
 87 * [   26.590965] [drm] [Conn_LKTN]	  [DP-1] HBRx4 pass VS=0, PE=0^
 88 * [   26.881060] [drm] [Conn_Mode]	  [DP-1] {2560x1080, 2784x1111@185580Khz}^
 89 */
 90
 91#define CONN_DATA_DETECT(link, hex_data, hex_len, ...) \
 92		do { \
 93			(void)(link); \
 94			DC_LOG_EVENT_DETECTION(__VA_ARGS__); \
 95		} while (0)
 96
 97#define CONN_DATA_LINK_LOSS(link, hex_data, hex_len, ...) \
 98		do { \
 99			(void)(link); \
100			DC_LOG_EVENT_LINK_LOSS(__VA_ARGS__); \
101		} while (0)
102
103#define CONN_MSG_LT(link, ...) \
104		do { \
105			(void)(link); \
106			DC_LOG_EVENT_LINK_TRAINING(__VA_ARGS__); \
107		} while (0)
108
109#define CONN_MSG_MODE(link, ...) \
110		do { \
111			(void)(link); \
112			DC_LOG_EVENT_MODE_SET(__VA_ARGS__); \
113		} while (0)
114
115/*
116 * Display Test Next logging
117 */
118#define DTN_INFO_BEGIN() \
119	dm_dtn_log_begin(dc_ctx, log_ctx)
120
121#define DTN_INFO(msg, ...) \
122	dm_dtn_log_append_v(dc_ctx, log_ctx, msg, ##__VA_ARGS__)
123
124#define DTN_INFO_END() \
125	dm_dtn_log_end(dc_ctx, log_ctx)
126
127#define PERFORMANCE_TRACE_START() \
128	unsigned long long perf_trc_start_stmp = dm_get_timestamp(dc->ctx)
129
130#define PERFORMANCE_TRACE_END() \
131	do { \
132		unsigned long long perf_trc_end_stmp = dm_get_timestamp(dc->ctx); \
133		if (dc->debug.performance_trace) { \
134			DC_LOG_PERF_TRACE("%s duration: %lld ticks\n", __func__, \
135				perf_trc_end_stmp - perf_trc_start_stmp); \
136		} \
137	} while (0)
138
139#define DISPLAY_STATS_BEGIN(entry) (void)(entry)
140
141#define DISPLAY_STATS(msg, ...) DC_LOG_PERF_TRACE(msg, __VA_ARGS__)
142
143#define DISPLAY_STATS_END(entry) (void)(entry)
144
145#define LOG_GAMMA_WRITE(msg, ...)
146
147#endif /* __DAL_LOGGER_INTERFACE_H__ */