2 * Copyright 2015 Advanced Micro Devices, Inc.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
25 #ifndef DRIVERS_GPU_DRM_AMD_DC_DEV_DC_INC_RESOURCE_H_
26 #define DRIVERS_GPU_DRM_AMD_DC_DEV_DC_INC_RESOURCE_H_
28 #include "core_types.h"
29 #include "core_status.h"
30 #include "dal_asic_id.h"
31 #include "dm_pp_smu.h"
32 #include "spl/dc_spl.h"
34 #define MEMORY_TYPE_MULTIPLIER_CZ 4
35 #define MEMORY_TYPE_HBM 2
38 #define IS_PIPE_SYNCD_VALID(pipe) ((((pipe)->pipe_idx_syncd) & 0x80)?1:0)
39 #define GET_PIPE_SYNCD_FROM_PIPE(pipe) ((pipe)->pipe_idx_syncd & 0x7F)
40 #define SET_PIPE_SYNCD_TO_PIPE(pipe, pipe_syncd) ((pipe)->pipe_idx_syncd = (0x80 | pipe_syncd))
42 enum dce_version resource_parse_asic_id(
43 struct hw_asic_id asic_id);
45 struct resource_caps {
46 int num_timing_generator;
50 int num_stream_encoder;
56 unsigned int num_dig_link_enc; // Total number of DIGs (digital encoders) in DIO (Display Input/Output).
57 unsigned int num_usb4_dpia; // Total number of USB4 DPIA (DisplayPort Input Adapters).
58 int num_hpo_dp_stream_encoder;
59 int num_hpo_dp_link_encoder;
63 struct resource_straps {
64 uint32_t hdmi_disable;
65 uint32_t dc_pinstraps_audio;
66 uint32_t audio_stream_number;
69 struct resource_create_funcs {
70 void (*read_dce_straps)(
71 struct dc_context *ctx, struct resource_straps *straps);
73 struct audio *(*create_audio)(
74 struct dc_context *ctx, unsigned int inst);
76 struct stream_encoder *(*create_stream_encoder)(
77 enum engine_id eng_id, struct dc_context *ctx);
79 struct hpo_dp_stream_encoder *(*create_hpo_dp_stream_encoder)(
80 enum engine_id eng_id, struct dc_context *ctx);
81 struct hpo_dp_link_encoder *(*create_hpo_dp_link_encoder)(
83 struct dc_context *ctx);
84 struct dce_hwseq *(*create_hwseq)(
85 struct dc_context *ctx);
88 bool resource_construct(
89 unsigned int num_virtual_links,
91 struct resource_pool *pool,
92 const struct resource_create_funcs *create_funcs);
94 struct resource_pool *dc_create_resource_pool(struct dc *dc,
95 const struct dc_init_data *init_data,
96 enum dce_version dc_version);
98 void dc_destroy_resource_pool(struct dc *dc);
100 enum dc_status resource_map_pool_resources(
102 struct dc_state *context,
103 struct dc_stream_state *stream);
105 void resource_build_test_pattern_params(
106 struct resource_context *res_ctx,
107 struct pipe_ctx *pipe_ctx);
109 bool resource_build_scaling_params(struct pipe_ctx *pipe_ctx);
111 enum dc_status resource_build_scaling_params_for_context(
113 struct dc_state *context);
115 void resource_build_info_frame(struct pipe_ctx *pipe_ctx);
117 void resource_unreference_clock_source(
118 struct resource_context *res_ctx,
119 const struct resource_pool *pool,
120 struct clock_source *clock_source);
122 void resource_reference_clock_source(
123 struct resource_context *res_ctx,
124 const struct resource_pool *pool,
125 struct clock_source *clock_source);
127 int resource_get_clock_source_reference(
128 struct resource_context *res_ctx,
129 const struct resource_pool *pool,
130 struct clock_source *clock_source);
132 bool resource_are_streams_timing_synchronizable(
133 struct dc_stream_state *stream1,
134 struct dc_stream_state *stream2);
136 bool resource_are_vblanks_synchronizable(
137 struct dc_stream_state *stream1,
138 struct dc_stream_state *stream2);
140 struct clock_source *resource_find_used_clk_src_for_sharing(
141 struct resource_context *res_ctx,
142 struct pipe_ctx *pipe_ctx);
144 struct clock_source *dc_resource_find_first_free_pll(
145 struct resource_context *res_ctx,
146 const struct resource_pool *pool);
148 bool resource_attach_surfaces_to_context(
149 struct dc_plane_state *const *plane_state,
151 struct dc_stream_state *dc_stream,
152 struct dc_state *context,
153 const struct resource_pool *pool);
155 #define FREE_PIPE_INDEX_NOT_FOUND -1
158 * pipe types are identified based on MUXes in DCN front end that are capable
159 * of taking input from one DCN pipeline to another DCN pipeline. The name is
160 * in a form of XXXX_YYYY, where XXXX is the DCN front end hardware block the
161 * pipeline ends with and YYYY is the rendering role that the pipe is in.
163 * For instance OTG_MASTER is a pipe ending with OTG hardware block in its
164 * pipeline and it is in a role of a master pipe for timing generation.
166 * For quick reference a diagram of each pipe type's areas of responsibility
167 * for outputting timings on the screen is shown below:
169 * Timing Active for Stream 0
170 * __________________________________________________
171 * |OTG master 0 (OPP head 0)|OPP head 2 (DPP pipe 2) |
174 * | ______________|____ |
175 * | |DPP pipe 1 |DPP | |
180 * | |______________|____| |
183 * | ODM slice 0 | ODM slice 1 |
184 * |_________________________|________________________|
186 * Timing Active for Stream 1
187 * __________________________________________________
188 * |OTG master 4 (OPP head 4) |
194 * | Blank Pixel Data |
195 * | (generated by DPG4) |
201 * |__________________________________________________|
203 * Inter-pipe Relation
204 * __________________________________________________
205 * |PIPE IDX| DPP PIPES | OPP HEADS | OTG MASTER |
206 * | | plane 0 | slice 0 | |
207 * | 0 | -------------MPC---------ODM----------- |
208 * | | plane 1 | | | | |
209 * | 1 | ------------- | | | |
210 * | | plane 0 | slice 1 | | |
211 * | 2 | -------------MPC--------- | |
212 * | | plane 1 | | | |
213 * | 3 | ------------- | | |
215 * | 4 | | ----------------------- |
218 * |________|_______________|___________|_____________|
220 * The following is a quick reference of the class relation:
222 * DC state ---1--------0..N--- streams
224 * stream ---1-----------1--- OTG Master pipe
226 * OTG Master pipe ---1--------1..N--- OPP Head pipes
228 * OPP Head pipe ---1--------0..N--- DPP pipes
230 * stream ---1--------0..N--- Planes
232 * Plane ---1--------1..N--- DPP pipes
236 /* free pipe - free pipe is an uninitialized pipe without a stream
237 * associated with it. It is a free DCN pipe resource. It can be
238 * acquired as any type of pipe.
242 /* OTG master pipe - the master pipe of its OPP head pipes with a
243 * functional OTG. It merges all its OPP head pipes pixel data in ODM
244 * block and output to back end DIG. OTG master pipe is responsible for
245 * generating entire CRTC timing to back end DIG. An OTG master pipe may
246 * or may not have a plane. If it has a plane it blends it as the left
247 * most MPC slice of the top most layer. If it doesn't have a plane it
248 * can output pixel data from its OPP head pipes' test pattern
249 * generators (DPG) such as solid black pixel data to blank the screen.
253 /* OPP head pipe - the head pipe of an MPC blending tree with a
254 * functional OPP outputting to an OTG. OPP head pipe is responsible for
255 * processing output pixels in its own ODM slice. It may or may not have
256 * a plane. If it has a plane it blends it as the top most layer within
257 * its own ODM slice. If it doesn't have a plane it can output pixel
258 * data from its DPG such as solid black pixel data to blank the pixel
259 * data in its own ODM slice. OTG master pipe is also an OPP head pipe
260 * but with more responsibility.
264 /* DPP pipe - the pipe with a functional DPP outputting to an OPP head
265 * pipe's MPC. DPP pipe is responsible for processing pixel data from
266 * its own MPC slice of a plane. It must be connected to an OPP head
267 * pipe and it must have a plane associated with it.
273 * Determine if the input pipe_ctx is of a pipe type.
274 * return - true if pipe_ctx is of the input type.
276 bool resource_is_pipe_type(const struct pipe_ctx *pipe_ctx, enum pipe_type type);
279 * Acquire a pipe as OTG master pipe and allocate pipe resources required to
280 * enable stream output.
282 enum dc_status resource_add_otg_master_for_stream_output(struct dc_state *new_ctx,
283 const struct resource_pool *pool,
284 struct dc_stream_state *stream);
287 * Release pipe resources and the OTG master pipe associated with the stream
288 * The stream must have all planes removed and ODM/MPC slice counts are reset
289 * to 1 before invoking this interface.
291 void resource_remove_otg_master_for_stream_output(struct dc_state *new_ctx,
292 const struct resource_pool *pool,
293 struct dc_stream_state *stream);
296 * Add plane to the bottom most layer in plane composition and allocate DPP pipe
297 * resources as needed.
298 * return - true if plane is added in plane composition, false otherwise.
300 bool resource_append_dpp_pipes_for_plane_composition(
301 struct dc_state *new_ctx,
302 struct dc_state *cur_ctx,
303 struct resource_pool *pool,
304 struct pipe_ctx *otg_master_pipe,
305 struct dc_plane_state *plane_state);
308 * Add plane to the bottom most layer in plane composition and allocate DPP pipe
309 * resources as needed.
310 * return - true if plane is added in plane composition, false otherwise.
312 void resource_remove_dpp_pipes_for_plane_composition(
313 struct dc_state *context,
314 const struct resource_pool *pool,
315 const struct dc_plane_state *plane_state);
318 * Update ODM slice count by acquiring or releasing pipes. If new slices need
319 * to be added, it is going to add them to the last ODM index. If existing
320 * slices need to be removed, it is going to remove them from the last ODM
323 * return - true if ODM slices are updated and required pipes are acquired. All
324 * affected pipe parameters are updated.
326 * false if resource fails to complete this update. The function is not designed
327 * to recover the creation of invalid topologies. Returning false is typically
328 * an indication of insufficient validation in caller's stack. new_ctx will be
329 * invalid. Caller may attempt to restore new_ctx by calling this function
330 * again with original slice count.
332 bool resource_update_pipes_for_stream_with_slice_count(
333 struct dc_state *new_ctx,
334 const struct dc_state *cur_ctx,
335 const struct resource_pool *pool,
336 const struct dc_stream_state *stream,
337 int new_slice_count);
340 * Update MPC slice count by acquiring or releasing DPP pipes. If new slices
341 * need to be added it is going to add to the last MPC index. If existing
342 * slices need to be removed, it is going to remove them from the last MPC
345 * @dpp_pipe - top most dpp pipe for MPCC combine.
347 * return - true if MPC slices are updated and required pipes are acquired. All
348 * affected pipe parameters are updated.
350 * false if resource fails to complete this update. The function is not designed
351 * to recover the creation of invalid topologies. Returning false is typically
352 * an indication of insufficient validation in caller's stack. new_ctx will be
353 * invalid. Caller may attempt to restore new_ctx by calling this function
354 * again with original slice count.
356 bool resource_update_pipes_for_plane_with_slice_count(
357 struct dc_state *new_ctx,
358 const struct dc_state *cur_ctx,
359 const struct resource_pool *pool,
360 const struct dc_plane_state *plane,
364 * Get the OTG master pipe in resource context associated with the stream.
365 * return - NULL if not found. Otherwise the OTG master pipe associated with the
368 struct pipe_ctx *resource_get_otg_master_for_stream(
369 struct resource_context *res_ctx,
370 const struct dc_stream_state *stream);
373 * Get an array of OPP heads in opp_heads ordered with index low to high for OTG
374 * master pipe in res_ctx.
375 * return - number of OPP heads in the array. If otg_master passed in is not
376 * an OTG master, the function returns 0.
378 int resource_get_opp_heads_for_otg_master(const struct pipe_ctx *otg_master,
379 struct resource_context *res_ctx,
380 struct pipe_ctx *opp_heads[MAX_PIPES]);
383 * Get an array of DPP pipes in dpp_pipes ordered with index low to high for OPP
384 * head pipe in res_ctx.
385 * return - number of DPP pipes in the array. If opp_head passed in is not
386 * an OPP pipe, the function returns 0.
388 int resource_get_dpp_pipes_for_opp_head(const struct pipe_ctx *opp_head,
389 struct resource_context *res_ctx,
390 struct pipe_ctx *dpp_pipes[MAX_PIPES]);
393 * Get an array of DPP pipes in dpp_pipes ordered with index low to high for
395 * return - number of DPP pipes in the array.
397 int resource_get_dpp_pipes_for_plane(const struct dc_plane_state *plane,
398 struct resource_context *res_ctx,
399 struct pipe_ctx *dpp_pipes[MAX_PIPES]);
402 * Get the OTG master pipe for the input pipe context.
403 * return - the OTG master pipe for the input pipe
406 struct pipe_ctx *resource_get_otg_master(const struct pipe_ctx *pipe_ctx);
409 * Get the OPP head pipe for the input pipe context.
410 * return - the OPP head pipe for the input pipe
413 struct pipe_ctx *resource_get_opp_head(const struct pipe_ctx *pipe_ctx);
416 * Get the DPP pipe allocated for MPC slice 0 and ODM slice 0 of the plane
417 * associated with dpp_pipe.
419 struct pipe_ctx *resource_get_primary_dpp_pipe(const struct pipe_ctx *dpp_pipe);
422 * Get the MPC slice index counting from 0 from left most slice
423 * For example, if a DPP pipe is used as a secondary pipe in MPCC combine, MPC
424 * split index is greater than 0.
426 int resource_get_mpc_slice_index(const struct pipe_ctx *dpp_pipe);
429 * Get the number of MPC slices associated with the pipe.
430 * The function returns 0 if the pipe is not associated with an MPC combine
433 int resource_get_mpc_slice_count(const struct pipe_ctx *pipe);
436 * Get the number of ODM slices associated with the pipe.
437 * The function returns 0 if the pipe is not associated with an ODM combine
440 int resource_get_odm_slice_count(const struct pipe_ctx *pipe);
442 /* Get the ODM slice index counting from 0 from left most slice */
443 int resource_get_odm_slice_index(const struct pipe_ctx *opp_head);
445 /* Get ODM slice source rect in timing active as input to OPP block */
446 struct rect resource_get_odm_slice_src_rect(struct pipe_ctx *pipe_ctx);
448 /* Get ODM slice destination rect in timing active as output from OPP block */
449 struct rect resource_get_odm_slice_dst_rect(struct pipe_ctx *pipe_ctx);
451 /* Get ODM slice destination width in timing active as output from OPP block */
452 int resource_get_odm_slice_dst_width(struct pipe_ctx *otg_master,
453 bool is_last_segment);
455 /* determine if pipe topology is changed between state a and state b */
456 bool resource_is_pipe_topology_changed(const struct dc_state *state_a,
457 const struct dc_state *state_b);
460 * determine if the two OTG master pipes have the same ODM topology
462 * false - if pipes passed in are not OTG masters or ODM topology is
466 bool resource_is_odm_topology_changed(const struct pipe_ctx *otg_master_a,
467 const struct pipe_ctx *otg_master_b);
469 /* log the pipe topology update in state */
470 void resource_log_pipe_topology_update(struct dc *dc, struct dc_state *state);
473 * Look for a free pipe in new resource context that is used as a secondary OPP
474 * head by cur_otg_master.
476 * return - FREE_PIPE_INDEX_NOT_FOUND if free pipe is not found, otherwise
477 * pipe idx of the free pipe
479 int resource_find_free_pipe_used_as_sec_opp_head_by_cur_otg_master(
480 const struct resource_context *cur_res_ctx,
481 struct resource_context *new_res_ctx,
482 const struct pipe_ctx *cur_otg_master);
485 * Look for a free pipe in new resource context that is used as a secondary DPP
486 * pipe in MPC blending tree associated with input OPP head pipe.
488 * return - FREE_PIPE_INDEX_NOT_FOUND if free pipe is not found, otherwise
489 * pipe idx of the free pipe
491 int resource_find_free_pipe_used_in_cur_mpc_blending_tree(
492 const struct resource_context *cur_res_ctx,
493 struct resource_context *new_res_ctx,
494 const struct pipe_ctx *cur_opp_head);
497 * Look for a free pipe in new resource context that is not used in current
500 * return - FREE_PIPE_INDEX_NOT_FOUND if free pipe is not found, otherwise
501 * pipe idx of the free pipe
503 int recource_find_free_pipe_not_used_in_cur_res_ctx(
504 const struct resource_context *cur_res_ctx,
505 struct resource_context *new_res_ctx,
506 const struct resource_pool *pool);
509 * Look for a free pipe in new resource context that is used in current resource
510 * context as an OTG master pipe.
512 * return - FREE_PIPE_INDEX_NOT_FOUND if free pipe is not found, otherwise
513 * pipe idx of the free pipe
515 int recource_find_free_pipe_used_as_otg_master_in_cur_res_ctx(
516 const struct resource_context *cur_res_ctx,
517 struct resource_context *new_res_ctx,
518 const struct resource_pool *pool);
521 * Look for a free pipe in new resource context that is used as a secondary DPP
522 * pipe in current resource context.
523 * return - FREE_PIPE_INDEX_NOT_FOUND if free pipe is not found, otherwise
524 * pipe idx of the free pipe
526 int resource_find_free_pipe_used_as_cur_sec_dpp(
527 const struct resource_context *cur_res_ctx,
528 struct resource_context *new_res_ctx,
529 const struct resource_pool *pool);
532 * Look for a free pipe in new resource context that is used as a secondary DPP
533 * pipe in any MPCC combine in current resource context.
534 * return - FREE_PIPE_INDEX_NOT_FOUND if free pipe is not found, otherwise
535 * pipe idx of the free pipe
537 int resource_find_free_pipe_used_as_cur_sec_dpp_in_mpcc_combine(
538 const struct resource_context *cur_res_ctx,
539 struct resource_context *new_res_ctx,
540 const struct resource_pool *pool);
543 * Look for any free pipe in new resource context.
544 * return - FREE_PIPE_INDEX_NOT_FOUND if free pipe is not found, otherwise
545 * pipe idx of the free pipe
547 int resource_find_any_free_pipe(struct resource_context *new_res_ctx,
548 const struct resource_pool *pool);
551 * Legacy find free secondary pipe logic deprecated for newer DCNs as it doesn't
552 * find the most optimal free pipe to prevent from time consuming hardware state
555 struct pipe_ctx *resource_find_free_secondary_pipe_legacy(
556 struct resource_context *res_ctx,
557 const struct resource_pool *pool,
558 const struct pipe_ctx *primary_pipe);
560 bool resource_validate_attach_surfaces(
561 const struct dc_validation_set set[],
563 const struct dc_state *old_context,
564 struct dc_state *context,
565 const struct resource_pool *pool);
567 enum dc_status resource_map_clock_resources(
569 struct dc_state *context,
570 struct dc_stream_state *stream);
572 enum dc_status resource_map_phy_clock_resources(
574 struct dc_state *context,
575 struct dc_stream_state *stream);
577 bool pipe_need_reprogram(
578 struct pipe_ctx *pipe_ctx_old,
579 struct pipe_ctx *pipe_ctx);
581 void resource_build_bit_depth_reduction_params(struct dc_stream_state *stream,
582 struct bit_depth_reduction_params *fmt_bit_depth);
584 void update_audio_usage(
585 struct resource_context *res_ctx,
586 const struct resource_pool *pool,
590 unsigned int resource_pixel_format_to_bpp(enum surface_pixel_format format);
592 bool get_temp_dp_link_res(struct dc_link *link,
593 struct link_resource *link_res,
594 struct dc_link_settings *link_settings);
596 void reset_syncd_pipes_from_disabled_pipes(struct dc *dc,
597 struct dc_state *context);
599 void check_syncd_pipes_for_disabled_master_pipe(struct dc *dc,
600 struct dc_state *context,
601 uint8_t disabled_master_pipe_idx);
603 void reset_sync_context_for_pipe(const struct dc *dc,
604 struct dc_state *context,
607 uint8_t resource_transmitter_to_phy_idx(const struct dc *dc, enum transmitter transmitter);
609 const struct link_hwss *get_link_hwss(const struct dc_link *link,
610 const struct link_resource *link_res);
612 bool is_h_timing_divisible_by_2(struct dc_stream_state *stream);
614 bool dc_resource_acquire_secondary_pipe_for_mpc_odm_legacy(
616 struct dc_state *state,
617 struct pipe_ctx *pri_pipe,
618 struct pipe_ctx *sec_pipe,
621 /* A test harness interface that modifies dp encoder resources in the given dc
622 * state and bypasses the need to revalidate. The interface assumes that the
623 * test harness interface is called with pre-validated link config stored in the
624 * pipe_ctx and updates dp encoder resources according to the link config.
626 enum dc_status update_dp_encoder_resources_for_test_harness(const struct dc *dc,
627 struct dc_state *context,
628 struct pipe_ctx *pipe_ctx);
630 bool check_subvp_sw_cursor_fallback_req(const struct dc *dc, struct dc_stream_state *stream);
632 /* Get hw programming parameters container from pipe context
633 * @pipe_ctx: pipe context
634 * @dscl_prog_data: struct to hold programmable hw reg values
636 struct dscl_prog_data *resource_get_dscl_prog_data(struct pipe_ctx *pipe_ctx);
637 /* Setup dc callbacks for dml2
638 * @dc: the display core structure
639 * @dml2_options: struct to hold callbacks
641 void resource_init_common_dml2_callbacks(struct dc *dc, struct dml2_configuration_options *dml2_options);
644 *Calculate total DET allocated for all pipes for a given OTG_MASTER pipe
646 int resource_calculate_det_for_stream(struct dc_state *state, struct pipe_ctx *otg_master);
648 bool resource_is_hpo_acquired(struct dc_state *context);
649 #endif /* DRIVERS_GPU_DRM_AMD_DC_DEV_DC_INC_RESOURCE_H_ */