Skip to content

Commit 62d9dd4

Browse files
chore(linux): AM62LX/AM62PX: Fix ref release-specific-build-information
release-specific-build-information reference with list-table is used now for release specific tag info on AM62Lx and AM62PX. Hence updating the references in Foundational_Components sections accordingly. While at it, fixed some vale errors and warnings. TODO: Fix up the same methodology for all other devices closer to their next release. Signed-off-by: Praneeth Bajjuri <[email protected]>
1 parent 7d14b75 commit 62d9dd4

File tree

3 files changed

+28
-38
lines changed

3 files changed

+28
-38
lines changed

source/linux/Foundational_Components/U-Boot/BG-Setup-K3.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ on Ubuntu 22.04+, run the following command in the terminal prompt:
2020
.. note::
2121

2222
The recommended host machine for building U-Boot is Ubuntu 22.04.
23-
Users of Ubuntu 18.04 may need to install Python 3.7 or higher. If using the default Python 3.6
24-
that comes with Ubuntu 18.04, users may need to install these additional dependencies:
23+
Users of Ubuntu 18.04 might need to install Python 3.7 or later. If using the default Python 3.6
24+
that is in Ubuntu 18.04, users might need to install these additional dependencies:
2525

2626
.. code-block:: console
2727
@@ -42,7 +42,7 @@ Getting the Source Code
4242

4343
The easiest way to get access to the source code is by
4444
downloading and installing the Processor SDK Linux. Once installed,
45-
the source code is included in the SDK at the path :file:`<path to tisdk>/board-support`.
45+
the source code is in the SDK at the path :file:`<path to tisdk>/board-support`.
4646
For your convenience the sources also includes
4747
git repositories including commit history.
4848

@@ -51,9 +51,7 @@ git repositories including commit history.
5151
Alternatively, BL-1 and U-Boot sources can directly be fetched from GIT. The GIT
5252
repo URL, branch and commit id can be found in the release notes:
5353

54-
- ti-u-boot version: :ref:`u-boot-release-notes`
55-
- ti-linux-firmware version: :ref:`ti-linux-fw-release-notes`
56-
- TF-A version: :ref:`tf-a-release-notes`
54+
- ti-u-boot , OPTEE, TF-A and ti-linux-firmware version is at :ref:`release-specific-build-information`
5755

5856
.. ifconfig:: CONFIG_part_variant not in ('AM62LX')
5957

source/linux/Foundational_Components/U-Boot/UG-General-Info.rst

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ General Information
1717
.. note::
1818

1919
The recommended host machine for building U-Boot is Ubuntu 22.04.
20-
Users of Ubuntu 18.04 may need to install Python 3.7 or higher. If using the default Python 3.6
21-
that comes with Ubuntu 18.04, users may need to install these additional dependencies:
20+
Users of Ubuntu 18.04 might need to install Python 3.7 or later. If using the default Python 3.6
21+
that is in Ubuntu 18.04, users might need to install these additional dependencies:
2222

2323
.. code-block:: console
2424
@@ -32,20 +32,20 @@ General Information
3232
enable secondary program loader.
3333
The easiest way to get access to the BL-1 source code is by
3434
downloading and installing the Processor SDK Linux. Once installed,
35-
the BL-1 source code is included in the SDK at the path ``<path to tisdk>/board-support``.
35+
the BL-1 source code is in the SDK at the path ``<path to tisdk>/board-support``.
3636
For your convenience the sources also includes the BL-1's
3737
git repository including commit history.
3838

3939
Alternatively, BL-1 sources can directly be fetched from GIThub. The GIT
40-
repo URL, branch and commit id can be found in the :ref:`u-boot-release-notes`
40+
repo URL, branch and commit id can be found at :ref:`release-specific-build-information`.
4141
section of the release notes.
4242

4343
.. _Build-BL1-label:
4444

4545
Build BL-1
4646
^^^^^^^^^^
4747
.. note::
48-
The following commands are intended to be run from the root of the
48+
The following commands needs to run from the root of the
4949
TF-A tree unless otherwise specified. The root of the TF-A tree is
5050
the top-level directory and can be identified by looking for the
5151
"licenses" directory.
@@ -73,12 +73,12 @@ Getting the U-Boot Source Code
7373

7474
The easiest way to get access to the U-boot source code is by
7575
downloading and installing the Processor SDK Linux. Once installed,
76-
the U-Boot source code is included in the SDK at the path ``<path to tisdk>/board-support``.
76+
the U-Boot source code is in the SDK at the path ``<path to tisdk>/board-support``.
7777
For your convenience the sources also includes the U-Boot's
7878
git repository including commit history.
7979

80-
Alternatively, U-Boot sources can directly be fetched from GIT. The GIT
81-
repo URL, branch and commit id can be found in the :ref:`u-boot-release-notes`
80+
Alternatively, U-Boot sources can directly be fetched from Git.
81+
The Git repo URL, branch and commit id can be found in the :ref:`u-boot-release-notes` :ref:`release-specific-build-information`
8282
section of the release notes.
8383

8484

@@ -610,12 +610,7 @@ Build U-Boot
610610

611611
.. note::
612612

613-
Where to get the sources:
614-
615-
- ti-u-boot version: :ref:`u-boot-release-notes`
616-
- ti-linux-firmware version: :ref:`ti-linux-fw-release-notes`
617-
- TF-A version: :ref:`tf-a-release-notes`
618-
- OP-TEE version: :ref:`optee-release-notes`
613+
Where to get the sources: :ref:`release-specific-build-information`.
619614

620615
.. code-block:: console
621616
@@ -653,11 +648,7 @@ Build U-Boot
653648

654649
.. note::
655650

656-
Where to get the sources:
657-
658-
- ti-u-boot version: :ref:`u-boot-release-notes`
659-
- ti-linux-firmware version: :ref:`ti-linux-fw-release-notes`
660-
- TF-A version: :ref:`tf-a-release-notes`
651+
Where to get the sources: :ref:`release-specific-build-information`.
661652

662653
.. code-block:: console
663654
@@ -711,7 +702,7 @@ Build U-Boot
711702

712703
.. note::
713704

714-
It is also possible to pick up a custom DM binary by adding TI_DM argument pointing to the file. If not provided, it defaults to picking up the DM binary from BINMAN_INDIRS. This is only applicable to devices that utilize split firmware.
705+
It is also possible to pick up a custom DM binary by adding TI_DM argument pointing to the file. If not provided, it defaults to picking up the DM binary from BINMAN_INDIRS. This is only applicable to devices that use split firmware.
715706

716707
.. ifconfig:: CONFIG_part_variant in ('AM65X', 'J721E', 'J7200', 'AM64X', 'AM62X', 'AM62AX', 'AM62DX', 'AM62LX', 'AM62PX', 'J721S2', 'J784S4','J742S2', 'J722S')
717708

@@ -921,7 +912,7 @@ Build U-Boot
921912
Also, (For GP devices only) rename :file:`tispl.bin_unsigned` to :file:`tispl.bin` and :file:`u-boot.img_unsigned` to :file:`u-boot.img` as well.
922913

923914
Image Formats
924-
^^^^^^^^^^^^^^^
915+
^^^^^^^^^^^^^
925916

926917
.. ifconfig:: CONFIG_part_variant not in ('J7200', 'AM64X', 'J721S2', 'J721E', 'AM62X', 'AM62AX', 'AM62LX', 'J784S4','J742S2', 'J722S', 'AM57X')
927918

@@ -1897,7 +1888,7 @@ Boot Flow
18971888
and complete the boot process.
18981889

18991890
U-Boot Environment
1900-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1891+
^^^^^^^^^^^^^^^^^^
19011892

19021893
.. note::
19031894

@@ -1968,7 +1959,7 @@ Then start the USB subsystem:
19681959
19691960
=> usb start
19701961
1971-
The default behavior of U-Boot is to utilize all information that a DHCP
1962+
The default behavior of U-Boot is to use all information that a DHCP
19721963
server passes to us when the user issues the **dhcp** command. This will
19731964
include the dhcp parameter *next-server* which indicates where to fetch
19741965
files from via TFTP. There may be times however where the dhcp server on
@@ -1982,7 +1973,7 @@ the server. In this case the following steps can be helpful:
19821973
=> setenv serverip correct.server.ip
19831974
=> tftp
19841975
1985-
Another alternative is to utilize the full syntax of the tftp command:
1976+
Another alternative is to use the full syntax of the tftp command:
19861977

19871978
.. code-block:: console
19881979
@@ -2022,7 +2013,7 @@ RAM in the range of ``[0x80000000, 0xFCE00000]`` is safely available for
20222013
use.
20232014

20242015
Device Trees
2025-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2016+
^^^^^^^^^^^^
20262017

20272018
A note about device trees. Now all supported boards are required to use a
20282019
device tree to boot. To facilitate this in supported platforms, a command

source/linux/Foundational_Components_ATF.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
.. _foundational-components-atf:
22

33
ARM Trusted Firmware-A
4-
========================================
4+
======================
55
.. rubric:: Overview
66

77
Trusted Firmware-A (TF-A) provides a reference implementation of secure world
88
software for Armv7-A and Armv8-A, including a Secure Monitor executing at
99
Exception Level 3 (EL3).
1010

11-
ATF is used as the initial start code on ARMv8-A cores for all K3 platforms.
11+
Arm Trusted Firmware (ATF) is the initial code on ARMv8-A cores for all K3 platforms.
1212
After setting up the initial core state and applying any needed errata fixes
1313
it sets up itself as the EL3 monitor handler. Following that, it installs the secure
14-
world software (OP-TEE) and passes execution on to either the Linux kernel or U-Boot
15-
in the non-secure world.
14+
world open source Trusted Execution Environment (OP-TEE) software and passes execution
15+
on to either the Linux kernel or U-Boot in the non-secure world.
1616

1717
.. ifconfig:: CONFIG_part_variant in ('AM62LX')
1818

@@ -28,8 +28,9 @@ in the non-secure world.
2828
2929
.. rubric:: Getting the ATF Source Code
3030

31-
The pre-built TF-A binary should be packaged in TI Processor SDK: <path-to-processor-sdk>/board-support/prebuilt-images/<optional-build-machine-name>/bl31.bin.
32-
Use this binary since it has been tested with TI Processor SDK.
31+
The pre-built TF-A binary is in TI Processor SDK:
32+
<path-to-processor-sdk>/board-support/prebuilt-images/<optional-build-machine-name>/bl31.bin.
33+
Use this binary since it is tested with TI Processor SDK.
3334

3435
If it is not possible to use pre-build binary, use the following:
3536

@@ -38,7 +39,7 @@ If it is not possible to use pre-build binary, use the following:
3839
$ git clone https://github.com/TexasInstruments/arm-trusted-firmware.git
3940
$ git checkout <hash>
4041
41-
Where <hash> is the commit shown here: :ref:`tf-a-release-notes`.
42+
Where <hash> is the commit shown here: :ref:`tf-a-release-notes` :ref:`release-specific-build-information`.
4243

4344
|
4445

0 commit comments

Comments
 (0)