The main changes are as below:

* Move the description of running demo application manually from
  Reproduce section to Application section.
* Add a section to describe the limitations in rpmsg-demo and how
  to improve it.
* Update Known Issues and Limitations in changelog.
* Minor changes to keep the doc consistent overall.

Issue-Id: SCM-5651
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: Ia2c820f8e42f1251c6464e351f1583fd81fbb922

Robbie Cao authored Dec 21, 2022 and Qi Feng committed Dec 21, 2022

* Introduce the "meta-armv8r64-extras/kas/release/v5.0.yml" and pin
  the dependent layers' refspec in it
* Have the "meta-armv8r64-extras/kas/include/base.yml" including the
  file above
* Update the "documentation/user-guide/reproduce.rst" to

    git clone https://gitlab.arm.com/automotive-and-industrial/v8r64

 \
        -b v5.0

Issue-Id: SCM-5610
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: Id1c65d15e7670765ba78279ff2c698f893c189fb

Robbie Cao authored Dec 12, 2022 and Qi Feng committed Dec 21, 2022

Issue-Id: SCM-5610
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Signed-off-by: Qi Feng <qi.feng@arm.com>
Change-Id: Id3f8c7bce72fdbc793a95861fc0a0bcf5ef1dbff

* fvp-baser-aemv8r64.conf belongs to meta-arm repo, should not use
  repo_links.
* Update minimal disk space requirement to 85 GBytes.

Issue-Id: SCM-5624
Signed-off-by: Qi Feng <qi.feng@arm.com>
Change-Id: I4930ee088891b0247dd3ae258a5139710855e358

Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Signed-off-by: Qi Feng <qi.feng@arm.com>
Issue-Id: SCM-5610
Change-Id: I0752d2fa00fb3b568e6a64102a5c8882c1f41d45

Add a new section for application, and move the exist content from
comonents into it.

Issue-Id: SCM-5624
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Signed-off-by: Qi Feng <qi.feng@arm.com>
Change-Id: I2160cd81bbf112f060ebebc5e33a4bab616e1ae5

The recent patch
https://git.yoctoproject.org/meta-zephyr/commit/?h=langdale&id=2a81a45bfbd42bb1995f66a6f8e38151fee95428


in meta-zephyr langdale branch changed the inclusion of the Zephyr
version-specific .inc file, it doesn't use the local include now,
so it is unnecessary to include it in meta-armv8r64-extras.

Issue-Id: SCM-5560
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: I63f1f544acad16c2f5410a49cd2d6b04efd0cb16

Add information on the validation for the stack integration.

Issue-Id: SCM-5624
Signed-off-by: Tomás González <tomasagustin.gonzalezorlando@arm.com>
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Signed-off-by: Qi Feng <qi.feng@arm.com>
Change-Id: Id7d5288acf7b41ff5bd07a33db4b005c00e9c18d

Xen in the v8r64 stack has been upgraded to 4.17, the main relevant
changes are:
* Changed the codebase and branch
* Put the implementation of Armv8-R AArch64 with MPU support in Xen
  as downstream patches in v8r64

Update the User Guide and Developer Manual sections with the
information related to the above changes.

Issue-Id: SCM-5624
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Signed-off-by: Qi Feng <qi.feng@arm.com>
Change-Id: I6b5f862a9ef9add427c41d1edfd898fbd4d86009

Qi Feng authored Dec 16, 2022 and Robbie Cao committed Dec 20, 2022

* Explain how to customize the FVP parameters.
* Describe the build environment variables.
* Use repo_links when appropriate.

Signed-off-by: Qi Feng <qi.feng@arm.com>
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Issue-Id: SCM-4874
Change-Id: I8204bef047e2145057e4243c7e02fa4bb9d13d88

Qi Feng authored Dec 19, 2022 and Robbie Cao committed Dec 20, 2022

Signed-off-by: Qi Feng <qi.feng@arm.com>
Issue-Id: SCM-5624
Change-Id: I166e4d8a43005ffd45361de6f60b47052a6c1e98
Signed-off-by: Robbie Cao <robbie.cao@arm.com>

Peter Hoyes authored Nov 09, 2022 and Robbie Cao committed Dec 20, 2022

To promote cross-links between the documentation and the code, create a
small Sphinx extension which transforms links relative to the repository
root into a reference to the repository URL. It attempts to read the
version from the Read the Docs configuration and falls back to `git
rev-parse HEAD`.

The links can be written as follows:

  :repo:`path/to/file.bb`

The environment variable REPO_URL_PATTERN can be used to modify the repo
URL for development purposes.

The Read the Docs version_name is not useful for determining the Git ref
for the purposes of linking to the source code because of the special
value "latest", which refers to the default branch. Use the
gitlab_version variable instead, which despite the name is simply the
"commit_name" of the version according to:
https://github.com/readthedocs/readthedocs.org/blob/6.3.0/readthedocs/doc_builder/backends/sphinx.py#L95
and
https://github.com/readthedocs/readthedocs.org/blob/6.3.0/readthedocs/builds/models.py#L254



Issue-Id: SCM-5314
Issue-Id: SCM-5624
Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Signed-off-by: Qi Feng <qi.feng@arm.com>
Change-Id: Ic3c89208895f36dc3042f3bacbdd08547eb38265

Jiacheng Tang authored Dec 19, 2022 and Robbie Cao committed Dec 20, 2022

When zephyr-philosophers is running on Xen, it fails at the assertion
to check whether GICD_CTRL_NS is 1. The reason for the failure is:

    On Armv8R-64, all of stuff are running in secure state and there is
    no non-secure world. The GIC implementation supports only single
    security state. But VGICD_CTLR_DEFAULT is non-secure state in
    current Xen implementation.

This downstream patch set VGICD_CTLR_DEFAULT as
GICD_CTLR_DS|GICD_CTLR_ARE to avoid the issues like above.

Issue-Id: SCM-5560
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: I4ddfc5dff786ac07a77c4e56746d969ac509d741
Signed-off-by: Robbie Cao <robbie.cao@arm.com>

* Zephyr and rpmsg test cases are not adapt to single domU, add this
  patch to solve this.
* Split test cases for baremetal-linux and virtualization to two
  .bbclass files.
* Update the name of zephyr console in zephyr test case.

Issue-Id: SCM-5560
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: Ib38cb36f7504b0a70127ca275709b04bd69a19e3

The changes are as below:
* Linux kernel version upgrade to 5.19
* Add link to Zephyr 3.2.0
* The langdale branch of meta-zephyr is used now

Issue-Id: SCM-5624
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: If66ed5e5bc1922ed7ebd2662a1e0e78ff9042d95

Add trademarks for Arm and Cortex.

Signed-off-by: Qi Feng <qi.feng@arm.com>
Issue-Id: SCM-4874
Change-Id: I9f683c7a18df28ddf1c491dd03bacb68807537a0

* Add description of codeline management.
* Update the Maintainer(s) list.
* Add description of u-boot patch that disables setting
  COUNTER_FREQUENCY.
* Use kas version 3.1.

Signed-off-by: Qi Feng <qi.feng@arm.com>
Issue-Id: SCM-4874
Change-Id: I15f6b6bdea1308f5bfb540f85ba4f7ac2af79547

Qi Feng authored Dec 13, 2022 and Robbie Cao committed Dec 16, 2022

* Rewrite section Overview.
* Invert the order of the listed supported architectures.

Signed-off-by: Qi Feng <qi.feng@arm.com>
Issue-Id: SCM-4874
Change-Id: I6cf7010090759045fdf557d61c9b9f37eaced0d1

The event channel is established statically for communication between
two domains. There is no need to define event channels in device tree
if only one domain is running on Xen. Also, since the event channel
must describe the foreign-evtchn phandle connected to in the device
tree, this is missing in the case of only one domain running on Xen,
which causes the device tree overlay to fail.

Based on the above reason, this patch adds a switch to enable the
description of evtchn in the device tree. Whether it is enabled or not
is determined by the 'XEN_DOM0LESS_DOMAINS' configuration: if only one
domain runs on Xen, evtchn will be excluded from the device tree.

This functionality is achieved by:
1. Wrap the evtchn node in '#if VAR / #endif'
2. The value of VAR (0 or 1) is determined by XEN_DOM0LESS_DOMAINS
3. Use cpp (c preprocessor) to generate dts that meet the conditions

Issue-Id: SCM-5451
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: I9c96f0b9de502757a1f29c6f022addb842990bee

And update the patches for shmem & evtchn driver as well.

Issue-Id: SCM-5625
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: Ie3894945040858ce2206f4ca5a4a8e51884276aa

To achieve this upgrade, the main changes are as follows:
* Switch to use the main Xen Project repository
* Add .bb for xen 4.17 and change to use stable-4.17 branch
* Bump the version to RELEASE-4.17.0
* Do the same for xen-tools 4.17
* Remove downstream patches for shmem and evtchn since their support
  was included in 4.17
* Add Xen support for Armv8-R AArch64 with MPU as downstream patches
* Update Xen's config
* Update device tree, mainly including:
   * Add 'xen,static-heap' settings
   * Update 'xen,static-mem' settings
   * Add 'xen,peer-dom-id' settings
   * Update the shared memory nodes
   * Update event channel nodes:
      * The 'evtchn' nodes are now inside the DomUs
      * Add configs for evtchn in xen_dom0less_config.bbclass
      * Remove obsolete evtchn configs, templates and python code
* Update the Linux driver patches for shmem and evtchn

Issue-Id: SCM-5230
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: I5bd2f7d52817214f36b70fda242dbcf9788a9093

Jiacheng Tang authored Dec 09, 2022 and Robbie Cao committed Dec 13, 2022

* Use semaphore instead of receiving flag to synchronize data receving
in rpmsg demo.
* Change "metal_irq_enable" after the registration of endpoint

Issue-Id: SCM-5560
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: I5f1c4a903eab4937cd110d76484f9f6508e64c8b

Peter Hoyes authored Nov 04, 2022 and Robbie Cao committed Dec 13, 2022

The main changes are as below:

* Use the same branch as the defaults setting, for meta-zephyr

* Set PREFERRED_VERSION_zephyr-kernel to 3.2.0

* Add recipe for the Zephyr SDK v0.15.1

  Zephyr 3.2.0 requires Zephyr SDK version >= 0.15.0, so add a recipe
  to meta-armv8r64-extras for 0.15.1 which requires the upstream
  0.14.2 recipe.

* Add .inc file for Zephyr 3.2.0

  Use the generate-versions.py script in meta-zephyr-core to generate a
  .inc file for meta-zephyr containing the Yocto modules and SRCREVs for
  Zephyr 3.2.0

  The version-specific include file is currently included using a local
  include relative to meta-zephyr-core, so as a workaround re-require
  the new .inc file in the fvp-baser-aemv8r64 machine bbappend.

Issue-Id: SCM-4874
Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: I3e9e71c1cdbb902329be86060650e86f0b63688b

The bbappend that is currently used to apply machine-specific Zephyr
configuration is problematic because it applies to all recipes with the
'zephyr-' prefix, including zephyr-sdk, which is not a Zephyr
application for the target.
Replace this mechanism with one using ZEPHYR_INHERIT_CLASSES, which is
only present in Zephyr application recipes. Create a bbclass,
zephyr-machine-extras, which includes a machine-specific .inc file, if
it exists.

Issue-Id: SCM-4874
Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: I3c0c3eb748aa192531299f573f611ceb65fb72cc

The main changes are as below:

* Add commands to test Nginx web server and rpmsg-demo, both manually
  and using autorun.
* Running virtualization configuration will not connect to Linux
  terminal by default.
* Add explanation about XEN_DOM0LESS_DOM_LINUX_DEMO_AUTORUN and
  TESTIMAGE_AUTO
* Update validation output examples.

Signed-off-by: Qi Feng <qi.feng@arm.com>
Issue-Id: SCM-4879
Change-Id: I69b54898f196c22793ce6263a276168acda662cb

Add starting parameters to rpmsg-remote, the test suite can run
rpmsg-remote with the "-t" parameter to avoid the infinite loop
and ensure other test case on linux console can run after the
test of rpmsg.

Issue-Id: SCM-5560
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: I814b255e360ebc00bb5cf1d9479b4ba1a3d19bc3

Nginx container will exit automatically when FVP restart,
add restart policy for nginx docker to fix this problem.

Issue-Id: SCM-4874
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: I07eb133af3e26fb857297707c549210cf582c9c5

The program wants to delete the oldest line of data in
the file, use the correct line number for this purpose.

Issue-Id: SCM-4874
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: Ia89299b479f6f77f218dbd872f47ea2898b96b64

The main changes are as below:

* Add introduction to device tree nodes for shared memory and event
  channel in Xen.
* Add the description to the configurations for Linux kernel to run as
  Xen VM, enable shared memory, run docker, etc.
* Introduction to the demo applications.
* Bump Zephyr version to 3.2.0.
* Update the introduction to Zephyr sample applications

Signed-off-by: Qi Feng <qi.feng@arm.com>
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Issue-Id: SCM-4877
Issue-Id: SCM-4878
Change-Id: I12dfa0d38062119ab7e306adf78b8b81c9a96250

The software stack introduces two new use scenarios by extending the
virtualization stack:

* Inter-VM communication using the shared memory and event channel
  mechanism provided by the Xen hypervisor
* Exposing data with a docker container hosted Nginx

These two use cases are implemented using the OpenAMP framework and
docker container technology.

This patch adds an introduction to these two new use cases and related
features, as well as other related changes.

Signed-off-by: Qi Feng <qi.feng@arm.com>
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Issue-Id: SCM-4877
Issue-Id: SCM-4878
Change-Id: I42c3c98bde9dcd131e662e6cd0ba0b811a17b5e3

A simple yet effective method to manage the data file: use the 'sed'
command to simply delete the oldest line of data, to maintain the
data file like a FIFO.

Doing like this is to avoid the data file becomes larger and larger.

Issue-Id: SCM-5560
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: I8aabf7e1aed7d155ffee2075aaeddabb332cd21f

Add support to autorun nginx-docker-demo when system boot.

The main changes are as follows:
* Introduce a SysV-style initscript to control the starting, stopping
  and restarting of nginx docker container.
* Install the initscript with the help of update-rc.d class, thus
  nginx docker container can start automatically after system boot.
* The autorun works only if XEN_DOM0LESS_DOM_LINUX_DEMO_AUTORUN is set
  as "1".
* To disable the autorun, build the stack using the following command:

      XEN_DOM0LESS_DOM_LINUX_DEMO_AUTORUN=0 \
          kas build v8r64/meta-armv8r64-extras/kas/virtualization.yml

Issue-Id: SCM-4876
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: Iec49632a60cc3fc14ce64c58af066ade9e688cd3

Add support to autorun rpmsg-demo when system boot.

The main changes are as follows:
* Introduce a SysV-style initscript to control the starting, stopping
  and restarting of rpmsg-remote daemon.
* Install the initscript with the help of update-rc.d class, thus
  rpmsg-remote can start automatically after system boot.
* Introduce a configuration XEN_DOM0LESS_DOM_LINUX_DEMO_AUTORUN to
  set if autorun rpmsg-demo when building the target image.
  And config it to "1" as default for virtualization stack.
  To disable it, build the stack using the following command:

      XEN_DOM0LESS_DOM_LINUX_DEMO_AUTORUN=0 \
          kas build v8r64/meta-armv8r64-extras/kas/virtualization.yml

* The autorun works only if XEN_DOM0LESS_ZEPHYR_APPLICATION is set as
  "zephyr-rpmsg-demo".

Issue-Id: SCM-4876
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: I49b430e86828910f8a73f2be4789493692bf11a9

Registering evtchn to metal irq before vring and vq are initialized
may trigger null pointer access in irq handler, and cause Segmentation
fault.

To avoid this potential risk, register evtchn to metal irq after vring
and vq are initialized.

Issue-Id: SCM-5451
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: I3b23cd6bd933098c159fe8b4d522c45944caf8fc

Set commit message length (title and body) to 72.

Issue-Id: SCM-4874
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: Iae323a4b7dabfe2c02162fceac6d190ee4dcebf3

SRCREV_libmetal is already set in meta-zephyr.

Issue-Id: SCM-4874
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: I6bea8e68bd42f4c7dfa47b28d8cd762aa571ea6b

Update the U-Boot version in the documentation as well.

Issue-Id: SCM-4879
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: I4c90b8d796dec7f1827489dffa764a1df0ee2aca

Refinement on the coding of the demo program, mainly including:
* Fix comments in HTML by adding exclamation mark
* Unify the comment style in C code
* Change the hardcoded numbers to macros
* Fix compile warnings
* Minor fixes on code alignment, padding data structure, etc

Issue-Id: SCM-5615
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Change-Id: Id075c60933606a6513b6cbb2e9047f494cb0b280

Add new test cases to check docker engine installation, daemon
and runtime.

Issue-Id: SCM-4872
Signed-off-by: Robbie Cao <robbie.cao@arm.com>
Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>
Change-Id: I522f8eafe88355f715e80d3f898eb1bafd0025dc

Qi Feng authored Nov 28, 2022 and Robbie Cao committed Nov 30, 2022

Signed-off-by: Qi Feng <qi.feng@arm.com>
Issue-Id: SCM-4874
Change-Id: I7e7ee9ec7455c75a0e7f80e2cc2893787b50a9b8