17dcf36dcSFrançois Tigeot /* 27dcf36dcSFrançois Tigeot * Copyright 2014 Advanced Micro Devices, Inc. 37dcf36dcSFrançois Tigeot * 47dcf36dcSFrançois Tigeot * Permission is hereby granted, free of charge, to any person obtaining a 57dcf36dcSFrançois Tigeot * copy of this software and associated documentation files (the "Software"), 67dcf36dcSFrançois Tigeot * to deal in the Software without restriction, including without limitation 77dcf36dcSFrançois Tigeot * the rights to use, copy, modify, merge, publish, distribute, sublicense, 87dcf36dcSFrançois Tigeot * and/or sell copies of the Software, and to permit persons to whom the 97dcf36dcSFrançois Tigeot * Software is furnished to do so, subject to the following conditions: 107dcf36dcSFrançois Tigeot * 117dcf36dcSFrançois Tigeot * The above copyright notice and this permission notice shall be included in 127dcf36dcSFrançois Tigeot * all copies or substantial portions of the Software. 137dcf36dcSFrançois Tigeot * 147dcf36dcSFrançois Tigeot * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 157dcf36dcSFrançois Tigeot * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 167dcf36dcSFrançois Tigeot * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 177dcf36dcSFrançois Tigeot * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 187dcf36dcSFrançois Tigeot * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 197dcf36dcSFrançois Tigeot * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 207dcf36dcSFrançois Tigeot * OTHER DEALINGS IN THE SOFTWARE. 217dcf36dcSFrançois Tigeot */ 227dcf36dcSFrançois Tigeot 237dcf36dcSFrançois Tigeot /* 247dcf36dcSFrançois Tigeot * This file defines the private interface between the 257dcf36dcSFrançois Tigeot * AMD kernel graphics drivers and the AMD KFD. 267dcf36dcSFrançois Tigeot */ 277dcf36dcSFrançois Tigeot 287dcf36dcSFrançois Tigeot #ifndef KGD_KFD_INTERFACE_H_INCLUDED 297dcf36dcSFrançois Tigeot #define KGD_KFD_INTERFACE_H_INCLUDED 307dcf36dcSFrançois Tigeot 317dcf36dcSFrançois Tigeot #include <linux/types.h> 327dcf36dcSFrançois Tigeot 337dcf36dcSFrançois Tigeot struct pci_dev; 347dcf36dcSFrançois Tigeot 357dcf36dcSFrançois Tigeot #define KFD_INTERFACE_VERSION 1 367dcf36dcSFrançois Tigeot 377dcf36dcSFrançois Tigeot struct kfd_dev; 387dcf36dcSFrançois Tigeot struct kgd_dev; 397dcf36dcSFrançois Tigeot 407dcf36dcSFrançois Tigeot struct kgd_mem; 417dcf36dcSFrançois Tigeot 427dcf36dcSFrançois Tigeot enum kgd_memory_pool { 437dcf36dcSFrançois Tigeot KGD_POOL_SYSTEM_CACHEABLE = 1, 447dcf36dcSFrançois Tigeot KGD_POOL_SYSTEM_WRITECOMBINE = 2, 457dcf36dcSFrançois Tigeot KGD_POOL_FRAMEBUFFER = 3, 467dcf36dcSFrançois Tigeot }; 477dcf36dcSFrançois Tigeot 487dcf36dcSFrançois Tigeot enum kgd_engine_type { 497dcf36dcSFrançois Tigeot KGD_ENGINE_PFP = 1, 507dcf36dcSFrançois Tigeot KGD_ENGINE_ME, 517dcf36dcSFrançois Tigeot KGD_ENGINE_CE, 527dcf36dcSFrançois Tigeot KGD_ENGINE_MEC1, 537dcf36dcSFrançois Tigeot KGD_ENGINE_MEC2, 547dcf36dcSFrançois Tigeot KGD_ENGINE_RLC, 55c59a5c48SFrançois Tigeot KGD_ENGINE_SDMA1, 56c59a5c48SFrançois Tigeot KGD_ENGINE_SDMA2, 577dcf36dcSFrançois Tigeot KGD_ENGINE_MAX 587dcf36dcSFrançois Tigeot }; 597dcf36dcSFrançois Tigeot 607dcf36dcSFrançois Tigeot struct kgd2kfd_shared_resources { 617dcf36dcSFrançois Tigeot /* Bit n == 1 means VMID n is available for KFD. */ 627dcf36dcSFrançois Tigeot unsigned int compute_vmid_bitmap; 637dcf36dcSFrançois Tigeot 647dcf36dcSFrançois Tigeot /* Compute pipes are counted starting from MEC0/pipe0 as 0. */ 657dcf36dcSFrançois Tigeot unsigned int first_compute_pipe; 667dcf36dcSFrançois Tigeot 677dcf36dcSFrançois Tigeot /* Number of MEC pipes available for KFD. */ 687dcf36dcSFrançois Tigeot unsigned int compute_pipe_count; 697dcf36dcSFrançois Tigeot 707dcf36dcSFrançois Tigeot /* Base address of doorbell aperture. */ 717dcf36dcSFrançois Tigeot phys_addr_t doorbell_physical_address; 727dcf36dcSFrançois Tigeot 737dcf36dcSFrançois Tigeot /* Size in bytes of doorbell aperture. */ 747dcf36dcSFrançois Tigeot size_t doorbell_aperture_size; 757dcf36dcSFrançois Tigeot 767dcf36dcSFrançois Tigeot /* Number of bytes at start of aperture reserved for KGD. */ 777dcf36dcSFrançois Tigeot size_t doorbell_start_offset; 787dcf36dcSFrançois Tigeot }; 797dcf36dcSFrançois Tigeot 807dcf36dcSFrançois Tigeot /** 81c59a5c48SFrançois Tigeot * struct kfd2kgd_calls 82c59a5c48SFrançois Tigeot * 83c59a5c48SFrançois Tigeot * @init_gtt_mem_allocation: Allocate a buffer on the gart aperture. 84c59a5c48SFrançois Tigeot * The buffer can be used for mqds, hpds, kernel queue, fence and runlists 85c59a5c48SFrançois Tigeot * 86c59a5c48SFrançois Tigeot * @free_gtt_mem: Frees a buffer that was allocated on the gart aperture 87c59a5c48SFrançois Tigeot * 88c59a5c48SFrançois Tigeot * @get_vmem_size: Retrieves (physical) size of VRAM 89c59a5c48SFrançois Tigeot * 90c59a5c48SFrançois Tigeot * @get_gpu_clock_counter: Retrieves GPU clock counter 91c59a5c48SFrançois Tigeot * 92c59a5c48SFrançois Tigeot * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz 93c59a5c48SFrançois Tigeot * 94c59a5c48SFrançois Tigeot * @program_sh_mem_settings: A function that should initiate the memory 95c59a5c48SFrançois Tigeot * properties such as main aperture memory type (cache / non cached) and 96c59a5c48SFrançois Tigeot * secondary aperture base address, size and memory type. 97c59a5c48SFrançois Tigeot * This function is used only for no cp scheduling mode. 98c59a5c48SFrançois Tigeot * 99c59a5c48SFrançois Tigeot * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp 100c59a5c48SFrançois Tigeot * scheduling mode. Only used for no cp scheduling mode. 101c59a5c48SFrançois Tigeot * 102c59a5c48SFrançois Tigeot * @init_pipeline: Initialized the compute pipelines. 103c59a5c48SFrançois Tigeot * 104c59a5c48SFrançois Tigeot * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp 105c59a5c48SFrançois Tigeot * sceduling mode. 106c59a5c48SFrançois Tigeot * 107c59a5c48SFrançois Tigeot * @hqd_sdma_load: Loads the SDMA mqd structure to a H/W SDMA hqd slot. 108c59a5c48SFrançois Tigeot * used only for no HWS mode. 109c59a5c48SFrançois Tigeot * 110c59a5c48SFrançois Tigeot * @hqd_is_occupies: Checks if a hqd slot is occupied. 111c59a5c48SFrançois Tigeot * 112c59a5c48SFrançois Tigeot * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot. 113c59a5c48SFrançois Tigeot * 114c59a5c48SFrançois Tigeot * @hqd_sdma_is_occupied: Checks if an SDMA hqd slot is occupied. 115c59a5c48SFrançois Tigeot * 116c59a5c48SFrançois Tigeot * @hqd_sdma_destroy: Destructs and preempts the SDMA queue assigned to that 117c59a5c48SFrançois Tigeot * SDMA hqd slot. 118c59a5c48SFrançois Tigeot * 119c59a5c48SFrançois Tigeot * @get_fw_version: Returns FW versions from the header 120c59a5c48SFrançois Tigeot * 121c59a5c48SFrançois Tigeot * This structure contains function pointers to services that the kgd driver 122c59a5c48SFrançois Tigeot * provides to amdkfd driver. 123c59a5c48SFrançois Tigeot * 124c59a5c48SFrançois Tigeot */ 125c59a5c48SFrançois Tigeot struct kfd2kgd_calls { 126c59a5c48SFrançois Tigeot int (*init_gtt_mem_allocation)(struct kgd_dev *kgd, size_t size, 127c59a5c48SFrançois Tigeot void **mem_obj, uint64_t *gpu_addr, 128c59a5c48SFrançois Tigeot void **cpu_ptr); 129c59a5c48SFrançois Tigeot 130c59a5c48SFrançois Tigeot void (*free_gtt_mem)(struct kgd_dev *kgd, void *mem_obj); 131c59a5c48SFrançois Tigeot 132c59a5c48SFrançois Tigeot uint64_t (*get_vmem_size)(struct kgd_dev *kgd); 133c59a5c48SFrançois Tigeot uint64_t (*get_gpu_clock_counter)(struct kgd_dev *kgd); 134c59a5c48SFrançois Tigeot 135c59a5c48SFrançois Tigeot uint32_t (*get_max_engine_clock_in_mhz)(struct kgd_dev *kgd); 136c59a5c48SFrançois Tigeot 137c59a5c48SFrançois Tigeot /* Register access functions */ 138c59a5c48SFrançois Tigeot void (*program_sh_mem_settings)(struct kgd_dev *kgd, uint32_t vmid, 139c59a5c48SFrançois Tigeot uint32_t sh_mem_config, uint32_t sh_mem_ape1_base, 140c59a5c48SFrançois Tigeot uint32_t sh_mem_ape1_limit, uint32_t sh_mem_bases); 141c59a5c48SFrançois Tigeot 142c59a5c48SFrançois Tigeot int (*set_pasid_vmid_mapping)(struct kgd_dev *kgd, unsigned int pasid, 143c59a5c48SFrançois Tigeot unsigned int vmid); 144c59a5c48SFrançois Tigeot 145c59a5c48SFrançois Tigeot int (*init_pipeline)(struct kgd_dev *kgd, uint32_t pipe_id, 146c59a5c48SFrançois Tigeot uint32_t hpd_size, uint64_t hpd_gpu_addr); 147c59a5c48SFrançois Tigeot 148c59a5c48SFrançois Tigeot int (*init_interrupts)(struct kgd_dev *kgd, uint32_t pipe_id); 149c59a5c48SFrançois Tigeot 150c59a5c48SFrançois Tigeot int (*hqd_load)(struct kgd_dev *kgd, void *mqd, uint32_t pipe_id, 151c59a5c48SFrançois Tigeot uint32_t queue_id, uint32_t __user *wptr); 152c59a5c48SFrançois Tigeot 153c59a5c48SFrançois Tigeot int (*hqd_sdma_load)(struct kgd_dev *kgd, void *mqd); 154c59a5c48SFrançois Tigeot 155c59a5c48SFrançois Tigeot bool (*hqd_is_occupied)(struct kgd_dev *kgd, uint64_t queue_address, 156c59a5c48SFrançois Tigeot uint32_t pipe_id, uint32_t queue_id); 157c59a5c48SFrançois Tigeot 158c59a5c48SFrançois Tigeot int (*hqd_destroy)(struct kgd_dev *kgd, uint32_t reset_type, 159c59a5c48SFrançois Tigeot unsigned int timeout, uint32_t pipe_id, 160c59a5c48SFrançois Tigeot uint32_t queue_id); 161c59a5c48SFrançois Tigeot 162c59a5c48SFrançois Tigeot bool (*hqd_sdma_is_occupied)(struct kgd_dev *kgd, void *mqd); 163c59a5c48SFrançois Tigeot 164c59a5c48SFrançois Tigeot int (*hqd_sdma_destroy)(struct kgd_dev *kgd, void *mqd, 165c59a5c48SFrançois Tigeot unsigned int timeout); 166c59a5c48SFrançois Tigeot 167c59a5c48SFrançois Tigeot int (*address_watch_disable)(struct kgd_dev *kgd); 168c59a5c48SFrançois Tigeot int (*address_watch_execute)(struct kgd_dev *kgd, 169c59a5c48SFrançois Tigeot unsigned int watch_point_id, 170c59a5c48SFrançois Tigeot uint32_t cntl_val, 171c59a5c48SFrançois Tigeot uint32_t addr_hi, 172c59a5c48SFrançois Tigeot uint32_t addr_lo); 173c59a5c48SFrançois Tigeot int (*wave_control_execute)(struct kgd_dev *kgd, 174c59a5c48SFrançois Tigeot uint32_t gfx_index_val, 175c59a5c48SFrançois Tigeot uint32_t sq_cmd); 176c59a5c48SFrançois Tigeot uint32_t (*address_watch_get_offset)(struct kgd_dev *kgd, 177c59a5c48SFrançois Tigeot unsigned int watch_point_id, 178c59a5c48SFrançois Tigeot unsigned int reg_offset); 179c59a5c48SFrançois Tigeot bool (*get_atc_vmid_pasid_mapping_valid)( 180c59a5c48SFrançois Tigeot struct kgd_dev *kgd, 181c59a5c48SFrançois Tigeot uint8_t vmid); 182c59a5c48SFrançois Tigeot uint16_t (*get_atc_vmid_pasid_mapping_pasid)( 183c59a5c48SFrançois Tigeot struct kgd_dev *kgd, 184c59a5c48SFrançois Tigeot uint8_t vmid); 185c59a5c48SFrançois Tigeot void (*write_vmid_invalidate_request)(struct kgd_dev *kgd, 186c59a5c48SFrançois Tigeot uint8_t vmid); 187c59a5c48SFrançois Tigeot 188c59a5c48SFrançois Tigeot uint16_t (*get_fw_version)(struct kgd_dev *kgd, 189c59a5c48SFrançois Tigeot enum kgd_engine_type type); 190c59a5c48SFrançois Tigeot }; 191c59a5c48SFrançois Tigeot 192c59a5c48SFrançois Tigeot /** 1937dcf36dcSFrançois Tigeot * struct kgd2kfd_calls 1947dcf36dcSFrançois Tigeot * 1957dcf36dcSFrançois Tigeot * @exit: Notifies amdkfd that kgd module is unloaded 1967dcf36dcSFrançois Tigeot * 1977dcf36dcSFrançois Tigeot * @probe: Notifies amdkfd about a probe done on a device in the kgd driver. 1987dcf36dcSFrançois Tigeot * 1997dcf36dcSFrançois Tigeot * @device_init: Initialize the newly probed device (if it is a device that 2007dcf36dcSFrançois Tigeot * amdkfd supports) 2017dcf36dcSFrançois Tigeot * 2027dcf36dcSFrançois Tigeot * @device_exit: Notifies amdkfd about a removal of a kgd device 2037dcf36dcSFrançois Tigeot * 2047dcf36dcSFrançois Tigeot * @suspend: Notifies amdkfd about a suspend action done to a kgd device 2057dcf36dcSFrançois Tigeot * 2067dcf36dcSFrançois Tigeot * @resume: Notifies amdkfd about a resume action done to a kgd device 2077dcf36dcSFrançois Tigeot * 2087dcf36dcSFrançois Tigeot * This structure contains function callback pointers so the kgd driver 2097dcf36dcSFrançois Tigeot * will notify to the amdkfd about certain status changes. 2107dcf36dcSFrançois Tigeot * 2117dcf36dcSFrançois Tigeot */ 2127dcf36dcSFrançois Tigeot struct kgd2kfd_calls { 2137dcf36dcSFrançois Tigeot void (*exit)(void); 214c59a5c48SFrançois Tigeot struct kfd_dev* (*probe)(struct kgd_dev *kgd, struct pci_dev *pdev, 215c59a5c48SFrançois Tigeot const struct kfd2kgd_calls *f2g); 2167dcf36dcSFrançois Tigeot bool (*device_init)(struct kfd_dev *kfd, 2177dcf36dcSFrançois Tigeot const struct kgd2kfd_shared_resources *gpu_resources); 2187dcf36dcSFrançois Tigeot void (*device_exit)(struct kfd_dev *kfd); 2197dcf36dcSFrançois Tigeot void (*interrupt)(struct kfd_dev *kfd, const void *ih_ring_entry); 2207dcf36dcSFrançois Tigeot void (*suspend)(struct kfd_dev *kfd); 2217dcf36dcSFrançois Tigeot int (*resume)(struct kfd_dev *kfd); 2227dcf36dcSFrançois Tigeot }; 2237dcf36dcSFrançois Tigeot 224*d78d3a22SFrançois Tigeot int kgd2kfd_init(unsigned interface_version, 2257dcf36dcSFrançois Tigeot const struct kgd2kfd_calls **g2f); 2267dcf36dcSFrançois Tigeot 2277dcf36dcSFrançois Tigeot #endif /* KGD_KFD_INTERFACE_H_INCLUDED */ 228