Skip to content

feat(display_cluster): add building display cluster image through installer #803

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

Open
yogeshhegde wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat(display_cluster): add building display cluster image through installer #803

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a798d55
feat(display_cluster): add building display cluster image through ins…
yogeshhegde Sep 29, 2026
d56be98
refactor(display_cluster): fix indentation issues thoughout the file
yogeshhegde Nov 12, 2026
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
60 changes: 46 additions & 14 deletions source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@
Hardware Prerequisites
======================

- `SK-AM62P-LP <https://www.ti.com/tool/SK-AM62P-LP>`__
#. `SK-AM62P-LP <https://www.ti.com/tool/SK-AM62P-LP>`__

- Microtips LVDS Panel
#. Microtips LVDS Panel

Check warning on line 18 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

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

Raw Output:
{"message":"[RedHat.Definitions] Define acronyms and abbreviations (such as 'LVDS') on first occurrence if they're likely to be unfamiliar.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":18,"column":14},"end":{"line":18,"column":18}}},"severity":"INFO","code":{"value":"RedHat.Definitions","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#definitions"}}

Check warning on line 18 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'Microtips'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.

Raw Output:
{"message":"[RedHat.Spelling] Verify the word 'Microtips'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":18,"column":4},"end":{"line":18,"column":13}}},"severity":"WARNING","code":{"value":"RedHat.Spelling","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#spelling"}}

- SD card (minimum 32GB)
#. SD card (minimum 32GB)

- PC (Windows or Linux) to flash wic image onto an SD Card
#. PC (Windows or Linux) to flash wic image onto an SD Card

Check warning on line 22 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'wic'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.

Raw Output:
{"message":"[RedHat.Spelling] Verify the word 'wic'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":22,"column":35},"end":{"line":22,"column":38}}},"severity":"WARNING","code":{"value":"RedHat.Spelling","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#spelling"}}

- :file:`tisdk-display-cluster` wic image (Available at |__SDK_DOWNLOAD_URL__|)
#. :file:`tisdk-display-cluster` wic image (Available at |__SDK_DOWNLOAD_URL__|)

Check warning on line 24 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'wic'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.

Raw Output:
{"message":"[RedHat.Spelling] Verify the word 'wic'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":24,"column":34},"end":{"line":24,"column":37}}},"severity":"WARNING","code":{"value":"RedHat.Spelling","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#spelling"}}

Steps to validate Display Cluster Demo
======================================
Expand All @@ -36,7 +36,7 @@

#. The entire screen is controlled by the A53 displaying the Cluster except the region where MCU R5 is overlaying the Tell Tales.

.. figure:: /images/AM62P-display-cluster.png
.. figure:: /images/AM62P-display-cluster.png
:width: 500
:height: 400

Expand All @@ -53,21 +53,53 @@
Building Display Cluster wic image from Yocto
---------------------------------------------

#. To build the display cluster wic image, please refer :ref:`Processor SDK - Building the SDK with Yocto <building-the-sdk-with-yocto>`
#. To build the display cluster wic image, please refer :ref:`Processor SDK - Building the SDK with Yocto <building-the-sdk-with-yocto>`

Check warning on line 56 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message":"[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":56,"column":107},"end":{"line":56,"column":136}}},"severity":"INFO","code":{"value":"RedHat.UserReplacedValues","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#user-replaced-values"}}

Check warning on line 56 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.DoNotUseTerms] Do not use "please" in technical documentation.

Raw Output:
{"message":"[RedHat.DoNotUseTerms] Do not use \"please\" in technical documentation.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":56,"column":44},"end":{"line":56,"column":50}}},"severity":"WARNING","code":{"value":"RedHat.DoNotUseTerms","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#do-not-use-terms"}}

Check warning on line 56 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'wic'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.

Raw Output:
{"message":"[RedHat.Spelling] Verify the word 'wic'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":56,"column":33},"end":{"line":56,"column":36}}},"severity":"WARNING","code":{"value":"RedHat.Spelling","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#spelling"}}

Building Display Cluster image from SDK Installer

Check warning on line 58 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'Building Display Cluster image from SDK Installer'.

Raw Output:
{"message":"[RedHat.Headings] Use sentence-style capitalization in 'Building Display Cluster image from SDK Installer'.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":58,"column":1},"end":{"line":58,"column":50}}},"severity":"INFO","code":{"value":"RedHat.Headings","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#headings"}}
-------------------------------------------------

#. :ref:`Download and Install the SDK <download-and-install-sdk>`

Check warning on line 61 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.

Raw Output:
{"message":"[RedHat.UserReplacedValues] Separate words by underscores in user-replaced values.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":61,"column":39},"end":{"line":61,"column":65}}},"severity":"INFO","code":{"value":"RedHat.UserReplacedValues","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#user-replaced-values"}}

#. Compile U-boot for Display cluster, by issuing the following command

.. code-block:: console

DISPLAY_CLUSTER=1 make u-boot

#. The compiled u-boot will be located at :file:`<SDK-root>/board-support/u-boot-build`

Check warning on line 69 in source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

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

Raw Output:
{"message":"[RedHat.PassiveVoice] 'be located' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.","location":{"path":"source/linux/Demo_User_Guides/Display_Cluster_User_Guide.rst","range":{"start":{"line":69,"column":29},"end":{"line":69,"column":39}}},"severity":"INFO","code":{"value":"RedHat.PassiveVoice","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#passive-voice"}}

#. Create a temporary copy of the folder :file:`<SDK-root>/board-support/prebuilt-images/am62pxx-evm-display-cluster`

.. code-block:: console

cp -arv <SDK-root>/board-support/prebuilt-images/am62pxx-evm-display-cluster /tmp/am62pxx-evm-display-cluster-boot

#. Copy compiled u-boot to the temporary folder

.. code-block:: console

cp -arv <SDK-root>/board-support/u-boot-build/r5/tiboot3.bin /tmp/am62pxx-evm-display-cluster-boot
cp -arv <SDK-root>/board-support/u-boot-build/a53/tispl.bin /tmp/am62pxx-evm-display-cluster-boot
cp -arv <SDK-root>/board-support/u-boot-build/a53/u-boot.img /tmp/am62pxx-evm-display-cluster-boot

#. Create the SD card by following the instructions provided at :ref:`Create SD Card <processor-sdk-linux-create-sd-card-with-custom-images>` guide.

Building the Display Cluster Demo from source
---------------------------------------------

#. The source code for Display Cluster demo is available as part of the `ti-apps-launcher <https://github.com/TexasInstruments/ti-apps-launcher>`__.
#. Display Cluster Demo does not require building the source code.
#. The demo can run provided that the app source code and Qt 6's ``qmlscene`` utility are present.
#. The source code for Display Cluster demo is available as part of the `ti-apps-launcher <https://github.com/TexasInstruments/ti-apps-launcher>`__.

#. Display Cluster Demo does not require building the source code.

#. The demo can run provided that the app source code and Qt 6's ``qmlscene`` utility are present.

#. To start the demo, issue the following command
.. code-block:: console
#. To start the demo, issue the following command

.. code-block:: console

qmlscene --fullscreen apps/auto_cluster.qml
qmlscene --fullscreen apps/auto_cluster.qml

Building the MCU Firmware from sources
--------------------------------------

#. Please refer to the `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/11_01_01_08/exports/docs/api_guide_am62px/group__DRV__DSS__MODULE.html>`__
#. Please refer to the `MCU+ SDK Documentation <https://software-dl.ti.com/mcu-plus-sdk/esd/AM62PX/11_01_01_08/exports/docs/api_guide_am62px/group__DRV__DSS__MODULE.html>`__
Loading