Skip to content
GitLab
Commit f54334a1 authored by Thomas Abraham's avatar Thomas Abraham
Browse files

infra/common: add a new file to list platform names 



Instead of repeating the 'platform names' table in multiple documents,
create a new file to list the platform names and remove the table that
lists the platform names in other documents. Let other documents
provide a link to this new document instead.

Signed-off-by: Thomas Abraham's avatarThomas Abraham <thomas.abraham@arm.com>
Change-Id: Iad828bc84674c5ddb59ba00c406e5404feffc586
parent f5f1327f
Hide whitespace changes
Inline Side-by-side
docs/infra/common/acs-test.rst
View file @ f54334a1
......@@ -28,35 +28,6 @@ results can then be looked into to determine the conformance to the SBSA and
SBBR standards.
Platform Names
--------------
Arm's Infra reference platforms are assigned names in order to allow the build
and execute scripts to recognize the platform that has to be buit and executed.
The names for the reference platforms are listed below. Please make a note
of the name of the platform of your choice. This name is required to start the
build and execute procedure. The names under 'Platform Name' column has to be
used in place of the placeholder <platform> as mentioned in the commands
listed below.
+--------------------------+-------------------------+
| Reference Platform | Platform Name |
+==========================+=========================+
| SGI-575 | sgi575 |
+--------------------------+-------------------------+
| RD-N1-Edge (Single Chip) | rdn1edge |
+--------------------------+-------------------------+
| RD-N1-Edge (Dual Chip) | rdn1edgex2 |
+--------------------------+-------------------------+
| RD-E1-Edge | rde1edge |
+--------------------------+-------------------------+
| RD-V1 | rdv1 |
+--------------------------+-------------------------+
| RD-V1-MC (Quad Chip) | rdv1mc |
+--------------------------+-------------------------+
| RD-N2 | rdn2 |
+--------------------------+-------------------------+
Download the required platform software
---------------------------------------
......@@ -80,13 +51,13 @@ To build the software stack, the command to be used is
::
./build-scripts/build-test-uefi.sh -p <platform> <command>
./build-scripts/build-test-uefi.sh -p <platform name> <command>
Supported command line options are listed below
* <platform>
* <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* <command>
......@@ -159,14 +130,14 @@ To boot and to start ACS test, the commands to be used are
::
./acs.sh -p <platform> -v <path to luv-live image> -n [true|false] -a <additional_params>
./acs.sh -p <platform name> -v <path to luv-live image> -n [true|false] -a <additional_params>
Supported command line options are listed below
* -p <platform>
* -p <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* -v <absolute path to the luv-live prebuilt image>
......@@ -293,3 +264,4 @@ Unmount the disk after analysing the logs using the following commands.
*Copyright (c) 2021, Arm Limited. All rights reserved.*
.. _Download sources: docs/infra/common/download-sources.rst
.. _Platform Names: docs/infra/common/platform_names.rst
docs/infra/common/buildroot-boot.rst
View file @ f54334a1
......@@ -31,36 +31,6 @@ This document describes the procedure to build and execute the software
stack with buildroot as the root filesystem.
Platform Names
--------------
Arm's Infra reference platforms are assigned names in order to allow the build
and execute scripts to recognize the platform that has to be buit and executed.
The names for the reference platforms are listed below. Please make a note
of the name of the platform of your choice. This name is required to start the
build and execute procedure. The names under 'Platform Name' column has to be
used in place of the placeholder ``<platform>`` as mentioned in the commands
listed below.
+--------------------------+-------------------------+
| Reference Platform | Platform Name |
+==========================+=========================+
| SGI-575 | sgi575 |
+--------------------------+-------------------------+
| RD-N1-Edge (Single Chip) | rdn1edge |
+--------------------------+-------------------------+
| RD-N1-Edge (Dual Chip) | rdn1edgex2 |
+--------------------------+-------------------------+
| RD-E1-Edge | rde1edge |
+--------------------------+-------------------------+
| RD-V1 | rdv1 |
+--------------------------+-------------------------+
| RD-V1-MC | rdv1mc |
+--------------------------+-------------------------+
| RD-N2 | rdn2 |
+--------------------------+-------------------------+
Sync the required platform software
-----------------------------------
......@@ -86,13 +56,13 @@ To build the software stack, the command to be used is
::
./build-scripts/rdinfra/build-test-buildroot.sh -p <platform> <command>
./build-scripts/rdinfra/build-test-buildroot.sh -p <platform name> <command>
Supported command line options are listed below
* <platform>
* <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* <command>
......@@ -196,14 +166,14 @@ To boot up to the buildroot prompt, the command to be used is
::
./boot-buildroot.sh -p <platform> -a <additional_params> -n [true|false]
./boot-buildroot.sh -p <platform name> -a <additional_params> -n [true|false]
Supported command line options are listed below
* -p <platform>
* -p <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* -n [true|false] (optional)
......@@ -250,3 +220,4 @@ Example commands to boot with buildroot as the filesystem are as listed below.
*Copyright (c) 2021, Arm Limited. All rights reserved.*
.. _Download sources: docs/infra/common/download-sources.rst
.. _Platform Names: docs/infra/common/platform_names.rst
docs/infra/common/busybox-boot.rst
View file @ f54334a1
......@@ -22,36 +22,6 @@ This document describes how to build the Neoverse RD platform software stack and
and use it to boot upto busybox on the Neoverse RD FVP.
Platform Names
--------------
Arm's Neoverse reference design platforms are assigned names in order to allow
the build and execute scripts to recognize the platform for which the software
has to be built and executed. The names for the reference platforms are listed
below. Please make a note of the name of the platform of your choice. This name
is required to start the build and execute procedure. The names under 'Platform
Name' column has to be used in place of the placeholder ``<platform>`` as
mentioned in the commands listed below.
+--------------------------+-------------------------+
| Reference Platform | Platform Name |
+==========================+=========================+
| SGI-575 | sgi575 |
+--------------------------+-------------------------+
| RD-N1-Edge (Single Chip) | rdn1edge |
+--------------------------+-------------------------+
| RD-N1-Edge (Dual Chip) | rdn1edgex2 |
+--------------------------+-------------------------+
| RD-E1-Edge | rde1edge |
+--------------------------+-------------------------+
| RD-Daniel Config-M | rddaniel |
+--------------------------+-------------------------+
| RD-Daniel Config-XLR | rddanielxlr |
+--------------------------+-------------------------+
| RD-N2 | rdn2 |
+--------------------------+-------------------------+
Download the platform software
------------------------------
......@@ -77,13 +47,13 @@ To build the software stack, the command to be used is
::
./build-scripts/rdinfra/build-test-busybox.sh -p <platform> <command>
./build-scripts/rdinfra/build-test-busybox.sh -p <platform name> <command>
Supported command line options are listed below
* <platform>
* <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* <command>
......@@ -154,14 +124,14 @@ To boot up to the busybox prompt, the commands to be used are
::
./boot.sh -p <platform> -a <additional_params> -n [true|false]
./boot.sh -p <platform name> -a <additional_params> -n [true|false]
Supported command line options are listed below
* -p <platform>
* -p <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* -n [true|false] (optional)
......@@ -206,3 +176,4 @@ Example commands to boot upto busybox are as listed below.
*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
.. _Download sources: docs/infra/common/download-sources.rst
.. _Platform Names: docs/infra/common/platform_names.rst
docs/infra/common/distro-boot.rst
View file @ f54334a1
......@@ -13,37 +13,6 @@ distribution is installed on a SATA disk and the installed image can be used for
multiple boots.
Platform Names
--------------
Arm's Neoverse reference design platforms are assigned names in order to allow
the build and execute scripts to recognize the platform for which the software
has to be built and executed. The names for the reference platforms are listed
below. Please make a note of the name of the platform of your choice. This name
is required to start the build and execute procedure. The names under 'Platform
Name' column has to be used in place of the placeholder ``<platform>`` as
mentioned in the commands listed below.
+--------------------------+-------------------------+
| Reference Platform | Platform Name |
+==========================+=========================+
| SGI-575 | sgi575 |
+--------------------------+-------------------------+
| RD-N1-Edge (Single Chip) | rdn1edge |
+--------------------------+-------------------------+
| RD-N1-Edge (Dual Chip) | rdn1edgex2 |
+--------------------------+-------------------------+
| RD-E1-Edge | rde1edge |
+--------------------------+-------------------------+
| RD-Daniel Config-M | rddaniel |
+--------------------------+-------------------------+
| RD-Daniel Config-XLR | rddanielxlr |
+--------------------------+-------------------------+
| RD-N2 | rdn2 |
+--------------------------+-------------------------+
Download the platform software
------------------------------
......@@ -66,13 +35,13 @@ To build the RD software stack, the command to be used is
::
./build-scripts/build-test-uefi.sh -p <platform> <command>
./build-scripts/build-test-uefi.sh -p <platform name> <command>
Supported command line options are listed below
* <platform>
* <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* <command>
......@@ -149,13 +118,13 @@ The commands used to begin the distro installation are:
::
./distro.sh -p <platform> -i <abs_iso_image_path> -s <disk size> -a <additional_params> -n [true|false]
./distro.sh -p <platform name> -i <abs_iso_image_path> -s <disk size> -a <additional_params> -n [true|false]
Supported command line options are listed below
* -p <platform>
* -p <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* -i <abs_iso_image_path>
......@@ -240,13 +209,13 @@ To boot the installed distro, use the following commands:
::
./distro.sh -p <platform> -d <satadisk_path> -a <additional_params> -n [true|false]
./distro.sh -p <platform name> -d <satadisk_path> -a <additional_params> -n [true|false]
Supported command line options are listed below
* -p <platform>
* -p <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* -d <satadisk_path>
......@@ -288,3 +257,4 @@ Example commands to boot a linux distribution are listed below.
*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
.. _Download sources: docs/infra/common/download-sources.rst
.. _Platform Names: docs/infra/common/platform_names.rst
docs/infra/common/platform_names.rst 0 → 100644
View file @ f54334a1
Platform Names
==============
Arm's Neoverse reference design platforms are assigned names in order to allow
the build and execute scripts to recognize the platform for which the software
has to be built and executed. The names for the reference platforms are listed
below. Please make a note of the name of the platform of your choice. This name
is required to start the build and execute procedure. The names under 'Platform
Name' column has to be used in place of the placeholder ``<platform>`` as
mentioned in the commands in other documents.
+--------------------------+-------------------------+
| Reference Platform | Platform Name |
+==========================+=========================+
| RD-N2 | rdn2 |
+--------------------------+-------------------------+
| RD-V1 (Single Chip) | rdv1 |
+--------------------------+-------------------------+
| RD-V1 (Quad Chip) | rdv1mc |
+--------------------------+-------------------------+
| RD-N1-Edge (Single Chip) | rdn1edge |
+--------------------------+-------------------------+
| RD-N1-Edge (Dual Chip) | rdn1edgex2 |
+--------------------------+-------------------------+
| RD-E1-Edge | rde1edge |
+--------------------------+-------------------------+
| SGI-575 | sgi575 |
+--------------------------+-------------------------+
--------------
*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
docs/infra/common/secure-boot.rst
View file @ f54334a1
......@@ -36,36 +36,6 @@ the target OS, the RD platform software stack currently limits this feature
validation to boot of a signed busybox OS.
Platform Names
--------------
Arm's Infra reference platforms are assigned names in order to allow the build
and execute scripts to recognize the platform that has to be buit and executed.
The names for the reference platforms are listed below. Please make a note
of the name of the platform of your choice. This name is required to start the
build and execute procedure. The names under 'Platform Name' column has to be
used in place of the placeholder ``<platform>`` as mentioned in the commands
listed below.
+--------------------------+-------------------------+
| Reference Platform | Platform Name |
+==========================+=========================+
| SGI-575 | sgi575 |
+--------------------------+-------------------------+
| RD-N1-Edge (Single Chip) | rdn1edge |
+--------------------------+-------------------------+
| RD-N1-Edge (Dual Chip) | rdn1edgex2 |
+--------------------------+-------------------------+
| RD-E1-Edge | rde1edge |
+--------------------------+-------------------------+
| RD-Daniel Config-M | rddaniel |
+--------------------------+-------------------------+
| RD-Daniel Config-XLR | rddanielxlr |
+--------------------------+-------------------------+
| RD-N2 | rdn2 |
+--------------------------+-------------------------+
Download the platform software
------------------------------
......@@ -122,13 +92,13 @@ To build the software stack, the command to be used is
::
./build-scripts/rdinfra/build-test-secureboot.sh -p <plaform> <command>
./build-scripts/rdinfra/build-test-secureboot.sh -p <plaform name> <command>
Supported command line options are listed below
* <platform>
* <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* <command>
......@@ -203,14 +173,14 @@ To boot up to the busybox prompt, the commands to be used are
::
./secure_boot.sh -p <platform> -a <additional_params> -n [true|false]
./secure_boot.sh -p <platform name> -a <additional_params> -n [true|false]
Supported command line options are listed below
* -p <platform>
* -p <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* -n [true|false] (optional)
......@@ -308,3 +278,4 @@ This completes the validation of the secure boot functionality.
*Copyright (c) 2021, Arm Limited. All rights reserved.*
.. _Download sources: docs/infra/common/download-sources.rst
.. _Platform Names: docs/infra/common/platform_names.rst
docs/infra/common/winpe-boot.rst
View file @ f54334a1
......@@ -14,36 +14,6 @@ During boot, the platform firmware detects the connected WinPE disk image
and boots from it.
Platform Names
--------------
Arm's Neoverse reference design platforms are assigned names in order to allow
the build and execute scripts to recognize the platform for which the software
has to be built and executed. The names for the reference platforms are listed
below. Please make a note of the name of the platform of your choice. This name
is required to start the build and execute procedure. The names under 'Platform
Name' column has to be used in place of the placeholder ``<platform>`` as
mentioned in the commands listed below.
+--------------------------+-------------------------+
| Reference Platform | Platform Name |
+==========================+=========================+
| SGI-575 | sgi575 |
+--------------------------+-------------------------+
| RD-N1-Edge (Single Chip) | rdn1edge |
+--------------------------+-------------------------+
| RD-N1-Edge (Dual Chip) | rdn1edgex2 |
+--------------------------+-------------------------+
| RD-E1-Edge | rde1edge |
+--------------------------+-------------------------+
| RD-Daniel Config-M | rddaniel |
+--------------------------+-------------------------+
| RD-Daniel Config-XLR | rddanielxlr |
+--------------------------+-------------------------+
| RD-N2 | rdn2 |
+--------------------------+-------------------------+
Download the platform software
------------------------------
......@@ -66,13 +36,13 @@ To build the RD software stack, the command to be used is
::
./build-scripts/build-test-uefi.sh -p <platform> <command>
./build-scripts/build-test-uefi.sh -p <platform name> <command>
Supported command line options are listed below
* <platform>
* <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* <command>
......@@ -152,14 +122,14 @@ To boot from the WinPE disk image, the commands to be used are:
::
./distro.sh -p <platform> -d <satadisk_path> -a <additional_params> -n [true|false]
./distro.sh -p <platform name> -d <satadisk_path> -a <additional_params> -n [true|false]
Supported command line options are listed below
* -p <platform>
* -p <platform name>
- Supported platforms are listed in `Platform Names`_.
- Lookup for a platform name in `Platform Names`_.
* -d <satadisk_path>
......@@ -194,3 +164,4 @@ Example commands to boot WinPE are as listed below.
*Copyright (c) 2020-2021, Arm Limited. All rights reserved.*
.. _Download sources: docs/infra/common/download-sources.rst
.. _Platform Names: docs/infra/common/platform_names.rst
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment