Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
2 changes: 1 addition & 1 deletion demos/docker_images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<exit_docker>` use key combination Ctrl-A x
To :ref:`exit the docker container<exit-docker>` 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<qemu-tips-tricks>` to help
Expand Down
2 changes: 1 addition & 1 deletion demos/linux_rpc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/data_structures_content.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Virtio Structure for Remoteproc
.. doxygenstruct:: remoteproc_virtio
:members:

Refer also :openamp_doc_link:`remoteproc_virtio <remoteproc_virtio>` documentation and `remoteproc code implementation <https://github.com/OpenAMP/open-amp/blob/main/lib/include/openamp/remoteproc_virtio.h>`_.
Refer also :openamp_doc_link:`remoteproc_virtio <remoteproc_virtio>` documentation and `remoteproc_virtio code implementation <https://github.com/OpenAMP/open-amp/blob/main/lib/include/openamp/remoteproc_virtio.h>`_.

Virtio Data Structures
===========================
Expand Down
14 changes: 0 additions & 14 deletions docs/index.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/remoteproc_design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,6 @@ State Transition
Remote User APIs
----------------
.. _remoteproc_config:
Configure remote
^^^^^^^^^^^^^^^^

.. doxygenfunction:: remoteproc_config
:project: openamp_doc_embed

Initialize remoteproc instance
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
8 changes: 4 additions & 4 deletions docs/rpmsg_design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions openamp/links.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Links
Note: Before getting the mailing lists, we used this
`OpenAMP Google Group <https://groups.google.com/g/open-amp>`_. 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) <https://www.youtube.com/watch?v=R_5DOIvo7tI>`_
- `OpenAMP Elevator Pitch Slideset (2024) <https://www.openampproject.org/docs/presentations/OpenAMP-Elevator-Pitch-2024-Q1.pdf>`_
11 changes: 0 additions & 11 deletions openamp/meeting_notes.rst

This file was deleted.

7 changes: 4 additions & 3 deletions openamp/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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 <https://www.kernel.org/doc/html/latest/staging/remoteproc.html>`_/
`RPMsg <https://www.kernel.org/doc/html/latest/staging/rpmsg.html>`_/
`Virtio <https://docs.kernel.org/driver-api/virtio/virtio.html>`_ efforts in the kernel.
`Virtio Driver <https://docs.kernel.org/driver-api/virtio/virtio.html>`_ efforts in the kernel.
- multiple proprietary implementations.

The operating environments that OpenAMP supports include:
Expand Down Expand Up @@ -313,6 +313,7 @@ There are a few guiding principles that governs OpenAMP:
:ref:`RPMsg <rpmsg-protocol-work-label>`/`Virtio <https://docs.oasis-open.org/virtio/virtio>`_

There are a number of project members as outlined in
`OpenAMP Project Page <https://www.openampproject.org/about/>`_ as well as many community members,
`OpenAMP Project About Page <https://www.openampproject.org/about/>`_ as well as many community members,
so please join the :ref:`OpenAMP open source project<openamp-maintenance-work-label>`!

- See https://github.com/OpenAMP/open-amp
8 changes: 4 additions & 4 deletions protocol_details/lifecyclemgmt_creation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<resource-table>` structure in the application. The resource
table must minimally contain carve-out and VirtIO device information for IPC.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion protocol_details/rpmsg_protocol.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _rpmsg-protocol-work-label:
.. _rpmsg-layers-work-label:

=====================
RPMsg Protocol Layers
Expand Down
2 changes: 1 addition & 1 deletion protocol_details/system_considerations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Determine system topology
-------------------------

The OpenAMP framework implicitly assumes a host controller to remote system architecture. The
`topology<topology-work-label>`for this architecture should be determined; either star, chain, or a combination. The
:ref:`topology<topology-work-label>` 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
Expand Down