mod_hdcp.h

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