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