michaelh/zephyr
1
0
Fork 0
Code Releases Activity

lib: open-amp: add helper to add resource table in project

Browse source 
The resource table is needed by the Linux kernel OS
for a rpmsg generic support, but is also recognised by OpenAMP.
This table allows to add trace based on the RAM console
and to support rpmsg protocol.

Signed-off-by: Arnaud Pouliquen <arnaud.pouliquen@st.com>
This commit is contained in:
Arnaud Pouliquen 2019-09-20 11:41:38 +02:00 • committed by Kumar Gala
commit 25ec73986b
7 changed files with 186 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
CODEOWNERS
View file

@ -350,6 +350,7 @@
/kernel/ @andrewboie @andyross
/lib/fnmatch/ @carlescufi
/lib/gui/ @vanwinkeljan
/lib/open-amp/ @arnopo
/lib/os/ @andrewboie @andyross
/lib/posix/ @pfalcon
/lib/cmsis_rtos_v2/ @nashif

1
lib/CMakeLists.txt
View file

@ -10,3 +10,4 @@ add_subdirectory_ifdef(CONFIG_FNMATCH fnmatch)
add_subdirectory(gui)
add_subdirectory(os)
add_subdirectory_ifdef(CONFIG_UPDATEHUB updatehub)
add_subdirectory_ifdef(CONFIG_OPENAMP open-amp)

2
lib/Kconfig
View file

@ -19,4 +19,6 @@ source "lib/posix/Kconfig"
source "lib/updatehub/Kconfig"
source "lib/open-amp/Kconfig"
endmenu

8
lib/open-amp/CMakeLists.txt Normal file
View file

@ -0,0 +1,8 @@
#
# Copyright (c) 2020, STMicroelectronics
#
# SPDX-License-Identifier: Apache-2.0
#
zephyr_include_directories_ifdef(CONFIG_OPENAMP_RSC_TABLE .)
zephyr_sources_ifdef(CONFIG_OPENAMP_RSC_TABLE resource_table.c)

20
lib/open-amp/Kconfig Normal file
View file

@ -0,0 +1,20 @@
#
# Copyright (c) 2020, STMicroelectronics
#
# SPDX-License-Identifier: Apache-2.0
#
config OPENAMP_RSC_TABLE
bool "coprocessor resource table"
imply OPENAMP
help
add the resource table in the generated binary. This table is
compatible with linux remote proc framework and OpenAMP library.
config OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF
int "Resource table number of rpmsg buffers"
default 0
depends on OPENAMP_RSC_TABLE
help
This option specifies the number of buffer used in a Vring for
interprocessor communication

82
lib/open-amp/resource_table.c Normal file
View file

@ -0,0 +1,82 @@
/*
* Copyright (c) 2020 STMicroelectronics
*
* SPDX-License-Identifier: Apache-2.0
*/
/*
* In addition to the standard ELF segments, most remote processors would
* also include a special section which we call "the resource table".
*
* The resource table contains system resources that the remote processor
* requires before it should be powered on, such as allocation of physically
* contiguous memory, or iommu mapping of certain on-chip peripherals.
* In addition to system resources, the resource table may also contain
* resource entries that publish the existence of supported features
* or configurations by the remote processor, such as trace buffers and
* supported virtio devices (and their configurations).
* Dependencies:
* to be compliant with Linux kernel OS the resource table must be linked in a
* specific section named ".resource_table".
* Related documentation:
* https://www.kernel.org/doc/Documentation/remoteproc.txt
* https://github.com/OpenAMP/open-amp/wiki/OpenAMP-Life-Cycle-Management
*/
#include <zephyr.h>
#include <resource_table.h>
extern char ram_console[];
#define __resource Z_GENERIC_SECTION(.resource_table)
#if (CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF > 0) || defined(CONFIG_RAM_CONSOLE)
static struct fw_resource_table __resource resource_table = {
.ver = 1,
.num = RSC_TABLE_NUM_ENTRY,
.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
},
#if (CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF > 0)
/* Virtio device entry */
.vdev = {
RSC_VDEV, VIRTIO_ID_RPMSG, 0, RPMSG_IPU_C0_FEATURES, 0, 0, 0,
VRING_COUNT, {0, 0},
},
/* Vring rsc entry - part of vdev rsc entry */
.vring0 = {VRING_TX_ADDRESS, VRING_ALIGNMENT,
CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF,
VRING0_ID, 0},
.vring1 = {VRING_RX_ADDRESS, VRING_ALIGNMENT,
CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF,
VRING1_ID, 0},
#endif
#if defined(CONFIG_RAM_CONSOLE)
.cm_trace = {
RSC_TRACE,
(uint32_t)ram_console, CONFIG_RAM_CONSOLE_BUFFER_SIZE + 1, 0,
"Zephyr_log",
},
#endif
};
void rsc_table_get(void **table_ptr, int *length)
{
*table_ptr = (void *)&resource_table;
*length = sizeof(resource_table);
}
#endif

72
lib/open-amp/resource_table.h Normal file
View file

@ -0,0 +1,72 @@
/*
* Copyright (c) 2020 STMicroelectronics
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef RESOURCE_TABLE_H__
#define RESOURCE_TABLE_H__
#include <openamp/remoteproc.h>
#include <openamp/virtio.h>
#if (CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF > 0)
#define VDEV_ID 0xFF
#define VRING0_ID 0 /* (master to remote) fixed to 0 for Linux compatibility */
#define VRING1_ID 1 /* (remote to master) fixed to 1 for Linux compatibility */
#define VRING_COUNT 2
#define RPMSG_IPU_C0_FEATURES 1
#define VRING_RX_ADDRESS -1 /* allocated by Master processor */
#define VRING_TX_ADDRESS -1 /* allocated by Master processor */
#define VRING_BUFF_ADDRESS -1 /* allocated by Master processor */
#define VRING_ALIGNMENT 16 /* fixed to match with Linux constraint */
#endif
enum rsc_table_entries {
#if (CONFIG_OPENAMP_RSC_TABLE_NUM_RPMSG_BUFF > 0)
RSC_TABLE_VDEV_ENTRY,
#endif
#if defined(CONFIG_RAM_CONSOLE)
RSC_TABLE_TRACE_ENTRY,
#endif
RSC_TABLE_NUM_ENTRY
};
struct fw_resource_table {
unsigned int ver;
unsigned int num;
unsigned int reserved[2];
unsigned int offset[RSC_TABLE_NUM_ENTRY];
struct fw_rsc_vdev vdev;
struct fw_rsc_vdev_vring vring0;
struct fw_rsc_vdev_vring vring1;
#if defined(CONFIG_RAM_CONSOLE)
/* rpmsg trace entry */
struct fw_rsc_trace cm_trace;
#endif
} METAL_PACKED_END;
void rsc_table_get(void **table_ptr, int *length);
inline struct fw_rsc_vdev *rsc_table_to_vdev(void *rsc_table)
{
return &((struct fw_resource_table *)rsc_table)->vdev;
}
inline struct fw_rsc_vdev_vring *rsc_table_get_vring0(void *rsc_table)
{
return &((struct fw_resource_table *)rsc_table)->vring0;
}
inline struct fw_rsc_vdev_vring *rsc_table_get_vring1(void *rsc_table)
{
return &((struct fw_resource_table *)rsc_table)->vring1;
}
#endif