2 * Copyright 2016-2024 Advanced Micro Devices, Inc. All rights reserved.
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.
24 #ifndef __AMDGPU_VCN_H__
25 #define __AMDGPU_VCN_H__
27 #include "amdgpu_ras.h"
29 #define AMDGPU_VCN_STACK_SIZE (128*1024)
30 #define AMDGPU_VCN_CONTEXT_SIZE (512*1024)
32 #define AMDGPU_VCN_FIRMWARE_OFFSET 256
33 #define AMDGPU_VCN_MAX_ENC_RINGS 3
35 #define AMDGPU_MAX_VCN_INSTANCES 4
36 #define AMDGPU_MAX_VCN_ENC_RINGS (AMDGPU_VCN_MAX_ENC_RINGS * AMDGPU_MAX_VCN_INSTANCES)
38 #define AMDGPU_VCN_HARVEST_VCN0 (1 << 0)
39 #define AMDGPU_VCN_HARVEST_VCN1 (1 << 1)
41 #define VCN_DEC_KMD_CMD 0x80000000
42 #define VCN_DEC_CMD_FENCE 0x00000000
43 #define VCN_DEC_CMD_TRAP 0x00000001
44 #define VCN_DEC_CMD_WRITE_REG 0x00000004
45 #define VCN_DEC_CMD_REG_READ_COND_WAIT 0x00000006
46 #define VCN_DEC_CMD_PACKET_START 0x0000000a
47 #define VCN_DEC_CMD_PACKET_END 0x0000000b
49 #define VCN_DEC_SW_CMD_NO_OP 0x00000000
50 #define VCN_DEC_SW_CMD_END 0x00000001
51 #define VCN_DEC_SW_CMD_IB 0x00000002
52 #define VCN_DEC_SW_CMD_FENCE 0x00000003
53 #define VCN_DEC_SW_CMD_TRAP 0x00000004
54 #define VCN_DEC_SW_CMD_IB_AUTO 0x00000005
55 #define VCN_DEC_SW_CMD_SEMAPHORE 0x00000006
56 #define VCN_DEC_SW_CMD_PREEMPT_FENCE 0x00000009
57 #define VCN_DEC_SW_CMD_REG_WRITE 0x0000000b
58 #define VCN_DEC_SW_CMD_REG_WAIT 0x0000000c
60 #define VCN_ENC_CMD_NO_OP 0x00000000
61 #define VCN_ENC_CMD_END 0x00000001
62 #define VCN_ENC_CMD_IB 0x00000002
63 #define VCN_ENC_CMD_FENCE 0x00000003
64 #define VCN_ENC_CMD_TRAP 0x00000004
65 #define VCN_ENC_CMD_REG_WRITE 0x0000000b
66 #define VCN_ENC_CMD_REG_WAIT 0x0000000c
68 #define VCN_AON_SOC_ADDRESS_2_0 0x1f800
69 #define VCN1_AON_SOC_ADDRESS_3_0 0x48000
70 #define VCN_VID_IP_ADDRESS_2_0 0x0
71 #define VCN_AON_IP_ADDRESS_2_0 0x30000
73 #define mmUVD_RBC_XX_IB_REG_CHECK 0x026b
74 #define mmUVD_RBC_XX_IB_REG_CHECK_BASE_IDX 1
75 #define mmUVD_REG_XX_MASK 0x026c
76 #define mmUVD_REG_XX_MASK_BASE_IDX 1
78 /* 1 second timeout */
79 #define VCN_IDLE_TIMEOUT msecs_to_jiffies(1000)
81 #define RREG32_SOC15_DPG_MODE_1_0(ip, inst_idx, reg, mask, sram_sel) \
82 ({ WREG32_SOC15(ip, inst_idx, mmUVD_DPG_LMA_MASK, mask); \
83 WREG32_SOC15(ip, inst_idx, mmUVD_DPG_LMA_CTL, \
84 UVD_DPG_LMA_CTL__MASK_EN_MASK | \
85 ((adev->reg_offset[ip##_HWIP][inst_idx][reg##_BASE_IDX] + reg) \
86 << UVD_DPG_LMA_CTL__READ_WRITE_ADDR__SHIFT) | \
87 (sram_sel << UVD_DPG_LMA_CTL__SRAM_SEL__SHIFT)); \
88 RREG32_SOC15(ip, inst_idx, mmUVD_DPG_LMA_DATA); \
91 #define WREG32_SOC15_DPG_MODE_1_0(ip, inst_idx, reg, value, mask, sram_sel) \
93 WREG32_SOC15(ip, inst_idx, mmUVD_DPG_LMA_DATA, value); \
94 WREG32_SOC15(ip, inst_idx, mmUVD_DPG_LMA_MASK, mask); \
95 WREG32_SOC15(ip, inst_idx, mmUVD_DPG_LMA_CTL, \
96 UVD_DPG_LMA_CTL__READ_WRITE_MASK | \
97 ((adev->reg_offset[ip##_HWIP][inst_idx][reg##_BASE_IDX] + reg) \
98 << UVD_DPG_LMA_CTL__READ_WRITE_ADDR__SHIFT) | \
99 (sram_sel << UVD_DPG_LMA_CTL__SRAM_SEL__SHIFT)); \
102 #define SOC15_DPG_MODE_OFFSET(ip, inst_idx, reg) \
104 uint32_t internal_reg_offset, addr; \
105 bool video_range, video1_range, aon_range, aon1_range; \
107 addr = (adev->reg_offset[ip##_HWIP][inst_idx][reg##_BASE_IDX] + reg); \
109 video_range = ((((0xFFFFF & addr) >= (VCN_VID_SOC_ADDRESS_2_0)) && \
110 ((0xFFFFF & addr) < ((VCN_VID_SOC_ADDRESS_2_0 + 0x2600))))); \
111 video1_range = ((((0xFFFFF & addr) >= (VCN1_VID_SOC_ADDRESS_3_0)) && \
112 ((0xFFFFF & addr) < ((VCN1_VID_SOC_ADDRESS_3_0 + 0x2600))))); \
113 aon_range = ((((0xFFFFF & addr) >= (VCN_AON_SOC_ADDRESS_2_0)) && \
114 ((0xFFFFF & addr) < ((VCN_AON_SOC_ADDRESS_2_0 + 0x600))))); \
115 aon1_range = ((((0xFFFFF & addr) >= (VCN1_AON_SOC_ADDRESS_3_0)) && \
116 ((0xFFFFF & addr) < ((VCN1_AON_SOC_ADDRESS_3_0 + 0x600))))); \
118 internal_reg_offset = ((0xFFFFF & addr) - (VCN_VID_SOC_ADDRESS_2_0) + \
119 (VCN_VID_IP_ADDRESS_2_0)); \
120 else if (aon_range) \
121 internal_reg_offset = ((0xFFFFF & addr) - (VCN_AON_SOC_ADDRESS_2_0) + \
122 (VCN_AON_IP_ADDRESS_2_0)); \
123 else if (video1_range) \
124 internal_reg_offset = ((0xFFFFF & addr) - (VCN1_VID_SOC_ADDRESS_3_0) + \
125 (VCN_VID_IP_ADDRESS_2_0)); \
126 else if (aon1_range) \
127 internal_reg_offset = ((0xFFFFF & addr) - (VCN1_AON_SOC_ADDRESS_3_0) + \
128 (VCN_AON_IP_ADDRESS_2_0)); \
130 internal_reg_offset = (0xFFFFF & addr); \
132 internal_reg_offset >>= 2; \
135 #define RREG32_SOC15_DPG_MODE(inst_idx, offset, mask_en) \
137 WREG32_SOC15(VCN, inst_idx, mmUVD_DPG_LMA_CTL, \
138 (0x0 << UVD_DPG_LMA_CTL__READ_WRITE__SHIFT | \
139 mask_en << UVD_DPG_LMA_CTL__MASK_EN__SHIFT | \
140 offset << UVD_DPG_LMA_CTL__READ_WRITE_ADDR__SHIFT)); \
141 RREG32_SOC15(VCN, inst_idx, mmUVD_DPG_LMA_DATA); \
144 #define WREG32_SOC15_DPG_MODE(inst_idx, offset, value, mask_en, indirect) \
147 WREG32_SOC15(VCN, GET_INST(VCN, inst_idx), \
148 mmUVD_DPG_LMA_DATA, value); \
150 VCN, GET_INST(VCN, inst_idx), \
152 (0x1 << UVD_DPG_LMA_CTL__READ_WRITE__SHIFT | \
153 mask_en << UVD_DPG_LMA_CTL__MASK_EN__SHIFT | \
154 offset << UVD_DPG_LMA_CTL__READ_WRITE_ADDR__SHIFT)); \
156 *adev->vcn.inst[inst_idx].dpg_sram_curr_addr++ = \
158 *adev->vcn.inst[inst_idx].dpg_sram_curr_addr++ = \
163 #define SOC24_DPG_MODE_OFFSET(ip, inst_idx, reg) \
165 uint32_t internal_reg_offset, addr; \
166 bool video_range, video1_range, aon_range, aon1_range; \
168 addr = (adev->reg_offset[ip##_HWIP][inst_idx][reg##_BASE_IDX] + reg); \
170 video_range = ((((0xFFFFF & addr) >= (VCN_VID_SOC_ADDRESS)) && \
171 ((0xFFFFF & addr) < ((VCN_VID_SOC_ADDRESS + 0x2600))))); \
172 video1_range = ((((0xFFFFF & addr) >= (VCN1_VID_SOC_ADDRESS)) && \
173 ((0xFFFFF & addr) < ((VCN1_VID_SOC_ADDRESS + 0x2600))))); \
174 aon_range = ((((0xFFFFF & addr) >= (VCN_AON_SOC_ADDRESS)) && \
175 ((0xFFFFF & addr) < ((VCN_AON_SOC_ADDRESS + 0x600))))); \
176 aon1_range = ((((0xFFFFF & addr) >= (VCN1_AON_SOC_ADDRESS)) && \
177 ((0xFFFFF & addr) < ((VCN1_AON_SOC_ADDRESS + 0x600))))); \
179 internal_reg_offset = ((0xFFFFF & addr) - (VCN_VID_SOC_ADDRESS) + \
180 (VCN_VID_IP_ADDRESS)); \
181 else if (aon_range) \
182 internal_reg_offset = ((0xFFFFF & addr) - (VCN_AON_SOC_ADDRESS) + \
183 (VCN_AON_IP_ADDRESS)); \
184 else if (video1_range) \
185 internal_reg_offset = ((0xFFFFF & addr) - (VCN1_VID_SOC_ADDRESS) + \
186 (VCN_VID_IP_ADDRESS)); \
187 else if (aon1_range) \
188 internal_reg_offset = ((0xFFFFF & addr) - (VCN1_AON_SOC_ADDRESS) + \
189 (VCN_AON_IP_ADDRESS)); \
191 internal_reg_offset = (0xFFFFF & addr); \
193 internal_reg_offset >>= 2; \
196 #define WREG32_SOC24_DPG_MODE(inst_idx, offset, value, mask_en, indirect) \
199 WREG32_SOC15(VCN, GET_INST(VCN, inst_idx), \
200 regUVD_DPG_LMA_DATA, value); \
202 VCN, GET_INST(VCN, inst_idx), \
203 regUVD_DPG_LMA_CTL, \
204 (0x1 << UVD_DPG_LMA_CTL__READ_WRITE__SHIFT | \
205 mask_en << UVD_DPG_LMA_CTL__MASK_EN__SHIFT | \
206 offset << UVD_DPG_LMA_CTL__READ_WRITE_ADDR__SHIFT)); \
208 *adev->vcn.inst[inst_idx].dpg_sram_curr_addr++ = \
210 *adev->vcn.inst[inst_idx].dpg_sram_curr_addr++ = \
215 #define AMDGPU_FW_SHARED_FLAG_0_UNIFIED_QUEUE (1 << 2)
216 #define AMDGPU_FW_SHARED_FLAG_0_DRM_KEY_INJECT (1 << 4)
217 #define AMDGPU_VCN_FW_SHARED_FLAG_0_RB (1 << 6)
218 #define AMDGPU_VCN_MULTI_QUEUE_FLAG (1 << 8)
219 #define AMDGPU_VCN_SW_RING_FLAG (1 << 9)
220 #define AMDGPU_VCN_FW_LOGGING_FLAG (1 << 10)
221 #define AMDGPU_VCN_SMU_VERSION_INFO_FLAG (1 << 11)
222 #define AMDGPU_VCN_SMU_DPM_INTERFACE_FLAG (1 << 11)
223 #define AMDGPU_VCN_VF_RB_SETUP_FLAG (1 << 14)
224 #define AMDGPU_VCN_VF_RB_DECOUPLE_FLAG (1 << 15)
226 #define MAX_NUM_VCN_RB_SETUP 4
228 #define AMDGPU_VCN_IB_FLAG_DECODE_BUFFER 0x00000001
229 #define AMDGPU_VCN_CMD_FLAG_MSG_BUFFER 0x00000001
231 #define VCN_CODEC_DISABLE_MASK_AV1 (1 << 0)
232 #define VCN_CODEC_DISABLE_MASK_VP9 (1 << 1)
233 #define VCN_CODEC_DISABLE_MASK_HEVC (1 << 2)
234 #define VCN_CODEC_DISABLE_MASK_H264 (1 << 3)
236 #define AMDGPU_VCN_SMU_DPM_INTERFACE_DGPU (0)
237 #define AMDGPU_VCN_SMU_DPM_INTERFACE_APU (1)
239 #define AMDGPU_DRM_KEY_INJECT_WORKAROUND_VCNFW_ASD_HANDSHAKING 2
242 FW_QUEUE_RING_RESET = 1,
243 FW_QUEUE_DPG_HOLD_OFF = 2,
246 enum engine_status_constants {
247 UVD_PGFSM_STATUS__UVDM_UVDU_PWR_ON = 0x2AAAA0,
248 UVD_PGFSM_STATUS__UVDM_UVDU_PWR_ON_2_0 = 0xAAAA0,
249 UVD_PGFSM_STATUS__UVDM_UVDU_UVDLM_PWR_ON_3_0 = 0x2A2A8AA0,
250 UVD_PGFSM_CONFIG__UVDM_UVDU_PWR_ON = 0x00000002,
251 UVD_STATUS__UVD_BUSY = 0x00000004,
252 GB_ADDR_CONFIG_DEFAULT = 0x26010011,
253 UVD_STATUS__IDLE = 0x2,
254 UVD_STATUS__BUSY = 0x5,
255 UVD_POWER_STATUS__UVD_POWER_STATUS_TILES_OFF = 0x1,
256 UVD_STATUS__RBC_BUSY = 0x1,
257 UVD_PGFSM_STATUS_UVDJ_PWR_ON = 0,
260 enum internal_dpg_state {
261 VCN_DPG_STATE__UNPAUSE = 0,
262 VCN_DPG_STATE__PAUSE,
265 struct dpg_pause_state {
266 enum internal_dpg_state fw_based;
267 enum internal_dpg_state jpeg;
270 struct amdgpu_vcn_reg{
278 unsigned ib_bar_high;
280 unsigned gp_scratch8;
284 struct amdgpu_vcn_fw_shared {
291 struct amdgpu_vcn_inst {
292 struct amdgpu_bo *vcpu_bo;
296 struct amdgpu_ring ring_dec;
297 struct amdgpu_ring ring_enc[AMDGPU_VCN_MAX_ENC_RINGS];
298 atomic_t sched_score;
299 struct amdgpu_irq_src irq;
300 struct amdgpu_irq_src ras_poison_irq;
301 struct amdgpu_vcn_reg external;
302 struct amdgpu_bo *dpg_sram_bo;
303 struct dpg_pause_state pause_state;
304 void *dpg_sram_cpu_addr;
305 uint64_t dpg_sram_gpu_addr;
306 uint32_t *dpg_sram_curr_addr;
307 atomic_t dpg_enc_submission_cnt;
308 struct amdgpu_vcn_fw_shared fw_shared;
310 const struct firmware *fw; /* VCN firmware */
312 uint32_t vcn_codec_disable_mask;
315 struct amdgpu_vcn_ras {
316 struct amdgpu_ras_block_object ras_block;
321 struct delayed_work idle_work;
322 unsigned num_enc_rings;
323 enum amd_powergating_state cur_state;
326 uint8_t num_vcn_inst;
327 struct amdgpu_vcn_inst inst[AMDGPU_MAX_VCN_INSTANCES];
328 struct amdgpu_vcn_reg internal;
329 struct mutex vcn_pg_lock;
330 struct mutex vcn1_jpeg1_workaround;
331 atomic_t total_submission_cnt;
333 unsigned harvest_config;
334 int (*pause_dpg_mode)(struct amdgpu_device *adev,
335 int inst_idx, struct dpg_pause_state *new_state);
337 struct ras_common_if *ras_if;
338 struct amdgpu_vcn_ras *ras;
341 uint8_t num_inst_per_aid;
342 bool using_unified_queue;
347 uint32_t supported_reset;
350 struct amdgpu_fw_shared_rb_ptrs_struct {
351 /* to WA DPG R/W ptr issues.*/
356 struct amdgpu_fw_shared_multi_queue {
357 uint8_t decode_queue_mode;
358 uint8_t encode_generalpurpose_queue_mode;
359 uint8_t encode_lowlatency_queue_mode;
360 uint8_t encode_realtime_queue_mode;
364 struct amdgpu_fw_shared_sw_ring {
369 struct amdgpu_fw_shared_unified_queue_struct {
372 uint8_t queue_status;
376 struct amdgpu_fw_shared_fw_logging {
383 struct amdgpu_fw_shared_smu_interface_info {
384 uint8_t smu_interface_type;
388 struct amdgpu_fw_shared {
389 uint32_t present_flag_0;
391 struct amdgpu_fw_shared_rb_ptrs_struct rb;
393 struct amdgpu_fw_shared_multi_queue multi_queue;
394 struct amdgpu_fw_shared_sw_ring sw_ring;
395 struct amdgpu_fw_shared_fw_logging fw_log;
396 struct amdgpu_fw_shared_smu_interface_info smu_interface_info;
399 struct amdgpu_vcn_rb_setup_info {
405 struct amdgpu_fw_shared_rb_setup {
406 uint32_t is_rb_enabled_flags;
413 uint32_t rb4_addr_lo;
414 uint32_t rb4_addr_hi;
416 uint32_t reserved[6];
420 struct amdgpu_vcn_rb_setup_info rb_info[MAX_NUM_VCN_RB_SETUP];
425 struct amdgpu_fw_shared_drm_key_wa {
430 struct amdgpu_fw_shared_queue_decouple {
435 struct amdgpu_vcn4_fw_shared {
436 uint32_t present_flag_0;
438 struct amdgpu_fw_shared_unified_queue_struct sq;
440 struct amdgpu_fw_shared_fw_logging fw_log;
442 struct amdgpu_fw_shared_rb_setup rb_setup;
443 struct amdgpu_fw_shared_smu_interface_info smu_dpm_interface;
444 struct amdgpu_fw_shared_drm_key_wa drm_key_wa;
446 struct amdgpu_fw_shared_queue_decouple decouple;
449 struct amdgpu_vcn_fwlog {
452 uint32_t buffer_size;
453 uint32_t header_size;
457 struct amdgpu_vcn_decode_buffer {
458 uint32_t valid_buf_flag;
459 uint32_t msg_buffer_address_hi;
460 uint32_t msg_buffer_address_lo;
464 struct amdgpu_vcn_rb_metadata {
466 uint32_t present_flag_0;
473 struct amdgpu_vcn5_fw_shared {
474 uint32_t present_flag_0;
476 struct amdgpu_fw_shared_unified_queue_struct sq;
478 struct amdgpu_fw_shared_fw_logging fw_log;
480 struct amdgpu_fw_shared_rb_setup rb_setup;
481 struct amdgpu_fw_shared_smu_interface_info smu_dpm_interface;
482 struct amdgpu_fw_shared_drm_key_wa drm_key_wa;
486 #define VCN_BLOCK_ENCODE_DISABLE_MASK 0x80
487 #define VCN_BLOCK_DECODE_DISABLE_MASK 0x40
488 #define VCN_BLOCK_QUEUE_DISABLE_MASK 0xC0
496 int amdgpu_vcn_early_init(struct amdgpu_device *adev);
497 int amdgpu_vcn_sw_init(struct amdgpu_device *adev);
498 int amdgpu_vcn_sw_fini(struct amdgpu_device *adev);
499 int amdgpu_vcn_suspend(struct amdgpu_device *adev);
500 int amdgpu_vcn_resume(struct amdgpu_device *adev);
501 void amdgpu_vcn_ring_begin_use(struct amdgpu_ring *ring);
502 void amdgpu_vcn_ring_end_use(struct amdgpu_ring *ring);
504 bool amdgpu_vcn_is_disabled_vcn(struct amdgpu_device *adev,
505 enum vcn_ring_type type, uint32_t vcn_instance);
507 int amdgpu_vcn_dec_ring_test_ring(struct amdgpu_ring *ring);
508 int amdgpu_vcn_dec_ring_test_ib(struct amdgpu_ring *ring, long timeout);
509 int amdgpu_vcn_dec_sw_ring_test_ring(struct amdgpu_ring *ring);
510 int amdgpu_vcn_dec_sw_ring_test_ib(struct amdgpu_ring *ring, long timeout);
511 int amdgpu_vcn_unified_ring_test_ib(struct amdgpu_ring *ring, long timeout);
513 int amdgpu_vcn_enc_ring_test_ring(struct amdgpu_ring *ring);
514 int amdgpu_vcn_enc_ring_test_ib(struct amdgpu_ring *ring, long timeout);
516 enum amdgpu_ring_priority_level amdgpu_vcn_get_enc_ring_prio(int ring);
518 void amdgpu_vcn_setup_ucode(struct amdgpu_device *adev);
520 void amdgpu_vcn_fwlog_init(struct amdgpu_vcn_inst *vcn);
521 void amdgpu_debugfs_vcn_fwlog_init(struct amdgpu_device *adev,
522 uint8_t i, struct amdgpu_vcn_inst *vcn);
524 int amdgpu_vcn_process_poison_irq(struct amdgpu_device *adev,
525 struct amdgpu_irq_src *source,
526 struct amdgpu_iv_entry *entry);
527 int amdgpu_vcn_ras_late_init(struct amdgpu_device *adev,
528 struct ras_common_if *ras_block);
529 int amdgpu_vcn_ras_sw_init(struct amdgpu_device *adev);
531 int amdgpu_vcn_psp_update_sram(struct amdgpu_device *adev, int inst_idx,
532 enum AMDGPU_UCODE_ID ucode_id);
533 int amdgpu_vcn_save_vcpu_bo(struct amdgpu_device *adev);
534 int amdgpu_vcn_sysfs_reset_mask_init(struct amdgpu_device *adev);
535 void amdgpu_vcn_sysfs_reset_mask_fini(struct amdgpu_device *adev);
536 void amdgpu_debugfs_vcn_sched_mask_init(struct amdgpu_device *adev);