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_H_ 27 #define MOD_HDCP_H_ 28 29 #include "os_types.h" 30 #include "signal_types.h" 31 32 /* Forward Declarations */ 33 struct mod_hdcp; 34 35 #define MAX_NUM_OF_DISPLAYS 6 36 #define MAX_NUM_OF_ATTEMPTS 4 37 #define MAX_NUM_OF_ERROR_TRACE 10 38 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_FAILURE, 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_FAILURE, 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, 100 }; 101 102 struct mod_hdcp_displayport { 103 uint8_t rev; 104 uint8_t assr_enabled; 105 uint8_t mst_enabled; 106 }; 107 108 struct mod_hdcp_hdmi { 109 uint8_t reserved; 110 }; 111 enum mod_hdcp_operation_mode { 112 MOD_HDCP_MODE_OFF, 113 MOD_HDCP_MODE_DEFAULT, 114 MOD_HDCP_MODE_DP 115 }; 116 117 enum mod_hdcp_display_state { 118 MOD_HDCP_DISPLAY_INACTIVE = 0, 119 MOD_HDCP_DISPLAY_ACTIVE, 120 MOD_HDCP_DISPLAY_ENCRYPTION_ENABLED 121 }; 122 123 struct mod_hdcp_ddc { 124 void *handle; 125 struct { 126 bool (*read_i2c)(void *handle, 127 uint32_t address, 128 uint8_t offset, 129 uint8_t *data, 130 uint32_t size); 131 bool (*write_i2c)(void *handle, 132 uint32_t address, 133 const uint8_t *data, 134 uint32_t size); 135 bool (*read_dpcd)(void *handle, 136 uint32_t address, 137 uint8_t *data, 138 uint32_t size); 139 bool (*write_dpcd)(void *handle, 140 uint32_t address, 141 const uint8_t *data, 142 uint32_t size); 143 } funcs; 144 }; 145 146 struct mod_hdcp_psp { 147 void *handle; 148 void *funcs; 149 }; 150 151 struct mod_hdcp_display_adjustment { 152 uint8_t disable : 1; 153 uint8_t reserved : 7; 154 }; 155 156 struct mod_hdcp_link_adjustment_hdcp1 { 157 uint8_t disable : 1; 158 uint8_t postpone_encryption : 1; 159 uint8_t min_auth_retries_wa : 1; 160 uint8_t reserved : 5; 161 }; 162 163 enum mod_hdcp_force_hdcp_type { 164 MOD_HDCP_FORCE_TYPE_MAX = 0, 165 MOD_HDCP_FORCE_TYPE_0, 166 MOD_HDCP_FORCE_TYPE_1 167 }; 168 169 struct mod_hdcp_link_adjustment_hdcp2 { 170 uint8_t disable : 1; 171 uint8_t force_type : 2; 172 uint8_t force_no_stored_km : 1; 173 uint8_t increase_h_prime_timeout: 1; 174 uint8_t reserved : 3; 175 }; 176 177 struct mod_hdcp_link_adjustment { 178 uint8_t auth_delay; 179 struct mod_hdcp_link_adjustment_hdcp1 hdcp1; 180 struct mod_hdcp_link_adjustment_hdcp2 hdcp2; 181 }; 182 183 struct mod_hdcp_error { 184 enum mod_hdcp_status status; 185 uint8_t state_id; 186 }; 187 188 struct mod_hdcp_trace { 189 struct mod_hdcp_error errors[MAX_NUM_OF_ERROR_TRACE]; 190 uint8_t error_count; 191 }; 192 193 enum mod_hdcp_encryption_status { 194 MOD_HDCP_ENCRYPTION_STATUS_HDCP_OFF = 0, 195 MOD_HDCP_ENCRYPTION_STATUS_HDCP1_ON, 196 MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE0_ON, 197 MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE1_ON, 198 MOD_HDCP_ENCRYPTION_STATUS_HDCP2_ON 199 }; 200 201 /* per link events dm has to notify to hdcp module */ 202 enum mod_hdcp_event { 203 MOD_HDCP_EVENT_CALLBACK = 0, 204 MOD_HDCP_EVENT_WATCHDOG_TIMEOUT, 205 MOD_HDCP_EVENT_CPIRQ 206 }; 207 208 /* output flags from module requesting timer operations */ 209 struct mod_hdcp_output { 210 uint8_t callback_needed; 211 uint8_t callback_stop; 212 uint8_t watchdog_timer_needed; 213 uint8_t watchdog_timer_stop; 214 uint16_t callback_delay; 215 uint16_t watchdog_timer_delay; 216 }; 217 218 /* used to represent per display info */ 219 struct mod_hdcp_display { 220 enum mod_hdcp_display_state state; 221 uint8_t index; 222 uint8_t controller; 223 uint8_t dig_fe; 224 union { 225 uint8_t vc_id; 226 }; 227 struct mod_hdcp_display_adjustment adjust; 228 }; 229 230 /* used to represent per link info */ 231 /* in case a link has multiple displays, they share the same link info */ 232 struct mod_hdcp_link { 233 enum mod_hdcp_operation_mode mode; 234 uint8_t dig_be; 235 uint8_t ddc_line; 236 union { 237 struct mod_hdcp_displayport dp; 238 struct mod_hdcp_hdmi hdmi; 239 }; 240 struct mod_hdcp_link_adjustment adjust; 241 }; 242 243 /* a query structure for a display's hdcp information */ 244 struct mod_hdcp_display_query { 245 const struct mod_hdcp_display *display; 246 const struct mod_hdcp_link *link; 247 const struct mod_hdcp_trace *trace; 248 enum mod_hdcp_encryption_status encryption_status; 249 }; 250 251 /* contains values per on external display configuration change */ 252 struct mod_hdcp_config { 253 struct mod_hdcp_psp psp; 254 struct mod_hdcp_ddc ddc; 255 uint8_t index; 256 }; 257 258 struct mod_hdcp; 259 260 /* dm allocates memory of mod_hdcp per dc_link on dm init based on memory size*/ 261 size_t mod_hdcp_get_memory_size(void); 262 263 /* called per link on link creation */ 264 enum mod_hdcp_status mod_hdcp_setup(struct mod_hdcp *hdcp, 265 struct mod_hdcp_config *config); 266 267 /* called per link on link destroy */ 268 enum mod_hdcp_status mod_hdcp_teardown(struct mod_hdcp *hdcp); 269 270 /* called per display on cp_desired set to true */ 271 enum mod_hdcp_status mod_hdcp_add_display(struct mod_hdcp *hdcp, 272 struct mod_hdcp_link *link, struct mod_hdcp_display *display, 273 struct mod_hdcp_output *output); 274 275 /* called per display on cp_desired set to false */ 276 enum mod_hdcp_status mod_hdcp_remove_display(struct mod_hdcp *hdcp, 277 uint8_t index, struct mod_hdcp_output *output); 278 279 /* called to query hdcp information on a specific index */ 280 enum mod_hdcp_status mod_hdcp_query_display(struct mod_hdcp *hdcp, 281 uint8_t index, struct mod_hdcp_display_query *query); 282 283 /* called per link on connectivity change */ 284 enum mod_hdcp_status mod_hdcp_reset_connection(struct mod_hdcp *hdcp, 285 struct mod_hdcp_output *output); 286 287 /* called per link on events (i.e. callback, watchdog, CP_IRQ) */ 288 enum mod_hdcp_status mod_hdcp_process_event(struct mod_hdcp *hdcp, 289 enum mod_hdcp_event event, struct mod_hdcp_output *output); 290 291 /* called to convert enum mod_hdcp_status to c string */ 292 char *mod_hdcp_status_to_str(int32_t status); 293 294 /* called to convert state id to c string */ 295 char *mod_hdcp_state_id_to_str(int32_t id); 296 297 /* called to convert signal type to operation mode */ 298 enum mod_hdcp_operation_mode mod_hdcp_signal_type_to_operation_mode( 299 enum signal_type signal); 300 #endif /* MOD_HDCP_H_ */ 301