Linux Audio

Check our new training course

Real-Time Linux with PREEMPT_RT training

Feb 18-20, 2025
Register
Loading...
Note: File does not exist in v3.1.
  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#define AMDGPU_SRIOV_CAPS_SRIOV_VBIOS  (1 << 0) /* vBIOS is sr-iov ready */
 28#define AMDGPU_SRIOV_CAPS_ENABLE_IOV   (1 << 1) /* sr-iov is enabled on this GPU */
 29#define AMDGPU_SRIOV_CAPS_IS_VF        (1 << 2) /* this GPU is a virtual function */
 30#define AMDGPU_PASSTHROUGH_MODE        (1 << 3) /* thw whole GPU is pass through for VM */
 31#define AMDGPU_SRIOV_CAPS_RUNTIME      (1 << 4) /* is out of full access mode */
 32
 33struct amdgpu_mm_table {
 34	struct amdgpu_bo	*bo;
 35	uint32_t		*cpu_addr;
 36	uint64_t		gpu_addr;
 37};
 38
 39#define AMDGPU_VF_ERROR_ENTRY_SIZE    16
 40
 41/* struct error_entry - amdgpu VF error information. */
 42struct amdgpu_vf_error_buffer {
 43	struct mutex lock;
 44	int read_count;
 45	int write_count;
 46	uint16_t code[AMDGPU_VF_ERROR_ENTRY_SIZE];
 47	uint16_t flags[AMDGPU_VF_ERROR_ENTRY_SIZE];
 48	uint64_t data[AMDGPU_VF_ERROR_ENTRY_SIZE];
 49};
 50
 51/**
 52 * struct amdgpu_virt_ops - amdgpu device virt operations
 53 */
 54struct amdgpu_virt_ops {
 55	int (*req_full_gpu)(struct amdgpu_device *adev, bool init);
 56	int (*rel_full_gpu)(struct amdgpu_device *adev, bool init);
 57	int (*reset_gpu)(struct amdgpu_device *adev);
 58	int (*wait_reset)(struct amdgpu_device *adev);
 59	void (*trans_msg)(struct amdgpu_device *adev, u32 req, u32 data1, u32 data2, u32 data3);
 60	int (*get_pp_clk)(struct amdgpu_device *adev, u32 type, char *buf);
 61	int (*force_dpm_level)(struct amdgpu_device *adev, u32 level);
 62};
 63
 64/*
 65 * Firmware Reserve Frame buffer
 66 */
 67struct amdgpu_virt_fw_reserve {
 68	struct amd_sriov_msg_pf2vf_info_header *p_pf2vf;
 69	struct amd_sriov_msg_vf2pf_info_header *p_vf2pf;
 70	unsigned int checksum_key;
 71};
 72/*
 73 * Defination between PF and VF
 74 * Structures forcibly aligned to 4 to keep the same style as PF.
 75 */
 76#define AMDGIM_DATAEXCHANGE_OFFSET		(64 * 1024)
 77
 78#define AMDGIM_GET_STRUCTURE_RESERVED_SIZE(total, u8, u16, u32, u64) \
 79		(total - (((u8)+3) / 4 + ((u16)+1) / 2 + (u32) + (u64)*2))
 80
 81enum AMDGIM_FEATURE_FLAG {
 82	/* GIM supports feature of Error log collecting */
 83	AMDGIM_FEATURE_ERROR_LOG_COLLECT = 0x1,
 84	/* GIM supports feature of loading uCodes */
 85	AMDGIM_FEATURE_GIM_LOAD_UCODES   = 0x2,
 86	/* VRAM LOST by GIM */
 87	AMDGIM_FEATURE_GIM_FLR_VRAMLOST = 0x4,
 88	/* HW PERF SIM in GIM */
 89	AMDGIM_FEATURE_HW_PERF_SIMULATION = (1 << 3),
 90};
 91
 92struct amd_sriov_msg_pf2vf_info_header {
 93	/* the total structure size in byte. */
 94	uint32_t size;
 95	/* version of this structure, written by the GIM */
 96	uint32_t version;
 97	/* reserved */
 98	uint32_t reserved[2];
 99} __aligned(4);
100struct  amdgim_pf2vf_info_v1 {
101	/* header contains size and version */
102	struct amd_sriov_msg_pf2vf_info_header header;
103	/* max_width * max_height */
104	unsigned int uvd_enc_max_pixels_count;
105	/* 16x16 pixels/sec, codec independent */
106	unsigned int uvd_enc_max_bandwidth;
107	/* max_width * max_height */
108	unsigned int vce_enc_max_pixels_count;
109	/* 16x16 pixels/sec, codec independent */
110	unsigned int vce_enc_max_bandwidth;
111	/* MEC FW position in kb from the start of visible frame buffer */
112	unsigned int mecfw_kboffset;
113	/* The features flags of the GIM driver supports. */
114	unsigned int feature_flags;
115	/* use private key from mailbox 2 to create chueksum */
116	unsigned int checksum;
117} __aligned(4);
118
119struct  amdgim_pf2vf_info_v2 {
120	/* header contains size and version */
121	struct amd_sriov_msg_pf2vf_info_header header;
122	/* use private key from mailbox 2 to create chueksum */
123	uint32_t checksum;
124	/* The features flags of the GIM driver supports. */
125	uint32_t feature_flags;
126	/* max_width * max_height */
127	uint32_t uvd_enc_max_pixels_count;
128	/* 16x16 pixels/sec, codec independent */
129	uint32_t uvd_enc_max_bandwidth;
130	/* max_width * max_height */
131	uint32_t vce_enc_max_pixels_count;
132	/* 16x16 pixels/sec, codec independent */
133	uint32_t vce_enc_max_bandwidth;
134	/* MEC FW position in kb from the start of VF visible frame buffer */
135	uint64_t mecfw_kboffset;
136	/* MEC FW size in KB */
137	uint32_t mecfw_ksize;
138	/* UVD FW position in kb from the start of VF visible frame buffer */
139	uint64_t uvdfw_kboffset;
140	/* UVD FW size in KB */
141	uint32_t uvdfw_ksize;
142	/* VCE FW position in kb from the start of VF visible frame buffer */
143	uint64_t vcefw_kboffset;
144	/* VCE FW size in KB */
145	uint32_t vcefw_ksize;
146	uint32_t reserved[AMDGIM_GET_STRUCTURE_RESERVED_SIZE(256, 0, 0, (9 + sizeof(struct amd_sriov_msg_pf2vf_info_header)/sizeof(uint32_t)), 3)];
147} __aligned(4);
148
149
150struct amd_sriov_msg_vf2pf_info_header {
151	/* the total structure size in byte. */
152	uint32_t size;
153	/*version of this structure, written by the guest */
154	uint32_t version;
155	/* reserved */
156	uint32_t reserved[2];
157} __aligned(4);
158
159struct amdgim_vf2pf_info_v1 {
160	/* header contains size and version */
161	struct amd_sriov_msg_vf2pf_info_header header;
162	/* driver version */
163	char driver_version[64];
164	/* driver certification, 1=WHQL, 0=None */
165	unsigned int driver_cert;
166	/* guest OS type and version: need a define */
167	unsigned int os_info;
168	/* in the unit of 1M */
169	unsigned int fb_usage;
170	/* guest gfx engine usage percentage */
171	unsigned int gfx_usage;
172	/* guest gfx engine health percentage */
173	unsigned int gfx_health;
174	/* guest compute engine usage percentage */
175	unsigned int compute_usage;
176	/* guest compute engine health percentage */
177	unsigned int compute_health;
178	/* guest vce engine usage percentage. 0xffff means N/A. */
179	unsigned int vce_enc_usage;
180	/* guest vce engine health percentage. 0xffff means N/A. */
181	unsigned int vce_enc_health;
182	/* guest uvd engine usage percentage. 0xffff means N/A. */
183	unsigned int uvd_enc_usage;
184	/* guest uvd engine usage percentage. 0xffff means N/A. */
185	unsigned int uvd_enc_health;
186	unsigned int checksum;
187} __aligned(4);
188
189struct amdgim_vf2pf_info_v2 {
190	/* header contains size and version */
191	struct amd_sriov_msg_vf2pf_info_header header;
192	uint32_t checksum;
193	/* driver version */
194	uint8_t driver_version[64];
195	/* driver certification, 1=WHQL, 0=None */
196	uint32_t driver_cert;
197	/* guest OS type and version: need a define */
198	uint32_t os_info;
199	/* in the unit of 1M */
200	uint32_t fb_usage;
201	/* guest gfx engine usage percentage */
202	uint32_t gfx_usage;
203	/* guest gfx engine health percentage */
204	uint32_t gfx_health;
205	/* guest compute engine usage percentage */
206	uint32_t compute_usage;
207	/* guest compute engine health percentage */
208	uint32_t compute_health;
209	/* guest vce engine usage percentage. 0xffff means N/A. */
210	uint32_t vce_enc_usage;
211	/* guest vce engine health percentage. 0xffff means N/A. */
212	uint32_t vce_enc_health;
213	/* guest uvd engine usage percentage. 0xffff means N/A. */
214	uint32_t uvd_enc_usage;
215	/* guest uvd engine usage percentage. 0xffff means N/A. */
216	uint32_t uvd_enc_health;
217	uint32_t reserved[AMDGIM_GET_STRUCTURE_RESERVED_SIZE(256, 64, 0, (12 + sizeof(struct amd_sriov_msg_vf2pf_info_header)/sizeof(uint32_t)), 0)];
218} __aligned(4);
219
220#define AMDGPU_FW_VRAM_VF2PF_VER 2
221typedef struct amdgim_vf2pf_info_v2 amdgim_vf2pf_info ;
222
223#define AMDGPU_FW_VRAM_VF2PF_WRITE(adev, field, val) \
224	do { \
225		((amdgim_vf2pf_info *)adev->virt.fw_reserve.p_vf2pf)->field = (val); \
226	} while (0)
227
228#define AMDGPU_FW_VRAM_VF2PF_READ(adev, field, val) \
229	do { \
230		(*val) = ((amdgim_vf2pf_info *)adev->virt.fw_reserve.p_vf2pf)->field; \
231	} while (0)
232
233#define AMDGPU_FW_VRAM_PF2VF_READ(adev, field, val) \
234	do { \
235		if (!adev->virt.fw_reserve.p_pf2vf) \
236			*(val) = 0; \
237		else { \
238			if (adev->virt.fw_reserve.p_pf2vf->version == 1) \
239				*(val) = ((struct amdgim_pf2vf_info_v1 *)adev->virt.fw_reserve.p_pf2vf)->field; \
240			if (adev->virt.fw_reserve.p_pf2vf->version == 2) \
241				*(val) = ((struct amdgim_pf2vf_info_v2 *)adev->virt.fw_reserve.p_pf2vf)->field; \
242		} \
243	} while (0)
244
245/* GPU virtualization */
246struct amdgpu_virt {
247	uint32_t			caps;
248	struct amdgpu_bo		*csa_obj;
249	void				*csa_cpu_addr;
250	bool chained_ib_support;
251	uint32_t			reg_val_offs;
252	struct amdgpu_irq_src		ack_irq;
253	struct amdgpu_irq_src		rcv_irq;
254	struct work_struct		flr_work;
255	struct amdgpu_mm_table		mm_table;
256	const struct amdgpu_virt_ops	*ops;
257	struct amdgpu_vf_error_buffer   vf_errors;
258	struct amdgpu_virt_fw_reserve	fw_reserve;
259	uint32_t gim_feature;
260	/* protect DPM events to GIM */
261	struct mutex                    dpm_mutex;
262	uint32_t reg_access_mode;
263};
264
265#define amdgpu_sriov_enabled(adev) \
266((adev)->virt.caps & AMDGPU_SRIOV_CAPS_ENABLE_IOV)
267
268#define amdgpu_sriov_vf(adev) \
269((adev)->virt.caps & AMDGPU_SRIOV_CAPS_IS_VF)
270
271#define amdgpu_sriov_bios(adev) \
272((adev)->virt.caps & AMDGPU_SRIOV_CAPS_SRIOV_VBIOS)
273
274#define amdgpu_sriov_runtime(adev) \
275((adev)->virt.caps & AMDGPU_SRIOV_CAPS_RUNTIME)
276
277#define amdgpu_passthrough(adev) \
278((adev)->virt.caps & AMDGPU_PASSTHROUGH_MODE)
279
280static inline bool is_virtual_machine(void)
281{
282#ifdef CONFIG_X86
283	return boot_cpu_has(X86_FEATURE_HYPERVISOR);
284#else
285	return false;
286#endif
287}
288
289#define amdgim_is_hwperf(adev) \
290	((adev)->virt.gim_feature & AMDGIM_FEATURE_HW_PERF_SIMULATION)
291
292bool amdgpu_virt_mmio_blocked(struct amdgpu_device *adev);
293void amdgpu_virt_init_setting(struct amdgpu_device *adev);
294uint32_t amdgpu_virt_kiq_rreg(struct amdgpu_device *adev, uint32_t reg);
295void amdgpu_virt_kiq_wreg(struct amdgpu_device *adev, uint32_t reg, uint32_t v);
296void amdgpu_virt_kiq_reg_write_reg_wait(struct amdgpu_device *adev,
297					uint32_t reg0, uint32_t rreg1,
298					uint32_t ref, uint32_t mask);
299int amdgpu_virt_request_full_gpu(struct amdgpu_device *adev, bool init);
300int amdgpu_virt_release_full_gpu(struct amdgpu_device *adev, bool init);
301int amdgpu_virt_reset_gpu(struct amdgpu_device *adev);
302int amdgpu_virt_wait_reset(struct amdgpu_device *adev);
303int amdgpu_virt_alloc_mm_table(struct amdgpu_device *adev);
304void amdgpu_virt_free_mm_table(struct amdgpu_device *adev);
305int amdgpu_virt_fw_reserve_get_checksum(void *obj, unsigned long obj_size,
306					unsigned int key,
307					unsigned int chksum);
308void amdgpu_virt_init_data_exchange(struct amdgpu_device *adev);
309uint32_t amdgpu_virt_get_sclk(struct amdgpu_device *adev, bool lowest);
310uint32_t amdgpu_virt_get_mclk(struct amdgpu_device *adev, bool lowest);
311#endif