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                    scheduled;
  70         struct fence                    finished;
  71         struct fence_cb                 cb;
  72         struct fence                    *parent;
  73         struct amd_gpu_scheduler        *sched;
  74         spinlock_t                      lock;
  75         void                            *owner;
  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         struct fence_cb                 finish_cb;
  83         struct work_struct              finish_work;
  84         struct list_head                node;
  85         struct delayed_work             work_tdr;
  86 };
  87
  88 extern const struct fence_ops amd_sched_fence_ops_scheduled;
  89 extern const struct fence_ops amd_sched_fence_ops_finished;
  90 static inline struct amd_sched_fence *to_amd_sched_fence(struct fence *f)
  91 {
  92         if (f->ops == &amd_sched_fence_ops_scheduled)
  93                 return container_of(f, struct amd_sched_fence, scheduled);
  94
  95         if (f->ops == &amd_sched_fence_ops_finished)
  96                 return container_of(f, struct amd_sched_fence, finished);
  97
  98         return NULL;
  99 }
 100
 101 /**
 102  * Define the backend operations called by the scheduler,
 103  * these functions should be implemented in driver side
 104 */
 105 struct amd_sched_backend_ops {
 106         struct fence *(*dependency)(struct amd_sched_job *sched_job);
 107         struct fence *(*run_job)(struct amd_sched_job *sched_job);
 108         void (*timedout_job)(struct amd_sched_job *sched_job);
 109         void (*free_job)(struct amd_sched_job *sched_job);
 110 };
 111
 112 enum amd_sched_priority {
 113         AMD_SCHED_PRIORITY_KERNEL = 0,
 114         AMD_SCHED_PRIORITY_NORMAL,
 115         AMD_SCHED_MAX_PRIORITY
 116 };
 117
 118 /**
 119  * One scheduler is implemented for each hardware ring
 120 */
 121 struct amd_gpu_scheduler {
 122         const struct amd_sched_backend_ops      *ops;
 123         uint32_t                        hw_submission_limit;
 124         long                            timeout;
 125         const char                      *name;
 126         struct amd_sched_rq             sched_rq[AMD_SCHED_MAX_PRIORITY];
 127         wait_queue_head_t               wake_up_worker;
 128         wait_queue_head_t               job_scheduled;
 129         atomic_t                        hw_rq_count;
 130         struct task_struct              *thread;
 131         struct list_head        ring_mirror_list;
 132         spinlock_t                      job_list_lock;
 133 };
 134
 135 int amd_sched_init(struct amd_gpu_scheduler *sched,
 136                    const struct amd_sched_backend_ops *ops,
 137                    uint32_t hw_submission, long timeout, const char *name);
 138 void amd_sched_fini(struct amd_gpu_scheduler *sched);
 139
 140 int amd_sched_entity_init(struct amd_gpu_scheduler *sched,
 141                           struct amd_sched_entity *entity,
 142                           struct amd_sched_rq *rq,
 143                           uint32_t jobs);
 144 void amd_sched_entity_fini(struct amd_gpu_scheduler *sched,
 145                            struct amd_sched_entity *entity);
 146 void amd_sched_entity_push_job(struct amd_sched_job *sched_job);
 147
 148 struct amd_sched_fence *amd_sched_fence_create(
 149         struct amd_sched_entity *s_entity, void *owner);
 150 void amd_sched_fence_scheduled(struct amd_sched_fence *fence);
 151 void amd_sched_fence_finished(struct amd_sched_fence *fence);
 152 int amd_sched_job_init(struct amd_sched_job *job,
 153                        struct amd_gpu_scheduler *sched,
 154                        struct amd_sched_entity *entity,
 155                        void *owner);
 156 void amd_sched_hw_job_reset(struct amd_gpu_scheduler *sched);
 157 void amd_sched_job_recovery(struct amd_gpu_scheduler *sched);
 158 #endif