From cf40eff0197237ce25a34657fd43451ec9407d58 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 14:57:07 +1000 Subject: [PATCH 01/13] demos: fix type in reference to exit-docker underscore used by mistake causing a missing reference warning Signed-off-by: Sipke Vriend --- demos/docker_images.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/demos/docker_images.rst b/demos/docker_images.rst index 46606b7..361b5d1 100644 --- a/demos/docker_images.rst +++ b/demos/docker_images.rst @@ -117,7 +117,7 @@ As part of logging you in, some guidance will be printed on how to run the demos Enjoy! dev@openamp-demo:~$ -To :ref:`exit the docker container` use key combination Ctrl-A x +To :ref:`exit the docker container` use key combination Ctrl-A x on window 0 (left tmux pane) or type exit on window 1 (top right tmux pane). We also recommend reading :ref:`Qemu Tips and Tricks` to help From 592a913f45a6af3306317e3dd6483e2f7cd2e7e0 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 14:58:08 +1000 Subject: [PATCH 02/13] demos: fix location of linux_rpc_demo README file warning indicated that linux_rpc_demo moved location so correct link Signed-off-by: Sipke Vriend --- demos/linux_rpc.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/demos/linux_rpc.rst b/demos/linux_rpc.rst index c7da2de..349e163 100644 --- a/demos/linux_rpc.rst +++ b/demos/linux_rpc.rst @@ -106,4 +106,4 @@ This Linux RPC Sample is demonstrated in the following reference implementations :maxdepth: 1 :caption: Demo Compile and Execution Instructions - ../open-amp/apps/examples/linux_rpc_demo/README + ../openamp-system-reference/examples/legacy_apps/examples/linux_rpc_demo/README From d0ed6d558127af0f50824235bf7dac57ec407a17 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 15:00:15 +1000 Subject: [PATCH 03/13] docs: fix duplicate link name to remove warning 'remoteproc code implimentation' occurred twice likely due to copy paste error, causing a non critical warning but correct anyway to reduce warning count. --- docs/data_structures_content.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/data_structures_content.rst b/docs/data_structures_content.rst index 06e98b8..be92753 100644 --- a/docs/data_structures_content.rst +++ b/docs/data_structures_content.rst @@ -15,7 +15,7 @@ Virtio Structure for Remoteproc .. doxygenstruct:: remoteproc_virtio :members: -Refer also :openamp_doc_link:`remoteproc_virtio ` documentation and `remoteproc code implementation `_. +Refer also :openamp_doc_link:`remoteproc_virtio ` documentation and `remoteproc_virtio code implementation `_. Virtio Data Structures =========================== From 8590bc76d3a4c7768be13f67c91673a8fd88640b Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 15:53:12 +1000 Subject: [PATCH 04/13] Remove redundant files and associated warning warnings show that these files are not indexed and they seemed to have been orphaned, so remove them. Signed-off-by: Sipke Vriend --- docs/index.rst | 14 -------------- openamp/links.rst | 1 + openamp/meeting_notes.rst | 11 ----------- 3 files changed, 1 insertion(+), 25 deletions(-) delete mode 100644 docs/index.rst delete mode 100644 openamp/meeting_notes.rst diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index af92f90..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. OpenAMP documentation master file, created by - sphinx-quickstart on Wed Oct 5 10:21:26 2022. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -OpenAMP Libraries User Guide -=========================== - -.. toctree:: - :maxdepth: 1 - :caption: Contents: - - porting_guide - diff --git a/openamp/links.rst b/openamp/links.rst index 5e60742..8f3cd19 100644 --- a/openamp/links.rst +++ b/openamp/links.rst @@ -7,6 +7,7 @@ Links Note: Before getting the mailing lists, we used this `OpenAMP Google Group `_. The Google Group is only listed here for reference to older content. Please use the mailing lists. + - The OpenAMP Meeting Notes: https://github.com/OpenAMP/open-amp/wiki/Meeting-Notes - The OpenAMP Source Repositories: https://github.com/OpenAMP - `OpenAMP and Heterogenous Processing Project Webinar (December 2022) `_ - `OpenAMP Elevator Pitch Slideset (2024) `_ diff --git a/openamp/meeting_notes.rst b/openamp/meeting_notes.rst deleted file mode 100644 index 2b4b047..0000000 --- a/openamp/meeting_notes.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _meeting-notes-work-label: - -============= -Meeting Notes -============= - -Meeting_Notes_ - -.. _Meeting_Notes: https://github.com/OpenAMP/open-amp/wiki/Meeting-Notes - -TODO - Move notes to google doc drive? It may be arduous to post notes to this page \ No newline at end of file From e7ae499c266b2f67f6eb1a36531935b72ec0e5cc Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 15:54:54 +1000 Subject: [PATCH 05/13] docs: add line between sections to remove warning missing empty line causes warning so add it to remove the warning. Signed-off-by: Sipke Vriend --- docs/remoteproc_design.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/remoteproc_design.rst b/docs/remoteproc_design.rst index c304eed..466ab1b 100644 --- a/docs/remoteproc_design.rst +++ b/docs/remoteproc_design.rst @@ -38,6 +38,7 @@ State Transition Remote User APIs ---------------- .. _remoteproc_config: + Configure remote ^^^^^^^^^^^^^^^^ From 0511353cf2a7ca8c2ccda82fe0fb6561adb22537 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 15:56:12 +1000 Subject: [PATCH 06/13] overview: correct README file case and link to remove warning link was incorrect as case was wrong. This removes a warning and corrects the link. Signed-off-by: Sipke Vriend --- openamp/overview.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openamp/overview.rst b/openamp/overview.rst index 495c299..4ecbf0b 100644 --- a/openamp/overview.rst +++ b/openamp/overview.rst @@ -256,7 +256,7 @@ RPC client. Libmetal ======== -:doc:`Libmetal <../libmetal/readme>` is a hardware abstraction component, intended to provide for +:doc:`Libmetal <../libmetal/README>` is a hardware abstraction component, intended to provide for portability across different platforms. Vendors porting OpenAMP will provide an implementation of libmetal for their system. From 99d658bd384bf69fc2ff105058aaa4cadea56b15 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 15:57:20 +1000 Subject: [PATCH 07/13] overview: fix duplicate reference/link warnings A few links had duplicate names which results in a warning, so adjust the name to be unique which removes the warning. Signed-off-by: Sipke Vriend --- openamp/overview.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/openamp/overview.rst b/openamp/overview.rst index 4ecbf0b..86af523 100644 --- a/openamp/overview.rst +++ b/openamp/overview.rst @@ -277,7 +277,7 @@ OpenAMP aims to provide components which are portable and aim to be environment - an OpenAMP Linux Kernel project, coming through the regular `remoteproc `_/ `RPMsg `_/ - `Virtio `_ efforts in the kernel. + `Virtio Driver `_ efforts in the kernel. - multiple proprietary implementations. The operating environments that OpenAMP supports include: @@ -313,6 +313,7 @@ There are a few guiding principles that governs OpenAMP: :ref:`RPMsg `/`Virtio `_ There are a number of project members as outlined in -`OpenAMP Project Page `_ as well as many community members, +`OpenAMP Project About Page `_ as well as many community members, so please join the :ref:`OpenAMP open source project`! + - See https://github.com/OpenAMP/open-amp From 92c9eba41b6ebbafb52cb6d07bf210f322c87284 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 16:00:41 +1000 Subject: [PATCH 08/13] protocol_details: Use unique headings to avoid duplicate reference warning The duplicate headings result in duplicate auto generated references with associated warning, so make them unique to remove this warning. Signed-off-by: Sipke Vriend --- protocol_details/lifecyclemgmt_creation.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/protocol_details/lifecyclemgmt_creation.rst b/protocol_details/lifecyclemgmt_creation.rst index 80376b5..d84c52d 100644 --- a/protocol_details/lifecyclemgmt_creation.rst +++ b/protocol_details/lifecyclemgmt_creation.rst @@ -16,8 +16,8 @@ Defining the Resource Table and Creating the Remote ELF Image Creating a remote image through remoteproc begins by defining the resource table and creating the remote ELF image. -Procedure -~~~~~~~~~ +Resource Table Procedure +~~~~~~~~~~~~~~~~~~~~~~~~ 1. Define the :ref:`resource table` structure in the application. The resource table must minimally contain carve-out and VirtIO device information for IPC. @@ -56,8 +56,8 @@ Making Remote Firmware Accessible to the Host After creating the remote firmware’s ELF image, you need to make it accessible to remoteproc in the host context. -Procedure -~~~~~~~~~ +Remote Firmware Procedure +~~~~~~~~~~~~~~~~~~~~~~~~~ 1. If the RTOS- or bare metal-based host software context has a file system, place this firmware ELF image in the file system. From 40d564c40a37002be9096579495a81cce6206829 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 16:01:28 +1000 Subject: [PATCH 09/13] protocol_details: add missing :ref: tag warning noted missing :ref: tag, so add it. Signed-off-by: Sipke Vriend --- protocol_details/system_considerations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/protocol_details/system_considerations.rst b/protocol_details/system_considerations.rst index c2ac332..e12d017 100644 --- a/protocol_details/system_considerations.rst +++ b/protocol_details/system_considerations.rst @@ -14,7 +14,7 @@ Determine system topology ------------------------- The OpenAMP framework implicitly assumes a host controller to remote system architecture. The -`topology`for this architecture should be determined; either star, chain, or a combination. The +:ref:`topology` for this architecture should be determined; either star, chain, or a combination. The following figure shows some simple use cases. * Case 1 — A single host controller software context on processor 1 controlling life cycle and From 30e93517cc192dec8f9fd87eb5373a6856938ab1 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 16:03:33 +1000 Subject: [PATCH 10/13] protocol_details: remove duplicate tag for rpmsg-protocol-work-label rpmsg-protocol-work-label was used in rpmsg_protocol.rst and rpmsg.rst so change one to remove duplication and associated warning. Signed-off-by: Sipke Vriend --- protocol_details/rpmsg_protocol.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/protocol_details/rpmsg_protocol.rst b/protocol_details/rpmsg_protocol.rst index c96deec..0a2bd69 100644 --- a/protocol_details/rpmsg_protocol.rst +++ b/protocol_details/rpmsg_protocol.rst @@ -1,4 +1,4 @@ -.. _rpmsg-protocol-work-label: +.. _rpmsg-layers-work-label: ===================== RPMsg Protocol Layers From a3f56820101b14f8fc914f090a6db5d87e4c057c Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 16:06:23 +1000 Subject: [PATCH 11/13] docs: remove duplicate reference to remoteproc_config function warning showed that there were two references to remoteproc_config so remove the alternate. Signed-off-by: Sipke Vriend --- docs/remoteproc_design.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/remoteproc_design.rst b/docs/remoteproc_design.rst index 466ab1b..a9db20f 100644 --- a/docs/remoteproc_design.rst +++ b/docs/remoteproc_design.rst @@ -39,12 +39,6 @@ Remote User APIs ---------------- .. _remoteproc_config: -Configure remote -^^^^^^^^^^^^^^^^ - -.. doxygenfunction:: remoteproc_config - :project: openamp_doc_embed - Initialize remoteproc instance ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From 73f7db3eab4a86aa8b84850ad6c2a78f4fd4721d Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 16:31:29 +1000 Subject: [PATCH 12/13] docs: correct end point release reference warning showed that rpmsg_ns_unbind_cb was reference twice when the second should be the release rpmsg_ept_release_cb function. Signed-off-by: Sipke Vriend --- docs/rpmsg_design.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/rpmsg_design.rst b/docs/rpmsg_design.rst index 8c6f80e..e1c6d4e 100644 --- a/docs/rpmsg_design.rst +++ b/docs/rpmsg_design.rst @@ -113,9 +113,9 @@ RPMsg User Defined Callbacks .. doxygentypedef:: rpmsg_ns_unbind_cb :project: openamp_doc_embed -* RPMsg endpoint name service unbind callback. If user defines such callback, - when there is name service destroy arrives, it will call this callback to - notify the user application about the remote has destroyed the service.: +* RPMsg endpoint release callback. If defined by the user, + it will be called when the associated RPMsg endpoint is released, + allowing the user application to safely remove associated allocation.: -.. doxygentypedef:: rpmsg_ns_unbind_cb +.. doxygentypedef:: rpmsg_ept_release_cb :project: openamp_doc_embed From 5e28436bbcdb55e756f33b2d5f9b350296787be3 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Wed, 26 Nov 2025 16:31:46 +1000 Subject: [PATCH 13/13] conf: exclude .venv* and _doxygen from source list the README instructions were modified to recommend using a virtual environment which results in sphinx parsing the .venv directory, so add it to exclude_patterns as well as the 'build' folder _doxygen. This removes many unnecessary warnings that were inadvertently introduced. Signed-off-by: Sipke Vriend --- conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.py b/conf.py index 54bb6e5..3c336c6 100644 --- a/conf.py +++ b/conf.py @@ -98,7 +98,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.git'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.git', '.venv*', '_doxygen'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx'