[deliverable/linux.git] / drivers / gpu / drm / i915 / intel_lrc.h

/*
 * Copyright © 2014 Intel Corporation
 *
 * 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 (including the next
 * paragraph) 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 AUTHORS OR COPYRIGHT HOLDERS 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 _INTEL_LRC_H_
#define _INTEL_LRC_H_

#define GEN8_LR_CONTEXT_ALIGN 4096

/* Execlists regs */
#define RING_ELSP(ring)				_MMIO((ring)->mmio_base + 0x230)
#define RING_EXECLIST_STATUS_LO(ring)		_MMIO((ring)->mmio_base + 0x234)
#define RING_EXECLIST_STATUS_HI(ring)		_MMIO((ring)->mmio_base + 0x234 + 4)
#define RING_CONTEXT_CONTROL(ring)		_MMIO((ring)->mmio_base + 0x244)
#define	  CTX_CTRL_INHIBIT_SYN_CTX_SWITCH	(1 << 3)
#define	  CTX_CTRL_ENGINE_CTX_RESTORE_INHIBIT	(1 << 0)
#define   CTX_CTRL_RS_CTX_ENABLE                (1 << 1)
#define RING_CONTEXT_STATUS_BUF_LO(ring, i)	_MMIO((ring)->mmio_base + 0x370 + (i) * 8)
#define RING_CONTEXT_STATUS_BUF_HI(ring, i)	_MMIO((ring)->mmio_base + 0x370 + (i) * 8 + 4)
#define RING_CONTEXT_STATUS_PTR(ring)		_MMIO((ring)->mmio_base + 0x3a0)

/* The docs specify that the write pointer wraps around after 5h, "After status
 * is written out to the last available status QW at offset 5h, this pointer
 * wraps to 0."
 *
 * Therefore, one must infer than even though there are 3 bits available, 6 and
 * 7 appear to be * reserved.
 */
#define GEN8_CSB_ENTRIES 6
#define GEN8_CSB_PTR_MASK 0x7
#define GEN8_CSB_READ_PTR_MASK (GEN8_CSB_PTR_MASK << 8)
#define GEN8_CSB_WRITE_PTR_MASK (GEN8_CSB_PTR_MASK << 0)
#define GEN8_CSB_WRITE_PTR(csb_status) \
	(((csb_status) & GEN8_CSB_WRITE_PTR_MASK) >> 0)
#define GEN8_CSB_READ_PTR(csb_status) \
	(((csb_status) & GEN8_CSB_READ_PTR_MASK) >> 8)

/* Logical Rings */
int intel_logical_ring_alloc_request_extras(struct drm_i915_gem_request *request);
int intel_logical_ring_reserve_space(struct drm_i915_gem_request *request);
void intel_logical_ring_stop(struct intel_engine_cs *ring);
void intel_logical_ring_cleanup(struct intel_engine_cs *ring);
int intel_logical_rings_init(struct drm_device *dev);
int intel_logical_ring_begin(struct drm_i915_gem_request *req, int num_dwords);

int logical_ring_flush_all_caches(struct drm_i915_gem_request *req);
/**
 * intel_logical_ring_advance() - advance the ringbuffer tail
 * @ringbuf: Ringbuffer to advance.
 *
 * The tail is only updated in our logical ringbuffer struct.
 */
static inline void intel_logical_ring_advance(struct intel_ringbuffer *ringbuf)
{
	ringbuf->tail &= ringbuf->size - 1;
}
/**
 * intel_logical_ring_emit() - write a DWORD to the ringbuffer.
 * @ringbuf: Ringbuffer to write to.
 * @data: DWORD to write.
 */
static inline void intel_logical_ring_emit(struct intel_ringbuffer *ringbuf,
					   u32 data)
{
	iowrite32(data, ringbuf->virtual_start + ringbuf->tail);
	ringbuf->tail += 4;
}
static inline void intel_logical_ring_emit_reg(struct intel_ringbuffer *ringbuf,
					       i915_reg_t reg)
{
	intel_logical_ring_emit(ringbuf, i915_mmio_reg_offset(reg));
}

/* Logical Ring Contexts */

/* One extra page is added before LRC for GuC as shared data */
#define LRC_GUCSHR_PN	(0)
#define LRC_PPHWSP_PN	(LRC_GUCSHR_PN + 1)
#define LRC_STATE_PN	(LRC_PPHWSP_PN + 1)

void intel_lr_context_free(struct intel_context *ctx);
uint32_t intel_lr_context_size(struct intel_engine_cs *ring);
int intel_lr_context_deferred_alloc(struct intel_context *ctx,
				    struct intel_engine_cs *ring);
void intel_lr_context_unpin(struct intel_context *ctx,
			    struct intel_engine_cs *engine);
void intel_lr_context_reset(struct drm_device *dev,
			struct intel_context *ctx);
uint64_t intel_lr_context_descriptor(struct intel_context *ctx,
				     struct intel_engine_cs *ring);

u32 intel_execlists_ctx_id(struct intel_context *ctx,
			   struct intel_engine_cs *ring);

/* Execlists */
int intel_sanitize_enable_execlists(struct drm_device *dev, int enable_execlists);
struct i915_execbuffer_params;
int intel_execlists_submission(struct i915_execbuffer_params *params,
			       struct drm_i915_gem_execbuffer2 *args,
			       struct list_head *vmas);

void intel_lrc_irq_handler(struct intel_engine_cs *ring);
void intel_execlists_retire_requests(struct intel_engine_cs *ring);

#endif /* _INTEL_LRC_H_ */
Commit	Line	Data
b20385f1 OM	1	/*
	2	* Copyright © 2014 Intel Corporation
	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 (including the next
	12	* paragraph) shall be included in all copies or substantial portions of the
	13	* Software.
	14	*
	15	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	16	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	18	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	19	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
	20	* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
	21	* DEALINGS IN THE SOFTWARE.
	22	*/
	23
	24	#ifndef _INTEL_LRC_H_
	25	#define _INTEL_LRC_H_
	26
dcb4c12a OM	27	#define GEN8_LR_CONTEXT_ALIGN 4096
dcb4c12a OM	28
4ba70e44	29	/* Execlists regs */
f0f59a00 VS	30	#define RING_ELSP(ring) _MMIO((ring)->mmio_base + 0x230)
	31	#define RING_EXECLIST_STATUS_LO(ring) _MMIO((ring)->mmio_base + 0x234)
	32	#define RING_EXECLIST_STATUS_HI(ring) _MMIO((ring)->mmio_base + 0x234 + 4)
	33	#define RING_CONTEXT_CONTROL(ring) _MMIO((ring)->mmio_base + 0x244)
5baa22c5 ZW	34	#define CTX_CTRL_INHIBIT_SYN_CTX_SWITCH (1 << 3)
5baa22c5 ZW	35	#define CTX_CTRL_ENGINE_CTX_RESTORE_INHIBIT (1 << 0)
6922528a	36	#define CTX_CTRL_RS_CTX_ENABLE (1 << 1)
f0f59a00 VS	37	#define RING_CONTEXT_STATUS_BUF_LO(ring, i) _MMIO((ring)->mmio_base + 0x370 + (i) * 8)
	38	#define RING_CONTEXT_STATUS_BUF_HI(ring, i) _MMIO((ring)->mmio_base + 0x370 + (i) * 8 + 4)
	39	#define RING_CONTEXT_STATUS_PTR(ring) _MMIO((ring)->mmio_base + 0x3a0)
4ba70e44	40
5590a5f0 BW	41	/* The docs specify that the write pointer wraps around after 5h, "After status
	42	* is written out to the last available status QW at offset 5h, this pointer
	43	* wraps to 0."
	44	*
	45	* Therefore, one must infer than even though there are 3 bits available, 6 and
	46	* 7 appear to be * reserved.
	47	*/
	48	#define GEN8_CSB_ENTRIES 6
	49	#define GEN8_CSB_PTR_MASK 0x7
	50	#define GEN8_CSB_READ_PTR_MASK (GEN8_CSB_PTR_MASK << 8)
	51	#define GEN8_CSB_WRITE_PTR_MASK (GEN8_CSB_PTR_MASK << 0)
	52	#define GEN8_CSB_WRITE_PTR(csb_status) \
	53	(((csb_status) & GEN8_CSB_WRITE_PTR_MASK) >> 0)
	54	#define GEN8_CSB_READ_PTR(csb_status) \
	55	(((csb_status) & GEN8_CSB_READ_PTR_MASK) >> 8)
	56
454afebd	57	/* Logical Rings */
40e895ce	58	int intel_logical_ring_alloc_request_extras(struct drm_i915_gem_request *request);
ccd98fe4	59	int intel_logical_ring_reserve_space(struct drm_i915_gem_request *request);
454afebd OM	60	void intel_logical_ring_stop(struct intel_engine_cs *ring);
	61	void intel_logical_ring_cleanup(struct intel_engine_cs *ring);
	62	int intel_logical_rings_init(struct drm_device *dev);
3bbaba0c	63	int intel_logical_ring_begin(struct drm_i915_gem_request *req, int num_dwords);
454afebd	64
4866d729	65	int logical_ring_flush_all_caches(struct drm_i915_gem_request *req);
73e4d07f OM	66	/**
	67	* intel_logical_ring_advance() - advance the ringbuffer tail
	68	* @ringbuf: Ringbuffer to advance.
	69	*
	70	* The tail is only updated in our logical ringbuffer struct.
	71	*/
82e104cc OM	72	static inline void intel_logical_ring_advance(struct intel_ringbuffer *ringbuf)
	73	{
	74	ringbuf->tail &= ringbuf->size - 1;
	75	}
73e4d07f OM	76	/**
	77	* intel_logical_ring_emit() - write a DWORD to the ringbuffer.
	78	* @ringbuf: Ringbuffer to write to.
	79	* @data: DWORD to write.
	80	*/
82e104cc OM	81	static inline void intel_logical_ring_emit(struct intel_ringbuffer *ringbuf,
	82	u32 data)
	83	{
	84	iowrite32(data, ringbuf->virtual_start + ringbuf->tail);
	85	ringbuf->tail += 4;
	86	}
f92a9162	87	static inline void intel_logical_ring_emit_reg(struct intel_ringbuffer *ringbuf,
f0f59a00	88	i915_reg_t reg)
f92a9162	89	{
f0f59a00	90	intel_logical_ring_emit(ringbuf, i915_mmio_reg_offset(reg));
f92a9162	91	}
82e104cc	92
ede7d42b	93	/* Logical Ring Contexts */
d1675198 AD	94
	95	/* One extra page is added before LRC for GuC as shared data */
	96	#define LRC_GUCSHR_PN (0)
	97	#define LRC_PPHWSP_PN (LRC_GUCSHR_PN + 1)
	98	#define LRC_STATE_PN (LRC_PPHWSP_PN + 1)
	99
ede7d42b	100	void intel_lr_context_free(struct intel_context *ctx);
95a66f7e	101	uint32_t intel_lr_context_size(struct intel_engine_cs *ring);
e84fe803 NH	102	int intel_lr_context_deferred_alloc(struct intel_context *ctx,
e84fe803 NH	103	struct intel_engine_cs *ring);
e5292823 TU	104	void intel_lr_context_unpin(struct intel_context *ctx,
e5292823 TU	105	struct intel_engine_cs *engine);
3e5b6f05 TD	106	void intel_lr_context_reset(struct drm_device *dev,
3e5b6f05 TD	107	struct intel_context *ctx);
919f1f55 DG	108	uint64_t intel_lr_context_descriptor(struct intel_context *ctx,
919f1f55 DG	109	struct intel_engine_cs *ring);
ede7d42b	110
ca82580c TU	111	u32 intel_execlists_ctx_id(struct intel_context *ctx,
	112	struct intel_engine_cs *ring);
	113
127f1003 OM	114	/* Execlists */
127f1003 OM	115	int intel_sanitize_enable_execlists(struct drm_device *dev, int enable_execlists);
5f19e2bf JH	116	struct i915_execbuffer_params;
5f19e2bf JH	117	int intel_execlists_submission(struct i915_execbuffer_params *params,
454afebd	118	struct drm_i915_gem_execbuffer2 *args,
5f19e2bf	119	struct list_head *vmas);
127f1003	120
3f7531c3	121	void intel_lrc_irq_handler(struct intel_engine_cs *ring);
c86ee3a9	122	void intel_execlists_retire_requests(struct intel_engine_cs *ring);
e981e7b1	123
b20385f1	124	#endif /* _INTEL_LRC_H_ */