From f3d2b74efc89557b93442e4d801b60a23a444347 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 17 Nov 2025 17:05:52 +1000 Subject: [PATCH 1/3] overview: remove some redundant dashes --- openamp/overview.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openamp/overview.rst b/openamp/overview.rst index 495c299..6be7e67 100644 --- a/openamp/overview.rst +++ b/openamp/overview.rst @@ -34,10 +34,10 @@ History Texas Instruments’ remoteproc and RPMsg infrastructure available in the upstream Linux kernel enable the Linux applications running on a host processor to manage the life cycle of -remote processor/firmware and perform IPC with them. However, there was no open- source +remote processor/firmware and perform IPC with them. However, there was no open source API/software available that provided similar functionality and interfaces for other possible -software contexts (RTOS- or bare metal-based applications) running on the remote processor to -communicate with the Linux host. Also, AMP applications may require RTOS- or bare metal-based +software contexts (RTOS or bare metal-based applications) running on the remote processor to +communicate with the Linux host. Also, AMP applications may require RTOS or bare metal-based applications to run on the host processor and be able to manage and communicate with various software environments (RTOS, bare metal, or even Linux) on the remote processor. From 99770077080a3917f1df3c6fb365582e8ced0fe8 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 17 Nov 2025 17:08:00 +1000 Subject: [PATCH 2/3] overview: reword project aims Reword project aims and include links to the openampproject.org page also to tie the two sets of information as the information is related. Issue https://github.com/OpenAMP/openamp-docs/issues/62 Signed-off-by: Sipke Vriend --- openamp/overview.rst | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/openamp/overview.rst b/openamp/overview.rst index 6be7e67..3db2a5d 100644 --- a/openamp/overview.rst +++ b/openamp/overview.rst @@ -47,27 +47,32 @@ upstream Linux kernel. As in upstream Linux, the OpenAMP Framework's remoteproc infrastructure uses virtio as the transport layer/abstraction. +.. _project-aims: + ************ Project Aims ************ -To provide a solution to cover the :ref:`AMP Fundamentals`, the -OpenAMP project is divided into the following efforts: +The `OpenAMP Project `_ is primarily focused on these efforts: + +- "seeks to standardize the interactions between operating environments in a heterogeneous embedded + system through open source solutions for Asymmetric MultiProcessing (AMP)" + [`1 `_]. + +- "providing a clean-room open source implementation of the above standards" + [`2 `_]. - * A guidance group under Linaro Community Projects - - Provides guidance for the low-level protocol that allows systems to interact (:ref:`more info here`) - + Built on top of the `Virtio Open Standard `_ - - Maintaining common user level APIs that allow applications to be portable - + :ref:`RPMSG` - + :ref:`remoteproc` - - **Provide low-level** :ref:`OS/HW abstraction layer` APIs **that - abstracts the open source implementation from the underlying OS and hardware, simplifying - the porting to new environments** +- providing a set of reference integrations into several common operating environments on + multiple vendor platforms [`3 `_]. - * An open source project that implements a clean-room implementation of OpenAMP - - Runs in :ref:`multiple environments` - - BSD License +The project components are "Based on the existing open source implementations of RemoteProc, +RPMsg, Virtio and Device tree, it covers aspects such as lifecycle operations, messaging, +low level abstractions" +[`2 `_]. +The following :ref:`OpenAMP Fundamentals` section delves deeper +into the components which, implemented in the OpenAMP libraries, provide for agnostic +implementations for differing :ref:`Operating Environments`. .. _openamp-fundamentals-work-label: From 82a4d06d356bccb464176d0a67104ad151a07253 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 17 Nov 2025 17:09:31 +1000 Subject: [PATCH 3/3] overview: reword operating environments with focus on library Reword operating environment to focus on library, with slightly modified suggestion made by Arnaud in PR https://github.com/OpenAMP/openamp-docs/pull/61 Issue https://github.com/OpenAMP/openamp-docs/issues/62 Signed-off-by: Sipke Vriend --- openamp/overview.rst | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/openamp/overview.rst b/openamp/overview.rst index 3db2a5d..e73da8c 100644 --- a/openamp/overview.rst +++ b/openamp/overview.rst @@ -275,24 +275,25 @@ Read more about the OpenAMP System Components :ref:`here`_, - - an OpenAMP Linux Kernel project, coming through the regular - `remoteproc `_/ - `RPMsg `_/ - `Virtio `_ efforts in the kernel. - - multiple proprietary implementations. - -The operating environments that OpenAMP supports include: - - - Linux user space - - Linux kernel - - Multiple RTOS's - including `FreeRTOS `_, `NuttX `_, `Zephyr `_, `VxWorks `_, and more - - Bare Metal (No OS) - - In OS's on top of hypervisors - - Within hypervisors +The OpenAMP project aims to provide components which are portable and environment agnostic. + +This is achieved through the OpenAMP library which: + + - implements the Virtio and RPMsg protocols with associated API + (`See OpenAMP repository `_) + - works on different system thanks to the `libmetal `_ + adaptation layer: + - Bare Metal (No OS) + - Multiple RTOS's, including `FreeRTOS `_, + `NuttX `_, `Zephyr `_, + `VxWorks `_, and more + - OS's on top of hypervisors + - Within hypervisors + - is compatible with different compilers such as gcc, clang, armcc and more + - maintains compatibility with the Linux kernel by leveraging the following frameworks: + `remoteproc `_, + `RPMsg `_ and + `Virtio `_ frameworks. .. _governance-work-label: @@ -304,7 +305,7 @@ OpenAMP Governance and Guidelines The OpenAMP Project governance is detailed on the `OpenAMP Project Page `_. -There are a few guiding principles that governs OpenAMP: +There are a few guiding principles, based on the :ref:`project aims` that govern OpenAMP: - Provide a clean-room implementation of OpenAMP with business friendly APIs and licensing * Allow for compatible proprietary implementations and products