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.
30 #include "signal_types.h"
32 /* Forward Declarations */
35 #define MAX_NUM_OF_DISPLAYS 6
36 #define MAX_NUM_OF_ATTEMPTS 4
37 #define MAX_NUM_OF_ERROR_TRACE 10
39 /* detailed return status */
40 enum mod_hdcp_status {
41 MOD_HDCP_STATUS_SUCCESS = 0,
42 MOD_HDCP_STATUS_FAILURE,
43 MOD_HDCP_STATUS_RESET_NEEDED,
44 MOD_HDCP_STATUS_DISPLAY_OUT_OF_BOUND,
45 MOD_HDCP_STATUS_DISPLAY_NOT_FOUND,
46 MOD_HDCP_STATUS_INVALID_STATE,
47 MOD_HDCP_STATUS_NOT_IMPLEMENTED,
48 MOD_HDCP_STATUS_INTERNAL_POLICY_FAILURE,
49 MOD_HDCP_STATUS_UPDATE_TOPOLOGY_FAILURE,
50 MOD_HDCP_STATUS_CREATE_PSP_SERVICE_FAILURE,
51 MOD_HDCP_STATUS_DESTROY_PSP_SERVICE_FAILURE,
52 MOD_HDCP_STATUS_HDCP1_CREATE_SESSION_FAILURE,
53 MOD_HDCP_STATUS_HDCP1_DESTROY_SESSION_FAILURE,
54 MOD_HDCP_STATUS_HDCP1_VALIDATE_ENCRYPTION_FAILURE,
55 MOD_HDCP_STATUS_HDCP1_NOT_HDCP_REPEATER,
56 MOD_HDCP_STATUS_HDCP1_NOT_CAPABLE,
57 MOD_HDCP_STATUS_HDCP1_R0_PRIME_PENDING,
58 MOD_HDCP_STATUS_HDCP1_VALIDATE_RX_FAILURE,
59 MOD_HDCP_STATUS_HDCP1_BKSV_REVOKED,
60 MOD_HDCP_STATUS_HDCP1_KSV_LIST_NOT_READY,
61 MOD_HDCP_STATUS_HDCP1_VALIDATE_KSV_LIST_FAILURE,
62 MOD_HDCP_STATUS_HDCP1_KSV_LIST_REVOKED,
63 MOD_HDCP_STATUS_HDCP1_ENABLE_ENCRYPTION,
64 MOD_HDCP_STATUS_HDCP1_ENABLE_STREAM_ENCRYPTION_FAILURE,
65 MOD_HDCP_STATUS_HDCP1_MAX_CASCADE_EXCEEDED_FAILURE,
66 MOD_HDCP_STATUS_HDCP1_MAX_DEVS_EXCEEDED_FAILURE,
67 MOD_HDCP_STATUS_HDCP1_DEVICE_COUNT_MISMATCH_FAILURE,
68 MOD_HDCP_STATUS_HDCP1_LINK_INTEGRITY_FAILURE,
69 MOD_HDCP_STATUS_HDCP1_REAUTH_REQUEST_ISSUED,
70 MOD_HDCP_STATUS_HDCP1_LINK_MAINTENANCE_FAILURE,
71 MOD_HDCP_STATUS_HDCP1_INVALID_BKSV,
72 MOD_HDCP_STATUS_DDC_FAILURE, /* TODO: specific errors */
73 MOD_HDCP_STATUS_INVALID_OPERATION,
74 MOD_HDCP_STATUS_HDCP2_NOT_CAPABLE,
75 MOD_HDCP_STATUS_HDCP2_CREATE_SESSION_FAILURE,
76 MOD_HDCP_STATUS_HDCP2_DESTROY_SESSION_FAILURE,
77 MOD_HDCP_STATUS_HDCP2_PREP_AKE_INIT_FAILURE,
78 MOD_HDCP_STATUS_HDCP2_AKE_CERT_PENDING,
79 MOD_HDCP_STATUS_HDCP2_H_PRIME_PENDING,
80 MOD_HDCP_STATUS_HDCP2_PAIRING_INFO_PENDING,
81 MOD_HDCP_STATUS_HDCP2_VALIDATE_AKE_CERT_FAILURE,
82 MOD_HDCP_STATUS_HDCP2_AKE_CERT_REVOKED,
83 MOD_HDCP_STATUS_HDCP2_VALIDATE_H_PRIME_FAILURE,
84 MOD_HDCP_STATUS_HDCP2_VALIDATE_PAIRING_INFO_FAILURE,
85 MOD_HDCP_STATUS_HDCP2_PREP_LC_INIT_FAILURE,
86 MOD_HDCP_STATUS_HDCP2_L_PRIME_PENDING,
87 MOD_HDCP_STATUS_HDCP2_VALIDATE_L_PRIME_FAILURE,
88 MOD_HDCP_STATUS_HDCP2_PREP_EKS_FAILURE,
89 MOD_HDCP_STATUS_HDCP2_ENABLE_ENCRYPTION_FAILURE,
90 MOD_HDCP_STATUS_HDCP2_RX_ID_LIST_NOT_READY,
91 MOD_HDCP_STATUS_HDCP2_VALIDATE_RX_ID_LIST_FAILURE,
92 MOD_HDCP_STATUS_HDCP2_RX_ID_LIST_REVOKED,
93 MOD_HDCP_STATUS_HDCP2_ENABLE_STREAM_ENCRYPTION,
94 MOD_HDCP_STATUS_HDCP2_STREAM_READY_PENDING,
95 MOD_HDCP_STATUS_HDCP2_VALIDATE_STREAM_READY_FAILURE,
96 MOD_HDCP_STATUS_HDCP2_PREPARE_STREAM_MANAGEMENT_FAILURE,
97 MOD_HDCP_STATUS_HDCP2_REAUTH_REQUEST,
98 MOD_HDCP_STATUS_HDCP2_REAUTH_LINK_INTEGRITY_FAILURE,
99 MOD_HDCP_STATUS_HDCP2_DEVICE_COUNT_MISMATCH_FAILURE,
102 struct mod_hdcp_displayport {
104 uint8_t assr_supported;
105 uint8_t mst_supported;
108 struct mod_hdcp_hdmi {
111 enum mod_hdcp_operation_mode {
113 MOD_HDCP_MODE_DEFAULT,
117 enum mod_hdcp_display_state {
118 MOD_HDCP_DISPLAY_INACTIVE = 0,
119 MOD_HDCP_DISPLAY_ACTIVE,
120 MOD_HDCP_DISPLAY_ACTIVE_AND_ADDED,
121 MOD_HDCP_DISPLAY_ENCRYPTION_ENABLED
124 struct mod_hdcp_ddc {
127 bool (*read_i2c)(void *handle,
132 bool (*write_i2c)(void *handle,
136 bool (*read_dpcd)(void *handle,
140 bool (*write_dpcd)(void *handle,
147 struct mod_hdcp_psp {
152 struct mod_hdcp_display_adjustment {
154 uint8_t reserved : 7;
157 struct mod_hdcp_link_adjustment_hdcp1 {
159 uint8_t postpone_encryption : 1;
160 uint8_t min_auth_retries_wa : 1;
161 uint8_t reserved : 5;
164 enum mod_hdcp_force_hdcp_type {
165 MOD_HDCP_FORCE_TYPE_MAX = 0,
166 MOD_HDCP_FORCE_TYPE_0,
167 MOD_HDCP_FORCE_TYPE_1
170 struct mod_hdcp_link_adjustment_hdcp2 {
172 uint8_t force_type : 2;
173 uint8_t force_no_stored_km : 1;
174 uint8_t increase_h_prime_timeout: 1;
175 uint8_t reserved : 3;
178 struct mod_hdcp_link_adjustment {
180 struct mod_hdcp_link_adjustment_hdcp1 hdcp1;
181 struct mod_hdcp_link_adjustment_hdcp2 hdcp2;
184 struct mod_hdcp_error {
185 enum mod_hdcp_status status;
189 struct mod_hdcp_trace {
190 struct mod_hdcp_error errors[MAX_NUM_OF_ERROR_TRACE];
194 enum mod_hdcp_encryption_status {
195 MOD_HDCP_ENCRYPTION_STATUS_HDCP_OFF = 0,
196 MOD_HDCP_ENCRYPTION_STATUS_HDCP1_ON,
197 MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE0_ON,
198 MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE1_ON,
199 MOD_HDCP_ENCRYPTION_STATUS_HDCP2_ON
202 /* per link events dm has to notify to hdcp module */
203 enum mod_hdcp_event {
204 MOD_HDCP_EVENT_CALLBACK = 0,
205 MOD_HDCP_EVENT_WATCHDOG_TIMEOUT,
209 /* output flags from module requesting timer operations */
210 struct mod_hdcp_output {
211 uint8_t callback_needed;
212 uint8_t callback_stop;
213 uint8_t watchdog_timer_needed;
214 uint8_t watchdog_timer_stop;
215 uint16_t callback_delay;
216 uint16_t watchdog_timer_delay;
219 /* used to represent per display info */
220 struct mod_hdcp_display {
221 enum mod_hdcp_display_state state;
228 struct mod_hdcp_display_adjustment adjust;
231 /* used to represent per link info */
232 /* in case a link has multiple displays, they share the same link info */
233 struct mod_hdcp_link {
234 enum mod_hdcp_operation_mode mode;
238 struct mod_hdcp_displayport dp;
239 struct mod_hdcp_hdmi hdmi;
241 struct mod_hdcp_link_adjustment adjust;
244 /* a query structure for a display's hdcp information */
245 struct mod_hdcp_display_query {
246 const struct mod_hdcp_display *display;
247 const struct mod_hdcp_link *link;
248 const struct mod_hdcp_trace *trace;
249 enum mod_hdcp_encryption_status encryption_status;
252 /* contains values per on external display configuration change */
253 struct mod_hdcp_config {
254 struct mod_hdcp_psp psp;
255 struct mod_hdcp_ddc ddc;
261 /* dm allocates memory of mod_hdcp per dc_link on dm init based on memory size*/
262 size_t mod_hdcp_get_memory_size(void);
264 /* called per link on link creation */
265 enum mod_hdcp_status mod_hdcp_setup(struct mod_hdcp *hdcp,
266 struct mod_hdcp_config *config);
268 /* called per link on link destroy */
269 enum mod_hdcp_status mod_hdcp_teardown(struct mod_hdcp *hdcp);
271 /* called per display on cp_desired set to true */
272 enum mod_hdcp_status mod_hdcp_add_display(struct mod_hdcp *hdcp,
273 struct mod_hdcp_link *link, struct mod_hdcp_display *display,
274 struct mod_hdcp_output *output);
276 /* called per display on cp_desired set to false */
277 enum mod_hdcp_status mod_hdcp_remove_display(struct mod_hdcp *hdcp,
278 uint8_t index, struct mod_hdcp_output *output);
280 /* called to query hdcp information on a specific index */
281 enum mod_hdcp_status mod_hdcp_query_display(struct mod_hdcp *hdcp,
282 uint8_t index, struct mod_hdcp_display_query *query);
284 /* called per link on connectivity change */
285 enum mod_hdcp_status mod_hdcp_reset_connection(struct mod_hdcp *hdcp,
286 struct mod_hdcp_output *output);
288 /* called per link on events (i.e. callback, watchdog, CP_IRQ) */
289 enum mod_hdcp_status mod_hdcp_process_event(struct mod_hdcp *hdcp,
290 enum mod_hdcp_event event, struct mod_hdcp_output *output);
292 /* called to convert enum mod_hdcp_status to c string */
293 char *mod_hdcp_status_to_str(int32_t status);
295 /* called to convert state id to c string */
296 char *mod_hdcp_state_id_to_str(int32_t id);
298 /* called to convert signal type to operation mode */
299 enum mod_hdcp_operation_mode mod_hdcp_signal_type_to_operation_mode(
300 enum signal_type signal);
301 #endif /* MOD_HDCP_H_ */