2 * Copyright © 2014 Intel Corporation
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:
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
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 DEALINGS
24 #include <linux/firmware.h>
25 #include <linux/circ_buf.h>
27 #include "intel_guc.h"
30 * DOC: GuC-based command submission
33 * We use the term client to avoid confusion with contexts. A i915_guc_client is
34 * equivalent to GuC object guc_context_desc. This context descriptor is
35 * allocated from a pool of 1024 entries. Kernel driver will allocate doorbell
36 * and workqueue for it. Also the process descriptor (guc_process_desc), which
37 * is mapped to client space. So the client can write Work Item then ring the
40 * To simplify the implementation, we allocate one gem object that contains all
41 * pages for doorbell, process descriptor and workqueue.
43 * The Scratch registers:
44 * There are 16 MMIO-based registers start from 0xC180. The kernel driver writes
45 * a value to the action register (SOFT_SCRATCH_0) along with any data. It then
46 * triggers an interrupt on the GuC via another register write (0xC4C8).
47 * Firmware writes a success/fail code back to the action register after
48 * processes the request. The kernel driver polls waiting for this update and
50 * See host2guc_action()
53 * Doorbells are interrupts to uKernel. A doorbell is a single cache line (QW)
54 * mapped into process space.
57 * There are several types of work items that the host may place into a
58 * workqueue, each with its own requirements and limitations. Currently only
59 * WQ_TYPE_INORDER is needed to support legacy submission via GuC, which
60 * represents in-order queue. The kernel driver packs ring tail pointer and an
61 * ELSP context descriptor dword into Work Item.
62 * See guc_add_workqueue_item()
67 * Read GuC command/status register (SOFT_SCRATCH_0)
68 * Return true if it contains a response rather than a command
70 static inline bool host2guc_action_response(struct drm_i915_private
*dev_priv
,
73 u32 val
= I915_READ(SOFT_SCRATCH(0));
75 return GUC2HOST_IS_RESPONSE(val
);
78 static int host2guc_action(struct intel_guc
*guc
, u32
*data
, u32 len
)
80 struct drm_i915_private
*dev_priv
= guc_to_i915(guc
);
85 if (WARN_ON(len
< 1 || len
> 15))
88 intel_uncore_forcewake_get(dev_priv
, FORCEWAKE_ALL
);
90 dev_priv
->guc
.action_count
+= 1;
91 dev_priv
->guc
.action_cmd
= data
[0];
93 for (i
= 0; i
< len
; i
++)
94 I915_WRITE(SOFT_SCRATCH(i
), data
[i
]);
96 POSTING_READ(SOFT_SCRATCH(i
- 1));
98 I915_WRITE(HOST2GUC_INTERRUPT
, HOST2GUC_TRIGGER
);
101 * Fast commands should complete in less than 10us, so sample quickly
102 * up to that length of time, then switch to a slower sleep-wait loop.
103 * No HOST2GUC command should ever take longer than 10ms.
105 ret
= wait_for_us(host2guc_action_response(dev_priv
, &status
), 10);
107 ret
= wait_for(host2guc_action_response(dev_priv
, &status
), 10);
108 if (status
!= GUC2HOST_STATUS_SUCCESS
) {
110 * Either the GuC explicitly returned an error (which
111 * we convert to -EIO here) or no response at all was
112 * received within the timeout limit (-ETIMEDOUT)
114 if (ret
!= -ETIMEDOUT
)
117 DRM_ERROR("GUC: host2guc action 0x%X failed. ret=%d "
118 "status=0x%08X response=0x%08X\n",
119 data
[0], ret
, status
,
120 I915_READ(SOFT_SCRATCH(15)));
122 dev_priv
->guc
.action_fail
+= 1;
123 dev_priv
->guc
.action_err
= ret
;
125 dev_priv
->guc
.action_status
= status
;
127 intel_uncore_forcewake_put(dev_priv
, FORCEWAKE_ALL
);
133 * Tell the GuC to allocate or deallocate a specific doorbell
136 static int host2guc_allocate_doorbell(struct intel_guc
*guc
,
137 struct i915_guc_client
*client
)
141 data
[0] = HOST2GUC_ACTION_ALLOCATE_DOORBELL
;
142 data
[1] = client
->ctx_index
;
144 return host2guc_action(guc
, data
, 2);
147 static int host2guc_release_doorbell(struct intel_guc
*guc
,
148 struct i915_guc_client
*client
)
152 data
[0] = HOST2GUC_ACTION_DEALLOCATE_DOORBELL
;
153 data
[1] = client
->ctx_index
;
155 return host2guc_action(guc
, data
, 2);
158 static int host2guc_sample_forcewake(struct intel_guc
*guc
,
159 struct i915_guc_client
*client
)
161 struct drm_i915_private
*dev_priv
= guc_to_i915(guc
);
164 data
[0] = HOST2GUC_ACTION_SAMPLE_FORCEWAKE
;
165 /* WaRsDisableCoarsePowerGating:skl,bxt */
166 if (!intel_enable_rc6() || NEEDS_WaRsDisableCoarsePowerGating(dev_priv
))
169 /* bit 0 and 1 are for Render and Media domain separately */
170 data
[1] = GUC_FORCEWAKE_RENDER
| GUC_FORCEWAKE_MEDIA
;
172 return host2guc_action(guc
, data
, ARRAY_SIZE(data
));
176 * Initialise, update, or clear doorbell data shared with the GuC
178 * These functions modify shared data and so need access to the mapped
179 * client object which contains the page being used for the doorbell
182 static int guc_update_doorbell_id(struct intel_guc
*guc
,
183 struct i915_guc_client
*client
,
186 struct sg_table
*sg
= guc
->ctx_pool_vma
->pages
;
187 void *doorbell_bitmap
= guc
->doorbell_bitmap
;
188 struct guc_doorbell_info
*doorbell
;
189 struct guc_context_desc desc
;
192 doorbell
= client
->client_base
+ client
->doorbell_offset
;
194 if (client
->doorbell_id
!= GUC_INVALID_DOORBELL_ID
&&
195 test_bit(client
->doorbell_id
, doorbell_bitmap
)) {
196 /* Deactivate the old doorbell */
197 doorbell
->db_status
= GUC_DOORBELL_DISABLED
;
198 (void)host2guc_release_doorbell(guc
, client
);
199 __clear_bit(client
->doorbell_id
, doorbell_bitmap
);
202 /* Update the GuC's idea of the doorbell ID */
203 len
= sg_pcopy_to_buffer(sg
->sgl
, sg
->nents
, &desc
, sizeof(desc
),
204 sizeof(desc
) * client
->ctx_index
);
205 if (len
!= sizeof(desc
))
208 len
= sg_pcopy_from_buffer(sg
->sgl
, sg
->nents
, &desc
, sizeof(desc
),
209 sizeof(desc
) * client
->ctx_index
);
210 if (len
!= sizeof(desc
))
213 client
->doorbell_id
= new_id
;
214 if (new_id
== GUC_INVALID_DOORBELL_ID
)
217 /* Activate the new doorbell */
218 __set_bit(new_id
, doorbell_bitmap
);
219 doorbell
->cookie
= 0;
220 doorbell
->db_status
= GUC_DOORBELL_ENABLED
;
221 return host2guc_allocate_doorbell(guc
, client
);
224 static int guc_init_doorbell(struct intel_guc
*guc
,
225 struct i915_guc_client
*client
,
228 return guc_update_doorbell_id(guc
, client
, db_id
);
231 static void guc_disable_doorbell(struct intel_guc
*guc
,
232 struct i915_guc_client
*client
)
234 (void)guc_update_doorbell_id(guc
, client
, GUC_INVALID_DOORBELL_ID
);
236 /* XXX: wait for any interrupts */
237 /* XXX: wait for workqueue to drain */
241 select_doorbell_register(struct intel_guc
*guc
, uint32_t priority
)
244 * The bitmap tracks which doorbell registers are currently in use.
245 * It is split into two halves; the first half is used for normal
246 * priority contexts, the second half for high-priority ones.
247 * Note that logically higher priorities are numerically less than
248 * normal ones, so the test below means "is it high-priority?"
250 const bool hi_pri
= (priority
<= GUC_CTX_PRIORITY_HIGH
);
251 const uint16_t half
= GUC_MAX_DOORBELLS
/ 2;
252 const uint16_t start
= hi_pri
? half
: 0;
253 const uint16_t end
= start
+ half
;
256 id
= find_next_zero_bit(guc
->doorbell_bitmap
, end
, start
);
258 id
= GUC_INVALID_DOORBELL_ID
;
260 DRM_DEBUG_DRIVER("assigned %s priority doorbell id 0x%x\n",
261 hi_pri
? "high" : "normal", id
);
267 * Select, assign and relase doorbell cachelines
269 * These functions track which doorbell cachelines are in use.
270 * The data they manipulate is protected by the host2guc lock.
273 static uint32_t select_doorbell_cacheline(struct intel_guc
*guc
)
275 const uint32_t cacheline_size
= cache_line_size();
278 /* Doorbell uses a single cache line within a page */
279 offset
= offset_in_page(guc
->db_cacheline
);
281 /* Moving to next cache line to reduce contention */
282 guc
->db_cacheline
+= cacheline_size
;
284 DRM_DEBUG_DRIVER("selected doorbell cacheline 0x%x, next 0x%x, linesize %u\n",
285 offset
, guc
->db_cacheline
, cacheline_size
);
291 * Initialise the process descriptor shared with the GuC firmware.
293 static void guc_init_proc_desc(struct intel_guc
*guc
,
294 struct i915_guc_client
*client
)
296 struct guc_process_desc
*desc
;
298 desc
= client
->client_base
+ client
->proc_desc_offset
;
300 memset(desc
, 0, sizeof(*desc
));
303 * XXX: pDoorbell and WQVBaseAddress are pointers in process address
304 * space for ring3 clients (set them as in mmap_ioctl) or kernel
305 * space for kernel clients (map on demand instead? May make debug
306 * easier to have it mapped).
308 desc
->wq_base_addr
= 0;
309 desc
->db_base_addr
= 0;
311 desc
->context_id
= client
->ctx_index
;
312 desc
->wq_size_bytes
= client
->wq_size
;
313 desc
->wq_status
= WQ_STATUS_ACTIVE
;
314 desc
->priority
= client
->priority
;
318 * Initialise/clear the context descriptor shared with the GuC firmware.
320 * This descriptor tells the GuC where (in GGTT space) to find the important
321 * data structures relating to this client (doorbell, process descriptor,
325 static void guc_init_ctx_desc(struct intel_guc
*guc
,
326 struct i915_guc_client
*client
)
328 struct drm_i915_private
*dev_priv
= guc_to_i915(guc
);
329 struct intel_engine_cs
*engine
;
330 struct i915_gem_context
*ctx
= client
->owner
;
331 struct guc_context_desc desc
;
335 memset(&desc
, 0, sizeof(desc
));
337 desc
.attribute
= GUC_CTX_DESC_ATTR_ACTIVE
| GUC_CTX_DESC_ATTR_KERNEL
;
338 desc
.context_id
= client
->ctx_index
;
339 desc
.priority
= client
->priority
;
340 desc
.db_id
= client
->doorbell_id
;
342 for_each_engine_masked(engine
, dev_priv
, client
->engines
) {
343 struct intel_context
*ce
= &ctx
->engine
[engine
->id
];
344 uint32_t guc_engine_id
= engine
->guc_id
;
345 struct guc_execlist_context
*lrc
= &desc
.lrc
[guc_engine_id
];
347 /* TODO: We have a design issue to be solved here. Only when we
348 * receive the first batch, we know which engine is used by the
349 * user. But here GuC expects the lrc and ring to be pinned. It
350 * is not an issue for default context, which is the only one
351 * for now who owns a GuC client. But for future owner of GuC
352 * client, need to make sure lrc is pinned prior to enter here.
355 break; /* XXX: continue? */
357 lrc
->context_desc
= lower_32_bits(ce
->lrc_desc
);
359 /* The state page is after PPHWSP */
361 i915_ggtt_offset(ce
->state
) + LRC_STATE_PN
* PAGE_SIZE
;
362 lrc
->context_id
= (client
->ctx_index
<< GUC_ELC_CTXID_OFFSET
) |
363 (guc_engine_id
<< GUC_ELC_ENGINE_OFFSET
);
365 lrc
->ring_begin
= i915_ggtt_offset(ce
->ring
->vma
);
366 lrc
->ring_end
= lrc
->ring_begin
+ ce
->ring
->size
- 1;
367 lrc
->ring_next_free_location
= lrc
->ring_begin
;
368 lrc
->ring_current_tail_pointer_value
= 0;
370 desc
.engines_used
|= (1 << guc_engine_id
);
373 DRM_DEBUG_DRIVER("Host engines 0x%x => GuC engines used 0x%x\n",
374 client
->engines
, desc
.engines_used
);
375 WARN_ON(desc
.engines_used
== 0);
378 * The doorbell, process descriptor, and workqueue are all parts
379 * of the client object, which the GuC will reference via the GGTT
381 gfx_addr
= i915_ggtt_offset(client
->vma
);
382 desc
.db_trigger_phy
= sg_dma_address(client
->vma
->pages
->sgl
) +
383 client
->doorbell_offset
;
384 desc
.db_trigger_cpu
= (uintptr_t)client
->client_base
+
385 client
->doorbell_offset
;
386 desc
.db_trigger_uk
= gfx_addr
+ client
->doorbell_offset
;
387 desc
.process_desc
= gfx_addr
+ client
->proc_desc_offset
;
388 desc
.wq_addr
= gfx_addr
+ client
->wq_offset
;
389 desc
.wq_size
= client
->wq_size
;
392 * XXX: Take LRCs from an existing context if this is not an
393 * IsKMDCreatedContext client
395 desc
.desc_private
= (uintptr_t)client
;
397 /* Pool context is pinned already */
398 sg
= guc
->ctx_pool_vma
->pages
;
399 sg_pcopy_from_buffer(sg
->sgl
, sg
->nents
, &desc
, sizeof(desc
),
400 sizeof(desc
) * client
->ctx_index
);
403 static void guc_fini_ctx_desc(struct intel_guc
*guc
,
404 struct i915_guc_client
*client
)
406 struct guc_context_desc desc
;
409 memset(&desc
, 0, sizeof(desc
));
411 sg
= guc
->ctx_pool_vma
->pages
;
412 sg_pcopy_from_buffer(sg
->sgl
, sg
->nents
, &desc
, sizeof(desc
),
413 sizeof(desc
) * client
->ctx_index
);
417 * i915_guc_wq_check_space() - check that the GuC can accept a request
418 * @request: request associated with the commands
420 * Return: 0 if space is available
421 * -EAGAIN if space is not currently available
423 * This function must be called (and must return 0) before a request
424 * is submitted to the GuC via i915_guc_submit() below. Once a result
425 * of 0 has been returned, it remains valid until (but only until)
426 * the next call to submit().
428 * This precheck allows the caller to determine in advance that space
429 * will be available for the next submission before committing resources
430 * to it, and helps avoid late failures with complicated recovery paths.
432 int i915_guc_wq_check_space(struct drm_i915_gem_request
*request
)
434 const size_t wqi_size
= sizeof(struct guc_wq_item
);
435 struct i915_guc_client
*gc
= request
->i915
->guc
.execbuf_client
;
436 struct guc_process_desc
*desc
;
439 GEM_BUG_ON(gc
== NULL
);
441 desc
= gc
->client_base
+ gc
->proc_desc_offset
;
443 freespace
= CIRC_SPACE(gc
->wq_tail
, desc
->head
, gc
->wq_size
);
444 if (likely(freespace
>= wqi_size
))
447 gc
->no_wq_space
+= 1;
452 static void guc_add_workqueue_item(struct i915_guc_client
*gc
,
453 struct drm_i915_gem_request
*rq
)
455 /* wqi_len is in DWords, and does not include the one-word header */
456 const size_t wqi_size
= sizeof(struct guc_wq_item
);
457 const u32 wqi_len
= wqi_size
/sizeof(u32
) - 1;
458 struct intel_engine_cs
*engine
= rq
->engine
;
459 struct guc_process_desc
*desc
;
460 struct guc_wq_item
*wqi
;
462 u32 freespace
, tail
, wq_off
, wq_page
;
464 desc
= gc
->client_base
+ gc
->proc_desc_offset
;
466 /* Free space is guaranteed, see i915_guc_wq_check_space() above */
467 freespace
= CIRC_SPACE(gc
->wq_tail
, desc
->head
, gc
->wq_size
);
468 GEM_BUG_ON(freespace
< wqi_size
);
470 /* The GuC firmware wants the tail index in QWords, not bytes */
472 GEM_BUG_ON(tail
& 7);
474 GEM_BUG_ON(tail
> WQ_RING_TAIL_MAX
);
476 /* For now workqueue item is 4 DWs; workqueue buffer is 2 pages. So we
477 * should not have the case where structure wqi is across page, neither
478 * wrapped to the beginning. This simplifies the implementation below.
480 * XXX: if not the case, we need save data to a temp wqi and copy it to
481 * workqueue buffer dw by dw.
483 BUILD_BUG_ON(wqi_size
!= 16);
485 /* postincrement WQ tail for next time */
486 wq_off
= gc
->wq_tail
;
487 gc
->wq_tail
+= wqi_size
;
488 gc
->wq_tail
&= gc
->wq_size
- 1;
489 GEM_BUG_ON(wq_off
& (wqi_size
- 1));
491 /* WQ starts from the page after doorbell / process_desc */
492 wq_page
= (wq_off
+ GUC_DB_SIZE
) >> PAGE_SHIFT
;
493 wq_off
&= PAGE_SIZE
- 1;
494 base
= kmap_atomic(i915_gem_object_get_page(gc
->vma
->obj
, wq_page
));
495 wqi
= (struct guc_wq_item
*)((char *)base
+ wq_off
);
497 /* Now fill in the 4-word work queue item */
498 wqi
->header
= WQ_TYPE_INORDER
|
499 (wqi_len
<< WQ_LEN_SHIFT
) |
500 (engine
->guc_id
<< WQ_TARGET_SHIFT
) |
503 /* The GuC wants only the low-order word of the context descriptor */
504 wqi
->context_desc
= (u32
)intel_lr_context_descriptor(rq
->ctx
, engine
);
506 wqi
->ring_tail
= tail
<< WQ_RING_TAIL_SHIFT
;
507 wqi
->fence_id
= rq
->fence
.seqno
;
512 static int guc_ring_doorbell(struct i915_guc_client
*gc
)
514 struct guc_process_desc
*desc
;
515 union guc_doorbell_qw db_cmp
, db_exc
, db_ret
;
516 union guc_doorbell_qw
*db
;
517 int attempt
= 2, ret
= -EAGAIN
;
519 desc
= gc
->client_base
+ gc
->proc_desc_offset
;
521 /* Update the tail so it is visible to GuC */
522 desc
->tail
= gc
->wq_tail
;
525 db_cmp
.db_status
= GUC_DOORBELL_ENABLED
;
526 db_cmp
.cookie
= gc
->cookie
;
528 /* cookie to be updated */
529 db_exc
.db_status
= GUC_DOORBELL_ENABLED
;
530 db_exc
.cookie
= gc
->cookie
+ 1;
531 if (db_exc
.cookie
== 0)
534 /* pointer of current doorbell cacheline */
535 db
= gc
->client_base
+ gc
->doorbell_offset
;
538 /* lets ring the doorbell */
539 db_ret
.value_qw
= atomic64_cmpxchg((atomic64_t
*)db
,
540 db_cmp
.value_qw
, db_exc
.value_qw
);
542 /* if the exchange was successfully executed */
543 if (db_ret
.value_qw
== db_cmp
.value_qw
) {
544 /* db was successfully rung */
545 gc
->cookie
= db_exc
.cookie
;
550 /* XXX: doorbell was lost and need to acquire it again */
551 if (db_ret
.db_status
== GUC_DOORBELL_DISABLED
)
554 DRM_ERROR("Cookie mismatch. Expected %d, returned %d\n",
555 db_cmp
.cookie
, db_ret
.cookie
);
557 /* update the cookie to newly read cookie from GuC */
558 db_cmp
.cookie
= db_ret
.cookie
;
559 db_exc
.cookie
= db_ret
.cookie
+ 1;
560 if (db_exc
.cookie
== 0)
568 * i915_guc_submit() - Submit commands through GuC
569 * @rq: request associated with the commands
571 * Return: 0 on success, otherwise an errno.
572 * (Note: nonzero really shouldn't happen!)
574 * The caller must have already called i915_guc_wq_check_space() above
575 * with a result of 0 (success) since the last request submission. This
576 * guarantees that there is space in the work queue for the new request,
577 * so enqueuing the item cannot fail.
579 * Bad Things Will Happen if the caller violates this protocol e.g. calls
580 * submit() when check() says there's no space, or calls submit() multiple
581 * times with no intervening check().
583 * The only error here arises if the doorbell hardware isn't functioning
584 * as expected, which really shouln't happen.
586 static void i915_guc_submit(struct drm_i915_gem_request
*rq
)
588 unsigned int engine_id
= rq
->engine
->id
;
589 struct intel_guc
*guc
= &rq
->i915
->guc
;
590 struct i915_guc_client
*client
= guc
->execbuf_client
;
593 guc_add_workqueue_item(client
, rq
);
594 b_ret
= guc_ring_doorbell(client
);
596 client
->submissions
[engine_id
] += 1;
597 client
->retcode
= b_ret
;
601 guc
->submissions
[engine_id
] += 1;
602 guc
->last_seqno
[engine_id
] = rq
->fence
.seqno
;
606 * Everything below here is concerned with setup & teardown, and is
607 * therefore not part of the somewhat time-critical batch-submission
608 * path of i915_guc_submit() above.
612 * guc_allocate_vma() - Allocate a GGTT VMA for GuC usage
614 * @size: size of area to allocate (both virtual space and memory)
616 * This is a wrapper to create an object for use with the GuC. In order to
617 * use it inside the GuC, an object needs to be pinned lifetime, so we allocate
618 * both some backing storage and a range inside the Global GTT. We must pin
619 * it in the GGTT somewhere other than than [0, GUC_WOPCM_TOP) because that
620 * range is reserved inside GuC.
622 * Return: A i915_vma if successful, otherwise an ERR_PTR.
624 static struct i915_vma
*guc_allocate_vma(struct intel_guc
*guc
, u32 size
)
626 struct drm_i915_private
*dev_priv
= guc_to_i915(guc
);
627 struct drm_i915_gem_object
*obj
;
628 struct i915_vma
*vma
;
631 obj
= i915_gem_object_create(&dev_priv
->drm
, size
);
633 return ERR_CAST(obj
);
635 vma
= i915_vma_create(obj
, &dev_priv
->ggtt
.base
, NULL
);
639 ret
= i915_vma_pin(vma
, 0, PAGE_SIZE
,
640 PIN_GLOBAL
| PIN_OFFSET_BIAS
| GUC_WOPCM_TOP
);
646 /* Invalidate GuC TLB to let GuC take the latest updates to GTT. */
647 I915_WRITE(GEN8_GTCR
, GEN8_GTCR_INVALIDATE
);
652 i915_gem_object_put(obj
);
657 guc_client_free(struct drm_i915_private
*dev_priv
,
658 struct i915_guc_client
*client
)
660 struct intel_guc
*guc
= &dev_priv
->guc
;
666 * XXX: wait for any outstanding submissions before freeing memory.
667 * Be sure to drop any locks
670 if (client
->client_base
) {
672 * If we got as far as setting up a doorbell, make sure we
673 * shut it down before unmapping & deallocating the memory.
675 guc_disable_doorbell(guc
, client
);
677 kunmap(kmap_to_page(client
->client_base
));
680 i915_vma_unpin_and_release(&client
->vma
);
682 if (client
->ctx_index
!= GUC_INVALID_CTX_ID
) {
683 guc_fini_ctx_desc(guc
, client
);
684 ida_simple_remove(&guc
->ctx_ids
, client
->ctx_index
);
690 /* Check that a doorbell register is in the expected state */
691 static bool guc_doorbell_check(struct intel_guc
*guc
, uint16_t db_id
)
693 struct drm_i915_private
*dev_priv
= guc_to_i915(guc
);
694 i915_reg_t drbreg
= GEN8_DRBREGL(db_id
);
695 uint32_t value
= I915_READ(drbreg
);
696 bool enabled
= (value
& GUC_DOORBELL_ENABLED
) != 0;
697 bool expected
= test_bit(db_id
, guc
->doorbell_bitmap
);
699 if (enabled
== expected
)
702 DRM_DEBUG_DRIVER("Doorbell %d (reg 0x%x) 0x%x, should be %s\n",
703 db_id
, drbreg
.reg
, value
,
704 expected
? "active" : "inactive");
710 * Borrow the first client to set up & tear down each unused doorbell
711 * in turn, to ensure that all doorbell h/w is (re)initialised.
713 static void guc_init_doorbell_hw(struct intel_guc
*guc
)
715 struct i915_guc_client
*client
= guc
->execbuf_client
;
719 /* Save client's original doorbell selection */
720 db_id
= client
->doorbell_id
;
722 for (i
= 0; i
< GUC_MAX_DOORBELLS
; ++i
) {
723 /* Skip if doorbell is OK */
724 if (guc_doorbell_check(guc
, i
))
727 err
= guc_update_doorbell_id(guc
, client
, i
);
729 DRM_DEBUG_DRIVER("Doorbell %d update failed, err %d\n",
733 /* Restore to original value */
734 err
= guc_update_doorbell_id(guc
, client
, db_id
);
736 DRM_ERROR("Failed to restore doorbell to %d, err %d\n",
739 /* Read back & verify all doorbell registers */
740 for (i
= 0; i
< GUC_MAX_DOORBELLS
; ++i
)
741 (void)guc_doorbell_check(guc
, i
);
745 * guc_client_alloc() - Allocate an i915_guc_client
746 * @dev_priv: driver private data structure
747 * @engines: The set of engines to enable for this client
748 * @priority: four levels priority _CRITICAL, _HIGH, _NORMAL and _LOW
749 * The kernel client to replace ExecList submission is created with
750 * NORMAL priority. Priority of a client for scheduler can be HIGH,
751 * while a preemption context can use CRITICAL.
752 * @ctx: the context that owns the client (we use the default render
755 * Return: An i915_guc_client object if success, else NULL.
757 static struct i915_guc_client
*
758 guc_client_alloc(struct drm_i915_private
*dev_priv
,
761 struct i915_gem_context
*ctx
)
763 struct i915_guc_client
*client
;
764 struct intel_guc
*guc
= &dev_priv
->guc
;
765 struct i915_vma
*vma
;
768 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
774 client
->engines
= engines
;
775 client
->priority
= priority
;
776 client
->doorbell_id
= GUC_INVALID_DOORBELL_ID
;
778 client
->ctx_index
= (uint32_t)ida_simple_get(&guc
->ctx_ids
, 0,
779 GUC_MAX_GPU_CONTEXTS
, GFP_KERNEL
);
780 if (client
->ctx_index
>= GUC_MAX_GPU_CONTEXTS
) {
781 client
->ctx_index
= GUC_INVALID_CTX_ID
;
785 /* The first page is doorbell/proc_desc. Two followed pages are wq. */
786 vma
= guc_allocate_vma(guc
, GUC_DB_SIZE
+ GUC_WQ_SIZE
);
790 /* We'll keep just the first (doorbell/proc) page permanently kmap'd. */
792 client
->client_base
= kmap(i915_vma_first_page(vma
));
793 client
->wq_offset
= GUC_DB_SIZE
;
794 client
->wq_size
= GUC_WQ_SIZE
;
796 db_id
= select_doorbell_register(guc
, client
->priority
);
797 if (db_id
== GUC_INVALID_DOORBELL_ID
)
798 /* XXX: evict a doorbell instead? */
801 client
->doorbell_offset
= select_doorbell_cacheline(guc
);
804 * Since the doorbell only requires a single cacheline, we can save
805 * space by putting the application process descriptor in the same
806 * page. Use the half of the page that doesn't include the doorbell.
808 if (client
->doorbell_offset
>= (GUC_DB_SIZE
/ 2))
809 client
->proc_desc_offset
= 0;
811 client
->proc_desc_offset
= (GUC_DB_SIZE
/ 2);
813 guc_init_proc_desc(guc
, client
);
814 guc_init_ctx_desc(guc
, client
);
815 if (guc_init_doorbell(guc
, client
, db_id
))
818 DRM_DEBUG_DRIVER("new priority %u client %p for engine(s) 0x%x: ctx_index %u\n",
819 priority
, client
, client
->engines
, client
->ctx_index
);
820 DRM_DEBUG_DRIVER("doorbell id %u, cacheline offset 0x%x\n",
821 client
->doorbell_id
, client
->doorbell_offset
);
826 DRM_ERROR("FAILED to create priority %u GuC client!\n", priority
);
828 guc_client_free(dev_priv
, client
);
832 static void guc_create_log(struct intel_guc
*guc
)
834 struct i915_vma
*vma
;
835 unsigned long offset
;
836 uint32_t size
, flags
;
838 if (i915
.guc_log_level
< GUC_LOG_VERBOSITY_MIN
)
841 if (i915
.guc_log_level
> GUC_LOG_VERBOSITY_MAX
)
842 i915
.guc_log_level
= GUC_LOG_VERBOSITY_MAX
;
844 /* The first page is to save log buffer state. Allocate one
845 * extra page for others in case for overlap */
846 size
= (1 + GUC_LOG_DPC_PAGES
+ 1 +
847 GUC_LOG_ISR_PAGES
+ 1 +
848 GUC_LOG_CRASH_PAGES
+ 1) << PAGE_SHIFT
;
852 vma
= guc_allocate_vma(guc
, size
);
854 /* logging will be off */
855 i915
.guc_log_level
= -1;
862 /* each allocated unit is a page */
863 flags
= GUC_LOG_VALID
| GUC_LOG_NOTIFY_ON_HALF_FULL
|
864 (GUC_LOG_DPC_PAGES
<< GUC_LOG_DPC_SHIFT
) |
865 (GUC_LOG_ISR_PAGES
<< GUC_LOG_ISR_SHIFT
) |
866 (GUC_LOG_CRASH_PAGES
<< GUC_LOG_CRASH_SHIFT
);
868 offset
= i915_ggtt_offset(vma
) >> PAGE_SHIFT
; /* in pages */
869 guc
->log_flags
= (offset
<< GUC_LOG_BUF_ADDR_SHIFT
) | flags
;
872 static void init_guc_policies(struct guc_policies
*policies
)
874 struct guc_policy
*policy
;
877 policies
->dpc_promote_time
= 500000;
878 policies
->max_num_work_items
= POLICY_MAX_NUM_WI
;
880 for (p
= 0; p
< GUC_CTX_PRIORITY_NUM
; p
++) {
881 for (i
= GUC_RENDER_ENGINE
; i
< GUC_MAX_ENGINES_NUM
; i
++) {
882 policy
= &policies
->policy
[p
][i
];
884 policy
->execution_quantum
= 1000000;
885 policy
->preemption_time
= 500000;
886 policy
->fault_time
= 250000;
887 policy
->policy_flags
= 0;
891 policies
->is_valid
= 1;
894 static void guc_create_ads(struct intel_guc
*guc
)
896 struct drm_i915_private
*dev_priv
= guc_to_i915(guc
);
897 struct i915_vma
*vma
;
899 struct guc_policies
*policies
;
900 struct guc_mmio_reg_state
*reg_state
;
901 struct intel_engine_cs
*engine
;
905 /* The ads obj includes the struct itself and buffers passed to GuC */
906 size
= sizeof(struct guc_ads
) + sizeof(struct guc_policies
) +
907 sizeof(struct guc_mmio_reg_state
) +
908 GUC_S3_SAVE_SPACE_PAGES
* PAGE_SIZE
;
912 vma
= guc_allocate_vma(guc
, PAGE_ALIGN(size
));
919 page
= i915_vma_first_page(vma
);
923 * The GuC requires a "Golden Context" when it reinitialises
924 * engines after a reset. Here we use the Render ring default
925 * context, which must already exist and be pinned in the GGTT,
926 * so its address won't change after we've told the GuC where
929 engine
= &dev_priv
->engine
[RCS
];
930 ads
->golden_context_lrca
= engine
->status_page
.ggtt_offset
;
932 for_each_engine(engine
, dev_priv
)
933 ads
->eng_state_size
[engine
->guc_id
] = intel_lr_context_size(engine
);
935 /* GuC scheduling policies */
936 policies
= (void *)ads
+ sizeof(struct guc_ads
);
937 init_guc_policies(policies
);
939 ads
->scheduler_policies
=
940 i915_ggtt_offset(vma
) + sizeof(struct guc_ads
);
943 reg_state
= (void *)policies
+ sizeof(struct guc_policies
);
945 for_each_engine(engine
, dev_priv
) {
946 reg_state
->mmio_white_list
[engine
->guc_id
].mmio_start
=
947 engine
->mmio_base
+ GUC_MMIO_WHITE_LIST_START
;
949 /* Nothing to be saved or restored for now. */
950 reg_state
->mmio_white_list
[engine
->guc_id
].count
= 0;
953 ads
->reg_state_addr
= ads
->scheduler_policies
+
954 sizeof(struct guc_policies
);
956 ads
->reg_state_buffer
= ads
->reg_state_addr
+
957 sizeof(struct guc_mmio_reg_state
);
963 * Set up the memory resources to be shared with the GuC. At this point,
964 * we require just one object that can be mapped through the GGTT.
966 int i915_guc_submission_init(struct drm_i915_private
*dev_priv
)
968 struct intel_guc
*guc
= &dev_priv
->guc
;
969 struct i915_vma
*vma
;
972 /* Wipe bitmap & delete client in case of reinitialisation */
973 bitmap_clear(guc
->doorbell_bitmap
, 0, GUC_MAX_DOORBELLS
);
974 i915_guc_submission_disable(dev_priv
);
976 if (!i915
.enable_guc_submission
)
977 return 0; /* not enabled */
979 if (guc
->ctx_pool_vma
)
980 return 0; /* already allocated */
982 size
= PAGE_ALIGN(GUC_MAX_GPU_CONTEXTS
*sizeof(struct guc_context_desc
));
983 vma
= guc_allocate_vma(guc
, size
);
987 guc
->ctx_pool_vma
= vma
;
988 ida_init(&guc
->ctx_ids
);
995 int i915_guc_submission_enable(struct drm_i915_private
*dev_priv
)
997 struct intel_guc
*guc
= &dev_priv
->guc
;
998 struct i915_guc_client
*client
;
999 struct intel_engine_cs
*engine
;
1001 /* client for execbuf submission */
1002 client
= guc_client_alloc(dev_priv
,
1003 INTEL_INFO(dev_priv
)->ring_mask
,
1004 GUC_CTX_PRIORITY_KMD_NORMAL
,
1005 dev_priv
->kernel_context
);
1007 DRM_ERROR("Failed to create execbuf guc_client\n");
1011 guc
->execbuf_client
= client
;
1012 host2guc_sample_forcewake(guc
, client
);
1013 guc_init_doorbell_hw(guc
);
1015 /* Take over from manual control of ELSP (execlists) */
1016 for_each_engine(engine
, dev_priv
)
1017 engine
->submit_request
= i915_guc_submit
;
1022 void i915_guc_submission_disable(struct drm_i915_private
*dev_priv
)
1024 struct intel_guc
*guc
= &dev_priv
->guc
;
1026 if (!guc
->execbuf_client
)
1029 /* Revert back to manual ELSP submission */
1030 intel_execlists_enable_submission(dev_priv
);
1032 guc_client_free(dev_priv
, guc
->execbuf_client
);
1033 guc
->execbuf_client
= NULL
;
1036 void i915_guc_submission_fini(struct drm_i915_private
*dev_priv
)
1038 struct intel_guc
*guc
= &dev_priv
->guc
;
1040 i915_vma_unpin_and_release(&guc
->ads_vma
);
1041 i915_vma_unpin_and_release(&guc
->log_vma
);
1043 if (guc
->ctx_pool_vma
)
1044 ida_destroy(&guc
->ctx_ids
);
1045 i915_vma_unpin_and_release(&guc
->ctx_pool_vma
);
1049 * intel_guc_suspend() - notify GuC entering suspend state
1052 int intel_guc_suspend(struct drm_device
*dev
)
1054 struct drm_i915_private
*dev_priv
= to_i915(dev
);
1055 struct intel_guc
*guc
= &dev_priv
->guc
;
1056 struct i915_gem_context
*ctx
;
1059 if (guc
->guc_fw
.guc_fw_load_status
!= GUC_FIRMWARE_SUCCESS
)
1062 ctx
= dev_priv
->kernel_context
;
1064 data
[0] = HOST2GUC_ACTION_ENTER_S_STATE
;
1065 /* any value greater than GUC_POWER_D0 */
1066 data
[1] = GUC_POWER_D1
;
1067 /* first page is shared data with GuC */
1068 data
[2] = i915_ggtt_offset(ctx
->engine
[RCS
].state
);
1070 return host2guc_action(guc
, data
, ARRAY_SIZE(data
));
1075 * intel_guc_resume() - notify GuC resuming from suspend state
1078 int intel_guc_resume(struct drm_device
*dev
)
1080 struct drm_i915_private
*dev_priv
= to_i915(dev
);
1081 struct intel_guc
*guc
= &dev_priv
->guc
;
1082 struct i915_gem_context
*ctx
;
1085 if (guc
->guc_fw
.guc_fw_load_status
!= GUC_FIRMWARE_SUCCESS
)
1088 ctx
= dev_priv
->kernel_context
;
1090 data
[0] = HOST2GUC_ACTION_EXIT_S_STATE
;
1091 data
[1] = GUC_POWER_D0
;
1092 /* first page is shared data with GuC */
1093 data
[2] = i915_ggtt_offset(ctx
->engine
[RCS
].state
);
1095 return host2guc_action(guc
, data
, ARRAY_SIZE(data
));