1 /*
2  * Copyright 2012-14 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 DC_STREAM_H_
27 #define DC_STREAM_H_
28 
29 #include "dc_types.h"
30 #include "grph_object_defs.h"
31 
32 /*******************************************************************************
33  * Stream Interfaces
34  ******************************************************************************/
35 
36 struct dc_stream_status {
37 	int primary_otg_inst;
38 	int stream_enc_inst;
39 	int plane_count;
40 	struct dc_plane_state *plane_states[MAX_SURFACE_NUM];
41 
42 	/*
43 	 * link this stream passes through
44 	 */
45 	struct dc_link *link;
46 };
47 
48 // TODO: References to this needs to be removed..
49 struct freesync_context {
50 	bool dummy;
51 };
52 
53 struct dc_stream_state {
54 	struct dc_sink *sink;
55 	struct dc_crtc_timing timing;
56 	struct dc_crtc_timing_adjust adjust;
57 	struct dc_info_packet vrr_infopacket;
58 	struct dc_info_packet vsc_infopacket;
59 	struct dc_info_packet vsp_infopacket;
60 
61 	struct rect src; /* composition area */
62 	struct rect dst; /* stream addressable area */
63 
64 	// TODO: References to this needs to be removed..
65 	struct freesync_context freesync_ctx;
66 
67 	struct audio_info audio_info;
68 
69 	struct dc_info_packet hdr_static_metadata;
70 	PHYSICAL_ADDRESS_LOC dmdata_address;
71 	bool   use_dynamic_meta;
72 
73 	struct dc_transfer_func *out_transfer_func;
74 	struct colorspace_transform gamut_remap_matrix;
75 	struct dc_csc_transform csc_color_matrix;
76 
77 	enum dc_color_space output_color_space;
78 	enum dc_dither_option dither_option;
79 
80 	enum view_3d_format view_format;
81 
82 	bool ignore_msa_timing_param;
83 
84 	unsigned long long periodic_fn_vsync_delta;
85 
86 	/* TODO: custom INFO packets */
87 	/* TODO: ABM info (DMCU) */
88 	/* PSR info */
89 	unsigned char psr_version;
90 	/* TODO: CEA VIC */
91 
92 	/* DMCU info */
93 	unsigned int abm_level;
94 	unsigned int bl_pwm_level;
95 
96 	/* from core_stream struct */
97 	struct dc_context *ctx;
98 
99 	/* used by DCP and FMT */
100 	struct bit_depth_reduction_params bit_depth_params;
101 	struct clamping_and_pixel_encoding_params clamping;
102 
103 	int phy_pix_clk;
104 	enum signal_type signal;
105 	bool dpms_off;
106 	bool apply_edp_fast_boot_optimization;
107 
108 	struct dc_cursor_attributes cursor_attributes;
109 	struct dc_cursor_position cursor_position;
110 	uint32_t sdr_white_level; // for boosting (SDR) cursor in HDR mode
111 
112 	/* from stream struct */
113 	struct kref refcount;
114 
115 	struct crtc_trigger_info triggered_crtc_reset;
116 
117 	/* Computed state bits */
118 	bool mode_changed : 1;
119 
120 };
121 
122 struct dc_stream_update {
123 	struct rect src;
124 	struct rect dst;
125 	struct dc_transfer_func *out_transfer_func;
126 	struct dc_info_packet *hdr_static_metadata;
127 	unsigned int *abm_level;
128 
129 	unsigned long long *periodic_fn_vsync_delta;
130 	struct dc_crtc_timing_adjust *adjust;
131 	struct dc_info_packet *vrr_infopacket;
132 	struct dc_info_packet *vsc_infopacket;
133 	struct dc_info_packet *vsp_infopacket;
134 
135 	bool *dpms_off;
136 
137 	struct colorspace_transform *gamut_remap;
138 	enum dc_color_space *output_color_space;
139 	enum dc_dither_option *dither_option;
140 
141 	struct dc_csc_transform *output_csc_transform;
142 
143 };
144 
145 bool dc_is_stream_unchanged(
146 	struct dc_stream_state *old_stream, struct dc_stream_state *stream);
147 bool dc_is_stream_scaling_unchanged(
148 	struct dc_stream_state *old_stream, struct dc_stream_state *stream);
149 
150 /*
151  * Set up surface attributes and associate to a stream
152  * The surfaces parameter is an absolute set of all surface active for the stream.
153  * If no surfaces are provided, the stream will be blanked; no memory read.
154  * Any flip related attribute changes must be done through this interface.
155  *
156  * After this call:
157  *   Surfaces attributes are programmed and configured to be composed into stream.
158  *   This does not trigger a flip.  No surface address is programmed.
159  */
160 
161 void dc_commit_updates_for_stream(struct dc *dc,
162 		struct dc_surface_update *srf_updates,
163 		int surface_count,
164 		struct dc_stream_state *stream,
165 		struct dc_stream_update *stream_update,
166 		struct dc_plane_state **plane_states,
167 		struct dc_state *state);
168 /*
169  * Log the current stream state.
170  */
171 void dc_stream_log(const struct dc *dc, const struct dc_stream_state *stream);
172 
173 uint8_t dc_get_current_stream_count(struct dc *dc);
174 struct dc_stream_state *dc_get_stream_at_index(struct dc *dc, uint8_t i);
175 
176 /*
177  * Return the current frame counter.
178  */
179 uint32_t dc_stream_get_vblank_counter(const struct dc_stream_state *stream);
180 
181 /* TODO: Return parsed values rather than direct register read
182  * This has a dependency on the caller (amdgpu_display_get_crtc_scanoutpos)
183  * being refactored properly to be dce-specific
184  */
185 bool dc_stream_get_scanoutpos(const struct dc_stream_state *stream,
186 				  uint32_t *v_blank_start,
187 				  uint32_t *v_blank_end,
188 				  uint32_t *h_position,
189 				  uint32_t *v_position);
190 
191 enum dc_status dc_add_stream_to_ctx(
192 			struct dc *dc,
193 		struct dc_state *new_ctx,
194 		struct dc_stream_state *stream);
195 
196 enum dc_status dc_remove_stream_from_ctx(
197 		struct dc *dc,
198 			struct dc_state *new_ctx,
199 			struct dc_stream_state *stream);
200 
201 
202 bool dc_add_plane_to_context(
203 		const struct dc *dc,
204 		struct dc_stream_state *stream,
205 		struct dc_plane_state *plane_state,
206 		struct dc_state *context);
207 
208 bool dc_remove_plane_from_context(
209 		const struct dc *dc,
210 		struct dc_stream_state *stream,
211 		struct dc_plane_state *plane_state,
212 		struct dc_state *context);
213 
214 bool dc_rem_all_planes_for_stream(
215 		const struct dc *dc,
216 		struct dc_stream_state *stream,
217 		struct dc_state *context);
218 
219 bool dc_add_all_planes_for_stream(
220 		const struct dc *dc,
221 		struct dc_stream_state *stream,
222 		struct dc_plane_state * const *plane_states,
223 		int plane_count,
224 		struct dc_state *context);
225 
226 enum dc_status dc_validate_stream(struct dc *dc, struct dc_stream_state *stream);
227 
228 /*
229  * Set up streams and links associated to drive sinks
230  * The streams parameter is an absolute set of all active streams.
231  *
232  * After this call:
233  *   Phy, Encoder, Timing Generator are programmed and enabled.
234  *   New streams are enabled with blank stream; no memory read.
235  */
236 /*
237  * Enable stereo when commit_streams is not required,
238  * for example, frame alternate.
239  */
240 bool dc_enable_stereo(
241 	struct dc *dc,
242 	struct dc_state *context,
243 	struct dc_stream_state *streams[],
244 	uint8_t stream_count);
245 
246 
247 enum surface_update_type dc_check_update_surfaces_for_stream(
248 		struct dc *dc,
249 		struct dc_surface_update *updates,
250 		int surface_count,
251 		struct dc_stream_update *stream_update,
252 		const struct dc_stream_status *stream_status);
253 
254 /**
255  * Create a new default stream for the requested sink
256  */
257 struct dc_stream_state *dc_create_stream_for_sink(struct dc_sink *dc_sink);
258 
259 void update_stream_signal(struct dc_stream_state *stream);
260 
261 void dc_stream_retain(struct dc_stream_state *dc_stream);
262 void dc_stream_release(struct dc_stream_state *dc_stream);
263 
264 struct dc_stream_status *dc_stream_get_status(
265 	struct dc_stream_state *dc_stream);
266 
267 /*******************************************************************************
268  * Cursor interfaces - To manages the cursor within a stream
269  ******************************************************************************/
270 /* TODO: Deprecated once we switch to dc_set_cursor_position */
271 bool dc_stream_set_cursor_attributes(
272 	struct dc_stream_state *stream,
273 	const struct dc_cursor_attributes *attributes);
274 
275 bool dc_stream_set_cursor_position(
276 	struct dc_stream_state *stream,
277 	const struct dc_cursor_position *position);
278 
279 
280 bool dc_stream_adjust_vmin_vmax(struct dc *dc,
281 				struct dc_stream_state *stream,
282 				struct dc_crtc_timing_adjust *adjust);
283 
284 bool dc_stream_get_crtc_position(struct dc *dc,
285 				 struct dc_stream_state **stream,
286 				 int num_streams,
287 				 unsigned int *v_pos,
288 				 unsigned int *nom_v_pos);
289 
290 bool dc_stream_configure_crc(struct dc *dc,
291 			     struct dc_stream_state *stream,
292 			     bool enable,
293 			     bool continuous);
294 
295 bool dc_stream_get_crc(struct dc *dc,
296 		       struct dc_stream_state *stream,
297 		       uint32_t *r_cr,
298 		       uint32_t *g_y,
299 		       uint32_t *b_cb);
300 
301 void dc_stream_set_static_screen_events(struct dc *dc,
302 					struct dc_stream_state **stream,
303 					int num_streams,
304 					const struct dc_static_screen_events *events);
305 
306 void dc_stream_set_dither_option(struct dc_stream_state *stream,
307 				 enum dc_dither_option option);
308 
309 bool dc_stream_set_gamut_remap(struct dc *dc,
310 			       const struct dc_stream_state *stream);
311 
312 bool dc_stream_program_csc_matrix(struct dc *dc,
313 				  struct dc_stream_state *stream);
314 
315 bool dc_stream_get_crtc_position(struct dc *dc,
316 				 struct dc_stream_state **stream,
317 				 int num_streams,
318 				 unsigned int *v_pos,
319 				 unsigned int *nom_v_pos);
320 
321 #endif /* DC_STREAM_H_ */
322