1 #ifndef _INTEL_RINGBUFFER_H_
2 #define _INTEL_RINGBUFFER_H_
5 * Gen2 BSpec "1. Programming Environment" / 1.4.4.6 "Ring Buffer Use"
6 * Gen3 BSpec "vol1c Memory Interface Functions" / 2.3.4.5 "Ring Buffer Use"
7 * Gen4+ BSpec "vol1c Memory Interface and Command Stream" / 5.3.4.5 "Ring Buffer Use"
9 * "If the Ring Buffer Head Pointer and the Tail Pointer are on the same
10 * cacheline, the Head Pointer must not be greater than the Tail
13 #define I915_RING_FREE_SPACE 64
15 struct intel_hw_status_page {
17 unsigned int gfx_addr;
18 struct drm_i915_gem_object *obj;
21 #define I915_READ_TAIL(ring) I915_READ(RING_TAIL((ring)->mmio_base))
22 #define I915_WRITE_TAIL(ring, val) I915_WRITE(RING_TAIL((ring)->mmio_base), val)
24 #define I915_READ_START(ring) I915_READ(RING_START((ring)->mmio_base))
25 #define I915_WRITE_START(ring, val) I915_WRITE(RING_START((ring)->mmio_base), val)
27 #define I915_READ_HEAD(ring) I915_READ(RING_HEAD((ring)->mmio_base))
28 #define I915_WRITE_HEAD(ring, val) I915_WRITE(RING_HEAD((ring)->mmio_base), val)
30 #define I915_READ_CTL(ring) I915_READ(RING_CTL((ring)->mmio_base))
31 #define I915_WRITE_CTL(ring, val) I915_WRITE(RING_CTL((ring)->mmio_base), val)
33 #define I915_READ_IMR(ring) I915_READ(RING_IMR((ring)->mmio_base))
34 #define I915_WRITE_IMR(ring, val) I915_WRITE(RING_IMR((ring)->mmio_base), val)
36 #define I915_READ_MODE(ring) I915_READ(RING_MI_MODE((ring)->mmio_base))
37 #define I915_WRITE_MODE(ring, val) I915_WRITE(RING_MI_MODE((ring)->mmio_base), val)
39 enum intel_ring_hangcheck_action {
47 #define HANGCHECK_SCORE_RING_HUNG 31
49 struct intel_ring_hangcheck {
53 enum intel_ring_hangcheck_action action;
57 struct intel_ring_buffer {
65 #define I915_NUM_RINGS 4
67 void __iomem *virtual_start;
68 struct drm_device *dev;
69 struct drm_i915_gem_object *obj;
76 struct intel_hw_status_page status_page;
78 /** We track the position of the requests in the ring buffer, and
79 * when each is retired we increment last_retired_head as the GPU
80 * must have finished processing the request and so we know we
81 * can advance the ringbuffer up to that position.
83 * last_retired_head is set to -1 after the value is consumed so
84 * we can detect new retirements.
86 u32 last_retired_head;
88 unsigned irq_refcount; /* protected by dev_priv->irq_lock */
89 u32 irq_enable_mask; /* bitmask to enable ring interrupt */
91 u32 sync_seqno[I915_NUM_RINGS-1];
92 bool __must_check (*irq_get)(struct intel_ring_buffer *ring);
93 void (*irq_put)(struct intel_ring_buffer *ring);
95 int (*init)(struct intel_ring_buffer *ring);
97 void (*write_tail)(struct intel_ring_buffer *ring,
99 int __must_check (*flush)(struct intel_ring_buffer *ring,
100 u32 invalidate_domains,
102 int (*add_request)(struct intel_ring_buffer *ring);
103 /* Some chipsets are not quite as coherent as advertised and need
104 * an expensive kick to force a true read of the up-to-date seqno.
105 * However, the up-to-date seqno is not always required and the last
106 * seen value is good enough. Note that the seqno will always be
107 * monotonic, even if not coherent.
109 u32 (*get_seqno)(struct intel_ring_buffer *ring,
110 bool lazy_coherency);
111 void (*set_seqno)(struct intel_ring_buffer *ring,
113 int (*dispatch_execbuffer)(struct intel_ring_buffer *ring,
114 u32 offset, u32 length,
116 #define I915_DISPATCH_SECURE 0x1
117 #define I915_DISPATCH_PINNED 0x2
118 void (*cleanup)(struct intel_ring_buffer *ring);
119 int (*sync_to)(struct intel_ring_buffer *ring,
120 struct intel_ring_buffer *to,
123 /* our mbox written by others */
124 u32 semaphore_register[I915_NUM_RINGS];
125 /* mboxes this ring signals to */
126 u32 signal_mbox[I915_NUM_RINGS];
129 * List of objects currently involved in rendering from the
132 * Includes buffers having the contents of their GPU caches
133 * flushed, not necessarily primitives. last_rendering_seqno
134 * represents when the rendering involved will be completed.
136 * A reference is held on the buffer while on this list.
138 struct list_head active_list;
141 * List of breadcrumbs associated with GPU requests currently
144 struct list_head request_list;
147 * Do we have some not yet emitted requests outstanding?
149 struct drm_i915_gem_request *preallocated_lazy_request;
150 u32 outstanding_lazy_seqno;
151 bool gpu_caches_dirty;
154 wait_queue_head_t irq_queue;
157 * Do an explicit TLB flush before MI_SET_CONTEXT
159 bool itlb_before_ctx_switch;
160 struct i915_hw_context *default_context;
161 struct i915_hw_context *last_context;
163 struct intel_ring_hangcheck hangcheck;
166 struct drm_i915_gem_object *obj;
168 volatile u32 *cpu_page;
172 * Tables of commands the command parser needs to know about
175 const struct drm_i915_cmd_table *cmd_tables;
179 * Table of registers allowed in commands that read/write registers.
181 const u32 *reg_table;
185 * Table of registers allowed in commands that read/write registers, but
186 * only from the DRM master.
188 const u32 *master_reg_table;
189 int master_reg_count;
192 * Returns the bitmask for the length field of the specified command.
193 * Return 0 for an unrecognized/invalid command.
195 * If the command parser finds an entry for a command in the ring's
196 * cmd_tables, it gets the command's length based on the table entry.
197 * If not, it calls this function to determine the per-ring length field
198 * encoding for the command (i.e. certain opcode ranges use certain bits
199 * to encode the command length in the header).
201 u32 (*get_cmd_length_mask)(u32 cmd_header);
205 intel_ring_initialized(struct intel_ring_buffer *ring)
207 return ring->obj != NULL;
210 static inline unsigned
211 intel_ring_flag(struct intel_ring_buffer *ring)
213 return 1 << ring->id;
217 intel_ring_sync_index(struct intel_ring_buffer *ring,
218 struct intel_ring_buffer *other)
223 * cs -> 0 = vcs, 1 = bcs
224 * vcs -> 0 = bcs, 1 = cs,
225 * bcs -> 0 = cs, 1 = vcs.
228 idx = (other - ring) - 1;
230 idx += I915_NUM_RINGS;
236 intel_read_status_page(struct intel_ring_buffer *ring,
239 /* Ensure that the compiler doesn't optimize away the load. */
241 return ring->status_page.page_addr[reg];
245 intel_write_status_page(struct intel_ring_buffer *ring,
248 ring->status_page.page_addr[reg] = value;
252 * Reads a dword out of the status page, which is written to from the command
253 * queue by automatic updates, MI_REPORT_HEAD, MI_STORE_DATA_INDEX, or
256 * The following dwords have a reserved meaning:
257 * 0x00: ISR copy, updated when an ISR bit not set in the HWSTAM changes.
258 * 0x04: ring 0 head pointer
259 * 0x05: ring 1 head pointer (915-class)
260 * 0x06: ring 2 head pointer (915-class)
261 * 0x10-0x1b: Context status DWords (GM45)
262 * 0x1f: Last written status offset. (GM45)
264 * The area from dword 0x20 to 0x3ff is available for driver usage.
266 #define I915_GEM_HWS_INDEX 0x20
267 #define I915_GEM_HWS_SCRATCH_INDEX 0x30
268 #define I915_GEM_HWS_SCRATCH_ADDR (I915_GEM_HWS_SCRATCH_INDEX << MI_STORE_DWORD_INDEX_SHIFT)
270 void intel_cleanup_ring_buffer(struct intel_ring_buffer *ring);
272 int __must_check intel_ring_begin(struct intel_ring_buffer *ring, int n);
273 int __must_check intel_ring_cacheline_align(struct intel_ring_buffer *ring);
274 static inline void intel_ring_emit(struct intel_ring_buffer *ring,
277 iowrite32(data, ring->virtual_start + ring->tail);
280 static inline void intel_ring_advance(struct intel_ring_buffer *ring)
282 ring->tail &= ring->size - 1;
284 void __intel_ring_advance(struct intel_ring_buffer *ring);
286 int __must_check intel_ring_idle(struct intel_ring_buffer *ring);
287 void intel_ring_init_seqno(struct intel_ring_buffer *ring, u32 seqno);
288 int intel_ring_flush_all_caches(struct intel_ring_buffer *ring);
289 int intel_ring_invalidate_all_caches(struct intel_ring_buffer *ring);
291 int intel_init_render_ring_buffer(struct drm_device *dev);
292 int intel_init_bsd_ring_buffer(struct drm_device *dev);
293 int intel_init_blt_ring_buffer(struct drm_device *dev);
294 int intel_init_vebox_ring_buffer(struct drm_device *dev);
296 u64 intel_ring_get_active_head(struct intel_ring_buffer *ring);
297 void intel_ring_setup_status_page(struct intel_ring_buffer *ring);
299 static inline u32 intel_ring_get_tail(struct intel_ring_buffer *ring)
304 static inline u32 intel_ring_get_seqno(struct intel_ring_buffer *ring)
306 BUG_ON(ring->outstanding_lazy_seqno == 0);
307 return ring->outstanding_lazy_seqno;
310 static inline void i915_trace_irq_get(struct intel_ring_buffer *ring, u32 seqno)
312 if (ring->trace_irq_seqno == 0 && ring->irq_get(ring))
313 ring->trace_irq_seqno = seqno;
317 int intel_render_ring_init_dri(struct drm_device *dev, u64 start, u32 size);
319 #endif /* _INTEL_RINGBUFFER_H_ */