apps: machine: zynqmp_r5: correct IPI setting.
[processor-sdk/open-amp.git] / apps / rpc_demo / README.md
2 # rpc_demo 
3 This readme is about the OpenAMP rpc_demo demo.
4 The rpc_demo is about one processor uses the UART on the other processor and create file on the other processor's filesystem with file operations.
6 For now, It implements the processor running generic(baremetal) applicaiton access the devices on the Linux.
8 ## Compilation
10 ### Baremetal Compilation
11 Option `WITH_RPC_DEMO` is to control if the application will be built.
12 By default this option is `ON` when `WITH_APPS` is on.
14 Here is an example:
16 ```
17 $ cmake ../open-amp -DCMAKE_TOOLCHAIN_FILE=zynq7_generic -DWITH_OBSOLETE=on -DWITH_APPS=ON
18 ```
20 ### Linux Compilation
22 #### Linux Kernel Compilation
23 You will need to manually compile the following kernel modules with your Linux kernel (Please refer to Linux kernel documents for how to add kernel module):
25 * Your machine's remoteproc kernel driver
26 * `obsolete/apps/rpc_demo/system/linux/kernelspace/rpmsg_proxy_dev_driver`
28 #### Linux Userspace Compliation
29 * Compile `obsolete/apps/rpc_demo/system/linux/userspace/proxy_app` into your Linux OS.
30 * Add the built generic `rpc_demo` executable to the firmware of your Linux OS.
32 ## Run the Demo
33 After Linux boots, run `proxy_app` as follows:
34 ```
35 # proxy_app [-m REMOTEPROC_MODULE] [-f PATH_OF_THE_RPC_DEMO_FIRMWARE]
36 ```
38 The demo application will load the remoteproc module, then the proxy rpmsg module, will output message sent from the other processor, send the console input back to the other processor. When the demo application exits, it will unload the kernel modules.