id
stringlengths
4
63
text
stringlengths
153
8.81M
xe_info_printer(9)
NAME xe_info_printer - Construct a &drm_printer that outputs to xe_info() SYNOPSIS struct drm_printer xe_info_printer (struct xe_device *xe ); ARGUMENTS xe the xe_device pointer to use in xe_info RETURN The drm_printer object. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_printk.h xe_err_printer(9), xe_dbg_...
xe_is_xe_file(9)
NAME xe_is_xe_file - Is the file an xe device file? SYNOPSIS bool xe_is_xe_file (const struct file *file ); ARGUMENTS file The file. DESCRIPTION Checks whether the file is opened against an xe device. RETURN true if an xe file, false if not. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_device.c xe_f...
xe_kunit_helper_alloc_xe_device(9)
NAME xe_kunit_helper_alloc_xe_device - Allocate a &xe_device for a KUnit test. SYNOPSIS struct xe_device * xe_kunit_helper_alloc_xe_device (struct kunit *test , struct device *dev ); ARGUMENTS test the kunit where this xe_device will be used dev The parent device object DESCRIPTION This funct...
xe_kunit_helper_xe_device_live_test_init(9)
NAME xe_kunit_helper_xe_device_live_test_init - Prepare a &xe_device for use in a live KUnit test. SYNOPSIS int xe_kunit_helper_xe_device_live_test_init (struct kunit *test ); ARGUMENTS test the kunit where live xe_device will be used DESCRIPTION This function expects pointer to the xe_device in the test....
xe_kunit_helper_xe_device_test_init(9)
NAME xe_kunit_helper_xe_device_test_init - Prepare a &xe_device for a KUnit test. SYNOPSIS int xe_kunit_helper_xe_device_test_init (struct kunit *test ); ARGUMENTS test the kunit where this fake xe_device will be used DESCRIPTION This function allocates and initializes a fake xe_device and stores its pointe...
xe_late_bind_init(9)
NAME xe_late_bind_init - add xe mei late binding component SYNOPSIS int xe_late_bind_init (struct xe_late_bind *late_bind ); ARGUMENTS late_bind pointer to late bind structure. RETURN 0 if the initialization was successful, a negative errno otherwise. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_late_bind_fw.c A...
xe_lmtt_drop_pages(9)
NAME xe_lmtt_drop_pages - Remove VF's LMTT Pages. SYNOPSIS void xe_lmtt_drop_pages (struct xe_lmtt *lmtt , unsigned int vfid ); ARGUMENTS lmtt the xe_lmtt to update vfid the VF identifier (1-based) DESCRIPTION This function removes all LMTT Page Tables prepared by xe_lmtt_prepare_pages. This f...
xe_lmtt_estimate_pt_size(9)
NAME xe_lmtt_estimate_pt_size - Estimate size of LMTT PT allocations. SYNOPSIS u64 xe_lmtt_estimate_pt_size (struct xe_lmtt *lmtt , u64 size ); ARGUMENTS lmtt the xe_lmtt size the size of the LMEM to be mapped over LMTT (including any offset) DESCRIPTION This function shall be called only by PF...
xe_lmtt_init(9)
NAME xe_lmtt_init - LMTT software initialization. SYNOPSIS int xe_lmtt_init (struct xe_lmtt *lmtt ); ARGUMENTS lmtt the xe_lmtt to initialize DESCRIPTION The LMTT initialization requires two steps. The xe_lmtt_init checks if LMTT is required on current device and selects and initialize proper variant of the...
xe_lmtt_init_hw(9)
NAME xe_lmtt_init_hw - Perform LMTT hardware initialization. SYNOPSIS void xe_lmtt_init_hw (struct xe_lmtt *lmtt ); ARGUMENTS lmtt the xe_lmtt to initialize DESCRIPTION This function is a second step of the LMTT initialization. This function registers LMTT Root Directory prepared in xe_lmtt_init. This fun...
xe_lmtt_invalidate_hw(9)
NAME xe_lmtt_invalidate_hw - Invalidate LMTT hardware. SYNOPSIS void xe_lmtt_invalidate_hw (struct xe_lmtt *lmtt ); ARGUMENTS lmtt the xe_lmtt to invalidate DESCRIPTION Send requests to all GuCs on this tile to invalidate all TLBs. If the platform has a standalone MERT, also invalidate MERT's TLB. This func...
xe_lmtt_populate_pages(9)
NAME xe_lmtt_populate_pages - Update VF's LMTT Page Table Entries. SYNOPSIS int xe_lmtt_populate_pages (struct xe_lmtt *lmtt , unsigned int vfid , struct xe_bo *bo , u64 offset ); ARGUMENTS lmtt the xe_lmtt to update vfid the VF identifier (1-based) bo the buffer object with LME...
xe_lmtt_prepare_pages(9)
NAME xe_lmtt_prepare_pages - Create VF's LMTT Page Tables. SYNOPSIS int xe_lmtt_prepare_pages (struct xe_lmtt *lmtt , unsigned int vfid , u64 range ); ARGUMENTS lmtt the xe_lmtt to update vfid the VF identifier (1-based) range top range of LMEM offset to be supported DESCRIPTION T...
xe_lrc_alloc_seqno_fence(9)
NAME xe_lrc_alloc_seqno_fence - Allocate an lrc seqno fence. SYNOPSIS struct dma_fence * xe_lrc_alloc_seqno_fence (void ); ARGUMENTS void no arguments DESCRIPTION Allocate but don't initialize an lrc seqno fence. RETURN Pointer to the allocated fence or negative error pointer on error. SEE ALSO Kernel fil...
xe_lrc_create(9)
NAME xe_lrc_create - Create a LRC SYNOPSIS struct xe_lrc * xe_lrc_create (struct xe_hw_engine *hwe , struct xe_vm *vm , void *replay_state , u32 ring_size , u16 msix_vec , u32 flags ); ARGUMENTS hwe Hardware Engine vm The VM (address space) replay_state GPU hang rep...
xe_lrc_ctx_job_timestamp(9)
NAME xe_lrc_ctx_job_timestamp - Read ctx job timestamp value SYNOPSIS u32 xe_lrc_ctx_job_timestamp (struct xe_lrc *lrc ); ARGUMENTS lrc Pointer to the lrc. RETURN ctx timestamp job value SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_replay_size(9), xe_lrc_reg_size(9), xe_lrc_ctx_ti...
xe_lrc_ctx_job_timestamp_ggtt_addr(9)
NAME xe_lrc_ctx_job_timestamp_ggtt_addr - Get ctx job timestamp GGTT address SYNOPSIS u32 xe_lrc_ctx_job_timestamp_ggtt_addr (struct xe_lrc *lrc ); ARGUMENTS lrc Pointer to the lrc. RETURN ctx timestamp job GGTT address SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_replay_size(9), xe_lr...
xe_lrc_ctx_timestamp(9)
NAME xe_lrc_ctx_timestamp - Read ctx timestamp value SYNOPSIS u64 xe_lrc_ctx_timestamp (struct xe_lrc *lrc ); ARGUMENTS lrc Pointer to the lrc. RETURN ctx timestamp value SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_replay_size(9), xe_lrc_reg_size(9), xe_lrc_ctx_timestamp_gg...
xe_lrc_ctx_timestamp_ggtt_addr(9)
NAME xe_lrc_ctx_timestamp_ggtt_addr - Get ctx timestamp GGTT address SYNOPSIS u32 xe_lrc_ctx_timestamp_ggtt_addr (struct xe_lrc *lrc ); ARGUMENTS lrc Pointer to the lrc. RETURN ctx timestamp GGTT address SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_replay_size(9), xe_lrc_reg_size(9)...
xe_lrc_ctx_timestamp_udw_ggtt_addr(9)
NAME xe_lrc_ctx_timestamp_udw_ggtt_addr - Get ctx timestamp udw GGTT address SYNOPSIS u32 xe_lrc_ctx_timestamp_udw_ggtt_addr (struct xe_lrc *lrc ); ARGUMENTS lrc Pointer to the lrc. RETURN ctx timestamp udw GGTT address SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_replay_size(9), xe_lr...
xe_lrc_destroy(9)
NAME xe_lrc_destroy - Destroy the LRC SYNOPSIS void xe_lrc_destroy (struct kref *ref ); ARGUMENTS ref reference to LRC DESCRIPTION Called when ref == 0, release resources held by the Logical Ring Context (LRC) and free the LRC memory. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_rep...
xe_lrc_engine_id(9)
NAME xe_lrc_engine_id - Read engine id value SYNOPSIS u32 xe_lrc_engine_id (struct xe_lrc *lrc ); ARGUMENTS lrc Pointer to the lrc. RETURN context id value SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_replay_size(9), xe_lrc_reg_size(9), xe_lrc_ctx_timestamp_ggtt_addr(9), xe_lrc_c...
xe_lrc_free_seqno_fence(9)
NAME xe_lrc_free_seqno_fence - Free an lrc seqno fence. SYNOPSIS void xe_lrc_free_seqno_fence (struct dma_fence *fence ); ARGUMENTS fence Pointer to the fence to free. DESCRIPTION Frees an lrc seqno fence that hasn't yet been initialized. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_r...
xe_lrc_get(9)
NAME xe_lrc_get - Get reference to the LRC SYNOPSIS struct xe_lrc * xe_lrc_get (struct xe_lrc *lrc ); ARGUMENTS lrc Logical Ring Context DESCRIPTION Increment reference count of lrc SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.h xe_lrc_put(9), xe_lrc_ring_size(9), xe_lrc_update_timestamp(9) April 2026 ...
xe_lrc_init_seqno_fence(9)
NAME xe_lrc_init_seqno_fence - Initialize an lrc seqno fence. SYNOPSIS void xe_lrc_init_seqno_fence (struct xe_lrc *lrc , struct dma_fence *fence ); ARGUMENTS lrc Pointer to the lrc. fence Pointer to the fence to initialize. DESCRIPTION Initializes a pre-allocated lrc seqno fence. After initia...
xe_lrc_put(9)
NAME xe_lrc_put - Put reference of the LRC SYNOPSIS void xe_lrc_put (struct xe_lrc *lrc ); ARGUMENTS lrc Logical Ring Context DESCRIPTION Decrement reference count of lrc, call xe_lrc_destroy when reference count reaches 0. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.h xe_lrc_get(9), xe_lrc_ring_size(9...
xe_lrc_reg_size(9)
NAME xe_lrc_reg_size - Get size of the LRC registers area within queues SYNOPSIS size_t xe_lrc_reg_size (struct xe_device *xe ); ARGUMENTS xe the xe_device struct instance RETURN Size of the LRC registers area for current platform SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_repl...
xe_lrc_ring_is_idle(9)
NAME xe_lrc_ring_is_idle - LRC is idle SYNOPSIS bool xe_lrc_ring_is_idle (struct xe_lrc *lrc ); ARGUMENTS lrc Pointer to the lrc. DESCRIPTION Compare LRC ring head and tail to determine if idle. RETURN True is ring is idle, False otherwise SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_ha...
xe_lrc_ring_size(9)
NAME xe_lrc_ring_size - Xe LRC ring size SYNOPSIS size_t xe_lrc_ring_size (void ); ARGUMENTS void no arguments RETURN Size of LRC ring buffer SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.h xe_lrc_get(9), xe_lrc_put(9), xe_lrc_update_timestamp(9) April 2026 ...
xe_lrc_set_multi_queue_priority(9)
NAME xe_lrc_set_multi_queue_priority - Set multi queue priority in LRC SYNOPSIS void xe_lrc_set_multi_queue_priority (struct xe_lrc *lrc , enum xe_multi_queue_priority priority ); ARGUMENTS lrc Logical Ring Context priority Multi queue priority of the exec queue DESCRIPTION Convert priority to LRC...
xe_lrc_setup_wa_bb_with_scratch(9)
NAME xe_lrc_setup_wa_bb_with_scratch - Execute all wa bb setup callbacks. SYNOPSIS int xe_lrc_setup_wa_bb_with_scratch (struct xe_lrc *lrc , struct xe_hw_engine *hwe , u32 *scratch ); ARGUMENTS lrc the xe_lrc struct instance hwe the xe_hw_engine struct instance scratch preallocated...
xe_lrc_timestamp(9)
NAME xe_lrc_timestamp - Current ctx timestamp SYNOPSIS u64 xe_lrc_timestamp (struct xe_lrc *lrc ); ARGUMENTS lrc Pointer to the lrc. DESCRIPTION Return latest ctx timestamp. With support for active contexts, the calculation may be slightly racy, so follow a read-again logic to ensure that the context is stil...
xe_lrc_update_hwctx_regs_with_address(9)
NAME xe_lrc_update_hwctx_regs_with_address - Re-compute GGTT references within given LRC. SYNOPSIS void xe_lrc_update_hwctx_regs_with_address (struct xe_lrc *lrc ); ARGUMENTS lrc the xe_lrc struct instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_lrc.c xe_gt_lrc_hang_replay_size(9), xe_lrc_reg_size(...
xe_lrc_update_memirq_regs_with_address(9)
NAME xe_lrc_update_memirq_regs_with_address - Re-compute GGTT references in mem interrupt data for given LRC. SYNOPSIS void xe_lrc_update_memirq_regs_with_address (struct xe_lrc *lrc , struct xe_hw_engine *hwe , u32 *regs ); ARGUMENTS lrc the xe_lrc struct instance hwe the xe_hw_engine struct ...
xe_lrc_update_timestamp(9)
NAME xe_lrc_update_timestamp - readout LRC timestamp and update cached value SYNOPSIS u64 xe_lrc_update_timestamp (struct xe_lrc *lrc , u64 *old_ts ); ARGUMENTS lrc logical ring context for this exec queue old_ts pointer where to save the previous timestamp DESCRIPTION Read the current timest...
xe_managed_bo_reinit_in_vram(9)
NAME xe_managed_bo_reinit_in_vram - SYNOPSIS int xe_managed_bo_reinit_in_vram (struct xe_device *xe , struct xe_tile *tile , struct xe_bo **src ); ARGUMENTS xe xe device tile Tile where the new buffer will be created src Managed buffer object allocated in system memory DESCRIP...
xe_memirq_enable_ptr(9)
NAME xe_memirq_enable_ptr - Get GGTT's offset of the Interrupt Enable Mask. SYNOPSIS u32 xe_memirq_enable_ptr (struct xe_memirq *memirq ); ARGUMENTS memirq the xe_memirq to query DESCRIPTION Shall be called when `Memory Based Interrupts`_ are used and xe_memirq_init didn't fail. RETURN GGTT's offset of the Int...
xe_memirq_guc_sw_int_0_irq_pending(9)
NAME xe_memirq_guc_sw_int_0_irq_pending - SW_INT_0 IRQ is pending SYNOPSIS bool xe_memirq_guc_sw_int_0_irq_pending (struct xe_memirq *memirq , struct xe_guc *guc ); ARGUMENTS memirq the xe_memirq guc the xe_guc to check for IRQ RETURN True if SW_INT_0 IRQ is pending on guc, False otherwise SEE ...
xe_memirq_handler(9)
NAME xe_memirq_handler - The `Memory Based Interrupts`_ Handler. SYNOPSIS void xe_memirq_handler (struct xe_memirq *memirq ); ARGUMENTS memirq the xe_memirq DESCRIPTION This function reads and dispatches `Memory Based Interrupts`. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_memirq.c Kernel API(9), Kernel...
xe_memirq_hwe_handler(9)
NAME xe_memirq_hwe_handler - Check and process interrupts for a specific HW engine. SYNOPSIS void xe_memirq_hwe_handler (struct xe_memirq *memirq , struct xe_hw_engine *hwe ); ARGUMENTS memirq the xe_memirq hwe the hw engine to process DESCRIPTION This function reads and dispatches `Memory Based...
xe_memirq_init(9)
NAME xe_memirq_init - Initialize data used by `Memory Based Interrupts`_. SYNOPSIS int xe_memirq_init (struct xe_memirq *memirq ); ARGUMENTS memirq the xe_memirq to initialize DESCRIPTION Allocate `Interrupt Source Report Page`_ and `Interrupt Status Report Page`_ used by `Memory Based Interrupts`_. These al...
xe_memirq_init_guc(9)
NAME xe_memirq_init_guc - Prepare GuC for `Memory Based Interrupts`_. SYNOPSIS int xe_memirq_init_guc (struct xe_memirq *memirq , struct xe_guc *guc ); ARGUMENTS memirq the xe_memirq guc the xe_guc to setup DESCRIPTION Register `Interrupt Source Report Page`_ and `Interrupt Status Report Page`_ ...
xe_memirq_postinstall(9)
NAME xe_memirq_postinstall - Enable processing of `Memory Based Interrupts`_. SYNOPSIS void xe_memirq_postinstall (struct xe_memirq *memirq ); ARGUMENTS memirq the xe_memirq DESCRIPTION This is part of the driver IRQ setup flow. This function shall only be used on platforms that use `Memory Based Interrupts`_....
xe_memirq_reset(9)
NAME xe_memirq_reset - Disable processing of `Memory Based Interrupts`_. SYNOPSIS void xe_memirq_reset (struct xe_memirq *memirq ); ARGUMENTS memirq struct xe_memirq DESCRIPTION This is part of the driver IRQ setup flow. This function shall only be used on platforms that use `Memory Based Interrupts`_. SEE AL...
xe_memirq_source_ptr(9)
NAME xe_memirq_source_ptr - Get GGTT's offset of the `Interrupt Source Report Page`_. SYNOPSIS u32 xe_memirq_source_ptr (struct xe_memirq *memirq , struct xe_hw_engine *hwe ); ARGUMENTS memirq the xe_memirq to query hwe the hw engine for which we want the report page DESCRIPTION Shall be called ...
xe_memirq_status_ptr(9)
NAME xe_memirq_status_ptr - Get GGTT's offset of the `Interrupt Status Report Page`_. SYNOPSIS u32 xe_memirq_status_ptr (struct xe_memirq *memirq , struct xe_hw_engine *hwe ); ARGUMENTS memirq the xe_memirq to query hwe the hw engine for which we want the report page DESCRIPTION Shall be called ...
xe_mert_init_early(9)
NAME xe_mert_init_early - Initialize MERT data SYNOPSIS void xe_mert_init_early (struct xe_device *xe ); ARGUMENTS xe the xe_device with MERT to init SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_mert.c xe_mert_invalidate_lmtt(9), xe_mert_irq_handler(9) April 2026 ...
xe_mert_invalidate_lmtt(9)
NAME xe_mert_invalidate_lmtt - Invalidate MERT LMTT SYNOPSIS int xe_mert_invalidate_lmtt (struct xe_device *xe ); ARGUMENTS xe the xe_device with MERT DESCRIPTION Trigger invalidation of the MERT LMTT and wait for completion. RETURN 0 on success or -ETIMEDOUT in case of a timeout. SEE ALSO Kernel file ./d...
xe_mert_irq_handler(9)
NAME xe_mert_irq_handler - Handler for MERT interrupts SYNOPSIS void xe_mert_irq_handler (struct xe_device *xe , u32 master_ctl ); ARGUMENTS xe the xe_device master_ctl interrupt register DESCRIPTION Handle interrupts generated by MERT. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_mert.c xe_mert_i...
xe_migrate_access_memory(9)
NAME xe_migrate_access_memory - Access memory of a BO via GPU SYNOPSIS int xe_migrate_access_memory (struct xe_migrate *m , struct xe_bo *bo , unsigned long offset , void *buf , int len , int write ); ARGUMENTS m The migration context. bo buffer object offset access offset into...
xe_migrate_alloc(9)
NAME xe_migrate_alloc - Allocate a migrate struct for a given &xe_tile SYNOPSIS struct xe_migrate * xe_migrate_alloc (struct xe_tile *tile ); ARGUMENTS tile xe_tile DESCRIPTION Allocates a xe_migrate for a given tile. RETURN xe_migrate on success, or NULL when out of memory. SEE ALSO Kernel file ./drivers...
xe_migrate_ccs_rw_copy(9)
NAME xe_migrate_ccs_rw_copy - Copy content of TTM resources. SYNOPSIS int xe_migrate_ccs_rw_copy (struct xe_tile *tile , struct xe_exec_queue *q , struct xe_bo *src_bo , enum xe_sriov_vf_ccs_rw_ctxs read_write ); ARGUMENTS tile Tile whose migration context to be used. q Execution to be used a...
xe_migrate_ccs_rw_copy_clear(9)
NAME xe_migrate_ccs_rw_copy_clear - Clear the CCS read/write batch buffer content. SYNOPSIS void xe_migrate_ccs_rw_copy_clear (struct xe_bo *src_bo , enum xe_sriov_vf_ccs_rw_ctxs read_write ); ARGUMENTS src_bo The buffer object src is currently bound to. read_write Creates BB commands for CCS read/write...
xe_migrate_clear(9)
NAME xe_migrate_clear - Copy content of TTM resources. SYNOPSIS struct dma_fence * xe_migrate_clear (struct xe_migrate *m , struct xe_bo *bo , struct ttm_resource *dst , u32 clear_flags ); ARGUMENTS m The migration context. bo The buffer object dst is currently bound to. dst ...
xe_migrate_copy(9)
NAME xe_migrate_copy - Copy content of TTM resources. SYNOPSIS struct dma_fence * xe_migrate_copy (struct xe_migrate *m , struct xe_bo *src_bo , struct xe_bo *dst_bo , struct ttm_resource *src , struct ttm_resource *dst , bool copy_only_ccs ); ARGUMENTS m The migration context. src_bo The buffe...
xe_migrate_exec_queue(9)
NAME xe_migrate_exec_queue - Get the execution queue from migrate context. SYNOPSIS struct xe_exec_queue * xe_migrate_exec_queue (struct xe_migrate *migrate ); ARGUMENTS migrate Migrate context. RETURN Pointer to execution queue on success, error on failure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_migrate...
xe_migrate_from_vram(9)
NAME xe_migrate_from_vram - Migrate from VRAM SYNOPSIS struct dma_fence * xe_migrate_from_vram (struct xe_migrate *m , unsigned long npages , u64 src_addr , struct drm_pagemap_addr *dst_addr , struct dma_fence *deps ); ARGUMENTS m The migration context. npages Number of pages to migrate. ...
xe_migrate_init(9)
NAME xe_migrate_init - Initialize a migrate context SYNOPSIS int xe_migrate_init (struct xe_migrate *m ); ARGUMENTS m The migration context RETURN 0 if successful, negative error code on failure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_migrate.c struct xe_migrate(9), xe_migrate_alloc(9), xe_migrate_c...
xe_migrate_job_lock(9)
NAME xe_migrate_job_lock - Lock migrate job lock SYNOPSIS void xe_migrate_job_lock (struct xe_migrate *m , struct xe_exec_queue *q ); ARGUMENTS m The migration context. q Queue associated with the operation which requires a lock DESCRIPTION Lock the migrate job lock if the queue is a migr...
xe_migrate_job_lock_assert(9)
NAME xe_migrate_job_lock_assert - Assert migrate job lock held of queue SYNOPSIS void xe_migrate_job_lock_assert (struct xe_exec_queue *q ); ARGUMENTS q Migrate queue SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_migrate.c struct xe_migrate(9), xe_migrate_alloc(9), xe_migrate_init(9), xe_migrate_copy...
xe_migrate_job_unlock(9)
NAME xe_migrate_job_unlock - Unlock migrate job lock SYNOPSIS void xe_migrate_job_unlock (struct xe_migrate *m , struct xe_exec_queue *q ); ARGUMENTS m The migration context. q Queue associated with the operation which requires a lock DESCRIPTION Unlock the migrate job lock if the queue i...
xe_migrate_lrc(9)
NAME xe_migrate_lrc - Get the LRC from migrate context. SYNOPSIS struct xe_lrc * xe_migrate_lrc (struct xe_migrate *migrate ); ARGUMENTS migrate Migrate context. RETURN Pointer to LRC on success, error on failure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_migrate.c struct xe_migrate(9), xe_migrate_alloc(9), x...
xe_migrate_to_vram(9)
NAME xe_migrate_to_vram - Migrate to VRAM SYNOPSIS struct dma_fence * xe_migrate_to_vram (struct xe_migrate *m , unsigned long npages , struct drm_pagemap_addr *src_addr , u64 dst_addr , struct dma_fence *deps ); ARGUMENTS m The migration context. npages Number of pages to migrate. src_...
xe_migrate_update_pgtables(9)
NAME xe_migrate_update_pgtables - Pipelined page-table update SYNOPSIS struct dma_fence * xe_migrate_update_pgtables (struct xe_migrate *m , struct xe_migrate_pt_update *pt_update ); ARGUMENTS m The migrate context. pt_update PT update arguments DESCRIPTION Perform a pipelined page-table update. ...
xe_migrate_vram_copy_chunk(9)
NAME xe_migrate_vram_copy_chunk - Copy a chunk of a VRAM buffer object. SYNOPSIS struct dma_fence * xe_migrate_vram_copy_chunk (struct xe_bo *vram_bo , u64 vram_offset , struct xe_bo *sysmem_bo , u64 sysmem_offset , u64 size , enum xe_migrate_copy_dir dir ); ARGUMENTS vram_bo The VRAM buffer object. vram_...
xe_migrate_wait(9)
NAME xe_migrate_wait - Complete all operations using the xe_migrate context SYNOPSIS void xe_migrate_wait (struct xe_migrate *m ); ARGUMENTS m Migrate context to wait for. DESCRIPTION Waits until the GPU no longer uses the migrate context's default engine or its page-table objects. FIXME: What about separa...
xe_mmio_gem_create(9)
NAME xe_mmio_gem_create - Expose an MMIO region to userspace SYNOPSIS struct xe_mmio_gem * xe_mmio_gem_create (struct xe_device *xe , struct drm_file *file , phys_addr_t phys_addr , size_t size ); ARGUMENTS xe The xe device file DRM file descriptor phys_addr Start of the exposed MMIO...
xe_mmio_gem_destroy(9)
NAME xe_mmio_gem_destroy - Destroy the GEM object that exposes an MMIO region SYNOPSIS void xe_mmio_gem_destroy (struct xe_mmio_gem *gem ); ARGUMENTS gem the GEM object to destroy DESCRIPTION This function releases resources associated with the GEM object created by xe_mmio_gem_create. See: "Exposing MMIO r...
xe_mmio_gem_mmap_offset(9)
NAME xe_mmio_gem_mmap_offset - Return the mmap-able fake offset SYNOPSIS u64 xe_mmio_gem_mmap_offset (struct xe_mmio_gem *gem ); ARGUMENTS gem the GEM object created with xe_mmio_gem_create DESCRIPTION This function returns the mmap-able fake offset allocated during xe_mmio_gem_create. See: "Exposing MMIO r...
xe_mmio_init(9)
NAME xe_mmio_init - Initialize an MMIO instance SYNOPSIS void xe_mmio_init (struct xe_mmio *mmio , struct xe_tile *tile , void __iomem *ptr , u32 size ); ARGUMENTS mmio Pointer to the MMIO instance to initialize tile The tile to which the MMIO region belongs ptr Pointer to the st...
xe_mmio_init_vf_view(9)
NAME xe_mmio_init_vf_view - Initialize an MMIO instance for accesses like the VF SYNOPSIS void xe_mmio_init_vf_view (struct xe_mmio *mmio , const struct xe_mmio *base , unsigned int vfid ); ARGUMENTS mmio the target xe_mmio to initialize as VF's view base the source xe_mmio to initialize from ...
xe_mmio_read64_2x32(9)
NAME xe_mmio_read64_2x32 - Read a 64-bit register as two 32-bit reads SYNOPSIS u64 xe_mmio_read64_2x32 (struct xe_mmio *mmio , struct xe_reg reg ); ARGUMENTS mmio MMIO target reg register to read value from DESCRIPTION Although Intel GPUs have some 64-bit registers, the hardware officially...
xe_mmio_wait32(9)
NAME xe_mmio_wait32 - Wait for a register to match the desired masked value SYNOPSIS int xe_mmio_wait32 (struct xe_mmio *mmio , struct xe_reg reg , u32 mask , u32 val , u32 timeout_us , u32 *out_val , bool atomic ); ARGUMENTS mmio MMIO target reg register to read value from mask ...
xe_mmio_wait32_not(9)
NAME xe_mmio_wait32_not - Wait for a register to return anything other than the given masked value SYNOPSIS int xe_mmio_wait32_not (struct xe_mmio *mmio , struct xe_reg reg , u32 mask , u32 val , u32 timeout_us , u32 *out_val , bool atomic ); ARGUMENTS mmio MMIO target reg register to read valu...
xe_mocs_dump(9)
NAME xe_mocs_dump - Dump MOCS table. SYNOPSIS int xe_mocs_dump (struct xe_gt *gt , struct drm_printer *p ); ARGUMENTS gt the xe_gt with MOCS table p the drm_printer to dump info to RETURN 0 on success or a negative error code on failure. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_mocs.c...
xe_oa_add_config_ioctl(9)
NAME xe_oa_add_config_ioctl - Adds one OA config SYNOPSIS int xe_oa_add_config_ioctl (struct drm_device *dev , u64 data , struct drm_file *file ); ARGUMENTS dev drm_device data pointer to struct drm_xe_oa_config file drm_file DESCRIPTION The functions adds an OA config to the se...
xe_oa_init(9)
NAME xe_oa_init - OA initialization during device probe SYNOPSIS int xe_oa_init (struct xe_device *xe ); ARGUMENTS xe xe_device RETURN 0 on success or a negative error code on failure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_oa.c xe_oa_timestamp_frequency(9), xe_oa_unit_id(9), xe_oa_stream_open_ioctl(9...
xe_oa_register(9)
NAME xe_oa_register - Xe OA registration SYNOPSIS int xe_oa_register (struct xe_device *xe ); ARGUMENTS xe xe_device DESCRIPTION Exposes the metrics sysfs directory upon completion of module initialization SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_oa.c xe_oa_timestamp_frequency(9), xe_oa_unit_id(9), xe_...
xe_oa_remove_config_ioctl(9)
NAME xe_oa_remove_config_ioctl - Removes one OA config SYNOPSIS int xe_oa_remove_config_ioctl (struct drm_device *dev , u64 data , struct drm_file *file ); ARGUMENTS dev drm_device data pointer to struct drm_xe_observation_param file drm_file SEE ALSO Kernel file ./drivers/gpu/d...
xe_oa_stream_open_ioctl(9)
NAME xe_oa_stream_open_ioctl - Opens an OA stream SYNOPSIS int xe_oa_stream_open_ioctl (struct drm_device *dev , u64 data , struct drm_file *file ); ARGUMENTS dev drm_device data pointer to struct drm_xe_oa_config file drm_file DESCRIPTION The functions opens an OA stream. An OA...
xe_oa_timestamp_frequency(9)
NAME xe_oa_timestamp_frequency - Return OA timestamp frequency SYNOPSIS u32 xe_oa_timestamp_frequency (struct xe_gt *gt ); ARGUMENTS gt xe_gt DESCRIPTION OA timestamp frequency = CS timestamp frequency in most platforms. On some platforms OA unit ignores the CTC_SHIFT and the 2 timestamps differ. In such ca...
xe_oa_unit_id(9)
NAME xe_oa_unit_id - Return OA unit ID for a hardware engine SYNOPSIS u16 xe_oa_unit_id (struct xe_hw_engine *hwe ); ARGUMENTS hwe xe_hw_engine DESCRIPTION Return OA unit ID for a hardware engine when available SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_oa.c xe_oa_timestamp_frequency(9), xe_oa_stream_open...
xe_observation_ioctl(9)
NAME xe_observation_ioctl - The top level observation layer ioctl SYNOPSIS int xe_observation_ioctl (struct drm_device *dev , void *data , struct drm_file *file ); ARGUMENTS dev drm_device data pointer to struct drm_xe_observation_param file drm_file DESCRIPTION The function is ...
xe_observation_sysctl_register(9)
NAME xe_observation_sysctl_register - Register xe_observation_paranoid sysctl SYNOPSIS int xe_observation_sysctl_register (void ); ARGUMENTS void no arguments DESCRIPTION Normally only superuser/root can access observation stream data. However, superuser can set xe_observation_paranoid sysctl to 0 to allow no...
xe_observation_sysctl_unregister(9)
NAME xe_observation_sysctl_unregister - Unregister xe_observation_paranoid sysctl SYNOPSIS void xe_observation_sysctl_unregister (void ); ARGUMENTS void no arguments SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_observation.c xe_observation_ioctl(9), xe_observation_sysctl_register(9) April 2026 ...
xe_page_reclaim_create_prl_bo(9)
NAME xe_page_reclaim_create_prl_bo - Back a PRL with a suballocated GGTT BO SYNOPSIS struct drm_suballoc * xe_page_reclaim_create_prl_bo (struct xe_tlb_inval *tlb_inval , struct xe_page_reclaim_list *prl , struct xe_tlb_inval_fence *fence ); ARGUMENTS tlb_inval TLB invalidation frontend associated with the request ...
xe_page_reclaim_entries_get(9)
NAME xe_page_reclaim_entries_get - Increment the reference count of page reclaim entries. SYNOPSIS void xe_page_reclaim_entries_get (struct xe_guc_page_reclaim_entry *entries ); ARGUMENTS entries Pointer to the array of page reclaim entries. DESCRIPTION This function increments the reference count of the backing...
xe_page_reclaim_entries_put(9)
NAME xe_page_reclaim_entries_put - Decrement the reference count of page reclaim entries. SYNOPSIS void xe_page_reclaim_entries_put (struct xe_guc_page_reclaim_entry *entries ); ARGUMENTS entries Pointer to the array of page reclaim entries. DESCRIPTION This function decrements the reference count of the backing...
xe_page_reclaim_list_abort(9)
NAME xe_page_reclaim_list_abort - Invalidate a PRL and log an abort reason SYNOPSIS xe_page_reclaim_list_abort (gt , prl , fmt , ... ); ARGUMENTS gt GT owning the page reclaim request prl Page reclaim list to invalidate fmt format string for the log message with args ....
xe_page_reclaim_list_alloc_entries(9)
NAME xe_page_reclaim_list_alloc_entries - Allocate page reclaim list entries SYNOPSIS int xe_page_reclaim_list_alloc_entries (struct xe_page_reclaim_list *prl ); ARGUMENTS prl Page reclaim list to allocate entries for DESCRIPTION Allocate one 4K page for the PRL entries, otherwise assign prl->entries to NULL...
xe_page_reclaim_list_init(9)
NAME xe_page_reclaim_list_init - Initialize a page reclaim list SYNOPSIS void xe_page_reclaim_list_init (struct xe_page_reclaim_list *prl ); ARGUMENTS prl Page reclaim list to initialize DESCRIPTION NULLs both values in list to prepare on initalization. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_page_recl...
xe_page_reclaim_list_invalidate(9)
NAME xe_page_reclaim_list_invalidate - Mark a PRL as invalid SYNOPSIS void xe_page_reclaim_list_invalidate (struct xe_page_reclaim_list *prl ); ARGUMENTS prl Page reclaim list to reset DESCRIPTION Clears the entries pointer and marks the list as invalid so future use knows PRL is unusable. It is expected tha...
xe_page_reclaim_list_is_new(9)
NAME xe_page_reclaim_list_is_new - Check if PRL is new allocation SYNOPSIS bool xe_page_reclaim_list_is_new (struct xe_page_reclaim_list *prl ); ARGUMENTS prl Pointer to page reclaim list DESCRIPTION PRL indicates it hasn't been allocated through both values being NULL SEE ALSO Kernel file ./drivers/gpu/drm...
xe_page_reclaim_list_valid(9)
NAME xe_page_reclaim_list_valid - Check if the page reclaim list is valid SYNOPSIS bool xe_page_reclaim_list_valid (struct xe_page_reclaim_list *prl ); ARGUMENTS prl Pointer to page reclaim list DESCRIPTION PRL uses the XE_PAGE_RECLAIM_INVALID_LIST to indicate that a PRL is unusable. SEE ALSO Kernel file ./...
xe_page_reclaim_skip(9)
NAME xe_page_reclaim_skip - Decide whether PRL should be skipped for a VMA SYNOPSIS bool xe_page_reclaim_skip (struct xe_tile *tile , struct xe_vma *vma ); ARGUMENTS tile Tile owning the VMA vma VMA under consideration DESCRIPTION PPC flushing may be handled by HW for specific PAT encodings. ...
xe_pagefault_handler(9)
NAME xe_pagefault_handler - Page fault handler SYNOPSIS int xe_pagefault_handler (struct xe_device *xe , struct xe_pagefault *pf ); ARGUMENTS xe xe device instance pf Page fault DESCRIPTION Sink the page fault to a queue (i.e., a memory buffer) and queue a worker to service it. Safe to be c...
xe_pagefault_init(9)
NAME xe_pagefault_init - Page fault init SYNOPSIS int xe_pagefault_init (struct xe_device *xe ); ARGUMENTS xe xe device instance DESCRIPTION Initialize Xe page fault state. Must be done after reading fuses. RETURN 0 on Success, errno on failure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_pagefault.c Kern...
xe_pagefault_reset(9)
NAME xe_pagefault_reset - Page fault reset for a GT SYNOPSIS void xe_pagefault_reset (struct xe_device *xe , struct xe_gt *gt ); ARGUMENTS xe xe device instance gt GT being reset DESCRIPTION Reset the Xe page fault state for a GT; that is, squash any pending faults on the GT. SEE ALSO Kern...
xe_pagemap_cache_create(9)
NAME xe_pagemap_cache_create - Create a drm_pagemap cache SYNOPSIS int xe_pagemap_cache_create (struct xe_tile *tile ); ARGUMENTS tile The tile to register the cache with DESCRIPTION Create a drm_pagemap cache and register with the tile. RETURN 0 on success, negative error code on failure. SEE ALSO Kernel ...
xe_pagemap_create(9)
NAME xe_pagemap_create - Create a struct xe_pagemap object SYNOPSIS struct xe_pagemap * xe_pagemap_create (struct xe_device *xe , struct xe_vram_region *vr ); ARGUMENTS xe The xe device. vr Back-pointer to the struct xe_vram_region. DESCRIPTION Allocate and initialize a struct xe_pagemap. O...