hdcp_log.h

  1/*
  2 * Copyright 2019 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 MOD_HDCP_LOG_H_
 27#define MOD_HDCP_LOG_H_
 28
 29#define HDCP_LOG_ERR(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
 30#define HDCP_LOG_VER(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
 31#define HDCP_LOG_FSM(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
 32#define HDCP_LOG_TOP(hdcp, ...) pr_debug("[HDCP_TOP]:"__VA_ARGS__)
 33#define HDCP_LOG_DDC(hdcp, ...) pr_debug("[HDCP_DDC]:"__VA_ARGS__)
 34#define HDCP_LOG_TRA(hdcp) do {} while (0)
 35
 36/* default logs */
 37#define HDCP_ERROR_TRACE(hdcp, status) \
 38		HDCP_LOG_ERR(hdcp, \
 39			"[Link %d] WARNING %s IN STATE %s STAY COUNT %d", \
 40			hdcp->config.index, \
 41			mod_hdcp_status_to_str(status), \
 42			mod_hdcp_state_id_to_str(hdcp->state.id), \
 43			hdcp->state.stay_count)
 44#define HDCP_HDCP1_ENABLED_TRACE(hdcp, displayIndex) \
 45		HDCP_LOG_VER(hdcp, \
 46			"[Link %d] HDCP 1.4 enabled on display %d", \
 47			hdcp->config.index, displayIndex)
 48#define HDCP_HDCP2_ENABLED_TRACE(hdcp, displayIndex) \
 49		HDCP_LOG_VER(hdcp, \
 50			"[Link %d] HDCP 2.2 enabled on display %d", \
 51			hdcp->config.index, displayIndex)
 52#define HDCP_HDCP1_DISABLED_TRACE(hdcp, displayIndex) \
 53		HDCP_LOG_VER(hdcp, \
 54			"[Link %d] HDCP 1.4 disabled on display %d", \
 55			hdcp->config.index, displayIndex)
 56#define HDCP_HDCP2_DISABLED_TRACE(hdcp, displayIndex) \
 57		HDCP_LOG_VER(hdcp, \
 58			"[Link %d] HDCP 2.2 disabled on display %d", \
 59			hdcp->config.index, displayIndex)
 60
 61/* state machine logs */
 62#define HDCP_REMOVE_DISPLAY_TRACE(hdcp, displayIndex) \
 63		HDCP_LOG_FSM(hdcp, \
 64			"[Link %d] HDCP_REMOVE_DISPLAY index %d", \
 65			hdcp->config.index, displayIndex)
 66#define HDCP_INPUT_PASS_TRACE(hdcp, str) \
 67		HDCP_LOG_FSM(hdcp, \
 68			"[Link %d]\tPASS %s", \
 69			hdcp->config.index, str)
 70#define HDCP_INPUT_FAIL_TRACE(hdcp, str) \
 71		HDCP_LOG_FSM(hdcp, \
 72			"[Link %d]\tFAIL %s", \
 73			hdcp->config.index, str)
 74#define HDCP_NEXT_STATE_TRACE(hdcp, id, output) do { \
 75		if (output->watchdog_timer_needed) \
 76			HDCP_LOG_FSM(hdcp, \
 77				"[Link %d] > %s with %d ms watchdog", \
 78				hdcp->config.index, \
 79				mod_hdcp_state_id_to_str(id), output->watchdog_timer_delay); \
 80		else \
 81			HDCP_LOG_FSM(hdcp, \
 82				"[Link %d] > %s", hdcp->config.index, \
 83				mod_hdcp_state_id_to_str(id)); \
 84} while (0)
 85#define HDCP_TIMEOUT_TRACE(hdcp) \
 86		HDCP_LOG_FSM(hdcp, "[Link %d] --> TIMEOUT", hdcp->config.index)
 87#define HDCP_CPIRQ_TRACE(hdcp) \
 88		HDCP_LOG_FSM(hdcp, "[Link %d] --> CPIRQ", hdcp->config.index)
 89#define HDCP_EVENT_TRACE(hdcp, event) \
 90		do { \
 91			if (event == MOD_HDCP_EVENT_WATCHDOG_TIMEOUT) \
 92				HDCP_TIMEOUT_TRACE(hdcp); \
 93			else if (event == MOD_HDCP_EVENT_CPIRQ) \
 94				HDCP_CPIRQ_TRACE(hdcp);	\
 95		} while (0)
 96/* TODO: find some way to tell if logging is off to save time */
 97#define HDCP_DDC_READ_TRACE(hdcp, msg_name, msg, msg_size) do { \
 98		mod_hdcp_dump_binary_message(msg, msg_size, hdcp->buf, \
 99				sizeof(hdcp->buf)); \
100		HDCP_LOG_DDC(hdcp, "[Link %d] Read %s%s", hdcp->config.index, \
101				msg_name, hdcp->buf); \
102} while (0)
103#define HDCP_DDC_WRITE_TRACE(hdcp, msg_name, msg, msg_size) do { \
104		mod_hdcp_dump_binary_message(msg, msg_size, hdcp->buf, \
105				sizeof(hdcp->buf)); \
106		HDCP_LOG_DDC(hdcp, "[Link %d] Write %s%s", \
107				hdcp->config.index, msg_name,\
108				hdcp->buf); \
109} while (0)
110#define HDCP_TOP_ADD_DISPLAY_TRACE(hdcp, i) \
111		HDCP_LOG_TOP(hdcp, "[Link %d]\tadd display %d", \
112				hdcp->config.index, i)
113#define HDCP_TOP_REMOVE_DISPLAY_TRACE(hdcp, i) \
114		HDCP_LOG_TOP(hdcp, "[Link %d]\tremove display %d", \
115				hdcp->config.index, i)
116#define HDCP_TOP_HDCP1_DESTROY_SESSION_TRACE(hdcp) \
117		HDCP_LOG_TOP(hdcp, "[Link %d]\tdestroy hdcp1 session", \
118				hdcp->config.index)
119#define HDCP_TOP_HDCP2_DESTROY_SESSION_TRACE(hdcp) \
120		HDCP_LOG_TOP(hdcp, "[Link %d]\tdestroy hdcp2 session", \
121				hdcp->config.index)
122#define HDCP_TOP_RESET_AUTH_TRACE(hdcp) \
123		HDCP_LOG_TOP(hdcp, "[Link %d]\treset authentication", hdcp->config.index)
124#define HDCP_TOP_RESET_CONN_TRACE(hdcp) \
125		HDCP_LOG_TOP(hdcp, "[Link %d]\treset connection", hdcp->config.index)
126#define HDCP_TOP_INTERFACE_TRACE(hdcp) do { \
127		HDCP_LOG_TOP(hdcp, "\n"); \
128		HDCP_LOG_TOP(hdcp, "[Link %d] %s", hdcp->config.index, __func__); \
129} while (0)
130#define HDCP_TOP_INTERFACE_TRACE_WITH_INDEX(hdcp, i) do { \
131		HDCP_LOG_TOP(hdcp, "\n"); \
132		HDCP_LOG_TOP(hdcp, "[Link %d] %s display %d", hdcp->config.index, __func__, i); \
133} while (0)
134
135#define HDCP_AUTH_COMPLETE_TRACE(hdcp) do { \
136		mod_hdcp_log_ddc_trace(hdcp); \
137		HDCP_LOG_TRA(hdcp); \
138} while (0)
139
140#endif // MOD_HDCP_LOG_H_