modules/inc/mod_hdcp.h

0001 /*
0002  * Copyright 2018 Advanced Micro Devices, Inc.
0003  *
0004  * Permission is hereby granted, free of charge, to any person obtaining a
0005  * copy of this software and associated documentation files (the "Software"),
0006  * to deal in the Software without restriction, including without limitation
0007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
0008  * and/or sell copies of the Software, and to permit persons to whom the
0009  * Software is furnished to do so, subject to the following conditions:
0010  *
0011  * The above copyright notice and this permission notice shall be included in
0012  * all copies or substantial portions of the Software.
0013  *
0014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
0017  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
0018  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
0019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
0020  * OTHER DEALINGS IN THE SOFTWARE.
0021  *
0022  * Authors: AMD
0023  *
0024  */
0025
0026 #ifndef MOD_HDCP_H_
0027 #define MOD_HDCP_H_
0028
0029 #include "os_types.h"
0030 #include "signal_types.h"
0031
0032 /* Forward Declarations */
0033 struct mod_hdcp;
0034
0035 #define MAX_NUM_OF_DISPLAYS 6
0036 #define MAX_NUM_OF_ATTEMPTS 4
0037 #define MAX_NUM_OF_ERROR_TRACE 10
0038
0039 /* detailed return status */
0040 enum mod_hdcp_status {
0041     MOD_HDCP_STATUS_SUCCESS = 0,
0042     MOD_HDCP_STATUS_FAILURE,
0043     MOD_HDCP_STATUS_RESET_NEEDED,
0044     MOD_HDCP_STATUS_DISPLAY_OUT_OF_BOUND,
0045     MOD_HDCP_STATUS_DISPLAY_NOT_FOUND,
0046     MOD_HDCP_STATUS_INVALID_STATE,
0047     MOD_HDCP_STATUS_NOT_IMPLEMENTED,
0048     MOD_HDCP_STATUS_INTERNAL_POLICY_FAILURE,
0049     MOD_HDCP_STATUS_UPDATE_TOPOLOGY_FAILURE,
0050     MOD_HDCP_STATUS_CREATE_PSP_SERVICE_FAILURE,
0051     MOD_HDCP_STATUS_DESTROY_PSP_SERVICE_FAILURE,
0052     MOD_HDCP_STATUS_HDCP1_CREATE_SESSION_FAILURE,
0053     MOD_HDCP_STATUS_HDCP1_DESTROY_SESSION_FAILURE,
0054     MOD_HDCP_STATUS_HDCP1_VALIDATE_ENCRYPTION_FAILURE,
0055     MOD_HDCP_STATUS_HDCP1_NOT_HDCP_REPEATER,
0056     MOD_HDCP_STATUS_HDCP1_NOT_CAPABLE,
0057     MOD_HDCP_STATUS_HDCP1_R0_PRIME_PENDING,
0058     MOD_HDCP_STATUS_HDCP1_VALIDATE_RX_FAILURE,
0059     MOD_HDCP_STATUS_HDCP1_BKSV_REVOKED,
0060     MOD_HDCP_STATUS_HDCP1_KSV_LIST_NOT_READY,
0061     MOD_HDCP_STATUS_HDCP1_VALIDATE_KSV_LIST_FAILURE,
0062     MOD_HDCP_STATUS_HDCP1_KSV_LIST_REVOKED,
0063     MOD_HDCP_STATUS_HDCP1_ENABLE_ENCRYPTION_FAILURE,
0064     MOD_HDCP_STATUS_HDCP1_ENABLE_STREAM_ENCRYPTION_FAILURE,
0065     MOD_HDCP_STATUS_HDCP1_MAX_CASCADE_EXCEEDED_FAILURE,
0066     MOD_HDCP_STATUS_HDCP1_MAX_DEVS_EXCEEDED_FAILURE,
0067     MOD_HDCP_STATUS_HDCP1_DEVICE_COUNT_MISMATCH_FAILURE,
0068     MOD_HDCP_STATUS_HDCP1_LINK_INTEGRITY_FAILURE,
0069     MOD_HDCP_STATUS_HDCP1_REAUTH_REQUEST_ISSUED,
0070     MOD_HDCP_STATUS_HDCP1_LINK_MAINTENANCE_FAILURE,
0071     MOD_HDCP_STATUS_HDCP1_INVALID_BKSV,
0072     MOD_HDCP_STATUS_DDC_FAILURE, /* TODO: specific errors */
0073     MOD_HDCP_STATUS_INVALID_OPERATION,
0074     MOD_HDCP_STATUS_HDCP2_NOT_CAPABLE,
0075     MOD_HDCP_STATUS_HDCP2_CREATE_SESSION_FAILURE,
0076     MOD_HDCP_STATUS_HDCP2_DESTROY_SESSION_FAILURE,
0077     MOD_HDCP_STATUS_HDCP2_PREP_AKE_INIT_FAILURE,
0078     MOD_HDCP_STATUS_HDCP2_AKE_CERT_PENDING,
0079     MOD_HDCP_STATUS_HDCP2_H_PRIME_PENDING,
0080     MOD_HDCP_STATUS_HDCP2_PAIRING_INFO_PENDING,
0081     MOD_HDCP_STATUS_HDCP2_VALIDATE_AKE_CERT_FAILURE,
0082     MOD_HDCP_STATUS_HDCP2_AKE_CERT_REVOKED,
0083     MOD_HDCP_STATUS_HDCP2_VALIDATE_H_PRIME_FAILURE,
0084     MOD_HDCP_STATUS_HDCP2_VALIDATE_PAIRING_INFO_FAILURE,
0085     MOD_HDCP_STATUS_HDCP2_PREP_LC_INIT_FAILURE,
0086     MOD_HDCP_STATUS_HDCP2_L_PRIME_PENDING,
0087     MOD_HDCP_STATUS_HDCP2_VALIDATE_L_PRIME_FAILURE,
0088     MOD_HDCP_STATUS_HDCP2_PREP_EKS_FAILURE,
0089     MOD_HDCP_STATUS_HDCP2_ENABLE_ENCRYPTION_FAILURE,
0090     MOD_HDCP_STATUS_HDCP2_RX_ID_LIST_NOT_READY,
0091     MOD_HDCP_STATUS_HDCP2_VALIDATE_RX_ID_LIST_FAILURE,
0092     MOD_HDCP_STATUS_HDCP2_RX_ID_LIST_REVOKED,
0093     MOD_HDCP_STATUS_HDCP2_ENABLE_STREAM_ENCRYPTION_FAILURE,
0094     MOD_HDCP_STATUS_HDCP2_STREAM_READY_PENDING,
0095     MOD_HDCP_STATUS_HDCP2_VALIDATE_STREAM_READY_FAILURE,
0096     MOD_HDCP_STATUS_HDCP2_PREPARE_STREAM_MANAGEMENT_FAILURE,
0097     MOD_HDCP_STATUS_HDCP2_REAUTH_REQUEST,
0098     MOD_HDCP_STATUS_HDCP2_REAUTH_LINK_INTEGRITY_FAILURE,
0099     MOD_HDCP_STATUS_HDCP2_DEVICE_COUNT_MISMATCH_FAILURE,
0100     MOD_HDCP_STATUS_UNSUPPORTED_PSP_VER_FAILURE,
0101 };
0102
0103 struct mod_hdcp_displayport {
0104     uint8_t rev;
0105     uint8_t assr_enabled;
0106     uint8_t mst_enabled;
0107     uint8_t usb4_enabled;
0108 };
0109
0110 struct mod_hdcp_hdmi {
0111     uint8_t reserved;
0112 };
0113 enum mod_hdcp_operation_mode {
0114     MOD_HDCP_MODE_OFF,
0115     MOD_HDCP_MODE_DEFAULT,
0116     MOD_HDCP_MODE_DP
0117 };
0118
0119 enum mod_hdcp_display_state {
0120     MOD_HDCP_DISPLAY_INACTIVE = 0,
0121     MOD_HDCP_DISPLAY_ACTIVE,
0122     MOD_HDCP_DISPLAY_ENCRYPTION_ENABLED
0123 };
0124
0125 struct mod_hdcp_psp_caps {
0126     uint8_t dtm_v3_supported;
0127 };
0128
0129 enum mod_hdcp_display_disable_option {
0130     MOD_HDCP_DISPLAY_NOT_DISABLE = 0,
0131     MOD_HDCP_DISPLAY_DISABLE_AUTHENTICATION,
0132     MOD_HDCP_DISPLAY_DISABLE_ENCRYPTION,
0133 };
0134
0135 struct mod_hdcp_ddc {
0136     void *handle;
0137     struct {
0138         bool (*read_i2c)(void *handle,
0139                 uint32_t address,
0140                 uint8_t offset,
0141                 uint8_t *data,
0142                 uint32_t size);
0143         bool (*write_i2c)(void *handle,
0144                 uint32_t address,
0145                 const uint8_t *data,
0146                 uint32_t size);
0147         bool (*read_dpcd)(void *handle,
0148                 uint32_t address,
0149                 uint8_t *data,
0150                 uint32_t size);
0151         bool (*write_dpcd)(void *handle,
0152                 uint32_t address,
0153                 const uint8_t *data,
0154                 uint32_t size);
0155     } funcs;
0156 };
0157
0158 struct mod_hdcp_psp {
0159     void *handle;
0160     void *funcs;
0161     struct mod_hdcp_psp_caps caps;
0162 };
0163
0164 struct mod_hdcp_display_adjustment {
0165     uint8_t disable         : 2;
0166     uint8_t reserved        : 6;
0167 };
0168
0169 struct mod_hdcp_link_adjustment_hdcp1 {
0170     uint8_t disable         : 1;
0171     uint8_t postpone_encryption : 1;
0172     uint8_t min_auth_retries_wa : 1;
0173     uint8_t reserved        : 5;
0174 };
0175
0176 enum mod_hdcp_force_hdcp_type {
0177     MOD_HDCP_FORCE_TYPE_MAX = 0,
0178     MOD_HDCP_FORCE_TYPE_0,
0179     MOD_HDCP_FORCE_TYPE_1
0180 };
0181
0182 struct mod_hdcp_link_adjustment_hdcp2 {
0183     uint8_t disable         : 1;
0184     uint8_t force_type      : 2;
0185     uint8_t force_no_stored_km  : 1;
0186     uint8_t increase_h_prime_timeout: 1;
0187     uint8_t reserved        : 3;
0188 };
0189
0190 struct mod_hdcp_link_adjustment {
0191     uint8_t auth_delay;
0192     struct mod_hdcp_link_adjustment_hdcp1 hdcp1;
0193     struct mod_hdcp_link_adjustment_hdcp2 hdcp2;
0194 };
0195
0196 struct mod_hdcp_error {
0197     enum mod_hdcp_status status;
0198     uint8_t state_id;
0199 };
0200
0201 struct mod_hdcp_trace {
0202     struct mod_hdcp_error errors[MAX_NUM_OF_ERROR_TRACE];
0203     uint8_t error_count;
0204 };
0205
0206 enum mod_hdcp_encryption_status {
0207     MOD_HDCP_ENCRYPTION_STATUS_HDCP_OFF = 0,
0208     MOD_HDCP_ENCRYPTION_STATUS_HDCP1_ON,
0209     MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE0_ON,
0210     MOD_HDCP_ENCRYPTION_STATUS_HDCP2_TYPE1_ON,
0211     MOD_HDCP_ENCRYPTION_STATUS_HDCP2_ON
0212 };
0213
0214 /* per link events dm has to notify to hdcp module */
0215 enum mod_hdcp_event {
0216     MOD_HDCP_EVENT_CALLBACK = 0,
0217     MOD_HDCP_EVENT_WATCHDOG_TIMEOUT,
0218     MOD_HDCP_EVENT_CPIRQ
0219 };
0220
0221 /* output flags from module requesting timer operations */
0222 struct mod_hdcp_output {
0223     uint8_t callback_needed;
0224     uint8_t callback_stop;
0225     uint8_t watchdog_timer_needed;
0226     uint8_t watchdog_timer_stop;
0227     uint16_t callback_delay;
0228     uint16_t watchdog_timer_delay;
0229     uint8_t auth_complete;
0230 };
0231
0232 /* used to represent per display info */
0233 struct mod_hdcp_display {
0234     enum mod_hdcp_display_state state;
0235     uint8_t index;
0236     uint8_t controller;
0237     uint8_t dig_fe;
0238     uint8_t stream_enc_idx;
0239     union {
0240         uint8_t vc_id;
0241     };
0242     struct mod_hdcp_display_adjustment adjust;
0243 };
0244
0245 /* used to represent per link info */
0246 /* in case a link has multiple displays, they share the same link info */
0247 struct mod_hdcp_link {
0248     enum mod_hdcp_operation_mode mode;
0249     uint8_t dig_be;
0250     uint8_t ddc_line;
0251     uint8_t link_enc_idx;
0252     uint8_t phy_idx;
0253     uint8_t dio_output_id;
0254     uint8_t hdcp_supported_informational;
0255     union {
0256         struct mod_hdcp_displayport dp;
0257         struct mod_hdcp_hdmi hdmi;
0258     };
0259     struct mod_hdcp_link_adjustment adjust;
0260 };
0261
0262 /* a query structure for a display's hdcp information */
0263 struct mod_hdcp_display_query {
0264     const struct mod_hdcp_display *display;
0265     const struct mod_hdcp_link *link;
0266     const struct mod_hdcp_trace *trace;
0267     enum mod_hdcp_encryption_status encryption_status;
0268 };
0269
0270 /* contains values per on external display configuration change */
0271 struct mod_hdcp_config {
0272     struct mod_hdcp_psp psp;
0273     struct mod_hdcp_ddc ddc;
0274     uint8_t index;
0275 };
0276
0277 /* dm allocates memory of mod_hdcp per dc_link on dm init based on memory size*/
0278 size_t mod_hdcp_get_memory_size(void);
0279
0280 /* called per link on link creation */
0281 enum mod_hdcp_status mod_hdcp_setup(struct mod_hdcp *hdcp,
0282         struct mod_hdcp_config *config);
0283
0284 /* called per link on link destroy */
0285 enum mod_hdcp_status mod_hdcp_teardown(struct mod_hdcp *hdcp);
0286
0287 /* called per display after stream is enabled */
0288 enum mod_hdcp_status mod_hdcp_add_display(struct mod_hdcp *hdcp,
0289         struct mod_hdcp_link *link, struct mod_hdcp_display *display,
0290         struct mod_hdcp_output *output);
0291
0292 /* called per display before stream is disabled */
0293 enum mod_hdcp_status mod_hdcp_remove_display(struct mod_hdcp *hdcp,
0294         uint8_t index, struct mod_hdcp_output *output);
0295
0296 /* called per display to apply new authentication adjustment */
0297 enum mod_hdcp_status mod_hdcp_update_display(struct mod_hdcp *hdcp,
0298         uint8_t index,
0299         struct mod_hdcp_link_adjustment *link_adjust,
0300         struct mod_hdcp_display_adjustment *display_adjust,
0301         struct mod_hdcp_output *output);
0302
0303 /* called to query hdcp information on a specific index */
0304 enum mod_hdcp_status mod_hdcp_query_display(struct mod_hdcp *hdcp,
0305         uint8_t index, struct mod_hdcp_display_query *query);
0306
0307 /* called per link on connectivity change */
0308 enum mod_hdcp_status mod_hdcp_reset_connection(struct mod_hdcp *hdcp,
0309         struct mod_hdcp_output *output);
0310
0311 /* called per link on events (i.e. callback, watchdog, CP_IRQ) */
0312 enum mod_hdcp_status mod_hdcp_process_event(struct mod_hdcp *hdcp,
0313         enum mod_hdcp_event event, struct mod_hdcp_output *output);
0314
0315 /* called to convert enum mod_hdcp_status to c string */
0316 char *mod_hdcp_status_to_str(int32_t status);
0317
0318 /* called to convert state id to c string */
0319 char *mod_hdcp_state_id_to_str(int32_t id);
0320
0321 /* called to convert signal type to operation mode */
0322 enum mod_hdcp_operation_mode mod_hdcp_signal_type_to_operation_mode(
0323         enum signal_type signal);
0324 #endif /* MOD_HDCP_H_ */