Apply 2.14.0 release update

ChangeLogKSDK.txt

@@ -2,7 +2,53 @@
 @page middleware_log Middleware Change Log
 
 @section multicore Multicore SDK
-  The current version of Multicore SDK is 2.13.0
+  The current version of Multicore SDK is 2.14.0
+  - 2.14.0
+    - Multicore SDK component versions:
+      - embedded Remote Procedure Call (eRPC) v1.11.0
+      - eRPC generator (erpcgen) v.1.11.0
+      - Multicore Manager (MCMgr) v4.1.4
+      - RPMsg-Lite v5.1.0
+    - New features:
+      - eRPC: Makefiles update, GitHub PR #301.
+      - eRPC: Resolving warnings in Python, GitHub PR #325.
+      - eRPC: Python3.8 is not ready for usage of typing.Any type, GitHub PR #325.
+      - eRPC: Improved codec function to use reference instead of address, GitHub PR #324.
+      - eRPC: Fix NULL check for  pending client creation, GitHub PR #341.
+      - eRPC: Replace sprintf with snprintf, GitHub PR #343.
+      - eRPC: Use MU_SendMsg blocking call in MU transport.
+      - eRPC: New LPSPI and LPI2C transport layers.
+      - eRPC: Freeing static objects, GitHub PR #353.
+      - eRPC: Fixed casting in deinit functions, GitHub PR #354.
+      - eRPC: Align LIBUSBSIO.GetNumPorts API use with libusbsio python module v. 2.1.11.
+      - erpcgen: Renamed temp variable to more generic one, GitHub PR #321.
+      - erpcgen: Add check that string read is not more than max length, GitHub PR #328.
+      - erpcgen: Move to g++ in pytest, GitHub PR #335.
+      - erpcgen: Use build=release for make, GitHub PR #334.
+      - erpcgen: Removed boost dependency, GitHub PR #346.
+      - erpcgen: Mingw support, GitHub PR #344.
+      - erpcgen: VS build update, GitHub PR #347.
+      - erpcgen: Modified name for common types macro scope, GitHub PR #337.
+      - erpcgen: Fixed memcpy for template, GitHub PR #352.
+      - eRPC,erpcgen: Change default build target to release + adding artefacts, GitHub PR #334.
+      - eRPC,erpcgen: Remove redundant includes, GitHub PR #338.
+      - eRPC,erpcgen: Many minor code improvements, GitHub PR #323.
+      - MCMgr: Avoid calling tx isr callbacks when respective Messaging Unit Transmit Interrupt Enable flag is not set in the CR/TCR register.
+      - MCMgr: Messaging Unit RX and status registers are cleared after the initialization.
+      - RPMsg-Lite: Resolved issues in ThreadX env. layer implementation.
+      - RPMsg-Lite: Added aarch64 support.
+      - RPMsg-Lite: Increased the queue size to (2 * RL_BUFFER_COUNT) to cover zero copy cases.
+  - 2.13.0_imxrt1180a0
+    - Multicore SDK component versions:
+      - embedded Remote Procedure Call (eRPC) v1.10.0
+      - eRPC generator (erpcgen) v.1.10.0
+      - Multicore Manager (MCMgr) v4.1.3
+      - RPMsg-Lite v5.0.0
+    - New features:
+      - MCMgr, RPMsg-Lite: Added porting layers for imxrt1180.
+      - MCMgr: mu_isr() updated to avoid calling tx isr callbacks when respective Transmit Interrupt Enable flag is not set in the CR/TCR register.
+      - RPMsg-Lite, eRPC: RPMsg_Lite queue size adjusted.
+      - eRPC: MU transport layer switched to blocking MU_SendMsg() API use.
   - 2.13.0
     - Multicore SDK component versions:
       - embedded Remote Procedure Call (eRPC) v1.10.0

mcmgr/doc/dir_68267d1309a1af8e8297ef4c3efbcdba.html

@@ -34,7 +34,7 @@
   <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Multicore Manager (MCMGR) User&#39;s Guide
-   &#160;<span id="projectnumber">Rev. 4.1.3</span>
+   &#160;<span id="projectnumber">Rev. 4.1.4</span>
    </div>
    <div id="projectbrief">NXP Semiconductors</div>
   </td>

mcmgr/doc/group__mcmgr.html

@@ -34,7 +34,7 @@
   <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Multicore Manager (MCMGR) User&#39;s Guide
-   &#160;<span id="projectnumber">Rev. 4.1.3</span>
+   &#160;<span id="projectnumber">Rev. 4.1.4</span>
    </div>
    <div id="projectbrief">NXP Semiconductors</div>
   </td>
@@ -242,7 +242,7 @@
  }<tr class="memdesc:ga0a45660b38a87ca65052a15d721a4949"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type definition of event types. <br /></td></tr>
 </td></tr>
 <tr class="separator:ga0a45660b38a87ca65052a15d721a4949"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:gabbf6e7e7978f537eaa72ea8e95bd0f1f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcmgr.html#gabbf6e7e7978f537eaa72ea8e95bd0f1f">mcmgr_version_enum</a> { <b>kMCMGR_Version</b> = 0x00040103
+<tr class="memitem:gabbf6e7e7978f537eaa72ea8e95bd0f1f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcmgr.html#gabbf6e7e7978f537eaa72ea8e95bd0f1f">mcmgr_version_enum</a> { <b>kMCMGR_Version</b> = 0x00040104
  }<tr class="memdesc:gabbf6e7e7978f537eaa72ea8e95bd0f1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Version of MCMGR.  <a href="group__mcmgr.html#gabbf6e7e7978f537eaa72ea8e95bd0f1f">More...</a><br /></td></tr>
 </td></tr>
 <tr class="separator:gabbf6e7e7978f537eaa72ea8e95bd0f1f"><td class="memSeparator" colspan="2">&#160;</td></tr>

mcmgr/doc/index.html

@@ -34,7 +34,7 @@
   <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Multicore Manager (MCMGR) User&#39;s Guide
-   &#160;<span id="projectnumber">Rev. 4.1.3</span>
+   &#160;<span id="projectnumber">Rev. 4.1.4</span>
    </div>
    <div id="projectbrief">NXP Semiconductors</div>
   </td>
@@ -118,7 +118,8 @@ <h1><a class="anchor" id="usage"></a>
 Usage of the MCMGR software component</h1>
 <p>The main use case of MCMGR is the secondary/auxiliary core start. This functionality is performed by the public API function.</p>
 <p>Example of MCMGR usage to start secondary core:</p>
-<div class="fragment"><div class="line"><span class="preprocessor">#include &quot;mcmgr.h&quot;</span></div><div class="line"></div><div class="line"><span class="keywordtype">void</span> main()</div><div class="line">{</div><div class="line">    <span class="comment">/* Initialize MCMGR - low level multicore management library.</span></div><div class="line"><span class="comment">       Call this function as close to the reset entry as possible,</span></div><div class="line"><span class="comment">       (into the startup sequence) to allow CoreUp event triggering. */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#ga113834314ba8d727f8d601463ee71e88">MCMGR_EarlyInit</a>();</div><div class="line"></div><div class="line">    <span class="comment">/* Initialize MCMGR, install generic event handlers */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#gab18e570ea8c466214b3725785d45aa35">MCMGR_Init</a>();</div><div class="line"></div><div class="line">    <span class="comment">/* Boot secondary core application from the CORE1_BOOT_ADDRESS, pass &quot;1&quot; as startup data, starting synchronously. */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#gac7850a1875bec8499300b1915a79a596">MCMGR_StartCore</a>(<a class="code" href="group__mcmgr.html#gga04ccbddec3c91482490e57e53afbeb6fae5ff151633b4ee4b9dc9e0825675ecc1">kMCMGR_Core1</a>, CORE1_BOOT_ADDRESS, 1, <a class="code" href="group__mcmgr.html#gga2b471b0504b78138baba1e17a05a9b9ca1d97daf76353ad10e9ccdf91c42c759f">kMCMGR_Start_Synchronous</a>);</div><div class="line">.</div><div class="line">.</div><div class="line">.</div><div class="line">    <span class="comment">/* Stop secondary core execution. */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#gab11c27fda1a646433b0d8cef19de6ee4">MCMGR_StopCore</a>(<a class="code" href="group__mcmgr.html#gga04ccbddec3c91482490e57e53afbeb6fae5ff151633b4ee4b9dc9e0825675ecc1">kMCMGR_Core1</a>);</div><div class="line">}</div></div><!-- fragment --><p>Another important MCMGR feature is the ability for remote core monitoring and handling of events such as reset, exception, and application events. Application-specific callback functions for events are registered by the <a class="el" href="group__mcmgr.html#ga08a4a13691e04c934998926adb277ae2" title="Register event handler. ">MCMGR_RegisterEvent()</a> API. Triggering these events is done using the <a class="el" href="group__mcmgr.html#ga75116754c189363da844f4a1a6da0f47" title="Trigger event handler. ">MCMGR_TriggerEvent()</a> API. mcmgr_event_type_t enums all possible event types.</p>
+<div class="fragment"><div class="line"><span class="preprocessor">#include &quot;mcmgr.h&quot;</span></div><div class="line"></div><div class="line"><span class="keywordtype">void</span> main()</div><div class="line">{</div><div class="line">    <span class="comment">/* Initialize MCMGR - low level multicore management library.</span></div><div class="line"><span class="comment">       Call this function as close to the reset entry as possible,</span></div><div class="line"><span class="comment">       (into the startup sequence) to allow CoreUp event triggering. */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#ga113834314ba8d727f8d601463ee71e88">MCMGR_EarlyInit</a>();</div><div class="line"></div><div class="line">    <span class="comment">/* Initialize MCMGR, install generic event handlers */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#gab18e570ea8c466214b3725785d45aa35">MCMGR_Init</a>();</div><div class="line"></div><div class="line">    <span class="comment">/* Boot secondary core application from the CORE1_BOOT_ADDRESS, pass &quot;1&quot; as startup data, starting synchronously. */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#gac7850a1875bec8499300b1915a79a596">MCMGR_StartCore</a>(<a class="code" href="group__mcmgr.html#gga04ccbddec3c91482490e57e53afbeb6fae5ff151633b4ee4b9dc9e0825675ecc1">kMCMGR_Core1</a>, CORE1_BOOT_ADDRESS, 1, <a class="code" href="group__mcmgr.html#gga2b471b0504b78138baba1e17a05a9b9ca1d97daf76353ad10e9ccdf91c42c759f">kMCMGR_Start_Synchronous</a>);</div><div class="line">.</div><div class="line">.</div><div class="line">.</div><div class="line">    <span class="comment">/* Stop secondary core execution. */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#gab11c27fda1a646433b0d8cef19de6ee4">MCMGR_StopCore</a>(<a class="code" href="group__mcmgr.html#gga04ccbddec3c91482490e57e53afbeb6fae5ff151633b4ee4b9dc9e0825675ecc1">kMCMGR_Core1</a>);</div><div class="line">}</div></div><!-- fragment --><p>Some platforms allow stopping and re-starting the secondary core application again, using the MCMGR_StopCore / MCMGR_StartCore API calls. It is necessary to ensure the initially loaded image is not corrupted before re-starting, especially if it deals with the RAM target. Cache coherence has to be considered/ensured as well.</p>
+<p>Another important MCMGR feature is the ability for remote core monitoring and handling of events such as reset, exception, and application events. Application-specific callback functions for events are registered by the <a class="el" href="group__mcmgr.html#ga08a4a13691e04c934998926adb277ae2" title="Register event handler. ">MCMGR_RegisterEvent()</a> API. Triggering these events is done using the <a class="el" href="group__mcmgr.html#ga75116754c189363da844f4a1a6da0f47" title="Trigger event handler. ">MCMGR_TriggerEvent()</a> API. mcmgr_event_type_t enums all possible event types.</p>
 <p>An example of MCMGR usage for remote core monitoring and event handling. Code for the primary side:</p>
 <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;mcmgr.h&quot;</span></div><div class="line"></div><div class="line"><span class="preprocessor">#define APP_RPMSG_READY_EVENT_DATA  (1)</span></div><div class="line"></div><div class="line">uint16_t RPMsgRemoteReadyEventData = 0;</div><div class="line"></div><div class="line"><span class="comment">/* Callback function registered via the MCMGR_RegisterEvent() and triggered by MCMGR_TriggerEvent() called on the secondary core side */</span></div><div class="line"><span class="keywordtype">void</span> RPMsgRemoteReadyEventHandler(uint16_t eventData, <span class="keywordtype">void</span> *context)</div><div class="line">{</div><div class="line">    RPMsgRemoteReadyEventData = eventData;</div><div class="line">}</div><div class="line"></div><div class="line"><span class="keywordtype">void</span> main()</div><div class="line">{</div><div class="line">    <span class="comment">/* Initialize MCMGR - low level multicore management library.</span></div><div class="line"><span class="comment">       Call this function as close to the reset entry as possible,</span></div><div class="line"><span class="comment">       (into the startup sequence) to allow CoreUp event triggering. */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#ga113834314ba8d727f8d601463ee71e88">MCMGR_EarlyInit</a>();</div><div class="line"></div><div class="line">    <span class="comment">/* Initialize MCMGR, install generic event handlers */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#gab18e570ea8c466214b3725785d45aa35">MCMGR_Init</a>();</div><div class="line"></div><div class="line">    <span class="comment">/* Register the application event before starting the secondary core */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#ga08a4a13691e04c934998926adb277ae2">MCMGR_RegisterEvent</a>(kMCMGR_RemoteApplicationEvent, RPMsgRemoteReadyEventHandler, NULL);</div><div class="line"></div><div class="line">    <span class="comment">/* Boot secondary core application from the CORE1_BOOT_ADDRESS, pass rpmsg_lite_base address as startup data, starting synchronously. */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#gac7850a1875bec8499300b1915a79a596">MCMGR_StartCore</a>(<a class="code" href="group__mcmgr.html#gga04ccbddec3c91482490e57e53afbeb6fae5ff151633b4ee4b9dc9e0825675ecc1">kMCMGR_Core1</a>, CORE1_BOOT_ADDRESS, (uint32_t)rpmsg_lite_base, <a class="code" href="group__mcmgr.html#gga2b471b0504b78138baba1e17a05a9b9ca1d97daf76353ad10e9ccdf91c42c759f">kMCMGR_Start_Synchronous</a>);</div><div class="line"></div><div class="line">    <span class="comment">/* Wait until the secondary core application signals the rpmsg remote has been initialized and is ready to communicate. */</span></div><div class="line">    <span class="keywordflow">while</span>(APP_RPMSG_READY_EVENT_DATA != RPMsgRemoteReadyEventData) {};</div><div class="line">.</div><div class="line">.</div><div class="line">.</div><div class="line">}</div></div><!-- fragment --><p>Code for the secondary side:</p>
 <div class="fragment"><div class="line"><span class="preprocessor">#include &quot;mcmgr.h&quot;</span></div><div class="line"></div><div class="line"><span class="preprocessor">#define APP_RPMSG_READY_EVENT_DATA  (1)</span></div><div class="line"></div><div class="line"><span class="keywordtype">void</span> main()</div><div class="line">{</div><div class="line">    <span class="comment">/* Initialize MCMGR - low level multicore management library.</span></div><div class="line"><span class="comment">       Call this function as close to the reset entry as possible,</span></div><div class="line"><span class="comment">       (into the startup sequence) to allow CoreUp event triggering. */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#ga113834314ba8d727f8d601463ee71e88">MCMGR_EarlyInit</a>();</div><div class="line"></div><div class="line">    <span class="comment">/* Initialize MCMGR, install generic event handlers */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#gab18e570ea8c466214b3725785d45aa35">MCMGR_Init</a>();</div><div class="line">.</div><div class="line">.</div><div class="line">.</div><div class="line"></div><div class="line">    <span class="comment">/* Signal the to other core that we are ready by triggering the event and passing the APP_RPMSG_READY_EVENT_DATA */</span></div><div class="line">    <a class="code" href="group__mcmgr.html#ga75116754c189363da844f4a1a6da0f47">MCMGR_TriggerEvent</a>(kMCMGR_RemoteApplicationEvent, APP_RPMSG_READY_EVENT_DATA);</div><div class="line">.</div><div class="line">.</div><div class="line">.</div><div class="line">}</div></div><!-- fragment --><h1><a class="anchor" id="data_exchange_diagram"></a>
@@ -159,6 +160,10 @@ <h1><a class="anchor" id="revision_history"></a>
 <td>4.1.2 </td><td>04/2022 </td><td>Update mcmgr_stop_core_internal() implementations to set core state to kMCMGR_ResetCoreState </td></tr>
 <tr>
 <td>4.1.3 </td><td>10/2022 </td><td>mcmgr_mu_internal.c code adaptation to new supported SoCs </td></tr>
+<tr>
+<td>4.1.4 </td><td>04/2023 </td><td><p class="starttd">Avoid calling tx isr callbacks when respective Messaging Unit Transmit Interrupt Enable flag is not set in the CR/TCR register </p>
+<p class="endtd">Messaging Unit RX and status registers are cleared after the initialization </p>
+</td></tr>
 </table>
 </div></div><!-- contents -->
 </div><!-- doc-content -->

mcmgr/doc/modules.html

@@ -34,7 +34,7 @@
   <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Multicore Manager (MCMGR) User&#39;s Guide
-   &#160;<span id="projectnumber">Rev. 4.1.3</span>
+   &#160;<span id="projectnumber">Rev. 4.1.4</span>
    </div>
    <div id="projectbrief">NXP Semiconductors</div>
   </td>

mcmgr/doxygen/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Multicore Manager (MCMGR) User's Guide"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "Rev. 4.1.1"
+PROJECT_NUMBER         = "Rev. 4.1.4"
 
 # 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

mcmgr/doxygen/mainpage.md

@@ -42,6 +42,8 @@ void main()
 }
 ~~~~~
 
+Some platforms allow stopping and re-starting the secondary core application again, using the MCMGR_StopCore / MCMGR_StartCore API calls. It is necessary to ensure the initially loaded image is not corrupted before re-starting, especially if it deals with the RAM target. Cache coherence has to be considered/ensured as well.
+
 Another important MCMGR feature is the ability for remote core monitoring and handling of events such as reset, exception, and application events.
 Application-specific callback functions for events are registered by the MCMGR_RegisterEvent() API. Triggering these events is done using the MCMGR_TriggerEvent() API.
 mcmgr_event_type_t enums all possible event types.
@@ -134,4 +136,7 @@ This table summarizes revisions of this document.
 |4.0.2          | 09/2018 | Align porting layers to the updated MCUXpressoSDK feature files      |
 |4.0.3          | 05/2019 | Minor code adjustments based on static analysis tool findings      |
 |4.1.0          | 11/2019 | Code adjustments to address MISRA C-2012 Rules      |
+|4.1.2          | 04/2022 | Update mcmgr_stop_core_internal() implementations to set core state to kMCMGR_ResetCoreState      |
+|4.1.3          | 10/2022 | mcmgr_mu_internal.c code adaptation to new supported SoCs     |
+|4.1.4          | 04/2023 | Avoid calling tx isr callbacks when respective Messaging Unit Transmit Interrupt Enable flag is not set in the CR/TCR register <p> Messaging Unit RX and status registers are cleared after the initialization     |
 

mcmgr/src/mcmgr.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2014-2016, Freescale Semiconductor, Inc.
- * Copyright 2016-2020 NXP
+ * Copyright 2016-2023 NXP
  * All rights reserved.
  *
  *
@@ -116,7 +116,7 @@ typedef void (*mcmgr_event_callback_t)(uint16_t data, void *context);
  */
 enum mcmgr_version_enum
 {
-    kMCMGR_Version = 0x00040103
+    kMCMGR_Version = 0x00040104
 };
 
 #if defined(__cplusplus)