xe_bo_create_pin_map(9)

📦 version 7.3.1, in nixpkgs unstable

💖 xe_bo_create_pin_map(9) — Kernel API Manual, group-chat edition 💖

🌸 NAME 🌸

xe_bo_create_pin_map — Create pinned and mapped bo. Yup, that's the name, and it ate. 💅

✨ SYNOPSIS ✨

Here's the summoning spell, exactly as written — no edits, no autocorrect, bestie:

struct xe_bo * xe_bo_create_pin_map (struct xe_device *xe , struct
       xe_tile *tile , struct xe_vm *vm , size_t size , enum ttm_bo_type type ,
       u32 flags , struct drm_exec *exec );

🎀 ARGUMENTS 🎀

Okay, let's meet the cast:

  • xe — the xe device. Main character device energy.
  • tile — the tile to select for migration of this bo, and the tile used for (the source line literally ends there, no cap 💀).
  • vm — the vm to associate the buffer object with. The vm's resv must be locked with the transaction represented by exec. GGTT binding if any. Only to be non-NULL for ttm_bo_type_kernel bos.
  • size — the storage size to use for the bo.
  • type — the TTM buffer object type.
  • flags — XE_BO_FLAG_ flags. That's it, that's the flag situation.
  • exec — the drm_exec transaction to use for exhaustive eviction, and previously used for locking vm's resv.

🦋 DESCRIPTION 🦋

Create a pinned and mapped bo. That bo will be external and not associated with a VM. It's giving external, not-associated-with-a-VM energy, and that's the whole description. ✨

👑 RETURN 👑

  • On success: the buffer object. Slay. 💖
  • On failure: a negative error pointer. 😭
  • In particular, the function may return ERR_PTR(-EINTR) if exec was configured for interruptible locking. That's the special little failure gremlin to watch for.

🌈 SEE ALSO 🌈

Kernel file: ./drivers/gpu/drm/xe/xe_bo.c

The whole friend group:

xoxo 💋 — source ./drivers/gpu/drm/xe, version/manual xe_bo_create_pin_map(9), date October 2026.

📦 where this page comes from