Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions examples/legacy_apps/machine/xlnx/microblaze_generic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,16 @@ with RPMSG_NO_IPI flag.
include (cross-generic-gcc)
```

* Compile the libmetal library:
* Compile the libmetal library:

```
$ mkdir -p build-libmetal
$ cd build-libmetal
$ BSP="/path/to/your_MicroBlaze_design_BSP/dir"
$ cmake <libmetal_source> -DCMAKE_TOOLCHAIN_FILE=<toolchain_file> \
-DCMAKE_LIBRARY_PATH=$BSP/lib
$ make VERBOSE=1 DESTDIR=<libmetal_install> install
```
```shell
mkdir -p build-libmetal
cd build-libmetal
BSP="/path/to/your_MicroBlaze_design_BSP/dir"
cmake <libmetal_source> -DCMAKE_TOOLCHAIN_FILE=<toolchain_file> \
-DCMAKE_LIBRARY_PATH=$BSP/lib
make VERBOSE=1 DESTDIR=<libmetal_install> install
```

* build the OpenAMP library on your host as follows:
* Create your own cmake toolchain file to compile openamp for your generic
Expand Down Expand Up @@ -76,16 +76,16 @@ with RPMSG_NO_IPI flag.

* Compile the OpenAMP library:

```
$ mkdir -p build-openamp
$ cd build-openamp
$ BSP="/path/to/your_MicroBlaze_design_BSP/dir"

$ cmake <openamp_source> -DCMAKE_TOOLCHAIN_FILE=<toolchain_file> \
-DCMAKE_INCLUDE_PATH="$LIBMETAL/include;$BSP/include" \
-DCMAKE_LIBRARY_PATH="$LIBMETAL/lib/;BSP/lib" -DWITH_APPS=on
$ make VERBOSE=1 DESTDIR=$(pwd) install
```
```shell
mkdir -p build-openamp
cd build-openamp
BSP="/path/to/your_MicroBlaze_design_BSP/dir"

cmake <openamp_source> -DCMAKE_TOOLCHAIN_FILE=<toolchain_file> \
-DCMAKE_INCLUDE_PATH="$LIBMETAL/include;$BSP/include" \
-DCMAKE_LIBRARY_PATH="$LIBMETAL/lib/;BSP/lib" -DWITH_APPS=on
make VERBOSE=1 DESTDIR=$(pwd) install
```

The OpenAMP library will be built in `build/usr/local/lib` directory,
headers will be built in `build/usr/local/include` directory, and the
Expand Down
2 changes: 1 addition & 1 deletion examples/linux/rpmsg-echo-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

Assume all the binaries are board specific.

```
```shell
# Specify remote processor firmware to be loaded.
echo image_echo_test > /sys/class/remoteproc/remoteproc0/firmware

Expand Down
2 changes: 1 addition & 1 deletion examples/linux/rpmsg-mat-mul/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

Assume all the binaries are board specific.

```
```shell
# Specify remote processor firmware to be loaded.
echo image_matrix_multiply > /sys/class/remoteproc/remoteproc0/firmware

Expand Down
2 changes: 1 addition & 1 deletion examples/linux/rpmsg-proxy-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@

Assume all the binaries are zcu102 board specific.

```
```shell
# Specify remote processor firmware to be loaded.
echo image_rpc_demo > /sys/class/remoteproc/remoteproc0/firmware

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ automatically create endpoint devices as remoteproc devices are booted.
An example of udev-rule that automatically exposes the APPS_RIVA_CTRL channel
to user space as the pronto core comes up:

```
ACTION=="add", SUBSYSTEM=="rpmsg", \
KERNEL=="rpmsg_ctrl[0-9]*", \
ATTRS{rpmsg_name}=="pronto", \
Expand All @@ -22,9 +23,10 @@ SUBSYSTEM=="rpmsg", KERNEL=="rpmsg[0-9]*", \
ATTR{name}=="?*", \
ATTRS{rpmsg_name}=="?*", \
SYMLINK+="rpmsg/$attr{rpmsg_name}/$attr{name}"
```

eptdestroy
====
==========
"rpmsg_destroy_ept" implements RPMSG_DESTROY_EPT_IOCTL to destroy an endpoint created by the RPMSG_CREATE_EPT_IOCTL.

ping
Expand Down
66 changes: 45 additions & 21 deletions examples/zephyr/dual_qemu_ivshmem/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,21 @@ Preparing IVSHMEM server before doing anything:
.. code-block:: console

# n = number of vectors
$ sudo ivshmem-server -n 2
$ *** Example code, do not use in production ***
sudo ivshmem-server -n 2

.. code-block:: console

*** Example code, do not use in production ***

#. Appropriately set ownership of ``/dev/shm/ivshmem`` and
``/tmp/ivshmem_socket`` for your deployment scenario. For instance:

.. code-block:: console

$ sudo chgrp $USER /dev/shm/ivshmem
$ sudo chmod 060 /dev/shm/ivshmem
$ sudo chgrp $USER /tmp/ivshmem_socket
$ sudo chmod 060 /tmp/ivshmem_socket
sudo chgrp $USER /dev/shm/ivshmem
sudo chmod 060 /dev/shm/ivshmem
sudo chgrp $USER /tmp/ivshmem_socket
sudo chmod 060 /tmp/ivshmem_socket

Building and Running
********************
Expand All @@ -68,15 +71,15 @@ open a terminal and then type:

.. code-block:: console

$ cd path/to/this-repo/examples/zephyr/dual_qemu_ivshmem/host
$ west build -pauto -bqemu_cortex_a53
cd path/to/this-repo/examples/zephyr/dual_qemu_ivshmem/host
west build -pauto -bqemu_cortex_a53

For the remote side, open another terminal window and then type:

.. code-block:: console

$ cd path/to/this-repo/examples/zephyr/dual_qemu_ivshmem/remote
$ west build -pauto -bqemu_cortex_a53
cd path/to/this-repo/examples/zephyr/dual_qemu_ivshmem/remote
west build -pauto -bqemu_cortex_a53

* Note: Warnings that appear are from ivshmem-shell subsystem and can be ignored.

Expand All @@ -89,15 +92,15 @@ For example to run host instance:

.. code-block:: console

$ cd path/to/this-repo/examples/zephyr/dual_qemu_ivshmem/host
$ west build -t run
cd path/to/this-repo/examples/zephyr/dual_qemu_ivshmem/host
west build -t run

For the remote instance, just go to the remote side directory in another terminal:

.. code-block:: console

$ cd path/to/this-repo/examples/zephyr/dual_qemu_ivshmem/remote
$ west build -t run
cd path/to/this-repo/examples/zephyr/dual_qemu_ivshmem/remote
west build -t run

Expected output:
****************
Expand All @@ -107,7 +110,7 @@ go to the host instance terminal, you should see something like this:

.. code-block:: console

uart:~$ *** Booting Zephyr OS build v3.4.0-rc2-91-gbf0f58d69816 ***
*** Booting Zephyr OS build v3.4.0-rc2-91-gbf0f58d69816 ***
Hello qemu_cortex_a53 - Host Side, the communication over RPMsg is ready to use!

If nothing appears, make sure you are running the remote instance after this one, because
Expand All @@ -125,9 +128,16 @@ on console you may see something like this:
Then go back to the host side terminal window, and issue the custom shell command
``rpmsg_ivshmem send`` and you should see how to use that:

**Command**

.. code-block:: console

rpmsg_ivshmem send

**Output**

.. code-block:: console

uart:~$ rpmsg_ivshmem send
send: wrong parameter count
send - Usage: rpmsg_ivshmem send <string> <number of messages>

Expand All @@ -136,9 +146,16 @@ this command will send the data over RPMsg-IVSHMEM backend and the remote side
will reply back echoing the sent string, on the host terminal this should take
an output similar like the shown below:

**Command**

.. code-block:: console

rpmsg_ivshmem send "RPMsg over IVSHMEM" 10

**Output**

.. code-block:: console

uart:~$ rpmsg_ivshmem send "RPMsg over IVSHMEM" 10
Remote side echoed the string back:
[ RPMsg over IVSHMEM ]
at message number 1
Expand Down Expand Up @@ -182,13 +199,14 @@ an output similar like the shown below:
On the remote side terminal window is possible also to check the messages
arriving from host:

**Output**

.. code-block:: console

*** Booting Zephyr OS build v3.4.0-rc2-91-gbf0f58d69816 ***
Hello qemu_cortex_a53 - Remote Side, the communication over RPMsg is ready to use!


uart:~$ Host side sent a string:
Host side sent a string:
[ RPMsg over IVSHMEM ]
Now echoing it back!

Expand Down Expand Up @@ -233,11 +251,17 @@ This sample supports huge message number in order to do stress testing, somethin
this command is blocking and have a 5 second timeout, returning if something goes wrong,
for example shutdown the remote side unexpectedly:

**Command**

.. code-block:: console

rpmsg_ivshmem send "RPMsg over IVSHMEM" 10

**Output**

.. code-block:: console

uart:~$ rpmsg_ivshmem send "RPMsg over IVSHMEM" 10
Remote side response timed out!
uart:~$

Known limitation:
*****************
Expand Down