drivers/gpu/drm/amd/amdkfd/kfd_mqd_manager.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 #ifndef KFD_MQD_MANAGER_H_
  25 #define KFD_MQD_MANAGER_H_
  26
  27 #include "kfd_priv.h"
  28
  29 /**
  30  * struct mqd_manager
  31  *
  32  * @init_mqd: Allocates the mqd buffer on local gpu memory and initialize it.
  33  *
  34  * @load_mqd: Loads the mqd to a concrete hqd slot. Used only for no cp
  35  * scheduling mode.
  36  *
  37  * @update_mqd: Handles a update call for the MQD
  38  *
  39  * @destroy_mqd: Destroys the HQD slot and by that preempt the relevant queue.
  40  * Used only for no cp scheduling.
  41  *
  42  * @uninit_mqd: Releases the mqd buffer from local gpu memory.
  43  *
  44  * @is_occupied: Checks if the relevant HQD slot is occupied.
  45  *
  46  * @mqd_mutex: Mqd manager mutex.
  47  *
  48  * @dev: The kfd device structure coupled with this module.
  49  *
  50  * MQD stands for Memory Queue Descriptor which represents the current queue
  51  * state in the memory and initiate the HQD (Hardware Queue Descriptor) state.
  52  * This structure is actually a base class for the different types of MQDs
  53  * structures for the variant ASICs that should be supported in the future.
  54  * This base class is also contains all the MQD specific operations.
  55  * Another important thing to mention is that each queue has a MQD that keeps
  56  * his state (or context) after each preemption or reassignment.
  57  * Basically there are a instances of the mqd manager class per MQD type per
  58  * ASIC. Currently the kfd driver supports only Kaveri so there are instances
  59  * per KFD_MQD_TYPE for each device.
  60  *
  61  */
  62
  63 struct mqd_manager {
  64         int     (*init_mqd)(struct mqd_manager *mm, void **mqd,
  65                         struct kfd_mem_obj **mqd_mem_obj, uint64_t *gart_addr,
  66                         struct queue_properties *q);
  67
  68         int     (*load_mqd)(struct mqd_manager *mm, void *mqd,
  69                                 uint32_t pipe_id, uint32_t queue_id,
  70                                 uint32_t __user *wptr);
  71
  72         int     (*update_mqd)(struct mqd_manager *mm, void *mqd,
  73                                 struct queue_properties *q);
  74
  75         int     (*destroy_mqd)(struct mqd_manager *mm, void *mqd,
  76                                 enum kfd_preempt_type type,
  77                                 unsigned int timeout, uint32_t pipe_id,
  78                                 uint32_t queue_id);
  79
  80         void    (*uninit_mqd)(struct mqd_manager *mm, void *mqd,
  81                                 struct kfd_mem_obj *mqd_mem_obj);
  82
  83         bool    (*is_occupied)(struct mqd_manager *mm, void *mqd,
  84                                 uint64_t queue_address, uint32_t pipe_id,
  85                                 uint32_t queue_id);
  86
  87         struct mutex    mqd_mutex;
  88         struct kfd_dev  *dev;
  89 };
  90
  91 #endif /* KFD_MQD_MANAGER_H_ */