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.
23 #ifndef __AMD_SHARED_H__
24 #define __AMD_SHARED_H__
26 #include <drm/amd_asic_type.h>
27 #include <drm/drm_print.h>
30 #define AMD_MAX_USEC_TIMEOUT 1000000 /* 1000 ms */
31 struct amdgpu_ip_block;
38 AMD_ASIC_MASK = 0x0000ffffUL,
39 AMD_FLAGS_MASK = 0xffff0000UL,
40 AMD_IS_MOBILITY = 0x00010000UL,
41 AMD_IS_APU = 0x00020000UL,
42 AMD_IS_PX = 0x00040000UL,
43 AMD_EXP_HW_SUPPORT = 0x00080000UL,
47 AMD_APU_IS_RAVEN = 0x00000001UL,
48 AMD_APU_IS_RAVEN2 = 0x00000002UL,
49 AMD_APU_IS_PICASSO = 0x00000004UL,
50 AMD_APU_IS_RENOIR = 0x00000008UL,
51 AMD_APU_IS_GREEN_SARDINE = 0x00000010UL,
52 AMD_APU_IS_VANGOGH = 0x00000020UL,
53 AMD_APU_IS_CYAN_SKILLFISH2 = 0x00000040UL,
59 * GPUs are composed of IP (intellectual property) blocks. These
60 * IP blocks provide various functionalities: display, graphics,
61 * video decode, etc. The IP blocks that comprise a particular GPU
62 * are listed in the GPU's respective SoC file. amdgpu_device.c
63 * acquires the list of IP blocks for the GPU in use on initialization.
64 * It can then operate on this list to perform standard driver operations
65 * such as: init, fini, suspend, resume, etc.
68 * IP block implementations are named using the following convention:
69 * <functionality>_v<version> (E.g.: gfx_v6_0).
73 * enum amd_ip_block_type - Used to classify IP blocks by functionality.
75 * @AMD_IP_BLOCK_TYPE_COMMON: GPU Family
76 * @AMD_IP_BLOCK_TYPE_GMC: Graphics Memory Controller
77 * @AMD_IP_BLOCK_TYPE_IH: Interrupt Handler
78 * @AMD_IP_BLOCK_TYPE_SMC: System Management Controller
79 * @AMD_IP_BLOCK_TYPE_PSP: Platform Security Processor
80 * @AMD_IP_BLOCK_TYPE_DCE: Display and Compositing Engine
81 * @AMD_IP_BLOCK_TYPE_GFX: Graphics and Compute Engine
82 * @AMD_IP_BLOCK_TYPE_SDMA: System DMA Engine
83 * @AMD_IP_BLOCK_TYPE_UVD: Unified Video Decoder
84 * @AMD_IP_BLOCK_TYPE_VCE: Video Compression Engine
85 * @AMD_IP_BLOCK_TYPE_ACP: Audio Co-Processor
86 * @AMD_IP_BLOCK_TYPE_VCN: Video Core/Codec Next
87 * @AMD_IP_BLOCK_TYPE_MES: Micro-Engine Scheduler
88 * @AMD_IP_BLOCK_TYPE_JPEG: JPEG Engine
89 * @AMD_IP_BLOCK_TYPE_VPE: Video Processing Engine
90 * @AMD_IP_BLOCK_TYPE_UMSCH_MM: User Mode Scheduler for Multimedia
91 * @AMD_IP_BLOCK_TYPE_ISP: Image Signal Processor
92 * @AMD_IP_BLOCK_TYPE_NUM: Total number of IP block types
94 enum amd_ip_block_type {
95 AMD_IP_BLOCK_TYPE_COMMON,
96 AMD_IP_BLOCK_TYPE_GMC,
98 AMD_IP_BLOCK_TYPE_SMC,
99 AMD_IP_BLOCK_TYPE_PSP,
100 AMD_IP_BLOCK_TYPE_DCE,
101 AMD_IP_BLOCK_TYPE_GFX,
102 AMD_IP_BLOCK_TYPE_SDMA,
103 AMD_IP_BLOCK_TYPE_UVD,
104 AMD_IP_BLOCK_TYPE_VCE,
105 AMD_IP_BLOCK_TYPE_ACP,
106 AMD_IP_BLOCK_TYPE_VCN,
107 AMD_IP_BLOCK_TYPE_MES,
108 AMD_IP_BLOCK_TYPE_JPEG,
109 AMD_IP_BLOCK_TYPE_VPE,
110 AMD_IP_BLOCK_TYPE_UMSCH_MM,
111 AMD_IP_BLOCK_TYPE_ISP,
112 AMD_IP_BLOCK_TYPE_NUM,
115 enum amd_clockgating_state {
116 AMD_CG_STATE_GATE = 0,
121 enum amd_powergating_state {
122 AMD_PG_STATE_GATE = 0,
128 #define AMD_CG_SUPPORT_GFX_MGCG (1ULL << 0)
129 #define AMD_CG_SUPPORT_GFX_MGLS (1ULL << 1)
130 #define AMD_CG_SUPPORT_GFX_CGCG (1ULL << 2)
131 #define AMD_CG_SUPPORT_GFX_CGLS (1ULL << 3)
132 #define AMD_CG_SUPPORT_GFX_CGTS (1ULL << 4)
133 #define AMD_CG_SUPPORT_GFX_CGTS_LS (1ULL << 5)
134 #define AMD_CG_SUPPORT_GFX_CP_LS (1ULL << 6)
135 #define AMD_CG_SUPPORT_GFX_RLC_LS (1ULL << 7)
136 #define AMD_CG_SUPPORT_MC_LS (1ULL << 8)
137 #define AMD_CG_SUPPORT_MC_MGCG (1ULL << 9)
138 #define AMD_CG_SUPPORT_SDMA_LS (1ULL << 10)
139 #define AMD_CG_SUPPORT_SDMA_MGCG (1ULL << 11)
140 #define AMD_CG_SUPPORT_BIF_LS (1ULL << 12)
141 #define AMD_CG_SUPPORT_UVD_MGCG (1ULL << 13)
142 #define AMD_CG_SUPPORT_VCE_MGCG (1ULL << 14)
143 #define AMD_CG_SUPPORT_HDP_LS (1ULL << 15)
144 #define AMD_CG_SUPPORT_HDP_MGCG (1ULL << 16)
145 #define AMD_CG_SUPPORT_ROM_MGCG (1ULL << 17)
146 #define AMD_CG_SUPPORT_DRM_LS (1ULL << 18)
147 #define AMD_CG_SUPPORT_BIF_MGCG (1ULL << 19)
148 #define AMD_CG_SUPPORT_GFX_3D_CGCG (1ULL << 20)
149 #define AMD_CG_SUPPORT_GFX_3D_CGLS (1ULL << 21)
150 #define AMD_CG_SUPPORT_DRM_MGCG (1ULL << 22)
151 #define AMD_CG_SUPPORT_DF_MGCG (1ULL << 23)
152 #define AMD_CG_SUPPORT_VCN_MGCG (1ULL << 24)
153 #define AMD_CG_SUPPORT_HDP_DS (1ULL << 25)
154 #define AMD_CG_SUPPORT_HDP_SD (1ULL << 26)
155 #define AMD_CG_SUPPORT_IH_CG (1ULL << 27)
156 #define AMD_CG_SUPPORT_ATHUB_LS (1ULL << 28)
157 #define AMD_CG_SUPPORT_ATHUB_MGCG (1ULL << 29)
158 #define AMD_CG_SUPPORT_JPEG_MGCG (1ULL << 30)
159 #define AMD_CG_SUPPORT_GFX_FGCG (1ULL << 31)
160 #define AMD_CG_SUPPORT_REPEATER_FGCG (1ULL << 32)
161 #define AMD_CG_SUPPORT_GFX_PERF_CLK (1ULL << 33)
163 #define AMD_PG_SUPPORT_GFX_PG (1 << 0)
164 #define AMD_PG_SUPPORT_GFX_SMG (1 << 1)
165 #define AMD_PG_SUPPORT_GFX_DMG (1 << 2)
166 #define AMD_PG_SUPPORT_UVD (1 << 3)
167 #define AMD_PG_SUPPORT_VCE (1 << 4)
168 #define AMD_PG_SUPPORT_CP (1 << 5)
169 #define AMD_PG_SUPPORT_GDS (1 << 6)
170 #define AMD_PG_SUPPORT_RLC_SMU_HS (1 << 7)
171 #define AMD_PG_SUPPORT_SDMA (1 << 8)
172 #define AMD_PG_SUPPORT_ACP (1 << 9)
173 #define AMD_PG_SUPPORT_SAMU (1 << 10)
174 #define AMD_PG_SUPPORT_GFX_QUICK_MG (1 << 11)
175 #define AMD_PG_SUPPORT_GFX_PIPELINE (1 << 12)
176 #define AMD_PG_SUPPORT_MMHUB (1 << 13)
177 #define AMD_PG_SUPPORT_VCN (1 << 14)
178 #define AMD_PG_SUPPORT_VCN_DPG (1 << 15)
179 #define AMD_PG_SUPPORT_ATHUB (1 << 16)
180 #define AMD_PG_SUPPORT_JPEG (1 << 17)
181 #define AMD_PG_SUPPORT_IH_SRAM_PG (1 << 18)
182 #define AMD_PG_SUPPORT_JPEG_DPG (1 << 19)
185 * enum PP_FEATURE_MASK - Used to mask power play features.
187 * @PP_SCLK_DPM_MASK: Dynamic adjustment of the system (graphics) clock.
188 * @PP_MCLK_DPM_MASK: Dynamic adjustment of the memory clock.
189 * @PP_PCIE_DPM_MASK: Dynamic adjustment of PCIE clocks and lanes.
190 * @PP_SCLK_DEEP_SLEEP_MASK: System (graphics) clock deep sleep.
191 * @PP_POWER_CONTAINMENT_MASK: Power containment.
192 * @PP_UVD_HANDSHAKE_MASK: Unified video decoder handshake.
193 * @PP_SMC_VOLTAGE_CONTROL_MASK: Dynamic voltage control.
194 * @PP_VBI_TIME_SUPPORT_MASK: Vertical blank interval support.
195 * @PP_ULV_MASK: Ultra low voltage.
196 * @PP_ENABLE_GFX_CG_THRU_SMU: SMU control of GFX engine clockgating.
197 * @PP_CLOCK_STRETCH_MASK: Clock stretching.
198 * @PP_OD_FUZZY_FAN_CONTROL_MASK: Overdrive fuzzy fan control.
199 * @PP_SOCCLK_DPM_MASK: Dynamic adjustment of the SoC clock.
200 * @PP_DCEFCLK_DPM_MASK: Dynamic adjustment of the Display Controller Engine Fabric clock.
201 * @PP_OVERDRIVE_MASK: Over- and under-clocking support.
202 * @PP_GFXOFF_MASK: Dynamic graphics engine power control.
203 * @PP_ACG_MASK: Adaptive clock generator.
204 * @PP_STUTTER_MODE: Stutter mode.
205 * @PP_AVFS_MASK: Adaptive voltage and frequency scaling.
206 * @PP_GFX_DCS_MASK: GFX Async DCS.
208 * To override these settings on boot, append amdgpu.ppfeaturemask=<mask> to
209 * the kernel's command line parameters. This is usually done through a system's
210 * boot loader (E.g. GRUB). If manually loading the driver, pass
211 * ppfeaturemask=<mask> as a modprobe parameter.
213 enum PP_FEATURE_MASK {
214 PP_SCLK_DPM_MASK = 0x1,
215 PP_MCLK_DPM_MASK = 0x2,
216 PP_PCIE_DPM_MASK = 0x4,
217 PP_SCLK_DEEP_SLEEP_MASK = 0x8,
218 PP_POWER_CONTAINMENT_MASK = 0x10,
219 PP_UVD_HANDSHAKE_MASK = 0x20,
220 PP_SMC_VOLTAGE_CONTROL_MASK = 0x40,
221 PP_VBI_TIME_SUPPORT_MASK = 0x80,
223 PP_ENABLE_GFX_CG_THRU_SMU = 0x200,
224 PP_CLOCK_STRETCH_MASK = 0x400,
225 PP_OD_FUZZY_FAN_CONTROL_MASK = 0x800,
226 PP_SOCCLK_DPM_MASK = 0x1000,
227 PP_DCEFCLK_DPM_MASK = 0x2000,
228 PP_OVERDRIVE_MASK = 0x4000,
229 PP_GFXOFF_MASK = 0x8000,
230 PP_ACG_MASK = 0x10000,
231 PP_STUTTER_MODE = 0x20000,
232 PP_AVFS_MASK = 0x40000,
233 PP_GFX_DCS_MASK = 0x80000,
236 enum amd_harvest_ip_mask {
237 AMD_HARVEST_IP_VCN_MASK = 0x1,
238 AMD_HARVEST_IP_JPEG_MASK = 0x2,
239 AMD_HARVEST_IP_DMU_MASK = 0x4,
242 enum DC_FEATURE_MASK {
243 //Default value can be found at "uint amdgpu_dc_feature_mask"
244 DC_FBC_MASK = (1 << 0), //0x1, disabled by default
245 DC_MULTI_MON_PP_MCLK_SWITCH_MASK = (1 << 1), //0x2, enabled by default
246 DC_DISABLE_FRACTIONAL_PWM_MASK = (1 << 2), //0x4, disabled by default
247 DC_PSR_MASK = (1 << 3), //0x8, disabled by default for dcn < 3.1
248 DC_EDP_NO_POWER_SEQUENCING = (1 << 4), //0x10, disabled by default
249 DC_DISABLE_LTTPR_DP1_4A = (1 << 5), //0x20, disabled by default
250 DC_DISABLE_LTTPR_DP2_0 = (1 << 6), //0x40, disabled by default
251 DC_PSR_ALLOW_SMU_OPT = (1 << 7), //0x80, disabled by default
252 DC_PSR_ALLOW_MULTI_DISP_OPT = (1 << 8), //0x100, disabled by default
253 DC_REPLAY_MASK = (1 << 9), //0x200, disabled by default for dcn < 3.1.4
257 * enum DC_DEBUG_MASK - Bits that are useful for debugging the Display Core IP
261 * @DC_DISABLE_PIPE_SPLIT: If set, disable pipe-splitting
263 DC_DISABLE_PIPE_SPLIT = 0x1,
266 * @DC_DISABLE_STUTTER: If set, disable memory stutter mode
268 DC_DISABLE_STUTTER = 0x2,
271 * @DC_DISABLE_DSC: If set, disable display stream compression
273 DC_DISABLE_DSC = 0x4,
276 * @DC_DISABLE_CLOCK_GATING: If set, disable clock gating optimizations
278 DC_DISABLE_CLOCK_GATING = 0x8,
281 * @DC_DISABLE_PSR: If set, disable Panel self refresh v1 and PSR-SU
283 DC_DISABLE_PSR = 0x10,
286 * @DC_FORCE_SUBVP_MCLK_SWITCH: If set, force mclk switch in subvp, even
287 * if mclk switch in vblank is possible
289 DC_FORCE_SUBVP_MCLK_SWITCH = 0x20,
292 * @DC_DISABLE_MPO: If set, disable multi-plane offloading
294 DC_DISABLE_MPO = 0x40,
297 * @DC_ENABLE_DPIA_TRACE: If set, enable trace logging for DPIA
299 DC_ENABLE_DPIA_TRACE = 0x80,
302 * @DC_ENABLE_DML2: If set, force usage of DML2, even if the DCN version
303 * does not default to it.
305 DC_ENABLE_DML2 = 0x100,
308 * @DC_DISABLE_PSR_SU: If set, disable PSR SU
310 DC_DISABLE_PSR_SU = 0x200,
313 * @DC_DISABLE_REPLAY: If set, disable Panel Replay
315 DC_DISABLE_REPLAY = 0x400,
318 * @DC_DISABLE_IPS: If set, disable all Idle Power States, all the time.
319 * If more than one IPS debug bit is set, the lowest bit takes
320 * precedence. For example, if DC_FORCE_IPS_ENABLE and
321 * DC_DISABLE_IPS_DYNAMIC are set, then DC_DISABLE_IPS_DYNAMIC takes
324 DC_DISABLE_IPS = 0x800,
327 * @DC_DISABLE_IPS_DYNAMIC: If set, disable all IPS, all the time,
328 * *except* when driver goes into suspend.
330 DC_DISABLE_IPS_DYNAMIC = 0x1000,
333 * @DC_DISABLE_IPS2_DYNAMIC: If set, disable IPS2 (IPS1 allowed) if
334 * there is an enabled display. Otherwise, enable all IPS.
336 DC_DISABLE_IPS2_DYNAMIC = 0x2000,
339 * @DC_FORCE_IPS_ENABLE: If set, force enable all IPS, all the time.
341 DC_FORCE_IPS_ENABLE = 0x4000,
343 * @DC_DISABLE_ACPI_EDID: If set, don't attempt to fetch EDID for
344 * eDP display from ACPI _DDC method.
346 DC_DISABLE_ACPI_EDID = 0x8000,
349 * @DC_DISABLE_HDMI_CEC: If set, disable HDMI-CEC feature in amdgpu driver.
351 DC_DISABLE_HDMI_CEC = 0x10000,
354 * @DC_DISABLE_SUBVP: If set, disable DCN Sub-Viewport feature in amdgpu driver.
356 DC_DISABLE_SUBVP = 0x20000,
359 enum amd_dpm_forced_level;
362 * struct amd_ip_funcs - general hooks for managing amdgpu IP Blocks
363 * @name: Name of IP block
364 * @early_init: sets up early driver state (pre sw_init),
365 * does not configure hw - Optional
366 * @late_init: sets up late driver/hw state (post hw_init) - Optional
367 * @sw_init: sets up driver state, does not configure hw
368 * @sw_fini: tears down driver state, does not configure hw
369 * @early_fini: tears down stuff before dev detached from driver
370 * @hw_init: sets up the hw state
371 * @hw_fini: tears down the hw state
372 * @late_fini: final cleanup
373 * @prepare_suspend: handle IP specific changes to prepare for suspend
374 * (such as allocating any required memory)
375 * @suspend: handles IP specific hw/sw changes for suspend
376 * @resume: handles IP specific hw/sw changes for resume
377 * @is_idle: returns current IP block idle status
378 * @wait_for_idle: poll for idle
379 * @check_soft_reset: check soft reset the IP block
380 * @pre_soft_reset: pre soft reset the IP block
381 * @soft_reset: soft reset the IP block
382 * @post_soft_reset: post soft reset the IP block
383 * @set_clockgating_state: enable/disable cg for the IP block
384 * @set_powergating_state: enable/disable pg for the IP block
385 * @get_clockgating_state: get current clockgating status
386 * @dump_ip_state: dump the IP state of the ASIC during a gpu hang
387 * @print_ip_state: print the IP state in devcoredump for each IP of the ASIC
389 * These hooks provide an interface for controlling the operational state
390 * of IP blocks. After acquiring a list of IP blocks for the GPU in use,
391 * the driver can make chip-wide state changes by walking this list and
392 * making calls to hooks from each IP block. This list is ordered to ensure
393 * that the driver initializes the IP blocks in a safe sequence.
395 struct amd_ip_funcs {
397 int (*early_init)(struct amdgpu_ip_block *ip_block);
398 int (*late_init)(struct amdgpu_ip_block *ip_block);
399 int (*sw_init)(struct amdgpu_ip_block *ip_block);
400 int (*sw_fini)(struct amdgpu_ip_block *ip_block);
401 int (*early_fini)(struct amdgpu_ip_block *ip_block);
402 int (*hw_init)(struct amdgpu_ip_block *ip_block);
403 int (*hw_fini)(struct amdgpu_ip_block *ip_block);
404 void (*late_fini)(struct amdgpu_ip_block *ip_block);
405 int (*prepare_suspend)(struct amdgpu_ip_block *ip_block);
406 int (*suspend)(struct amdgpu_ip_block *ip_block);
407 int (*resume)(struct amdgpu_ip_block *ip_block);
408 bool (*is_idle)(void *handle);
409 int (*wait_for_idle)(struct amdgpu_ip_block *ip_block);
410 bool (*check_soft_reset)(struct amdgpu_ip_block *ip_block);
411 int (*pre_soft_reset)(struct amdgpu_ip_block *ip_block);
412 int (*soft_reset)(struct amdgpu_ip_block *ip_block);
413 int (*post_soft_reset)(struct amdgpu_ip_block *ip_block);
414 int (*set_clockgating_state)(struct amdgpu_ip_block *ip_block,
415 enum amd_clockgating_state state);
416 int (*set_powergating_state)(struct amdgpu_ip_block *ip_block,
417 enum amd_powergating_state state);
418 void (*get_clockgating_state)(void *handle, u64 *flags);
419 void (*dump_ip_state)(struct amdgpu_ip_block *ip_block);
420 void (*print_ip_state)(struct amdgpu_ip_block *ip_block, struct drm_printer *p);
424 #endif /* __AMD_SHARED_H__ */