xref: /linux/drivers/gpu/drm/xe/instructions/xe_mi_commands.h (revision 53597deca0e38c30e6cd4ba2114fa42d2bcd85bb)
1 /* SPDX-License-Identifier: MIT */
2 /*
3  * Copyright © 2023 Intel Corporation
4  */
5 
6 #ifndef _XE_MI_COMMANDS_H_
7 #define _XE_MI_COMMANDS_H_
8 
9 #include "instructions/xe_instr_defs.h"
10 
11 /*
12  * MI (Memory Interface) commands are supported by all GT engines.  They
13  * provide general memory operations and command streamer control.  MI commands
14  * have a command type of 0x0 (MI_COMMAND) in bits 31:29 of the instruction
15  * header dword and a specific MI opcode in bits 28:23.
16  */
17 
18 #define MI_OPCODE			REG_GENMASK(28, 23)
19 #define MI_SUBOPCODE			REG_GENMASK(22, 17)  /* used with MI_EXPANSION */
20 
21 #define __MI_INSTR(opcode) \
22 	(XE_INSTR_MI | REG_FIELD_PREP(MI_OPCODE, opcode))
23 
24 #define MI_NOOP				__MI_INSTR(0x0)
25 #define MI_USER_INTERRUPT		__MI_INSTR(0x2)
26 #define MI_ARB_CHECK			__MI_INSTR(0x5)
27 
28 #define MI_ARB_ON_OFF			__MI_INSTR(0x8)
29 #define   MI_ARB_ENABLE			REG_BIT(0)
30 #define   MI_ARB_DISABLE		0x0
31 
32 #define MI_BATCH_BUFFER_END		__MI_INSTR(0xA)
33 #define MI_TOPOLOGY_FILTER		__MI_INSTR(0xD)
34 #define MI_FORCE_WAKEUP			__MI_INSTR(0x1D)
35 #define MI_MATH(n)			(__MI_INSTR(0x1A) | XE_INSTR_NUM_DW((n) + 1))
36 
37 #define MI_SEMAPHORE_WAIT		(__MI_INSTR(0x1c) | XE_INSTR_NUM_DW(5))
38 #define   MI_SEMW_GGTT			REG_BIT(22)
39 #define   MI_SEMW_POLL			REG_BIT(15)
40 #define   MI_SEMW_COMPARE_OP_MASK	REG_GENMASK(14, 12)
41 #define     COMPARE_OP_SAD_GT_SDD	0
42 #define     COMPARE_OP_SAD_GTE_SDD	1
43 #define     COMPARE_OP_SAD_LT_SDD	2
44 #define     COMPARE_OP_SAD_LTE_SDD	3
45 #define     COMPARE_OP_SAD_EQ_SDD	4
46 #define     COMPARE_OP_SAD_NEQ_SDD	5
47 #define   MI_SEMW_COMPARE(OP)		REG_FIELD_PREP(MI_SEMW_COMPARE_OP_MASK, COMPARE_OP_##OP)
48 #define   MI_SEMW_TOKEN(token)		REG_FIELD_PREP(REG_GENMASK(9, 2), (token))
49 
50 #define MI_STORE_DATA_IMM		__MI_INSTR(0x20)
51 #define   MI_SDI_GGTT			REG_BIT(22)
52 #define   MI_SDI_LEN_DW			GENMASK(9, 0)
53 #define   MI_SDI_NUM_DW(x)		REG_FIELD_PREP(MI_SDI_LEN_DW, (x) + 3 - 2)
54 #define   MI_SDI_NUM_QW(x)		(REG_FIELD_PREP(MI_SDI_LEN_DW, 2 * (x) + 3 - 2) | \
55 					 REG_BIT(21))
56 
57 #define MI_LOAD_REGISTER_IMM		__MI_INSTR(0x22)
58 #define   MI_LRI_LRM_CS_MMIO		REG_BIT(19)
59 #define   MI_LRI_MMIO_REMAP_EN		REG_BIT(17)
60 #define   MI_LRI_NUM_REGS(x)		XE_INSTR_NUM_DW(2 * (x) + 1)
61 #define   MI_LRI_FORCE_POSTED		REG_BIT(12)
62 #define   MI_LRI_LEN(x)			(((x) & 0xff) + 1)
63 
64 #define MI_STORE_REGISTER_MEM		(__MI_INSTR(0x24) | XE_INSTR_NUM_DW(4))
65 #define   MI_SRM_USE_GGTT		REG_BIT(22)
66 #define   MI_SRM_ADD_CS_OFFSET		REG_BIT(19)
67 
68 #define MI_FLUSH_DW			__MI_INSTR(0x26)
69 #define   MI_FLUSH_DW_PROTECTED_MEM_EN	REG_BIT(22)
70 #define   MI_FLUSH_DW_STORE_INDEX	REG_BIT(21)
71 #define   MI_INVALIDATE_TLB		REG_BIT(18)
72 #define   MI_FLUSH_DW_CCS		REG_BIT(16)
73 #define   MI_FLUSH_DW_OP_STOREDW	REG_BIT(14)
74 #define   MI_FLUSH_DW_LEN_DW		REG_GENMASK(5, 0)
75 #define   MI_FLUSH_IMM_DW		REG_FIELD_PREP(MI_FLUSH_DW_LEN_DW, 4 - 2)
76 #define   MI_FLUSH_IMM_QW		REG_FIELD_PREP(MI_FLUSH_DW_LEN_DW, 5 - 2)
77 #define   MI_FLUSH_DW_USE_GTT		REG_BIT(2)
78 
79 #define MI_LOAD_REGISTER_MEM		(__MI_INSTR(0x29) | XE_INSTR_NUM_DW(4))
80 #define   MI_LRM_USE_GGTT		REG_BIT(22)
81 #define   MI_LRM_ASYNC			REG_BIT(21)
82 
83 #define MI_LOAD_REGISTER_REG		(__MI_INSTR(0x2a) | XE_INSTR_NUM_DW(3))
84 #define   MI_LRR_DST_CS_MMIO		REG_BIT(19)
85 #define   MI_LRR_SRC_CS_MMIO		REG_BIT(18)
86 
87 #define MI_COPY_MEM_MEM			(__MI_INSTR(0x2e) | XE_INSTR_NUM_DW(5))
88 #define   MI_COPY_MEM_MEM_SRC_GGTT	REG_BIT(22)
89 #define   MI_COPY_MEM_MEM_DST_GGTT	REG_BIT(21)
90 
91 #define MI_BATCH_BUFFER_START		__MI_INSTR(0x31)
92 
93 #define MI_SET_APPID			__MI_INSTR(0x0e)
94 #define MI_SET_APPID_SESSION_ID_MASK	REG_GENMASK(6, 0)
95 #define MI_SET_APPID_SESSION_ID(x)	REG_FIELD_PREP(MI_SET_APPID_SESSION_ID_MASK, x)
96 
97 #define MI_SEMAPHORE_WAIT_TOKEN		(__MI_INSTR(0x1c) | XE_INSTR_NUM_DW(5)) /* XeLP+ */
98 #define   MI_SEMAPHORE_REGISTER_POLL	REG_BIT(16)
99 #define   MI_SEMAPHORE_POLL		REG_BIT(15)
100 #define   MI_SEMAPHORE_CMP_OP_MASK	REG_GENMASK(14, 12)
101 #define   MI_SEMAPHORE_SAD_EQ_SDD	REG_FIELD_PREP(MI_SEMAPHORE_CMP_OP_MASK, 4)
102 
103 #endif
104