xref: /openbmc/linux/drivers/gpu/drm/amd/display/modules/hdcp/hdcp_log.h (revision 15a1fbdcfb519c2bd291ed01c6c94e0b89537a77)
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 #ifdef CONFIG_DRM_AMD_DC_HDCP
30 #define HDCP_LOG_ERR(hdcp, ...) DRM_WARN(__VA_ARGS__)
31 #define HDCP_LOG_VER(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
32 #define HDCP_LOG_FSM(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
33 #define HDCP_LOG_TOP(hdcp, ...) pr_debug("[HDCP_TOP]:"__VA_ARGS__)
34 #define HDCP_LOG_DDC(hdcp, ...) pr_debug("[HDCP_DDC]:"__VA_ARGS__)
35 #endif
36 
37 /* default logs */
38 #define HDCP_ERROR_TRACE(hdcp, status) \
39 		HDCP_LOG_ERR(hdcp, \
40 			"[Link %d] WARNING %s IN STATE %s", \
41 			hdcp->config.index, \
42 			mod_hdcp_status_to_str(status), \
43 			mod_hdcp_state_id_to_str(hdcp->state.id))
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 		if (event == MOD_HDCP_EVENT_WATCHDOG_TIMEOUT) \
91 			HDCP_TIMEOUT_TRACE(hdcp); \
92 		else if (event == MOD_HDCP_EVENT_CPIRQ) \
93 			HDCP_CPIRQ_TRACE(hdcp)
94 /* TODO: find some way to tell if logging is off to save time */
95 #define HDCP_DDC_READ_TRACE(hdcp, msg_name, msg, msg_size) do { \
96 		mod_hdcp_dump_binary_message(msg, msg_size, hdcp->buf, \
97 				sizeof(hdcp->buf)); \
98 		HDCP_LOG_DDC(hdcp, "[Link %d] Read %s%s", hdcp->config.index, \
99 				msg_name, hdcp->buf); \
100 } while (0)
101 #define HDCP_DDC_WRITE_TRACE(hdcp, msg_name, msg, msg_size) do { \
102 		mod_hdcp_dump_binary_message(msg, msg_size, hdcp->buf, \
103 				sizeof(hdcp->buf)); \
104 		HDCP_LOG_DDC(hdcp, "[Link %d] Write %s%s", \
105 				hdcp->config.index, msg_name,\
106 				hdcp->buf); \
107 } while (0)
108 #define HDCP_FULL_DDC_TRACE(hdcp) do { \
109 	if (is_hdcp1(hdcp)) { \
110 		HDCP_DDC_READ_TRACE(hdcp, "BKSV", hdcp->auth.msg.hdcp1.bksv, \
111 				sizeof(hdcp->auth.msg.hdcp1.bksv)); \
112 		HDCP_DDC_READ_TRACE(hdcp, "BCAPS", &hdcp->auth.msg.hdcp1.bcaps, \
113 				sizeof(hdcp->auth.msg.hdcp1.bcaps)); \
114 		HDCP_DDC_WRITE_TRACE(hdcp, "AN", hdcp->auth.msg.hdcp1.an, \
115 				sizeof(hdcp->auth.msg.hdcp1.an)); \
116 		HDCP_DDC_WRITE_TRACE(hdcp, "AKSV", hdcp->auth.msg.hdcp1.aksv, \
117 				sizeof(hdcp->auth.msg.hdcp1.aksv)); \
118 		HDCP_DDC_WRITE_TRACE(hdcp, "AINFO", &hdcp->auth.msg.hdcp1.ainfo, \
119 				sizeof(hdcp->auth.msg.hdcp1.ainfo)); \
120 		HDCP_DDC_READ_TRACE(hdcp, "RI' / R0'", \
121 				(uint8_t *)&hdcp->auth.msg.hdcp1.r0p, \
122 				sizeof(hdcp->auth.msg.hdcp1.r0p)); \
123 		HDCP_DDC_READ_TRACE(hdcp, "BINFO", \
124 				(uint8_t *)&hdcp->auth.msg.hdcp1.binfo_dp, \
125 				sizeof(hdcp->auth.msg.hdcp1.binfo_dp)); \
126 		HDCP_DDC_READ_TRACE(hdcp, "KSVLIST", hdcp->auth.msg.hdcp1.ksvlist, \
127 				hdcp->auth.msg.hdcp1.ksvlist_size); \
128 		HDCP_DDC_READ_TRACE(hdcp, "V'", hdcp->auth.msg.hdcp1.vp, \
129 				sizeof(hdcp->auth.msg.hdcp1.vp)); \
130 	} else { \
131 		HDCP_DDC_READ_TRACE(hdcp, "HDCP2Version", \
132 				&hdcp->auth.msg.hdcp2.hdcp2version_hdmi, \
133 				sizeof(hdcp->auth.msg.hdcp2.hdcp2version_hdmi)); \
134 		HDCP_DDC_READ_TRACE(hdcp, "Rx Caps", hdcp->auth.msg.hdcp2.rxcaps_dp, \
135 				sizeof(hdcp->auth.msg.hdcp2.rxcaps_dp)); \
136 		HDCP_DDC_WRITE_TRACE(hdcp, "AKE Init", hdcp->auth.msg.hdcp2.ake_init, \
137 				sizeof(hdcp->auth.msg.hdcp2.ake_init)); \
138 		HDCP_DDC_READ_TRACE(hdcp, "AKE Cert", hdcp->auth.msg.hdcp2.ake_cert, \
139 				sizeof(hdcp->auth.msg.hdcp2.ake_cert)); \
140 		HDCP_DDC_WRITE_TRACE(hdcp, "Stored KM", \
141 				hdcp->auth.msg.hdcp2.ake_stored_km, \
142 				sizeof(hdcp->auth.msg.hdcp2.ake_stored_km)); \
143 		HDCP_DDC_WRITE_TRACE(hdcp, "No Stored KM", \
144 				hdcp->auth.msg.hdcp2.ake_no_stored_km, \
145 				sizeof(hdcp->auth.msg.hdcp2.ake_no_stored_km)); \
146 		HDCP_DDC_READ_TRACE(hdcp, "H'", hdcp->auth.msg.hdcp2.ake_h_prime, \
147 				sizeof(hdcp->auth.msg.hdcp2.ake_h_prime)); \
148 		HDCP_DDC_READ_TRACE(hdcp, "Pairing Info", \
149 				hdcp->auth.msg.hdcp2.ake_pairing_info, \
150 				sizeof(hdcp->auth.msg.hdcp2.ake_pairing_info)); \
151 		HDCP_DDC_WRITE_TRACE(hdcp, "LC Init", hdcp->auth.msg.hdcp2.lc_init, \
152 				sizeof(hdcp->auth.msg.hdcp2.lc_init)); \
153 		HDCP_DDC_READ_TRACE(hdcp, "L'", hdcp->auth.msg.hdcp2.lc_l_prime, \
154 				sizeof(hdcp->auth.msg.hdcp2.lc_l_prime)); \
155 		HDCP_DDC_WRITE_TRACE(hdcp, "Exchange KS", hdcp->auth.msg.hdcp2.ske_eks, \
156 				sizeof(hdcp->auth.msg.hdcp2.ske_eks)); \
157 		HDCP_DDC_READ_TRACE(hdcp, "Rx Status", \
158 				(uint8_t *)&hdcp->auth.msg.hdcp2.rxstatus, \
159 				sizeof(hdcp->auth.msg.hdcp2.rxstatus)); \
160 		HDCP_DDC_READ_TRACE(hdcp, "Rx Id List", \
161 				hdcp->auth.msg.hdcp2.rx_id_list, \
162 				hdcp->auth.msg.hdcp2.rx_id_list_size); \
163 		HDCP_DDC_WRITE_TRACE(hdcp, "Rx Id List Ack", \
164 				hdcp->auth.msg.hdcp2.repeater_auth_ack, \
165 				sizeof(hdcp->auth.msg.hdcp2.repeater_auth_ack)); \
166 		HDCP_DDC_WRITE_TRACE(hdcp, "Content Stream Management", \
167 				hdcp->auth.msg.hdcp2.repeater_auth_stream_manage, \
168 				hdcp->auth.msg.hdcp2.stream_manage_size); \
169 		HDCP_DDC_READ_TRACE(hdcp, "Stream Ready", \
170 				hdcp->auth.msg.hdcp2.repeater_auth_stream_ready, \
171 				sizeof(hdcp->auth.msg.hdcp2.repeater_auth_stream_ready)); \
172 		HDCP_DDC_WRITE_TRACE(hdcp, "Content Stream Type", \
173 				hdcp->auth.msg.hdcp2.content_stream_type_dp, \
174 				sizeof(hdcp->auth.msg.hdcp2.content_stream_type_dp)); \
175 	} \
176 } while (0)
177 #define HDCP_TOP_ADD_DISPLAY_TRACE(hdcp, i) \
178 		HDCP_LOG_TOP(hdcp, "[Link %d]\tadd display %d", \
179 				hdcp->config.index, i)
180 #define HDCP_TOP_REMOVE_DISPLAY_TRACE(hdcp, i) \
181 		HDCP_LOG_TOP(hdcp, "[Link %d]\tremove display %d", \
182 				hdcp->config.index, i)
183 #define HDCP_TOP_HDCP1_DESTROY_SESSION_TRACE(hdcp) \
184 		HDCP_LOG_TOP(hdcp, "[Link %d]\tdestroy hdcp1 session", \
185 				hdcp->config.index)
186 #define HDCP_TOP_HDCP2_DESTROY_SESSION_TRACE(hdcp) \
187 		HDCP_LOG_TOP(hdcp, "[Link %d]\tdestroy hdcp2 session", \
188 				hdcp->config.index)
189 #define HDCP_TOP_RESET_AUTH_TRACE(hdcp) \
190 		HDCP_LOG_TOP(hdcp, "[Link %d]\treset authentication", hdcp->config.index)
191 #define HDCP_TOP_RESET_CONN_TRACE(hdcp) \
192 		HDCP_LOG_TOP(hdcp, "[Link %d]\treset connection", hdcp->config.index)
193 #define HDCP_TOP_INTERFACE_TRACE(hdcp) do { \
194 		HDCP_LOG_TOP(hdcp, "\n"); \
195 		HDCP_LOG_TOP(hdcp, "[Link %d] %s", hdcp->config.index, __func__); \
196 } while (0)
197 #define HDCP_TOP_INTERFACE_TRACE_WITH_INDEX(hdcp, i) do { \
198 		HDCP_LOG_TOP(hdcp, "\n"); \
199 		HDCP_LOG_TOP(hdcp, "[Link %d] %s display %d", hdcp->config.index, __func__, i); \
200 } while (0)
201 
202 #endif // MOD_HDCP_LOG_H_
203