Go to file
Simon Ser f83ad09dc0 xf86drmMode: constify drmModeAtomicReq functions
This acts as an additional ABI guarantee, and improves
documentation for users.

Signed-off-by: Simon Ser <contact@emersion.fr>
Reviewed-by: Thierry Reding <treding@nvidia.com>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2022-06-09 11:44:38 +02:00
.gitlab-ci xf86drm: Add a human readable representation for format modifiers 2021-06-22 11:16:04 +00:00
amdgpu meson: use the modern interface for pkg.generate 2022-01-20 10:20:40 -08:00
android android: Fix 32-bit app crashing in 64-bit Android 2018-12-18 21:18:19 +01:00
data amdgpu: add marketing names from 22.10 2022-05-13 13:20:14 -04:00
etnaviv meson: use the modern interface for pkg.generate 2022-01-20 10:20:40 -08:00
exynos meson: use the modern interface for pkg.generate 2022-01-20 10:20:40 -08:00
freedreno meson: use the modern interface for pkg.generate 2022-01-20 10:20:40 -08:00
include/drm tegra: Update for new UABI 2022-02-23 15:39:57 +01:00
intel intel: Add support for RPLP 2022-04-21 23:04:33 +05:30
man man: Add formatting to drmModeGetConnector reference 2022-04-19 13:13:13 -07:00
nouveau nouveau: add ioctl wrapper to check for dead channels 2022-05-03 11:23:30 +00:00
omap meson: use the modern interface for pkg.generate 2022-01-20 10:20:40 -08:00
radeon meson: use the modern interface for pkg.generate 2022-01-20 10:20:40 -08:00
tegra tests: tegra: Add VIC 3.0 support 2022-02-23 15:40:17 +01:00
tests tests/amdgpu: use appropriate ring for different asics 2022-05-26 21:02:33 +08:00
vc4 Revert "Revert "libdrm: remove autotools support"" 2019-10-18 18:05:45 +01:00
.editorconfig Add meson build system 2018-01-12 09:40:48 -08:00
.gitignore add a minimal .gitignore back 2019-12-17 22:37:39 +00:00
.gitlab-ci.yml libkms: Remove libkms completely 2022-04-15 22:40:29 +00:00
Android.common.mk meson: always define whether headers exist 2020-01-23 17:00:12 +00:00
Android.mk libdrm: Android.mk: Add minimal Android platform check 2019-04-25 10:55:02 +01:00
CONTRIBUTING.rst doc: Rename README&CONTRIBUTING to .rst 2018-10-17 17:17:19 +02:00
CleanSpec.mk tests: Split helpers into library 2015-12-18 17:43:40 +00:00
Makefile.sources libdrm: add msm drm uapi header 2018-08-23 08:48:45 -07:00
README.rst README.rst: Include some notes about syncing uapi headers 2021-06-22 11:16:04 +00:00
RELEASING releasing: s/master/main/ 2021-12-21 13:07:01 +00:00
core-symbols.txt xf86drm: add drmGetDeviceFromDevId 2021-11-19 15:30:30 +01:00
gen_table_fourcc.py gen_table_fourcc: strip _MODIFIER suffix for INVALID 2022-06-08 14:02:48 +02:00
libdrm.pc.in Revert "Fix pkgconfig includes for /usr/include/drm" 2010-04-09 16:33:38 -04:00
libdrm_lists.h use standard `__typeof__()` instead of GNU extension `typeof()` 2022-01-19 16:08:31 -08:00
libdrm_macros.h libdrm: Use mmap64 instead of __mmap2 2019-04-25 10:55:13 +01:00
libsync.h add libsync.h helper 2016-11-05 10:16:46 -04:00
meson.build build: bump version to 2.4.111 2022-06-03 14:04:41 +10:00
meson_options.txt libkms: Remove libkms completely 2022-04-15 22:40:29 +00:00
symbols-check.py meson: import Mesa's symbols check script 2019-11-11 22:57:14 +00:00
util_double_list.h use standard `__typeof__()` instead of GNU extension `typeof()` 2022-01-19 16:08:31 -08:00
util_math.h Fix build with -std=c11 2018-09-05 13:09:29 +01:00
xf86atomic.h xf86atomic: require CAS support in libatomic_ops 2019-12-06 21:57:12 +00:00
xf86drm.c xf86drm.c: fix C99 warning 2022-05-09 14:56:11 +03:00
xf86drm.h xf86drm: add drmGetDeviceFromDevId 2021-11-19 15:30:30 +01:00
xf86drmHash.c xf86drmHash: remove unused loop variable 2018-11-09 10:59:11 +00:00
xf86drmHash.h tests/hash: extract test out of xf86drmHash.c 2015-04-05 15:19:42 +01:00
xf86drmMode.c xf86drmMode: constify drmModeAtomicReq functions 2022-06-09 11:44:38 +02:00
xf86drmMode.h xf86drmMode: constify drmModeAtomicReq functions 2022-06-09 11:44:38 +02:00
xf86drmRandom.c libdrm: annotate public functions 2018-09-19 22:46:45 -07:00
xf86drmRandom.h tests/random: extract test out of xf86drmRandom.c 2015-04-05 15:33:33 +01:00
xf86drmSL.c libdrm: annotate public functions 2018-09-19 22:46:45 -07:00

README.rst

libdrm - userspace library for drm
----------------------------------

This is libdrm, a userspace library for accessing the DRM, direct rendering
manager, on Linux, BSD and other operating systems that support the ioctl
interface.
The library provides wrapper functions for the ioctls to avoid exposing the
kernel interface directly, and for chipsets with drm memory manager, support
for tracking relocations and buffers.
New functionality in the kernel DRM drivers typically requires a new libdrm,
but a new libdrm will always work with an older kernel.

libdrm is a low-level library, typically used by graphics drivers such as
the Mesa drivers, the X drivers, libva and similar projects.

Syncing with the Linux kernel headers
-------------------------------------

The library should be regularly updated to match the recent changes in the
`include/uapi/drm/`.

libdrm maintains a human-readable version for the token format modifier, with
the simpler ones being extracted automatically from `drm_fourcc.h` header file
with the help of a python script.  This might not always possible, as some of
the vendors require decoding/extracting them programmatically.  For that
reason one can enhance the current vendor functions to include/provide the
newly added token formats, or, in case there's no such decoding
function, to add one that performs the tasks of extracting them.

For simpler format modifier tokens there's a script (gen_table_fourcc.py) that
creates a static table, by going over `drm_fourcc.h` header file. The script
could be further modified if it can't handle new (simpler) token format
modifiers instead of the generated static table.

Compiling
---------

To set up meson:

    meson builddir/

By default this will install into /usr/local, you can change your prefix
with --prefix=/usr (or `meson configure builddir/ -Dprefix=/usr` after 
the initial meson setup).

Then use ninja to build and install:

    ninja -C builddir/ install

If you are installing into a system location you will need to run install
separately, and as root.