examples: dual_qemu_ivhshmem: add RPMsg over IVSHMEM sample code.

[uLipe]

The additions include a backend to glue the Zephyr IVSHMEM device driver into the openAMP code making it usable to send data between two QEMU instances using the RPMsg protocol.

Also a custom shell command in the host side application is provided to send string messages for a number of times allowing to perform stress test of the communication.

This sample has a limitation regarding the order of initialization of the QEMU host and side instances, the host side must be initialized first, followed by the remote side please refer the README of this sample for more info.

[uLipe]

@wmamills , @danmilea , @arnopo just tagging you to follow-up, but feel free to review and reproduce this one.

[arnopo]

2 minor comments else LGTM

[arnopo]

It seems that a coding rule in Zephyr is to put the code in the src folder. This could be the case for the rpmsg_ivshmem_backend folder, but keeping it that way works for me too.

[tnmysh]

Hello,

Thanks for your patch.
minor comments related to coding style, otherwise looks good to me.

Thanks,
Tanmay

[tnmysh]

LGTM. Just can we mention vendor-id was taken from zephyr-(version) in README ? That will be good for user to understand how vendor-id is defined.

[arnopo]

@uLipe I run zephyr checkpatch.pl on your PR. there are some errors reported... could you fix them, please?

@TanmayShah-xilinx: any new concerns on this PR?

[uLipe]

@arnopo , yes sure, I will fix and run checkpatch.pl before pushing again

[uLipe]

@arnopo , @TanmayShah-xilinx just adressed the zephyr style issues.

[arnopo]

I still have issues with checkpatch.
could you squash the fixes and re-run the checkpatch?

[arnopo]

Please keep a separate patch for the update of the zephyr version. FYI in OpenAMp we use to fix the issue in the commit directly an not add fixup! on top of the series during review step

Please , could you fix the isfollowing remaining issue report by checkpatch

CHECK: Blank lines aren't necessary after an open brace '{'
#462: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:21:
+{
+

WARNING: line length of 102 exceeds 10 columns
#496: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:55:
+	printf("Hello %s - Host Side, the communication over RPMsg is ready to use!\n", CONFIG_BOARD);

CHECK: Alignment should match open parenthesis
#500: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:59:
+static int cmd_rpmsg_ivshmem_send(const struct shell *sh,
+			   size_t argc, char **argv)

WARNING: line length of 109 exceeds 80 columns
#516: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:75:
+			printf("failed to send message over RPMsg-IVSHMEM to the Remote side: %d\n", status);


CHECK: Alignment should match open parenthesis
#534: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:93:
+SHELL_STATIC_SUBCMD_SET_CREATE(sub_rpmsg_ivshmem,
+						SHELL_CMD_ARG(send, NULL,

CHECK: Alignment should match open parenthesis
#535: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:94:
+						SHELL_CMD_ARG(send, NULL,
+								"Usage: rpmsg_ivshmem send <string> <number of messages>",


CHECK: Alignment should match open parenthesis
#541: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:100:
+SHELL_CMD_ARG_REGISTER(rpmsg_ivshmem, &sub_rpmsg_ivshmem,
+				"Commands to use RPMsg over IVSHMEM",

WARNING: 'supress' may be misspelled - perhaps 'suppress'?
#643: FILE: examples/zephyr/dual_qemu_ivshmem/remote/prj.conf:16:
+# Enable IVSHMEM shell when debugging the driver, default OFF to supress warnings when not used.

WARNING: line length of 104 exceeds 100 columns
#705: FILE: examples/zephyr/dual_qemu_ivshmem/remote/src/main.c:53:
+	printf("Hello %s - Remote Side, the communication over RPMsg is ready to use!\n", CONFIG_BOARD);

CHECK: No space is necessary after a cast
#760: FILE: examples/zephyr/dual_qemu_ivshmem/rpmsg_ivshmem_backend/rpmsg_ivshmem_backend.c:48:
+			.virt       = (void *) 0,

CHECK: Please don't use multiple blank lines
#921: FILE: examples/zephyr/dual_qemu_ivshmem/rpmsg_ivshmem_backend/rpmsg_ivshmem_backend.c:209:
+
+

CHECK: Alignment should match open parenthesis
#927: FILE: examples/zephyr/dual_qemu_ivshmem/rpmsg_ivshmem_backend/rpmsg_ivshmem_backend.c:215:
+	k_thread_create(&ivshmem_ev_loop_thread,
+		ivshmem_ev_loop_stack,

[uLipe]

It is strange, my checkpatch.pl (under zephyr/scripts) did not catch these style issues, I addressed them manually btw.

[uLipe]

@arnopo , PTAL again, I ran the checkpatch using the same command you are using, the remaining issues are gone, but it stills report duplicate sign-off, I checked manually the patch and I did not find a reason for this being reported.

[arnopo]

@arnopo , PTAL again, I ran the checkpatch using the same command you are using, the remaining issues are gone, but it stills report duplicate sign-off, I checked manually the patch and I did not find a reason for this being reported.

You can ignore the signature duplication. It because the patch 11.patch from github contain both commits.

From your last version I can see only 3 check remaining that could be fixed, else it is ok

CHECK: Alignment should match open parenthesis
#498: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:58:
+static int cmd_rpmsg_ivshmem_send(const struct shell *sh, size_t argc,
+				char **argv)

CHECK: Alignment should match open parenthesis
#532: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:92:
+SHELL_STATIC_SUBCMD_SET_CREATE(sub_rpmsg_ivshmem,
+		SHELL_CMD_ARG(send, NULL,

CHECK: Alignment should match open parenthesis
#533: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:93:
+		SHELL_CMD_ARG(send, NULL,
+				"Usage: rpmsg_ivshmem send <string> <number of messages>",

CHECK: Alignment should match open parenthesis
#538: FILE: examples/zephyr/dual_qemu_ivshmem/host/src/main.c:98:
+SHELL_CMD_ARG_REGISTER(rpmsg_ivshmem, &sub_rpmsg_ivshmem,
+		"Commands to use RPMsg over IVSHMEM",

[uLipe]

It is strange, no matter how I align these, or change my editor settings, these three error never disappear, I even copied the alignment from other Zephyr samples and subsystems with no luck, as well trying to align mixing spaces and tabs, is there something I'm missing? @arnopo

[uLipe]

@arnopo the problem was in my editor local config, I was able to fix the alignment warning, thank you.

[arnopo]

LGTM

[tnmysh]

LGTM

[tnmysh]

@wmamills if all look good, can we merge this change? Me and @arnopo have approved.