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