Document that callers must zero-initialize the endpoint structure
before calling rpmsg_create_ept, including the release_cb field.
Fixes#659
Signed-off-by: Atul Akella <atul.akella@gmail.com>
Multiple lines of text are concatenated so use a code block for the
supported targets so they are on individual lines.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Use the markdown shell block instead of prepending $ to command so that
users can copy the block, as supported in github and IDEs.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Use the markdown shell block instead of prepending $ to command so that
users can copy the block, as supported in github and IDEs.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
The function unconditionally returns true and neither call site
checks the return value. Remove the dead return and change the
return type to void.
Fixes: commit b32187e4fb ("openamp: change rx/tx buffer hold flag to count")
Signed-off-by: Chirag Shilwant <c-shilwant@ti.com>
The macro body references 'rp_hdr' instead of using the declared
parameter 'rphdr'. This causes the macro to ignore its argument and
always reference whatever 'rp_hdr' variable exists in the calling
scope. Fix by using the parameter name in the macro body.
Fixes: commit b32187e4fb ("openamp: change rx/tx buffer hold flag to count")
Signed-off-by: Chirag Shilwant <c-shilwant@ti.com>
Print the freespace so we can monitor how close we are to overflow.
Also allow manual trigger for main CI action.
Signed-off-by: Bill Mills <bill.mills@linaro.org>
Update the README contribution guidelines to document a consistent
Assisted-by tag format for AI-assisted patches.
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
Since Zephyr 4.0, the command west packages pip --install must be run
before west zephyr-export.
Without this order, an error can occur when running west zephyr-export.
ModuleNotFoundError: No module named 'jsonschema'
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
Zephyr 4.3 does not properly support CMake 4.x.
The command "west sdk install" fails because of some Zephyr CMake files.
The issue has been fixed in Zephyr 4.4. Upgrade to Zephyr 4.4
instead of trying to apply a temporary fix for Zephyr 4.3.
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
Add a NULL check for vq before dereferencing it in
virtqueue_notification() to prevent a crash when vq is NULL.
Signed-off-by: Shichun Ma <masc2008@gmail.com>
We now use the "git checkout command" in the RTDs project settings.
This means we will use the .readthedocs.yaml and conf.py from the
openamp-docs repo and no longer need these files in the submodules.
See openamp-docs/.readthedocs.yaml for details.
Signed-off-by: Bill Mills <bill.mills@linaro.org>
Remove the split dcache CMake options from the README.
The options were removed by d183f24 after being deprecated in favor of
WITH_DCACHE. Document only WITH_DCACHE as the supported way to enable
cache operations for vrings, buffers and resource table.
Signed-off-by: Jiaqi Yao <yaojiaqi@lixiang.com>
There is nothing "zynqmp" specific in these files, rename them to generic
ARM names. Having only "zynqmp" files in platforms as before might give
the impression only ZynqMP platforms are supported by this project.
Signed-off-by: Andrew Davis <afd@ti.com>
These were used when this repo contained machine specific examples.
With those moved to the openamp-system-reference project, these CMake
variables are now unused. Remove them.
Signed-off-by: Andrew Davis <afd@ti.com>
The following configuration are deprecated since more than 2 years
(v2024.05):
- rpmsg_virtio_get_status
- rpmsg_virtio_get_features
- rpmsg_virtio_read_config
- virtio_write_config
- rpmsg_virtio_create_virtqueues
- rpmsg_virtio_delete_virtqueues
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
The following configuration are deprecated since more than 2 years
(v2024.05):
- VIRTIO_DRIVER_ONLY
- VIRTIO_DEVICE_ONLY
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
file used by doxygen is doc/Doxyfile.in so remove the Doxyfile file
from root folder to avoid confusion.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
PERL_PATH and MSCGEN_PATH are no longer used, so remove from Doxyfile.in
to avoid warning:
to avoid warning
warning Tag 'PERL_PATH' ... has become obsolete.
warning: Tag 'MSCGEN_PATH' ... has become obsolete.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
to provide access to maintainers information for this repository add it
to the input source files.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Clear the allocated bitmap in `remoteproc_shutdown()` to
prevent resource table parsing failures on repeated remoteproc
starts.
Signed-off-by: Li Zhiyuan <doitysf@hotmail.com>
On GitHub, this check is tagged as "Required."
However, if a PR only affects the following folders:.github, docs,
scripts, or cmake, the check is not executed (to avoid false positives),
resulting in the status "execution pending" + "required" on GitHub.
This commit forces the execution of the check but bypasses the
compliance.xml test when the PR only affects the listed folders.
If at least one update affects other folders, the compliance check
runs as usual.
In addition, the cmake folder is removed from the list, as there is
no reason to skip compliance tests on it.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
- bump to Zephyr 4.3
- use west packages pip --install
- use "west sdk install" command to install the expected sdk version.
- only install arm-zephyr-eabi compiler as build tested only on
arm targets
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
The code contains redundant checks with both metal_assert(vdev) and if
(!vdev).
Moreover, if the assert is disabled, it may lead to dereferencing a null
pointer.
We should not rely on asserts for API validation. Instead, replace the
assert with an error message.
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
Remove the following CMake options and associated definitions that have
been deprecated for over two years:
- WITH_DCACHE_VRINGS
- WITH_DCACHE_BUFFERS
- WITH_DCACHE_RSC_TABLE
- VIRTIO_CACHED_RSC_TABLE
- VIRTIO_CACHED_BUFFERS
- VIRTIO_CACHED_VRINGS
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
The function rproc_virtio_wait_remote_ready does not return a value.
Remove the related @return field from the documentation.
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
- removes CACHE_FLUSH macro clashing with internal QNX definition
- also removes CACHE_INVALIDATE macro for consistency
Signed-off-by: Deep Chordia <dchordia@blackberry.com>
review requested to use a table rather than a code snippet to define
the memory layout, so convert proposed struct to a table with
definition, size and description and explanation of padding between
available and used structures.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
In virtio device side, we always need to get the next avaiable
buffer based on current buffer index. So add these two APIs for
convinience use.
For example, virtio blk driver origanize the buffer:
+----------+
| Reqeust | (Flags: Read | Next)
+----------+
| Buffer | (Flags: Read/Write | Next)
+----------+
| Response | (Flags: Write)
+----------+
For the virtio blk device size, we need get the Buffer and Response buffer
based on the Request buffer index.
So add api virtqueue_get_next_avail_buffer() to get the next available
buffer based on the first buffer index.
And rename the virtqueue_get_available_buffer() to
virtqueue_get_first_avail_buffer()
Signed-off-by: Bowen Wang <wangbowen6@xiaomi.com>
Signed-off-by: Yongrong Wang <wangyongrong@xiaomi.com>
These design documents and images are being moved to openamp-docs
Decided with Bill and Arnaud to move all the design documentation from the
https://github.com/OpenAMP/open-amp repository doc folder to the
https://github.com/OpenAMP/openamp-docs repository docs folder
The main reason being that the breathe and doxylink integration is already
in openamp-docs, so can be used for the design doc.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
in order to use the sphinx breathe plugin in the OpenAMP/openamp-docs
repository we need to enable xml generation
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
To allow for external links to doxygen generated content, tell doxygen
to build tags, so the tag file can be used for cross referencing
doxygen generated data.
Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
metal_cpu_yield can either result in an unimplemented function or a yield
function. The yield function however only yields execution to another
thread of the same or higher priority. Thus starving any lower priority
threads.
wait_remote_ready can be blocked for a long time i.e. seconds waiting on
the remote core to start communication.
Instead use metal_sleep_usec, allowing lower priority tasks to be
executed. While waiting on the remote core.
Signed-off-by: Peter van der Perk <peter.vanderperk@nxp.com>
The applications are now available in the system-reference repository.
Remove the apps folder as it is no longer maintained.
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
The application folder is deprecated and should no more be used.
Remove associated cmake options.
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
We currently support an old version of CMake (3.0.2) that was released
in 2018.
This requires adding specific policies to support the evolution to the
latest versions of Zephyr.
Update the minimum version to 3.16, aligned with the libmetal.
By updating to CMake 3.16 as the minimum version, we can also clean up
the following policy add-ons:
- CMP0048 added in CMake v3.0
- CMP0077 added in CMake v3.13
Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@foss.st.com>
Upstream Read The Docs has tightened up the schema checking and this broke
what we were doing for PRs.
A good number of things were tried but the best compromise is to:
* supply a dummy sphinx config file in this repo
* override the default build command to use the openamp-docs dir
Also:
* add more documentation about what is going on
* lock to html only format. PRs only do html anyway but make sure
Signed-off-by: Bill Mills <bill.mills@linaro.org>
Atul Akella
Sipke Vriend
Chirag Shilwant
Bill Mills
Arnaud Pouliquen
Shichun Ma
Jiaqi Yao
Andrew Davis
Li Zhiyuan
Ed Mooring
Deep Chordia
Bowen Wang
Tanmay Shah
Peter van der Perk
Yongrong Wang