Home | History | Annotate | Line # | Download | only in amdgpu
      1 /*	$NetBSD: amdgpu_virt.h,v 1.3 2021/12/19 10:59:01 riastradh Exp $	*/
      2 
      3 /*
      4  * Copyright 2016 Advanced Micro Devices, Inc.
      5  *
      6  * Permission is hereby granted, free of charge, to any person obtaining a
      7  * copy of this software and associated documentation files (the "Software"),
      8  * to deal in the Software without restriction, including without limitation
      9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
     10  * and/or sell copies of the Software, and to permit persons to whom the
     11  * Software is furnished to do so, subject to the following conditions:
     12  *
     13  * The above copyright notice and this permission notice shall be included in
     14  * all copies or substantial portions of the Software.
     15  *
     16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
     19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
     20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
     21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
     22  * OTHER DEALINGS IN THE SOFTWARE.
     23  *
     24  * Author: Monk.liu (at) amd.com
     25  */
     26 #ifndef AMDGPU_VIRT_H
     27 #define AMDGPU_VIRT_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 
     35 struct amdgpu_mm_table {
     36 	struct amdgpu_bo	*bo;
     37 	uint32_t		*cpu_addr;
     38 	uint64_t		gpu_addr;
     39 };
     40 
     41 #define AMDGPU_VF_ERROR_ENTRY_SIZE    16
     42 
     43 /* struct error_entry - amdgpu VF error information. */
     44 struct amdgpu_vf_error_buffer {
     45 	struct mutex lock;
     46 	int read_count;
     47 	int write_count;
     48 	uint16_t code[AMDGPU_VF_ERROR_ENTRY_SIZE];
     49 	uint16_t flags[AMDGPU_VF_ERROR_ENTRY_SIZE];
     50 	uint64_t data[AMDGPU_VF_ERROR_ENTRY_SIZE];
     51 };
     52 
     53 /**
     54  * struct amdgpu_virt_ops - amdgpu device virt operations
     55  */
     56 struct amdgpu_virt_ops {
     57 	int (*req_full_gpu)(struct amdgpu_device *adev, bool init);
     58 	int (*rel_full_gpu)(struct amdgpu_device *adev, bool init);
     59 	int (*reset_gpu)(struct amdgpu_device *adev);
     60 	int (*wait_reset)(struct amdgpu_device *adev);
     61 	void (*trans_msg)(struct amdgpu_device *adev, u32 req, u32 data1, u32 data2, u32 data3);
     62 };
     63 
     64 /*
     65  * Firmware Reserve Frame buffer
     66  */
     67 struct 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 
     81 enum 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 	/* PP ONE VF MODE in GIM */
     89 	AMDGIM_FEATURE_PP_ONE_VF = (1 << 4),
     90 };
     91 
     92 struct 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);
    100 struct  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 
    119 struct  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 
    150 struct 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 
    159 struct 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 
    189 struct 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
    221 typedef 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 */
    246 struct 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 	uint32_t reg_access_mode;
    261 };
    262 
    263 #define amdgpu_sriov_enabled(adev) \
    264 ((adev)->virt.caps & AMDGPU_SRIOV_CAPS_ENABLE_IOV)
    265 
    266 #define amdgpu_sriov_vf(adev) \
    267 ((adev)->virt.caps & AMDGPU_SRIOV_CAPS_IS_VF)
    268 
    269 #define amdgpu_sriov_bios(adev) \
    270 ((adev)->virt.caps & AMDGPU_SRIOV_CAPS_SRIOV_VBIOS)
    271 
    272 #define amdgpu_sriov_runtime(adev) \
    273 ((adev)->virt.caps & AMDGPU_SRIOV_CAPS_RUNTIME)
    274 
    275 #define amdgpu_passthrough(adev) \
    276 ((adev)->virt.caps & AMDGPU_PASSTHROUGH_MODE)
    277 
    278 static inline bool is_virtual_machine(void)
    279 {
    280 #ifdef CONFIG_X86
    281 #ifdef __NetBSD__
    282 	return false;		/* XXX */
    283 #else
    284 	return boot_cpu_has(X86_FEATURE_HYPERVISOR);
    285 #endif
    286 #else
    287 	return false;
    288 #endif
    289 }
    290 
    291 #define amdgpu_sriov_is_pp_one_vf(adev) \
    292 	((adev)->virt.gim_feature & AMDGIM_FEATURE_PP_ONE_VF)
    293 
    294 bool amdgpu_virt_mmio_blocked(struct amdgpu_device *adev);
    295 void amdgpu_virt_init_setting(struct amdgpu_device *adev);
    296 void 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);
    299 int amdgpu_virt_request_full_gpu(struct amdgpu_device *adev, bool init);
    300 int amdgpu_virt_release_full_gpu(struct amdgpu_device *adev, bool init);
    301 int amdgpu_virt_reset_gpu(struct amdgpu_device *adev);
    302 int amdgpu_virt_wait_reset(struct amdgpu_device *adev);
    303 int amdgpu_virt_alloc_mm_table(struct amdgpu_device *adev);
    304 void amdgpu_virt_free_mm_table(struct amdgpu_device *adev);
    305 int amdgpu_virt_fw_reserve_get_checksum(void *obj, unsigned long obj_size,
    306 					unsigned int key,
    307 					unsigned int chksum);
    308 void amdgpu_virt_init_data_exchange(struct amdgpu_device *adev);
    309 #endif
    310