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' 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 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 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 =========================== 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/docs/remoteproc_design.rst b/docs/remoteproc_design.rst index c304eed..a9db20f 100644 --- a/docs/remoteproc_design.rst +++ b/docs/remoteproc_design.rst @@ -38,11 +38,6 @@ State Transition Remote User APIs ---------------- .. _remoteproc_config: -Configure remote -^^^^^^^^^^^^^^^^ - -.. doxygenfunction:: remoteproc_config - :project: openamp_doc_embed Initialize remoteproc instance ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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 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 diff --git a/openamp/overview.rst b/openamp/overview.rst index 495c299..86af523 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. @@ -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 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. 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 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