[linux-2.6-block.git] / drivers / gpu / drm / amd / scheduler / gpu_scheduler.h

/*
 * Copyright 2015 Advanced Micro Devices, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#ifndef _GPU_SCHEDULER_H_
#define _GPU_SCHEDULER_H_

#include <linux/kfifo.h>
#include <linux/fence.h>

struct amd_gpu_scheduler;
struct amd_sched_rq;

extern struct kmem_cache *sched_fence_slab;
extern atomic_t sched_fence_slab_ref;

/**
 * A scheduler entity is a wrapper around a job queue or a group
 * of other entities. Entities take turns emitting jobs from their 
 * job queues to corresponding hardware ring based on scheduling
 * policy.
*/
struct amd_sched_entity {
	struct list_head		list;
	struct amd_sched_rq		*rq;
	struct amd_gpu_scheduler	*sched;

	spinlock_t			queue_lock;
	struct kfifo                    job_queue;

	atomic_t			fence_seq;
	uint64_t                        fence_context;

	struct fence			*dependency;
	struct fence_cb			cb;
};

/**
 * Run queue is a set of entities scheduling command submissions for
 * one specific ring. It implements the scheduling policy that selects
 * the next entity to emit commands from.
*/
struct amd_sched_rq {
	spinlock_t		lock;
	struct list_head	entities;
	struct amd_sched_entity	*current_entity;
};

struct amd_sched_fence {
	struct fence                    base;
	struct fence_cb                 cb;
	struct amd_gpu_scheduler	*sched;
	spinlock_t			lock;
	void                            *owner;
	struct delayed_work		dwork;
	struct list_head		list;
};

struct amd_sched_job {
	struct amd_gpu_scheduler        *sched;
	struct amd_sched_entity         *s_entity;
	struct amd_sched_fence          *s_fence;
};

extern const struct fence_ops amd_sched_fence_ops;
static inline struct amd_sched_fence *to_amd_sched_fence(struct fence *f)
{
	struct amd_sched_fence *__f = container_of(f, struct amd_sched_fence, base);

	if (__f->base.ops == &amd_sched_fence_ops)
		return __f;

	return NULL;
}

/**
 * Define the backend operations called by the scheduler,
 * these functions should be implemented in driver side
*/
struct amd_sched_backend_ops {
	struct fence *(*dependency)(struct amd_sched_job *sched_job);
	struct fence *(*run_job)(struct amd_sched_job *sched_job);
};

/**
 * One scheduler is implemented for each hardware ring
*/
struct amd_gpu_scheduler {
	struct amd_sched_backend_ops	*ops;
	uint32_t			hw_submission_limit;
	long				timeout;
	const char			*name;
	struct amd_sched_rq		sched_rq;
	struct amd_sched_rq		kernel_rq;
	wait_queue_head_t		wake_up_worker;
	wait_queue_head_t		job_scheduled;
	atomic_t			hw_rq_count;
	struct list_head		fence_list;
	spinlock_t			fence_list_lock;
	struct task_struct		*thread;
};

int amd_sched_init(struct amd_gpu_scheduler *sched,
		   struct amd_sched_backend_ops *ops,
		   uint32_t hw_submission, long timeout, const char *name);
void amd_sched_fini(struct amd_gpu_scheduler *sched);

int amd_sched_entity_init(struct amd_gpu_scheduler *sched,
			  struct amd_sched_entity *entity,
			  struct amd_sched_rq *rq,
			  uint32_t jobs);
void amd_sched_entity_fini(struct amd_gpu_scheduler *sched,
			   struct amd_sched_entity *entity);
void amd_sched_entity_push_job(struct amd_sched_job *sched_job);

struct amd_sched_fence *amd_sched_fence_create(
	struct amd_sched_entity *s_entity, void *owner);
void amd_sched_fence_signal(struct amd_sched_fence *fence);


#endif
Commit	Line	Data
a72ce6f8 JZ	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>
4cef9267	28	#include <linux/fence.h>
a72ce6f8	29
a72ce6f8	30	struct amd_gpu_scheduler;
432a4ff8	31	struct amd_sched_rq;
a72ce6f8	32
f5617f9d CZ	33	extern struct kmem_cache *sched_fence_slab;
	34	extern atomic_t sched_fence_slab_ref;
	35
a72ce6f8 JZ	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;
0f75aee7 CK	44	struct amd_sched_rq *rq;
	45	struct amd_gpu_scheduler *sched;
	46
91404fb2	47	spinlock_t queue_lock;
0f75aee7 CK	48	struct kfifo job_queue;
	49
	50	atomic_t fence_seq;
f556cb0c	51	uint64_t fence_context;
0f75aee7	52
e61235db CK	53	struct fence *dependency;
e61235db CK	54	struct fence_cb cb;
a72ce6f8 JZ	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	*/
432a4ff8	62	struct amd_sched_rq {
2b184d8d	63	spinlock_t lock;
432a4ff8 CK	64	struct list_head entities;
432a4ff8 CK	65	struct amd_sched_entity *current_entity;
a72ce6f8 JZ	66	};
a72ce6f8 JZ	67
f556cb0c CZ	68	struct amd_sched_fence {
f556cb0c CZ	69	struct fence base;
258f3f99	70	struct fence_cb cb;
9b398fa5	71	struct amd_gpu_scheduler *sched;
f556cb0c	72	spinlock_t lock;
84f76ea6	73	void *owner;
2440ff2c JZ	74	struct delayed_work dwork;
2440ff2c JZ	75	struct list_head list;
f556cb0c CZ	76	};
f556cb0c CZ	77
4cef9267	78	struct amd_sched_job {
4cef9267	79	struct amd_gpu_scheduler *sched;
953e8fd4	80	struct amd_sched_entity *s_entity;
f556cb0c	81	struct amd_sched_fence *s_fence;
4cef9267 CZ	82	};
4cef9267 CZ	83
f556cb0c CZ	84	extern const struct fence_ops amd_sched_fence_ops;
	85	static inline struct amd_sched_fence to_amd_sched_fence(struct fence f)
	86	{
	87	struct amd_sched_fence *__f = container_of(f, struct amd_sched_fence, base);
	88
	89	if (__f->base.ops == &amd_sched_fence_ops)
	90	return __f;
	91
	92	return NULL;
	93	}
	94
a72ce6f8 JZ	95	/**
	96	* Define the backend operations called by the scheduler,
	97	* these functions should be implemented in driver side
	98	*/
	99	struct amd_sched_backend_ops {
4c7eb91c JZ	100	struct fence (dependency)(struct amd_sched_job *sched_job);
4c7eb91c JZ	101	struct fence (run_job)(struct amd_sched_job *sched_job);
a72ce6f8 JZ	102	};
	103
	104	/**
	105	* One scheduler is implemented for each hardware ring
	106	*/
	107	struct amd_gpu_scheduler {
4f839a24 CK	108	struct amd_sched_backend_ops *ops;
4f839a24 CK	109	uint32_t hw_submission_limit;
2440ff2c	110	long timeout;
4f839a24	111	const char *name;
432a4ff8 CK	112	struct amd_sched_rq sched_rq;
432a4ff8 CK	113	struct amd_sched_rq kernel_rq;
c2b6bd7e CK	114	wait_queue_head_t wake_up_worker;
c2b6bd7e CK	115	wait_queue_head_t job_scheduled;
4f839a24	116	atomic_t hw_rq_count;
2440ff2c JZ	117	struct list_head fence_list;
2440ff2c JZ	118	spinlock_t fence_list_lock;
4f839a24	119	struct task_struct *thread;
a72ce6f8 JZ	120	};
a72ce6f8 JZ	121
4f839a24 CK	122	int amd_sched_init(struct amd_gpu_scheduler *sched,
4f839a24 CK	123	struct amd_sched_backend_ops *ops,
2440ff2c	124	uint32_t hw_submission, long timeout, const char *name);
4f839a24	125	void amd_sched_fini(struct amd_gpu_scheduler *sched);
a72ce6f8	126
91404fb2 CK	127	int amd_sched_entity_init(struct amd_gpu_scheduler *sched,
91404fb2 CK	128	struct amd_sched_entity *entity,
432a4ff8	129	struct amd_sched_rq *rq,
91404fb2	130	uint32_t jobs);
062c7fb3 CK	131	void amd_sched_entity_fini(struct amd_gpu_scheduler *sched,
062c7fb3 CK	132	struct amd_sched_entity *entity);
e2840221	133	void amd_sched_entity_push_job(struct amd_sched_job *sched_job);
a72ce6f8	134
f556cb0c	135	struct amd_sched_fence *amd_sched_fence_create(
84f76ea6	136	struct amd_sched_entity s_entity, void owner);
f556cb0c CZ	137	void amd_sched_fence_signal(struct amd_sched_fence *fence);
	138
	139
a72ce6f8	140	#endif