dml2_dc_resource_mgmt.h

 1/* SPDX-License-Identifier: MIT */
 2/*
 3 * Copyright 2023 Advanced Micro Devices, Inc.
 4 *
 5 * Permission is hereby granted, free of charge, to any person obtaining a
 6 * copy of this software and associated documentation files (the "Software"),
 7 * to deal in the Software without restriction, including without limitation
 8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
22 *
23 * Authors: AMD
24 *
25 */
26
27#ifndef __DML2_DC_RESOURCE_MGMT_H__
28#define __DML2_DC_RESOURCE_MGMT_H__
29
30#include "dml2_dc_types.h"
31
32struct dml2_context;
33struct dml2_dml_to_dc_pipe_mapping;
34struct dml_display_cfg_st;
35
36/*
37 * dml2_map_dc_pipes - Creates a pipe linkage in dc_state based on current display config.
38 * @ctx: Input dml2 context
39 * @state: Current dc_state to be updated.
40 * @disp_cfg: Current display config.
41 * @mapping: Pipe mapping logic structure to keep a track of pipes to be used.
42 *
43 * Based on ODM and DPPPersurface outputs calculated by the DML for the current display
44 * config, create a pipe linkage in dc_state which is then used by DC core.
45 * Make this function generic to be used by multiple DML versions.
46 *
47 * Return: True if pipe mapping and linking is successful, false otherwise.
48 */
49
50bool dml2_map_dc_pipes(struct dml2_context *ctx, struct dc_state *state, const struct dml_display_cfg_st *disp_cfg, struct dml2_dml_to_dc_pipe_mapping *mapping, const struct dc_state *existing_state);
51
52#endif