1 /*
2  * Copyright 2015 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 __AMDGPU_DM_H__
27 #define __AMDGPU_DM_H__
28 
29 #include <drm/drmP.h>
30 #include <drm/drm_atomic.h>
31 #include "dc.h"
32 
33 /*
34  * This file contains the definition for amdgpu_display_manager
35  * and its API for amdgpu driver's use.
36  * This component provides all the display related functionality
37  * and this is the only component that calls DAL API.
38  * The API contained here intended for amdgpu driver use.
39  * The API that is called directly from KMS framework is located
40  * in amdgpu_dm_kms.h file
41  */
42 
43 #define AMDGPU_DM_MAX_DISPLAY_INDEX 31
44 /*
45 #include "include/amdgpu_dal_power_if.h"
46 #include "amdgpu_dm_irq.h"
47 */
48 
49 #include "irq_types.h"
50 #include "signal_types.h"
51 
52 /* Forward declarations */
53 struct amdgpu_device;
54 struct drm_device;
55 struct amdgpu_dm_irq_handler_data;
56 
57 struct amdgpu_dm_prev_state {
58 	struct drm_framebuffer *fb;
59 	int32_t x;
60 	int32_t y;
61 	struct drm_display_mode mode;
62 };
63 
64 struct common_irq_params {
65 	struct amdgpu_device *adev;
66 	enum dc_irq_source irq_src;
67 };
68 
69 struct irq_list_head {
70 	struct list_head head;
71 	/* In case this interrupt needs post-processing, 'work' will be queued*/
72 	struct work_struct work;
73 };
74 
75 #ifdef ENABLE_FBC
76 struct dm_comressor_info {
77 	void *cpu_addr;
78 	struct amdgpu_bo *bo_ptr;
79 	uint64_t gpu_addr;
80 };
81 #endif
82 
83 
84 struct amdgpu_display_manager {
85 	struct dal *dal;
86 	struct dc *dc;
87 	struct cgs_device *cgs_device;
88 	/* lock to be used when DAL is called from SYNC IRQ context */
89 	spinlock_t dal_lock;
90 
91 	struct amdgpu_device *adev;	/*AMD base driver*/
92 	struct drm_device *ddev;	/*DRM base driver*/
93 	u16 display_indexes_num;
94 
95 	struct amdgpu_dm_prev_state prev_state;
96 
97 	/*
98 	 * 'irq_source_handler_table' holds a list of handlers
99 	 * per (DAL) IRQ source.
100 	 *
101 	 * Each IRQ source may need to be handled at different contexts.
102 	 * By 'context' we mean, for example:
103 	 * - The ISR context, which is the direct interrupt handler.
104 	 * - The 'deferred' context - this is the post-processing of the
105 	 *	interrupt, but at a lower priority.
106 	 *
107 	 * Note that handlers are called in the same order as they were
108 	 * registered (FIFO).
109 	 */
110 	struct irq_list_head irq_handler_list_low_tab[DAL_IRQ_SOURCES_NUMBER];
111 	struct list_head irq_handler_list_high_tab[DAL_IRQ_SOURCES_NUMBER];
112 
113 	struct common_irq_params
114 	pflip_params[DC_IRQ_SOURCE_PFLIP_LAST - DC_IRQ_SOURCE_PFLIP_FIRST + 1];
115 
116 	struct common_irq_params
117 	vblank_params[DC_IRQ_SOURCE_VBLANK6 - DC_IRQ_SOURCE_VBLANK1 + 1];
118 
119 	/* this spin lock synchronizes access to 'irq_handler_list_table' */
120 	spinlock_t irq_handler_list_table_lock;
121 
122 	/* Timer-related data. */
123 	struct list_head timer_handler_list;
124 	struct workqueue_struct *timer_workqueue;
125 
126 	/* Use dal_mutex for any activity which is NOT syncronized by
127 	 * DRM mode setting locks.
128 	 * For example: amdgpu_dm_hpd_low_irq() calls into DAL *without*
129 	 * DRM mode setting locks being acquired. This is where dal_mutex
130 	 * is acquired before calling into DAL. */
131 	struct mutex dal_mutex;
132 
133 	struct backlight_device *backlight_dev;
134 
135 	const struct dc_link *backlight_link;
136 
137 	struct work_struct mst_hotplug_work;
138 
139 	struct mod_freesync *freesync_module;
140 
141 	/**
142 	 * Caches device atomic state for suspend/resume
143 	 */
144 	struct drm_atomic_state *cached_state;
145 #ifdef ENABLE_FBC
146 	struct dm_comressor_info compressor;
147 #endif
148 };
149 
150 /* basic init/fini API */
151 int amdgpu_dm_init(struct amdgpu_device *adev);
152 
153 void amdgpu_dm_fini(struct amdgpu_device *adev);
154 
155 void amdgpu_dm_destroy(void);
156 
157 /* initializes drm_device display related structures, based on the information
158  * provided by DAL. The drm strcutures are: drm_crtc, drm_connector,
159  * drm_encoder, drm_mode_config
160  *
161  * Returns 0 on success
162  */
163 int amdgpu_dm_initialize_drm_device(
164 	struct amdgpu_device *adev);
165 
166 /* removes and deallocates the drm structures, created by the above function */
167 void amdgpu_dm_destroy_drm_device(
168 	struct amdgpu_display_manager *dm);
169 
170 /* Locking/Mutex */
171 bool amdgpu_dm_acquire_dal_lock(struct amdgpu_display_manager *dm);
172 
173 bool amdgpu_dm_release_dal_lock(struct amdgpu_display_manager *dm);
174 
175 /* Register "Backlight device" accessible by user-mode. */
176 void amdgpu_dm_register_backlight_device(struct amdgpu_display_manager *dm);
177 
178 extern const struct amdgpu_ip_block_version dm_ip_block;
179 
180 void amdgpu_dm_update_connector_after_detect(
181 	struct amdgpu_connector *aconnector);
182 
183 struct amdgpu_connector *amdgpu_dm_find_first_crct_matching_connector(
184 	struct drm_atomic_state *state,
185 	struct drm_crtc *crtc,
186 	bool from_state_var);
187 
188 
189 struct amdgpu_framebuffer;
190 struct amdgpu_display_manager;
191 struct dc_validation_set;
192 struct dc_plane_state;
193 /* TODO rename to dc_stream_state */
194 struct  dc_stream;
195 
196 
197 struct dm_plane_state {
198 	struct drm_plane_state base;
199 	struct dc_plane_state *dc_state;
200 };
201 
202 struct dm_crtc_state {
203 	struct drm_crtc_state base;
204 	struct dc_stream_state *stream;
205 };
206 
207 #define to_dm_crtc_state(x)    container_of(x, struct dm_crtc_state, base)
208 
209 struct dm_atomic_state {
210 	struct drm_atomic_state base;
211 
212 	struct validate_context *context;
213 };
214 
215 #define to_dm_atomic_state(x) container_of(x, struct dm_atomic_state, base)
216 
217 
218 /*TODO Jodan Hersen use the one in amdgpu_dm*/
219 int amdgpu_dm_plane_init(struct amdgpu_display_manager *dm,
220 			struct amdgpu_plane *aplane,
221 			unsigned long possible_crtcs);
222 int amdgpu_dm_crtc_init(struct amdgpu_display_manager *dm,
223 			struct drm_plane *plane,
224 			uint32_t link_index);
225 int amdgpu_dm_connector_init(struct amdgpu_display_manager *dm,
226 			struct amdgpu_connector *amdgpu_connector,
227 			uint32_t link_index,
228 			struct amdgpu_encoder *amdgpu_encoder);
229 int amdgpu_dm_encoder_init(
230 	struct drm_device *dev,
231 	struct amdgpu_encoder *aencoder,
232 	uint32_t link_index);
233 
234 void amdgpu_dm_crtc_destroy(struct drm_crtc *crtc);
235 void amdgpu_dm_connector_destroy(struct drm_connector *connector);
236 void amdgpu_dm_encoder_destroy(struct drm_encoder *encoder);
237 
238 int amdgpu_dm_connector_get_modes(struct drm_connector *connector);
239 
240 int amdgpu_dm_atomic_commit(
241 		struct drm_device *dev,
242 		struct drm_atomic_state *state,
243 		bool nonblock);
244 
245 void amdgpu_dm_atomic_commit_tail(
246 	struct drm_atomic_state *state);
247 
248 int amdgpu_dm_atomic_check(struct drm_device *dev,
249 				struct drm_atomic_state *state);
250 
251 void amdgpu_dm_connector_funcs_reset(struct drm_connector *connector);
252 struct drm_connector_state *amdgpu_dm_connector_atomic_duplicate_state(
253 	struct drm_connector *connector);
254 int amdgpu_dm_connector_atomic_set_property(
255 	struct drm_connector *connector,
256 	struct drm_connector_state *state,
257 	struct drm_property *property,
258 	uint64_t val);
259 
260 int amdgpu_dm_connector_atomic_get_property(
261 	struct drm_connector *connector,
262 	const struct drm_connector_state *state,
263 	struct drm_property *property,
264 	uint64_t *val);
265 
266 int amdgpu_dm_get_encoder_crtc_mask(struct amdgpu_device *adev);
267 
268 void amdgpu_dm_connector_init_helper(
269 	struct amdgpu_display_manager *dm,
270 	struct amdgpu_connector *aconnector,
271 	int connector_type,
272 	struct dc_link *link,
273 	int link_index);
274 
275 int amdgpu_dm_connector_mode_valid(
276 	struct drm_connector *connector,
277 	struct drm_display_mode *mode);
278 
279 void dm_restore_drm_connector_state(struct drm_device *dev, struct drm_connector *connector);
280 
281 void amdgpu_dm_add_sink_to_freesync_module(
282 		struct drm_connector *connector,
283 		struct edid *edid);
284 
285 void amdgpu_dm_remove_sink_from_freesync_module(
286 		struct drm_connector *connector);
287 
288 extern const struct drm_encoder_helper_funcs amdgpu_dm_encoder_helper_funcs;
289 
290 #endif /* __AMDGPU_DM_H__ */
291