Skip to content

Update psdk graphics docs in preparation for AM57 11.01 release #451

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
praneethbajjuri merged 5 commits into from
Sep 22, 2025
Merged

Update psdk graphics docs in preparation for AM57 11.01 release #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
143062f
fix(linux): Remove mentions of IMG demos within SGX Overview
Antonios-C Sep 16, 2025
07dae7b
chore(gfx): Clarify gfx_check.sh script creation
Antonios-C Sep 16, 2025
b21fcd4
chore(gfx): Clarify creation of powervr.ini for SGX debug
Antonios-C Sep 16, 2025
0948d11
chore(gfx): Give example of DisableHWTextureUpload app hint
Antonios-C Sep 16, 2025
8cfe813
fix(linux): Delete OMAP_DRM as DSS apps no longer packaged
Antonios-C Sep 16, 2025
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
1 change: 0 additions & 1 deletion configs/AM335X/AM335X_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ linux/Foundational_Components/Graphics/Common/PVR_Tools
linux/Foundational_Components/Graphics/Common/QT_Graphics_Framework
linux/Foundational_Components/Graphics/Common/Weston
linux/Foundational_Components/Graphics/SGX/AM3_Beagle_Bone_Black_Configuration
linux/Foundational_Components/Graphics/SGX/OMAP_DRM
linux/Foundational_Components/Graphics/SGX/Overview
linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info
linux/Foundational_Components/Graphics/SGX/Build_Guide
Expand Down
1 change: 0 additions & 1 deletion configs/AM437X/AM437X_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ linux/Foundational_Components/Graphics/Common/OpenGL_ES
linux/Foundational_Components/Graphics/Common/PVR_Tools
linux/Foundational_Components/Graphics/Common/QT_Graphics_Framework
linux/Foundational_Components/Graphics/Common/Weston
linux/Foundational_Components/Graphics/SGX/OMAP_DRM
linux/Foundational_Components/Graphics/SGX/Overview
linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info
linux/Foundational_Components/Graphics/SGX/Build_Guide
Expand Down
1 change: 0 additions & 1 deletion configs/AM57X/AM57X_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@ linux/Foundational_Components/Graphics/Common/OpenGL_ES
linux/Foundational_Components/Graphics/Common/PVR_Tools
linux/Foundational_Components/Graphics/Common/QT_Graphics_Framework
linux/Foundational_Components/Graphics/Common/Weston
linux/Foundational_Components/Graphics/SGX/OMAP_DRM
linux/Foundational_Components/Graphics/SGX/Overview
linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info
linux/Foundational_Components/Graphics/SGX/Build_Guide
Expand Down
1 change: 0 additions & 1 deletion configs/AM65X/AM65X_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ linux/Foundational_Components/Graphics/Common/PVR_Tools
linux/Foundational_Components/Graphics/Common/QT_Graphics_Framework
linux/Foundational_Components/Graphics/Common/Weston
linux/Foundational_Components/Graphics/SGX/AM3_Beagle_Bone_Black_Configuration
linux/Foundational_Components/Graphics/SGX/OMAP_DRM
linux/Foundational_Components/Graphics/SGX/Overview
linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info
linux/Foundational_Components/Graphics/SGX/Build_Guide
Expand Down
1 change: 0 additions & 1 deletion configs/GEN/GEN_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ linux/Foundational_Components/Graphics/Common/PVR_Tools
linux/Foundational_Components/Graphics/Common/QT_Graphics_Framework
linux/Foundational_Components/Graphics/Common/Weston
linux/Foundational_Components/Graphics/SGX/AM3_Beagle_Bone_Black_Configuration
linux/Foundational_Components/Graphics/SGX/OMAP_DRM
linux/Foundational_Components/Graphics/SGX/Overview
linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info
linux/Foundational_Components/Graphics/SGX/Build_Guide
Expand Down
95 changes: 0 additions & 95 deletions source/linux/Foundational_Components/Graphics/SGX/OMAP_DRM.rst
View file
Open in desktop

This file was deleted.

45 changes: 0 additions & 45 deletions source/linux/Foundational_Components/Graphics/SGX/Overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,48 +61,3 @@ The following picture shows the software architecture of Graphics in
Please see the :doc:`Build_Guide` for more information about integration of this
software stack into other ecosystems.

Graphics demos
==============

Along with the graphics driver and user space libraries, the SDK also includes
example applications. Some of the demos are from the IMG Native_SDK examples.

The following demos are available to run under the Wayland windowing system.

.. code-block:: console

# /usr/bin/SGX/demos/Wayland/OpenGLESDeferredShading
# /usr/bin/SGX/demos/Wayland/OpenGLESGaussianBlur
# /usr/bin/SGX/demos/Wayland/OpenGLESImageBasedLighting
# /usr/bin/SGX/demos/Wayland/OpenGLESIntroducingPVRCamera
# /usr/bin/SGX/demos/Wayland/OpenGLESIntroducingPVRUtils
# /usr/bin/SGX/demos/Wayland/OpenGLESIntroducingUIRenderer
# /usr/bin/SGX/demos/Wayland/OpenGLESNavigation2D
# /usr/bin/SGX/demos/Wayland/OpenGLESNavigation3D
# /usr/bin/SGX/demos/Wayland/OpenGLESParticleSystem

Running demos in null window system mode
----------------------------------------

The graphics demos can also run in null-window system mode outside of Wayland
windowing system as full screen applications. To do so, :ref:`stop Weston
<stopping-weston>`. After that, access the command line from serial console, SSH
console, or LCD console.

Please make sure the board has at least one display connected before running
these demos.

.. code-block:: console

# /usr/bin/SGX/demos/DRM/OGLES2Coverflow
# /usr/bin/SGX/demos/DRM/OGLES2ChameleonMan
# /usr/bin/SGX/demos/DRM/OGLES2ExampleUI
# /usr/bin/SGX/demos/DRM/OGLES2Navigation

After you see the output on the display interface, press *q* to exit the
application.

Some of the demos under null windowing system require the user to pass in
the DRM connector id. For information about how to get connector id,
see the :ref:`finding_the_connector_id` section.

16 changes: 14 additions & 2 deletions source/linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
Baselin-ing the current SGX driver environment
**********************************************

The the following script shows the current SGX driver environment on the target:
Create the following script to show the current SGX driver environment on the target:

Check warning on line 19 in source/linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'SGX') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'SGX') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/linux/Foundational_Components/Graphics/SGX/SGX_Debug_Info.rst", "range": {"start": {"line": 19, "column": 49}}}, "severity": "INFO"}

.. code-block:: sh
:caption: gfx_check.sh
Expand Down Expand Up @@ -47,6 +47,14 @@
echo "Linux Kernel version"
uname -a

If you are not using any app hints, or have not created the :file:`powervr.ini` file then you should see the following:

.. code-block:: text

WSEGL settings
cat: /etc/powervr.ini: No such file or directory


**************************************************
Runtime checks and configuration of the SGX driver
**************************************************
Expand All @@ -62,7 +70,7 @@

The SGX driver supports some runtime configuration on the target by using a
configuration file. The optional configuration file is present in the Processor
SDK at :file:`/etc/powervr.ini`.
SDK at :file:`/etc/powervr.ini`. If no file is present, you need to create it.

Configuration items use the following syntax:

Expand Down Expand Up @@ -95,6 +103,10 @@

Useful to rule out problems in TQ.

.. code-block:: text

DisableHWTextureUpload=1

DefaultPixelFormat
==================

Expand Down
1 change: 0 additions & 1 deletion source/linux/Foundational_Components/Graphics/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ the details on the features supported by these hardware blocks.
SGX/Overview.rst
SGX/SGX_Debug_Info.rst
SGX/AM3_Beagle_Bone_Black_Configuration.rst
SGX/OMAP_DRM.rst
SGX/Build_Guide.rst

Rogue/Overview.rst
Expand Down