1/*
2 * Copyright 2016 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
28
29/*
30 * Copyright 2016 Advanced Micro Devices, Inc.
31 *
32 * Permission is hereby granted, free of charge, to any person obtaining a
33 * copy of this software and associated documentation files (the "Software"),
34 * to deal in the Software without restriction, including without limitation
35 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
36 * and/or sell copies of the Software, and to permit persons to whom the
37 * Software is furnished to do so, subject to the following conditions:
38 *
39 * The above copyright notice and this permission notice shall be included in
40 * all copies or substantial portions of the Software.
41 *
42 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
43 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
44 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
45 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
46 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
47 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
48 * OTHER DEALINGS IN THE SOFTWARE.
49 *
50 * Authors: AMD
51 *
52 */
53
54#ifndef MOD_FREESYNC_H_
55#define MOD_FREESYNC_H_
56
57#include "mod_shared.h"
58
59// Access structures
60struct mod_freesync {
61 int dummy;
62};
63
64// TODO: References to this should be removed
65struct mod_freesync_caps {
66 bool supported;
67 unsigned int min_refresh_in_micro_hz;
68 unsigned int max_refresh_in_micro_hz;
69};
70
71enum mod_vrr_state {
72 VRR_STATE_UNSUPPORTED = 0,
73 VRR_STATE_DISABLED,
74 VRR_STATE_INACTIVE,
75 VRR_STATE_ACTIVE_VARIABLE,
76 VRR_STATE_ACTIVE_FIXED
77};
78
79struct mod_freesync_config {
80 enum mod_vrr_state state;
81 bool vsif_supported;
82 bool ramping;
83 bool btr;
84 unsigned int min_refresh_in_uhz;
85 unsigned int max_refresh_in_uhz;
86 unsigned int fixed_refresh_in_uhz;
87
88};
89
90struct mod_vrr_params_btr {
91 bool btr_enabled;
92 bool btr_active;
93 uint32_t mid_point_in_us;
94 uint32_t inserted_duration_in_us;
95 uint32_t frames_to_insert;
96 uint32_t frame_counter;
97 uint32_t margin_in_us;
98};
99
100struct mod_vrr_params_fixed_refresh {
101 bool fixed_active;
102 bool ramping_active;
103 bool ramping_done;
104 uint32_t target_refresh_in_uhz;
105 uint32_t frame_counter;
106};
107
108struct mod_vrr_params_flip_interval {
109 bool flip_interval_workaround_active;
110 bool program_flip_interval_workaround;
111 bool do_flip_interval_workaround_cleanup;
112 uint32_t flip_interval_detect_counter;
113 uint32_t vsyncs_between_flip;
114 uint32_t vsync_to_flip_in_us;
115 uint32_t v_update_timestamp_in_us;
116};
117
118struct mod_vrr_params {
119 bool supported;
120 bool send_info_frame;
121 enum mod_vrr_state state;
122
123 uint32_t min_refresh_in_uhz;
124 uint32_t max_duration_in_us;
125 uint32_t max_refresh_in_uhz;
126 uint32_t min_duration_in_us;
127 uint32_t fixed_refresh_in_uhz;
128
129 struct dc_crtc_timing_adjust adjust;
130
131 struct mod_vrr_params_fixed_refresh fixed;
132
133 struct mod_vrr_params_btr btr;
134
135 struct mod_vrr_params_flip_interval flip_interval;
136};
137
138struct mod_freesync *mod_freesync_create(struct dc *dc);
139void mod_freesync_destroy(struct mod_freesync *mod_freesync);
140
141bool mod_freesync_get_vmin_vmax(struct mod_freesync *mod_freesync,
142 const struct dc_stream_state *stream,
143 unsigned int *vmin,
144 unsigned int *vmax);
145
146bool mod_freesync_get_v_position(struct mod_freesync *mod_freesync,
147 struct dc_stream_state *stream,
148 unsigned int *nom_v_pos,
149 unsigned int *v_pos);
150
151void mod_freesync_get_settings(struct mod_freesync *mod_freesync,
152 const struct mod_vrr_params *vrr,
153 unsigned int *v_total_min, unsigned int *v_total_max,
154 unsigned int *event_triggers,
155 unsigned int *window_min, unsigned int *window_max,
156 unsigned int *lfc_mid_point_in_us,
157 unsigned int *inserted_frames,
158 unsigned int *inserted_duration_in_us);
159
160void mod_freesync_build_vrr_infopacket(struct mod_freesync *mod_freesync,
161 const struct dc_stream_state *stream,
162 const struct mod_vrr_params *vrr,
163 enum vrr_packet_type packet_type,
164 enum color_transfer_func app_tf,
165 struct dc_info_packet *infopacket,
166 bool pack_sdp_v1_3);
167
168void mod_freesync_build_vrr_params(struct mod_freesync *mod_freesync,
169 const struct dc_stream_state *stream,
170 struct mod_freesync_config *in_config,
171 struct mod_vrr_params *in_out_vrr);
172
173void mod_freesync_handle_preflip(struct mod_freesync *mod_freesync,
174 const struct dc_plane_state *plane,
175 const struct dc_stream_state *stream,
176 unsigned int curr_time_stamp_in_us,
177 struct mod_vrr_params *in_out_vrr);
178
179void mod_freesync_handle_v_update(struct mod_freesync *mod_freesync,
180 const struct dc_stream_state *stream,
181 struct mod_vrr_params *in_out_vrr);
182
183unsigned long long mod_freesync_calc_nominal_field_rate(
184 const struct dc_stream_state *stream);
185
186unsigned long long mod_freesync_calc_field_rate_from_timing(
187 unsigned int vtotal, unsigned int htotal, unsigned int pix_clk);
188
189bool mod_freesync_is_valid_range(uint32_t min_refresh_cap_in_uhz,
190 uint32_t max_refresh_cap_in_uhz,
191 uint32_t nominal_field_rate_in_uhz);
192
193unsigned int mod_freesync_calc_v_total_from_refresh(
194 const struct dc_stream_state *stream,
195 unsigned int refresh_in_uhz);
196
197// Returns true when FreeSync is supported and enabled (even if it is inactive)
198bool mod_freesync_get_freesync_enabled(struct mod_vrr_params *pVrr);
199
200#endif
201

source code of linux/drivers/gpu/drm/amd/display/modules/inc/mod_freesync.h