| Message ID | 20191101154314.25435-1-gabrielabittencourt00@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v2] drm/doc: Adding VKMS module description and use to "Testing and Validation" | expand |
Hi Gabriela, Thank you very much for working on improving our documentation. For me the patch looks good, I just have some nitpick. First, it is recommended to use an imperative mood in the subject line. Try something like this: Add VKMS module description under "Testing and Validation" section On 11/01, Gabriela Bittencourt wrote: > Add a description on VKMS module and the cases in which it should be used. > There's a brief explanation on how to set it and use it in a VM, along with > an example of running an igt-test. > > Signed-off-by: Gabriela Bittencourt <gabrielabittencourt00@gmail.com> > > --- > > Changes in v2: > - Avoid repetition of words in the same sentence; > - Make the explanation on 'setting the kernel' shorter, eliminate the > 'make menuconfig' command; > - Add tab on enumeration to have one line per item; > - Clarify from each machine igt-tests commands should be ran on. > > Tested the patch using 'make htmldocs' to make sure the output .html is > correct. > > Hi DRM-community, > this is my first (of many, I hope) patch in this subsystem. I hope to have > a lot of learning (and fun :)) working with you guys. > I'm starting by documenting the VKMS driver in "Userland interfaces", if I > have been inaccurate in my description or if I misunderstood some concept, > please let me know. > --- > Documentation/gpu/drm-uapi.rst | 36 ++++++++++++++++++++++++++++++++++ > 1 file changed, 36 insertions(+) > > diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst > index 94f90521f58c..1586cbba05d0 100644 > --- a/Documentation/gpu/drm-uapi.rst > +++ b/Documentation/gpu/drm-uapi.rst > @@ -285,6 +285,42 @@ run-tests.sh is a wrapper around piglit that will execute the tests matching > the -t options. A report in HTML format will be available in > ./results/html/index.html. Results can be compared with piglit. > > +Using VKMS to test DRM API > +-------------------------- > + > +VKMS is a software-only model of a KMS driver that is useful for testing > +and for running compositors. VKMS aims to enable a virtual display without > +the need for a hardware display capability. These characteristics made VKMS > +a perfect tool for validating the DRM core behavior and also support the > +compositor developer. VKMS makes it possible to test DRM functions in a > +virtual machine without display, simplifing the validation of some of the /simplifing/simplifying/ > +core changes. > + > +To Validate changes in DRM API with VKMS, start setting the kernel: make > +sure to enable VKMS module; compile the kernel with the VKMS enabled and > +install it in the target machine. VKMS can be run in a Virtual Machine > +(QEMU, virtme or similar). It's recommended the use of KVM with the minimum > +of 1GB of RAM and four cores. > + > +It's possible to run the IGT-tests in a VM in two ways: Break line or add "::" at the end of the phrase, otherwise the above line will be bold. > + 1. Use IGT inside a VM > + 2. Use IGT from the host machine and write the results in a shared directory. > + > +As follow, there is an example of using a VM with a shared directory with > +the host machine to run igt-tests. As example it's used virtme:: > + /As example/As an example,/ Best Regards > + $ virtme-run --rwdir /path/for/shared_dir --kdir=path/for/kernel/directory --mods=auto > + > +Run the igt-tests in the guest machine, as example it's ran the 'kms_flip' > +tests:: > + > + $ /path/for/igt-gpu-tools/scripts/run-tests.sh -p -s -t "kms_flip.*" -v > + > +In this example, instead of build the igt_runner, Piglit is used > +(-p option); it's created html summary of the tests results and it's saved > +in the folder "igt-gpu-tools/results"; it's executed only the igt-tests > +matching the -t option. > + > Display CRC Support > ------------------- > > -- > 2.20.1 >
diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst index 94f90521f58c..1586cbba05d0 100644 --- a/Documentation/gpu/drm-uapi.rst +++ b/Documentation/gpu/drm-uapi.rst @@ -285,6 +285,42 @@ run-tests.sh is a wrapper around piglit that will execute the tests matching the -t options. A report in HTML format will be available in ./results/html/index.html. Results can be compared with piglit. +Using VKMS to test DRM API +-------------------------- + +VKMS is a software-only model of a KMS driver that is useful for testing +and for running compositors. VKMS aims to enable a virtual display without +the need for a hardware display capability. These characteristics made VKMS +a perfect tool for validating the DRM core behavior and also support the +compositor developer. VKMS makes it possible to test DRM functions in a +virtual machine without display, simplifing the validation of some of the +core changes. + +To Validate changes in DRM API with VKMS, start setting the kernel: make +sure to enable VKMS module; compile the kernel with the VKMS enabled and +install it in the target machine. VKMS can be run in a Virtual Machine +(QEMU, virtme or similar). It's recommended the use of KVM with the minimum +of 1GB of RAM and four cores. + +It's possible to run the IGT-tests in a VM in two ways: + 1. Use IGT inside a VM + 2. Use IGT from the host machine and write the results in a shared directory. + +As follow, there is an example of using a VM with a shared directory with +the host machine to run igt-tests. As example it's used virtme:: + + $ virtme-run --rwdir /path/for/shared_dir --kdir=path/for/kernel/directory --mods=auto + +Run the igt-tests in the guest machine, as example it's ran the 'kms_flip' +tests:: + + $ /path/for/igt-gpu-tools/scripts/run-tests.sh -p -s -t "kms_flip.*" -v + +In this example, instead of build the igt_runner, Piglit is used +(-p option); it's created html summary of the tests results and it's saved +in the folder "igt-gpu-tools/results"; it's executed only the igt-tests +matching the -t option. + Display CRC Support -------------------
Add a description on VKMS module and the cases in which it should be used. There's a brief explanation on how to set it and use it in a VM, along with an example of running an igt-test. Signed-off-by: Gabriela Bittencourt <gabrielabittencourt00@gmail.com> --- Changes in v2: - Avoid repetition of words in the same sentence; - Make the explanation on 'setting the kernel' shorter, eliminate the 'make menuconfig' command; - Add tab on enumeration to have one line per item; - Clarify from each machine igt-tests commands should be ran on. Tested the patch using 'make htmldocs' to make sure the output .html is correct. Hi DRM-community, this is my first (of many, I hope) patch in this subsystem. I hope to have a lot of learning (and fun :)) working with you guys. I'm starting by documenting the VKMS driver in "Userland interfaces", if I have been inaccurate in my description or if I misunderstood some concept, please let me know. --- Documentation/gpu/drm-uapi.rst | 36 ++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+)