modules/hdcp/hdcp_log.h

0001 /*
0002  * Copyright 2019 Advanced Micro Devices, Inc.
0003  *
0004  * Permission is hereby granted, free of charge, to any person obtaining a
0005  * copy of this software and associated documentation files (the "Software"),
0006  * to deal in the Software without restriction, including without limitation
0007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
0008  * and/or sell copies of the Software, and to permit persons to whom the
0009  * Software is furnished to do so, subject to the following conditions:
0010  *
0011  * The above copyright notice and this permission notice shall be included in
0012  * all copies or substantial portions of the Software.
0013  *
0014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
0017  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
0018  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
0019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
0020  * OTHER DEALINGS IN THE SOFTWARE.
0021  *
0022  * Authors: AMD
0023  *
0024  */
0025
0026 #ifndef MOD_HDCP_LOG_H_
0027 #define MOD_HDCP_LOG_H_
0028
0029 #ifdef CONFIG_DRM_AMD_DC_HDCP
0030 #define HDCP_LOG_ERR(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
0031 #define HDCP_LOG_VER(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
0032 #define HDCP_LOG_FSM(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
0033 #define HDCP_LOG_TOP(hdcp, ...) pr_debug("[HDCP_TOP]:"__VA_ARGS__)
0034 #define HDCP_LOG_DDC(hdcp, ...) pr_debug("[HDCP_DDC]:"__VA_ARGS__)
0035 #endif
0036
0037 /* default logs */
0038 #define HDCP_ERROR_TRACE(hdcp, status) \
0039         HDCP_LOG_ERR(hdcp, \
0040             "[Link %d] WARNING %s IN STATE %s STAY COUNT %d", \
0041             hdcp->config.index, \
0042             mod_hdcp_status_to_str(status), \
0043             mod_hdcp_state_id_to_str(hdcp->state.id), \
0044             hdcp->state.stay_count)
0045 #define HDCP_HDCP1_ENABLED_TRACE(hdcp, displayIndex) \
0046         HDCP_LOG_VER(hdcp, \
0047             "[Link %d] HDCP 1.4 enabled on display %d", \
0048             hdcp->config.index, displayIndex)
0049 #define HDCP_HDCP2_ENABLED_TRACE(hdcp, displayIndex) \
0050         HDCP_LOG_VER(hdcp, \
0051             "[Link %d] HDCP 2.2 enabled on display %d", \
0052             hdcp->config.index, displayIndex)
0053 #define HDCP_HDCP1_DISABLED_TRACE(hdcp, displayIndex) \
0054         HDCP_LOG_VER(hdcp, \
0055             "[Link %d] HDCP 1.4 disabled on display %d", \
0056             hdcp->config.index, displayIndex)
0057 #define HDCP_HDCP2_DISABLED_TRACE(hdcp, displayIndex) \
0058         HDCP_LOG_VER(hdcp, \
0059             "[Link %d] HDCP 2.2 disabled on display %d", \
0060             hdcp->config.index, displayIndex)
0061
0062 /* state machine logs */
0063 #define HDCP_REMOVE_DISPLAY_TRACE(hdcp, displayIndex) \
0064         HDCP_LOG_FSM(hdcp, \
0065             "[Link %d] HDCP_REMOVE_DISPLAY index %d", \
0066             hdcp->config.index, displayIndex)
0067 #define HDCP_INPUT_PASS_TRACE(hdcp, str) \
0068         HDCP_LOG_FSM(hdcp, \
0069             "[Link %d]\tPASS %s", \
0070             hdcp->config.index, str)
0071 #define HDCP_INPUT_FAIL_TRACE(hdcp, str) \
0072         HDCP_LOG_FSM(hdcp, \
0073             "[Link %d]\tFAIL %s", \
0074             hdcp->config.index, str)
0075 #define HDCP_NEXT_STATE_TRACE(hdcp, id, output) do { \
0076         if (output->watchdog_timer_needed) \
0077             HDCP_LOG_FSM(hdcp, \
0078                 "[Link %d] > %s with %d ms watchdog", \
0079                 hdcp->config.index, \
0080                 mod_hdcp_state_id_to_str(id), output->watchdog_timer_delay); \
0081         else \
0082             HDCP_LOG_FSM(hdcp, \
0083                 "[Link %d] > %s", hdcp->config.index, \
0084                 mod_hdcp_state_id_to_str(id)); \
0085 } while (0)
0086 #define HDCP_TIMEOUT_TRACE(hdcp) \
0087         HDCP_LOG_FSM(hdcp, "[Link %d] --> TIMEOUT", hdcp->config.index)
0088 #define HDCP_CPIRQ_TRACE(hdcp) \
0089         HDCP_LOG_FSM(hdcp, "[Link %d] --> CPIRQ", hdcp->config.index)
0090 #define HDCP_EVENT_TRACE(hdcp, event) \
0091         if (event == MOD_HDCP_EVENT_WATCHDOG_TIMEOUT) \
0092             HDCP_TIMEOUT_TRACE(hdcp); \
0093         else if (event == MOD_HDCP_EVENT_CPIRQ) \
0094             HDCP_CPIRQ_TRACE(hdcp)
0095 /* TODO: find some way to tell if logging is off to save time */
0096 #define HDCP_DDC_READ_TRACE(hdcp, msg_name, msg, msg_size) do { \
0097         mod_hdcp_dump_binary_message(msg, msg_size, hdcp->buf, \
0098                 sizeof(hdcp->buf)); \
0099         HDCP_LOG_DDC(hdcp, "[Link %d] Read %s%s", hdcp->config.index, \
0100                 msg_name, hdcp->buf); \
0101 } while (0)
0102 #define HDCP_DDC_WRITE_TRACE(hdcp, msg_name, msg, msg_size) do { \
0103         mod_hdcp_dump_binary_message(msg, msg_size, hdcp->buf, \
0104                 sizeof(hdcp->buf)); \
0105         HDCP_LOG_DDC(hdcp, "[Link %d] Write %s%s", \
0106                 hdcp->config.index, msg_name,\
0107                 hdcp->buf); \
0108 } while (0)
0109 #define HDCP_TOP_ADD_DISPLAY_TRACE(hdcp, i) \
0110         HDCP_LOG_TOP(hdcp, "[Link %d]\tadd display %d", \
0111                 hdcp->config.index, i)
0112 #define HDCP_TOP_REMOVE_DISPLAY_TRACE(hdcp, i) \
0113         HDCP_LOG_TOP(hdcp, "[Link %d]\tremove display %d", \
0114                 hdcp->config.index, i)
0115 #define HDCP_TOP_HDCP1_DESTROY_SESSION_TRACE(hdcp) \
0116         HDCP_LOG_TOP(hdcp, "[Link %d]\tdestroy hdcp1 session", \
0117                 hdcp->config.index)
0118 #define HDCP_TOP_HDCP2_DESTROY_SESSION_TRACE(hdcp) \
0119         HDCP_LOG_TOP(hdcp, "[Link %d]\tdestroy hdcp2 session", \
0120                 hdcp->config.index)
0121 #define HDCP_TOP_RESET_AUTH_TRACE(hdcp) \
0122         HDCP_LOG_TOP(hdcp, "[Link %d]\treset authentication", hdcp->config.index)
0123 #define HDCP_TOP_RESET_CONN_TRACE(hdcp) \
0124         HDCP_LOG_TOP(hdcp, "[Link %d]\treset connection", hdcp->config.index)
0125 #define HDCP_TOP_INTERFACE_TRACE(hdcp) do { \
0126         HDCP_LOG_TOP(hdcp, "\n"); \
0127         HDCP_LOG_TOP(hdcp, "[Link %d] %s", hdcp->config.index, __func__); \
0128 } while (0)
0129 #define HDCP_TOP_INTERFACE_TRACE_WITH_INDEX(hdcp, i) do { \
0130         HDCP_LOG_TOP(hdcp, "\n"); \
0131         HDCP_LOG_TOP(hdcp, "[Link %d] %s display %d", hdcp->config.index, __func__, i); \
0132 } while (0)
0133
0134 #endif // MOD_HDCP_LOG_H_