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