xref: /netbsd-src/sys/external/bsd/drm2/dist/drm/amd/display/modules/hdcp/hdcp_log.h (revision 41ec02673d281bbb3d38e6c78504ce6e30c228c1)
1 /*	$NetBSD: hdcp_log.h,v 1.2 2021/12/18 23:45:07 riastradh Exp $	*/
2 
3 /*
4  * Copyright 2019 Advanced Micro Devices, Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * Authors: AMD
25  *
26  */
27 
28 #ifndef MOD_HDCP_LOG_H_
29 #define MOD_HDCP_LOG_H_
30 
31 #ifdef CONFIG_DRM_AMD_DC_HDCP
32 #define HDCP_LOG_ERR(hdcp, ...) DRM_WARN(__VA_ARGS__)
33 #define HDCP_LOG_VER(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
34 #define HDCP_LOG_FSM(hdcp, ...) DRM_DEBUG_KMS(__VA_ARGS__)
35 #define HDCP_LOG_TOP(hdcp, ...) pr_debug("[HDCP_TOP]:"__VA_ARGS__)
36 #define HDCP_LOG_DDC(hdcp, ...) pr_debug("[HDCP_DDC]:"__VA_ARGS__)
37 #endif
38 
39 /* default logs */
40 #define HDCP_ERROR_TRACE(hdcp, status) \
41 		HDCP_LOG_ERR(hdcp, \
42 			"[Link %d] WARNING %s IN STATE %s", \
43 			hdcp->config.index, \
44 			mod_hdcp_status_to_str(status), \
45 			mod_hdcp_state_id_to_str(hdcp->state.id))
46 #define HDCP_HDCP1_ENABLED_TRACE(hdcp, displayIndex) \
47 		HDCP_LOG_VER(hdcp, \
48 			"[Link %d] HDCP 1.4 enabled on display %d", \
49 			hdcp->config.index, displayIndex)
50 #define HDCP_HDCP2_ENABLED_TRACE(hdcp, displayIndex) \
51 		HDCP_LOG_VER(hdcp, \
52 			"[Link %d] HDCP 2.2 enabled on display %d", \
53 			hdcp->config.index, displayIndex)
54 /* state machine logs */
55 #define HDCP_REMOVE_DISPLAY_TRACE(hdcp, displayIndex) \
56 		HDCP_LOG_FSM(hdcp, \
57 			"[Link %d] HDCP_REMOVE_DISPLAY index %d", \
58 			hdcp->config.index, displayIndex)
59 #define HDCP_INPUT_PASS_TRACE(hdcp, str) \
60 		HDCP_LOG_FSM(hdcp, \
61 			"[Link %d]\tPASS %s", \
62 			hdcp->config.index, str)
63 #define HDCP_INPUT_FAIL_TRACE(hdcp, str) \
64 		HDCP_LOG_FSM(hdcp, \
65 			"[Link %d]\tFAIL %s", \
66 			hdcp->config.index, str)
67 #define HDCP_NEXT_STATE_TRACE(hdcp, id, output) do { \
68 		if (output->watchdog_timer_needed) \
69 			HDCP_LOG_FSM(hdcp, \
70 				"[Link %d] > %s with %d ms watchdog", \
71 				hdcp->config.index, \
72 				mod_hdcp_state_id_to_str(id), output->watchdog_timer_delay); \
73 		else \
74 			HDCP_LOG_FSM(hdcp, \
75 				"[Link %d] > %s", hdcp->config.index, \
76 				mod_hdcp_state_id_to_str(id)); \
77 } while (0)
78 #define HDCP_TIMEOUT_TRACE(hdcp) \
79 		HDCP_LOG_FSM(hdcp, "[Link %d] --> TIMEOUT", hdcp->config.index)
80 #define HDCP_CPIRQ_TRACE(hdcp) \
81 		HDCP_LOG_FSM(hdcp, "[Link %d] --> CPIRQ", hdcp->config.index)
82 #define HDCP_EVENT_TRACE(hdcp, event) \
83 		if (event == MOD_HDCP_EVENT_WATCHDOG_TIMEOUT) \
84 			HDCP_TIMEOUT_TRACE(hdcp); \
85 		else if (event == MOD_HDCP_EVENT_CPIRQ) \
86 			HDCP_CPIRQ_TRACE(hdcp)
87 /* TODO: find some way to tell if logging is off to save time */
88 #define HDCP_DDC_READ_TRACE(hdcp, msg_name, msg, msg_size) do { \
89 		mod_hdcp_dump_binary_message(msg, msg_size, hdcp->buf, \
90 				sizeof(hdcp->buf)); \
91 		HDCP_LOG_DDC(hdcp, "[Link %d] Read %s%s", hdcp->config.index, \
92 				msg_name, hdcp->buf); \
93 } while (0)
94 #define HDCP_DDC_WRITE_TRACE(hdcp, msg_name, msg, msg_size) do { \
95 		mod_hdcp_dump_binary_message(msg, msg_size, hdcp->buf, \
96 				sizeof(hdcp->buf)); \
97 		HDCP_LOG_DDC(hdcp, "[Link %d] Write %s%s", \
98 				hdcp->config.index, msg_name,\
99 				hdcp->buf); \
100 } while (0)
101 #define HDCP_FULL_DDC_TRACE(hdcp) do { \
102 	if (is_hdcp1(hdcp)) { \
103 		HDCP_DDC_READ_TRACE(hdcp, "BKSV", hdcp->auth.msg.hdcp1.bksv, \
104 				sizeof(hdcp->auth.msg.hdcp1.bksv)); \
105 		HDCP_DDC_READ_TRACE(hdcp, "BCAPS", &hdcp->auth.msg.hdcp1.bcaps, \
106 				sizeof(hdcp->auth.msg.hdcp1.bcaps)); \
107 		HDCP_DDC_WRITE_TRACE(hdcp, "AN", hdcp->auth.msg.hdcp1.an, \
108 				sizeof(hdcp->auth.msg.hdcp1.an)); \
109 		HDCP_DDC_WRITE_TRACE(hdcp, "AKSV", hdcp->auth.msg.hdcp1.aksv, \
110 				sizeof(hdcp->auth.msg.hdcp1.aksv)); \
111 		HDCP_DDC_WRITE_TRACE(hdcp, "AINFO", &hdcp->auth.msg.hdcp1.ainfo, \
112 				sizeof(hdcp->auth.msg.hdcp1.ainfo)); \
113 		HDCP_DDC_READ_TRACE(hdcp, "RI' / R0'", \
114 				(uint8_t *)&hdcp->auth.msg.hdcp1.r0p, \
115 				sizeof(hdcp->auth.msg.hdcp1.r0p)); \
116 		HDCP_DDC_READ_TRACE(hdcp, "BINFO", \
117 				(uint8_t *)&hdcp->auth.msg.hdcp1.binfo_dp, \
118 				sizeof(hdcp->auth.msg.hdcp1.binfo_dp)); \
119 		HDCP_DDC_READ_TRACE(hdcp, "KSVLIST", hdcp->auth.msg.hdcp1.ksvlist, \
120 				hdcp->auth.msg.hdcp1.ksvlist_size); \
121 		HDCP_DDC_READ_TRACE(hdcp, "V'", hdcp->auth.msg.hdcp1.vp, \
122 				sizeof(hdcp->auth.msg.hdcp1.vp)); \
123 	} else { \
124 		HDCP_DDC_READ_TRACE(hdcp, "HDCP2Version", \
125 				&hdcp->auth.msg.hdcp2.hdcp2version_hdmi, \
126 				sizeof(hdcp->auth.msg.hdcp2.hdcp2version_hdmi)); \
127 		HDCP_DDC_READ_TRACE(hdcp, "Rx Caps", hdcp->auth.msg.hdcp2.rxcaps_dp, \
128 				sizeof(hdcp->auth.msg.hdcp2.rxcaps_dp)); \
129 		HDCP_DDC_WRITE_TRACE(hdcp, "AKE Init", hdcp->auth.msg.hdcp2.ake_init, \
130 				sizeof(hdcp->auth.msg.hdcp2.ake_init)); \
131 		HDCP_DDC_READ_TRACE(hdcp, "AKE Cert", hdcp->auth.msg.hdcp2.ake_cert, \
132 				sizeof(hdcp->auth.msg.hdcp2.ake_cert)); \
133 		HDCP_DDC_WRITE_TRACE(hdcp, "Stored KM", \
134 				hdcp->auth.msg.hdcp2.ake_stored_km, \
135 				sizeof(hdcp->auth.msg.hdcp2.ake_stored_km)); \
136 		HDCP_DDC_WRITE_TRACE(hdcp, "No Stored KM", \
137 				hdcp->auth.msg.hdcp2.ake_no_stored_km, \
138 				sizeof(hdcp->auth.msg.hdcp2.ake_no_stored_km)); \
139 		HDCP_DDC_READ_TRACE(hdcp, "H'", hdcp->auth.msg.hdcp2.ake_h_prime, \
140 				sizeof(hdcp->auth.msg.hdcp2.ake_h_prime)); \
141 		HDCP_DDC_READ_TRACE(hdcp, "Pairing Info", \
142 				hdcp->auth.msg.hdcp2.ake_pairing_info, \
143 				sizeof(hdcp->auth.msg.hdcp2.ake_pairing_info)); \
144 		HDCP_DDC_WRITE_TRACE(hdcp, "LC Init", hdcp->auth.msg.hdcp2.lc_init, \
145 				sizeof(hdcp->auth.msg.hdcp2.lc_init)); \
146 		HDCP_DDC_READ_TRACE(hdcp, "L'", hdcp->auth.msg.hdcp2.lc_l_prime, \
147 				sizeof(hdcp->auth.msg.hdcp2.lc_l_prime)); \
148 		HDCP_DDC_WRITE_TRACE(hdcp, "Exchange KS", hdcp->auth.msg.hdcp2.ske_eks, \
149 				sizeof(hdcp->auth.msg.hdcp2.ske_eks)); \
150 		HDCP_DDC_READ_TRACE(hdcp, "Rx Status", \
151 				(uint8_t *)&hdcp->auth.msg.hdcp2.rxstatus, \
152 				sizeof(hdcp->auth.msg.hdcp2.rxstatus)); \
153 		HDCP_DDC_READ_TRACE(hdcp, "Rx Id List", \
154 				hdcp->auth.msg.hdcp2.rx_id_list, \
155 				hdcp->auth.msg.hdcp2.rx_id_list_size); \
156 		HDCP_DDC_WRITE_TRACE(hdcp, "Rx Id List Ack", \
157 				hdcp->auth.msg.hdcp2.repeater_auth_ack, \
158 				sizeof(hdcp->auth.msg.hdcp2.repeater_auth_ack)); \
159 		HDCP_DDC_WRITE_TRACE(hdcp, "Content Stream Management", \
160 				hdcp->auth.msg.hdcp2.repeater_auth_stream_manage, \
161 				hdcp->auth.msg.hdcp2.stream_manage_size); \
162 		HDCP_DDC_READ_TRACE(hdcp, "Stream Ready", \
163 				hdcp->auth.msg.hdcp2.repeater_auth_stream_ready, \
164 				sizeof(hdcp->auth.msg.hdcp2.repeater_auth_stream_ready)); \
165 		HDCP_DDC_WRITE_TRACE(hdcp, "Content Stream Type", \
166 				hdcp->auth.msg.hdcp2.content_stream_type_dp, \
167 				sizeof(hdcp->auth.msg.hdcp2.content_stream_type_dp)); \
168 	} \
169 } while (0)
170 #define HDCP_TOP_ADD_DISPLAY_TRACE(hdcp, i) \
171 		HDCP_LOG_TOP(hdcp, "[Link %d]\tadd display %d", \
172 				hdcp->config.index, i)
173 #define HDCP_TOP_REMOVE_DISPLAY_TRACE(hdcp, i) \
174 		HDCP_LOG_TOP(hdcp, "[Link %d]\tremove display %d", \
175 				hdcp->config.index, i)
176 #define HDCP_TOP_HDCP1_DESTROY_SESSION_TRACE(hdcp) \
177 		HDCP_LOG_TOP(hdcp, "[Link %d]\tdestroy hdcp1 session", \
178 				hdcp->config.index)
179 #define HDCP_TOP_HDCP2_DESTROY_SESSION_TRACE(hdcp) \
180 		HDCP_LOG_TOP(hdcp, "[Link %d]\tdestroy hdcp2 session", \
181 				hdcp->config.index)
182 #define HDCP_TOP_RESET_AUTH_TRACE(hdcp) \
183 		HDCP_LOG_TOP(hdcp, "[Link %d]\treset authentication", hdcp->config.index)
184 #define HDCP_TOP_RESET_CONN_TRACE(hdcp) \
185 		HDCP_LOG_TOP(hdcp, "[Link %d]\treset connection", hdcp->config.index)
186 #define HDCP_TOP_INTERFACE_TRACE(hdcp) do { \
187 		HDCP_LOG_TOP(hdcp, "\n"); \
188 		HDCP_LOG_TOP(hdcp, "[Link %d] %s", hdcp->config.index, __func__); \
189 } while (0)
190 #define HDCP_TOP_INTERFACE_TRACE_WITH_INDEX(hdcp, i) do { \
191 		HDCP_LOG_TOP(hdcp, "\n"); \
192 		HDCP_LOG_TOP(hdcp, "[Link %d] %s display %d", hdcp->config.index, __func__, i); \
193 } while (0)
194 
195 #endif // MOD_HDCP_LOG_H_
196