Loading...
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#include "dm_services.h"
27#include "dc.h"
28#include "mod_freesync.h"
29#include "core_types.h"
30
31#define MOD_FREESYNC_MAX_CONCURRENT_STREAMS 32
32
33/* Refresh rate ramp at a fixed rate of 65 Hz/second */
34#define STATIC_SCREEN_RAMP_DELTA_REFRESH_RATE_PER_FRAME ((1000 / 60) * 65)
35/* Number of elements in the render times cache array */
36#define RENDER_TIMES_MAX_COUNT 10
37/* Threshold to exit BTR (to avoid frequent enter-exits at the lower limit) */
38#define BTR_EXIT_MARGIN 2000
39/* Number of consecutive frames to check before entering/exiting fixed refresh*/
40#define FIXED_REFRESH_ENTER_FRAME_COUNT 5
41#define FIXED_REFRESH_EXIT_FRAME_COUNT 5
42
43#define FREESYNC_REGISTRY_NAME "freesync_v1"
44
45#define FREESYNC_NO_STATIC_FOR_EXTERNAL_DP_REGKEY "DalFreeSyncNoStaticForExternalDp"
46
47#define FREESYNC_NO_STATIC_FOR_INTERNAL_REGKEY "DalFreeSyncNoStaticForInternal"
48
49#define FREESYNC_DEFAULT_REGKEY "LCDFreeSyncDefault"
50
51struct gradual_static_ramp {
52 bool ramp_is_active;
53 bool ramp_direction_is_up;
54 unsigned int ramp_current_frame_duration_in_ns;
55};
56
57struct freesync_time {
58 /* video (48Hz feature) related */
59 unsigned int update_duration_in_ns;
60
61 /* BTR/fixed refresh related */
62 unsigned int prev_time_stamp_in_us;
63
64 unsigned int min_render_time_in_us;
65 unsigned int max_render_time_in_us;
66
67 unsigned int render_times_index;
68 unsigned int render_times[RENDER_TIMES_MAX_COUNT];
69
70 unsigned int min_window;
71 unsigned int max_window;
72};
73
74struct below_the_range {
75 bool btr_active;
76 bool program_btr;
77
78 unsigned int mid_point_in_us;
79
80 unsigned int inserted_frame_duration_in_us;
81 unsigned int frames_to_insert;
82 unsigned int frame_counter;
83};
84
85struct fixed_refresh {
86 bool fixed_active;
87 bool program_fixed;
88 unsigned int frame_counter;
89};
90
91struct freesync_range {
92 unsigned int min_refresh;
93 unsigned int max_frame_duration;
94 unsigned int vmax;
95
96 unsigned int max_refresh;
97 unsigned int min_frame_duration;
98 unsigned int vmin;
99};
100
101struct freesync_state {
102 bool fullscreen;
103 bool static_screen;
104 bool video;
105
106 unsigned int vmin;
107 unsigned int vmax;
108
109 struct freesync_time time;
110
111 unsigned int nominal_refresh_rate_in_micro_hz;
112 bool windowed_fullscreen;
113
114 struct gradual_static_ramp static_ramp;
115 struct below_the_range btr;
116 struct fixed_refresh fixed_refresh;
117 struct freesync_range freesync_range;
118};
119
120struct freesync_entity {
121 struct dc_stream_state *stream;
122 struct mod_freesync_caps *caps;
123 struct freesync_state state;
124 struct mod_freesync_user_enable user_enable;
125};
126
127struct freesync_registry_options {
128 bool drr_external_supported;
129 bool drr_internal_supported;
130 bool lcd_freesync_default_set;
131 int lcd_freesync_default_value;
132};
133
134struct core_freesync {
135 struct mod_freesync public;
136 struct dc *dc;
137 struct freesync_registry_options opts;
138 struct freesync_entity *map;
139 int num_entities;
140};
141
142#define MOD_FREESYNC_TO_CORE(mod_freesync)\
143 container_of(mod_freesync, struct core_freesync, public)
144
145struct mod_freesync *mod_freesync_create(struct dc *dc)
146{
147 struct core_freesync *core_freesync =
148 kzalloc(sizeof(struct core_freesync), GFP_KERNEL);
149
150
151 struct persistent_data_flag flag;
152
153 int i, data = 0;
154
155 if (core_freesync == NULL)
156 goto fail_alloc_context;
157
158 core_freesync->map = kzalloc(sizeof(struct freesync_entity) * MOD_FREESYNC_MAX_CONCURRENT_STREAMS,
159 GFP_KERNEL);
160
161 if (core_freesync->map == NULL)
162 goto fail_alloc_map;
163
164 for (i = 0; i < MOD_FREESYNC_MAX_CONCURRENT_STREAMS; i++)
165 core_freesync->map[i].stream = NULL;
166
167 core_freesync->num_entities = 0;
168
169 if (dc == NULL)
170 goto fail_construct;
171
172 core_freesync->dc = dc;
173
174 /* Create initial module folder in registry for freesync enable data */
175 flag.save_per_edid = true;
176 flag.save_per_link = false;
177 dm_write_persistent_data(dc->ctx, NULL, FREESYNC_REGISTRY_NAME,
178 NULL, NULL, 0, &flag);
179 flag.save_per_edid = false;
180 flag.save_per_link = false;
181
182 if (dm_read_persistent_data(dc->ctx, NULL, NULL,
183 FREESYNC_NO_STATIC_FOR_INTERNAL_REGKEY,
184 &data, sizeof(data), &flag)) {
185 core_freesync->opts.drr_internal_supported =
186 (data & 1) ? false : true;
187 }
188
189 if (dm_read_persistent_data(dc->ctx, NULL, NULL,
190 FREESYNC_NO_STATIC_FOR_EXTERNAL_DP_REGKEY,
191 &data, sizeof(data), &flag)) {
192 core_freesync->opts.drr_external_supported =
193 (data & 1) ? false : true;
194 }
195
196 if (dm_read_persistent_data(dc->ctx, NULL, NULL,
197 FREESYNC_DEFAULT_REGKEY,
198 &data, sizeof(data), &flag)) {
199 core_freesync->opts.lcd_freesync_default_set = true;
200 core_freesync->opts.lcd_freesync_default_value = data;
201 } else {
202 core_freesync->opts.lcd_freesync_default_set = false;
203 core_freesync->opts.lcd_freesync_default_value = 0;
204 }
205
206 return &core_freesync->public;
207
208fail_construct:
209 kfree(core_freesync->map);
210
211fail_alloc_map:
212 kfree(core_freesync);
213
214fail_alloc_context:
215 return NULL;
216}
217
218void mod_freesync_destroy(struct mod_freesync *mod_freesync)
219{
220 if (mod_freesync != NULL) {
221 int i;
222 struct core_freesync *core_freesync =
223 MOD_FREESYNC_TO_CORE(mod_freesync);
224
225 for (i = 0; i < core_freesync->num_entities; i++)
226 if (core_freesync->map[i].stream)
227 dc_stream_release(core_freesync->map[i].stream);
228
229 kfree(core_freesync->map);
230
231 kfree(core_freesync);
232 }
233}
234
235/* Given a specific dc_stream* this function finds its equivalent
236 * on the core_freesync->map and returns the corresponding index
237 */
238static unsigned int map_index_from_stream(struct core_freesync *core_freesync,
239 struct dc_stream_state *stream)
240{
241 unsigned int index = 0;
242
243 for (index = 0; index < core_freesync->num_entities; index++) {
244 if (core_freesync->map[index].stream == stream) {
245 return index;
246 }
247 }
248 /* Could not find stream requested */
249 ASSERT(false);
250 return index;
251}
252
253bool mod_freesync_add_stream(struct mod_freesync *mod_freesync,
254 struct dc_stream_state *stream, struct mod_freesync_caps *caps)
255{
256 struct dc *dc = NULL;
257 struct core_freesync *core_freesync = NULL;
258 int persistent_freesync_enable = 0;
259 struct persistent_data_flag flag;
260 unsigned int nom_refresh_rate_uhz;
261 unsigned long long temp;
262
263 if (mod_freesync == NULL)
264 return false;
265
266 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
267 dc = core_freesync->dc;
268
269 flag.save_per_edid = true;
270 flag.save_per_link = false;
271
272 if (core_freesync->num_entities < MOD_FREESYNC_MAX_CONCURRENT_STREAMS) {
273
274 dc_stream_retain(stream);
275
276 temp = stream->timing.pix_clk_khz;
277 temp *= 1000ULL * 1000ULL * 1000ULL;
278 temp = div_u64(temp, stream->timing.h_total);
279 temp = div_u64(temp, stream->timing.v_total);
280
281 nom_refresh_rate_uhz = (unsigned int) temp;
282
283 core_freesync->map[core_freesync->num_entities].stream = stream;
284 core_freesync->map[core_freesync->num_entities].caps = caps;
285
286 core_freesync->map[core_freesync->num_entities].state.
287 fullscreen = false;
288 core_freesync->map[core_freesync->num_entities].state.
289 static_screen = false;
290 core_freesync->map[core_freesync->num_entities].state.
291 video = false;
292 core_freesync->map[core_freesync->num_entities].state.time.
293 update_duration_in_ns = 0;
294 core_freesync->map[core_freesync->num_entities].state.
295 static_ramp.ramp_is_active = false;
296
297 /* get persistent data from registry */
298 if (dm_read_persistent_data(dc->ctx, stream->sink,
299 FREESYNC_REGISTRY_NAME,
300 "userenable", &persistent_freesync_enable,
301 sizeof(int), &flag)) {
302 core_freesync->map[core_freesync->num_entities].user_enable.
303 enable_for_gaming =
304 (persistent_freesync_enable & 1) ? true : false;
305 core_freesync->map[core_freesync->num_entities].user_enable.
306 enable_for_static =
307 (persistent_freesync_enable & 2) ? true : false;
308 core_freesync->map[core_freesync->num_entities].user_enable.
309 enable_for_video =
310 (persistent_freesync_enable & 4) ? true : false;
311 /* If FreeSync display and LCDFreeSyncDefault is set, use as default values write back to userenable */
312 } else if (caps->supported && (core_freesync->opts.lcd_freesync_default_set)) {
313 core_freesync->map[core_freesync->num_entities].user_enable.enable_for_gaming =
314 (core_freesync->opts.lcd_freesync_default_value & 1) ? true : false;
315 core_freesync->map[core_freesync->num_entities].user_enable.enable_for_static =
316 (core_freesync->opts.lcd_freesync_default_value & 2) ? true : false;
317 core_freesync->map[core_freesync->num_entities].user_enable.enable_for_video =
318 (core_freesync->opts.lcd_freesync_default_value & 4) ? true : false;
319 dm_write_persistent_data(dc->ctx, stream->sink,
320 FREESYNC_REGISTRY_NAME,
321 "userenable", &core_freesync->opts.lcd_freesync_default_value,
322 sizeof(int), &flag);
323 } else {
324 core_freesync->map[core_freesync->num_entities].user_enable.
325 enable_for_gaming = false;
326 core_freesync->map[core_freesync->num_entities].user_enable.
327 enable_for_static = false;
328 core_freesync->map[core_freesync->num_entities].user_enable.
329 enable_for_video = false;
330 }
331
332 if (caps->supported &&
333 nom_refresh_rate_uhz >= caps->min_refresh_in_micro_hz &&
334 nom_refresh_rate_uhz <= caps->max_refresh_in_micro_hz)
335 stream->ignore_msa_timing_param = 1;
336
337 core_freesync->num_entities++;
338 return true;
339 }
340 return false;
341}
342
343bool mod_freesync_remove_stream(struct mod_freesync *mod_freesync,
344 struct dc_stream_state *stream)
345{
346 int i = 0;
347 struct core_freesync *core_freesync = NULL;
348 unsigned int index = 0;
349
350 if (mod_freesync == NULL)
351 return false;
352
353 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
354 index = map_index_from_stream(core_freesync, stream);
355
356 dc_stream_release(core_freesync->map[index].stream);
357 core_freesync->map[index].stream = NULL;
358 /* To remove this entity, shift everything after down */
359 for (i = index; i < core_freesync->num_entities - 1; i++)
360 core_freesync->map[i] = core_freesync->map[i + 1];
361 core_freesync->num_entities--;
362 return true;
363}
364
365static void adjust_vmin_vmax(struct core_freesync *core_freesync,
366 struct dc_stream_state **streams,
367 int num_streams,
368 int map_index,
369 unsigned int v_total_min,
370 unsigned int v_total_max)
371{
372 if (num_streams == 0 || streams == NULL || num_streams > 1)
373 return;
374
375 core_freesync->map[map_index].state.vmin = v_total_min;
376 core_freesync->map[map_index].state.vmax = v_total_max;
377
378 dc_stream_adjust_vmin_vmax(core_freesync->dc, streams,
379 num_streams, v_total_min,
380 v_total_max);
381}
382
383
384static void update_stream_freesync_context(struct core_freesync *core_freesync,
385 struct dc_stream_state *stream)
386{
387 unsigned int index;
388 struct freesync_context *ctx;
389
390 ctx = &stream->freesync_ctx;
391
392 index = map_index_from_stream(core_freesync, stream);
393
394 ctx->supported = core_freesync->map[index].caps->supported;
395 ctx->enabled = (core_freesync->map[index].user_enable.enable_for_gaming ||
396 core_freesync->map[index].user_enable.enable_for_video ||
397 core_freesync->map[index].user_enable.enable_for_static);
398 ctx->active = (core_freesync->map[index].state.fullscreen ||
399 core_freesync->map[index].state.video ||
400 core_freesync->map[index].state.static_ramp.ramp_is_active);
401 ctx->min_refresh_in_micro_hz =
402 core_freesync->map[index].caps->min_refresh_in_micro_hz;
403 ctx->nominal_refresh_in_micro_hz = core_freesync->
404 map[index].state.nominal_refresh_rate_in_micro_hz;
405
406}
407
408static void update_stream(struct core_freesync *core_freesync,
409 struct dc_stream_state *stream)
410{
411 unsigned int index = map_index_from_stream(core_freesync, stream);
412 if (core_freesync->map[index].caps->supported) {
413 stream->ignore_msa_timing_param = 1;
414 update_stream_freesync_context(core_freesync, stream);
415 }
416}
417
418static void calc_freesync_range(struct core_freesync *core_freesync,
419 struct dc_stream_state *stream,
420 struct freesync_state *state,
421 unsigned int min_refresh_in_uhz,
422 unsigned int max_refresh_in_uhz)
423{
424 unsigned int min_frame_duration_in_ns = 0, max_frame_duration_in_ns = 0;
425 unsigned int index = map_index_from_stream(core_freesync, stream);
426 uint32_t vtotal = stream->timing.v_total;
427
428 if ((min_refresh_in_uhz == 0) || (max_refresh_in_uhz == 0)) {
429 state->freesync_range.min_refresh =
430 state->nominal_refresh_rate_in_micro_hz;
431 state->freesync_range.max_refresh =
432 state->nominal_refresh_rate_in_micro_hz;
433
434 state->freesync_range.max_frame_duration = 0;
435 state->freesync_range.min_frame_duration = 0;
436
437 state->freesync_range.vmax = vtotal;
438 state->freesync_range.vmin = vtotal;
439
440 return;
441 }
442
443 min_frame_duration_in_ns = ((unsigned int) (div64_u64(
444 (1000000000ULL * 1000000),
445 max_refresh_in_uhz)));
446 max_frame_duration_in_ns = ((unsigned int) (div64_u64(
447 (1000000000ULL * 1000000),
448 min_refresh_in_uhz)));
449
450 state->freesync_range.min_refresh = min_refresh_in_uhz;
451 state->freesync_range.max_refresh = max_refresh_in_uhz;
452
453 state->freesync_range.max_frame_duration = max_frame_duration_in_ns;
454 state->freesync_range.min_frame_duration = min_frame_duration_in_ns;
455
456 state->freesync_range.vmax = div64_u64(div64_u64(((unsigned long long)(
457 max_frame_duration_in_ns) * stream->timing.pix_clk_khz),
458 stream->timing.h_total), 1000000);
459 state->freesync_range.vmin = div64_u64(div64_u64(((unsigned long long)(
460 min_frame_duration_in_ns) * stream->timing.pix_clk_khz),
461 stream->timing.h_total), 1000000);
462
463 /* vmin/vmax cannot be less than vtotal */
464 if (state->freesync_range.vmin < vtotal) {
465 /* Error of 1 is permissible */
466 ASSERT((state->freesync_range.vmin + 1) >= vtotal);
467 state->freesync_range.vmin = vtotal;
468 }
469
470 if (state->freesync_range.vmax < vtotal) {
471 /* Error of 1 is permissible */
472 ASSERT((state->freesync_range.vmax + 1) >= vtotal);
473 state->freesync_range.vmax = vtotal;
474 }
475
476 /* Determine whether BTR can be supported */
477 if (max_frame_duration_in_ns >=
478 2 * min_frame_duration_in_ns)
479 core_freesync->map[index].caps->btr_supported = true;
480 else
481 core_freesync->map[index].caps->btr_supported = false;
482
483 /* Cache the time variables */
484 state->time.max_render_time_in_us =
485 max_frame_duration_in_ns / 1000;
486 state->time.min_render_time_in_us =
487 min_frame_duration_in_ns / 1000;
488 state->btr.mid_point_in_us =
489 (max_frame_duration_in_ns +
490 min_frame_duration_in_ns) / 2000;
491}
492
493static void calc_v_total_from_duration(struct dc_stream_state *stream,
494 unsigned int duration_in_ns, int *v_total_nominal)
495{
496 *v_total_nominal = div64_u64(div64_u64(((unsigned long long)(
497 duration_in_ns) * stream->timing.pix_clk_khz),
498 stream->timing.h_total), 1000000);
499}
500
501static void calc_v_total_for_static_ramp(struct core_freesync *core_freesync,
502 struct dc_stream_state *stream,
503 unsigned int index, int *v_total)
504{
505 unsigned int frame_duration = 0;
506
507 struct gradual_static_ramp *static_ramp_variables =
508 &core_freesync->map[index].state.static_ramp;
509
510 /* Calc ratio between new and current frame duration with 3 digit */
511 unsigned int frame_duration_ratio = div64_u64(1000000,
512 (1000 + div64_u64(((unsigned long long)(
513 STATIC_SCREEN_RAMP_DELTA_REFRESH_RATE_PER_FRAME) *
514 static_ramp_variables->ramp_current_frame_duration_in_ns),
515 1000000000)));
516
517 /* Calculate delta between new and current frame duration in ns */
518 unsigned int frame_duration_delta = div64_u64(((unsigned long long)(
519 static_ramp_variables->ramp_current_frame_duration_in_ns) *
520 (1000 - frame_duration_ratio)), 1000);
521
522 /* Adjust frame duration delta based on ratio between current and
523 * standard frame duration (frame duration at 60 Hz refresh rate).
524 */
525 unsigned int ramp_rate_interpolated = div64_u64(((unsigned long long)(
526 frame_duration_delta) * static_ramp_variables->
527 ramp_current_frame_duration_in_ns), 16666666);
528
529 /* Going to a higher refresh rate (lower frame duration) */
530 if (static_ramp_variables->ramp_direction_is_up) {
531 /* reduce frame duration */
532 static_ramp_variables->ramp_current_frame_duration_in_ns -=
533 ramp_rate_interpolated;
534
535 /* min frame duration */
536 frame_duration = ((unsigned int) (div64_u64(
537 (1000000000ULL * 1000000),
538 core_freesync->map[index].state.
539 nominal_refresh_rate_in_micro_hz)));
540
541 /* adjust for frame duration below min */
542 if (static_ramp_variables->ramp_current_frame_duration_in_ns <=
543 frame_duration) {
544
545 static_ramp_variables->ramp_is_active = false;
546 static_ramp_variables->
547 ramp_current_frame_duration_in_ns =
548 frame_duration;
549 }
550 /* Going to a lower refresh rate (larger frame duration) */
551 } else {
552 /* increase frame duration */
553 static_ramp_variables->ramp_current_frame_duration_in_ns +=
554 ramp_rate_interpolated;
555
556 /* max frame duration */
557 frame_duration = ((unsigned int) (div64_u64(
558 (1000000000ULL * 1000000),
559 core_freesync->map[index].caps->min_refresh_in_micro_hz)));
560
561 /* adjust for frame duration above max */
562 if (static_ramp_variables->ramp_current_frame_duration_in_ns >=
563 frame_duration) {
564
565 static_ramp_variables->ramp_is_active = false;
566 static_ramp_variables->
567 ramp_current_frame_duration_in_ns =
568 frame_duration;
569 }
570 }
571
572 calc_v_total_from_duration(stream, static_ramp_variables->
573 ramp_current_frame_duration_in_ns, v_total);
574}
575
576static void reset_freesync_state_variables(struct freesync_state* state)
577{
578 state->static_ramp.ramp_is_active = false;
579 if (state->nominal_refresh_rate_in_micro_hz)
580 state->static_ramp.ramp_current_frame_duration_in_ns =
581 ((unsigned int) (div64_u64(
582 (1000000000ULL * 1000000),
583 state->nominal_refresh_rate_in_micro_hz)));
584
585 state->btr.btr_active = false;
586 state->btr.frame_counter = 0;
587 state->btr.frames_to_insert = 0;
588 state->btr.inserted_frame_duration_in_us = 0;
589 state->btr.program_btr = false;
590
591 state->fixed_refresh.fixed_active = false;
592 state->fixed_refresh.program_fixed = false;
593}
594/*
595 * Sets freesync mode on a stream depending on current freesync state.
596 */
597static bool set_freesync_on_streams(struct core_freesync *core_freesync,
598 struct dc_stream_state **streams, int num_streams)
599{
600 int v_total_nominal = 0, v_total_min = 0, v_total_max = 0;
601 unsigned int stream_idx, map_index = 0;
602 struct freesync_state *state;
603
604 if (num_streams == 0 || streams == NULL || num_streams > 1)
605 return false;
606
607 for (stream_idx = 0; stream_idx < num_streams; stream_idx++) {
608
609 map_index = map_index_from_stream(core_freesync,
610 streams[stream_idx]);
611
612 state = &core_freesync->map[map_index].state;
613
614 if (core_freesync->map[map_index].caps->supported) {
615
616 /* Fullscreen has the topmost priority. If the
617 * fullscreen bit is set, we are in a fullscreen
618 * application where it should not matter if it is
619 * static screen. We should not check the static_screen
620 * or video bit.
621 *
622 * Special cases of fullscreen include btr and fixed
623 * refresh. We program btr on every flip and involves
624 * programming full range right before the last inserted frame.
625 * However, we do not want to program the full freesync range
626 * when fixed refresh is active, because we only program
627 * that logic once and this will override it.
628 */
629 if (core_freesync->map[map_index].user_enable.
630 enable_for_gaming == true &&
631 state->fullscreen == true &&
632 state->fixed_refresh.fixed_active == false) {
633 /* Enable freesync */
634
635 v_total_min = state->freesync_range.vmin;
636 v_total_max = state->freesync_range.vmax;
637
638 /* Update the freesync context for the stream */
639 update_stream_freesync_context(core_freesync,
640 streams[stream_idx]);
641
642 adjust_vmin_vmax(core_freesync, streams,
643 num_streams, map_index,
644 v_total_min,
645 v_total_max);
646
647 return true;
648
649 } else if (core_freesync->map[map_index].user_enable.
650 enable_for_video && state->video == true) {
651 /* Enable 48Hz feature */
652
653 calc_v_total_from_duration(streams[stream_idx],
654 state->time.update_duration_in_ns,
655 &v_total_nominal);
656
657 /* Program only if v_total_nominal is in range*/
658 if (v_total_nominal >=
659 streams[stream_idx]->timing.v_total) {
660
661 /* Update the freesync context for
662 * the stream
663 */
664 update_stream_freesync_context(
665 core_freesync,
666 streams[stream_idx]);
667
668 adjust_vmin_vmax(
669 core_freesync, streams,
670 num_streams, map_index,
671 v_total_nominal,
672 v_total_nominal);
673 }
674 return true;
675
676 } else {
677 /* Disable freesync */
678 v_total_nominal = streams[stream_idx]->
679 timing.v_total;
680
681 /* Update the freesync context for
682 * the stream
683 */
684 update_stream_freesync_context(
685 core_freesync,
686 streams[stream_idx]);
687
688 adjust_vmin_vmax(core_freesync, streams,
689 num_streams, map_index,
690 v_total_nominal,
691 v_total_nominal);
692
693 /* Reset the cached variables */
694 reset_freesync_state_variables(state);
695
696 return true;
697 }
698 } else {
699 /* Disable freesync */
700 v_total_nominal = streams[stream_idx]->
701 timing.v_total;
702 /*
703 * we have to reset drr always even sink does
704 * not support freesync because a former stream has
705 * be programmed
706 */
707 adjust_vmin_vmax(core_freesync, streams,
708 num_streams, map_index,
709 v_total_nominal,
710 v_total_nominal);
711 /* Reset the cached variables */
712 reset_freesync_state_variables(state);
713 }
714
715 }
716
717 return false;
718}
719
720static void set_static_ramp_variables(struct core_freesync *core_freesync,
721 unsigned int index, bool enable_static_screen)
722{
723 unsigned int frame_duration = 0;
724 unsigned int nominal_refresh_rate = core_freesync->map[index].state.
725 nominal_refresh_rate_in_micro_hz;
726 unsigned int min_refresh_rate= core_freesync->map[index].caps->
727 min_refresh_in_micro_hz;
728 struct gradual_static_ramp *static_ramp_variables =
729 &core_freesync->map[index].state.static_ramp;
730
731 /* If we are ENABLING static screen, refresh rate should go DOWN.
732 * If we are DISABLING static screen, refresh rate should go UP.
733 */
734 if (enable_static_screen)
735 static_ramp_variables->ramp_direction_is_up = false;
736 else
737 static_ramp_variables->ramp_direction_is_up = true;
738
739 /* If ramp is not active, set initial frame duration depending on
740 * whether we are enabling/disabling static screen mode. If the ramp is
741 * already active, ramp should continue in the opposite direction
742 * starting with the current frame duration
743 */
744 if (!static_ramp_variables->ramp_is_active) {
745 if (enable_static_screen == true) {
746 /* Going to lower refresh rate, so start from max
747 * refresh rate (min frame duration)
748 */
749 frame_duration = ((unsigned int) (div64_u64(
750 (1000000000ULL * 1000000),
751 nominal_refresh_rate)));
752 } else {
753 /* Going to higher refresh rate, so start from min
754 * refresh rate (max frame duration)
755 */
756 frame_duration = ((unsigned int) (div64_u64(
757 (1000000000ULL * 1000000),
758 min_refresh_rate)));
759 }
760 static_ramp_variables->
761 ramp_current_frame_duration_in_ns = frame_duration;
762
763 static_ramp_variables->ramp_is_active = true;
764 }
765}
766
767void mod_freesync_handle_v_update(struct mod_freesync *mod_freesync,
768 struct dc_stream_state **streams, int num_streams)
769{
770 unsigned int index, v_total, inserted_frame_v_total = 0;
771 unsigned int min_frame_duration_in_ns, vmax, vmin = 0;
772 struct freesync_state *state;
773 struct core_freesync *core_freesync = NULL;
774 struct dc_static_screen_events triggers = {0};
775
776 if (mod_freesync == NULL)
777 return;
778
779 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
780
781 if (core_freesync->num_entities == 0)
782 return;
783
784 index = map_index_from_stream(core_freesync,
785 streams[0]);
786
787 if (core_freesync->map[index].caps->supported == false)
788 return;
789
790 state = &core_freesync->map[index].state;
791
792 /* Below the Range Logic */
793
794 /* Only execute if in fullscreen mode */
795 if (state->fullscreen == true &&
796 core_freesync->map[index].user_enable.enable_for_gaming &&
797 core_freesync->map[index].caps->btr_supported &&
798 state->btr.btr_active) {
799
800 /* TODO: pass in flag for Pre-DCE12 ASIC
801 * in order for frame variable duration to take affect,
802 * it needs to be done one VSYNC early, which is at
803 * frameCounter == 1.
804 * For DCE12 and newer updates to V_TOTAL_MIN/MAX
805 * will take affect on current frame
806 */
807 if (state->btr.frames_to_insert == state->btr.frame_counter) {
808
809 min_frame_duration_in_ns = ((unsigned int) (div64_u64(
810 (1000000000ULL * 1000000),
811 state->nominal_refresh_rate_in_micro_hz)));
812
813 vmin = state->freesync_range.vmin;
814
815 inserted_frame_v_total = vmin;
816
817 if (min_frame_duration_in_ns / 1000)
818 inserted_frame_v_total =
819 state->btr.inserted_frame_duration_in_us *
820 vmin / (min_frame_duration_in_ns / 1000);
821
822 /* Set length of inserted frames as v_total_max*/
823 vmax = inserted_frame_v_total;
824 vmin = inserted_frame_v_total;
825
826 /* Program V_TOTAL */
827 adjust_vmin_vmax(core_freesync, streams,
828 num_streams, index,
829 vmin, vmax);
830 }
831
832 if (state->btr.frame_counter > 0)
833 state->btr.frame_counter--;
834
835 /* Restore FreeSync */
836 if (state->btr.frame_counter == 0)
837 set_freesync_on_streams(core_freesync, streams, num_streams);
838 }
839
840 /* If in fullscreen freesync mode or in video, do not program
841 * static screen ramp values
842 */
843 if (state->fullscreen == true || state->video == true) {
844
845 state->static_ramp.ramp_is_active = false;
846
847 return;
848 }
849
850 /* Gradual Static Screen Ramping Logic */
851
852 /* Execute if ramp is active and user enabled freesync static screen*/
853 if (state->static_ramp.ramp_is_active &&
854 core_freesync->map[index].user_enable.enable_for_static) {
855
856 calc_v_total_for_static_ramp(core_freesync, streams[0],
857 index, &v_total);
858
859 /* Update the freesync context for the stream */
860 update_stream_freesync_context(core_freesync, streams[0]);
861
862 /* Program static screen ramp values */
863 adjust_vmin_vmax(core_freesync, streams,
864 num_streams, index,
865 v_total,
866 v_total);
867
868 triggers.overlay_update = true;
869 triggers.surface_update = true;
870
871 dc_stream_set_static_screen_events(core_freesync->dc, streams,
872 num_streams, &triggers);
873 }
874}
875
876void mod_freesync_update_state(struct mod_freesync *mod_freesync,
877 struct dc_stream_state **streams, int num_streams,
878 struct mod_freesync_params *freesync_params)
879{
880 bool freesync_program_required = false;
881 unsigned int stream_index;
882 struct freesync_state *state;
883 struct core_freesync *core_freesync = NULL;
884 struct dc_static_screen_events triggers = {0};
885
886 if (mod_freesync == NULL)
887 return;
888
889 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
890
891 if (core_freesync->num_entities == 0)
892 return;
893
894 for(stream_index = 0; stream_index < num_streams; stream_index++) {
895
896 unsigned int map_index = map_index_from_stream(core_freesync,
897 streams[stream_index]);
898
899 bool is_embedded = dc_is_embedded_signal(
900 streams[stream_index]->sink->sink_signal);
901
902 struct freesync_registry_options *opts = &core_freesync->opts;
903
904 state = &core_freesync->map[map_index].state;
905
906 switch (freesync_params->state){
907 case FREESYNC_STATE_FULLSCREEN:
908 state->fullscreen = freesync_params->enable;
909 freesync_program_required = true;
910 state->windowed_fullscreen =
911 freesync_params->windowed_fullscreen;
912 break;
913 case FREESYNC_STATE_STATIC_SCREEN:
914 /* Static screen ramp is disabled by default, but can
915 * be enabled through regkey.
916 */
917 if ((is_embedded && opts->drr_internal_supported) ||
918 (!is_embedded && opts->drr_external_supported))
919
920 if (state->static_screen !=
921 freesync_params->enable) {
922
923 /* Change the state flag */
924 state->static_screen =
925 freesync_params->enable;
926
927 /* Update static screen ramp */
928 set_static_ramp_variables(core_freesync,
929 map_index,
930 freesync_params->enable);
931 }
932 /* We program the ramp starting next VUpdate */
933 break;
934 case FREESYNC_STATE_VIDEO:
935 /* Change core variables only if there is a change*/
936 if(freesync_params->update_duration_in_ns !=
937 state->time.update_duration_in_ns) {
938
939 state->video = freesync_params->enable;
940 state->time.update_duration_in_ns =
941 freesync_params->update_duration_in_ns;
942
943 freesync_program_required = true;
944 }
945 break;
946 case FREESYNC_STATE_NONE:
947 /* handle here to avoid warning */
948 break;
949 }
950 }
951
952 /* Update mask */
953 triggers.overlay_update = true;
954 triggers.surface_update = true;
955
956 dc_stream_set_static_screen_events(core_freesync->dc, streams,
957 num_streams, &triggers);
958
959 if (freesync_program_required)
960 /* Program freesync according to current state*/
961 set_freesync_on_streams(core_freesync, streams, num_streams);
962}
963
964
965bool mod_freesync_get_state(struct mod_freesync *mod_freesync,
966 struct dc_stream_state *stream,
967 struct mod_freesync_params *freesync_params)
968{
969 unsigned int index = 0;
970 struct core_freesync *core_freesync = NULL;
971
972 if (mod_freesync == NULL)
973 return false;
974
975 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
976 index = map_index_from_stream(core_freesync, stream);
977
978 if (core_freesync->map[index].state.fullscreen) {
979 freesync_params->state = FREESYNC_STATE_FULLSCREEN;
980 freesync_params->enable = true;
981 } else if (core_freesync->map[index].state.static_screen) {
982 freesync_params->state = FREESYNC_STATE_STATIC_SCREEN;
983 freesync_params->enable = true;
984 } else if (core_freesync->map[index].state.video) {
985 freesync_params->state = FREESYNC_STATE_VIDEO;
986 freesync_params->enable = true;
987 } else {
988 freesync_params->state = FREESYNC_STATE_NONE;
989 freesync_params->enable = false;
990 }
991
992 freesync_params->update_duration_in_ns =
993 core_freesync->map[index].state.time.update_duration_in_ns;
994
995 freesync_params->windowed_fullscreen =
996 core_freesync->map[index].state.windowed_fullscreen;
997
998 return true;
999}
1000
1001bool mod_freesync_set_user_enable(struct mod_freesync *mod_freesync,
1002 struct dc_stream_state **streams, int num_streams,
1003 struct mod_freesync_user_enable *user_enable)
1004{
1005 unsigned int stream_index, map_index;
1006 int persistent_data = 0;
1007 struct persistent_data_flag flag;
1008 struct dc *dc = NULL;
1009 struct core_freesync *core_freesync = NULL;
1010
1011 if (mod_freesync == NULL)
1012 return false;
1013
1014 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1015 dc = core_freesync->dc;
1016
1017 flag.save_per_edid = true;
1018 flag.save_per_link = false;
1019
1020 for(stream_index = 0; stream_index < num_streams;
1021 stream_index++){
1022
1023 map_index = map_index_from_stream(core_freesync,
1024 streams[stream_index]);
1025
1026 core_freesync->map[map_index].user_enable = *user_enable;
1027
1028 /* Write persistent data in registry*/
1029 if (core_freesync->map[map_index].user_enable.
1030 enable_for_gaming)
1031 persistent_data = persistent_data | 1;
1032 if (core_freesync->map[map_index].user_enable.
1033 enable_for_static)
1034 persistent_data = persistent_data | 2;
1035 if (core_freesync->map[map_index].user_enable.
1036 enable_for_video)
1037 persistent_data = persistent_data | 4;
1038
1039 dm_write_persistent_data(dc->ctx,
1040 streams[stream_index]->sink,
1041 FREESYNC_REGISTRY_NAME,
1042 "userenable",
1043 &persistent_data,
1044 sizeof(int),
1045 &flag);
1046 }
1047
1048 set_freesync_on_streams(core_freesync, streams, num_streams);
1049
1050 return true;
1051}
1052
1053bool mod_freesync_get_user_enable(struct mod_freesync *mod_freesync,
1054 struct dc_stream_state *stream,
1055 struct mod_freesync_user_enable *user_enable)
1056{
1057 unsigned int index = 0;
1058 struct core_freesync *core_freesync = NULL;
1059
1060 if (mod_freesync == NULL)
1061 return false;
1062
1063 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1064 index = map_index_from_stream(core_freesync, stream);
1065
1066 *user_enable = core_freesync->map[index].user_enable;
1067
1068 return true;
1069}
1070
1071bool mod_freesync_get_static_ramp_active(struct mod_freesync *mod_freesync,
1072 struct dc_stream_state *stream,
1073 bool *is_ramp_active)
1074{
1075 unsigned int index = 0;
1076 struct core_freesync *core_freesync = NULL;
1077
1078 if (mod_freesync == NULL)
1079 return false;
1080
1081 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1082 index = map_index_from_stream(core_freesync, stream);
1083
1084 *is_ramp_active =
1085 core_freesync->map[index].state.static_ramp.ramp_is_active;
1086
1087 return true;
1088}
1089
1090bool mod_freesync_override_min_max(struct mod_freesync *mod_freesync,
1091 struct dc_stream_state *streams,
1092 unsigned int min_refresh,
1093 unsigned int max_refresh,
1094 struct mod_freesync_caps *caps)
1095{
1096 unsigned int index = 0;
1097 struct core_freesync *core_freesync;
1098 struct freesync_state *state;
1099
1100 if (mod_freesync == NULL)
1101 return false;
1102
1103 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1104 index = map_index_from_stream(core_freesync, streams);
1105 state = &core_freesync->map[index].state;
1106
1107 if (max_refresh == 0)
1108 max_refresh = state->nominal_refresh_rate_in_micro_hz;
1109
1110 if (min_refresh == 0) {
1111 /* Restore defaults */
1112 calc_freesync_range(core_freesync, streams, state,
1113 core_freesync->map[index].caps->
1114 min_refresh_in_micro_hz,
1115 state->nominal_refresh_rate_in_micro_hz);
1116 } else {
1117 calc_freesync_range(core_freesync, streams,
1118 state,
1119 min_refresh,
1120 max_refresh);
1121
1122 /* Program vtotal min/max */
1123 adjust_vmin_vmax(core_freesync, &streams, 1, index,
1124 state->freesync_range.vmin,
1125 state->freesync_range.vmax);
1126 }
1127
1128 if (min_refresh != 0 &&
1129 dc_is_embedded_signal(streams->sink->sink_signal) &&
1130 (max_refresh - min_refresh >= 10000000)) {
1131 caps->supported = true;
1132 caps->min_refresh_in_micro_hz = min_refresh;
1133 caps->max_refresh_in_micro_hz = max_refresh;
1134 }
1135
1136 /* Update the stream */
1137 update_stream(core_freesync, streams);
1138
1139 return true;
1140}
1141
1142bool mod_freesync_get_min_max(struct mod_freesync *mod_freesync,
1143 struct dc_stream_state *stream,
1144 unsigned int *min_refresh,
1145 unsigned int *max_refresh)
1146{
1147 unsigned int index = 0;
1148 struct core_freesync *core_freesync = NULL;
1149
1150 if (mod_freesync == NULL)
1151 return false;
1152
1153 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1154 index = map_index_from_stream(core_freesync, stream);
1155
1156 *min_refresh =
1157 core_freesync->map[index].state.freesync_range.min_refresh;
1158 *max_refresh =
1159 core_freesync->map[index].state.freesync_range.max_refresh;
1160
1161 return true;
1162}
1163
1164bool mod_freesync_get_vmin_vmax(struct mod_freesync *mod_freesync,
1165 struct dc_stream_state *stream,
1166 unsigned int *vmin,
1167 unsigned int *vmax)
1168{
1169 unsigned int index = 0;
1170 struct core_freesync *core_freesync = NULL;
1171
1172 if (mod_freesync == NULL)
1173 return false;
1174
1175 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1176 index = map_index_from_stream(core_freesync, stream);
1177
1178 *vmin =
1179 core_freesync->map[index].state.freesync_range.vmin;
1180 *vmax =
1181 core_freesync->map[index].state.freesync_range.vmax;
1182
1183 return true;
1184}
1185
1186bool mod_freesync_get_v_position(struct mod_freesync *mod_freesync,
1187 struct dc_stream_state *stream,
1188 unsigned int *nom_v_pos,
1189 unsigned int *v_pos)
1190{
1191 unsigned int index = 0;
1192 struct core_freesync *core_freesync = NULL;
1193 struct crtc_position position;
1194
1195 if (mod_freesync == NULL)
1196 return false;
1197
1198 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1199 index = map_index_from_stream(core_freesync, stream);
1200
1201 if (dc_stream_get_crtc_position(core_freesync->dc, &stream, 1,
1202 &position.vertical_count,
1203 &position.nominal_vcount)) {
1204
1205 *nom_v_pos = position.nominal_vcount;
1206 *v_pos = position.vertical_count;
1207
1208 return true;
1209 }
1210
1211 return false;
1212}
1213
1214void mod_freesync_notify_mode_change(struct mod_freesync *mod_freesync,
1215 struct dc_stream_state **streams, int num_streams)
1216{
1217 unsigned int stream_index, map_index;
1218 struct freesync_state *state;
1219 struct core_freesync *core_freesync = NULL;
1220 struct dc_static_screen_events triggers = {0};
1221 unsigned long long temp = 0;
1222
1223 if (mod_freesync == NULL)
1224 return;
1225
1226 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1227
1228 for (stream_index = 0; stream_index < num_streams; stream_index++) {
1229 map_index = map_index_from_stream(core_freesync,
1230 streams[stream_index]);
1231
1232 state = &core_freesync->map[map_index].state;
1233
1234 /* Update the field rate for new timing */
1235 temp = streams[stream_index]->timing.pix_clk_khz;
1236 temp *= 1000ULL * 1000ULL * 1000ULL;
1237 temp = div_u64(temp,
1238 streams[stream_index]->timing.h_total);
1239 temp = div_u64(temp,
1240 streams[stream_index]->timing.v_total);
1241 state->nominal_refresh_rate_in_micro_hz =
1242 (unsigned int) temp;
1243
1244 if (core_freesync->map[map_index].caps->supported) {
1245
1246 /* Update the stream */
1247 update_stream(core_freesync, streams[stream_index]);
1248
1249 /* Calculate vmin/vmax and refresh rate for
1250 * current mode
1251 */
1252 calc_freesync_range(core_freesync, *streams, state,
1253 core_freesync->map[map_index].caps->
1254 min_refresh_in_micro_hz,
1255 state->nominal_refresh_rate_in_micro_hz);
1256
1257 /* Update mask */
1258 triggers.overlay_update = true;
1259 triggers.surface_update = true;
1260
1261 dc_stream_set_static_screen_events(core_freesync->dc,
1262 streams, num_streams,
1263 &triggers);
1264 }
1265 }
1266
1267 /* Program freesync according to current state*/
1268 set_freesync_on_streams(core_freesync, streams, num_streams);
1269}
1270
1271/* Add the timestamps to the cache and determine whether BTR programming
1272 * is required, depending on the times calculated
1273 */
1274static void update_timestamps(struct core_freesync *core_freesync,
1275 const struct dc_stream_state *stream, unsigned int map_index,
1276 unsigned int last_render_time_in_us)
1277{
1278 struct freesync_state *state = &core_freesync->map[map_index].state;
1279
1280 state->time.render_times[state->time.render_times_index] =
1281 last_render_time_in_us;
1282 state->time.render_times_index++;
1283
1284 if (state->time.render_times_index >= RENDER_TIMES_MAX_COUNT)
1285 state->time.render_times_index = 0;
1286
1287 if (last_render_time_in_us + BTR_EXIT_MARGIN <
1288 state->time.max_render_time_in_us) {
1289
1290 /* Exit Below the Range */
1291 if (state->btr.btr_active) {
1292
1293 state->btr.program_btr = true;
1294 state->btr.btr_active = false;
1295 state->btr.frame_counter = 0;
1296
1297 /* Exit Fixed Refresh mode */
1298 } else if (state->fixed_refresh.fixed_active) {
1299
1300 state->fixed_refresh.frame_counter++;
1301
1302 if (state->fixed_refresh.frame_counter >
1303 FIXED_REFRESH_EXIT_FRAME_COUNT) {
1304 state->fixed_refresh.frame_counter = 0;
1305 state->fixed_refresh.program_fixed = true;
1306 state->fixed_refresh.fixed_active = false;
1307 }
1308 }
1309
1310 } else if (last_render_time_in_us > state->time.max_render_time_in_us) {
1311
1312 /* Enter Below the Range */
1313 if (!state->btr.btr_active &&
1314 core_freesync->map[map_index].caps->btr_supported) {
1315
1316 state->btr.program_btr = true;
1317 state->btr.btr_active = true;
1318
1319 /* Enter Fixed Refresh mode */
1320 } else if (!state->fixed_refresh.fixed_active &&
1321 !core_freesync->map[map_index].caps->btr_supported) {
1322
1323 state->fixed_refresh.frame_counter++;
1324
1325 if (state->fixed_refresh.frame_counter >
1326 FIXED_REFRESH_ENTER_FRAME_COUNT) {
1327 state->fixed_refresh.frame_counter = 0;
1328 state->fixed_refresh.program_fixed = true;
1329 state->fixed_refresh.fixed_active = true;
1330 }
1331 }
1332 }
1333
1334 /* When Below the Range is active, must react on every frame */
1335 if (state->btr.btr_active)
1336 state->btr.program_btr = true;
1337}
1338
1339static void apply_below_the_range(struct core_freesync *core_freesync,
1340 struct dc_stream_state *stream, unsigned int map_index,
1341 unsigned int last_render_time_in_us)
1342{
1343 unsigned int inserted_frame_duration_in_us = 0;
1344 unsigned int mid_point_frames_ceil = 0;
1345 unsigned int mid_point_frames_floor = 0;
1346 unsigned int frame_time_in_us = 0;
1347 unsigned int delta_from_mid_point_in_us_1 = 0xFFFFFFFF;
1348 unsigned int delta_from_mid_point_in_us_2 = 0xFFFFFFFF;
1349 unsigned int frames_to_insert = 0;
1350 unsigned int min_frame_duration_in_ns = 0;
1351 struct freesync_state *state = &core_freesync->map[map_index].state;
1352
1353 if (!state->btr.program_btr)
1354 return;
1355
1356 state->btr.program_btr = false;
1357
1358 min_frame_duration_in_ns = ((unsigned int) (div64_u64(
1359 (1000000000ULL * 1000000),
1360 state->nominal_refresh_rate_in_micro_hz)));
1361
1362 /* Program BTR */
1363
1364 /* BTR set to "not active" so disengage */
1365 if (!state->btr.btr_active)
1366
1367 /* Restore FreeSync */
1368 set_freesync_on_streams(core_freesync, &stream, 1);
1369
1370 /* BTR set to "active" so engage */
1371 else {
1372
1373 /* Calculate number of midPoint frames that could fit within
1374 * the render time interval- take ceil of this value
1375 */
1376 mid_point_frames_ceil = (last_render_time_in_us +
1377 state->btr.mid_point_in_us- 1) /
1378 state->btr.mid_point_in_us;
1379
1380 if (mid_point_frames_ceil > 0) {
1381
1382 frame_time_in_us = last_render_time_in_us /
1383 mid_point_frames_ceil;
1384 delta_from_mid_point_in_us_1 =
1385 (state->btr.mid_point_in_us >
1386 frame_time_in_us) ?
1387 (state->btr.mid_point_in_us - frame_time_in_us):
1388 (frame_time_in_us - state->btr.mid_point_in_us);
1389 }
1390
1391 /* Calculate number of midPoint frames that could fit within
1392 * the render time interval- take floor of this value
1393 */
1394 mid_point_frames_floor = last_render_time_in_us /
1395 state->btr.mid_point_in_us;
1396
1397 if (mid_point_frames_floor > 0) {
1398
1399 frame_time_in_us = last_render_time_in_us /
1400 mid_point_frames_floor;
1401 delta_from_mid_point_in_us_2 =
1402 (state->btr.mid_point_in_us >
1403 frame_time_in_us) ?
1404 (state->btr.mid_point_in_us - frame_time_in_us):
1405 (frame_time_in_us - state->btr.mid_point_in_us);
1406 }
1407
1408 /* Choose number of frames to insert based on how close it
1409 * can get to the mid point of the variable range.
1410 */
1411 if (delta_from_mid_point_in_us_1 < delta_from_mid_point_in_us_2)
1412 frames_to_insert = mid_point_frames_ceil;
1413 else
1414 frames_to_insert = mid_point_frames_floor;
1415
1416 /* Either we've calculated the number of frames to insert,
1417 * or we need to insert min duration frames
1418 */
1419 if (frames_to_insert > 0)
1420 inserted_frame_duration_in_us = last_render_time_in_us /
1421 frames_to_insert;
1422
1423 if (inserted_frame_duration_in_us <
1424 state->time.min_render_time_in_us)
1425
1426 inserted_frame_duration_in_us =
1427 state->time.min_render_time_in_us;
1428
1429 /* Cache the calculated variables */
1430 state->btr.inserted_frame_duration_in_us =
1431 inserted_frame_duration_in_us;
1432 state->btr.frames_to_insert = frames_to_insert;
1433 state->btr.frame_counter = frames_to_insert;
1434
1435 }
1436}
1437
1438static void apply_fixed_refresh(struct core_freesync *core_freesync,
1439 struct dc_stream_state *stream, unsigned int map_index)
1440{
1441 unsigned int vmin = 0, vmax = 0;
1442 struct freesync_state *state = &core_freesync->map[map_index].state;
1443
1444 if (!state->fixed_refresh.program_fixed)
1445 return;
1446
1447 state->fixed_refresh.program_fixed = false;
1448
1449 /* Program Fixed Refresh */
1450
1451 /* Fixed Refresh set to "not active" so disengage */
1452 if (!state->fixed_refresh.fixed_active) {
1453 set_freesync_on_streams(core_freesync, &stream, 1);
1454
1455 /* Fixed Refresh set to "active" so engage (fix to max) */
1456 } else {
1457
1458 vmin = state->freesync_range.vmin;
1459 vmax = vmin;
1460 adjust_vmin_vmax(core_freesync, &stream, map_index,
1461 1, vmin, vmax);
1462 }
1463}
1464
1465void mod_freesync_pre_update_plane_addresses(struct mod_freesync *mod_freesync,
1466 struct dc_stream_state **streams, int num_streams,
1467 unsigned int curr_time_stamp_in_us)
1468{
1469 unsigned int stream_index, map_index, last_render_time_in_us = 0;
1470 struct core_freesync *core_freesync = NULL;
1471
1472 if (mod_freesync == NULL)
1473 return;
1474
1475 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1476
1477 for (stream_index = 0; stream_index < num_streams; stream_index++) {
1478
1479 map_index = map_index_from_stream(core_freesync,
1480 streams[stream_index]);
1481
1482 if (core_freesync->map[map_index].caps->supported) {
1483
1484 last_render_time_in_us = curr_time_stamp_in_us -
1485 core_freesync->map[map_index].state.time.
1486 prev_time_stamp_in_us;
1487
1488 /* Add the timestamps to the cache and determine
1489 * whether BTR program is required
1490 */
1491 update_timestamps(core_freesync, streams[stream_index],
1492 map_index, last_render_time_in_us);
1493
1494 if (core_freesync->map[map_index].state.fullscreen &&
1495 core_freesync->map[map_index].user_enable.
1496 enable_for_gaming) {
1497
1498 if (core_freesync->map[map_index].caps->btr_supported) {
1499
1500 apply_below_the_range(core_freesync,
1501 streams[stream_index], map_index,
1502 last_render_time_in_us);
1503 } else {
1504 apply_fixed_refresh(core_freesync,
1505 streams[stream_index], map_index);
1506 }
1507 }
1508
1509 core_freesync->map[map_index].state.time.
1510 prev_time_stamp_in_us = curr_time_stamp_in_us;
1511 }
1512
1513 }
1514}
1515
1516void mod_freesync_get_settings(struct mod_freesync *mod_freesync,
1517 struct dc_stream_state **streams, int num_streams,
1518 unsigned int *v_total_min, unsigned int *v_total_max,
1519 unsigned int *event_triggers,
1520 unsigned int *window_min, unsigned int *window_max,
1521 unsigned int *lfc_mid_point_in_us,
1522 unsigned int *inserted_frames,
1523 unsigned int *inserted_duration_in_us)
1524{
1525 unsigned int stream_index, map_index;
1526 struct core_freesync *core_freesync = NULL;
1527
1528 if (mod_freesync == NULL)
1529 return;
1530
1531 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1532
1533 for (stream_index = 0; stream_index < num_streams; stream_index++) {
1534
1535 map_index = map_index_from_stream(core_freesync,
1536 streams[stream_index]);
1537
1538 if (core_freesync->map[map_index].caps->supported) {
1539 struct freesync_state state =
1540 core_freesync->map[map_index].state;
1541 *v_total_min = state.vmin;
1542 *v_total_max = state.vmax;
1543 *event_triggers = 0;
1544 *window_min = state.time.min_window;
1545 *window_max = state.time.max_window;
1546 *lfc_mid_point_in_us = state.btr.mid_point_in_us;
1547 *inserted_frames = state.btr.frames_to_insert;
1548 *inserted_duration_in_us =
1549 state.btr.inserted_frame_duration_in_us;
1550 }
1551
1552 }
1553}
1554
1/*
2 * Copyright 2016-2023 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#include "dm_services.h"
27#include "dc.h"
28#include "mod_freesync.h"
29#include "core_types.h"
30
31#define MOD_FREESYNC_MAX_CONCURRENT_STREAMS 32
32
33#define MIN_REFRESH_RANGE 10
34/* Refresh rate ramp at a fixed rate of 65 Hz/second */
35#define STATIC_SCREEN_RAMP_DELTA_REFRESH_RATE_PER_FRAME ((1000 / 60) * 65)
36/* Number of elements in the render times cache array */
37#define RENDER_TIMES_MAX_COUNT 10
38/* Threshold to exit/exit BTR (to avoid frequent enter-exits at the lower limit) */
39#define BTR_MAX_MARGIN 2500
40/* Threshold to change BTR multiplier (to avoid frequent changes) */
41#define BTR_DRIFT_MARGIN 2000
42/* Threshold to exit fixed refresh rate */
43#define FIXED_REFRESH_EXIT_MARGIN_IN_HZ 1
44/* Number of consecutive frames to check before entering/exiting fixed refresh */
45#define FIXED_REFRESH_ENTER_FRAME_COUNT 5
46#define FIXED_REFRESH_EXIT_FRAME_COUNT 10
47/* Flip interval workaround constants */
48#define VSYNCS_BETWEEN_FLIP_THRESHOLD 2
49#define FREESYNC_CONSEC_FLIP_AFTER_VSYNC 5
50#define FREESYNC_VSYNC_TO_FLIP_DELTA_IN_US 500
51
52struct core_freesync {
53 struct mod_freesync public;
54 struct dc *dc;
55};
56
57#define MOD_FREESYNC_TO_CORE(mod_freesync)\
58 container_of(mod_freesync, struct core_freesync, public)
59
60struct mod_freesync *mod_freesync_create(struct dc *dc)
61{
62 struct core_freesync *core_freesync =
63 kzalloc(sizeof(struct core_freesync), GFP_KERNEL);
64
65 if (core_freesync == NULL)
66 goto fail_alloc_context;
67
68 if (dc == NULL)
69 goto fail_construct;
70
71 core_freesync->dc = dc;
72 return &core_freesync->public;
73
74fail_construct:
75 kfree(core_freesync);
76
77fail_alloc_context:
78 return NULL;
79}
80
81void mod_freesync_destroy(struct mod_freesync *mod_freesync)
82{
83 struct core_freesync *core_freesync = NULL;
84
85 if (mod_freesync == NULL)
86 return;
87 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
88 kfree(core_freesync);
89}
90
91#if 0 /* Unused currently */
92static unsigned int calc_refresh_in_uhz_from_duration(
93 unsigned int duration_in_ns)
94{
95 unsigned int refresh_in_uhz =
96 ((unsigned int)(div64_u64((1000000000ULL * 1000000),
97 duration_in_ns)));
98 return refresh_in_uhz;
99}
100#endif
101
102static unsigned int calc_duration_in_us_from_refresh_in_uhz(
103 unsigned int refresh_in_uhz)
104{
105 unsigned int duration_in_us =
106 ((unsigned int)(div64_u64((1000000000ULL * 1000),
107 refresh_in_uhz)));
108 return duration_in_us;
109}
110
111static unsigned int calc_duration_in_us_from_v_total(
112 const struct dc_stream_state *stream,
113 const struct mod_vrr_params *in_vrr,
114 unsigned int v_total)
115{
116 unsigned int duration_in_us =
117 (unsigned int)(div64_u64(((unsigned long long)(v_total)
118 * 10000) * stream->timing.h_total,
119 stream->timing.pix_clk_100hz));
120
121 return duration_in_us;
122}
123
124unsigned int mod_freesync_calc_v_total_from_refresh(
125 const struct dc_stream_state *stream,
126 unsigned int refresh_in_uhz)
127{
128 unsigned int v_total;
129 unsigned int frame_duration_in_ns;
130
131 frame_duration_in_ns =
132 ((unsigned int)(div64_u64((1000000000ULL * 1000000),
133 refresh_in_uhz)));
134
135 v_total = div64_u64(div64_u64(((unsigned long long)(
136 frame_duration_in_ns) * (stream->timing.pix_clk_100hz / 10)),
137 stream->timing.h_total), 1000000);
138
139 /* v_total cannot be less than nominal */
140 if (v_total < stream->timing.v_total) {
141 ASSERT(v_total < stream->timing.v_total);
142 v_total = stream->timing.v_total;
143 }
144
145 return v_total;
146}
147
148static unsigned int calc_v_total_from_duration(
149 const struct dc_stream_state *stream,
150 const struct mod_vrr_params *vrr,
151 unsigned int duration_in_us)
152{
153 unsigned int v_total = 0;
154
155 if (duration_in_us < vrr->min_duration_in_us)
156 duration_in_us = vrr->min_duration_in_us;
157
158 if (duration_in_us > vrr->max_duration_in_us)
159 duration_in_us = vrr->max_duration_in_us;
160
161 if (dc_is_hdmi_signal(stream->signal)) {
162 uint32_t h_total_up_scaled;
163
164 h_total_up_scaled = stream->timing.h_total * 10000;
165 v_total = div_u64((unsigned long long)duration_in_us
166 * stream->timing.pix_clk_100hz + (h_total_up_scaled - 1),
167 h_total_up_scaled);
168 } else {
169 v_total = div64_u64(div64_u64(((unsigned long long)(
170 duration_in_us) * (stream->timing.pix_clk_100hz / 10)),
171 stream->timing.h_total), 1000);
172 }
173
174 /* v_total cannot be less than nominal */
175 if (v_total < stream->timing.v_total) {
176 ASSERT(v_total < stream->timing.v_total);
177 v_total = stream->timing.v_total;
178 }
179
180 return v_total;
181}
182
183static void update_v_total_for_static_ramp(
184 struct core_freesync *core_freesync,
185 const struct dc_stream_state *stream,
186 struct mod_vrr_params *in_out_vrr)
187{
188 unsigned int v_total = 0;
189 unsigned int current_duration_in_us =
190 calc_duration_in_us_from_v_total(
191 stream, in_out_vrr,
192 in_out_vrr->adjust.v_total_max);
193 unsigned int target_duration_in_us =
194 calc_duration_in_us_from_refresh_in_uhz(
195 in_out_vrr->fixed.target_refresh_in_uhz);
196 bool ramp_direction_is_up = (current_duration_in_us >
197 target_duration_in_us) ? true : false;
198
199 /* Calculate ratio between new and current frame duration with 3 digit */
200 unsigned int frame_duration_ratio = div64_u64(1000000,
201 (1000 + div64_u64(((unsigned long long)(
202 STATIC_SCREEN_RAMP_DELTA_REFRESH_RATE_PER_FRAME) *
203 current_duration_in_us),
204 1000000)));
205
206 /* Calculate delta between new and current frame duration in us */
207 unsigned int frame_duration_delta = div64_u64(((unsigned long long)(
208 current_duration_in_us) *
209 (1000 - frame_duration_ratio)), 1000);
210
211 /* Adjust frame duration delta based on ratio between current and
212 * standard frame duration (frame duration at 60 Hz refresh rate).
213 */
214 unsigned int ramp_rate_interpolated = div64_u64(((unsigned long long)(
215 frame_duration_delta) * current_duration_in_us), 16666);
216
217 /* Going to a higher refresh rate (lower frame duration) */
218 if (ramp_direction_is_up) {
219 /* Reduce frame duration */
220 current_duration_in_us -= ramp_rate_interpolated;
221
222 /* Adjust for frame duration below min */
223 if (current_duration_in_us <= target_duration_in_us) {
224 in_out_vrr->fixed.ramping_active = false;
225 in_out_vrr->fixed.ramping_done = true;
226 current_duration_in_us =
227 calc_duration_in_us_from_refresh_in_uhz(
228 in_out_vrr->fixed.target_refresh_in_uhz);
229 }
230 /* Going to a lower refresh rate (larger frame duration) */
231 } else {
232 /* Increase frame duration */
233 current_duration_in_us += ramp_rate_interpolated;
234
235 /* Adjust for frame duration above max */
236 if (current_duration_in_us >= target_duration_in_us) {
237 in_out_vrr->fixed.ramping_active = false;
238 in_out_vrr->fixed.ramping_done = true;
239 current_duration_in_us =
240 calc_duration_in_us_from_refresh_in_uhz(
241 in_out_vrr->fixed.target_refresh_in_uhz);
242 }
243 }
244
245 v_total = div64_u64(div64_u64(((unsigned long long)(
246 current_duration_in_us) * (stream->timing.pix_clk_100hz / 10)),
247 stream->timing.h_total), 1000);
248
249 /* v_total cannot be less than nominal */
250 if (v_total < stream->timing.v_total)
251 v_total = stream->timing.v_total;
252
253 in_out_vrr->adjust.v_total_min = v_total;
254 in_out_vrr->adjust.v_total_max = v_total;
255}
256
257static void apply_below_the_range(struct core_freesync *core_freesync,
258 const struct dc_stream_state *stream,
259 unsigned int last_render_time_in_us,
260 struct mod_vrr_params *in_out_vrr)
261{
262 unsigned int inserted_frame_duration_in_us = 0;
263 unsigned int mid_point_frames_ceil = 0;
264 unsigned int mid_point_frames_floor = 0;
265 unsigned int frame_time_in_us = 0;
266 unsigned int delta_from_mid_point_in_us_1 = 0xFFFFFFFF;
267 unsigned int delta_from_mid_point_in_us_2 = 0xFFFFFFFF;
268 unsigned int frames_to_insert = 0;
269 unsigned int delta_from_mid_point_delta_in_us;
270 unsigned int max_render_time_in_us =
271 in_out_vrr->max_duration_in_us - in_out_vrr->btr.margin_in_us;
272
273 /* Program BTR */
274 if ((last_render_time_in_us + in_out_vrr->btr.margin_in_us / 2) < max_render_time_in_us) {
275 /* Exit Below the Range */
276 if (in_out_vrr->btr.btr_active) {
277 in_out_vrr->btr.frame_counter = 0;
278 in_out_vrr->btr.btr_active = false;
279 }
280 } else if (last_render_time_in_us > (max_render_time_in_us + in_out_vrr->btr.margin_in_us / 2)) {
281 /* Enter Below the Range */
282 if (!in_out_vrr->btr.btr_active)
283 in_out_vrr->btr.btr_active = true;
284 }
285
286 /* BTR set to "not active" so disengage */
287 if (!in_out_vrr->btr.btr_active) {
288 in_out_vrr->btr.inserted_duration_in_us = 0;
289 in_out_vrr->btr.frames_to_insert = 0;
290 in_out_vrr->btr.frame_counter = 0;
291
292 /* Restore FreeSync */
293 in_out_vrr->adjust.v_total_min =
294 mod_freesync_calc_v_total_from_refresh(stream,
295 in_out_vrr->max_refresh_in_uhz);
296 in_out_vrr->adjust.v_total_max =
297 mod_freesync_calc_v_total_from_refresh(stream,
298 in_out_vrr->min_refresh_in_uhz);
299 /* BTR set to "active" so engage */
300 } else {
301
302 /* Calculate number of midPoint frames that could fit within
303 * the render time interval - take ceil of this value
304 */
305 mid_point_frames_ceil = (last_render_time_in_us +
306 in_out_vrr->btr.mid_point_in_us - 1) /
307 in_out_vrr->btr.mid_point_in_us;
308
309 if (mid_point_frames_ceil > 0) {
310 frame_time_in_us = last_render_time_in_us /
311 mid_point_frames_ceil;
312 delta_from_mid_point_in_us_1 =
313 (in_out_vrr->btr.mid_point_in_us >
314 frame_time_in_us) ?
315 (in_out_vrr->btr.mid_point_in_us - frame_time_in_us) :
316 (frame_time_in_us - in_out_vrr->btr.mid_point_in_us);
317 }
318
319 /* Calculate number of midPoint frames that could fit within
320 * the render time interval - take floor of this value
321 */
322 mid_point_frames_floor = last_render_time_in_us /
323 in_out_vrr->btr.mid_point_in_us;
324
325 if (mid_point_frames_floor > 0) {
326
327 frame_time_in_us = last_render_time_in_us /
328 mid_point_frames_floor;
329 delta_from_mid_point_in_us_2 =
330 (in_out_vrr->btr.mid_point_in_us >
331 frame_time_in_us) ?
332 (in_out_vrr->btr.mid_point_in_us - frame_time_in_us) :
333 (frame_time_in_us - in_out_vrr->btr.mid_point_in_us);
334 }
335
336 /* Choose number of frames to insert based on how close it
337 * can get to the mid point of the variable range.
338 * - Delta for CEIL: delta_from_mid_point_in_us_1
339 * - Delta for FLOOR: delta_from_mid_point_in_us_2
340 */
341 if (mid_point_frames_ceil &&
342 (last_render_time_in_us / mid_point_frames_ceil) <
343 in_out_vrr->min_duration_in_us) {
344 /* Check for out of range.
345 * If using CEIL produces a value that is out of range,
346 * then we are forced to use FLOOR.
347 */
348 frames_to_insert = mid_point_frames_floor;
349 } else if (mid_point_frames_floor < 2) {
350 /* Check if FLOOR would result in non-LFC. In this case
351 * choose to use CEIL
352 */
353 frames_to_insert = mid_point_frames_ceil;
354 } else if (delta_from_mid_point_in_us_1 < delta_from_mid_point_in_us_2) {
355 /* If choosing CEIL results in a frame duration that is
356 * closer to the mid point of the range.
357 * Choose CEIL
358 */
359 frames_to_insert = mid_point_frames_ceil;
360 } else {
361 /* If choosing FLOOR results in a frame duration that is
362 * closer to the mid point of the range.
363 * Choose FLOOR
364 */
365 frames_to_insert = mid_point_frames_floor;
366 }
367
368 /* Prefer current frame multiplier when BTR is enabled unless it drifts
369 * too far from the midpoint
370 */
371 if (delta_from_mid_point_in_us_1 < delta_from_mid_point_in_us_2) {
372 delta_from_mid_point_delta_in_us = delta_from_mid_point_in_us_2 -
373 delta_from_mid_point_in_us_1;
374 } else {
375 delta_from_mid_point_delta_in_us = delta_from_mid_point_in_us_1 -
376 delta_from_mid_point_in_us_2;
377 }
378 if (in_out_vrr->btr.frames_to_insert != 0 &&
379 delta_from_mid_point_delta_in_us < BTR_DRIFT_MARGIN) {
380 if (((last_render_time_in_us / in_out_vrr->btr.frames_to_insert) <
381 max_render_time_in_us) &&
382 ((last_render_time_in_us / in_out_vrr->btr.frames_to_insert) >
383 in_out_vrr->min_duration_in_us))
384 frames_to_insert = in_out_vrr->btr.frames_to_insert;
385 }
386
387 /* Either we've calculated the number of frames to insert,
388 * or we need to insert min duration frames
389 */
390 if (frames_to_insert &&
391 (last_render_time_in_us / frames_to_insert) <
392 in_out_vrr->min_duration_in_us){
393 frames_to_insert -= (frames_to_insert > 1) ?
394 1 : 0;
395 }
396
397 if (frames_to_insert > 0)
398 inserted_frame_duration_in_us = last_render_time_in_us /
399 frames_to_insert;
400
401 if (inserted_frame_duration_in_us < in_out_vrr->min_duration_in_us)
402 inserted_frame_duration_in_us = in_out_vrr->min_duration_in_us;
403
404 /* Cache the calculated variables */
405 in_out_vrr->btr.inserted_duration_in_us =
406 inserted_frame_duration_in_us;
407 in_out_vrr->btr.frames_to_insert = frames_to_insert;
408 in_out_vrr->btr.frame_counter = frames_to_insert;
409 }
410}
411
412static void apply_fixed_refresh(struct core_freesync *core_freesync,
413 const struct dc_stream_state *stream,
414 unsigned int last_render_time_in_us,
415 struct mod_vrr_params *in_out_vrr)
416{
417 bool update = false;
418 unsigned int max_render_time_in_us = in_out_vrr->max_duration_in_us;
419
420 /* Compute the exit refresh rate and exit frame duration */
421 unsigned int exit_refresh_rate_in_milli_hz = ((1000000000/max_render_time_in_us)
422 + (1000*FIXED_REFRESH_EXIT_MARGIN_IN_HZ));
423 unsigned int exit_frame_duration_in_us = 1000000000/exit_refresh_rate_in_milli_hz;
424
425 if (last_render_time_in_us < exit_frame_duration_in_us) {
426 /* Exit Fixed Refresh mode */
427 if (in_out_vrr->fixed.fixed_active) {
428 in_out_vrr->fixed.frame_counter++;
429
430 if (in_out_vrr->fixed.frame_counter >
431 FIXED_REFRESH_EXIT_FRAME_COUNT) {
432 in_out_vrr->fixed.frame_counter = 0;
433 in_out_vrr->fixed.fixed_active = false;
434 in_out_vrr->fixed.target_refresh_in_uhz = 0;
435 update = true;
436 }
437 } else
438 in_out_vrr->fixed.frame_counter = 0;
439 } else if (last_render_time_in_us > max_render_time_in_us) {
440 /* Enter Fixed Refresh mode */
441 if (!in_out_vrr->fixed.fixed_active) {
442 in_out_vrr->fixed.frame_counter++;
443
444 if (in_out_vrr->fixed.frame_counter >
445 FIXED_REFRESH_ENTER_FRAME_COUNT) {
446 in_out_vrr->fixed.frame_counter = 0;
447 in_out_vrr->fixed.fixed_active = true;
448 in_out_vrr->fixed.target_refresh_in_uhz =
449 in_out_vrr->max_refresh_in_uhz;
450 update = true;
451 }
452 } else
453 in_out_vrr->fixed.frame_counter = 0;
454 }
455
456 if (update) {
457 if (in_out_vrr->fixed.fixed_active) {
458 in_out_vrr->adjust.v_total_min =
459 mod_freesync_calc_v_total_from_refresh(
460 stream, in_out_vrr->max_refresh_in_uhz);
461 in_out_vrr->adjust.v_total_max =
462 in_out_vrr->adjust.v_total_min;
463 } else {
464 in_out_vrr->adjust.v_total_min =
465 mod_freesync_calc_v_total_from_refresh(stream,
466 in_out_vrr->max_refresh_in_uhz);
467 in_out_vrr->adjust.v_total_max =
468 mod_freesync_calc_v_total_from_refresh(stream,
469 in_out_vrr->min_refresh_in_uhz);
470 }
471 }
472}
473
474static void determine_flip_interval_workaround_req(struct mod_vrr_params *in_vrr,
475 unsigned int curr_time_stamp_in_us)
476{
477 in_vrr->flip_interval.vsync_to_flip_in_us = curr_time_stamp_in_us -
478 in_vrr->flip_interval.v_update_timestamp_in_us;
479
480 /* Determine conditions for stopping workaround */
481 if (in_vrr->flip_interval.flip_interval_workaround_active &&
482 in_vrr->flip_interval.vsyncs_between_flip < VSYNCS_BETWEEN_FLIP_THRESHOLD &&
483 in_vrr->flip_interval.vsync_to_flip_in_us > FREESYNC_VSYNC_TO_FLIP_DELTA_IN_US) {
484 in_vrr->flip_interval.flip_interval_detect_counter = 0;
485 in_vrr->flip_interval.program_flip_interval_workaround = true;
486 in_vrr->flip_interval.flip_interval_workaround_active = false;
487 } else {
488 /* Determine conditions for starting workaround */
489 if (in_vrr->flip_interval.vsyncs_between_flip >= VSYNCS_BETWEEN_FLIP_THRESHOLD &&
490 in_vrr->flip_interval.vsync_to_flip_in_us < FREESYNC_VSYNC_TO_FLIP_DELTA_IN_US) {
491 /* Increase flip interval counter we have 2 vsyncs between flips and
492 * vsync to flip interval is less than 500us
493 */
494 in_vrr->flip_interval.flip_interval_detect_counter++;
495 if (in_vrr->flip_interval.flip_interval_detect_counter > FREESYNC_CONSEC_FLIP_AFTER_VSYNC) {
496 /* Start workaround if we detect 5 consecutive instances of the above case */
497 in_vrr->flip_interval.program_flip_interval_workaround = true;
498 in_vrr->flip_interval.flip_interval_workaround_active = true;
499 }
500 } else {
501 /* Reset the flip interval counter if we condition is no longer met */
502 in_vrr->flip_interval.flip_interval_detect_counter = 0;
503 }
504 }
505
506 in_vrr->flip_interval.vsyncs_between_flip = 0;
507}
508
509static bool vrr_settings_require_update(struct core_freesync *core_freesync,
510 struct mod_freesync_config *in_config,
511 unsigned int min_refresh_in_uhz,
512 unsigned int max_refresh_in_uhz,
513 struct mod_vrr_params *in_vrr)
514{
515 if (in_vrr->state != in_config->state) {
516 return true;
517 } else if (in_vrr->state == VRR_STATE_ACTIVE_FIXED &&
518 in_vrr->fixed.target_refresh_in_uhz !=
519 in_config->fixed_refresh_in_uhz) {
520 return true;
521 } else if (in_vrr->min_refresh_in_uhz != min_refresh_in_uhz) {
522 return true;
523 } else if (in_vrr->max_refresh_in_uhz != max_refresh_in_uhz) {
524 return true;
525 }
526
527 return false;
528}
529
530bool mod_freesync_get_vmin_vmax(struct mod_freesync *mod_freesync,
531 const struct dc_stream_state *stream,
532 unsigned int *vmin,
533 unsigned int *vmax)
534{
535 *vmin = stream->adjust.v_total_min;
536 *vmax = stream->adjust.v_total_max;
537
538 return true;
539}
540
541bool mod_freesync_get_v_position(struct mod_freesync *mod_freesync,
542 struct dc_stream_state *stream,
543 unsigned int *nom_v_pos,
544 unsigned int *v_pos)
545{
546 struct core_freesync *core_freesync = NULL;
547 struct crtc_position position;
548
549 if (mod_freesync == NULL)
550 return false;
551
552 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
553
554 if (dc_stream_get_crtc_position(core_freesync->dc, &stream, 1,
555 &position.vertical_count,
556 &position.nominal_vcount)) {
557
558 *nom_v_pos = position.nominal_vcount;
559 *v_pos = position.vertical_count;
560
561 return true;
562 }
563
564 return false;
565}
566
567static void build_vrr_infopacket_data_v1(const struct mod_vrr_params *vrr,
568 struct dc_info_packet *infopacket,
569 bool freesync_on_desktop)
570{
571 /* PB1 = 0x1A (24bit AMD IEEE OUI (0x00001A) - Byte 0) */
572 infopacket->sb[1] = 0x1A;
573
574 /* PB2 = 0x00 (24bit AMD IEEE OUI (0x00001A) - Byte 1) */
575 infopacket->sb[2] = 0x00;
576
577 /* PB3 = 0x00 (24bit AMD IEEE OUI (0x00001A) - Byte 2) */
578 infopacket->sb[3] = 0x00;
579
580 /* PB4 = Reserved */
581
582 /* PB5 = Reserved */
583
584 /* PB6 = [Bits 7:3 = Reserved] */
585
586 /* PB6 = [Bit 0 = FreeSync Supported] */
587 if (vrr->state != VRR_STATE_UNSUPPORTED)
588 infopacket->sb[6] |= 0x01;
589
590 /* PB6 = [Bit 1 = FreeSync Enabled] */
591 if (vrr->state != VRR_STATE_DISABLED &&
592 vrr->state != VRR_STATE_UNSUPPORTED)
593 infopacket->sb[6] |= 0x02;
594
595 if (freesync_on_desktop) {
596 /* PB6 = [Bit 2 = FreeSync Active] */
597 if (vrr->state != VRR_STATE_DISABLED &&
598 vrr->state != VRR_STATE_UNSUPPORTED)
599 infopacket->sb[6] |= 0x04;
600 } else {
601 if (vrr->state == VRR_STATE_ACTIVE_VARIABLE ||
602 vrr->state == VRR_STATE_ACTIVE_FIXED)
603 infopacket->sb[6] |= 0x04;
604 }
605
606 // For v1 & 2 infoframes program nominal if non-fs mode, otherwise full range
607 /* PB7 = FreeSync Minimum refresh rate (Hz) */
608 if (vrr->state == VRR_STATE_ACTIVE_VARIABLE ||
609 vrr->state == VRR_STATE_ACTIVE_FIXED) {
610 infopacket->sb[7] = (unsigned char)((vrr->min_refresh_in_uhz + 500000) / 1000000);
611 } else {
612 infopacket->sb[7] = (unsigned char)((vrr->max_refresh_in_uhz + 500000) / 1000000);
613 }
614
615 /* PB8 = FreeSync Maximum refresh rate (Hz)
616 * Note: We should never go above the field rate of the mode timing set.
617 */
618 infopacket->sb[8] = (unsigned char)((vrr->max_refresh_in_uhz + 500000) / 1000000);
619}
620
621static void build_vrr_infopacket_data_v3(const struct mod_vrr_params *vrr,
622 struct dc_info_packet *infopacket,
623 bool freesync_on_desktop)
624{
625 unsigned int min_refresh;
626 unsigned int max_refresh;
627 unsigned int fixed_refresh;
628 unsigned int min_programmed;
629
630 /* PB1 = 0x1A (24bit AMD IEEE OUI (0x00001A) - Byte 0) */
631 infopacket->sb[1] = 0x1A;
632
633 /* PB2 = 0x00 (24bit AMD IEEE OUI (0x00001A) - Byte 1) */
634 infopacket->sb[2] = 0x00;
635
636 /* PB3 = 0x00 (24bit AMD IEEE OUI (0x00001A) - Byte 2) */
637 infopacket->sb[3] = 0x00;
638
639 /* PB4 = Reserved */
640
641 /* PB5 = Reserved */
642
643 /* PB6 = [Bits 7:3 = Reserved] */
644
645 /* PB6 = [Bit 0 = FreeSync Supported] */
646 if (vrr->state != VRR_STATE_UNSUPPORTED)
647 infopacket->sb[6] |= 0x01;
648
649 /* PB6 = [Bit 1 = FreeSync Enabled] */
650 if (vrr->state != VRR_STATE_DISABLED &&
651 vrr->state != VRR_STATE_UNSUPPORTED)
652 infopacket->sb[6] |= 0x02;
653
654 /* PB6 = [Bit 2 = FreeSync Active] */
655 if (freesync_on_desktop) {
656 if (vrr->state != VRR_STATE_DISABLED &&
657 vrr->state != VRR_STATE_UNSUPPORTED)
658 infopacket->sb[6] |= 0x04;
659 } else {
660 if (vrr->state == VRR_STATE_ACTIVE_VARIABLE ||
661 vrr->state == VRR_STATE_ACTIVE_FIXED)
662 infopacket->sb[6] |= 0x04;
663 }
664
665 min_refresh = (vrr->min_refresh_in_uhz + 500000) / 1000000;
666 max_refresh = (vrr->max_refresh_in_uhz + 500000) / 1000000;
667 fixed_refresh = (vrr->fixed_refresh_in_uhz + 500000) / 1000000;
668
669 min_programmed = (vrr->state == VRR_STATE_ACTIVE_FIXED) ? fixed_refresh :
670 (vrr->state == VRR_STATE_ACTIVE_VARIABLE) ? min_refresh :
671 (vrr->state == VRR_STATE_INACTIVE) ? min_refresh :
672 max_refresh; // Non-fs case, program nominal range
673
674 /* PB7 = FreeSync Minimum refresh rate (Hz) */
675 infopacket->sb[7] = min_programmed & 0xFF;
676
677 /* PB8 = FreeSync Maximum refresh rate (Hz) */
678 infopacket->sb[8] = max_refresh & 0xFF;
679
680 /* PB11 : MSB FreeSync Minimum refresh rate [Hz] - bits 9:8 */
681 infopacket->sb[11] = (min_programmed >> 8) & 0x03;
682
683 /* PB12 : MSB FreeSync Maximum refresh rate [Hz] - bits 9:8 */
684 infopacket->sb[12] = (max_refresh >> 8) & 0x03;
685
686 /* PB16 : Reserved bits 7:1, FixedRate bit 0 */
687 infopacket->sb[16] = (vrr->state == VRR_STATE_ACTIVE_FIXED) ? 1 : 0;
688}
689
690static void build_vrr_infopacket_fs2_data(enum color_transfer_func app_tf,
691 struct dc_info_packet *infopacket)
692{
693 if (app_tf != TRANSFER_FUNC_UNKNOWN) {
694 infopacket->valid = true;
695
696 if (app_tf == TRANSFER_FUNC_PQ2084)
697 infopacket->sb[9] |= 0x20; // PB9 = [Bit 5 = PQ EOTF Active]
698 else {
699 infopacket->sb[6] |= 0x08; // PB6 = [Bit 3 = Native Color Active]
700 if (app_tf == TRANSFER_FUNC_GAMMA_22)
701 infopacket->sb[9] |= 0x04; // PB9 = [Bit 2 = Gamma 2.2 EOTF Active]
702 }
703 }
704}
705
706static void build_vrr_infopacket_header_v1(enum signal_type signal,
707 struct dc_info_packet *infopacket,
708 unsigned int *payload_size)
709{
710 if (dc_is_hdmi_signal(signal)) {
711
712 /* HEADER */
713
714 /* HB0 = Packet Type = 0x83 (Source Product
715 * Descriptor InfoFrame)
716 */
717 infopacket->hb0 = DC_HDMI_INFOFRAME_TYPE_SPD;
718
719 /* HB1 = Version = 0x01 */
720 infopacket->hb1 = 0x01;
721
722 /* HB2 = [Bits 7:5 = 0] [Bits 4:0 = Length = 0x08] */
723 infopacket->hb2 = 0x08;
724
725 *payload_size = 0x08;
726
727 } else if (dc_is_dp_signal(signal)) {
728
729 /* HEADER */
730
731 /* HB0 = Secondary-data Packet ID = 0 - Only non-zero
732 * when used to associate audio related info packets
733 */
734 infopacket->hb0 = 0x00;
735
736 /* HB1 = Packet Type = 0x83 (Source Product
737 * Descriptor InfoFrame)
738 */
739 infopacket->hb1 = DC_HDMI_INFOFRAME_TYPE_SPD;
740
741 /* HB2 = [Bits 7:0 = Least significant eight bits -
742 * For INFOFRAME, the value must be 1Bh]
743 */
744 infopacket->hb2 = 0x1B;
745
746 /* HB3 = [Bits 7:2 = INFOFRAME SDP Version Number = 0x1]
747 * [Bits 1:0 = Most significant two bits = 0x00]
748 */
749 infopacket->hb3 = 0x04;
750
751 *payload_size = 0x1B;
752 }
753}
754
755static void build_vrr_infopacket_header_v2(enum signal_type signal,
756 struct dc_info_packet *infopacket,
757 unsigned int *payload_size)
758{
759 if (dc_is_hdmi_signal(signal)) {
760
761 /* HEADER */
762
763 /* HB0 = Packet Type = 0x83 (Source Product
764 * Descriptor InfoFrame)
765 */
766 infopacket->hb0 = DC_HDMI_INFOFRAME_TYPE_SPD;
767
768 /* HB1 = Version = 0x02 */
769 infopacket->hb1 = 0x02;
770
771 /* HB2 = [Bits 7:5 = 0] [Bits 4:0 = Length = 0x09] */
772 infopacket->hb2 = 0x09;
773
774 *payload_size = 0x09;
775 } else if (dc_is_dp_signal(signal)) {
776
777 /* HEADER */
778
779 /* HB0 = Secondary-data Packet ID = 0 - Only non-zero
780 * when used to associate audio related info packets
781 */
782 infopacket->hb0 = 0x00;
783
784 /* HB1 = Packet Type = 0x83 (Source Product
785 * Descriptor InfoFrame)
786 */
787 infopacket->hb1 = DC_HDMI_INFOFRAME_TYPE_SPD;
788
789 /* HB2 = [Bits 7:0 = Least significant eight bits -
790 * For INFOFRAME, the value must be 1Bh]
791 */
792 infopacket->hb2 = 0x1B;
793
794 /* HB3 = [Bits 7:2 = INFOFRAME SDP Version Number = 0x2]
795 * [Bits 1:0 = Most significant two bits = 0x00]
796 */
797 infopacket->hb3 = 0x08;
798
799 *payload_size = 0x1B;
800 }
801}
802
803static void build_vrr_infopacket_header_v3(enum signal_type signal,
804 struct dc_info_packet *infopacket,
805 unsigned int *payload_size)
806{
807 unsigned char version;
808
809 version = 3;
810 if (dc_is_hdmi_signal(signal)) {
811
812 /* HEADER */
813
814 /* HB0 = Packet Type = 0x83 (Source Product
815 * Descriptor InfoFrame)
816 */
817 infopacket->hb0 = DC_HDMI_INFOFRAME_TYPE_SPD;
818
819 /* HB1 = Version = 0x03 */
820 infopacket->hb1 = version;
821
822 /* HB2 = [Bits 7:5 = 0] [Bits 4:0 = Length] */
823 infopacket->hb2 = 0x10;
824
825 *payload_size = 0x10;
826 } else if (dc_is_dp_signal(signal)) {
827
828 /* HEADER */
829
830 /* HB0 = Secondary-data Packet ID = 0 - Only non-zero
831 * when used to associate audio related info packets
832 */
833 infopacket->hb0 = 0x00;
834
835 /* HB1 = Packet Type = 0x83 (Source Product
836 * Descriptor InfoFrame)
837 */
838 infopacket->hb1 = DC_HDMI_INFOFRAME_TYPE_SPD;
839
840 /* HB2 = [Bits 7:0 = Least significant eight bits -
841 * For INFOFRAME, the value must be 1Bh]
842 */
843 infopacket->hb2 = 0x1B;
844
845 /* HB3 = [Bits 7:2 = INFOFRAME SDP Version Number = 0x2]
846 * [Bits 1:0 = Most significant two bits = 0x00]
847 */
848
849 infopacket->hb3 = (version & 0x3F) << 2;
850
851 *payload_size = 0x1B;
852 }
853}
854
855static void build_vrr_infopacket_checksum(unsigned int *payload_size,
856 struct dc_info_packet *infopacket)
857{
858 /* Calculate checksum */
859 unsigned int idx = 0;
860 unsigned char checksum = 0;
861
862 checksum += infopacket->hb0;
863 checksum += infopacket->hb1;
864 checksum += infopacket->hb2;
865 checksum += infopacket->hb3;
866
867 for (idx = 1; idx <= *payload_size; idx++)
868 checksum += infopacket->sb[idx];
869
870 /* PB0 = Checksum (one byte complement) */
871 infopacket->sb[0] = (unsigned char)(0x100 - checksum);
872
873 infopacket->valid = true;
874}
875
876static void build_vrr_infopacket_v1(enum signal_type signal,
877 const struct mod_vrr_params *vrr,
878 struct dc_info_packet *infopacket,
879 bool freesync_on_desktop)
880{
881 /* SPD info packet for FreeSync */
882 unsigned int payload_size = 0;
883
884 build_vrr_infopacket_header_v1(signal, infopacket, &payload_size);
885 build_vrr_infopacket_data_v1(vrr, infopacket, freesync_on_desktop);
886 build_vrr_infopacket_checksum(&payload_size, infopacket);
887
888 infopacket->valid = true;
889}
890
891static void build_vrr_infopacket_v2(enum signal_type signal,
892 const struct mod_vrr_params *vrr,
893 enum color_transfer_func app_tf,
894 struct dc_info_packet *infopacket,
895 bool freesync_on_desktop)
896{
897 unsigned int payload_size = 0;
898
899 build_vrr_infopacket_header_v2(signal, infopacket, &payload_size);
900 build_vrr_infopacket_data_v1(vrr, infopacket, freesync_on_desktop);
901
902 build_vrr_infopacket_fs2_data(app_tf, infopacket);
903
904 build_vrr_infopacket_checksum(&payload_size, infopacket);
905
906 infopacket->valid = true;
907}
908
909static void build_vrr_infopacket_v3(enum signal_type signal,
910 const struct mod_vrr_params *vrr,
911 enum color_transfer_func app_tf,
912 struct dc_info_packet *infopacket,
913 bool freesync_on_desktop)
914{
915 unsigned int payload_size = 0;
916
917 build_vrr_infopacket_header_v3(signal, infopacket, &payload_size);
918 build_vrr_infopacket_data_v3(vrr, infopacket, freesync_on_desktop);
919
920 build_vrr_infopacket_fs2_data(app_tf, infopacket);
921
922 build_vrr_infopacket_checksum(&payload_size, infopacket);
923
924 infopacket->valid = true;
925}
926
927static void build_vrr_infopacket_sdp_v1_3(enum vrr_packet_type packet_type,
928 struct dc_info_packet *infopacket)
929{
930 uint8_t idx = 0, size = 0;
931
932 size = ((packet_type == PACKET_TYPE_FS_V1) ? 0x08 :
933 (packet_type == PACKET_TYPE_FS_V3) ? 0x10 :
934 0x09);
935
936 for (idx = infopacket->hb2; idx > 1; idx--) // Data Byte Count: 0x1B
937 infopacket->sb[idx] = infopacket->sb[idx-1];
938
939 infopacket->sb[1] = size; // Length
940 infopacket->sb[0] = (infopacket->hb3 >> 2) & 0x3F;//Version
941 infopacket->hb3 = (0x13 << 2); // Header,SDP 1.3
942 infopacket->hb2 = 0x1D;
943}
944
945void mod_freesync_build_vrr_infopacket(struct mod_freesync *mod_freesync,
946 const struct dc_stream_state *stream,
947 const struct mod_vrr_params *vrr,
948 enum vrr_packet_type packet_type,
949 enum color_transfer_func app_tf,
950 struct dc_info_packet *infopacket,
951 bool pack_sdp_v1_3)
952{
953 /* SPD info packet for FreeSync
954 * VTEM info packet for HdmiVRR
955 * Check if Freesync is supported. Return if false. If true,
956 * set the corresponding bit in the info packet
957 */
958 if (!vrr->send_info_frame)
959 return;
960
961 switch (packet_type) {
962 case PACKET_TYPE_FS_V3:
963 build_vrr_infopacket_v3(stream->signal, vrr, app_tf, infopacket, stream->freesync_on_desktop);
964 break;
965 case PACKET_TYPE_FS_V2:
966 build_vrr_infopacket_v2(stream->signal, vrr, app_tf, infopacket, stream->freesync_on_desktop);
967 break;
968 case PACKET_TYPE_VRR:
969 case PACKET_TYPE_FS_V1:
970 default:
971 build_vrr_infopacket_v1(stream->signal, vrr, infopacket, stream->freesync_on_desktop);
972 }
973
974 if (true == pack_sdp_v1_3 &&
975 true == dc_is_dp_signal(stream->signal) &&
976 packet_type != PACKET_TYPE_VRR &&
977 packet_type != PACKET_TYPE_VTEM)
978 build_vrr_infopacket_sdp_v1_3(packet_type, infopacket);
979}
980
981void mod_freesync_build_vrr_params(struct mod_freesync *mod_freesync,
982 const struct dc_stream_state *stream,
983 struct mod_freesync_config *in_config,
984 struct mod_vrr_params *in_out_vrr)
985{
986 struct core_freesync *core_freesync = NULL;
987 unsigned long long nominal_field_rate_in_uhz = 0;
988 unsigned long long rounded_nominal_in_uhz = 0;
989 unsigned int refresh_range = 0;
990 unsigned long long min_refresh_in_uhz = 0;
991 unsigned long long max_refresh_in_uhz = 0;
992 unsigned long long min_hardware_refresh_in_uhz = 0;
993
994 if (mod_freesync == NULL)
995 return;
996
997 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
998
999 /* Calculate nominal field rate for stream */
1000 nominal_field_rate_in_uhz =
1001 mod_freesync_calc_nominal_field_rate(stream);
1002
1003 if (stream->ctx->dc->caps.max_v_total != 0 && stream->timing.h_total != 0) {
1004 min_hardware_refresh_in_uhz = div64_u64((stream->timing.pix_clk_100hz * 100000000ULL),
1005 (stream->timing.h_total * stream->ctx->dc->caps.max_v_total));
1006 }
1007 /* Limit minimum refresh rate to what can be supported by hardware */
1008 min_refresh_in_uhz = min_hardware_refresh_in_uhz > in_config->min_refresh_in_uhz ?
1009 min_hardware_refresh_in_uhz : in_config->min_refresh_in_uhz;
1010 max_refresh_in_uhz = in_config->max_refresh_in_uhz;
1011
1012 /* Full range may be larger than current video timing, so cap at nominal */
1013 if (max_refresh_in_uhz > nominal_field_rate_in_uhz)
1014 max_refresh_in_uhz = nominal_field_rate_in_uhz;
1015
1016 /* Full range may be larger than current video timing, so cap at nominal */
1017 if (min_refresh_in_uhz > max_refresh_in_uhz)
1018 min_refresh_in_uhz = max_refresh_in_uhz;
1019
1020 /* If a monitor reports exactly max refresh of 2x of min, enforce it on nominal */
1021 rounded_nominal_in_uhz =
1022 div_u64(nominal_field_rate_in_uhz + 50000, 100000) * 100000;
1023 if (in_config->max_refresh_in_uhz == (2 * in_config->min_refresh_in_uhz) &&
1024 in_config->max_refresh_in_uhz == rounded_nominal_in_uhz)
1025 min_refresh_in_uhz = div_u64(nominal_field_rate_in_uhz, 2);
1026
1027 if (!vrr_settings_require_update(core_freesync,
1028 in_config, (unsigned int)min_refresh_in_uhz, (unsigned int)max_refresh_in_uhz,
1029 in_out_vrr))
1030 return;
1031
1032 in_out_vrr->state = in_config->state;
1033 in_out_vrr->send_info_frame = in_config->vsif_supported;
1034
1035 if (in_config->state == VRR_STATE_UNSUPPORTED) {
1036 in_out_vrr->state = VRR_STATE_UNSUPPORTED;
1037 in_out_vrr->supported = false;
1038 in_out_vrr->adjust.v_total_min = stream->timing.v_total;
1039 in_out_vrr->adjust.v_total_max = stream->timing.v_total;
1040
1041 return;
1042
1043 } else {
1044 in_out_vrr->min_refresh_in_uhz = (unsigned int)min_refresh_in_uhz;
1045 in_out_vrr->max_duration_in_us =
1046 calc_duration_in_us_from_refresh_in_uhz(
1047 (unsigned int)min_refresh_in_uhz);
1048
1049 in_out_vrr->max_refresh_in_uhz = (unsigned int)max_refresh_in_uhz;
1050 in_out_vrr->min_duration_in_us =
1051 calc_duration_in_us_from_refresh_in_uhz(
1052 (unsigned int)max_refresh_in_uhz);
1053
1054 if (in_config->state == VRR_STATE_ACTIVE_FIXED)
1055 in_out_vrr->fixed_refresh_in_uhz = in_config->fixed_refresh_in_uhz;
1056 else
1057 in_out_vrr->fixed_refresh_in_uhz = 0;
1058
1059 refresh_range = div_u64(in_out_vrr->max_refresh_in_uhz + 500000, 1000000) -
1060+ div_u64(in_out_vrr->min_refresh_in_uhz + 500000, 1000000);
1061
1062 in_out_vrr->supported = true;
1063 }
1064
1065 in_out_vrr->fixed.ramping_active = in_config->ramping;
1066
1067 in_out_vrr->btr.btr_enabled = in_config->btr;
1068
1069 if (in_out_vrr->max_refresh_in_uhz < (2 * in_out_vrr->min_refresh_in_uhz))
1070 in_out_vrr->btr.btr_enabled = false;
1071 else {
1072 in_out_vrr->btr.margin_in_us = in_out_vrr->max_duration_in_us -
1073 2 * in_out_vrr->min_duration_in_us;
1074 if (in_out_vrr->btr.margin_in_us > BTR_MAX_MARGIN)
1075 in_out_vrr->btr.margin_in_us = BTR_MAX_MARGIN;
1076 }
1077
1078 in_out_vrr->btr.btr_active = false;
1079 in_out_vrr->btr.inserted_duration_in_us = 0;
1080 in_out_vrr->btr.frames_to_insert = 0;
1081 in_out_vrr->btr.frame_counter = 0;
1082 in_out_vrr->fixed.fixed_active = false;
1083 in_out_vrr->fixed.target_refresh_in_uhz = 0;
1084
1085 in_out_vrr->btr.mid_point_in_us =
1086 (in_out_vrr->min_duration_in_us +
1087 in_out_vrr->max_duration_in_us) / 2;
1088
1089 if (in_out_vrr->state == VRR_STATE_UNSUPPORTED) {
1090 in_out_vrr->adjust.v_total_min = stream->timing.v_total;
1091 in_out_vrr->adjust.v_total_max = stream->timing.v_total;
1092 } else if (in_out_vrr->state == VRR_STATE_DISABLED) {
1093 in_out_vrr->adjust.v_total_min = stream->timing.v_total;
1094 in_out_vrr->adjust.v_total_max = stream->timing.v_total;
1095 } else if (in_out_vrr->state == VRR_STATE_INACTIVE) {
1096 in_out_vrr->adjust.v_total_min = stream->timing.v_total;
1097 in_out_vrr->adjust.v_total_max = stream->timing.v_total;
1098 } else if (in_out_vrr->state == VRR_STATE_ACTIVE_VARIABLE &&
1099 refresh_range >= MIN_REFRESH_RANGE) {
1100
1101 in_out_vrr->adjust.v_total_min =
1102 mod_freesync_calc_v_total_from_refresh(stream,
1103 in_out_vrr->max_refresh_in_uhz);
1104 in_out_vrr->adjust.v_total_max =
1105 mod_freesync_calc_v_total_from_refresh(stream,
1106 in_out_vrr->min_refresh_in_uhz);
1107 } else if (in_out_vrr->state == VRR_STATE_ACTIVE_FIXED) {
1108 in_out_vrr->fixed.target_refresh_in_uhz =
1109 in_out_vrr->fixed_refresh_in_uhz;
1110 if (in_out_vrr->fixed.ramping_active &&
1111 in_out_vrr->fixed.fixed_active) {
1112 /* Do not update vtotals if ramping is already active
1113 * in order to continue ramp from current refresh.
1114 */
1115 in_out_vrr->fixed.fixed_active = true;
1116 } else {
1117 in_out_vrr->fixed.fixed_active = true;
1118 in_out_vrr->adjust.v_total_min =
1119 mod_freesync_calc_v_total_from_refresh(stream,
1120 in_out_vrr->fixed.target_refresh_in_uhz);
1121 in_out_vrr->adjust.v_total_max =
1122 in_out_vrr->adjust.v_total_min;
1123 }
1124 } else {
1125 in_out_vrr->state = VRR_STATE_INACTIVE;
1126 in_out_vrr->adjust.v_total_min = stream->timing.v_total;
1127 in_out_vrr->adjust.v_total_max = stream->timing.v_total;
1128 }
1129}
1130
1131void mod_freesync_handle_preflip(struct mod_freesync *mod_freesync,
1132 const struct dc_plane_state *plane,
1133 const struct dc_stream_state *stream,
1134 unsigned int curr_time_stamp_in_us,
1135 struct mod_vrr_params *in_out_vrr)
1136{
1137 struct core_freesync *core_freesync = NULL;
1138 unsigned int last_render_time_in_us = 0;
1139
1140 if (mod_freesync == NULL)
1141 return;
1142
1143 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1144
1145 if (in_out_vrr->supported &&
1146 in_out_vrr->state == VRR_STATE_ACTIVE_VARIABLE) {
1147
1148 last_render_time_in_us = curr_time_stamp_in_us -
1149 plane->time.prev_update_time_in_us;
1150
1151 if (in_out_vrr->btr.btr_enabled) {
1152 apply_below_the_range(core_freesync,
1153 stream,
1154 last_render_time_in_us,
1155 in_out_vrr);
1156 } else {
1157 apply_fixed_refresh(core_freesync,
1158 stream,
1159 last_render_time_in_us,
1160 in_out_vrr);
1161 }
1162
1163 determine_flip_interval_workaround_req(in_out_vrr,
1164 curr_time_stamp_in_us);
1165
1166 }
1167}
1168
1169void mod_freesync_handle_v_update(struct mod_freesync *mod_freesync,
1170 const struct dc_stream_state *stream,
1171 struct mod_vrr_params *in_out_vrr)
1172{
1173 struct core_freesync *core_freesync = NULL;
1174 unsigned int cur_timestamp_in_us;
1175 unsigned long long cur_tick;
1176
1177 if ((mod_freesync == NULL) || (stream == NULL) || (in_out_vrr == NULL))
1178 return;
1179
1180 core_freesync = MOD_FREESYNC_TO_CORE(mod_freesync);
1181
1182 if (in_out_vrr->supported == false)
1183 return;
1184
1185 cur_tick = dm_get_timestamp(core_freesync->dc->ctx);
1186 cur_timestamp_in_us = (unsigned int)
1187 div_u64(dm_get_elapse_time_in_ns(core_freesync->dc->ctx, cur_tick, 0), 1000);
1188
1189 in_out_vrr->flip_interval.vsyncs_between_flip++;
1190 in_out_vrr->flip_interval.v_update_timestamp_in_us = cur_timestamp_in_us;
1191
1192 if (in_out_vrr->state == VRR_STATE_ACTIVE_VARIABLE &&
1193 (in_out_vrr->flip_interval.flip_interval_workaround_active ||
1194 (!in_out_vrr->flip_interval.flip_interval_workaround_active &&
1195 in_out_vrr->flip_interval.program_flip_interval_workaround))) {
1196 // set freesync vmin vmax to nominal for workaround
1197 in_out_vrr->adjust.v_total_min =
1198 mod_freesync_calc_v_total_from_refresh(
1199 stream, in_out_vrr->max_refresh_in_uhz);
1200 in_out_vrr->adjust.v_total_max =
1201 in_out_vrr->adjust.v_total_min;
1202 in_out_vrr->flip_interval.program_flip_interval_workaround = false;
1203 in_out_vrr->flip_interval.do_flip_interval_workaround_cleanup = true;
1204 return;
1205 }
1206
1207 if (in_out_vrr->state != VRR_STATE_ACTIVE_VARIABLE &&
1208 in_out_vrr->flip_interval.do_flip_interval_workaround_cleanup) {
1209 in_out_vrr->flip_interval.do_flip_interval_workaround_cleanup = false;
1210 in_out_vrr->flip_interval.flip_interval_detect_counter = 0;
1211 in_out_vrr->flip_interval.vsyncs_between_flip = 0;
1212 in_out_vrr->flip_interval.vsync_to_flip_in_us = 0;
1213 }
1214
1215 /* Below the Range Logic */
1216
1217 /* Only execute if in fullscreen mode */
1218 if (in_out_vrr->state == VRR_STATE_ACTIVE_VARIABLE &&
1219 in_out_vrr->btr.btr_active) {
1220 /* TODO: pass in flag for Pre-DCE12 ASIC
1221 * in order for frame variable duration to take affect,
1222 * it needs to be done one VSYNC early, which is at
1223 * frameCounter == 1.
1224 * For DCE12 and newer updates to V_TOTAL_MIN/MAX
1225 * will take affect on current frame
1226 */
1227 if (in_out_vrr->btr.frames_to_insert ==
1228 in_out_vrr->btr.frame_counter) {
1229 in_out_vrr->adjust.v_total_min =
1230 calc_v_total_from_duration(stream,
1231 in_out_vrr,
1232 in_out_vrr->btr.inserted_duration_in_us);
1233 in_out_vrr->adjust.v_total_max =
1234 in_out_vrr->adjust.v_total_min;
1235 }
1236
1237 if (in_out_vrr->btr.frame_counter > 0)
1238 in_out_vrr->btr.frame_counter--;
1239
1240 /* Restore FreeSync */
1241 if (in_out_vrr->btr.frame_counter == 0) {
1242 in_out_vrr->adjust.v_total_min =
1243 mod_freesync_calc_v_total_from_refresh(stream,
1244 in_out_vrr->max_refresh_in_uhz);
1245 in_out_vrr->adjust.v_total_max =
1246 mod_freesync_calc_v_total_from_refresh(stream,
1247 in_out_vrr->min_refresh_in_uhz);
1248 }
1249 }
1250
1251 /* If in fullscreen freesync mode or in video, do not program
1252 * static screen ramp values
1253 */
1254 if (in_out_vrr->state == VRR_STATE_ACTIVE_VARIABLE)
1255 in_out_vrr->fixed.ramping_active = false;
1256
1257 /* Gradual Static Screen Ramping Logic
1258 * Execute if ramp is active and user enabled freesync static screen
1259 */
1260 if (in_out_vrr->state == VRR_STATE_ACTIVE_FIXED &&
1261 in_out_vrr->fixed.ramping_active) {
1262 update_v_total_for_static_ramp(
1263 core_freesync, stream, in_out_vrr);
1264 }
1265}
1266
1267void mod_freesync_get_settings(struct mod_freesync *mod_freesync,
1268 const struct mod_vrr_params *vrr,
1269 unsigned int *v_total_min, unsigned int *v_total_max,
1270 unsigned int *event_triggers,
1271 unsigned int *window_min, unsigned int *window_max,
1272 unsigned int *lfc_mid_point_in_us,
1273 unsigned int *inserted_frames,
1274 unsigned int *inserted_duration_in_us)
1275{
1276 if (mod_freesync == NULL)
1277 return;
1278
1279 if (vrr->supported) {
1280 *v_total_min = vrr->adjust.v_total_min;
1281 *v_total_max = vrr->adjust.v_total_max;
1282 *event_triggers = 0;
1283 *lfc_mid_point_in_us = vrr->btr.mid_point_in_us;
1284 *inserted_frames = vrr->btr.frames_to_insert;
1285 *inserted_duration_in_us = vrr->btr.inserted_duration_in_us;
1286 }
1287}
1288
1289unsigned long long mod_freesync_calc_nominal_field_rate(
1290 const struct dc_stream_state *stream)
1291{
1292 unsigned long long nominal_field_rate_in_uhz = 0;
1293 unsigned int total = stream->timing.h_total * stream->timing.v_total;
1294
1295 /* Calculate nominal field rate for stream, rounded up to nearest integer */
1296 nominal_field_rate_in_uhz = stream->timing.pix_clk_100hz;
1297 nominal_field_rate_in_uhz *= 100000000ULL;
1298
1299 nominal_field_rate_in_uhz = div_u64(nominal_field_rate_in_uhz, total);
1300
1301 return nominal_field_rate_in_uhz;
1302}
1303
1304unsigned long long mod_freesync_calc_field_rate_from_timing(
1305 unsigned int vtotal, unsigned int htotal, unsigned int pix_clk)
1306{
1307 unsigned long long field_rate_in_uhz = 0;
1308 unsigned int total = htotal * vtotal;
1309
1310 /* Calculate nominal field rate for stream, rounded up to nearest integer */
1311 field_rate_in_uhz = pix_clk;
1312 field_rate_in_uhz *= 1000000ULL;
1313
1314 field_rate_in_uhz = div_u64(field_rate_in_uhz, total);
1315
1316 return field_rate_in_uhz;
1317}
1318
1319bool mod_freesync_get_freesync_enabled(struct mod_vrr_params *pVrr)
1320{
1321 return (pVrr->state != VRR_STATE_UNSUPPORTED) && (pVrr->state != VRR_STATE_DISABLED);
1322}
1323
1324bool mod_freesync_is_valid_range(uint32_t min_refresh_cap_in_uhz,
1325 uint32_t max_refresh_cap_in_uhz,
1326 uint32_t nominal_field_rate_in_uhz)
1327{
1328
1329 /* Typically nominal refresh calculated can have some fractional part.
1330 * Allow for some rounding error of actual video timing by taking floor
1331 * of caps and request. Round the nominal refresh rate.
1332 *
1333 * Dividing will convert everything to units in Hz although input
1334 * variable name is in uHz!
1335 *
1336 * Also note, this takes care of rounding error on the nominal refresh
1337 * so by rounding error we only expect it to be off by a small amount,
1338 * such as < 0.1 Hz. i.e. 143.9xxx or 144.1xxx.
1339 *
1340 * Example 1. Caps Min = 40 Hz, Max = 144 Hz
1341 * Request Min = 40 Hz, Max = 144 Hz
1342 * Nominal = 143.5x Hz rounded to 144 Hz
1343 * This function should allow this as valid request
1344 *
1345 * Example 2. Caps Min = 40 Hz, Max = 144 Hz
1346 * Request Min = 40 Hz, Max = 144 Hz
1347 * Nominal = 144.4x Hz rounded to 144 Hz
1348 * This function should allow this as valid request
1349 *
1350 * Example 3. Caps Min = 40 Hz, Max = 144 Hz
1351 * Request Min = 40 Hz, Max = 144 Hz
1352 * Nominal = 120.xx Hz rounded to 120 Hz
1353 * This function should return NOT valid since the requested
1354 * max is greater than current timing's nominal
1355 *
1356 * Example 4. Caps Min = 40 Hz, Max = 120 Hz
1357 * Request Min = 40 Hz, Max = 120 Hz
1358 * Nominal = 144.xx Hz rounded to 144 Hz
1359 * This function should return NOT valid since the nominal
1360 * is greater than the capability's max refresh
1361 */
1362 nominal_field_rate_in_uhz =
1363 div_u64(nominal_field_rate_in_uhz + 500000, 1000000);
1364 min_refresh_cap_in_uhz /= 1000000;
1365 max_refresh_cap_in_uhz /= 1000000;
1366
1367 /* Check nominal is within range */
1368 if (nominal_field_rate_in_uhz > max_refresh_cap_in_uhz ||
1369 nominal_field_rate_in_uhz < min_refresh_cap_in_uhz)
1370 return false;
1371
1372 /* If nominal is less than max, limit the max allowed refresh rate */
1373 if (nominal_field_rate_in_uhz < max_refresh_cap_in_uhz)
1374 max_refresh_cap_in_uhz = nominal_field_rate_in_uhz;
1375
1376 /* Check min is within range */
1377 if (min_refresh_cap_in_uhz > max_refresh_cap_in_uhz)
1378 return false;
1379
1380 /* For variable range, check for at least 10 Hz range */
1381 if (nominal_field_rate_in_uhz - min_refresh_cap_in_uhz < 10)
1382 return false;
1383
1384 return true;
1385}