xref: /aosp_15_r20/external/mesa3d/include/drm-uapi/README (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1*61046927SAndroid Build Coastguard WorkerThis directory contains a copy of the installed kernel headers
2*61046927SAndroid Build Coastguard Workerrequired by several drivers to communicate with the kernel.
3*61046927SAndroid Build Coastguard WorkerWhenever one of those driver needs new definitions for new kernel
4*61046927SAndroid Build Coastguard WorkerAPIs, these files should be updated.
5*61046927SAndroid Build Coastguard Worker
6*61046927SAndroid Build Coastguard WorkerThese files in upstream Mesa should only be updated once the changes
7*61046927SAndroid Build Coastguard Workerhave landed in the drm-next branch of the drm repository.
8*61046927SAndroid Build Coastguard Worker
9*61046927SAndroid Build Coastguard WorkerThe drm repository is currently located at:
10*61046927SAndroid Build Coastguard Worker
11*61046927SAndroid Build Coastguard Worker * https://gitlab.freedesktop.org/drm/kernel
12*61046927SAndroid Build Coastguard Worker
13*61046927SAndroid Build Coastguard Worker * git url: https://gitlab.freedesktop.org/drm/kernel.git
14*61046927SAndroid Build Coastguard Worker
15*61046927SAndroid Build Coastguard WorkerTagged Linux kernel releases can also be used.
16*61046927SAndroid Build Coastguard Worker
17*61046927SAndroid Build Coastguard WorkerWhen using the drm repository, it is recommended that the headers are
18*61046927SAndroid Build Coastguard Workergenerated using a *merge commit* in the drm-next branch. After
19*61046927SAndroid Build Coastguard Workerchecking out the commit in the drm (or tagged Linux release) tree, the
20*61046927SAndroid Build Coastguard Workerdrm-uapi files can be generated by running this from the drm tree:
21*61046927SAndroid Build Coastguard Worker
22*61046927SAndroid Build Coastguard Worker$ make headers_install INSTALL_HDR_PATH=/path/to/install
23*61046927SAndroid Build Coastguard Worker
24*61046927SAndroid Build Coastguard WorkerThis will generate files under /path/to/install/include/drm which can
25*61046927SAndroid Build Coastguard Workerbe copied into the Mesa include/drm-uapi directory. It is not required
26*61046927SAndroid Build Coastguard Workerto copy/update all kernel header files.
27*61046927SAndroid Build Coastguard Worker
28*61046927SAndroid Build Coastguard WorkerThe commit message for the Mesa drm-uapi update should include the
29*61046927SAndroid Build Coastguard Workerfull commit version of the drm kernel tree. An easy way to generate
30*61046927SAndroid Build Coastguard Workerthis is with the following command in the drm tree:
31*61046927SAndroid Build Coastguard Worker
32*61046927SAndroid Build Coastguard Worker$ git log -1 --pretty=short --no-decorate
33*61046927SAndroid Build Coastguard Worker
34*61046927SAndroid Build Coastguard WorkerWhich would produce output similar to this to include in the Mesa
35*61046927SAndroid Build Coastguard Workercommit:
36*61046927SAndroid Build Coastguard Worker
37*61046927SAndroid Build Coastguard Workercommit a78313bb206e0c456a989f380c4cbd8af8af7c76
38*61046927SAndroid Build Coastguard WorkerMerge: 365aa9f57399 79655e867ad6
39*61046927SAndroid Build Coastguard WorkerAuthor: Dave Airlie <[email protected]>
40*61046927SAndroid Build Coastguard Worker
41*61046927SAndroid Build Coastguard Worker    Merge tag 'drm-intel-gt-next-2024-06-12' of https://gitlab.freedesktop.org/drm/i915/kernel into drm-next
42