README.md
1# mcux-sdk-middleware-multicore
2
3This repository is for MCUXpresso SDK multicore middleware delivery and it contains multicore components officially provided in NXP MCUXpresso SDK.
4
5This reposirtory is a part of MCUXpresso SDK overall delivery which is composed of several project deliveries. Please go to the [main repository](https://github.com/NXPmicro/mcux-sdk/) to get the MCUXpresso overall delivery to be able to build and run multicore examples that are based on mcux-sdk-middleware-multicore components.
6
readme.txt
1Multicore SDK
2=============
3
4This is the top level Multicore SDK directory. This directory contains source code
5for NXP's multicore support.
6
7
8Prerequisites
9-------------
10
11There are several packages required to build multicore source code.
12
13erpcgen prerequisites:
14 - flex
15 - bison
16 - boost
17
18Documentation
19-------------
20
21Multicore SDK documents can be found in the top level MCUXpressoSDK doc directory:
22 "MCUXSDK_ROOT/docs/MULTICORE".
23
24Directory Structure
25-------------------
26
27(Not all MCUXpresso SDK packages contain the whole set of these folders)
28
29erpc - Embedded Remote Procedure Call. An infrastructure to abstract multicore
30communication to fully user-definable sets of function calls. A host tool,
31erpcgen, is provided to generate code to implement the multicore communication
32layer for the defined function calls. Erpcgen is built for Linux, Windows, and
33OS X.
34
35mcmgr - Multicore Manager. Provides control of second core startup and shutdown.
36
37rdmgr - Resource Domain Manager. Configures the XRDC periphal, which controls
38access rights to peripherals and memory blocks.
39
40remoteproc - General source code used for remote cores (from the Linux perspective)
41to allow easy remote core applications deployment/start/debug via the remoteproc
42Linux framework.
43
44rpmsg_lite - Remote Processor Messaging Lite software component is a lightweight
45implementation of the RPMsg protocol. Compared to the OpenAMP implementation,
46the RPMsg-Lite offers a code size reduction, API simplification and improved
47modularity.
48
49tools - Folder contains tools and utilities for multicore like prebuilt
50versions of erpcgen and erpcsniffer.
51
