[deliverable/linux.git] / drivers / gpu / drm / amd / amdkfd / kfd_device_queue_manager.h

/*
 * Copyright 2014 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 KFD_DEVICE_QUEUE_MANAGER_H_
#define KFD_DEVICE_QUEUE_MANAGER_H_

#include <linux/rwsem.h>
#include <linux/list.h>
#include "kfd_priv.h"
#include "kfd_mqd_manager.h"

#define QUEUE_PREEMPT_DEFAULT_TIMEOUT_MS	(500)
#define QUEUES_PER_PIPE				(8)
#define PIPE_PER_ME_CP_SCHEDULING		(3)
#define CIK_VMID_NUM				(8)
#define KFD_VMID_START_OFFSET			(8)
#define VMID_PER_DEVICE				CIK_VMID_NUM
#define KFD_DQM_FIRST_PIPE			(0)
#define CIK_SDMA_QUEUES				(4)
#define CIK_SDMA_QUEUES_PER_ENGINE		(2)
#define CIK_SDMA_ENGINE_NUM			(2)

struct device_process_node {
	struct qcm_process_device *qpd;
	struct list_head list;
};

/**
 * struct device_queue_manager_ops
 *
 * @create_queue: Queue creation routine.
 *
 * @destroy_queue: Queue destruction routine.
 *
 * @update_queue: Queue update routine.
 *
 * @get_mqd_manager: Returns the mqd manager according to the mqd type.
 *
 * @exeute_queues: Dispatches the queues list to the H/W.
 *
 * @register_process: This routine associates a specific process with device.
 *
 * @unregister_process: destroys the associations between process to device.
 *
 * @initialize: Initializes the pipelines and memory module for that device.
 *
 * @start: Initializes the resources/modules the the device needs for queues
 * execution. This function is called on device initialization and after the
 * system woke up after suspension.
 *
 * @stop: This routine stops execution of all the active queue running on the
 * H/W and basically this function called on system suspend.
 *
 * @uninitialize: Destroys all the device queue manager resources allocated in
 * initialize routine.
 *
 * @create_kernel_queue: Creates kernel queue. Used for debug queue.
 *
 * @destroy_kernel_queue: Destroys kernel queue. Used for debug queue.
 *
 * @set_cache_memory_policy: Sets memory policy (cached/ non cached) for the
 * memory apertures.
 *
 */

struct device_queue_manager_ops {
	int	(*create_queue)(struct device_queue_manager *dqm,
				struct queue *q,
				struct qcm_process_device *qpd,
				int *allocate_vmid);

	int	(*destroy_queue)(struct device_queue_manager *dqm,
				struct qcm_process_device *qpd,
				struct queue *q);

	int	(*update_queue)(struct device_queue_manager *dqm,
				struct queue *q);

	struct mqd_manager * (*get_mqd_manager)
					(struct device_queue_manager *dqm,
					enum KFD_MQD_TYPE type);

	int	(*register_process)(struct device_queue_manager *dqm,
					struct qcm_process_device *qpd);

	int	(*unregister_process)(struct device_queue_manager *dqm,
					struct qcm_process_device *qpd);

	int	(*initialize)(struct device_queue_manager *dqm);
	int	(*start)(struct device_queue_manager *dqm);
	int	(*stop)(struct device_queue_manager *dqm);
	void	(*uninitialize)(struct device_queue_manager *dqm);
	int	(*create_kernel_queue)(struct device_queue_manager *dqm,
					struct kernel_queue *kq,
					struct qcm_process_device *qpd);

	void	(*destroy_kernel_queue)(struct device_queue_manager *dqm,
					struct kernel_queue *kq,
					struct qcm_process_device *qpd);

	bool	(*set_cache_memory_policy)(struct device_queue_manager *dqm,
					   struct qcm_process_device *qpd,
					   enum cache_policy default_policy,
					   enum cache_policy alternate_policy,
					   void __user *alternate_aperture_base,
					   uint64_t alternate_aperture_size);
};

struct device_queue_manager_asic_ops {
	int	(*register_process)(struct device_queue_manager *dqm,
					struct qcm_process_device *qpd);
	int	(*initialize)(struct device_queue_manager *dqm);
	bool	(*set_cache_memory_policy)(struct device_queue_manager *dqm,
					   struct qcm_process_device *qpd,
					   enum cache_policy default_policy,
					   enum cache_policy alternate_policy,
					   void __user *alternate_aperture_base,
					   uint64_t alternate_aperture_size);
	void	(*init_sdma_vm)(struct device_queue_manager *dqm,
				struct queue *q,
				struct qcm_process_device *qpd);
};

/**
 * struct device_queue_manager
 *
 * This struct is a base class for the kfd queues scheduler in the
 * device level. The device base class should expose the basic operations
 * for queue creation and queue destruction. This base class hides the
 * scheduling mode of the driver and the specific implementation of the
 * concrete device. This class is the only class in the queues scheduler
 * that configures the H/W.
 *
 */

struct device_queue_manager {
	struct device_queue_manager_ops ops;
	struct device_queue_manager_asic_ops ops_asic_specific;

	struct mqd_manager	*mqds[KFD_MQD_TYPE_MAX];
	struct packet_manager	packets;
	struct kfd_dev		*dev;
	struct mutex		lock;
	struct list_head	queues;
	unsigned int		processes_count;
	unsigned int		queue_count;
	unsigned int		sdma_queue_count;
	unsigned int		total_queue_count;
	unsigned int		next_pipe_to_allocate;
	unsigned int		*allocated_queues;
	unsigned int		sdma_bitmap;
	unsigned int		vmid_bitmap;
	uint64_t		pipelines_addr;
	struct kfd_mem_obj	*pipeline_mem;
	uint64_t		fence_gpu_addr;
	unsigned int		*fence_addr;
	struct kfd_mem_obj	*fence_mem;
	bool			active_runlist;
};

void device_queue_manager_init_cik(struct device_queue_manager_asic_ops *ops);
void device_queue_manager_init_vi(struct device_queue_manager_asic_ops *ops);
void program_sh_mem_settings(struct device_queue_manager *dqm,
					struct qcm_process_device *qpd);
int init_pipelines(struct device_queue_manager *dqm,
		unsigned int pipes_num, unsigned int first_pipe);
unsigned int get_first_pipe(struct device_queue_manager *dqm);
unsigned int get_pipes_num(struct device_queue_manager *dqm);

static inline unsigned int get_sh_mem_bases_32(struct kfd_process_device *pdd)
{
	return (pdd->lds_base >> 16) & 0xFF;
}

static inline unsigned int
get_sh_mem_bases_nybble_64(struct kfd_process_device *pdd)
{
	return (pdd->lds_base >> 60) & 0x0E;
}

#endif /* KFD_DEVICE_QUEUE_MANAGER_H_ */
Commit	Line	Data
ed6e6a34 BG	1	/*
	2	* Copyright 2014 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 KFD_DEVICE_QUEUE_MANAGER_H_
	25	#define KFD_DEVICE_QUEUE_MANAGER_H_
	26
	27	#include <linux/rwsem.h>
	28	#include <linux/list.h>
	29	#include "kfd_priv.h"
	30	#include "kfd_mqd_manager.h"
	31
	32	#define QUEUE_PREEMPT_DEFAULT_TIMEOUT_MS (500)
	33	#define QUEUES_PER_PIPE (8)
	34	#define PIPE_PER_ME_CP_SCHEDULING (3)
	35	#define CIK_VMID_NUM (8)
	36	#define KFD_VMID_START_OFFSET (8)
	37	#define VMID_PER_DEVICE CIK_VMID_NUM
	38	#define KFD_DQM_FIRST_PIPE (0)
bcea3081 BG	39	#define CIK_SDMA_QUEUES (4)
	40	#define CIK_SDMA_QUEUES_PER_ENGINE (2)
	41	#define CIK_SDMA_ENGINE_NUM (2)
ed6e6a34 BG	42
	43	struct device_process_node {
	44	struct qcm_process_device *qpd;
	45	struct list_head list;
	46	};
	47
64c7f8cf	48	/**
45c9a5e4	49	* struct device_queue_manager_ops
64c7f8cf BG	50	*
	51	* @create_queue: Queue creation routine.
	52	*
	53	* @destroy_queue: Queue destruction routine.
	54	*
	55	* @update_queue: Queue update routine.
	56	*
	57	* @get_mqd_manager: Returns the mqd manager according to the mqd type.
	58	*
	59	* @exeute_queues: Dispatches the queues list to the H/W.
	60	*
	61	* @register_process: This routine associates a specific process with device.
	62	*
	63	* @unregister_process: destroys the associations between process to device.
	64	*
	65	* @initialize: Initializes the pipelines and memory module for that device.
	66	*
	67	* @start: Initializes the resources/modules the the device needs for queues
	68	* execution. This function is called on device initialization and after the
	69	* system woke up after suspension.
	70	*
	71	* @stop: This routine stops execution of all the active queue running on the
	72	* H/W and basically this function called on system suspend.
	73	*
	74	* @uninitialize: Destroys all the device queue manager resources allocated in
	75	* initialize routine.
	76	*
	77	* @create_kernel_queue: Creates kernel queue. Used for debug queue.
	78	*
	79	* @destroy_kernel_queue: Destroys kernel queue. Used for debug queue.
	80	*
	81	* @set_cache_memory_policy: Sets memory policy (cached/ non cached) for the
	82	* memory apertures.
	83	*
64c7f8cf BG	84	*/
64c7f8cf BG	85
45c9a5e4	86	struct device_queue_manager_ops {
ed6e6a34 BG	87	int (create_queue)(struct device_queue_manager dqm,
	88	struct queue *q,
	89	struct qcm_process_device *qpd,
	90	int *allocate_vmid);
992839ad	91
ed6e6a34 BG	92	int (destroy_queue)(struct device_queue_manager dqm,
	93	struct qcm_process_device *qpd,
	94	struct queue *q);
992839ad	95
ed6e6a34 BG	96	int (update_queue)(struct device_queue_manager dqm,
ed6e6a34 BG	97	struct queue *q);
64c7f8cf BG	98
	99	struct mqd_manager * (*get_mqd_manager)
	100	(struct device_queue_manager *dqm,
ed6e6a34 BG	101	enum KFD_MQD_TYPE type);
	102
	103	int (register_process)(struct device_queue_manager dqm,
	104	struct qcm_process_device *qpd);
992839ad	105
ed6e6a34 BG	106	int (unregister_process)(struct device_queue_manager dqm,
ed6e6a34 BG	107	struct qcm_process_device *qpd);
992839ad	108
ed6e6a34 BG	109	int (initialize)(struct device_queue_manager dqm);
	110	int (start)(struct device_queue_manager dqm);
	111	int (stop)(struct device_queue_manager dqm);
	112	void (uninitialize)(struct device_queue_manager dqm);
	113	int (create_kernel_queue)(struct device_queue_manager dqm,
	114	struct kernel_queue *kq,
	115	struct qcm_process_device *qpd);
992839ad	116
ed6e6a34 BG	117	void (destroy_kernel_queue)(struct device_queue_manager dqm,
	118	struct kernel_queue *kq,
	119	struct qcm_process_device *qpd);
992839ad	120
ed6e6a34 BG	121	bool (set_cache_memory_policy)(struct device_queue_manager dqm,
	122	struct qcm_process_device *qpd,
	123	enum cache_policy default_policy,
	124	enum cache_policy alternate_policy,
	125	void __user *alternate_aperture_base,
	126	uint64_t alternate_aperture_size);
45c9a5e4 OG	127	};
45c9a5e4 OG	128
d42af779 OG	129	struct device_queue_manager_asic_ops {
	130	int (register_process)(struct device_queue_manager dqm,
	131	struct qcm_process_device *qpd);
	132	int (initialize)(struct device_queue_manager dqm);
	133	bool (set_cache_memory_policy)(struct device_queue_manager dqm,
	134	struct qcm_process_device *qpd,
	135	enum cache_policy default_policy,
	136	enum cache_policy alternate_policy,
	137	void __user *alternate_aperture_base,
	138	uint64_t alternate_aperture_size);
3e3f6e1a OG	139	void (init_sdma_vm)(struct device_queue_manager dqm,
	140	struct queue *q,
	141	struct qcm_process_device *qpd);
d42af779 OG	142	};
d42af779 OG	143
45c9a5e4 OG	144	/**
	145	* struct device_queue_manager
	146	*
	147	* This struct is a base class for the kfd queues scheduler in the
	148	* device level. The device base class should expose the basic operations
	149	* for queue creation and queue destruction. This base class hides the
	150	* scheduling mode of the driver and the specific implementation of the
	151	* concrete device. This class is the only class in the queues scheduler
	152	* that configures the H/W.
	153	*
	154	*/
ed6e6a34	155
45c9a5e4 OG	156	struct device_queue_manager {
45c9a5e4 OG	157	struct device_queue_manager_ops ops;
d42af779	158	struct device_queue_manager_asic_ops ops_asic_specific;
ed6e6a34 BG	159
	160	struct mqd_manager *mqds[KFD_MQD_TYPE_MAX];
	161	struct packet_manager packets;
	162	struct kfd_dev *dev;
	163	struct mutex lock;
	164	struct list_head queues;
	165	unsigned int processes_count;
	166	unsigned int queue_count;
bcea3081	167	unsigned int sdma_queue_count;
b8cbab04	168	unsigned int total_queue_count;
ed6e6a34 BG	169	unsigned int next_pipe_to_allocate;
ed6e6a34 BG	170	unsigned int *allocated_queues;
bcea3081	171	unsigned int sdma_bitmap;
ed6e6a34 BG	172	unsigned int vmid_bitmap;
	173	uint64_t pipelines_addr;
	174	struct kfd_mem_obj *pipeline_mem;
	175	uint64_t fence_gpu_addr;
	176	unsigned int *fence_addr;
	177	struct kfd_mem_obj *fence_mem;
	178	bool active_runlist;
	179	};
	180
d42af779 OG	181	void device_queue_manager_init_cik(struct device_queue_manager_asic_ops *ops);
d42af779 OG	182	void device_queue_manager_init_vi(struct device_queue_manager_asic_ops *ops);
a22fc854 BG	183	void program_sh_mem_settings(struct device_queue_manager *dqm,
a22fc854 BG	184	struct qcm_process_device *qpd);
a22fc854 BG	185	int init_pipelines(struct device_queue_manager *dqm,
a22fc854 BG	186	unsigned int pipes_num, unsigned int first_pipe);
1365aa62	187	unsigned int get_first_pipe(struct device_queue_manager *dqm);
64ea8f4a	188	unsigned int get_pipes_num(struct device_queue_manager *dqm);
0b3674ae	189
a104299b	190	static inline unsigned int get_sh_mem_bases_32(struct kfd_process_device *pdd)
0b3674ae OG	191	{
	192	return (pdd->lds_base >> 16) & 0xFF;
	193	}
	194
a104299b	195	static inline unsigned int
0b3674ae OG	196	get_sh_mem_bases_nybble_64(struct kfd_process_device *pdd)
	197	{
	198	return (pdd->lds_base >> 60) & 0x0E;
	199	}
	200
ed6e6a34	201	#endif /* KFD_DEVICE_QUEUE_MANAGER_H_ */