Add notes about running things as root.
[platform/upstream/intel-gpu-tools.git] / README
1 This is a collection of tools for development and testing of the Intel DRM
2 driver.  There are many macro-level test suites that get used against our
3 driver, including xtest, rendercheck, piglit, and oglconform, but failures
4 from those can be difficult to track down to kernel changes, and many require
5 complicated build procedures or specific testing environments to get useful
6 results.
7
8 Thus, intel-graphics-tools was a project I started to collect some low-level
9 tools I intended to build.  There are 3 subdirectories:
10
11 benchmarks/
12         This should be a collection of useful microbenchmarks.  The hope is
13         that people can use these to tune some pieces of DRM code in relevant
14         ways.
15
16 tests/
17         This is a set of automated tests to run against the DRM to validate
18         changes.  Hopefully this can cover the relevant cases we need to
19         worry about, including backwards compatibility.
20
21 tools/
22         This is a collection of debugging tools that had previously been
23         built with the 2D driver but not shipped.  Some distros were hacking
24         up the 2D build to ship them.  Instead, here's a separate package for
25         people debugging the driver.
26
27 Note that most of these tools must be run as root.  Several tools require
28 MMIO register access (which may be denied if CONFIG_STRICT_DEVMEM is enabled).
29 When an X Server is running, benchmarks and tests clients won't be able to
30 run due to being unable to authenticate against it, unless you run them as
31 root.