Skip to content

docs(linux): Replace kmstest with kmsxxtest #378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeevantelukula merged 1 commit into from
Jul 15, 2025
Merged

docs(linux): Replace kmstest with kmsxxtest #378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/linux/Foundational_Components/Graphics/Common/Display.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The list of available DRM blocks is viewable using the application

For ADAS parts by default Display is disabled in linux via
k3-<soc>-vision-apps.dtso and enabled to be controlled by one of the
real time r5f core. So modetest, kmstest, weston will not work.
real time r5f core. So modetest, kmsxxtest, weston will not work.
To enabled it you need to modify k3-<soc>-vision-apps.dtso, rebuild
linux-dtbs and install. Also need to disable Display in r5f, rebuild
r5f FW using PSDK RTOS.
Expand Down
18 changes: 9 additions & 9 deletions source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@
Testing tidss
-------------

kmstest from kms++ is a good tool for testing tidss features. Note that any other applications using DRM (Weston, X) must be killed first. Another tool from kms++ is kmsprint, which can be used to print various bits of information about tidss.
kmsxxtest from kms++ is a good tool for testing tidss features. Note that any other applications using DRM (Weston, X) must be killed first. Another tool from kms++ is kmsprint, which can be used to print various bits of information about tidss.

Check warning on line 444 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.PassiveVoice] 'be used' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message": "[RedHat.PassiveVoice] 'be used' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 444, "column": 189}}}, "severity": "INFO"}

Check warning on line 444 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'kmsprint'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'kmsprint'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 444, "column": 169}}}, "severity": "WARNING"}

Check warning on line 444 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.PassiveVoice] 'be killed' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message": "[RedHat.PassiveVoice] 'be killed' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 444, "column": 125}}}, "severity": "INFO"}

Check warning on line 444 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Using] Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness.

Raw Output:
{"message": "[RedHat.Using] Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 444, "column": 85}}}, "severity": "WARNING"}

Check warning on line 444 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'tidss'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'tidss'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 444, "column": 49}}}, "severity": "WARNING"}

Check warning on line 444 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'kmsxxtest'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'kmsxxtest'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 444, "column": 1}}}, "severity": "WARNING"}

.. code-block:: console

Expand All @@ -456,7 +456,7 @@

.. code-block:: console

$ kmstest -c dp -r 640x480
$ kmsxxtest -c dp -r 640x480
Connector 0/@39: DP-1
Crtc 0/@37: 640x480 25.175 640/16/96/48/- 480/10/2/33/- 60 (59.94) 0xa 0x40
Plane 0/@31: 0,0-640x480
Expand All @@ -475,7 +475,7 @@
Crtc 0 (38) 800x480 28.569 800/48/32/80 480/3/7/6 60 (60.00)
Plane 0 (31) fb-id: 48 (crtcs: 0) 0,0 800x480 -> 0,0 800x480 (AR12 AB12 RA12 RG16 BG16 AR15 AB15 AR24 AB24 RA24 BA24 RG24 BG24 AR30 AB30 XR12 XB12 RX12 XR15 XB15 XR24 XB24 RX24 BX24 XR30 XB30 YUYV UYVY NV12)
FB 48 800x480
$ kmstest --device=/dev/dri/card2
$ kmsxxtest --device=/dev/dri/card2
Connector 0/@40: DSI-1
Crtc 0/@38: 800x480 28.569 800/48/32/80/- 480/3/7/6/- 60 (60.00) 0xa 0x48
Plane 0/@31: 0,0-800x480
Expand Down Expand Up @@ -507,8 +507,8 @@

.. _testing_tidss_properties:

Testing tidss properties with modetest and kmstest
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Testing tidss properties with modetest and kmsxxtest

Check warning on line 510 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'kmsxxtest'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'kmsxxtest'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 510, "column": 44}}}, "severity": "WARNING"}

Check warning on line 510 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'modetest'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'modetest'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 510, "column": 31}}}, "severity": "WARNING"}

Check warning on line 510 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'tidss'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'tidss'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 510, "column": 9}}}, "severity": "WARNING"}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

As the name suggests, ``modetest`` is DRM based mode setting test program available along with libdrm.
It is an easy-to-use tool to test different features provided by display HWs. The DRM driver for,
Expand Down Expand Up @@ -683,12 +683,12 @@

- **Cropping**

``kmstest`` utility can be used to demonstrate cropping in a video frame using a test pattern.
``kmsxxtest`` utility can be used to demonstrate cropping in a video frame using a test pattern.

Check warning on line 686 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.SimpleWords] Use simple language. Consider using 'show' or 'prove' rather than 'demonstrate'.

Raw Output:
{"message": "[RedHat.SimpleWords] Use simple language. Consider using 'show' or 'prove' rather than 'demonstrate'.", "location": {"path": "source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst", "range": {"start": {"line": 686, "column": 38}}}, "severity": "INFO"}
The user can specify the main video frame size and an input color format using the ``-f`` argument. Then the source region, also known as a view region, can be specified using the ``-v`` argument. This takes a secondary width and height to create a rectangle starting at a given coordinate. The destination region, or plane region, for the view can be specified using ``-p`` argument. This takes a third width, height and coordinate position to place an overlay with the associated view region's content.

.. code-block:: console

$ kmstest -c hdmi -p 0:0,0-1000x1000 -f 1000x1000-XR24 -v 0,0-1000x1000
$ kmsxxtest -c hdmi -p 0:0,0-1000x1000 -f 1000x1000-XR24 -v 0,0-1000x1000
Connector 1/@50: HDMI-A-1
Crtc 1/@48: [email protected] 138.500 1920/48/32/80/+ 1080/3/5/23/- 60 (59.93) 0x9 0x48
Plane 0/@31: 0,0-1000x1000
Expand All @@ -702,7 +702,7 @@

.. code-block:: console

$ kmstest -c hdmi -p 0:0,0-800x800 -f 1000x1000 -v 0,0-800x800
$ kmsxxtest -c hdmi -p 0:0,0-800x800 -f 1000x1000 -v 0,0-800x800
Connector 1/@50: HDMI-A-1
Crtc 1/@48: [email protected] 138.500 1920/48/32/80/+ 1080/3/5/23/- 60 (59.93) 0x9 0x48
Plane 0/@31: 0,0-800x800
Expand All @@ -716,7 +716,7 @@

.. code-block:: console

$ kmstest -c hdmi -p 0:500,200-800x800 -f 1000x1000 -v 200,100-800x800
$ kmsxxtest -c hdmi -p 0:500,200-800x800 -f 1000x1000 -v 200,100-800x800
Connector 1/@50: HDMI-A-1
Crtc 1/@48: [email protected] 138.500 1920/48/32/80/+ 1080/3/5/23/- 60 (59.93) 0x9 0x48
Plane 0/@31: 500,200-800x800
Expand Down
Loading