xref: /linux/drivers/gpu/drm/amd/amdgpu/amdgpu_virt.h (revision 954ea91fb68b771dba6d87cfa61b68e09cc2497f)
1  /*
2   * Copyright 2016 Advanced Micro Devices, Inc.
3   *
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:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
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.
21   *
22   * Author: Monk.liu@amd.com
23   */
24  #ifndef AMDGPU_VIRT_H
25  #define AMDGPU_VIRT_H
26  
27  #include "amdgv_sriovmsg.h"
28  
29  #define AMDGPU_SRIOV_CAPS_SRIOV_VBIOS  (1 << 0) /* vBIOS is sr-iov ready */
30  #define AMDGPU_SRIOV_CAPS_ENABLE_IOV   (1 << 1) /* sr-iov is enabled on this GPU */
31  #define AMDGPU_SRIOV_CAPS_IS_VF        (1 << 2) /* this GPU is a virtual function */
32  #define AMDGPU_PASSTHROUGH_MODE        (1 << 3) /* thw whole GPU is pass through for VM */
33  #define AMDGPU_SRIOV_CAPS_RUNTIME      (1 << 4) /* is out of full access mode */
34  #define AMDGPU_VF_MMIO_ACCESS_PROTECT  (1 << 5) /* MMIO write access is not allowed in sriov runtime */
35  
36  /* flags for indirect register access path supported by rlcg for sriov */
37  #define AMDGPU_RLCG_GC_WRITE_LEGACY    (0x8 << 28)
38  #define AMDGPU_RLCG_GC_WRITE           (0x0 << 28)
39  #define AMDGPU_RLCG_GC_READ            (0x1 << 28)
40  #define AMDGPU_RLCG_MMHUB_WRITE        (0x2 << 28)
41  
42  /* error code for indirect register access path supported by rlcg for sriov */
43  #define AMDGPU_RLCG_VFGATE_DISABLED		0x4000000
44  #define AMDGPU_RLCG_WRONG_OPERATION_TYPE	0x2000000
45  #define AMDGPU_RLCG_REG_NOT_IN_RANGE		0x1000000
46  
47  #define AMDGPU_RLCG_SCRATCH1_ADDRESS_MASK	0xFFFFF
48  
49  /* all asic after AI use this offset */
50  #define mmRCC_IOV_FUNC_IDENTIFIER 0xDE5
51  /* tonga/fiji use this offset */
52  #define mmBIF_IOV_FUNC_IDENTIFIER 0x1503
53  
54  enum amdgpu_sriov_vf_mode {
55  	SRIOV_VF_MODE_BARE_METAL = 0,
56  	SRIOV_VF_MODE_ONE_VF,
57  	SRIOV_VF_MODE_MULTI_VF,
58  };
59  
60  struct amdgpu_mm_table {
61  	struct amdgpu_bo	*bo;
62  	uint32_t		*cpu_addr;
63  	uint64_t		gpu_addr;
64  };
65  
66  #define AMDGPU_VF_ERROR_ENTRY_SIZE    16
67  
68  /* struct error_entry - amdgpu VF error information. */
69  struct amdgpu_vf_error_buffer {
70  	struct mutex lock;
71  	int read_count;
72  	int write_count;
73  	uint16_t code[AMDGPU_VF_ERROR_ENTRY_SIZE];
74  	uint16_t flags[AMDGPU_VF_ERROR_ENTRY_SIZE];
75  	uint64_t data[AMDGPU_VF_ERROR_ENTRY_SIZE];
76  };
77  
78  enum idh_request;
79  
80  /**
81   * struct amdgpu_virt_ops - amdgpu device virt operations
82   */
83  struct amdgpu_virt_ops {
84  	int (*req_full_gpu)(struct amdgpu_device *adev, bool init);
85  	int (*rel_full_gpu)(struct amdgpu_device *adev, bool init);
86  	int (*req_init_data)(struct amdgpu_device *adev);
87  	int (*reset_gpu)(struct amdgpu_device *adev);
88  	int (*wait_reset)(struct amdgpu_device *adev);
89  	void (*trans_msg)(struct amdgpu_device *adev, enum idh_request req,
90  			  u32 data1, u32 data2, u32 data3);
91  	void (*ras_poison_handler)(struct amdgpu_device *adev);
92  };
93  
94  /*
95   * Firmware Reserve Frame buffer
96   */
97  struct amdgpu_virt_fw_reserve {
98  	struct amd_sriov_msg_pf2vf_info_header *p_pf2vf;
99  	struct amd_sriov_msg_vf2pf_info_header *p_vf2pf;
100  	unsigned int checksum_key;
101  };
102  
103  /*
104   * Legacy GIM header
105   *
106   * Defination between PF and VF
107   * Structures forcibly aligned to 4 to keep the same style as PF.
108   */
109  #define AMDGIM_DATAEXCHANGE_OFFSET		(64 * 1024)
110  
111  #define AMDGIM_GET_STRUCTURE_RESERVED_SIZE(total, u8, u16, u32, u64) \
112  		(total - (((u8)+3) / 4 + ((u16)+1) / 2 + (u32) + (u64)*2))
113  
114  enum AMDGIM_FEATURE_FLAG {
115  	/* GIM supports feature of Error log collecting */
116  	AMDGIM_FEATURE_ERROR_LOG_COLLECT = 0x1,
117  	/* GIM supports feature of loading uCodes */
118  	AMDGIM_FEATURE_GIM_LOAD_UCODES   = 0x2,
119  	/* VRAM LOST by GIM */
120  	AMDGIM_FEATURE_GIM_FLR_VRAMLOST = 0x4,
121  	/* MM bandwidth */
122  	AMDGIM_FEATURE_GIM_MM_BW_MGR = 0x8,
123  	/* PP ONE VF MODE in GIM */
124  	AMDGIM_FEATURE_PP_ONE_VF = (1 << 4),
125  	/* Indirect Reg Access enabled */
126  	AMDGIM_FEATURE_INDIRECT_REG_ACCESS = (1 << 5),
127  };
128  
129  enum AMDGIM_REG_ACCESS_FLAG {
130  	/* Use PSP to program IH_RB_CNTL */
131  	AMDGIM_FEATURE_IH_REG_PSP_EN     = (1 << 0),
132  	/* Use RLC to program MMHUB regs */
133  	AMDGIM_FEATURE_MMHUB_REG_RLC_EN  = (1 << 1),
134  	/* Use RLC to program GC regs */
135  	AMDGIM_FEATURE_GC_REG_RLC_EN     = (1 << 2),
136  };
137  
138  struct amdgim_pf2vf_info_v1 {
139  	/* header contains size and version */
140  	struct amd_sriov_msg_pf2vf_info_header header;
141  	/* max_width * max_height */
142  	unsigned int uvd_enc_max_pixels_count;
143  	/* 16x16 pixels/sec, codec independent */
144  	unsigned int uvd_enc_max_bandwidth;
145  	/* max_width * max_height */
146  	unsigned int vce_enc_max_pixels_count;
147  	/* 16x16 pixels/sec, codec independent */
148  	unsigned int vce_enc_max_bandwidth;
149  	/* MEC FW position in kb from the start of visible frame buffer */
150  	unsigned int mecfw_kboffset;
151  	/* The features flags of the GIM driver supports. */
152  	unsigned int feature_flags;
153  	/* use private key from mailbox 2 to create chueksum */
154  	unsigned int checksum;
155  } __aligned(4);
156  
157  struct amdgim_vf2pf_info_v1 {
158  	/* header contains size and version */
159  	struct amd_sriov_msg_vf2pf_info_header header;
160  	/* driver version */
161  	char driver_version[64];
162  	/* driver certification, 1=WHQL, 0=None */
163  	unsigned int driver_cert;
164  	/* guest OS type and version: need a define */
165  	unsigned int os_info;
166  	/* in the unit of 1M */
167  	unsigned int fb_usage;
168  	/* guest gfx engine usage percentage */
169  	unsigned int gfx_usage;
170  	/* guest gfx engine health percentage */
171  	unsigned int gfx_health;
172  	/* guest compute engine usage percentage */
173  	unsigned int compute_usage;
174  	/* guest compute engine health percentage */
175  	unsigned int compute_health;
176  	/* guest vce engine usage percentage. 0xffff means N/A. */
177  	unsigned int vce_enc_usage;
178  	/* guest vce engine health percentage. 0xffff means N/A. */
179  	unsigned int vce_enc_health;
180  	/* guest uvd engine usage percentage. 0xffff means N/A. */
181  	unsigned int uvd_enc_usage;
182  	/* guest uvd engine usage percentage. 0xffff means N/A. */
183  	unsigned int uvd_enc_health;
184  	unsigned int checksum;
185  } __aligned(4);
186  
187  struct amdgim_vf2pf_info_v2 {
188  	/* header contains size and version */
189  	struct amd_sriov_msg_vf2pf_info_header header;
190  	uint32_t checksum;
191  	/* driver version */
192  	uint8_t driver_version[64];
193  	/* driver certification, 1=WHQL, 0=None */
194  	uint32_t driver_cert;
195  	/* guest OS type and version: need a define */
196  	uint32_t os_info;
197  	/* in the unit of 1M */
198  	uint32_t fb_usage;
199  	/* guest gfx engine usage percentage */
200  	uint32_t gfx_usage;
201  	/* guest gfx engine health percentage */
202  	uint32_t gfx_health;
203  	/* guest compute engine usage percentage */
204  	uint32_t compute_usage;
205  	/* guest compute engine health percentage */
206  	uint32_t compute_health;
207  	/* guest vce engine usage percentage. 0xffff means N/A. */
208  	uint32_t vce_enc_usage;
209  	/* guest vce engine health percentage. 0xffff means N/A. */
210  	uint32_t vce_enc_health;
211  	/* guest uvd engine usage percentage. 0xffff means N/A. */
212  	uint32_t uvd_enc_usage;
213  	/* guest uvd engine usage percentage. 0xffff means N/A. */
214  	uint32_t uvd_enc_health;
215  	uint32_t reserved[AMDGIM_GET_STRUCTURE_RESERVED_SIZE(256, 64, 0, (12 + sizeof(struct amd_sriov_msg_vf2pf_info_header)/sizeof(uint32_t)), 0)];
216  } __aligned(4);
217  
218  struct amdgpu_virt_ras_err_handler_data {
219  	/* point to bad page records array */
220  	struct eeprom_table_record *bps;
221  	/* point to reserved bo array */
222  	struct amdgpu_bo **bps_bo;
223  	/* the count of entries */
224  	int count;
225  	/* last reserved entry's index + 1 */
226  	int last_reserved;
227  };
228  
229  /* GPU virtualization */
230  struct amdgpu_virt {
231  	uint32_t			caps;
232  	struct amdgpu_bo		*csa_obj;
233  	void				*csa_cpu_addr;
234  	bool chained_ib_support;
235  	uint32_t			reg_val_offs;
236  	struct amdgpu_irq_src		ack_irq;
237  	struct amdgpu_irq_src		rcv_irq;
238  	struct work_struct		flr_work;
239  	struct amdgpu_mm_table		mm_table;
240  	const struct amdgpu_virt_ops	*ops;
241  	struct amdgpu_vf_error_buffer	vf_errors;
242  	struct amdgpu_virt_fw_reserve	fw_reserve;
243  	uint32_t gim_feature;
244  	uint32_t reg_access_mode;
245  	int req_init_data_ver;
246  	bool tdr_debug;
247  	struct amdgpu_virt_ras_err_handler_data *virt_eh_data;
248  	bool ras_init_done;
249  	uint32_t reg_access;
250  
251  	/* vf2pf message */
252  	struct delayed_work vf2pf_work;
253  	uint32_t vf2pf_update_interval_ms;
254  
255  	/* multimedia bandwidth config */
256  	bool     is_mm_bw_enabled;
257  	uint32_t decode_max_dimension_pixels;
258  	uint32_t decode_max_frame_pixels;
259  	uint32_t encode_max_dimension_pixels;
260  	uint32_t encode_max_frame_pixels;
261  
262  	/* the ucode id to signal the autoload */
263  	uint32_t autoload_ucode_id;
264  };
265  
266  struct amdgpu_video_codec_info;
267  
268  #define amdgpu_sriov_enabled(adev) \
269  ((adev)->virt.caps & AMDGPU_SRIOV_CAPS_ENABLE_IOV)
270  
271  #define amdgpu_sriov_vf(adev) \
272  ((adev)->virt.caps & AMDGPU_SRIOV_CAPS_IS_VF)
273  
274  #define amdgpu_sriov_bios(adev) \
275  ((adev)->virt.caps & AMDGPU_SRIOV_CAPS_SRIOV_VBIOS)
276  
277  #define amdgpu_sriov_runtime(adev) \
278  ((adev)->virt.caps & AMDGPU_SRIOV_CAPS_RUNTIME)
279  
280  #define amdgpu_sriov_fullaccess(adev) \
281  (amdgpu_sriov_vf((adev)) && !amdgpu_sriov_runtime((adev)))
282  
283  #define amdgpu_sriov_reg_indirect_en(adev) \
284  (amdgpu_sriov_vf((adev)) && \
285  	((adev)->virt.gim_feature & (AMDGIM_FEATURE_INDIRECT_REG_ACCESS)))
286  
287  #define amdgpu_sriov_reg_indirect_ih(adev) \
288  (amdgpu_sriov_vf((adev)) && \
289  	((adev)->virt.reg_access & (AMDGIM_FEATURE_IH_REG_PSP_EN)))
290  
291  #define amdgpu_sriov_reg_indirect_mmhub(adev) \
292  (amdgpu_sriov_vf((adev)) && \
293  	((adev)->virt.reg_access & (AMDGIM_FEATURE_MMHUB_REG_RLC_EN)))
294  
295  #define amdgpu_sriov_reg_indirect_gc(adev) \
296  (amdgpu_sriov_vf((adev)) && \
297  	((adev)->virt.reg_access & (AMDGIM_FEATURE_GC_REG_RLC_EN)))
298  
299  #define amdgpu_sriov_rlcg_error_report_enabled(adev) \
300          (amdgpu_sriov_reg_indirect_mmhub(adev) || amdgpu_sriov_reg_indirect_gc(adev))
301  
302  #define amdgpu_passthrough(adev) \
303  ((adev)->virt.caps & AMDGPU_PASSTHROUGH_MODE)
304  
305  #define amdgpu_sriov_vf_mmio_access_protection(adev) \
306  ((adev)->virt.caps & AMDGPU_VF_MMIO_ACCESS_PROTECT)
307  
308  static inline bool is_virtual_machine(void)
309  {
310  #if defined(CONFIG_X86)
311  	return boot_cpu_has(X86_FEATURE_HYPERVISOR);
312  #elif defined(CONFIG_ARM64)
313  	return !is_kernel_in_hyp_mode();
314  #else
315  	return false;
316  #endif
317  }
318  
319  #define amdgpu_sriov_is_pp_one_vf(adev) \
320  	((adev)->virt.gim_feature & AMDGIM_FEATURE_PP_ONE_VF)
321  #define amdgpu_sriov_is_debug(adev) \
322  	((!amdgpu_in_reset(adev)) && adev->virt.tdr_debug)
323  #define amdgpu_sriov_is_normal(adev) \
324  	((!amdgpu_in_reset(adev)) && (!adev->virt.tdr_debug))
325  bool amdgpu_virt_mmio_blocked(struct amdgpu_device *adev);
326  void amdgpu_virt_init_setting(struct amdgpu_device *adev);
327  void amdgpu_virt_kiq_reg_write_reg_wait(struct amdgpu_device *adev,
328  					uint32_t reg0, uint32_t rreg1,
329  					uint32_t ref, uint32_t mask);
330  int amdgpu_virt_request_full_gpu(struct amdgpu_device *adev, bool init);
331  int amdgpu_virt_release_full_gpu(struct amdgpu_device *adev, bool init);
332  int amdgpu_virt_reset_gpu(struct amdgpu_device *adev);
333  void amdgpu_virt_request_init_data(struct amdgpu_device *adev);
334  int amdgpu_virt_wait_reset(struct amdgpu_device *adev);
335  int amdgpu_virt_alloc_mm_table(struct amdgpu_device *adev);
336  void amdgpu_virt_free_mm_table(struct amdgpu_device *adev);
337  void amdgpu_virt_release_ras_err_handler_data(struct amdgpu_device *adev);
338  void amdgpu_virt_init_data_exchange(struct amdgpu_device *adev);
339  void amdgpu_virt_exchange_data(struct amdgpu_device *adev);
340  void amdgpu_virt_fini_data_exchange(struct amdgpu_device *adev);
341  void amdgpu_detect_virtualization(struct amdgpu_device *adev);
342  
343  bool amdgpu_virt_can_access_debugfs(struct amdgpu_device *adev);
344  int amdgpu_virt_enable_access_debugfs(struct amdgpu_device *adev);
345  void amdgpu_virt_disable_access_debugfs(struct amdgpu_device *adev);
346  
347  enum amdgpu_sriov_vf_mode amdgpu_virt_get_sriov_vf_mode(struct amdgpu_device *adev);
348  
349  void amdgpu_virt_update_sriov_video_codec(struct amdgpu_device *adev,
350  			struct amdgpu_video_codec_info *encode, uint32_t encode_array_size,
351  			struct amdgpu_video_codec_info *decode, uint32_t decode_array_size);
352  void amdgpu_sriov_wreg(struct amdgpu_device *adev,
353  		       u32 offset, u32 value,
354  		       u32 acc_flags, u32 hwip);
355  u32 amdgpu_sriov_rreg(struct amdgpu_device *adev,
356  		      u32 offset, u32 acc_flags, u32 hwip);
357  bool amdgpu_virt_fw_load_skip_check(struct amdgpu_device *adev,
358  			uint32_t ucode_id);
359  #endif
360