drivers/gpu/drm/amd/scheduler/gpu_scheduler.h

   1 /*
   2  * Copyright 2015 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 _GPU_SCHEDULER_H_
  25 #define _GPU_SCHEDULER_H_
  26
  27 #include <linux/kfifo.h>
  28 #include <linux/fence.h>
  29
  30 struct amd_gpu_scheduler;
  31 struct amd_sched_rq;
  32
  33 extern struct kmem_cache *sched_fence_slab;
  34 extern atomic_t sched_fence_slab_ref;
  35
  36 /**
  37  * A scheduler entity is a wrapper around a job queue or a group
  38  * of other entities. Entities take turns emitting jobs from their
  39  * job queues to corresponding hardware ring based on scheduling
  40  * policy.
  41 */
  42 struct amd_sched_entity {
  43         struct list_head                list;
  44         struct amd_sched_rq             *rq;
  45         struct amd_gpu_scheduler        *sched;
  46
  47         spinlock_t                      queue_lock;
  48         struct kfifo                    job_queue;
  49
  50         atomic_t                        fence_seq;
  51         uint64_t                        fence_context;
  52
  53         struct fence                    *dependency;
  54         struct fence_cb                 cb;
  55 };
  56
  57 /**
  58  * Run queue is a set of entities scheduling command submissions for
  59  * one specific ring. It implements the scheduling policy that selects
  60  * the next entity to emit commands from.
  61 */
  62 struct amd_sched_rq {
  63         spinlock_t              lock;
  64         struct list_head        entities;
  65         struct amd_sched_entity *current_entity;
  66 };
  67
  68 struct amd_sched_fence {
  69         struct fence                    base;
  70         struct fence_cb                 cb;
  71         struct amd_gpu_scheduler        *sched;
  72         spinlock_t                      lock;
  73         void                            *owner;
  74         struct delayed_work             dwork;
  75         struct list_head                list;
  76 };
  77
  78 struct amd_sched_job {
  79         struct amd_gpu_scheduler        *sched;
  80         struct amd_sched_entity         *s_entity;
  81         struct amd_sched_fence          *s_fence;
  82         void                            *owner;
  83 };
  84
  85 extern const struct fence_ops amd_sched_fence_ops;
  86 static inline struct amd_sched_fence *to_amd_sched_fence(struct fence *f)
  87 {
  88         struct amd_sched_fence *__f = container_of(f, struct amd_sched_fence, base);
  89
  90         if (__f->base.ops == &amd_sched_fence_ops)
  91                 return __f;
  92
  93         return NULL;
  94 }
  95
  96 /**
  97  * Define the backend operations called by the scheduler,
  98  * these functions should be implemented in driver side
  99 */
 100 struct amd_sched_backend_ops {
 101         struct fence *(*dependency)(struct amd_sched_job *sched_job);
 102         struct fence *(*run_job)(struct amd_sched_job *sched_job);
 103 };
 104
 105 /**
 106  * One scheduler is implemented for each hardware ring
 107 */
 108 struct amd_gpu_scheduler {
 109         struct amd_sched_backend_ops    *ops;
 110         uint32_t                        hw_submission_limit;
 111         long                            timeout;
 112         const char                      *name;
 113         struct amd_sched_rq             sched_rq;
 114         struct amd_sched_rq             kernel_rq;
 115         wait_queue_head_t               wake_up_worker;
 116         wait_queue_head_t               job_scheduled;
 117         atomic_t                        hw_rq_count;
 118         struct list_head                fence_list;
 119         spinlock_t                      fence_list_lock;
 120         struct task_struct              *thread;
 121 };
 122
 123 int amd_sched_init(struct amd_gpu_scheduler *sched,
 124                    struct amd_sched_backend_ops *ops,
 125                    uint32_t hw_submission, long timeout, const char *name);
 126 void amd_sched_fini(struct amd_gpu_scheduler *sched);
 127
 128 int amd_sched_entity_init(struct amd_gpu_scheduler *sched,
 129                           struct amd_sched_entity *entity,
 130                           struct amd_sched_rq *rq,
 131                           uint32_t jobs);
 132 void amd_sched_entity_fini(struct amd_gpu_scheduler *sched,
 133                            struct amd_sched_entity *entity);
 134 int amd_sched_entity_push_job(struct amd_sched_job *sched_job);
 135
 136 struct amd_sched_fence *amd_sched_fence_create(
 137         struct amd_sched_entity *s_entity, void *owner);
 138 void amd_sched_fence_signal(struct amd_sched_fence *fence);
 139
 140
 141 #endif