1 /*
2  * Copyright 2022 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 
27 #ifndef __DC_LINK_DP_TRAINING_DPIA_H__
28 #define __DC_LINK_DP_TRAINING_DPIA_H__
29 #include "link_dp_training.h"
30 
31 /* The approximate time (us) it takes to transmit 9 USB4 DP clock sync packets. */
32 #define DPIA_CLK_SYNC_DELAY 16000
33 
34 /* Train DP tunneling link for USB4 DPIA display endpoint.
35  * DPIA equivalent of dc_link_dp_perfrorm_link_training.
36  * Aborts link training upon detection of sink unplug.
37  */
38 enum link_training_result dpia_perform_link_training(
39 	struct dc_link *link,
40 	const struct link_resource *link_res,
41 	const struct dc_link_settings *link_setting,
42 	bool skip_video_pattern);
43 
44 void dpia_training_abort(
45 		struct dc_link *link,
46 		struct link_training_settings *lt_settings,
47 		uint32_t hop);
48 
49 uint32_t dpia_get_eq_aux_rd_interval(
50 		const struct dc_link *link,
51 		const struct link_training_settings *lt_settings,
52 		uint32_t hop);
53 
54 void dpia_set_tps_notification(
55 		struct dc_link *link,
56 		const struct link_training_settings *lt_settings,
57 		uint8_t pattern,
58 		uint32_t offset);
59 
60 #endif /* __DC_LINK_DP_TRAINING_DPIA_H__ */
61