Skip to content

fix(linux): doc fixes for benchmark demo on am64x #755

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
+61 −60
Open

fix(linux): doc fixes for benchmark demo on am64x #755

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
446b6b2
fix(linux): doc fixes for benchmark demo on am64x
yogeshhegde Jul 24, 2026
f3370d9
refactor(linux): benchmark demo user guide
yogeshhegde Jul 29, 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
121 changes: 61 additions & 60 deletions source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@

.. _Benchmark-Demo-User-Guide-label:

###########################
Benchmark Demo - User Guide
===========================
###########################

********
Overview
--------
********

The default application loaded on the AM64x is the Benchmark Demo. It's
purpose is to showcase the capabilities of the four R5F cores as well as
Expand All @@ -17,7 +19,7 @@
All of the necessary equipment requirement and instructions are provided here.

Hardware Prerequisites
----------------------
======================

- TI AM64x EVM

Expand All @@ -27,60 +29,54 @@

- Ethernet switch or ethernet router with DHCP service

- SD card (minimum 2GB)
- SD card (minimum 32GB)

Get Started
-----------
===========

1. Follow the instructions in section
:ref:`am64x-create-sd-card-with-default-images` to create an SD card with
the prebuilt WIC image.
#. Follow the instructions in section
:ref:`am64x-create-sd-card-with-default-images` to create an SD card with
the prebuilt WIC image.

Check warning on line 39 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

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

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

2. Insert the SD card into the AM64x EVM
#. Insert the SD card into the AM64x EVM

Check warning on line 41 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

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

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

3. Set the AM64x EVM Boot mode to "Boot from SD card"
#. Set the AM64x EVM Boot mode to "Boot from SD card"

Check warning on line 43 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

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

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

- SW2(1:8) on, on, off, off, off, off, on, off
- SW3(1:8) off, on, off, off, off, off, off, off
- SW2(1:8) on, on, off, off, off, off, on, off
- SW3(1:8) off, on, off, off, off, off, off, off

.. Image:: /images/boot_pins_sd_mode_oob.png
.. Image:: /images/boot_pins_sd_mode_oob.png

4. Connect an ethernet cable from your ethernet switch or router to the
AM64x EVM
#. Connect an ethernet cable from your ethernet switch or router to the
AM64x EVM

Check warning on line 51 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

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

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

5. Connect your PC to the same ethernet switch or router
#. Connect your PC to the same ethernet switch or router

6. Connect the UART (J26 via USB cable) to the PC's USB port.
#. Connect the UART (J26 via USB cable) to the PC's USB port.

Check warning on line 55 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

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

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

7. Open the the main UART0 port using the TeraTerm or other UART emulator
program. Set the port to 115200bps, 8 bit, no parity, 1 stop bit, no flow control
#. Open the the main UART0 port using the TeraTerm or other UART emulator

Check warning on line 57 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

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

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

Check warning on line 57 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.RepeatedWords] 'the' is repeated.

Raw Output:
{"message": "[RedHat.RepeatedWords] 'the' is repeated.", "location": {"path": "source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst", "range": {"start": {"line": 57, "column": 9}}}, "severity": "WARNING"}
program. Set the port to 115200bps, 8 bit, no parity, 1 stop bit, no flow control

8. Power on the AM64x
#. Power on the AM64x

9. After the Linux boot completes, login as "root", then type in "ifconfig" in
Linux prompt to find out the IP address for the AM64x EVM
#. After the Linux boot completes, login as "root", then type in "ifconfig" in
Linux prompt to find out the IP address for the AM64x EVM

Check warning on line 63 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

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

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

Check warning on line 63 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsWarnings] Consider using 'discover' rather than 'find out' unless updating existing content that uses the term.

Raw Output:
{"message": "[RedHat.TermsWarnings] Consider using 'discover' rather than 'find out' unless updating existing content that uses the term.", "location": {"path": "source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst", "range": {"start": {"line": 63, "column": 20}}}, "severity": "WARNING"}

.. Image:: /images/OOB_Linux_ifconfig.png
.. Image:: /images/OOB_Linux_ifconfig.png

10. Run the command below
#. On the PC, open a Internet Browser and enter in the
following: ``http://IP_ADDRESS_OF_AM64x_EVM:3000``, for example, ``http://192.168.81.198:3000``

.. code-block:: console
#. The following web page will pop up:

systemctl restart rpmsg_json.service
.. Image:: /images/OOB_GUI_root.png

11. On the PC, open a Internet Browser and enter in the
following: \ http://IP_ADDRESS_OF_AM64x_EVM:8081, for example, http://192.168.86.198:8081
#. Click on the "Benchmark Demo":

Check warning on line 74 in source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsWarnings] Consider using 'click' rather than 'Click on' unless updating existing content that uses the term.

Raw Output:
{"message": "[RedHat.TermsWarnings] Consider using 'click' rather than 'Click on' unless updating existing content that uses the term.", "location": {"path": "source/linux/Demo_User_Guides/Benchmark_Demo_User_Guide.rst", "range": {"start": {"line": 74, "column": 4}}}, "severity": "WARNING"}

12. The following web page will pop up:
.. Image:: /images/OOB_GUI_stats.png

.. Image:: /images/OOB_GUI_root.png

13. Click on the "Benchmark Demo":

.. Image:: /images/OOB_GUI_stats.png

14. With the current release, the R5F app for each R5F core are fixed. User can only
change the "Options" for each core, then click "LOAD" to refresh the statistics
#. With the current release, the R5F app for each R5F core are fixed. User can only
change the "Options" for each core, then click "LOAD" to refresh the statistics

+-------------+------------------+----------------------+-----------------------------------------------------------+
| **R5 Core** | **App Name** | Default Option | **Description** |
Expand All @@ -96,12 +92,12 @@
+-------------+------------------+----------------------+-----------------------------------------------------------+

Software Architecture
---------------------
=====================

.. Image:: /images/OOB_SW_arch.png

Building Blocks
---------------
===============

- **User Interface:** The GUI was built by using `GUI Composer <https://dev.ti.com/gc/v2/>`__. The
Benchmark Demo is the second page where inputs and outputs can be
Expand All @@ -124,10 +120,10 @@
- Web server code is built on Node JS

Demo Internals
--------------
==============

Programming Paradigm
~~~~~~~~~~~~~~~~~~~~
--------------------

- The user interface of the demo is built from GUI Composer and runs on
a PC's browser
Expand All @@ -143,15 +139,15 @@
(Procedural Programming Paradigm)

Node JS
~~~~~~~
-------

When the AM64x boots, an initialization script executes the web server
code by calling the Node JS code. Several node packages are used to edit
the JSON file, create the demo instance, and serve up the files to the
client.

HTTP
~~~~
----

All data communication is handled via HTTP. Benchmark data from the
AM64x is requested by the GUI every second, whereas the option selection
Expand All @@ -160,7 +156,7 @@
is a JSON string containing the input/output benchmark data.

JSON
~~~~
----

A JSON file has been used to exchange structured information between the
web server and the A53 Linux application (a user space application
Expand All @@ -171,28 +167,33 @@
will then be displayed on the GUI every second.

Build Baremetal Demos and Update SD card
----------------------------------------
========================================

1. Install MCU+ SDK `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/latest/exports/docs/api_guide_am64x/SDK_DOWNLOAD_PAGE.html>`__.
#. Install MCU+ SDK `[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/latest/exports/docs/api_guide_am64x/SDK_DOWNLOAD_PAGE.html>`__.
Refer MCU+ SDK benchmark demo user guide
`[Use Link] <https://software-dl.ti.com/mcu-plus-sdk/esd/AM64X/latest/exports/docs/api_guide_am64x/EXAMPLE_BENCHMARKDEMO.html>`__
on how to build demos.

2. Once the R5F binaries are available, copy them to Linux file system in folder /lib/firmware/mcusdk-benchmark_demo/.
#. Once the R5F binaries are available, copy them to Linux file system in folder :file:`/lib/firmware/mcusdk-benchmark_demo/`.
The copy step can only be done using a Linux machine since the Linux filesystem on the
SD card cannot be seen on a Windows machine. Once copied, make sure the soft links are pointing to the correct binaries.

Directory Structure
-------------------

The source code can be found at `[this link] <https://git.ti.com/cgit/processor-sdk/sitara-apps/>`__.

+------+--------------------------------------------------+----------------------------------------------------------------------------------------+
| | **Directory Name** | **Description** |
+======+==================================================+========================================================================================+
| 1 | apps/benchmark\_demo/webserver\_app/app | GUI code and component files |
+------+--------------------------------------------------+----------------------------------------------------------------------------------------+
| 2 | apps/benchmark\_demo/webserver\_app/linux\_app | Linux application code handles the IPC RPMsg\_char and the JSON file update for A53 |
+------+--------------------------------------------------+----------------------------------------------------------------------------------------+
| 3 | apps/benchmark\_demo/webserver\_app/webserver | Web server and node files |
+------+--------------------------------------------------+----------------------------------------------------------------------------------------+
===================

The source code can be found at `[this link] <https://github.com/TexasInstruments/webserver-oob-demo>`__.

.. list-table:: Directory Structure
:widths: 25 75
:header-rows: 1

* - **Directory Name**
- **Description**
* - :file:`common/app/`
- GUI code
* - :file:`common/app/demos/benchmark/`
- Web page load code
* - :file:`devices/am64xx/linux_app/`
- Linux application code handles the IPC ``RPMsg_char`` and the JSON file update for A53
* - :file:`demos/benchmark/`
- Web server and node files
Loading