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