mesa/include/drm-uapi
Jordan Justen 58bf403e8b include/drm-uapi/README: Update README for drm uapi header files
This update:

 * Clarifies the information about the acceptable source trees for
   updating the include/drm-uapi Mesa directory

 * Includes information about the current drm tree location

 * Expands the explanation of the process for generating the
   drm-uapi files

 * Expands the explanation of how what information to include
   in the Mesa commit that updates the drm-uapi files.

Signed-off-by: Jordan Justen <jordan.l.justen@intel.com>
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/29973>
2024-08-01 09:58:45 +00:00
..
amdgpu_drm.h ac: add gfx12 DCC shared code 2024-06-06 01:01:46 +00:00
d3dkmthk.h freedreno/replay: Add WSL backend for Windows 2024-01-15 13:12:58 +00:00
dma-buf.h mesa: add managarm support 2023-11-20 13:35:19 +00:00
drm.h drm-uapi: Sync drm-uapi 2023-12-22 04:01:12 +00:00
drm_fourcc.h ac: add gfx12 DCC shared code 2024-06-06 01:01:46 +00:00
drm_mode.h drm-uapi: Sync drm-uapi 2023-12-22 04:01:12 +00:00
etnaviv_drm.h include/drm-uapi: bump headers 2021-06-24 16:14:38 +00:00
gpu_scheduler.h anv: Partialy import drm-uapi/gpu_scheduler.h and use it 2023-03-24 21:28:47 +00:00
i915_drm.h drm-uapi: Sync i915_drm.h with a78313bb206e 2024-06-28 00:03:39 +00:00
lima_drm.h lima: sync lima_drm.h with kernel 2020-01-30 03:39:21 +00:00
msm_drm.h drm-uapi: Sync drm-uapi 2023-12-22 04:01:12 +00:00
nouveau_drm.h drm-uapi: Sync nouveau_drm.h 2024-05-14 04:04:34 +00:00
panfrost_drm.h panfrost: Fix build with Perfetto (again) 2022-11-09 14:35:31 +00:00
panthor_drm.h drm-uapi: Add panthor uAPI 2024-03-01 10:42:43 +00:00
pvr_drm.h include/drm-uapi: add pvr_drm.h 2023-12-01 10:41:24 +00:00
README include/drm-uapi/README: Update README for drm uapi header files 2024-08-01 09:58:45 +00:00
sync_file.h Try to fix FTBFS on kfreebsd architecture 2022-09-22 10:30:36 +02:00
tegra_drm.h drm-uapi: bump headers 2022-10-27 10:53:18 +00:00
v3d_drm.h drm-uapi: Update v3d_drm.h 2024-05-22 05:37:47 +00:00
vc4_drm.h drm-uapi: Update vc4 header with syncobj submit support 2018-05-17 16:04:21 +01:00
virtgpu_drm.h drm-uapi: Sync drm-uapi 2023-12-22 04:01:12 +00:00
xe_drm.h intel: Rename XE_PERF to XE_OBSERVATION 2024-07-17 01:00:34 +00:00

This directory contains a copy of the installed kernel headers
required by several drivers to communicate with the kernel.
Whenever one of those driver needs new definitions for new kernel
APIs, these files should be updated.

These files in upstream Mesa should only be updated once the changes
have landed in the drm-next branch of the drm repository.

The drm repository is currently located at:

 * https://gitlab.freedesktop.org/drm/kernel

 * git url: https://gitlab.freedesktop.org/drm/kernel.git

Tagged Linux kernel releases can also be used.

When using the drm repository, it is recommended that the headers are
generated using a *merge commit* in the drm-next branch. After
checking out the commit in the drm (or tagged Linux release) tree, the
drm-uapi files can be generated by running this from the drm tree:

$ make headers_install INSTALL_HDR_PATH=/path/to/install

This will generate files under /path/to/install/include/drm which can
be copied into the Mesa include/drm-uapi directory. It is not required
to copy/update all kernel header files.

The commit message for the Mesa drm-uapi update should include the
full commit version of the drm kernel tree. An easy way to generate
this is with the following command in the drm tree:

$ git log -1 --pretty=short --no-decorate

Which would produce output similar to this to include in the Mesa
commit:

commit a78313bb206e0c456a989f380c4cbd8af8af7c76
Merge: 365aa9f57399 79655e867ad6
Author: Dave Airlie <airlied@redhat.com>

    Merge tag 'drm-intel-gt-next-2024-06-12' of https://gitlab.freedesktop.org/drm/i915/kernel into drm-next