Skip to content

Commit

Permalink
lib: update open-amp lib to release v2023.10.0
Browse files Browse the repository at this point in the history
Origin:
    	https://github.com/OpenAMP/open-amp

Commit:
    	1904dee18da85400e72b8f55c5c99e872a486573

Status:
  	Merge open-amp new version after removing the apps and scripts
  	directories.

Release description:
    	https://github.com/OpenAMP/open-amp/releases/tag/v2023.10.0

Signed-off-by: Arnaud Pouliquen <[email protected]>
  • Loading branch information
arnopo authored and carlescufi committed Dec 14, 2023
1 parent 214f9fc commit da78aea
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 30 deletions.
2 changes: 1 addition & 1 deletion open-amp/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -1144,7 +1144,7 @@ FORTRAN_COMMENT_AFTER = 72
# also VERBATIM_HEADERS is set to NO.
# The default value is: NO.

SOURCE_BROWSER = YES
SOURCE_BROWSER = NO

# Setting the INLINE_SOURCES tag to YES will include the body of functions,
# classes and enums directly into the documentation.
Expand Down
31 changes: 22 additions & 9 deletions open-amp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,8 @@ In order to user OpenAMP(RPMsg) in Linux userspace, you will need to have put th
https://github.com/OpenAMP/open-amp/blob/main/apps/machine/zynqmp/openamp-linux-userspace.dtsi

## Version
The OpenAMP version follows the set of rule proposed in [Semantic Versioning specification](https://semver.org/).
The OpenAMP version follows the set of rule proposed in
[Semantic Versioning specification](https://semver.org/).

## Supported System and Machines
For now, it supports:
Expand All @@ -269,37 +270,47 @@ For now, it supports:
it doesn't work on some systems if you are normal users.

## How to contribute:
As an open-source project, we welcome and encourage the community to submit patches directly to the project. As a contributor you should be familiar with common developer tools such as Git and CMake, and platforms such as GitHub.
As an open-source project, we welcome and encourage the community to submit patches directly to the
project. As a contributor you should be familiar with common developer tools such as Git and CMake,
and platforms such as GitHub.
Then following points should be rescpected to facilitate the review process.

### Licencing
Code is contributed to the Linux kernel under a number of licenses, but all code must be compatible with version the [BSD License](https://github.com/OpenAMP/open-amp/blob/main/LICENSE.md), which is the license covering the OpenAMP distribution as a whole. In practice, use the following tag instead of the full license text in the individual files:
Code is contributed to the Linux kernel under a number of licenses, but all code must be compatible
with version the [BSD License](https://github.com/OpenAMP/open-amp/blob/main/LICENSE.md), which is
the license covering the OpenAMP distribution as a whole. In practice, use the following tag
instead of the full license text in the individual files:

```
SPDX-License-Identifier: BSD-3-Clause
SPDX-License-Identifier: BSD-2-Clause
```
### Signed-off-by
Commit message must contain Signed-off-by: line and your email must match the change authorship information. Make sure your .gitconfig is set up correctly:
Commit message must contain Signed-off-by: line and your email must match the change authorship
information. Make sure your .gitconfig is set up correctly:

```
git config --global user.name "first-name Last-Namer"
git config --global user.email "[email protected]"
```
### gitlint
Before you submit a pull request to the project, verify your commit messages meet the requirements. The check can be performed locally using the the gitlint command.
Before you submit a pull request to the project, verify your commit messages meet the requirements.
The check can be performed locally using the the gitlint command.

Run gitlint locally in your tree and branch where your patches have been committed:

```gitlint```
Note, gitlint only checks HEAD (the most recent commit), so you should run it after each commit, or use the --commits option to specify a commit range covering all the development patches to be submitted.
Note, gitlint only checks HEAD (the most recent commit), so you should run it after each commit, or
use the --commits option to specify a commit range covering all the development patches to be
submitted.

### Code style
In general, follow the Linux kernel coding style, with the following exceptions:

* Use /** */ for doxygen comments that need to appear in the documentation.

The Linux kernel GPL-licensed tool checkpatch is used to check coding style conformity.Checkpatch is available in the scripts directory.
The Linux kernel GPL-licensed tool checkpatch is used to check coding style conformity.Checkpatch is
available in the scripts directory.

To check your \<n\> commits in your git branch:
```
Expand All @@ -310,6 +321,8 @@ To check your \<n\> commits in your git branch:
We use standard github mechanism for pull request. Please refer to github documentation for help.

## Communication and Collaboration
[Subscribe](https://lists.openampproject.org/mailman3/lists/openamp-rp.lists.openampproject.org/) to the OpenAMP mailing list([email protected]).
[Subscribe](https://lists.openampproject.org/mailman3/lists/openamp-rp.lists.openampproject.org/) to
the OpenAMP mailing list([email protected]).

For more details on the framework please refer to the the [OpenAMP wiki](https://github.com/OpenAMP/open-amp/wiki).
For more details on the framework please refer to the
[OpenAMP Docs](https://openamp.readthedocs.io/en/latest/).
2 changes: 1 addition & 1 deletion open-amp/VERSION
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
VERSION_MAJOR = 1
VERSION_MINOR = 4
VERSION_MINOR = 5
VERSION_PATCH = 0
22 changes: 17 additions & 5 deletions open-amp/doc/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
if (DOXYGEN_FOUND)

configure_file (Doxyfile.in Doxyfile @ONLY)
if (EXISTS ${CMAKE_SOURCE_DIR}/../_doxygen/openamp/Doxyfile-openamp.in)
set (OAMP_DOX_DIR ${CMAKE_SOURCE_DIR}/../_doxygen/openamp)
configure_file (Doxyfile.in Doxyfile1 @ONLY)
configure_file (${OAMP_DOX_DIR}/Doxyfile-openamp.in Doxyfile2 @ONLY)

add_custom_target (doc ALL
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
add_custom_target (doc ALL
COMMAND cat Doxyfile1 Doxyfile2 >Doxyfile
COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
else ()
configure_file (Doxyfile.in Doxyfile @ONLY)

add_custom_target (doc ALL
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
endif ()

install (DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
DESTINATION share/doc/${PROJECT_NAME})
Expand Down
18 changes: 7 additions & 11 deletions open-amp/lib/include/openamp/virtio.h
Original file line number Diff line number Diff line change
Expand Up @@ -214,9 +214,10 @@ struct virtio_device {
* @return pointer to the device name string if found, otherwise null.
*/
const char *virtio_dev_name(uint16_t devid);
void virtio_describe(struct virtio_device *dev, const char *msg,
uint32_t features,
struct virtio_feature_desc *feature_desc);

__deprecated void virtio_describe(struct virtio_device *dev, const char *msg,
uint32_t features,
struct virtio_feature_desc *feature_desc);

/**
* @brief Virtio device dispatcher functions.
Expand Down Expand Up @@ -297,18 +298,13 @@ int virtio_create_virtqueues(struct virtio_device *vdev, unsigned int flags,
*
* @param vdev Pointer to virtio device structure.
*
* @return 0 on success, otherwise error code.
*/
static inline int virtio_delete_virtqueues(struct virtio_device *vdev)
static inline void virtio_delete_virtqueues(struct virtio_device *vdev)
{
if (!vdev)
return -EINVAL;

if (!vdev->func || !vdev->func->delete_virtqueues)
return -ENXIO;
if (!vdev || !vdev->func || !vdev->func->delete_virtqueues)
return;

vdev->func->delete_virtqueues(vdev);
return 0;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion open-amp/lib/include/openamp/virtio_ring.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ extern "C" {
* The descriptor table refers to the buffers the driver is using for the
* device. addr is a physical address, and the buffers can be chained via \ref next.
* Each descriptor describes a buffer which is read-only for the device
* (“device-readable”) or write-only for the device (“device-writable”), but a
* (“device-readable”) or write-only for the device (“device-writable”), but a
* chain of descriptors can contain both device-readable and device-writable
* buffers.
*/
Expand Down
4 changes: 2 additions & 2 deletions open-amp/lib/virtio/virtio.c
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ static const char *virtio_feature_name(unsigned long val,
return NULL;
}

void virtio_describe(struct virtio_device *dev, const char *msg,
uint32_t features, struct virtio_feature_desc *desc)
__deprecated void virtio_describe(struct virtio_device *dev, const char *msg,
uint32_t features, struct virtio_feature_desc *desc)
{
(void)dev;
(void)msg;
Expand Down

0 comments on commit da78aea

Please sign in to comment.