1 /*
2  * Copyright 2012-15 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: AMD
23  *
24  */
25 
26 #ifndef __DAL_DCHUBBUB_H__
27 #define __DAL_DCHUBBUB_H__
28 
29 
30 enum dcc_control {
31 	dcc_control__256_256_xxx,
32 	dcc_control__128_128_xxx,
33 	dcc_control__256_64_64,
34 	dcc_control__256_128_128,
35 };
36 
37 enum segment_order {
38 	segment_order__na,
39 	segment_order__contiguous,
40 	segment_order__non_contiguous,
41 };
42 
43 struct dcn_hubbub_wm_set {
44 	uint32_t wm_set;
45 	uint32_t data_urgent;
46 	uint32_t pte_meta_urgent;
47 	uint32_t sr_enter;
48 	uint32_t sr_exit;
49 	uint32_t dram_clk_change;
50 	uint32_t usr_retrain;
51 	uint32_t fclk_pstate_change;
52 };
53 
54 struct dcn_hubbub_wm {
55 	struct dcn_hubbub_wm_set sets[4];
56 };
57 
58 enum dcn_hubbub_page_table_depth {
59 	DCN_PAGE_TABLE_DEPTH_1_LEVEL,
60 	DCN_PAGE_TABLE_DEPTH_2_LEVEL,
61 	DCN_PAGE_TABLE_DEPTH_3_LEVEL,
62 	DCN_PAGE_TABLE_DEPTH_4_LEVEL
63 };
64 
65 enum dcn_hubbub_page_table_block_size {
66 	DCN_PAGE_TABLE_BLOCK_SIZE_4KB = 0,
67 	DCN_PAGE_TABLE_BLOCK_SIZE_64KB = 4,
68 	DCN_PAGE_TABLE_BLOCK_SIZE_32KB = 3
69 };
70 
71 struct dcn_hubbub_phys_addr_config {
72 	struct {
73 		uint64_t fb_top;
74 		uint64_t fb_offset;
75 		uint64_t fb_base;
76 		uint64_t agp_top;
77 		uint64_t agp_bot;
78 		uint64_t agp_base;
79 	} system_aperture;
80 
81 	struct {
82 		uint64_t page_table_start_addr;
83 		uint64_t page_table_end_addr;
84 		uint64_t page_table_base_addr;
85 	} gart_config;
86 
87 	uint64_t page_table_default_page_addr;
88 };
89 
90 struct dcn_hubbub_virt_addr_config {
91 	uint64_t				page_table_start_addr;
92 	uint64_t				page_table_end_addr;
93 	enum dcn_hubbub_page_table_block_size	page_table_block_size;
94 	enum dcn_hubbub_page_table_depth	page_table_depth;
95 	uint64_t				page_table_base_addr;
96 };
97 
98 struct hubbub_addr_config {
99 	struct dcn_hubbub_phys_addr_config pa_config;
100 	struct dcn_hubbub_virt_addr_config va_config;
101 	struct {
102 		uint64_t aperture_check_fault;
103 		uint64_t generic_fault;
104 	} default_addrs;
105 };
106 
107 struct dcn_hubbub_state {
108 	uint32_t vm_fault_addr_msb;
109 	uint32_t vm_fault_addr_lsb;
110 	uint32_t vm_error_status;
111 	uint32_t vm_error_vmid;
112 	uint32_t vm_error_pipe;
113 	uint32_t vm_error_mode;
114 	uint32_t test_debug_data;
115 	uint32_t watermark_change_cntl;
116 	uint32_t dram_state_cntl;
117 };
118 
119 struct hubbub_funcs {
120 	void (*update_dchub)(
121 			struct hubbub *hubbub,
122 			struct dchub_init_data *dh_data);
123 
124 	int (*init_dchub_sys_ctx)(
125 			struct hubbub *hubbub,
126 			struct dcn_hubbub_phys_addr_config *pa_config);
127 	void (*init_vm_ctx)(
128 			struct hubbub *hubbub,
129 			struct dcn_hubbub_virt_addr_config *va_config,
130 			int vmid);
131 
132 	bool (*get_dcc_compression_cap)(struct hubbub *hubbub,
133 			const struct dc_dcc_surface_param *input,
134 			struct dc_surface_dcc_cap *output);
135 
136 	bool (*dcc_support_swizzle)(
137 			enum swizzle_mode_values swizzle,
138 			unsigned int bytes_per_element,
139 			enum segment_order *segment_order_horz,
140 			enum segment_order *segment_order_vert);
141 
142 	bool (*dcc_support_pixel_format)(
143 			enum surface_pixel_format format,
144 			unsigned int *bytes_per_element);
145 
146 	void (*wm_read_state)(struct hubbub *hubbub,
147 			struct dcn_hubbub_wm *wm);
148 
149 	void (*get_dchub_ref_freq)(struct hubbub *hubbub,
150 			unsigned int dccg_ref_freq_inKhz,
151 			unsigned int *dchub_ref_freq_inKhz);
152 
153 	bool (*program_watermarks)(
154 			struct hubbub *hubbub,
155 			struct dcn_watermark_set *watermarks,
156 			unsigned int refclk_mhz,
157 			bool safe_to_lower);
158 
159 	bool (*is_allow_self_refresh_enabled)(struct hubbub *hubbub);
160 	void (*allow_self_refresh_control)(struct hubbub *hubbub, bool allow);
161 
162 	bool (*verify_allow_pstate_change_high)(struct hubbub *hubbub);
163 
164 	void (*apply_DEDCN21_147_wa)(struct hubbub *hubbub);
165 
166 	void (*force_wm_propagate_to_pipes)(struct hubbub *hubbub);
167 
168 	void (*hubbub_read_state)(struct hubbub *hubbub, struct dcn_hubbub_state *hubbub_state);
169 
170 	void (*force_pstate_change_control)(struct hubbub *hubbub, bool force, bool allow);
171 
172 	void (*init_watermarks)(struct hubbub *hubbub);
173 
174 	/**
175 	 * @program_det_size:
176 	 *
177 	 * DE-Tile buffers (DET) is a memory that is used to convert the tiled
178 	 * data into linear, which the rest of the display can use to generate
179 	 * the graphics output. One of the main features of this component is
180 	 * that each pipe has a configurable DET buffer which means that when a
181 	 * pipe is not enabled, the device can assign the memory to other
182 	 * enabled pipes to try to be more efficient.
183 	 *
184 	 * DET logic is handled by dchubbub. Some ASICs provide a feature named
185 	 * Configurable Return Buffer (CRB) segments which can be allocated to
186 	 * compressed or detiled buffers.
187 	 */
188 	void (*program_det_size)(struct hubbub *hubbub, int hubp_inst, unsigned det_buffer_size_in_kbyte);
189 	void (*program_compbuf_size)(struct hubbub *hubbub, unsigned compbuf_size_kb, bool safe_to_increase);
190 	void (*init_crb)(struct hubbub *hubbub);
191 	void (*force_usr_retraining_allow)(struct hubbub *hubbub, bool allow);
192 	void (*set_request_limit)(struct hubbub *hubbub, int memory_channel_count, int words_per_channel);
193 	void (*dchubbub_init)(struct hubbub *hubbub);
194 };
195 
196 struct hubbub {
197 	const struct hubbub_funcs *funcs;
198 	struct dc_context *ctx;
199 	bool riommu_active;
200 };
201 
202 #endif
203