drivers/gpu/drm/xe/xe_bo.h

File Facts

System

Linux kernel

Corpus path

drivers/gpu/drm/xe/xe_bo.h

Extension

.h

Size

18311 bytes

Lines

602

Domain

Driver Families

Bucket

drivers/gpu

Inferred role

Driver Families: implementation source

Status

source implementation candidate

Why This File Exists

Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.

• Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
• Touches IRQ or DMA behavior; this matters for the representative real-device path.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• drm/ttm/ttm_tt.h
• xe_bo_types.h
• xe_ggtt.h
• xe_macros.h
• xe_validation.h
• xe_vm_types.h
• xe_vm.h
• xe_vram_types.h

Detected Declarations

• struct sg_table
• struct xe_bo_shrink_flags
• enum xe_madv_purgeable_state
• function xe_bo_get_unless_zero
• function __xe_bo_unset_bulk_move
• function xe_bo_assert_held
• function xe_bo_unlock_vm_held
• function xe_bo_is_pinned
• function xe_bo_is_protected
• function xe_bo_is_purged
• function xe_bo_madv_is_dontneed
• function xe_bo_willneed_get_locked
• function xe_bo_willneed_put_locked
• function xe_bo_vma_count_inc_locked
• function xe_bo_vma_count_dec_locked
• function xe_bo_unpin_map_no_vm
• function xe_bo_main_addr
• function xe_bo_size
• function __xe_bo_ggtt_addr
• function xe_bo_ggtt_addr
• function xe_bo_ccs_pages_start
• function xe_bo_has_valid_ccs_bb
• function xe_bo_has_pages
• function xe_bo_put_deferred
• function xe_bo_put_async
• function xe_sg_segment_size
• function xe_bo_is_mem_type

Annotated Snippet

struct xe_bo_shrink_flags {
	u32 purge : 1;
	u32 writeback : 1;
};

long xe_bo_shrink(struct ttm_operation_ctx *ctx, struct ttm_buffer_object *bo,
		  const struct xe_bo_shrink_flags flags,
		  unsigned long *scanned);

/**
 * xe_bo_is_mem_type - Whether the bo currently resides in the given
 * TTM memory type
 * @bo: The bo to check.
 * @mem_type: The TTM memory type.
 *
 * Return: true iff the bo resides in @mem_type, false otherwise.
 */
static inline bool xe_bo_is_mem_type(struct xe_bo *bo, u32 mem_type)
{
	xe_bo_assert_held(bo);
	return bo->ttm.resource->mem_type == mem_type;
}
#endif

Annotation

• Immediate include surface: `drm/ttm/ttm_tt.h`, `xe_bo_types.h`, `xe_ggtt.h`, `xe_macros.h`, `xe_validation.h`, `xe_vm_types.h`, `xe_vm.h`, `xe_vram_types.h`.
• Detected declarations: `struct sg_table`, `struct xe_bo_shrink_flags`, `enum xe_madv_purgeable_state`, `function xe_bo_get_unless_zero`, `function __xe_bo_unset_bulk_move`, `function xe_bo_assert_held`, `function xe_bo_unlock_vm_held`, `function xe_bo_is_pinned`, `function xe_bo_is_protected`, `function xe_bo_is_purged`.
• Atlas domain: Driver Families / drivers/gpu.
• Implementation status: source implementation candidate.
• IRQ or DMA behavior appears here, which is relevant to the selected PCIe/NVMe device path.

Implementation Notes

• This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
• Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
• Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.