drivers/gpu/drm/amd/include/kgd_kfd_interface.h

   1 /*
   2  * Copyright 2014 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
  23 /*
  24  * This file defines the private interface between the
  25  * AMD kernel graphics drivers and the AMD KFD.
  26  */
  27
  28 #ifndef KGD_KFD_INTERFACE_H_INCLUDED
  29 #define KGD_KFD_INTERFACE_H_INCLUDED
  30
  31 #include <linux/types.h>
  32 #include <linux/bitmap.h>
  33
  34 struct pci_dev;
  35
  36 #define KFD_INTERFACE_VERSION 2
  37 #define KGD_MAX_QUEUES 128
  38
  39 struct kfd_dev;
  40 struct kgd_dev;
  41
  42 struct kgd_mem;
  43
  44 enum kfd_preempt_type {
  45         KFD_PREEMPT_TYPE_WAVEFRONT_DRAIN = 0,
  46         KFD_PREEMPT_TYPE_WAVEFRONT_RESET,
  47 };
  48
  49 struct kfd_cu_info {
  50         uint32_t num_shader_engines;
  51         uint32_t num_shader_arrays_per_engine;
  52         uint32_t num_cu_per_sh;
  53         uint32_t cu_active_number;
  54         uint32_t cu_ao_mask;
  55         uint32_t simd_per_cu;
  56         uint32_t max_waves_per_simd;
  57         uint32_t wave_front_size;
  58         uint32_t max_scratch_slots_per_cu;
  59         uint32_t lds_size;
  60         uint32_t cu_bitmap[4][4];
  61 };
  62
  63 /* For getting GPU local memory information from KGD */
  64 struct kfd_local_mem_info {
  65         uint64_t local_mem_size_private;
  66         uint64_t local_mem_size_public;
  67         uint32_t vram_width;
  68         uint32_t mem_clk_max;
  69 };
  70
  71 enum kgd_memory_pool {
  72         KGD_POOL_SYSTEM_CACHEABLE = 1,
  73         KGD_POOL_SYSTEM_WRITECOMBINE = 2,
  74         KGD_POOL_FRAMEBUFFER = 3,
  75 };
  76
  77 enum kgd_engine_type {
  78         KGD_ENGINE_PFP = 1,
  79         KGD_ENGINE_ME,
  80         KGD_ENGINE_CE,
  81         KGD_ENGINE_MEC1,
  82         KGD_ENGINE_MEC2,
  83         KGD_ENGINE_RLC,
  84         KGD_ENGINE_SDMA1,
  85         KGD_ENGINE_SDMA2,
  86         KGD_ENGINE_MAX
  87 };
  88
  89 struct kgd2kfd_shared_resources {
  90         /* Bit n == 1 means VMID n is available for KFD. */
  91         unsigned int compute_vmid_bitmap;
  92
  93         /* number of pipes per mec */
  94         uint32_t num_pipe_per_mec;
  95
  96         /* number of queues per pipe */
  97         uint32_t num_queue_per_pipe;
  98
  99         /* Bit n == 1 means Queue n is available for KFD */
 100         DECLARE_BITMAP(queue_bitmap, KGD_MAX_QUEUES);
 101
 102         /* Base address of doorbell aperture. */
 103         phys_addr_t doorbell_physical_address;
 104
 105         /* Size in bytes of doorbell aperture. */
 106         size_t doorbell_aperture_size;
 107
 108         /* Number of bytes at start of aperture reserved for KGD. */
 109         size_t doorbell_start_offset;
 110 };
 111
 112 struct tile_config {
 113         uint32_t *tile_config_ptr;
 114         uint32_t *macro_tile_config_ptr;
 115         uint32_t num_tile_configs;
 116         uint32_t num_macro_tile_configs;
 117
 118         uint32_t gb_addr_config;
 119         uint32_t num_banks;
 120         uint32_t num_ranks;
 121 };
 122
 123 /**
 124  * struct kfd2kgd_calls
 125  *
 126  * @init_gtt_mem_allocation: Allocate a buffer on the gart aperture.
 127  * The buffer can be used for mqds, hpds, kernel queue, fence and runlists
 128  *
 129  * @free_gtt_mem: Frees a buffer that was allocated on the gart aperture
 130  *
 131  * @get_local_mem_info: Retrieves information about GPU local memory
 132  *
 133  * @get_gpu_clock_counter: Retrieves GPU clock counter
 134  *
 135  * @get_max_engine_clock_in_mhz: Retrieves maximum GPU clock in MHz
 136  *
 137  * @alloc_pasid: Allocate a PASID
 138  * @free_pasid: Free a PASID
 139  *
 140  * @program_sh_mem_settings: A function that should initiate the memory
 141  * properties such as main aperture memory type (cache / non cached) and
 142  * secondary aperture base address, size and memory type.
 143  * This function is used only for no cp scheduling mode.
 144  *
 145  * @set_pasid_vmid_mapping: Exposes pasid/vmid pair to the H/W for no cp
 146  * scheduling mode. Only used for no cp scheduling mode.
 147  *
 148  * @init_pipeline: Initialized the compute pipelines.
 149  *
 150  * @hqd_load: Loads the mqd structure to a H/W hqd slot. used only for no cp
 151  * sceduling mode.
 152  *
 153  * @hqd_sdma_load: Loads the SDMA mqd structure to a H/W SDMA hqd slot.
 154  * used only for no HWS mode.
 155  *
 156  * @hqd_dump: Dumps CPC HQD registers to an array of address-value pairs.
 157  * Array is allocated with kmalloc, needs to be freed with kfree by caller.
 158  *
 159  * @hqd_sdma_dump: Dumps SDMA HQD registers to an array of address-value pairs.
 160  * Array is allocated with kmalloc, needs to be freed with kfree by caller.
 161  *
 162  * @hqd_is_occupies: Checks if a hqd slot is occupied.
 163  *
 164  * @hqd_destroy: Destructs and preempts the queue assigned to that hqd slot.
 165  *
 166  * @hqd_sdma_is_occupied: Checks if an SDMA hqd slot is occupied.
 167  *
 168  * @hqd_sdma_destroy: Destructs and preempts the SDMA queue assigned to that
 169  * SDMA hqd slot.
 170  *
 171  * @get_fw_version: Returns FW versions from the header
 172  *
 173  * @set_scratch_backing_va: Sets VA for scratch backing memory of a VMID.
 174  * Only used for no cp scheduling mode
 175  *
 176  * @get_tile_config: Returns GPU-specific tiling mode information
 177  *
 178  * @get_cu_info: Retrieves activated cu info
 179  *
 180  * @get_vram_usage: Returns current VRAM usage
 181  *
 182  * This structure contains function pointers to services that the kgd driver
 183  * provides to amdkfd driver.
 184  *
 185  */
 186 struct kfd2kgd_calls {
 187         int (*init_gtt_mem_allocation)(struct kgd_dev *kgd, size_t size,
 188                                         void **mem_obj, uint64_t *gpu_addr,
 189                                         void **cpu_ptr);
 190
 191         void (*free_gtt_mem)(struct kgd_dev *kgd, void *mem_obj);
 192
 193         void (*get_local_mem_info)(struct kgd_dev *kgd,
 194                         struct kfd_local_mem_info *mem_info);
 195         uint64_t (*get_gpu_clock_counter)(struct kgd_dev *kgd);
 196
 197         uint32_t (*get_max_engine_clock_in_mhz)(struct kgd_dev *kgd);
 198
 199         int (*alloc_pasid)(unsigned int bits);
 200         void (*free_pasid)(unsigned int pasid);
 201
 202         /* Register access functions */
 203         void (*program_sh_mem_settings)(struct kgd_dev *kgd, uint32_t vmid,
 204                         uint32_t sh_mem_config, uint32_t sh_mem_ape1_base,
 205                         uint32_t sh_mem_ape1_limit, uint32_t sh_mem_bases);
 206
 207         int (*set_pasid_vmid_mapping)(struct kgd_dev *kgd, unsigned int pasid,
 208                                         unsigned int vmid);
 209
 210         int (*init_pipeline)(struct kgd_dev *kgd, uint32_t pipe_id,
 211                                 uint32_t hpd_size, uint64_t hpd_gpu_addr);
 212
 213         int (*init_interrupts)(struct kgd_dev *kgd, uint32_t pipe_id);
 214
 215         int (*hqd_load)(struct kgd_dev *kgd, void *mqd, uint32_t pipe_id,
 216                         uint32_t queue_id, uint32_t __user *wptr,
 217                         uint32_t wptr_shift, uint32_t wptr_mask,
 218                         struct mm_struct *mm);
 219
 220         int (*hqd_sdma_load)(struct kgd_dev *kgd, void *mqd,
 221                              uint32_t __user *wptr, struct mm_struct *mm);
 222
 223         int (*hqd_dump)(struct kgd_dev *kgd,
 224                         uint32_t pipe_id, uint32_t queue_id,
 225                         uint32_t (**dump)[2], uint32_t *n_regs);
 226
 227         int (*hqd_sdma_dump)(struct kgd_dev *kgd,
 228                              uint32_t engine_id, uint32_t queue_id,
 229                              uint32_t (**dump)[2], uint32_t *n_regs);
 230
 231         bool (*hqd_is_occupied)(struct kgd_dev *kgd, uint64_t queue_address,
 232                                 uint32_t pipe_id, uint32_t queue_id);
 233
 234         int (*hqd_destroy)(struct kgd_dev *kgd, void *mqd, uint32_t reset_type,
 235                                 unsigned int timeout, uint32_t pipe_id,
 236                                 uint32_t queue_id);
 237
 238         bool (*hqd_sdma_is_occupied)(struct kgd_dev *kgd, void *mqd);
 239
 240         int (*hqd_sdma_destroy)(struct kgd_dev *kgd, void *mqd,
 241                                 unsigned int timeout);
 242
 243         int (*address_watch_disable)(struct kgd_dev *kgd);
 244         int (*address_watch_execute)(struct kgd_dev *kgd,
 245                                         unsigned int watch_point_id,
 246                                         uint32_t cntl_val,
 247                                         uint32_t addr_hi,
 248                                         uint32_t addr_lo);
 249         int (*wave_control_execute)(struct kgd_dev *kgd,
 250                                         uint32_t gfx_index_val,
 251                                         uint32_t sq_cmd);
 252         uint32_t (*address_watch_get_offset)(struct kgd_dev *kgd,
 253                                         unsigned int watch_point_id,
 254                                         unsigned int reg_offset);
 255         bool (*get_atc_vmid_pasid_mapping_valid)(
 256                                         struct kgd_dev *kgd,
 257                                         uint8_t vmid);
 258         uint16_t (*get_atc_vmid_pasid_mapping_pasid)(
 259                                         struct kgd_dev *kgd,
 260                                         uint8_t vmid);
 261         void (*write_vmid_invalidate_request)(struct kgd_dev *kgd,
 262                                         uint8_t vmid);
 263
 264         uint16_t (*get_fw_version)(struct kgd_dev *kgd,
 265                                 enum kgd_engine_type type);
 266         void (*set_scratch_backing_va)(struct kgd_dev *kgd,
 267                                 uint64_t va, uint32_t vmid);
 268         int (*get_tile_config)(struct kgd_dev *kgd, struct tile_config *config);
 269
 270         void (*get_cu_info)(struct kgd_dev *kgd,
 271                         struct kfd_cu_info *cu_info);
 272         uint64_t (*get_vram_usage)(struct kgd_dev *kgd);
 273 };
 274
 275 /**
 276  * struct kgd2kfd_calls
 277  *
 278  * @exit: Notifies amdkfd that kgd module is unloaded
 279  *
 280  * @probe: Notifies amdkfd about a probe done on a device in the kgd driver.
 281  *
 282  * @device_init: Initialize the newly probed device (if it is a device that
 283  * amdkfd supports)
 284  *
 285  * @device_exit: Notifies amdkfd about a removal of a kgd device
 286  *
 287  * @suspend: Notifies amdkfd about a suspend action done to a kgd device
 288  *
 289  * @resume: Notifies amdkfd about a resume action done to a kgd device
 290  *
 291  * This structure contains function callback pointers so the kgd driver
 292  * will notify to the amdkfd about certain status changes.
 293  *
 294  */
 295 struct kgd2kfd_calls {
 296         void (*exit)(void);
 297         struct kfd_dev* (*probe)(struct kgd_dev *kgd, struct pci_dev *pdev,
 298                 const struct kfd2kgd_calls *f2g);
 299         bool (*device_init)(struct kfd_dev *kfd,
 300                         const struct kgd2kfd_shared_resources *gpu_resources);
 301         void (*device_exit)(struct kfd_dev *kfd);
 302         void (*interrupt)(struct kfd_dev *kfd, const void *ih_ring_entry);
 303         void (*suspend)(struct kfd_dev *kfd);
 304         int (*resume)(struct kfd_dev *kfd);
 305 };
 306
 307 int kgd2kfd_init(unsigned interface_version,
 308                 const struct kgd2kfd_calls **g2f);
 309
 310 #endif  /* KGD_KFD_INTERFACE_H_INCLUDED */