Skip to content

Commit 8bb5780

Browse files
committed
qemuv7a/v8a-rpserver/proxy: remove "_ivshmem" suffix and update documents
Now the qemu-armv7a:rpserver_ivshmem, qemu-armv7a:rpproxy_ivshmem and qemu-armv8a:rpserver_ivshmem, qemu-armv8a:rpproxy_ivshmem are not only based on the ivshmem device but also the virtio-serial, so remove the "_ivshmem" suffix and update documents. Signed-off-by: Bowen Wang <[email protected]>
1 parent ceb8240 commit 8bb5780

File tree

6 files changed

+28
-23
lines changed

6 files changed

+28
-23
lines changed

Documentation/platforms/arm/qemu/boards/qemu-armv7a/index.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,33 +71,35 @@ ACRN hypervisor but won't work with Jailhouse hypervisor which uses ``ivshmem-v2
7171
Please refer to the official `Qemu ivshmem documentation
7272
<https://www.qemu.org/docs/master/system/devices/ivshmem.html>`_ for more information.
7373

74-
This is an example implementation for OpenAMP based on the Inter-VM share memory(ivshmem)::
74+
This is an example implementation for OpenAMP that supports multiple transport
75+
mechanisms including Inter-VM shared memory (ivshmem) and RPMSG port UART::
7576

76-
rpproxy_ivshmem: Remote slave(client) proxy process.
77-
rpserver_ivshmem: Remote master(host) server process.
77+
rpproxy: Remote slave(client) proxy process.
78+
rpserver: Remote master(host) server process.
7879

79-
Steps for Using NuttX as IVSHMEM host and guest
80+
Steps for Using NuttX as OpenAMP host and guest
8081

8182
1. Build images
8283

83-
a. Build rpserver_ivshmem::
84+
a. Build rpserver::
8485

85-
$ cmake -B server -DBOARD_CONFIG=qemu-armv7a:rpserver_ivshmem -GNinja
86+
$ cmake -B server -DBOARD_CONFIG=qemu-armv7a:rpserver -GNinja
8687
$ cmake --build server
8788

88-
b. Build rpproxy_ivshmem::
89+
b. Build rpproxy::
8990

90-
$ cmake -B proxy -DBOARD_CONFIG=qemu-armv7a:rpproxy_ivshmem -GNinja
91+
$ cmake -B proxy -DBOARD_CONFIG=qemu-armv7a:rpproxy -GNinja
9192
$ cmake --build proxy
9293

9394
2. Bringup firmware via Qemu:
9495

95-
The Inter-VM Shared Memory device basic syntax is::
96+
The configuration supports both ivshmem and RPMSG port UART transports.
97+
For ivshmem, use the following device syntax::
9698

9799
-device ivshmem-plain,id=shmem0,memdev=shmmem-shmem0,addr=0xb \
98100
-object memory-backend-file,id=shmmem-shmem0,mem-path=/dev/shm/ivshmem0,size=4194304,share=yes
99101

100-
a. Start rpserver_ivshmem::
102+
a. Start rpserver::
101103

102104
$ qemu-system-arm -cpu cortex-a7 -nographic -machine virt,highmem=off \
103105
-object memory-backend-file,id=shmmem-shmem0,mem-path=/dev/shm/ivshmem0,size=4194304,share=yes \
@@ -107,7 +109,7 @@ Steps for Using NuttX as IVSHMEM host and guest
107109
-device virtconsole,chardev=foo \
108110
-kernel server/nuttx -nographic
109111

110-
b. Start rpproxy_ivshmem::
112+
b. Start rpproxy::
111113

112114
$ qemu-system-arm -cpu cortex-a7 -nographic -machine virt,highmem=off \
113115
-object memory-backend-file,discard-data=on,id=shmmem-shmem0,mem-path=/dev/shm/ivshmem0,size=4194304,share=yes \

Documentation/platforms/arm64/qemu/boards/qemu-armv8a/index.rst

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -413,38 +413,41 @@ hypervisor but won't work with Jailhouse hypervisor which uses ``ivshmem-v2``.
413413
Please refer to the official `Qemu ivshmem documentation
414414
<https://www.qemu.org/docs/master/system/devices/ivshmem.html>`_ for more information.
415415

416-
This is an example implementation for OpenAMP based on the Inter-VM share
417-
memory(ivshmem)::
416+
This is an example implementation for OpenAMP that supports multiple transport
417+
mechanisms including Inter-VM shared memory (ivshmem) and RPMSG port UART::
418418

419-
rpproxy_ivshmem: Remote slave(client) proxy process.
420-
rpserver_ivshmem: Remote master(host) server process.
419+
rpproxy: Remote slave(client) proxy process.
420+
rpserver: Remote master(host) server process.
421421

422-
Steps for Using NuttX as IVSHMEM host and guest
422+
Steps for Using NuttX as OpenAMP host and guest
423423

424424
1. Build images
425425

426-
a. Build ``rpserver_ivshmem``
426+
a. Build ``rpserver``
427427

428428
.. code:: console
429429
430-
$ cmake -B server -DBOARD_CONFIG=qemu-armv8a:rpserver_ivshmem -GNinja
430+
$ cmake -B server -DBOARD_CONFIG=qemu-armv8a:rpserver -GNinja
431431
$ cmake --build server
432432
433-
b. Build ``rpproxy_ivshmem``
433+
b. Build ``rpproxy``
434434

435435
.. code:: console
436436
437-
$ cmake -B proxy -DBOARD_CONFIG=qemu-armv8a:rpproxy_ivshmem -GNinja
437+
$ cmake -B proxy -DBOARD_CONFIG=qemu-armv8a:rpproxy -GNinja
438438
$ cmake --build proxy
439439
440440
2. Bringup firmware via Qemu:
441441

442-
The Inter-VM Shared Memory device basic syntax is::
442+
The configuration supports both ivshmem and RPMSG port UART transports.
443+
For ivshmem, use the following device syntax::
443444

444445
-device ivshmem-plain,id=shmem0,memdev=shmmem-shmem0,addr=0xb \
445446
-object memory-backend-file,id=shmmem-shmem0,mem-path=/dev/shm/ivshmem0,size=4194304,share=yes
446447

447-
a. Start ``rpserver_ivshmem``
448+
For RPMSG port UART, the virtconsole device is used as shown in the examples below.
449+
450+
a. Start ``rpserver``
448451

449452
.. code:: console
450453
@@ -455,7 +458,7 @@ Steps for Using NuttX as IVSHMEM host and guest
455458
-chardev socket,path=/tmp/rpmsg_port_uart_socket,server=on,wait=off,id=foo \
456459
-device virtconsole,chardev=foo
457460
458-
b. Start ``rpproxy_ivshmem``
461+
b. Start ``rpproxy``
459462

460463
.. code:: console
461464

boards/arm/qemu/qemu-armv7a/configs/rpproxy_ivshmem/defconfig renamed to boards/arm/qemu/qemu-armv7a/configs/rpproxy/defconfig

File renamed without changes.

boards/arm/qemu/qemu-armv7a/configs/rpserver_ivshmem/defconfig renamed to boards/arm/qemu/qemu-armv7a/configs/rpserver/defconfig

File renamed without changes.

boards/arm64/qemu/qemu-armv8a/configs/rpproxy_ivshmem/defconfig renamed to boards/arm64/qemu/qemu-armv8a/configs/rpproxy/defconfig

File renamed without changes.

boards/arm64/qemu/qemu-armv8a/configs/rpserver_ivshmem/defconfig renamed to boards/arm64/qemu/qemu-armv8a/configs/rpserver/defconfig

File renamed without changes.

0 commit comments

Comments
 (0)