API Reference for My Project
Version 1.4
This reference covers 71 documented symbols across 4 source groups.
Sources
- Core API — 2 files — 12 symbols
- Driver API — 2 files — 9 symbols
- Library API — 2 files — 9 symbols
- Test API — 5 files — 5 tests, 13 subtests
API Reference Manual
Welcome to the igt-gpu-tools API reference.
The reference covers two areas:
- Core Library (
lib/) — shared helpers for DRM testing, KMS, framebuffer management, debugfs, GPU-specific support, and more. These are the building blocks that all IGT tests rely on. - Tests (
tests/) — the full test catalog with structured metadata, subtest listings, and "By Category" / "By Functionality" group pages.
Each library module below links to its generated API page with function signatures, parameter tables, and cross-referenced symbols. Use the A–Z index on each overview page to jump directly to any symbol.
Core / Xe API Reference
| Module | Source | Description |
|---|---|---|
| DMABUF Sync File | dmabuf_sync_file.c |
DMABUF importing/exporting fencing support library |
| drmtest | drmtest.c |
Base library for drm tests and tools |
| ALSA | igt_alsa.c |
Library with ALSA helpers |
| Audio | igt_audio.c |
Library for audio-related tests |
| aux | igt_aux.c |
Auxiliary libraries and support functions |
| Chamelium | igt_chamelium.c |
Library for using the Chamelium into igt tests |
| Collection | igt_collection.c |
Generic combinatorics library |
| Core | igt_core.c |
Core i-g-t testing support |
| CRC | igt_crc.c |
igt crc tables and calculation functions |
| debugfs | igt_debugfs.c |
Support code for debugfs features |
| igt_device | igt_device.c |
igt_device |
| Device selection | igt_device_scan.c |
Device scanning and selection |
| Draw | igt_draw.c |
drawing helpers for tests |
| Dummyload | igt_dummyload.c |
Library for submitting GPU workloads |
| Framebuffer | igt_fb.c |
Framebuffer handling and drawing library |
| Frame | igt_frame.c |
Library for frame-related tests |
| fs | igt_fs.c |
Helpers for file operations |
| GT | igt_gt.c |
GT support library |
| Hook support | igt_hook.c |
Support for running a hook script on test execution |
| kmod | igt_kmod.c |
Wrappers around libkmod for module loading/unloading |
| KMS | igt_kms.c |
Kernel modesetting support library |
| IGT List | igt_list.c |
a list implementation inspired by the kernel |
| IGT Map | igt_map.c |
a linear-reprobing hashmap implementation |
| msm | igt_msm.c |
msm support library |
| pipe_crc | igt_pipe_crc.c |
Pipe CRC support |
| Power Management | igt_power.c |
Power Management related helpers |
| Primes | igt_primes.c |
Prime numbers helper library |
| Random | igt_rand.c |
Random numbers helper library |
| Stats | igt_stats.c |
Tools for statistical analysis |
| syncobj | igt_syncobj.c |
Library with syncobj helpers |
| sysfs | igt_sysfs.c |
Support code for sysfs features |
| VC4 | igt_vc4.c |
VC4 support library |
| VGEM | igt_vgem.c |
VGEM support library |
| x86 | igt_x86.c |
x86 helper library |
| Intel allocator | intel_allocator.c |
igt implementation of allocator |
| Batch Buffer | intel_batchbuffer.c |
Batchbuffer and blitter support |
| Buffer operations | intel_bufops.c |
Buffer operation on tiled surfaces |
| Chipset | intel_chipset.c |
Feature macros and chipset helpers |
| I/O | intel_mmio.c |
Register access and sideband I/O library |
| ioctl wrappers | ioctl_wrappers.c |
ioctl wrappers and related functions |
| SW Sync | sw_sync.c |
Software sync (fencing) support library |
i915 API Reference
| Module | Source | Description |
|---|---|---|
| GEM Create | gem.c |
Helpers for dealing with objects creation |
| GEM Context | gem_context.c |
Helpers for dealing with contexts |
| GEM Engine Topology | gem_engine_topology.c |
Helpers for dealing engine topology |
| GEM Scheduler | gem_scheduler.c |
Helpers for querying scheduler capabilities |
| GEM Submission | gem_submission.c |
Helpers for determining submission method |
| Blitter library | intel_blt.c |
i915/xe blitter library |
| I915 GPU CRC | i915_crc.c |
i915 gpu crc |
| Intel Context Wrapper | intel_ctx.c |
Wrapper structs for dealing with contexts |
This documentation is auto-generated from C/C++ source comments using mkdocs-cdoc.