2 * Copyright 2012-15 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.
26 #ifndef __DAL_BIOS_PARSER_TYPES_H__
28 #define __DAL_BIOS_PARSER_TYPES_H__
30 #include "dm_services.h"
31 #include "include/signal_types.h"
32 #include "include/grph_object_ctrl_defs.h"
33 #include "include/gpio_types.h"
34 #include "include/link_service_types.h"
36 /* TODO: include signal_types.h and remove this enum */
38 AS_SIGNAL_TYPE_NONE = 0L, /* no signal */
42 AS_SIGNAL_TYPE_DISPLAY_PORT,
43 AS_SIGNAL_TYPE_GPU_PLL,
45 AS_SIGNAL_TYPE_UNKNOWN
49 BP_RESULT_OK = 0, /* There was no error */
50 BP_RESULT_BADINPUT, /*Bad input parameter */
51 BP_RESULT_BADBIOSTABLE, /* Bad BIOS table */
52 BP_RESULT_UNSUPPORTED, /* BIOS Table is not supported */
53 BP_RESULT_NORECORD, /* Record can't be found */
57 enum bp_encoder_control_action {
58 /* direct VBIOS translation! Just to simplify the translation */
59 ENCODER_CONTROL_DISABLE = 0,
60 ENCODER_CONTROL_ENABLE,
61 ENCODER_CONTROL_SETUP,
65 enum bp_transmitter_control_action {
66 /* direct VBIOS translation! Just to simplify the translation */
67 TRANSMITTER_CONTROL_DISABLE = 0,
68 TRANSMITTER_CONTROL_ENABLE,
69 TRANSMITTER_CONTROL_BACKLIGHT_OFF,
70 TRANSMITTER_CONTROL_BACKLIGHT_ON,
71 TRANSMITTER_CONTROL_BACKLIGHT_BRIGHTNESS,
72 TRANSMITTER_CONTROL_LCD_SETF_TEST_START,
73 TRANSMITTER_CONTROL_LCD_SELF_TEST_STOP,
74 TRANSMITTER_CONTROL_INIT,
75 TRANSMITTER_CONTROL_DEACTIVATE,
76 TRANSMITTER_CONTROL_ACTIAVATE,
77 TRANSMITTER_CONTROL_SETUP,
78 TRANSMITTER_CONTROL_SET_VOLTAGE_AND_PREEMPASIS,
79 /* ATOM_TRANSMITTER_ACTION_POWER_ON. This action is for eDP only
80 * (power up the panel)
82 TRANSMITTER_CONTROL_POWER_ON,
83 /* ATOM_TRANSMITTER_ACTION_POWER_OFF. This action is for eDP only
84 * (power down the panel)
86 TRANSMITTER_CONTROL_POWER_OFF
89 enum bp_external_encoder_control_action {
90 EXTERNAL_ENCODER_CONTROL_DISABLE = 0,
91 EXTERNAL_ENCODER_CONTROL_ENABLE = 1,
92 EXTERNAL_ENCODER_CONTROL_INIT = 0x7,
93 EXTERNAL_ENCODER_CONTROL_SETUP = 0xf,
94 EXTERNAL_ENCODER_CONTROL_UNBLANK = 0x10,
95 EXTERNAL_ENCODER_CONTROL_BLANK = 0x11,
98 enum bp_pipe_control_action {
99 ASIC_PIPE_DISABLE = 0,
104 enum bp_lvtma_control_action {
105 LVTMA_CONTROL_LCD_BLOFF = 2,
106 LVTMA_CONTROL_LCD_BLON = 3,
107 LVTMA_CONTROL_POWER_ON = 12,
108 LVTMA_CONTROL_POWER_OFF = 13
111 struct bp_encoder_control {
112 enum bp_encoder_control_action action;
113 enum engine_id engine_id;
114 enum transmitter transmitter;
115 enum signal_type signal;
116 enum dc_lane_count lanes_number;
117 enum dc_color_depth color_depth;
118 bool enable_dp_audio;
119 uint32_t pixel_clock; /* khz */
122 struct bp_external_encoder_control {
123 enum bp_external_encoder_control_action action;
124 enum engine_id engine_id;
125 enum dc_link_rate link_rate;
126 enum dc_lane_count lanes_number;
127 enum signal_type signal;
128 enum dc_color_depth color_depth;
130 struct graphics_object_id encoder_id;
131 struct graphics_object_id connector_obj_id;
132 uint32_t pixel_clock; /* in KHz */
135 struct bp_crtc_source_select {
136 enum engine_id engine_id;
137 enum controller_id controller_id;
138 /* from GPU Tx aka asic_signal */
139 enum signal_type signal;
140 /* sink_signal may differ from asicSignal if Translator encoder */
141 enum signal_type sink_signal;
142 enum display_output_bit_depth display_output_bit_depth;
143 bool enable_dp_audio;
146 struct bp_transmitter_control {
147 enum bp_transmitter_control_action action;
148 enum engine_id engine_id;
149 enum transmitter transmitter; /* PhyId */
150 enum dc_lane_count lanes_number;
151 enum clock_source_id pll_id; /* needed for DCE 4.0 */
152 enum signal_type signal;
153 enum dc_color_depth color_depth; /* not used for DCE6.0 */
154 enum hpd_source_id hpd_sel; /* ucHPDSel, used for DCe6.0 */
155 struct graphics_object_id connector_obj_id;
156 /* symClock; in 10kHz, pixel clock, in HDMI deep color mode, it should
157 * be pixel clock * deep_color_ratio (in KHz)
159 uint32_t pixel_clock;
160 uint32_t lane_select;
161 uint32_t lane_settings;
164 bool single_pll_mode;
167 struct bp_hw_crtc_timing_parameters {
168 enum controller_id controller_id;
169 /* horizontal part */
171 uint32_t h_addressable;
172 uint32_t h_overscan_left;
173 uint32_t h_overscan_right;
174 uint32_t h_sync_start;
175 uint32_t h_sync_width;
179 uint32_t v_addressable;
180 uint32_t v_overscan_top;
181 uint32_t v_overscan_bottom;
182 uint32_t v_sync_start;
183 uint32_t v_sync_width;
185 struct timing_flags {
186 uint32_t INTERLACE:1;
187 uint32_t PIXEL_REPETITION:4;
188 uint32_t HSYNC_POSITIVE_POLARITY:1;
189 uint32_t VSYNC_POSITIVE_POLARITY:1;
190 uint32_t HORZ_COUNT_BY_TWO:1;
194 struct bp_adjust_pixel_clock_parameters {
195 /* Input: Signal Type - to be converted to Encoder mode */
196 enum signal_type signal_type;
197 /* Input: Encoder object id */
198 struct graphics_object_id encoder_object_id;
199 /* Input: Pixel Clock (requested Pixel clock based on Video timing
200 * standard used) in KHz
202 uint32_t pixel_clock;
203 /* Output: Adjusted Pixel Clock (after VBIOS exec table) in KHz */
204 uint32_t adjusted_pixel_clock;
205 /* Output: If non-zero, this refDiv value should be used to calculate
206 * other ppll params */
207 uint32_t reference_divider;
208 /* Output: If non-zero, this postDiv value should be used to calculate
209 * other ppll params */
210 uint32_t pixel_clock_post_divider;
211 /* Input: Enable spread spectrum */
215 struct bp_pixel_clock_parameters {
216 enum controller_id controller_id; /* (Which CRTC uses this PLL) */
217 enum clock_source_id pll_id; /* Clock Source Id */
218 /* signal_type -> Encoder Mode - needed by VBIOS Exec table */
219 enum signal_type signal_type;
220 /* Adjusted Pixel Clock (after VBIOS exec table)
221 * that becomes Target Pixel Clock (100 Hz units) */
222 uint32_t target_pixel_clock_100hz;
223 /* Calculated Reference divider of Display PLL */
224 uint32_t reference_divider;
225 /* Calculated Feedback divider of Display PLL */
226 uint32_t feedback_divider;
227 /* Calculated Fractional Feedback divider of Display PLL */
228 uint32_t fractional_feedback_divider;
229 /* Calculated Pixel Clock Post divider of Display PLL */
230 uint32_t pixel_clock_post_divider;
231 struct graphics_object_id encoder_object_id; /* Encoder object id */
232 /* VBIOS returns a fixed display clock when DFS-bypass feature
233 * is enabled (KHz) */
234 uint32_t dfs_bypass_display_clock;
235 /* color depth to support HDMI deep color */
236 enum transmitter_color_depth color_depth;
238 struct program_pixel_clock_flags {
239 uint32_t FORCE_PROGRAMMING_OF_PLL:1;
240 /* Use Engine Clock as source for Display Clock when
242 uint32_t USE_E_CLOCK_AS_SOURCE_FOR_D_CLOCK:1;
243 /* Use external reference clock (refDivSrc for PLL) */
244 uint32_t SET_EXTERNAL_REF_DIV_SRC:1;
245 /* Use DFS bypass for Display clock. */
246 uint32_t SET_DISPCLK_DFS_BYPASS:1;
247 /* Force program PHY PLL only */
248 uint32_t PROGRAM_PHY_PLL_ONLY:1;
249 /* Support for YUV420 */
250 uint32_t SUPPORT_YUV_420:1;
251 /* Use XTALIN reference clock source */
252 uint32_t SET_XTALIN_REF_SRC:1;
253 /* Use GENLK reference clock source */
254 uint32_t SET_GENLOCK_REF_DIV_SRC:1;
258 enum bp_dce_clock_type {
259 DCECLOCK_TYPE_DISPLAY_CLOCK = 0,
260 DCECLOCK_TYPE_DPREFCLK = 1
263 /* DCE Clock Parameters structure for SetDceClock Exec command table */
264 struct bp_set_dce_clock_parameters {
265 enum clock_source_id pll_id; /* Clock Source Id */
266 /* Display clock or DPREFCLK value */
267 uint32_t target_clock_frequency;
268 /* Clock to set: =0: DISPCLK =1: DPREFCLK =2: PIXCLK */
269 enum bp_dce_clock_type clock_type;
271 struct set_dce_clock_flags {
272 uint32_t USE_GENERICA_AS_SOURCE_FOR_DPREFCLK:1;
273 /* Use XTALIN reference clock source */
274 uint32_t USE_XTALIN_AS_SOURCE_FOR_DPREFCLK:1;
275 /* Use PCIE reference clock source */
276 uint32_t USE_PCIE_AS_SOURCE_FOR_DPREFCLK:1;
277 /* Use GENLK reference clock source */
278 uint32_t USE_GENLOCK_AS_SOURCE_FOR_DPREFCLK:1;
282 struct spread_spectrum_flags {
283 /* 1 = Center Spread; 0 = down spread */
284 uint32_t CENTER_SPREAD:1;
285 /* 1 = external; 0 = internal */
286 uint32_t EXTERNAL_SS:1;
287 /* 1 = delta-sigma type parameter; 0 = ver1 */
291 struct bp_spread_spectrum_parameters {
292 enum clock_source_id pll_id;
294 uint32_t ds_frac_amount;
300 uint32_t range; /* In Hz unit */
303 uint32_t feedback_amount;
304 uint32_t nfrac_amount;
305 uint32_t ds_frac_size;
309 struct spread_spectrum_flags flags;
312 struct bp_encoder_cap_info {
313 uint32_t DP_HBR2_CAP:1;
314 uint32_t DP_HBR2_EN:1;
315 uint32_t DP_HBR3_EN:1;
316 uint32_t HDMI_6GB_EN:1;
317 uint32_t DP_IS_USB_C:1;
318 uint32_t RESERVED:27;
321 #endif /*__DAL_BIOS_PARSER_TYPES_H__ */