STRUCT XE_DEVICE(9)
🎀 struct xe_device (9) — Kernel API Manual 🎀
okay bestie, welcome to the top-level struct of the Xe device ✨ this is the big one, the main character energy struct, the one everything else lives inside. buckle up, we're going through every single member. no skimming. 💅
🌸 NAME 🌸
struct xe_device — literally the top level struct of the Xe device, the whole entire vibe of your GPU in one C struct 🫶
✨ SYNOPSIS ✨
struct xe_device {
struct drm_device drm;
#if IS_ENABLED(CONFIG_DRM_XE_DISPLAY);
struct intel_display *display;
#endif;
struct xe_devcoredump devcoredump;
struct intel_device_info {
const char *platform_name;
const char *graphics_name;
const char *media_name;
u32 graphics_verx100;
u32 media_verx100;
u32 mem_region_mask;
enum xe_platform platform;
enum xe_subplatform subplatform;
u16 devid;
u8 revid;
struct xe_step_info step;
u8 dma_mask_size;
u8 vram_flags;
u8 tile_count;
u8 max_gt_per_tile;
u8 multi_lrc_mask;
u8 gt_count;
u8 vm_max_level;
u8 va_bits;
u8 has_access_counter:1;
u8 has_asid:1;
u8 has_atomic_enable_pte_bit:1;
u8 has_cached_pt:1;
u8 has_device_atomics_on_smem:1;
u8 has_drm_ras:1;
u8 has_fan_control:1;
u8 has_flat_ccs:1;
u8 has_gsc_nvm:1;
u8 has_heci_cscfi:1;
u8 has_heci_gscfi:1;
u8 has_i2c:1;
u8 has_late_bind:1;
u8 has_llc:1;
u8 has_mbx_power_limits:1;
u8 has_mbx_thermal_info:1;
u8 has_mem_copy_instr:1;
u8 has_mert:1;
u8 has_page_reclaim_hw_assist:1;
u8 has_pre_prod_wa:1;
u8 has_pxp:1;
u8 has_ctx_tlb_inval:1;
u8 has_range_tlb_inval:1;
u8 has_soc_remapper_sysctrl:1;
u8 has_soc_remapper_telem:1;
u8 has_sriov:1;
u8 has_sysctrl:1;
u8 has_usm:1;
u8 has_64bit_timestamp:1;
u8 is_dgfx:1;
u8 needs_scratch:1;
u8 probe_display:1;
u8 skip_guc_pc:1;
u8 skip_pcode:1;
u8 needs_shared_vf_gt_wq:1;
} info;
struct {
unsigned long *oob;
bool oob_initialized;
} wa_active;
struct xe_survivability survivability;
struct {
spinlock_t lock;
atomic_t enabled;
struct {
u16 nvec;
struct xarray indexes;
} msix;
} irq;
struct ttm_device ttm;
struct {
size_t size;
void __iomem *regs;
} mmio;
struct {
struct xe_vram_region *vram;
struct ttm_resource_manager sys_mgr;
struct xe_shrinker *shrinker;
struct xe_ttm_stolen_mgr *stolen_mgr;
} mem;
struct {
enum xe_sriov_mode __mode;
union {
struct xe_device_pf pf;
struct xe_device_vf vf;
};
struct workqueue_struct *wq;
} sriov;
struct {
struct xarray asid_to_vm;
u32 next_asid;
struct rw_semaphore lock;
struct workqueue_struct *pf_wq;
#define XE_PAGEFAULT_QUEUE_COUNT 4;
struct xe_pagefault_queue pf_queue[XE_PAGEFAULT_QUEUE_COUNT];
#if IS_ENABLED(CONFIG_DRM_XE_PAGEMAP);
struct drm_pagemap_shrinker *dpagemap_shrinker;
#endif;
} usm;
struct {
spinlock_t lock;
struct {
struct list_head kernel_bo_present;
struct list_head evicted;
} early;
struct {
struct list_head kernel_bo_present;
struct list_head evicted;
struct list_head external;
} late;
} pinned;
wait_queue_head_t ufence_wq;
struct workqueue_struct *preempt_fence_wq;
struct workqueue_struct *ordered_wq;
struct workqueue_struct *unordered_wq;
struct workqueue_struct *destroy_wq;
struct xe_tile tiles[XE_MAX_TILES_PER_DEVICE];
struct {
struct {
struct mutex lock;
struct list_head list;
} vram_userfault;
} mem_access;
struct {
const struct xe_pat_ops *ops;
const struct xe_pat_table_entry *table;
int n_entries;
const struct xe_pat_table_entry *pat_ats;
const struct xe_pat_table_entry *pat_primary_pta;
const struct xe_pat_table_entry *pat_media_pta;
const struct xe_pat_table_entry *pat_primary_tr_pta;
const struct xe_pat_table_entry *pat_media_tr_pta;
u16 idx[__XE_CACHE_LEVEL_COUNT];
} pat;
struct {
bool capable;
bool allowed;
u32 vram_threshold;
struct mutex lock;
} d3cold;
struct notifier_block pm_notifier;
struct completion pm_block;
struct list_head rebind_resume_list;
struct mutex rebind_resume_lock;
struct {
struct mutex lock;
} pmt;
struct {
spinlock_t lock;
void (*set_telem_region)(struct xe_device *xe, u32 index);
void (*set_sysctrl_region)(struct xe_device *xe, u32 index);
} soc_remapper;
struct task_struct *pm_callback_task;
struct xe_hwmon *hwmon;
struct xe_heci_gsc heci_gsc;
struct intel_dg_nvm_dev *nvm;
struct xe_late_bind late_bind;
#ifdef CONFIG_DRM_XE_DEBUG_PAGE_SIZE;
struct {
enum xe_page_size_alloc_ctrl_mode mode;
u32 cur_index;
struct mutex lock;
} page_size_alloc_ctrl;
#endif;
struct xe_oa oa;
struct xe_pxp *pxp;
bool needs_flr_on_fini;
atomic_t in_reset;
struct {
atomic_t flag;
enum xe_wedged_mode mode;
unsigned long method;
bool inconsistent_reset;
} wedged;
void *devres_group;
struct xe_bo_dev {
struct work_struct async_free;
struct llist_head async_list;
} bo_device;
struct xe_pmu pmu;
struct xe_drm_ras ras;
struct xe_i2c *i2c;
struct xe_sysctrl sc;
u32 atomic_svm_timeslice_ms;
u32 min_run_period_lr_ms;
u32 min_run_period_pf_ms;
#ifdef TEST_VM_OPS_ERROR;
u8 vm_inject_error_position;
#endif;
#if IS_ENABLED(CONFIG_TRACE_GPU_MEM);
atomic64_t global_total_pages;
#endif;
struct xe_validation_device val;
struct {
struct xe_bo *capture_obj[XE_MAX_TILES_PER_DEVICE + 1];
u8 region_mask;
} psmi;
#if IS_ENABLED(CONFIG_DRM_XE_KUNIT_TEST);
u32 *g2g_test_array;
atomic_t g2g_test_count;
#endif;
};👑 Members 👑
okay so now we go field by field, and yes, there are a LOT of them, but that's the whole point — no cap, every single one matters 💖
drm— the actualdrmdevice. the foundation bestie, everything else sits on top of it.display— display device data 🖥️ and here's the tea: it must be placed after thedrmdevice member. not optional. don't move it.devcoredump— device coredump. the receipts when things go sideways 💀info— device info. the giant nested struct of everything this device is.
🔍 info.* — the identity section 🔍
info.platform_name— platform nameinfo.graphics_name— graphics IP nameinfo.media_name— media IP nameinfo.graphics_verx100— graphics IP versioninfo.media_verx100— media IP versioninfo.mem_region_mask— mask of valid memory regionsinfo.platform— Xe platform enuminfo.subplatform— Xe subplatform enuminfo.devid— device IDinfo.revid— device revisioninfo.step— stepping information for each IPinfo.dma_mask_size— DMA address bitsinfo.vram_flags— Vram flagsinfo.tile_count— Number of tiles 🧱info.max_gt_per_tile— Number of GT IDs allocated to each tileinfo.multi_lrc_mask— bitmask of engine classes which support multi-lrcinfo.gt_count— Total number of GTs for entire deviceinfo.vm_max_level— Max VM levelinfo.va_bits— Maximum bits of a virtual address
🌈 info.has_* — the giant feature checklist 🌈
these are all single-bit flags, so think of it as the device's little "do I do this? 👀" list. slay.
info.has_access_counter— Device supports access counterinfo.has_asid— Has address space IDinfo.has_atomic_enable_pte_bit— Device has atomic enable PTE bitinfo.has_cached_pt— Supports caching pagetableinfo.has_device_atomics_on_smem— Supports device atomics on SMEMinfo.has_drm_ras— Device supportsdrm_ras(Reliability, Availability, Serviceability)info.has_fan_control— Device supports fan control 🌀info.has_flat_ccs— Whether flat CCS metadata is usedinfo.has_gsc_nvm— Device has gsc non-volatile memoryinfo.has_heci_cscfi— device hasheci cscfiinfo.has_heci_gscfi— device hasheci gscfiinfo.has_i2c— Device has I2C controllerinfo.has_late_bind— Device has firmware late binding supportinfo.has_llc— Device has a shared CPU+GPU last level cacheinfo.has_mbx_thermal_info— Device supports thermal mailbox commands 🌡️info.has_mem_copy_instr— Device supportsMEM_COPYinstructioninfo.has_mert— Device has standalone MERTinfo.has_page_reclaim_hw_assist— Device supports page reclamation featureinfo.has_pre_prod_wa— Pre-production workarounds still present in driverinfo.has_pxp— Device has PXP supportinfo.has_ctx_tlb_inval— Has context based TLB invalidationsinfo.has_range_tlb_inval— Has range based TLB invalidationsinfo.has_soc_remapper_sysctrl— Has SoC remapper system controllerinfo.has_soc_remapper_telem— Has SoC remapper telemetry supportinfo.has_sriov— Supports SR-IOVinfo.has_sysctrl— Supports System Controllerinfo.has_usm— Device has unified shared memory supportinfo.has_64bit_timestamp— Device supports 64-bit timestamps ⏱️info.is_dgfx— is discrete deviceinfo.needs_scratch— needs scratch page for oob prefetch to workinfo.probe_display— Probe display hardware. If set to false, the driver will behave as if there is no display hardware present and will not try to read/write to it in any way. The display hardware, if it exists, will not be exposed to userspace and will be left untouched in whatever state the firmware or bootloader left it in. 🙈 (<- literally "we pretend it isn't there and we do not touch it")info.skip_guc_pc— Skip GuC based PM feature initinfo.skip_pcode— skip access to PCODE uCinfo.needs_shared_vf_gt_wq— needs shared GT WQ on VF
🫶 wa_active — keeping the receipts 🫶
wa_active— keep track of active workaroundswa_active.oob— bitmap with active OOB workarounds
💅 and that's where part 1 lands — mid-struct, mid-vibe, exactly as the page was written. the rest is still coming, don't you dare close the tab 🎀
wa_active.oob_initialized— marks oob as initialized, and the whole point of that is helping detect misuse ofXE_DEVICE_WA— lowkey it can only be called on initialization after the Device OOB WAs have been processed 😌survivability— survivability information for device 🫶
okay next up, the interrupt corner, it's giving very "don't touch my stuff" energy ✨
irq— device interrupt stateirq.lock— lock for processing irq's on this deviceirq.enabled— interrupts enabled on this deviceirq.msix— irq info for platforms that support MSI-Xirq.msix.nvec— number of MSI-X interruptsirq.msix.indexes— used to allocate MSI-X indexesttm— ttm device
memory stuff, we love a memory moment 💅
mmio— mmio info for devicemmio.size— size of MMIO space for devicemmio.regs— pointer to MMIO space for devicemem— memory info for devicemem.vram— VRAM info for devicemem.sys_mgr— system TTM managermem.shrinker— system memory shrinker.mem.stolen_mgr— stolen memory manager.
sriov— device level virtualization datasriov.__mode— SR-IOV mode (don't access directly! seriously, hands off 🙈){unnamed_union}— anonymoussriov.pf— PF specific datasriov.vf— VF specific datasriov.wq— workqueue used by the virtualization workers
unified memory state, main character energy tbh 👑
usm— unified memory stateusm.asid_to_vm— convert an ASID to VMusm.next_asid— next ASID, used to cyclical alloc asidsusm.lock— protects UM stateusm.pf_wq— page fault work queue, unbound, high priority 🔥usm.pf_queue— page fault queuesusm.dpagemap_shrinker— shrinker for unused pagemaps
pinned BOs, the way these are split into early and late is so organized of them 🎀
pinned— pinned BO statepinned.lock— protected pinned BO list statepinned.early— early pinned listspinned.early.kernel_bo_present— pinned kernel BO that are presentpinned.early.evicted— pinned BO that have been evictedpinned.late— late pinned listspinned.late.kernel_bo_present— pinned kernel BO that are presentpinned.late.evicted— pinned BO that have been evictedpinned.late.external— pinned external and dma-buf.
a whole little family of workqueues, iykyk ⭐
ufence_wq— user fence wait queuepreempt_fence_wq— used to serialize preempt fencesordered_wq— used to serialize compute mode resumeunordered_wq— used to serialize unordered workdestroy_wq— used to serialize SVM pagemap destroy work
tiles— device tilesmem_access— keep track of memory access in the device, possibly triggering additional actions when they occur.mem_access.vram_userfault— encapsulate vram_userfault related stuffmem_access.vram_userfault.lock— protects access tomem_access.vram_userfault.list. Using mutex instead of spinlock as lock is applied to entire list operation which may sleep 😴mem_access.vram_userfault.list— keep list of userfaulted vram bo, which require to release their mmap mappings at runtime suspend path
PAT time, and yes there are a lot of entries, we're listing them all bestie 💜
pat— encapsulate PAT related stuffpat.ops— internal operations to abstract platformspat.table— PAT table to program in the HWpat.n_entries— number of PAT entriespat.pat_ats— PAT entry for PCIe ATS responsespat.pat_primary_pta— primary GT PAT entry for page table accessespat.pat_media_pta— media GT PAT entry for page table accessespat.pat_primary_tr_pta— primary GT PAT entry for TRTT page table accessespat.pat_media_tr_pta— media GT PAT entry for TRTT page table accesses
d3cold corner ❄️
d3cold— encapsulate d3cold related stuffd3cold.capable— indicates if root port is d3cold capabled3cold.allowed— indicates if d3cold is a valid device stated3cold.vram_threshold— this represents the permissible threshold (in megabytes) for vram save/restore. d3cold will be disallowed, whenvram_usagesis above or equals the threshold value to avoid the vram save/restore latency. Default threshold value is300mb.d3cold.lock— protectvram_threshold
pm_notifier— our PM notifier to perform actions in response to various PM events.pm_block— completion to block validating tasks on suspend / hibernate preparerebind_resume_list— list of wq items to kick on resume.rebind_resume_lock— lock to protect therebind_resume_listpmt— support the PMT driver callback interfacepmt.lock— protect access for telemetry data
SoC remapper, say that five times fast 🦋
soc_remapper— SoC remapper objectsoc_remapper.lock— serialize access to SoC Remapper's index registerssoc_remapper.set_telem_region— set telemetry indexsoc_remapper.set_sysctrl_region— set system controller index
pm_callback_task— track the active task that is running in either theruntime_suspendorruntime_resumecallbacks.hwmon— hwmon subsystem integrationheci_gsc— graphics security controllernvm— discrete graphics non-volatile memorylate_bind— xe mei late bind interfacepage_size_alloc_ctrl— user BO page-size allocation debug control statepage_size_alloc_ctrl.mode— xe page size allocation control modepage_size_alloc_ctrl.cur_index— round-robin index used by mixed modepage_size_alloc_ctrl.lock— protectsmodeandcur_indexoa— oa observation subsystempxp— encapsulate Protected Xe Path support
the "something went very wrong" section 🔥
needs_flr_on_fini— requests function-reset on finiin_reset— indicates if device is in resetwedged— struct to control Wedged States and modewedged.flag— Xe device faced a critical error and is now blocked. 💀wedged.mode— mode controlled by kernel parameter and debugfswedged.method— recovery method to be sent in the drm device wedged ueventwedged.inconsistent_reset— inconsistent reset policy state between GTs
devres_group— devres groupbo_device— struct to control async free of BOsbo_device.async_free— free workerbo_device.async_list— list of BOs to be freedpmu— performance monitoring unitras— RAS structure for devicei2c— I2C host controllersc— System Controller
timing + debug bits, lil guys but important 🍓
atomic_svm_timeslice_ms— atomic SVM fault timeslice MSmin_run_period_lr_ms— LR VM (preempt fence mode) timeslicemin_run_period_pf_ms— LR VM (page fault mode) timeslicevm_inject_error_position— inject errors at different places in VM bind IOCTL based on this valueglobal_total_pages— global GPU page usage tracked for gpu_mem tracepointsval— the domain for exhaustive eviction, which is currently per device.psmi— GPU debugging via additional validation HWpsmi.capture_obj— PSMI buffer for VRAMpsmi.region_mask— mask of valid memory regionsg2g_test_array— for testing G2G communicationsg2g_test_count— for testing G2G communications
🌈 SEE ALSO 🌈
- Kernel file
./drivers/gpu/drm/xe/xe_device_types.henum xe_wedged_mode(9),enum xe_page_size_alloc_ctrl_mode(9),struct xe_file(9)
go read those too bestie, they're literally right there and they slay 💅
and that's the whole struct, no cap 🫶 this lil page lives at ./drivers/gpu/drm/xe, dated October 2026, and it's officially titled struct xe_device(9) — mwah, bye ✨
📦 where this page comes from
- nixpkgs unstable: linux-manual 7.3.1
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms