[linux-block.git] / drivers / gpu / drm / amd / amdgpu / amdgpu_ring.h

/*
 * Copyright 2016 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.
 *
 * Authors: Christian König
 */
#ifndef __AMDGPU_RING_H__
#define __AMDGPU_RING_H__

#include "gpu_scheduler.h"

/* max number of rings */
#define AMDGPU_MAX_RINGS		16
#define AMDGPU_MAX_GFX_RINGS		1
#define AMDGPU_MAX_COMPUTE_RINGS	8
#define AMDGPU_MAX_VCE_RINGS		3

/* some special values for the owner field */
#define AMDGPU_FENCE_OWNER_UNDEFINED	((void*)0ul)
#define AMDGPU_FENCE_OWNER_VM		((void*)1ul)

#define AMDGPU_FENCE_FLAG_64BIT         (1 << 0)
#define AMDGPU_FENCE_FLAG_INT           (1 << 1)

enum amdgpu_ring_type {
	AMDGPU_RING_TYPE_GFX,
	AMDGPU_RING_TYPE_COMPUTE,
	AMDGPU_RING_TYPE_SDMA,
	AMDGPU_RING_TYPE_UVD,
	AMDGPU_RING_TYPE_VCE,
	AMDGPU_RING_TYPE_KIQ
};

struct amdgpu_device;
struct amdgpu_ring;
struct amdgpu_ib;
struct amdgpu_cs_parser;

/*
 * Fences.
 */
struct amdgpu_fence_driver {
	uint64_t			gpu_addr;
	volatile uint32_t		*cpu_addr;
	/* sync_seq is protected by ring emission lock */
	uint32_t			sync_seq;
	atomic_t			last_seq;
	bool				initialized;
	struct amdgpu_irq_src		*irq_src;
	unsigned			irq_type;
	struct timer_list		fallback_timer;
	unsigned			num_fences_mask;
	spinlock_t			lock;
	struct dma_fence		**fences;
};

int amdgpu_fence_driver_init(struct amdgpu_device *adev);
void amdgpu_fence_driver_fini(struct amdgpu_device *adev);
void amdgpu_fence_driver_force_completion(struct amdgpu_device *adev);

int amdgpu_fence_driver_init_ring(struct amdgpu_ring *ring,
				  unsigned num_hw_submission);
int amdgpu_fence_driver_start_ring(struct amdgpu_ring *ring,
				   struct amdgpu_irq_src *irq_src,
				   unsigned irq_type);
void amdgpu_fence_driver_suspend(struct amdgpu_device *adev);
void amdgpu_fence_driver_resume(struct amdgpu_device *adev);
int amdgpu_fence_emit(struct amdgpu_ring *ring, struct dma_fence **fence);
void amdgpu_fence_process(struct amdgpu_ring *ring);
int amdgpu_fence_wait_empty(struct amdgpu_ring *ring);
unsigned amdgpu_fence_count_emitted(struct amdgpu_ring *ring);

/*
 * Rings.
 */

/* provided by hw blocks that expose a ring buffer for commands */
struct amdgpu_ring_funcs {
	enum amdgpu_ring_type	type;
	uint32_t		align_mask;
	u32			nop;

	/* ring read/write ptr handling */
	u32 (*get_rptr)(struct amdgpu_ring *ring);
	u32 (*get_wptr)(struct amdgpu_ring *ring);
	void (*set_wptr)(struct amdgpu_ring *ring);
	/* validating and patching of IBs */
	int (*parse_cs)(struct amdgpu_cs_parser *p, uint32_t ib_idx);
	/* constants to calculate how many DW are needed for an emit */
	unsigned emit_frame_size;
	unsigned emit_ib_size;
	/* command emit functions */
	void (*emit_ib)(struct amdgpu_ring *ring,
			struct amdgpu_ib *ib,
			unsigned vm_id, bool ctx_switch);
	void (*emit_fence)(struct amdgpu_ring *ring, uint64_t addr,
			   uint64_t seq, unsigned flags);
	void (*emit_pipeline_sync)(struct amdgpu_ring *ring);
	void (*emit_vm_flush)(struct amdgpu_ring *ring, unsigned vm_id,
			      uint64_t pd_addr);
	void (*emit_hdp_flush)(struct amdgpu_ring *ring);
	void (*emit_hdp_invalidate)(struct amdgpu_ring *ring);
	void (*emit_gds_switch)(struct amdgpu_ring *ring, uint32_t vmid,
				uint32_t gds_base, uint32_t gds_size,
				uint32_t gws_base, uint32_t gws_size,
				uint32_t oa_base, uint32_t oa_size);
	/* testing functions */
	int (*test_ring)(struct amdgpu_ring *ring);
	int (*test_ib)(struct amdgpu_ring *ring, long timeout);
	/* insert NOP packets */
	void (*insert_nop)(struct amdgpu_ring *ring, uint32_t count);
	/* pad the indirect buffer to the necessary number of dw */
	void (*pad_ib)(struct amdgpu_ring *ring, struct amdgpu_ib *ib);
	unsigned (*init_cond_exec)(struct amdgpu_ring *ring);
	void (*patch_cond_exec)(struct amdgpu_ring *ring, unsigned offset);
	/* note usage for clock and power gating */
	void (*begin_use)(struct amdgpu_ring *ring);
	void (*end_use)(struct amdgpu_ring *ring);
	void (*emit_switch_buffer) (struct amdgpu_ring *ring);
	void (*emit_cntxcntl) (struct amdgpu_ring *ring, uint32_t flags);
	void (*emit_rreg)(struct amdgpu_ring *ring, uint32_t reg);
	void (*emit_wreg)(struct amdgpu_ring *ring, uint32_t reg, uint32_t val);
};

struct amdgpu_ring {
	struct amdgpu_device		*adev;
	const struct amdgpu_ring_funcs	*funcs;
	struct amdgpu_fence_driver	fence_drv;
	struct amd_gpu_scheduler	sched;

	struct amdgpu_bo	*ring_obj;
	volatile uint32_t	*ring;
	unsigned		rptr_offs;
	unsigned		wptr;
	unsigned		wptr_old;
	unsigned		ring_size;
	unsigned		max_dw;
	int			count_dw;
	uint64_t		gpu_addr;
	uint32_t		ptr_mask;
	bool			ready;
	u32			idx;
	u32			me;
	u32			pipe;
	u32			queue;
	struct amdgpu_bo	*mqd_obj;
	uint64_t                mqd_gpu_addr;
	void                    *mqd_ptr;
	u32			doorbell_index;
	bool			use_doorbell;
	unsigned		wptr_offs;
	unsigned		fence_offs;
	uint64_t		current_ctx;
	char			name[16];
	unsigned		cond_exe_offs;
	u64			cond_exe_gpu_addr;
	volatile u32		*cond_exe_cpu_addr;
#if defined(CONFIG_DEBUG_FS)
	struct dentry *ent;
#endif
};

int amdgpu_ring_alloc(struct amdgpu_ring *ring, unsigned ndw);
void amdgpu_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count);
void amdgpu_ring_generic_pad_ib(struct amdgpu_ring *ring, struct amdgpu_ib *ib);
void amdgpu_ring_commit(struct amdgpu_ring *ring);
void amdgpu_ring_undo(struct amdgpu_ring *ring);
int amdgpu_ring_init(struct amdgpu_device *adev, struct amdgpu_ring *ring,
		     unsigned ring_size, struct amdgpu_irq_src *irq_src,
		     unsigned irq_type);
void amdgpu_ring_fini(struct amdgpu_ring *ring);
static inline void amdgpu_ring_clear_ring(struct amdgpu_ring *ring)
{
	int i = 0;
	while (i <= ring->ptr_mask)
		ring->ring[i++] = ring->funcs->nop;

}

#endif
Commit	Line	Data
78023016 CK	1	/*
	2	* Copyright 2016 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	* Authors: Christian König
	23	*/
	24	#ifndef __AMDGPU_RING_H__
	25	#define __AMDGPU_RING_H__
	26
	27	#include "gpu_scheduler.h"
	28
	29	/* max number of rings */
	30	#define AMDGPU_MAX_RINGS 16
	31	#define AMDGPU_MAX_GFX_RINGS 1
	32	#define AMDGPU_MAX_COMPUTE_RINGS 8
	33	#define AMDGPU_MAX_VCE_RINGS 3
	34
	35	/* some special values for the owner field */
	36	#define AMDGPU_FENCE_OWNER_UNDEFINED ((void*)0ul)
	37	#define AMDGPU_FENCE_OWNER_VM ((void*)1ul)
	38
	39	#define AMDGPU_FENCE_FLAG_64BIT (1 << 0)
	40	#define AMDGPU_FENCE_FLAG_INT (1 << 1)
	41
	42	enum amdgpu_ring_type {
	43	AMDGPU_RING_TYPE_GFX,
	44	AMDGPU_RING_TYPE_COMPUTE,
	45	AMDGPU_RING_TYPE_SDMA,
	46	AMDGPU_RING_TYPE_UVD,
2068751d TH	47	AMDGPU_RING_TYPE_VCE,
2068751d TH	48	AMDGPU_RING_TYPE_KIQ
78023016 CK	49	};
	50
	51	struct amdgpu_device;
	52	struct amdgpu_ring;
	53	struct amdgpu_ib;
	54	struct amdgpu_cs_parser;
	55
	56	/*
	57	* Fences.
	58	*/
	59	struct amdgpu_fence_driver {
	60	uint64_t gpu_addr;
	61	volatile uint32_t *cpu_addr;
	62	/* sync_seq is protected by ring emission lock */
	63	uint32_t sync_seq;
	64	atomic_t last_seq;
	65	bool initialized;
	66	struct amdgpu_irq_src *irq_src;
	67	unsigned irq_type;
	68	struct timer_list fallback_timer;
	69	unsigned num_fences_mask;
	70	spinlock_t lock;
220196b3	71	struct dma_fence **fences;
78023016 CK	72	};
	73
	74	int amdgpu_fence_driver_init(struct amdgpu_device *adev);
	75	void amdgpu_fence_driver_fini(struct amdgpu_device *adev);
	76	void amdgpu_fence_driver_force_completion(struct amdgpu_device *adev);
	77
	78	int amdgpu_fence_driver_init_ring(struct amdgpu_ring *ring,
	79	unsigned num_hw_submission);
	80	int amdgpu_fence_driver_start_ring(struct amdgpu_ring *ring,
	81	struct amdgpu_irq_src *irq_src,
	82	unsigned irq_type);
	83	void amdgpu_fence_driver_suspend(struct amdgpu_device *adev);
	84	void amdgpu_fence_driver_resume(struct amdgpu_device *adev);
220196b3	85	int amdgpu_fence_emit(struct amdgpu_ring ring, struct dma_fence *fence);
78023016 CK	86	void amdgpu_fence_process(struct amdgpu_ring *ring);
	87	int amdgpu_fence_wait_empty(struct amdgpu_ring *ring);
	88	unsigned amdgpu_fence_count_emitted(struct amdgpu_ring *ring);
	89
	90	/*
	91	* Rings.
	92	*/
	93
	94	/* provided by hw blocks that expose a ring buffer for commands */
	95	struct amdgpu_ring_funcs {
21cd942e	96	enum amdgpu_ring_type type;
79887142 CK	97	uint32_t align_mask;
79887142 CK	98	u32 nop;
21cd942e	99
78023016 CK	100	/* ring read/write ptr handling */
	101	u32 (get_rptr)(struct amdgpu_ring ring);
	102	u32 (get_wptr)(struct amdgpu_ring ring);
	103	void (set_wptr)(struct amdgpu_ring ring);
	104	/* validating and patching of IBs */
	105	int (parse_cs)(struct amdgpu_cs_parser p, uint32_t ib_idx);
e12f3d7a CK	106	/* constants to calculate how many DW are needed for an emit */
	107	unsigned emit_frame_size;
	108	unsigned emit_ib_size;
78023016 CK	109	/* command emit functions */
	110	void (emit_ib)(struct amdgpu_ring ring,
	111	struct amdgpu_ib *ib,
	112	unsigned vm_id, bool ctx_switch);
	113	void (emit_fence)(struct amdgpu_ring ring, uint64_t addr,
	114	uint64_t seq, unsigned flags);
	115	void (emit_pipeline_sync)(struct amdgpu_ring ring);
	116	void (emit_vm_flush)(struct amdgpu_ring ring, unsigned vm_id,
	117	uint64_t pd_addr);
	118	void (emit_hdp_flush)(struct amdgpu_ring ring);
	119	void (emit_hdp_invalidate)(struct amdgpu_ring ring);
	120	void (emit_gds_switch)(struct amdgpu_ring ring, uint32_t vmid,
	121	uint32_t gds_base, uint32_t gds_size,
	122	uint32_t gws_base, uint32_t gws_size,
	123	uint32_t oa_base, uint32_t oa_size);
	124	/* testing functions */
	125	int (test_ring)(struct amdgpu_ring ring);
	126	int (test_ib)(struct amdgpu_ring ring, long timeout);
	127	/* insert NOP packets */
	128	void (insert_nop)(struct amdgpu_ring ring, uint32_t count);
	129	/* pad the indirect buffer to the necessary number of dw */
	130	void (pad_ib)(struct amdgpu_ring ring, struct amdgpu_ib *ib);
	131	unsigned (init_cond_exec)(struct amdgpu_ring ring);
	132	void (patch_cond_exec)(struct amdgpu_ring ring, unsigned offset);
	133	/* note usage for clock and power gating */
	134	void (begin_use)(struct amdgpu_ring ring);
	135	void (end_use)(struct amdgpu_ring ring);
	136	void (emit_switch_buffer) (struct amdgpu_ring ring);
	137	void (emit_cntxcntl) (struct amdgpu_ring ring, uint32_t flags);
b6091c12 XY	138	void (emit_rreg)(struct amdgpu_ring ring, uint32_t reg);
b6091c12 XY	139	void (emit_wreg)(struct amdgpu_ring ring, uint32_t reg, uint32_t val);
78023016 CK	140	};
	141
	142	struct amdgpu_ring {
	143	struct amdgpu_device *adev;
	144	const struct amdgpu_ring_funcs *funcs;
	145	struct amdgpu_fence_driver fence_drv;
	146	struct amd_gpu_scheduler sched;
	147
	148	struct amdgpu_bo *ring_obj;
	149	volatile uint32_t *ring;
	150	unsigned rptr_offs;
	151	unsigned wptr;
	152	unsigned wptr_old;
	153	unsigned ring_size;
	154	unsigned max_dw;
	155	int count_dw;
	156	uint64_t gpu_addr;
78023016 CK	157	uint32_t ptr_mask;
78023016 CK	158	bool ready;
78023016 CK	159	u32 idx;
	160	u32 me;
	161	u32 pipe;
	162	u32 queue;
	163	struct amdgpu_bo *mqd_obj;
f3972b53	164	uint64_t mqd_gpu_addr;
59a82d7d	165	void *mqd_ptr;
78023016 CK	166	u32 doorbell_index;
	167	bool use_doorbell;
	168	unsigned wptr_offs;
	169	unsigned fence_offs;
	170	uint64_t current_ctx;
78023016 CK	171	char name[16];
	172	unsigned cond_exe_offs;
	173	u64 cond_exe_gpu_addr;
	174	volatile u32 *cond_exe_cpu_addr;
	175	#if defined(CONFIG_DEBUG_FS)
	176	struct dentry *ent;
	177	#endif
	178	};
	179
	180	int amdgpu_ring_alloc(struct amdgpu_ring *ring, unsigned ndw);
	181	void amdgpu_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count);
	182	void amdgpu_ring_generic_pad_ib(struct amdgpu_ring ring, struct amdgpu_ib ib);
	183	void amdgpu_ring_commit(struct amdgpu_ring *ring);
	184	void amdgpu_ring_undo(struct amdgpu_ring *ring);
	185	int amdgpu_ring_init(struct amdgpu_device adev, struct amdgpu_ring ring,
79887142 CK	186	unsigned ring_size, struct amdgpu_irq_src *irq_src,
79887142 CK	187	unsigned irq_type);
78023016	188	void amdgpu_ring_fini(struct amdgpu_ring *ring);
c79ecfbf ML	189	static inline void amdgpu_ring_clear_ring(struct amdgpu_ring *ring)
	190	{
	191	int i = 0;
	192	while (i <= ring->ptr_mask)
	193	ring->ring[i++] = ring->funcs->nop;
	194
	195	}
78023016 CK	196
78023016 CK	197	#endif