1 /* 2 * Copyright 2018 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 #define MOD_HDCP_STATUS_LIST(FORMAT) \ 39 FORMAT(MOD_HDCP_STATUS_SUCCESS) \ 40 FORMAT(MOD_HDCP_STATUS_FAILURE) \ 41 FORMAT(MOD_HDCP_STATUS_RESET_NEEDED) \ 42 FORMAT(MOD_HDCP_STATUS_DISPLAY_OUT_OF_BOUND) \ 43 FORMAT(MOD_HDCP_STATUS_DISPLAY_NOT_FOUND) \ 44 FORMAT(MOD_HDCP_STATUS_INVALID_STATE) \ 45 FORMAT(MOD_HDCP_STATUS_NOT_IMPLEMENTED) \ 46 FORMAT(MOD_HDCP_STATUS_INTERNAL_POLICY_FAILURE) \ 47 FORMAT(MOD_HDCP_STATUS_UPDATE_TOPOLOGY_FAILURE) \ 48 FORMAT(MOD_HDCP_STATUS_CREATE_PSP_SERVICE_FAILURE) \ 49 FORMAT(MOD_HDCP_STATUS_DESTROY_PSP_SERVICE_FAILURE) \ 50 FORMAT(MOD_HDCP_STATUS_HDCP1_CREATE_SESSION_FAILURE) \ 51 FORMAT(MOD_HDCP_STATUS_HDCP1_DESTROY_SESSION_FAILURE) \ 52 FORMAT(MOD_HDCP_STATUS_HDCP1_VALIDATE_ENCRYPTION_FAILURE) \ 53 FORMAT(MOD_HDCP_STATUS_HDCP1_NOT_HDCP_REPEATER) \ 54 FORMAT(MOD_HDCP_STATUS_HDCP1_NOT_CAPABLE) \ 55 FORMAT(MOD_HDCP_STATUS_HDCP1_R0_PRIME_PENDING) \ 56 FORMAT(MOD_HDCP_STATUS_HDCP1_VALIDATE_RX_FAILURE) \ 57 FORMAT(MOD_HDCP_STATUS_HDCP1_BKSV_REVOKED) \ 58 FORMAT(MOD_HDCP_STATUS_HDCP1_KSV_LIST_NOT_READY) \ 59 FORMAT(MOD_HDCP_STATUS_HDCP1_VALIDATE_KSV_LIST_FAILURE) \ 60 FORMAT(MOD_HDCP_STATUS_HDCP1_KSV_LIST_REVOKED) \ 61 FORMAT(MOD_HDCP_STATUS_HDCP1_ENABLE_ENCRYPTION_FAILURE) \ 62 FORMAT(MOD_HDCP_STATUS_HDCP1_ENABLE_STREAM_ENCRYPTION_FAILURE) \ 63 FORMAT(MOD_HDCP_STATUS_HDCP1_MAX_CASCADE_EXCEEDED_FAILURE) \ 64 FORMAT(MOD_HDCP_STATUS_HDCP1_MAX_DEVS_EXCEEDED_FAILURE) \ 65 FORMAT(MOD_HDCP_STATUS_HDCP1_DEVICE_COUNT_MISMATCH_FAILURE) \ 66 FORMAT(MOD_HDCP_STATUS_HDCP1_LINK_INTEGRITY_FAILURE) \ 67 FORMAT(MOD_HDCP_STATUS_HDCP1_REAUTH_REQUEST_ISSUED) \ 68 FORMAT(MOD_HDCP_STATUS_HDCP1_LINK_MAINTENANCE_FAILURE) \ 69 FORMAT(MOD_HDCP_STATUS_HDCP1_INVALID_BKSV) \ 70 FORMAT(MOD_HDCP_STATUS_DDC_FAILURE) /* TODO: specific errors */ \ 71 FORMAT(MOD_HDCP_STATUS_INVALID_OPERATION) \ 72 FORMAT(MOD_HDCP_STATUS_HDCP2_NOT_CAPABLE) \ 73 FORMAT(MOD_HDCP_STATUS_HDCP2_CREATE_SESSION_FAILURE) \ 74 FORMAT(MOD_HDCP_STATUS_HDCP2_DESTROY_SESSION_FAILURE) \ 75 FORMAT(MOD_HDCP_STATUS_HDCP2_PREP_AKE_INIT_FAILURE) \ 76 FORMAT(MOD_HDCP_STATUS_HDCP2_AKE_CERT_PENDING) \ 77 FORMAT(MOD_HDCP_STATUS_HDCP2_H_PRIME_PENDING) \ 78 FORMAT(MOD_HDCP_STATUS_HDCP2_PAIRING_INFO_PENDING) \ 79 FORMAT(MOD_HDCP_STATUS_HDCP2_VALIDATE_AKE_CERT_FAILURE) \ 80 FORMAT(MOD_HDCP_STATUS_HDCP2_AKE_CERT_REVOKED) \ 81 FORMAT(MOD_HDCP_STATUS_HDCP2_VALIDATE_H_PRIME_FAILURE) \ 82 FORMAT(MOD_HDCP_STATUS_HDCP2_VALIDATE_PAIRING_INFO_FAILURE) \ 83 FORMAT(MOD_HDCP_STATUS_HDCP2_PREP_LC_INIT_FAILURE) \ 84 FORMAT(MOD_HDCP_STATUS_HDCP2_L_PRIME_PENDING) \ 85 FORMAT(MOD_HDCP_STATUS_HDCP2_VALIDATE_L_PRIME_FAILURE) \ 86 FORMAT(MOD_HDCP_STATUS_HDCP2_PREP_EKS_FAILURE) \ 87 FORMAT(MOD_HDCP_STATUS_HDCP2_ENABLE_ENCRYPTION_FAILURE) \ 88 FORMAT(MOD_HDCP_STATUS_HDCP2_RX_ID_LIST_NOT_READY) \ 89 FORMAT(MOD_HDCP_STATUS_HDCP2_VALIDATE_RX_ID_LIST_FAILURE) \ 90 FORMAT(MOD_HDCP_STATUS_HDCP2_RX_ID_LIST_REVOKED) \ 91 FORMAT(MOD_HDCP_STATUS_HDCP2_ENABLE_STREAM_ENCRYPTION_FAILURE) \ 92 FORMAT(MOD_HDCP_STATUS_HDCP2_STREAM_READY_PENDING) \ 93 FORMAT(MOD_HDCP_STATUS_HDCP2_VALIDATE_STREAM_READY_FAILURE) \ 94 FORMAT(MOD_HDCP_STATUS_HDCP2_PREPARE_STREAM_MANAGEMENT_FAILURE) \ 95 FORMAT(MOD_HDCP_STATUS_HDCP2_REAUTH_REQUEST) \ 96 FORMAT(MOD_HDCP_STATUS_HDCP2_REAUTH_LINK_INTEGRITY_FAILURE) \ 97 FORMAT(MOD_HDCP_STATUS_HDCP2_DEVICE_COUNT_MISMATCH_FAILURE) \ 98 FORMAT(MOD_HDCP_STATUS_UNSUPPORTED_PSP_VER_FAILURE) \ 99 FORMAT(MOD_HDCP_STATUS_HDCP2_LOCALITY_COMBO_READ_FAILURE) 100 101 #define ENUM_FORMAT(entry) entry, 102 103 /* detailed return status */ 104 enum mod_hdcp_status { 105 MOD_HDCP_STATUS_LIST(ENUM_FORMAT) 106 }; 107 108 struct mod_hdcp_displayport { 109 uint8_t rev; 110 uint8_t assr_enabled; 111 uint8_t mst_enabled; 112 uint8_t dp2_enabled; 113 uint8_t usb4_enabled; 114 }; 115 116 struct mod_hdcp_hdmi { 117 uint8_t frl_enabled; 118 uint8_t reserved; 119 }; 120 enum mod_hdcp_operation_mode { 121 MOD_HDCP_MODE_OFF, 122 MOD_HDCP_MODE_DEFAULT, 123 MOD_HDCP_MODE_DP 124 }; 125 126 enum mod_hdcp_display_state { 127 MOD_HDCP_DISPLAY_INACTIVE = 0, 128 MOD_HDCP_DISPLAY_ACTIVE, 129 MOD_HDCP_DISPLAY_ENCRYPTION_ENABLED 130 }; 131 132 struct mod_hdcp_psp_caps { 133 uint8_t dtm_v3_supported; 134 }; 135 136 enum mod_hdcp_display_disable_option { 137 MOD_HDCP_DISPLAY_NOT_DISABLE = 0, 138 MOD_HDCP_DISPLAY_DISABLE_AUTHENTICATION, 139 MOD_HDCP_DISPLAY_DISABLE_ENCRYPTION, 140 }; 141 142 struct mod_hdcp_atomic_op_i2c { 143 uint8_t address; 144 uint8_t offset; 145 uint8_t *data; 146 uint32_t size; 147 }; 148 149 struct mod_hdcp_atomic_op_aux { 150 uint32_t address; 151 uint8_t *data; 152 uint32_t size; 153 }; 154 155 struct mod_hdcp_ddc { 156 void *handle; 157 struct mod_hdcp_ddc_funcs { 158 bool (*read_i2c)(void *handle, 159 uint32_t address, 160 uint8_t offset, 161 uint8_t *data, 162 uint32_t size); 163 bool (*write_i2c)(void *handle, 164 uint32_t address, 165 const uint8_t *data, 166 uint32_t size); 167 bool (*read_dpcd)(void *handle, 168 uint32_t address, 169 uint8_t *data, 170 uint32_t size); 171 bool (*write_dpcd)(void *handle, 172 uint32_t address, 173 const uint8_t *data, 174 uint32_t size); 175 bool (*atomic_write_poll_read_i2c)( 176 void *handle, 177 const struct mod_hdcp_atomic_op_i2c *write, 178 const struct mod_hdcp_atomic_op_i2c *poll, 179 struct mod_hdcp_atomic_op_i2c *read, 180 uint32_t poll_timeout_us, 181 uint8_t poll_mask_msb 182 ); 183 bool (*atomic_write_poll_read_aux)( 184 void *handle, 185 const struct mod_hdcp_atomic_op_aux *write, 186 const struct mod_hdcp_atomic_op_aux *poll, 187 struct mod_hdcp_atomic_op_aux *read, 188 uint32_t poll_timeout_us, 189 uint8_t poll_mask_msb 190 ); 191 } funcs; 192 }; 193 194 struct mod_hdcp_psp { 195 void *handle; 196 void *funcs; 197 struct mod_hdcp_psp_caps caps; 198 }; 199 200 struct mod_hdcp_display_adjustment { 201 uint8_t disable : 2; 202 uint8_t reserved : 6; 203 }; 204 205 struct mod_hdcp_link_adjustment_hdcp1 { 206 uint8_t disable : 1; 207 uint8_t postpone_encryption : 1; 208 uint8_t min_auth_retries_wa : 1; 209 uint8_t reserved : 5; 210 }; 211 212 enum mod_hdcp_force_hdcp_type { 213 MOD_HDCP_FORCE_TYPE_MAX = 0, 214 MOD_HDCP_FORCE_TYPE_0, 215 MOD_HDCP_FORCE_TYPE_1 216 }; 217 218 struct mod_hdcp_link_adjustment_hdcp2 { 219 uint8_t disable : 1; 220 uint8_t force_type : 2; 221 uint8_t force_no_stored_km : 1; 222 uint8_t increase_h_prime_timeout: 1; 223 uint8_t use_fw_locality_check : 1; 224 uint8_t use_sw_locality_fallback: 1; 225 uint8_t reserved : 1; 226 }; 227 228 struct mod_hdcp_link_adjustment { 229 uint8_t auth_delay; 230 uint8_t retry_limit; 231 struct mod_hdcp_link_adjustment_hdcp1 hdcp1; 232 struct mod_hdcp_link_adjustment_hdcp2 hdcp2; 233 }; 234 235 struct mod_hdcp_error { 236 enum mod_hdcp_status status; 237 uint8_t state_id; 238 }; 239 240 struct mod_hdcp1_trace { 241 uint8_t attempt_count; 242 uint8_t downstream_device_count; 243 }; 244 245 struct mod_hdcp2_trace { 246 uint8_t attempt_count; 247 uint8_t downstream_device_count; 248 uint8_t hdcp1_device_downstream; 249 uint8_t hdcp2_legacy_device_downstream; 250 }; 251 252 struct mod_hdcp_trace { 253 struct mod_hdcp_error errors[MAX_NUM_OF_ERROR_TRACE]; 254 uint8_t error_count; 255 struct mod_hdcp1_trace hdcp1; 256 struct mod_hdcp2_trace hdcp2; 257 }; 258 259 enum mod_hdcp_encryption_status { 260 MOD_HDCP_ENCRYPTION_STATUS_HDCP_OFF = 0, 261 MOD_HDCP_ENCRYPTION_STATUS_HDCP1_ON, 262 MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE0_ON, 263 MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE1_ON, 264 MOD_HDCP_ENCRYPTION_STATUS_HDCP2_ON 265 }; 266 267 /* per link events dm has to notify to hdcp module */ 268 enum mod_hdcp_event { 269 MOD_HDCP_EVENT_CALLBACK = 0, 270 MOD_HDCP_EVENT_WATCHDOG_TIMEOUT, 271 MOD_HDCP_EVENT_CPIRQ 272 }; 273 274 /* output flags from module requesting timer operations */ 275 struct mod_hdcp_output { 276 uint8_t callback_needed; 277 uint8_t callback_stop; 278 uint8_t watchdog_timer_needed; 279 uint8_t watchdog_timer_stop; 280 uint16_t callback_delay; 281 uint16_t watchdog_timer_delay; 282 uint8_t auth_complete; 283 }; 284 285 /* used to represent per display info */ 286 struct mod_hdcp_display { 287 enum mod_hdcp_display_state state; 288 uint8_t index; 289 uint8_t controller; 290 uint8_t dig_fe; 291 uint8_t stream_enc_idx; 292 union { 293 uint8_t vc_id; 294 }; 295 struct mod_hdcp_display_adjustment adjust; 296 }; 297 298 /* used to represent per link info */ 299 /* in case a link has multiple displays, they share the same link info */ 300 struct mod_hdcp_link { 301 enum mod_hdcp_operation_mode mode; 302 uint8_t dig_be; 303 uint8_t ddc_line; 304 uint8_t link_enc_idx; 305 uint8_t phy_idx; 306 uint8_t dio_output_id; 307 uint8_t hdcp_supported_informational; 308 union { 309 struct mod_hdcp_displayport dp; 310 struct mod_hdcp_hdmi hdmi; 311 }; 312 struct mod_hdcp_link_adjustment adjust; 313 }; 314 315 /* a query structure for a display's hdcp information */ 316 struct mod_hdcp_display_query { 317 const struct mod_hdcp_display *display; 318 const struct mod_hdcp_link *link; 319 const struct mod_hdcp_trace *trace; 320 enum mod_hdcp_encryption_status encryption_status; 321 }; 322 323 /* contains values per on external display configuration change */ 324 struct mod_hdcp_config { 325 struct mod_hdcp_psp psp; 326 struct mod_hdcp_ddc ddc; 327 uint8_t index; 328 }; 329 330 /* dm allocates memory of mod_hdcp per dc_link on dm init based on memory size*/ 331 size_t mod_hdcp_get_memory_size(void); 332 333 /* called per link on link creation */ 334 enum mod_hdcp_status mod_hdcp_setup(struct mod_hdcp *hdcp, 335 struct mod_hdcp_config *config); 336 337 /* called per link on link destroy */ 338 enum mod_hdcp_status mod_hdcp_teardown(struct mod_hdcp *hdcp); 339 340 /* called per display after stream is enabled */ 341 enum mod_hdcp_status mod_hdcp_add_display(struct mod_hdcp *hdcp, 342 struct mod_hdcp_link *link, struct mod_hdcp_display *display, 343 struct mod_hdcp_output *output); 344 345 /* called per display before stream is disabled */ 346 enum mod_hdcp_status mod_hdcp_remove_display(struct mod_hdcp *hdcp, 347 uint8_t index, struct mod_hdcp_output *output); 348 349 /* called per display to apply new authentication adjustment */ 350 enum mod_hdcp_status mod_hdcp_update_display(struct mod_hdcp *hdcp, 351 uint8_t index, 352 struct mod_hdcp_link_adjustment *link_adjust, 353 struct mod_hdcp_display_adjustment *display_adjust, 354 struct mod_hdcp_output *output); 355 356 /* called to query hdcp information on a specific index */ 357 enum mod_hdcp_status mod_hdcp_query_display(struct mod_hdcp *hdcp, 358 uint8_t index, struct mod_hdcp_display_query *query); 359 360 /* called per link on connectivity change */ 361 enum mod_hdcp_status mod_hdcp_reset_connection(struct mod_hdcp *hdcp, 362 struct mod_hdcp_output *output); 363 364 /* called per link on events (i.e. callback, watchdog, CP_IRQ) */ 365 enum mod_hdcp_status mod_hdcp_process_event(struct mod_hdcp *hdcp, 366 enum mod_hdcp_event event, struct mod_hdcp_output *output); 367 368 /* called to convert enum mod_hdcp_status to c string */ 369 char *mod_hdcp_status_to_str(int32_t status); 370 371 /* called to convert state id to c string */ 372 char *mod_hdcp_state_id_to_str(int32_t id); 373 374 /* called to convert signal type to operation mode */ 375 enum mod_hdcp_operation_mode mod_hdcp_signal_type_to_operation_mode( 376 enum signal_type signal); 377 #endif /* MOD_HDCP_H_ */ 378