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