open-amp: resource table: Add support for vendor-specific features #87296

iuliana-prodan · 2025-03-18T15:31:29Z

This update introduces support for vendor-specific features within the OpenAMP remote processor resource table.

To facilitate the integration of custom data structures, new macros have been added to define initialization routines for resource table entries.

The core resource table has been refactored to include hooks that enable vendor-specific initialization logic. As part of this enhancement, NXP-specific support has been implemented, incorporating custom definitions and initialization routines tailored to NXP’s communication requirements.

To demonstrate this capability, the imx8ulp_evk_mimx8ud7_adsp board configuration has been updated to activate vendor-specific resource table features.

This enhancement allows better flexibility for remote processors requiring custom features configurations.

uLipe

I have a question regarding turning this option on and off, otherwise looks good to me.

uLipe · 2025-03-18T19:30:07Z

lib/open-amp/Kconfig

+config OPENAMP_RSC_TABLE_VENDOR_RSC_LENGTH
+	int "Vendor specific length of the resource"
+	default 0
+	range 0 4


Question instead of using the size to actually reserve space in the rsc_table, why not create a specific option let's ADD_VENDOR_SPEFICIC_AREA?

I'm afraid that implementors may use for example 0 - sized values and it silently have hard time to debug when this value is badly populated

Having a switch like option enforces the implementor to search the documentation to refer the "right" way to populate the vendor reserved area.

Instead of CONFIG_OPENAMP_RSC_TABLE_VENDOR_DATA_FEATURES_0, which means the vendor-specific feature is disable, I can add:

config CONFIG_OPENAMP_RSC_TABLE_VENDOR_RSC_FEATURE bool "Vendor specific resource entry" depends on OPENAMP_RSC_TABLE help Enable vendor-specific features supported by remote processor.

Will that be ok?

Hi @iuliana-prodan , I like that approach and it sounds more explicit on what this symbol does :)

arnopo · 2025-03-19T10:44:12Z

lib/open-amp/resource_table.c

+#if (CONFIG_OPENAMP_RSC_TABLE_VENDOR_RSC_LENGTH > 0)
+	/* Initialize vendor-specific resource entry */
+	.vendor_hdr = {
+		RSC_VENDOR_START,


We should be able to define a resource ID different from RSC_VENDOR_START

Since I wanted this to be generic, I used RSC_VENDOR_START.
I can add a config, something like:

config RSC_VENDOR_TYPE int "Vendor specific type of the resource entry" default 128 range 128 512 help Type of vendor-specific resource entry.

For example, for NXP:

in board overlay I can add my NXP type:
CONFIG_RSC_VENDOR_TYPE=129

in Linux driver (imx_dsp_rproc) I'll check for this value.

The same can be done for other vendors.

arnopo · 2025-03-19T12:27:09Z

lib/open-amp/resource_table.c

+			, CONFIG_OPENAMP_RSC_TABLE_VENDOR_DATA_FEATURES_3,
+#endif
+	},
+#endif


Regarding the implementation I wonder if you should not define your own table in you SoC Adapting this for all vendors could become a nightmare.

This one could be the default one without specific vendor resources

An example of implementation would be to define a OPENAMP_VENDOR_ RSC_TABLE config that would include a vendor_resource_table.h instead of defining the enum rsc_table_entries and struct fw_resource_table

Some other/better probably exist...

I want this to be generic, like struct fw_rsc_trace, with CONFIG_RAM_CONSOLE.
That's why I used those 4 CONFIG_OPENAMP_RSC_TABLE_VENDOR_DATA_FEATURES_X, so a vendor can enable as many features as needed.

This will be very simple to enable it for a vendor. Here's how I do for i.MX8ULP:

diff --git a/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf b/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf index 88f6a2df451..e9e2c5d7099 100644 --- a/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf +++ b/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf @@ -9,3 +9,6 @@ CONFIG_MBOX_NXP_IMX_MU=y CONFIG_OPENAMP_ADDR_TRANSLATION=y CONFIG_SHELL=n + +CONFIG_OPENAMP_RSC_TABLE_VENDOR_RSC_LENGTH=1 +CONFIG_OPENAMP_RSC_TABLE_VENDOR_DATA_FEATURES_1=0x0

(the diff is based on this PR that is still in review: https://github.com/zephyrproject-rtos/zephyr/pull/83049/files#diff-143b27ae2e5e64ca6cbb40b17c473439f177882a711361d97aa2f081b3b4cd7bR1)

I also have a Linux PR for i.MX DSP remoteproc driver: https://lore.kernel.org/all/[email protected]/ which works perfect with this change from remote processor side.

My concerns with this implementation are:

What happens if a vendor needs to set CONFIG_OPENAMP_RSC_TABLE_VENDOR_RSC_LENGTH to 20?

What happens if a vendor needs 4 vendor IDs?

That's why I suggest keeping this generic and implementing your own resource table for your platform.

Of course, this is just a suggestion. If the maintainer is okay with this implementation, let's keep it and address the issue when/if someone needs new vendor ID structures.

@carlocaione Can you please review since you are the assignee & maintainer?
Thank you!

iuliana-prodan · 2025-04-03T22:18:47Z

Changes in v2:

added CONFIG_OPENAMP_RSC_TABLE_VENDOR_RSC_FEATURE, instead of CONFIG_OPENAMP_RSC_TABLE_VENDOR_DATA_FEATURES_0 for enablement;
added CONFIG_RSC_VENDOR_TYPE to specify vendor specific type number, range 128-512.

iuliana-prodan · 2025-04-04T07:56:56Z

An example on how this will be used is the i.MX8ULP support for openamp_rsc_table sample.
We just need to set some configs in the dts overlay of the sample, for this particular board:

diff --git a/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf b/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf
index 88f6a2df451..decb9495d52 100644
--- a/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf
+++ b/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf
@@ -9,3 +9,13 @@ CONFIG_MBOX_NXP_IMX_MU=y
 
 CONFIG_OPENAMP_ADDR_TRANSLATION=y
 CONFIG_SHELL=n
+
+CONFIG_OPENAMP_RSC_TABLE_VENDOR_RSC_FEATURE=y
+CONFIG_RSC_VENDOR_TYPE=128
+CONFIG_OPENAMP_RSC_TABLE_VENDOR_RSC_LENGTH=3
+#magic number
+CONFIG_OPENAMP_RSC_TABLE_VENDOR_DATA_FEATURES_0=0x6E787073
+#version
+CONFIG_OPENAMP_RSC_TABLE_VENDOR_DATA_FEATURES_1=0x0
+#supported features - request host NOT to wait for FW_READY reply
+CONFIG_OPENAMP_RSC_TABLE_VENDOR_DATA_FEATURES_2=0x1

I haven't created a PR yet, for this change since there are still some dependencies that are not merged.

iuliana-prodan · 2025-05-05T13:03:26Z

Changes in v3:

add a new header file to define initialization for OpenAMP resource table;
add vendor-specific config options;
update build system to include vendor-specific files, if defined;
add NXP-specific resource table implementation.

An example on how to use this, and how to enable it is:

diff --git a/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf b/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf
index 88f6a2df451..ae5017e56f9 100644
--- a/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf
+++ b/samples/subsys/ipc/openamp_rsc_table/boards/imx8ulp_evk_mimx8ud7_adsp.conf
@@ -9,3 +9,7 @@ CONFIG_MBOX_NXP_IMX_MU=y
 
 CONFIG_SHELL=n
+
+CONFIG_OPENAMP_VENDOR_RSC_TABLE_ENTRY=y
+CONFIG_OPENAMP_VENDOR_RSC_TYPE=128
+CONFIG_OPENAMP_VENDOR_RSC_TABLE_FILE="nxp_resource_table.c"

This diff will be appended to this PR, when PR #89317 will be merged.

arnopo · 2025-05-06T14:53:45Z

lib/open-amp/resource_table.c

-		"Zephyr_log",
-	},
-#endif
+	#include "rsc_table_init.h"


I don't think that you can do that. it working but it is not clean.

you should have

#include <zephyr/kernel.h> #include <resource_table.h> #include "rsc_table_init.h" #ifdef CONFIG_OPENAMP_COPY_RSC_TABLE #define RSC_TABLE_ADDR DT_REG_ADDR(DT_CHOSEN(zephyr_ipc_rsc_table)) #define RSC_TABLE_SIZE DT_REG_SIZE(DT_CHOSEN(zephyr_ipc_rsc_table)) BUILD_ASSERT(sizeof(struct fw_resource_table) <= RSC_TABLE_SIZE); #endif extern char ram_console_buf[]; #define __resource Z_GENERIC_SECTION(.resource_table) static struct fw_resource_table __resource resource_table = RESOURCE_TABLE_INIT

with RESOURCE_TABLE_INIT defined as a macro in lib/open-amp/rsc_table_init.h

I've tried

static struct fw_resource_table __resource resource_table = RESOURCE_TABLE_INIT

I cannot use macro since in the initialization of resource table we have a few defines, like:

... .offset = { #if (CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF > 0) offsetof(struct fw_resource_table, vdev), #endif #if defined(CONFIG_RAM_CONSOLE) offsetof(struct fw_resource_table, cm_trace), #endif ...

arnopo · 2025-05-06T15:16:59Z

lib/open-amp/rsc_table_init.h

+	.vendor_type = CONFIG_OPENAMP_VENDOR_RSC_TYPE,
+#endif
+
+


extra line to remove

arnopo · 2025-05-06T15:19:19Z

lib/open-amp/rsc_table_init.h

+#ifndef RESOURCE_TABLE_INIT_H__
+#define RESOURCE_TABLE_INIT_H__
+
+	.hdr = {


should be a Macro

# define RESOURCE_TABLE_INIT \ { \ .hdr = { \ .... }

lib/open-amp/CMakeLists.txt

lib/open-amp/vendor_rsc_table/nxp_resource_table.c

iuliana-prodan · 2025-06-16T16:34:51Z

Changes in v6:

s/vendor_rsc_table/vendor;
use only CONFIG_OPENAMP_RSC_TABLE or CONFIG_OPENAMP_VENDOR_RSC_TABLE. Ensure these two options are mutually exclusive;
update linked.ld for 8ULP to support vendor specific resource table entry.

arnopo · 2025-06-20T13:03:02Z

lib/open-amp/Kconfig

+	depends on OPENAMP_VENDOR_RSC_TABLE
+	help
+	  Name of a source file containing vendor-specific
+	  resource table.


Look to me that there are some redundancies in configs

Could we do it in this way:

OPENAMP_RSC_TABLE should specify if there is a resource table
OPENAMP_VENDOR_RSC_TABLE_FILE point to the resource table file that is the legacy file by default

config OPENAMP_VENDOR_RSC_TABLE_FILE string "Source file containing vendor-specific resource table" default "" depends on OPENAMP_RSC_TABLE help Name of a source file containing vendor-specific resource table.

and then in CMakeLists.txt

zephyr_include_directories_ifdef(CONFIG_OPENAMP_RSC_TABLE .) # include vendor-specific resource table files if(CONFIG_OPENAMP_VENDOR_RSC_TABLE STREQUAL "") # include generic resource table zephyr_sources(resource_table.c) ielseif(CONFIG_OPENAMP_VENDOR_RSC_TABLE ) zephyr_include_directories(vendor) zephyr_sources(vendor/${CONFIG_OPENAMP_VENDOR_RSC_TABLE_FILE}) endif()

Look to me that there are some redundancies in configs

Here are the reasons why I wrote the code as I did:

Using CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF in vendor rsc table is not right.
For the generic table this config enables the VDEV_ENTRY that is mandatory for the sample.

I've made the CONFIG_OPENAMP_RSC_TABLE and CONFIG_OPENAMP_VENDOR_RSC_TABLE exclusive so a vendor can use only what is needed in their resource table.

The only configs that are needed in both generic and vendor rsc table will have the CONFIG_OPENAMP_RSC_TABLE_PRESENT.

if(CONFIG_OPENAMP_VENDOR_RSC_TABLE STREQUAL "")

In C, you can't directly check whether a Kconfig string is empty or not to conditionally include code. This limitation affects what I would need to implement here or here if I go with your proposed solution.

iuliana-prodan · 2025-06-23T18:57:17Z

Changes in v7:

made CONFIG_OPENAMP_VENDOR_RSC_TABLE dependent on CONFIG_OPENAMP_RSC_TABLE;
removed the patch that modified linked.ld for 8ULP, as the dependency is now handled via Kconfig.

In this PR I've introduced only 2 new configuration options:
CONFIG_OPENAMP_VENDOR_RSC_TABLE: enables vendor-specific resource table support.
CONFIG_OPENAMP_VENDOR_RSC_TABLE_FILE: specifies the file implementing the vendor-specific resource table.

arnopo

a last comment, with that LGTM

arnopo · 2025-06-25T07:06:58Z

lib/open-amp/CMakeLists.txt

 #
 # SPDX-License-Identifier: Apache-2.0
 #

 zephyr_include_directories_ifdef(CONFIG_OPENAMP_RSC_TABLE .)
-zephyr_sources_ifdef(CONFIG_OPENAMP_RSC_TABLE resource_table.c)
+zephyr_include_directories_ifdef(CONFIG_OPENAMP_VENDOR_RSC_TABLE vendor)


Here CONFIG_OPENAMP_RSC_TABLE and CONFIG_OPENAMP_VENDOR_RSC_TABLE can be defined move the
zephyr_include_directories_ifdef in codition below replacung by zephyr_include_directories

iuliana-prodan · 2025-06-25T07:46:04Z

Changes in v8:

move zephyr_include_directories for vendor headers under condition CONFIG_OPENAMP_VENDOR_RSC_TABLE.

Switching to void allows greater flexibility in supporting vendor-specific resource tables. This change reverts commit 39863b6, and adds some fixes. Signed-off-by: Iuliana Prodan <[email protected]>

Enhance flexibility by allowing vendors to define their own resource tables. This is achieved by moving the vdev and vring functions into the source file, requiring each vendor to implement these functions within their specific resource table definitions. Signed-off-by: Iuliana Prodan <[email protected]>

Introduce macros to define initialization routines for OpenAMP resource table entries. This will allow to extend the default OpenAMP resource table with vendor-specific data structures. Signed-off-by: Iuliana Prodan <[email protected]>

Add config options for vendor-specific resource tables. Signed-off-by: Iuliana Prodan <[email protected]>

Modify the build system to conditionally compile vendor-specific resource table support based on configuration. Signed-off-by: Iuliana Prodan <[email protected]>

Implement NXP-specific support for the remote processor resource table, including custom definitions and initialization logic to meet NXP's communication requirements. Signed-off-by: Iuliana Prodan <[email protected]>

Update the imx8ulp_evk_mimx8ud7_adsp board configuration to enable vendor-specific resource table features. Signed-off-by: Iuliana Prodan <[email protected]>

sonarqubecloud · 2025-06-25T08:19:57Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

zephyrbot added the area: Open AMP label Mar 18, 2025

zephyrbot requested review from carlocaione and uLipe March 18, 2025 15:31

zephyrbot assigned carlocaione Mar 18, 2025

iuliana-prodan requested a review from arnopo March 18, 2025 15:32

uLipe reviewed Mar 18, 2025

View reviewed changes

arnopo reviewed Mar 19, 2025

View reviewed changes

iuliana-prodan requested review from nashif and carlescufi March 21, 2025 16:58

uLipe previously approved these changes Mar 21, 2025

View reviewed changes

iuliana-prodan mentioned this pull request Apr 1, 2025

Prepare for i.MX8ULP DSP core support of openamp_rsc_table sample #83049

Merged

iuliana-prodan dismissed uLipe’s stale review via 146c275 April 3, 2025 21:22

iuliana-prodan force-pushed the rproc_fw_ready branch from 0874db4 to 146c275 Compare April 3, 2025 21:22

iuliana-prodan requested review from arnopo and uLipe April 3, 2025 21:23

iuliana-prodan mentioned this pull request Apr 30, 2025

samples: add support for i.MX8ULP DSP in openamp_rsc_table #89317

Merged

iuliana-prodan force-pushed the rproc_fw_ready branch from 146c275 to 7c1ba25 Compare May 5, 2025 12:57

iuliana-prodan assigned arnopo May 5, 2025

uLipe previously approved these changes May 5, 2025

View reviewed changes

iuliana-prodan dismissed uLipe’s stale review via 6f6ba58 May 6, 2025 08:00

iuliana-prodan force-pushed the rproc_fw_ready branch from 7c1ba25 to 6f6ba58 Compare May 6, 2025 08:00

arnopo requested changes May 6, 2025

View reviewed changes

iuliana-prodan force-pushed the rproc_fw_ready branch from 6f6ba58 to 0771820 Compare May 26, 2025 13:26

github-actions bot added area: IPC Inter-Process Communication area: Samples Samples labels May 26, 2025

github-actions bot requested review from doki-nordic and kartben May 26, 2025 13:27

github-actions bot requested review from dbaluta, dleach02, JiafeiPan and yangbolu1991 June 16, 2025 15:56

iuliana-prodan force-pushed the rproc_fw_ready branch from 0bc5dd2 to 3497f10 Compare June 16, 2025 16:09

iuliana-prodan requested a review from arnopo June 19, 2025 07:55

arnopo reviewed Jun 20, 2025

View reviewed changes

iuliana-prodan added this to the v4.2.0 milestone Jun 23, 2025

iuliana-prodan force-pushed the rproc_fw_ready branch from 3497f10 to b46b986 Compare June 23, 2025 16:37

iuliana-prodan requested a review from arnopo June 23, 2025 16:39

arnopo reviewed Jun 25, 2025

View reviewed changes

iuliana-prodan force-pushed the rproc_fw_ready branch from b46b986 to de5d9c5 Compare June 25, 2025 07:40

iuliana-prodan requested a review from arnopo June 25, 2025 07:53

iuliana-prodan added 7 commits June 25, 2025 10:54

lib: open-amp: Replace struct fw_resource_table with void

8cf791a

Switching to void allows greater flexibility in supporting vendor-specific resource tables. This change reverts commit 39863b6, and adds some fixes. Signed-off-by: Iuliana Prodan <[email protected]>

lib: open-amp: Add base support for resource table

547e7cc

Introduce macros to define initialization routines for OpenAMP resource table entries. This will allow to extend the default OpenAMP resource table with vendor-specific data structures. Signed-off-by: Iuliana Prodan <[email protected]>

lib: open-amp: Add vendor-specific config options

111857f

Add config options for vendor-specific resource tables. Signed-off-by: Iuliana Prodan <[email protected]>

lib: open-amp: Update CMakeLists.txt for vendor resource table

e6624fc

Modify the build system to conditionally compile vendor-specific resource table support based on configuration. Signed-off-by: Iuliana Prodan <[email protected]>

lib: open-amp: Add NXP-specific resource table implementation

3da66d5

Implement NXP-specific support for the remote processor resource table, including custom definitions and initialization logic to meet NXP's communication requirements. Signed-off-by: Iuliana Prodan <[email protected]>

samples: Enable vendor-specific support for i.MX8ULP

e5fb03d

Update the imx8ulp_evk_mimx8ud7_adsp board configuration to enable vendor-specific resource table features. Signed-off-by: Iuliana Prodan <[email protected]>

iuliana-prodan force-pushed the rproc_fw_ready branch from de5d9c5 to e5fb03d Compare June 25, 2025 07:54

arnopo approved these changes Jun 25, 2025

View reviewed changes

LaurentiuM1234 approved these changes Jun 25, 2025

View reviewed changes

dbaluta approved these changes Jun 25, 2025

View reviewed changes

kartben merged commit 81268e1 into zephyrproject-rtos:main Jun 25, 2025
26 checks passed

iuliana-prodan mentioned this pull request Jun 25, 2025

samples: Add support for different base address of the shared mem in the memory map of each core #84170

Merged

open-amp: resource table: Add support for vendor-specific features #87296

open-amp: resource table: Add support for vendor-specific features #87296

Uh oh!

Conversation

iuliana-prodan commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

uLipe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iuliana-prodan commented Apr 3, 2025

Uh oh!

iuliana-prodan commented Apr 4, 2025

Uh oh!

iuliana-prodan commented May 5, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iuliana-prodan May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

iuliana-prodan commented Jun 16, 2025

Uh oh!

arnopo Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iuliana-prodan commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arnopo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iuliana-prodan commented Jun 25, 2025

Uh oh!

sonarqubecloud bot commented Jun 25, 2025

Quality Gate passed

Uh oh!

Uh oh!

Uh oh!

iuliana-prodan commented Mar 18, 2025 •

edited

Loading

iuliana-prodan May 6, 2025 •

edited

Loading

arnopo Jun 20, 2025 •

edited

Loading

iuliana-prodan commented Jun 23, 2025 •

edited

Loading