1/*
 2 * Copyright 2017 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#ifndef __DISPLAY_MODE_LIB_H__
26#define __DISPLAY_MODE_LIB_H__
27
28#include "dm_services.h"
29#include "dc_features.h"
30#include "display_mode_structs.h"
31#include "display_mode_enums.h"
32#include "display_mode_vba.h"
33
34enum dml_project {
35	DML_PROJECT_UNDEFINED,
36	DML_PROJECT_RAVEN1,
37	DML_PROJECT_NAVI10,
38	DML_PROJECT_NAVI10v2,
39	DML_PROJECT_DCN21,
40#ifdef CONFIG_DRM_AMD_DC_DCN3_0
41	DML_PROJECT_DCN30,
42#endif
43};
44
45struct display_mode_lib;
46
47struct dml_funcs {
48	void (*rq_dlg_get_dlg_reg)(
49			struct display_mode_lib *mode_lib,
50			display_dlg_regs_st *dlg_regs,
51			display_ttu_regs_st *ttu_regs,
52			display_e2e_pipe_params_st *e2e_pipe_param,
53			const unsigned int num_pipes,
54			const unsigned int pipe_idx,
55			const bool cstate_en,
56			const bool pstate_en,
57			const bool vm_en,
58			const bool ignore_viewport_pos,
59			const bool immediate_flip_support);
60	void (*rq_dlg_get_rq_reg)(
61		struct display_mode_lib *mode_lib,
62		display_rq_regs_st *rq_regs,
63		const display_pipe_params_st pipe_param);
64	void (*recalculate)(struct display_mode_lib *mode_lib);
65	void (*validate)(struct display_mode_lib *mode_lib);
66};
67
68struct display_mode_lib {
69	struct _vcs_dpi_ip_params_st ip;
70	struct _vcs_dpi_soc_bounding_box_st soc;
71	enum dml_project project;
72	struct vba_vars_st vba;
73	struct dal_logger *logger;
74	struct dml_funcs funcs;
75};
76
77void dml_init_instance(struct display_mode_lib *lib,
78		const struct _vcs_dpi_soc_bounding_box_st *soc_bb,
79		const struct _vcs_dpi_ip_params_st *ip_params,
80		enum dml_project project);
81
82const char *dml_get_status_message(enum dm_validation_status status);
83
84#if defined(CONFIG_DRM_AMD_DC_DCN3_0)
85void dml_log_pipe_params(
86		struct display_mode_lib *mode_lib,
87		display_e2e_pipe_params_st *pipes,
88		int pipe_cnt);
89
90void dml_log_mode_support_params(struct display_mode_lib *mode_lib);
91#endif  // CONFIG_DRM_AMD_DC_DCN3_0
92#endif