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