Skip to content

Commit

Permalink
[MCUX-71701] Update RPMsg-Lite documentation for the version 5.1.3
Browse files Browse the repository at this point in the history
Signed-off-by: Michal Princ <michal.princ@nxp.com>
  • Loading branch information
MichalPrincNXP committed Jan 8, 2025
1 parent 90831dc commit d72dd6f
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 11 deletions.
13 changes: 12 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [5.1.3] - 13-Jan-2025

### Added

- Memory cache management of shared memory. Enable with `#define RL_USE_DCACHE (1)` in `rpmsg_config.h` in case of data cache is used.
- Cmake/Kconfig support added.
- Porting layers for imx95, imxrt700, mcmxw71x, mcmxw72x, kw47b42 added.

## [5.1.2] - 08-Jul-2024

### Changed

- Zephyr-related changes.
- Minor Misra corrections.

## [5.1.1] - 19-Jan-2023
## [5.1.1] - 19-Jan-2024

### Added

Expand Down
4 changes: 2 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
#
# Copyright 2024 NXP
# Copyright 2024,2025 NXP
#
# SPDX-License-Identifier: BSD-3-Clause
#

# middleware.multicore.rpmsg-lite
if (CONFIG_MCUX_COMPONENT_middleware.multicore.rpmsg-lite)
mcux_component_version(5.1.2)
mcux_component_version(5.1.3)
mcux_add_include(
INCLUDES lib/include
)
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ RPMsg_Lite multicore examples are part of NXP MCUXpressoSDK packages. Visit [htt

<MCUXpressoSDK_install_dir>/boards/<board_name>/multicore_examples for RPMsg_Lite multicore examples with 'rpmsg_lite_' name prefix.

Another way of getting NXP MCUXpressoSDK RPMsg_Lite multicore examples is using the [mcux-sdk](https://github.com/nxp-mcuxpresso/mcux-sdk) Github repo. Follow the description how to use the West tool to clone and update the mcuxsdk repo in [readme Overview section](https://github.com/nxp-mcuxpresso/mcux-sdk#overview). Once done the armgcc rpmsg_lite examples can be found in
Another way of getting NXP MCUXpressoSDK RPMsg_Lite multicore examples is using the [mcuxsdk-manifests](https://github.com/nxp-mcuxpresso/mcuxsdk-manifests) Github repo. Follow the description how to use the West tool to clone and update the mcuxsdk-manifests repo in [readme section](https://github.com/nxp-mcuxpresso/mcuxsdk-manifests?tab=readme-ov-file#readme). Once done the armgcc rpmsg_lite examples can be found in

mcuxsdk/examples/<board_name>/multicore_examples
mcuxsdk/examples/_<board_name>/multicore_examples

You can use the evkmimxrt1170 as the board_name for instance. Similar to MCUXpressoSDK packages the RPMsg_Lite examples use the 'rpmsg_lite_' name prefix.
## Notes {#notes}
Expand Down Expand Up @@ -133,4 +133,4 @@ This script executes the application named *clang-format.exe*. You need to have
[1] M. Novak, M. Cingel, Lockless Shared Memory Based Multicore Communication Protocol
---
Copyright © 2016 Freescale Semiconductor, Inc.
Copyright © 2016-2024 NXP
Copyright © 2016-2025 NXP
2 changes: 1 addition & 1 deletion doxygen/Doxyfile.rpmsglite
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "RPMsg-Lite User's Guide"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = "Rev. 5.1.2"
PROJECT_NUMBER = "Rev. 5.1.3"

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
4 changes: 2 additions & 2 deletions doxygen/html_footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul class="foot">
<li class="footer">Copyright 2016-2024 NXP Semiconductors. All rights reserved.
<li class="footer">Copyright 2016-2025 NXP Semiconductors. All rights reserved.
</li>
</ul>
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<hr class="footer"/><address class="footer"><small>
Copyright 2016-2024 NXP Semiconductors. All rights reserved.
Copyright 2016-2025 NXP Semiconductors. All rights reserved.
</small></address>
<!--END !GENERATE_TREEVIEW-->
</body>
Expand Down
4 changes: 2 additions & 2 deletions lib/include/rpmsg_lite.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Copyright (c) 2014, Mentor Graphics Corporation
* Copyright (c) 2015 Xilinx, Inc.
* Copyright (c) 2016 Freescale Semiconductor, Inc.
* Copyright 2016-2024 NXP
* Copyright 2016-2025 NXP
* Copyright 2021 ACRIOS Systems s.r.o.
* All rights reserved.
*
Expand Down Expand Up @@ -52,7 +52,7 @@ extern "C" {
* Definitions
******************************************************************************/

#define RL_VERSION "5.1.2" /*!< Current RPMsg Lite version */
#define RL_VERSION "5.1.3" /*!< Current RPMsg Lite version */

/* Shared memory "allocator" parameters */
#define RL_WORD_SIZE (sizeof(uint32_t))
Expand Down

0 comments on commit d72dd6f

Please sign in to comment.