2 * Copyright 2019 Advanced Micro Devices, Inc.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
28 static void push_error_status(struct mod_hdcp *hdcp,
29 enum mod_hdcp_status status)
31 struct mod_hdcp_trace *trace = &hdcp->connection.trace;
33 if (trace->error_count < MAX_NUM_OF_ERROR_TRACE) {
34 trace->errors[trace->error_count].status = status;
35 trace->errors[trace->error_count].state_id = hdcp->state.id;
37 HDCP_ERROR_TRACE(hdcp, status);
41 hdcp->connection.hdcp1_retry_count++;
42 if (hdcp->connection.hdcp1_retry_count == MAX_NUM_OF_ATTEMPTS)
43 hdcp->connection.link.adjust.hdcp1.disable = 1;
44 } else if (is_hdcp2(hdcp)) {
45 hdcp->connection.hdcp2_retry_count++;
46 if (hdcp->connection.hdcp2_retry_count == MAX_NUM_OF_ATTEMPTS)
47 hdcp->connection.link.adjust.hdcp2.disable = 1;
51 static uint8_t is_cp_desired_hdcp1(struct mod_hdcp *hdcp)
53 int i, is_auth_needed = 0;
55 /* if all displays on the link don't need authentication,
58 for (i = 0; i < MAX_NUM_OF_DISPLAYS; i++) {
59 if (hdcp->displays[i].state != MOD_HDCP_DISPLAY_INACTIVE &&
60 hdcp->displays[i].adjust.disable != MOD_HDCP_DISPLAY_DISABLE_AUTHENTICATION) {
66 return is_auth_needed &&
67 !hdcp->connection.link.adjust.hdcp1.disable &&
68 !hdcp->connection.is_hdcp1_revoked;
71 static uint8_t is_cp_desired_hdcp2(struct mod_hdcp *hdcp)
73 int i, is_auth_needed = 0;
75 /* if all displays on the link don't need authentication,
78 for (i = 0; i < MAX_NUM_OF_DISPLAYS; i++) {
79 if (hdcp->displays[i].state != MOD_HDCP_DISPLAY_INACTIVE &&
80 hdcp->displays[i].adjust.disable != MOD_HDCP_DISPLAY_DISABLE_AUTHENTICATION) {
86 return is_auth_needed &&
87 !hdcp->connection.link.adjust.hdcp2.disable &&
88 !hdcp->connection.is_hdcp2_revoked;
91 static enum mod_hdcp_status execution(struct mod_hdcp *hdcp,
92 struct mod_hdcp_event_context *event_ctx,
93 union mod_hdcp_transition_input *input)
95 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
97 if (is_in_initialized_state(hdcp)) {
98 if (event_ctx->event != MOD_HDCP_EVENT_CALLBACK) {
99 event_ctx->unexpected_event = 1;
102 /* initialize transition input */
103 memset(input, 0, sizeof(union mod_hdcp_transition_input));
104 } else if (is_in_cp_not_desired_state(hdcp)) {
105 if (event_ctx->event != MOD_HDCP_EVENT_CALLBACK) {
106 event_ctx->unexpected_event = 1;
109 } else if (is_in_hdcp1_states(hdcp)) {
110 status = mod_hdcp_hdcp1_execution(hdcp, event_ctx, &input->hdcp1);
111 } else if (is_in_hdcp1_dp_states(hdcp)) {
112 status = mod_hdcp_hdcp1_dp_execution(hdcp,
113 event_ctx, &input->hdcp1);
114 } else if (is_in_hdcp2_states(hdcp)) {
115 status = mod_hdcp_hdcp2_execution(hdcp, event_ctx, &input->hdcp2);
116 } else if (is_in_hdcp2_dp_states(hdcp)) {
117 status = mod_hdcp_hdcp2_dp_execution(hdcp,
118 event_ctx, &input->hdcp2);
120 event_ctx->unexpected_event = 1;
127 static enum mod_hdcp_status transition(struct mod_hdcp *hdcp,
128 struct mod_hdcp_event_context *event_ctx,
129 union mod_hdcp_transition_input *input,
130 struct mod_hdcp_output *output)
132 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
134 if (event_ctx->unexpected_event)
137 if (is_in_initialized_state(hdcp)) {
138 if (is_dp_hdcp(hdcp))
139 if (is_cp_desired_hdcp2(hdcp)) {
140 callback_in_ms(0, output);
141 set_state_id(hdcp, output, D2_A0_DETERMINE_RX_HDCP_CAPABLE);
142 } else if (is_cp_desired_hdcp1(hdcp)) {
143 callback_in_ms(0, output);
144 set_state_id(hdcp, output, D1_A0_DETERMINE_RX_HDCP_CAPABLE);
146 callback_in_ms(0, output);
147 set_state_id(hdcp, output, HDCP_CP_NOT_DESIRED);
148 set_auth_complete(hdcp, output);
150 else if (is_hdmi_dvi_sl_hdcp(hdcp))
151 if (is_cp_desired_hdcp2(hdcp)) {
152 callback_in_ms(0, output);
153 set_state_id(hdcp, output, H2_A0_KNOWN_HDCP2_CAPABLE_RX);
154 } else if (is_cp_desired_hdcp1(hdcp)) {
155 callback_in_ms(0, output);
156 set_state_id(hdcp, output, H1_A0_WAIT_FOR_ACTIVE_RX);
158 callback_in_ms(0, output);
159 set_state_id(hdcp, output, HDCP_CP_NOT_DESIRED);
160 set_auth_complete(hdcp, output);
163 callback_in_ms(0, output);
164 set_state_id(hdcp, output, HDCP_CP_NOT_DESIRED);
165 set_auth_complete(hdcp, output);
167 } else if (is_in_cp_not_desired_state(hdcp)) {
168 increment_stay_counter(hdcp);
169 } else if (is_in_hdcp1_states(hdcp)) {
170 status = mod_hdcp_hdcp1_transition(hdcp,
171 event_ctx, &input->hdcp1, output);
172 } else if (is_in_hdcp1_dp_states(hdcp)) {
173 status = mod_hdcp_hdcp1_dp_transition(hdcp,
174 event_ctx, &input->hdcp1, output);
175 } else if (is_in_hdcp2_states(hdcp)) {
176 status = mod_hdcp_hdcp2_transition(hdcp,
177 event_ctx, &input->hdcp2, output);
178 } else if (is_in_hdcp2_dp_states(hdcp)) {
179 status = mod_hdcp_hdcp2_dp_transition(hdcp,
180 event_ctx, &input->hdcp2, output);
182 status = MOD_HDCP_STATUS_INVALID_STATE;
188 static enum mod_hdcp_status reset_authentication(struct mod_hdcp *hdcp,
189 struct mod_hdcp_output *output)
191 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
193 if (is_hdcp1(hdcp)) {
194 if (hdcp->auth.trans_input.hdcp1.create_session != UNKNOWN) {
195 /* TODO - update psp to unify create session failure
196 * recovery between hdcp1 and 2.
198 mod_hdcp_hdcp1_destroy_session(hdcp);
202 HDCP_TOP_RESET_AUTH_TRACE(hdcp);
203 memset(&hdcp->auth, 0, sizeof(struct mod_hdcp_authentication));
204 memset(&hdcp->state, 0, sizeof(struct mod_hdcp_state));
205 set_state_id(hdcp, output, HDCP_INITIALIZED);
206 } else if (is_hdcp2(hdcp)) {
207 if (hdcp->auth.trans_input.hdcp2.create_session == PASS) {
208 status = mod_hdcp_hdcp2_destroy_session(hdcp);
209 if (status != MOD_HDCP_STATUS_SUCCESS) {
210 output->callback_needed = 0;
211 output->watchdog_timer_needed = 0;
216 HDCP_TOP_RESET_AUTH_TRACE(hdcp);
217 memset(&hdcp->auth, 0, sizeof(struct mod_hdcp_authentication));
218 memset(&hdcp->state, 0, sizeof(struct mod_hdcp_state));
219 set_state_id(hdcp, output, HDCP_INITIALIZED);
220 } else if (is_in_cp_not_desired_state(hdcp)) {
221 HDCP_TOP_RESET_AUTH_TRACE(hdcp);
222 memset(&hdcp->auth, 0, sizeof(struct mod_hdcp_authentication));
223 memset(&hdcp->state, 0, sizeof(struct mod_hdcp_state));
224 set_state_id(hdcp, output, HDCP_INITIALIZED);
228 /* stop callback and watchdog requests from previous authentication*/
229 output->watchdog_timer_stop = 1;
230 output->callback_stop = 1;
234 static enum mod_hdcp_status reset_connection(struct mod_hdcp *hdcp,
235 struct mod_hdcp_output *output)
237 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
239 memset(output, 0, sizeof(struct mod_hdcp_output));
241 status = reset_authentication(hdcp, output);
242 if (status != MOD_HDCP_STATUS_SUCCESS)
245 if (current_state(hdcp) != HDCP_UNINITIALIZED) {
246 HDCP_TOP_RESET_CONN_TRACE(hdcp);
247 set_state_id(hdcp, output, HDCP_UNINITIALIZED);
249 memset(&hdcp->connection, 0, sizeof(hdcp->connection));
254 static enum mod_hdcp_status update_display_adjustments(struct mod_hdcp *hdcp,
255 struct mod_hdcp_display *display,
256 struct mod_hdcp_display_adjustment *adj)
258 enum mod_hdcp_status status = MOD_HDCP_STATUS_NOT_IMPLEMENTED;
260 if (is_in_authenticated_states(hdcp) &&
261 is_dp_mst_hdcp(hdcp) &&
262 display->adjust.disable == true &&
263 adj->disable == false) {
264 display->adjust.disable = false;
266 status = mod_hdcp_hdcp1_enable_dp_stream_encryption(hdcp);
267 else if (is_hdcp2(hdcp))
268 status = mod_hdcp_hdcp2_enable_dp_stream_encryption(hdcp);
270 if (status != MOD_HDCP_STATUS_SUCCESS)
271 display->adjust.disable = true;
274 if (status == MOD_HDCP_STATUS_SUCCESS &&
275 memcmp(adj, &display->adjust,
276 sizeof(struct mod_hdcp_display_adjustment)) != 0)
277 status = MOD_HDCP_STATUS_NOT_IMPLEMENTED;
282 * Implementation of functions in mod_hdcp.h
284 size_t mod_hdcp_get_memory_size(void)
286 return sizeof(struct mod_hdcp);
289 enum mod_hdcp_status mod_hdcp_setup(struct mod_hdcp *hdcp,
290 struct mod_hdcp_config *config)
292 struct mod_hdcp_output output;
293 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
295 memset(&output, 0, sizeof(output));
296 hdcp->config = *config;
297 HDCP_TOP_INTERFACE_TRACE(hdcp);
298 status = reset_connection(hdcp, &output);
299 if (status != MOD_HDCP_STATUS_SUCCESS)
300 push_error_status(hdcp, status);
304 enum mod_hdcp_status mod_hdcp_teardown(struct mod_hdcp *hdcp)
306 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
307 struct mod_hdcp_output output;
309 HDCP_TOP_INTERFACE_TRACE(hdcp);
310 memset(&output, 0, sizeof(output));
311 status = reset_connection(hdcp, &output);
312 if (status == MOD_HDCP_STATUS_SUCCESS)
313 memset(hdcp, 0, sizeof(struct mod_hdcp));
315 push_error_status(hdcp, status);
319 enum mod_hdcp_status mod_hdcp_add_display(struct mod_hdcp *hdcp,
320 struct mod_hdcp_link *link, struct mod_hdcp_display *display,
321 struct mod_hdcp_output *output)
323 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
324 struct mod_hdcp_display *display_container = NULL;
326 HDCP_TOP_INTERFACE_TRACE_WITH_INDEX(hdcp, display->index);
327 memset(output, 0, sizeof(struct mod_hdcp_output));
329 /* skip inactive display */
330 if (display->state != MOD_HDCP_DISPLAY_ACTIVE) {
331 status = MOD_HDCP_STATUS_SUCCESS;
335 /* check existing display container */
336 if (get_active_display_at_index(hdcp, display->index)) {
337 status = MOD_HDCP_STATUS_SUCCESS;
341 /* find an empty display container */
342 display_container = get_empty_display_container(hdcp);
343 if (!display_container) {
344 status = MOD_HDCP_STATUS_DISPLAY_OUT_OF_BOUND;
348 /* reset existing authentication status */
349 status = reset_authentication(hdcp, output);
350 if (status != MOD_HDCP_STATUS_SUCCESS)
353 /* reset retry counters */
354 reset_retry_counts(hdcp);
356 /* reset error trace */
357 memset(&hdcp->connection.trace, 0, sizeof(hdcp->connection.trace));
359 /* add display to connection */
360 hdcp->connection.link = *link;
361 *display_container = *display;
362 status = mod_hdcp_add_display_to_topology(hdcp, display_container);
364 if (status != MOD_HDCP_STATUS_SUCCESS)
367 /* request authentication */
368 if (current_state(hdcp) != HDCP_INITIALIZED)
369 set_state_id(hdcp, output, HDCP_INITIALIZED);
370 callback_in_ms(hdcp->connection.link.adjust.auth_delay * 1000, output);
372 if (status != MOD_HDCP_STATUS_SUCCESS)
373 push_error_status(hdcp, status);
378 enum mod_hdcp_status mod_hdcp_remove_display(struct mod_hdcp *hdcp,
379 uint8_t index, struct mod_hdcp_output *output)
381 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
382 struct mod_hdcp_display *display = NULL;
384 HDCP_TOP_INTERFACE_TRACE_WITH_INDEX(hdcp, index);
385 memset(output, 0, sizeof(struct mod_hdcp_output));
387 /* find display in connection */
388 display = get_active_display_at_index(hdcp, index);
390 status = MOD_HDCP_STATUS_SUCCESS;
394 /* stop current authentication */
395 status = reset_authentication(hdcp, output);
396 if (status != MOD_HDCP_STATUS_SUCCESS)
399 /* clear retry counters */
400 reset_retry_counts(hdcp);
402 /* reset error trace */
403 memset(&hdcp->connection.trace, 0, sizeof(hdcp->connection.trace));
406 status = mod_hdcp_remove_display_from_topology(hdcp, index);
407 if (status != MOD_HDCP_STATUS_SUCCESS)
409 memset(display, 0, sizeof(struct mod_hdcp_display));
411 /* request authentication when connection is not reset */
412 if (current_state(hdcp) != HDCP_UNINITIALIZED)
413 callback_in_ms(hdcp->connection.link.adjust.auth_delay * 1000,
416 if (status != MOD_HDCP_STATUS_SUCCESS)
417 push_error_status(hdcp, status);
421 enum mod_hdcp_status mod_hdcp_update_display(struct mod_hdcp *hdcp,
423 struct mod_hdcp_link_adjustment *link_adjust,
424 struct mod_hdcp_display_adjustment *display_adjust,
425 struct mod_hdcp_output *output)
427 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
428 struct mod_hdcp_display *display = NULL;
430 HDCP_TOP_INTERFACE_TRACE_WITH_INDEX(hdcp, index);
431 memset(output, 0, sizeof(struct mod_hdcp_output));
433 /* find display in connection */
434 display = get_active_display_at_index(hdcp, index);
436 status = MOD_HDCP_STATUS_DISPLAY_NOT_FOUND;
440 /* skip if no changes */
441 if (memcmp(link_adjust, &hdcp->connection.link.adjust,
442 sizeof(struct mod_hdcp_link_adjustment)) == 0 &&
443 memcmp(display_adjust, &display->adjust,
444 sizeof(struct mod_hdcp_display_adjustment)) == 0) {
445 status = MOD_HDCP_STATUS_SUCCESS;
449 if (memcmp(link_adjust, &hdcp->connection.link.adjust,
450 sizeof(struct mod_hdcp_link_adjustment)) == 0 &&
451 memcmp(display_adjust, &display->adjust,
452 sizeof(struct mod_hdcp_display_adjustment)) != 0) {
453 status = update_display_adjustments(hdcp, display, display_adjust);
454 if (status != MOD_HDCP_STATUS_NOT_IMPLEMENTED)
458 /* stop current authentication */
459 status = reset_authentication(hdcp, output);
460 if (status != MOD_HDCP_STATUS_SUCCESS)
463 /* clear retry counters */
464 reset_retry_counts(hdcp);
466 /* reset error trace */
467 memset(&hdcp->connection.trace, 0, sizeof(hdcp->connection.trace));
469 /* set new adjustment */
470 hdcp->connection.link.adjust = *link_adjust;
471 display->adjust = *display_adjust;
473 /* request authentication when connection is not reset */
474 if (current_state(hdcp) != HDCP_UNINITIALIZED)
475 /* wait 100ms to debounce simultaneous updates for different indices */
476 callback_in_ms(100, output);
479 if (status != MOD_HDCP_STATUS_SUCCESS)
480 push_error_status(hdcp, status);
484 enum mod_hdcp_status mod_hdcp_query_display(struct mod_hdcp *hdcp,
485 uint8_t index, struct mod_hdcp_display_query *query)
487 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
488 struct mod_hdcp_display *display = NULL;
490 /* find display in connection */
491 display = get_active_display_at_index(hdcp, index);
493 status = MOD_HDCP_STATUS_DISPLAY_NOT_FOUND;
498 query->link = &hdcp->connection.link;
499 query->display = display;
500 query->trace = &hdcp->connection.trace;
501 query->encryption_status = MOD_HDCP_ENCRYPTION_STATUS_HDCP_OFF;
503 if (is_display_encryption_enabled(display)) {
504 if (is_hdcp1(hdcp)) {
505 query->encryption_status = MOD_HDCP_ENCRYPTION_STATUS_HDCP1_ON;
506 } else if (is_hdcp2(hdcp)) {
507 if (query->link->adjust.hdcp2.force_type == MOD_HDCP_FORCE_TYPE_0)
508 query->encryption_status = MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE0_ON;
509 else if (query->link->adjust.hdcp2.force_type == MOD_HDCP_FORCE_TYPE_1)
510 query->encryption_status = MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE1_ON;
512 query->encryption_status = MOD_HDCP_ENCRYPTION_STATUS_HDCP2_ON;
515 query->encryption_status = MOD_HDCP_ENCRYPTION_STATUS_HDCP_OFF;
522 enum mod_hdcp_status mod_hdcp_reset_connection(struct mod_hdcp *hdcp,
523 struct mod_hdcp_output *output)
525 enum mod_hdcp_status status = MOD_HDCP_STATUS_SUCCESS;
527 HDCP_TOP_INTERFACE_TRACE(hdcp);
528 status = reset_connection(hdcp, output);
529 if (status != MOD_HDCP_STATUS_SUCCESS)
530 push_error_status(hdcp, status);
535 enum mod_hdcp_status mod_hdcp_process_event(struct mod_hdcp *hdcp,
536 enum mod_hdcp_event event, struct mod_hdcp_output *output)
538 enum mod_hdcp_status exec_status, trans_status, reset_status, status;
539 struct mod_hdcp_event_context event_ctx;
541 HDCP_EVENT_TRACE(hdcp, event);
542 memset(output, 0, sizeof(struct mod_hdcp_output));
543 memset(&event_ctx, 0, sizeof(struct mod_hdcp_event_context));
544 event_ctx.event = event;
546 /* execute and transition */
547 exec_status = execution(hdcp, &event_ctx, &hdcp->auth.trans_input);
548 trans_status = transition(
549 hdcp, &event_ctx, &hdcp->auth.trans_input, output);
550 if (trans_status == MOD_HDCP_STATUS_SUCCESS) {
551 status = MOD_HDCP_STATUS_SUCCESS;
552 } else if (exec_status == MOD_HDCP_STATUS_SUCCESS) {
553 status = MOD_HDCP_STATUS_INTERNAL_POLICY_FAILURE;
554 push_error_status(hdcp, status);
556 status = exec_status;
557 push_error_status(hdcp, status);
560 /* reset authentication if needed */
561 if (trans_status == MOD_HDCP_STATUS_RESET_NEEDED) {
562 mod_hdcp_log_ddc_trace(hdcp);
563 reset_status = reset_authentication(hdcp, output);
564 if (reset_status != MOD_HDCP_STATUS_SUCCESS)
565 push_error_status(hdcp, reset_status);
568 /* Clear CP_IRQ status if needed */
569 if (event_ctx.event == MOD_HDCP_EVENT_CPIRQ) {
570 status = mod_hdcp_clear_cp_irq_status(hdcp);
571 if (status != MOD_HDCP_STATUS_SUCCESS)
572 push_error_status(hdcp, status);
578 enum mod_hdcp_operation_mode mod_hdcp_signal_type_to_operation_mode(
579 enum signal_type signal)
581 enum mod_hdcp_operation_mode mode = MOD_HDCP_MODE_OFF;
584 case SIGNAL_TYPE_DVI_SINGLE_LINK:
585 case SIGNAL_TYPE_HDMI_TYPE_A:
586 mode = MOD_HDCP_MODE_DEFAULT;
588 case SIGNAL_TYPE_EDP:
589 case SIGNAL_TYPE_DISPLAY_PORT:
590 case SIGNAL_TYPE_DISPLAY_PORT_MST:
591 mode = MOD_HDCP_MODE_DP;